Windchill integration settings

Depending on your implementation, you might need to specify these host configuration settings in both the Windchill and Creo sections of the Gateway configuration file.

Option Description
RecordNumberingScheme
Specifies the numbering scheme that will be used for Granta data objects that are created in Windchill.

Applies to: Windchill and Creo Gateways
RecordNameLengthLimit

Record names in Granta MI may be long. If you specify a value for this option, record names will be truncated to the specified number of characters when creating the corresponding object names in Windchill.

Applies to: Windchill Gateway
LibraryName

Materials, processes, surface treatments and colors are all created as objects in Windchill within a Windchill library (the ‘Granta materials library’). This library must be of type wt.inf.library.WTLibrary, and must be created by the Windchill administrator.

By default, MI Materials Gateway expects the name of the library object to be ‘Granta.Materials’. If you have given your library a different name, you must specify the name of the library object using this setting. For example, if you have created your Granta materials library with the name ‘MyGrantaMaterialsLibrary’:

<HostOption a:name="LibraryName">
MyGrantaMaterialsLibrary</HostOption>

Applies to: Windchill Gateway
WTPartAssemblyModesAsAssemblies

This optional setting determines which objects in Windchill are treated as parts, and which as subassemblies by Gateway.

If the Windchill object’s wt.part.WTPart.partType value is one of the values specified in this comma-separated list, then the Gateway will treat it as as a subassembly. If not, then Gateway will treat it as a part, unless there is some other reason to treat it as a subassembly (for example, it has other objects as children).
  • Possible values: Separable,Inseparable,Component
  • Default value: Separable,Inseparable

Applies to: Windchill Gateway
VolumePropertyName

Specifies the Windchill Part property from which Gateway reads the part volume (as written by Creo).

Default: PRO_MP_VOLUME

Applies to: Windchill Gateway
AreaPropertyName

Specifies the Windchill Part property from which Gateway reads the part area (as written by Creo).

Default: PRO_MP_AREA

Applies to: Windchill Gateway
AutoCheckOutOnChange
When assignments are made in a Windchill Gateway, Gateway can be configured to automatically check out parts from Windchill prior to making the modification.
  • If true, then parts will be automatically checked out prior to assignment or modification.
  • If false, the user will be responsible for checking out parts in the Gateway user interface in order to make assignments.
Following the assignment or modification, the check-out state of parts will be controlled by the value of the AutoCheckInOnChange setting.

Applies to: Windchill Gateway
AutoCheckInOnChange
When assignments are made in a Windchill Gateway, Gateway can be configured to automatically check in parts from Windchill after making the modification.
  • If true, then parts will be automatically checked in after every assignment or modification.
  • If false, the user will be responsible for checking in parts in the Gateway user interface after making assignments.

Applies to: Windchill Gateway
KeepAssignmentsInSync

In deployments with both Creo and Windchill Gateways, this setting specifies whether assignments made in this Gateway host will be updated to reflect assignments made in the other Gateway host.

The option can be set for the Creo Gateway (to enable synchronization from Windchill to Creo), the Windchill Gateway (to enable synchronization from Creo to Windchill), or both.

When this option is configured for a host:
  • If true, then on startup of the Gateway session in this host, the timestamp of CAD and PLM assignments will be compared. If the other host’s assignments are more recent than this host’s, then the assignments will be synchronised to this host. If this requires a modification to a Windchill part, that part will be automatically checked out to make the change. (Check-in behavior after synchronization is specified using another option, AutoCheckInSyncedAssignments.)
  • If false, then only assignments made in this Gateway host will be shown.
Additional options are available to enable automatic synchronization in either or both directions ( without requiring a Gateway window to be opened in the destination host). These options need to be configured on the client machine, either when you install Gateway, or by editing the client-side configuration file after installation.

Applies to: Windchill and Creo Gateways
AutoCheckInSyncedAssignments

If KeepAssignmentsInSync (see above) is set to true, then when an automatic synchronization results in a modification to a part stored in Windchill, the part will be automatically checked out to make the change.

This AutoCheckInSyncedAssignment setting specifies whether to check the part in again after synchronization, or to leave it in the checked-out state.
  • If true, then parts will be automatically checked in following a change that results from an automated synchronization.
  • If false, then parts will be left in the checked-out state, and users will be responsible for checking them in again.

Applies to: Windchill and Creo Gateways
EnablePLMCheckInCheckOut
This option can be configured to allow Creo Gateway users to check out and check in parts that are stored in Windchill, directly from the Creo Gateway user interface.
  • If true, the ‘Check out’, ‘Check in’, and ‘Cancel checkout’ menu options will be available on the shortcut (right-click) menu on parts that are stored in Windchill.
  • If false, these menu options will not be available.

Applies to: Creo Gateway
MaterialRecordMappingDef

This optional element specifies a host material attribute mapping (see Writing data to host material attributes) for assignments of materials.

The mapping is specified as a colon-separated pair of values:
  • The name of the host Windchill attribute that the value will be mapped to
  • A formatted string determining the value to be written. This format may contain any combination of fixed strings, and standard names of Granta MI attributes in curly braces { }. For example, HostApplicationMaterialAttributeName:Supplier = {SUPPLIER}
Any number of these elements may be specified.

For more details, see the example in section Writing data to host material attributes.

Applies to: Windchill Gateway
ProcessRecordMappingDef

As above, but for process assignments

Applies to: Windchill Gateway
SurfaceTreatmentRecordMappingDef

As above, but for surface treatment assignments

Applies to: Windchill Gateway
ColorRecordMappingDef

As above, but for color assignments

Applies to: Windchill Gateway
WTPartChildDescribedByUnit

Can be used to specify one or more units that will be used to identify child parts when MI Materials Gateway loads a Bill of Materials from Windchill.

Specify the units as a comma-separated list, using the unit Key as it is defined in your Windchill system.
Tip: You can find these using the Enumerated Type Customization (enumCustomize) utility on your Windchill system.

For example, where the Windchill system has been customized to include a unit piece with key pc:

<HostOption a:name="WTPartChildDescribedByUnit">
ea,pc</HostOption>

With this configuration, the Bill of Materials will include Windchill Part objects that are linked to the parent part with the unit each (key ea) or piece (key pc), and will not include Part objects that are linked to the parent part with other units.

If this setting is not specified, the BoM will include Windchill Part objects that are linked to the parent part with the unit each.

Applies to: Windchill Gateway
WTPartAttributeMassPerUnitOfMeasure

Specifies an attribute on the Windchill Part object that can be used to store the Mass per Unit of Measure value for each part.

<HostOption 
a:name="WTPartAttributeMassPerUnitOfMeasure">
WT_PART_ATTRIB_NAME</HostOption>

Applies to: Windchill Gateway
WTPartAttributeMassUnit

Specifies an attribute on the Windchill Part object that can be used to store the unit for the Mass per Unit of Measure value for that part.

<HostOption 
a:name="WTPartAttributeMassUnit">
WT_PART_ATTRIB_NAME
</HostOption>

Applies to: Windchill Gateway
BomAnalyzerUnitNameMapping
Can be used to specify a mapping between a unit Key in Windchill, and the name of the same unit as displayed in MI Materials Gateway and BoM Analyzer.
Note: This setting maps keys and display names only, and cannot be used to convert data values from one unit to another.

This mapping is required when configuring WTPartChildDescribedByUnit and WTPartAttributeMassUnit, if the Windchill unit Key does not exactly match the unit name in this list: Supported units for Windchill parts.

Create a separate entry for each mapping, using the syntax:

<HostOption a:name="BomAnalyzerUnitNameMapping">
{host_unit_key}:{bom_analyzer_unit_name}
</HostOption>

where host_unit_key is the unit Key as it is defined in your Windchill system

Tip: You can find these using the Enumerated Type Customization (enumCustomize) utility on your Windchill system.

and bom_analyzer_unit_name is the unit name as it appears in this list: Supported units for Windchill parts

For example: 

<HostOption a:name="BomAnalyzerUnitNameMapping">
sq_m:m^2</HostOption>

Applies to: Windchill Gateway
WTExcludePartChildrenTypes

Can be used to specify one or more sub-types of Windchill Part objects that will be filtered out when MI Materials Gateway loads a Bill of Materials from Windchill. If all children of an assembly are excluded from the BoM, it will appear as a part in the Windchill Gateway and you can assign to it.

To configure this option, create a separate entry for each Windchill Part sub-type that you want to exclude, and specify the sub-type by its internal identifier.

For example, the following configuration:

<HostOption a:name="WTExcludePartChildrenTypes">
WCTYPE|wt.part.WTPart|
com.MyOrganization.WTPartDocRef</HostOption>

<HostOption a:name="WTExcludePartChildrenTypes">
WCTYPE|wt.part.WTPart|
com.ptc.ElectricalPart</HostOption>

will exclude reference documents and parts of the sub-type 'Electrical Part' from the Bill of Materials.

Applies to: Windchill Gateway