Optional Configuration Settings for Windchill Connector Users

CheckConnection Element Configuration

The <CheckConnection> element defines the base Windchill object class used when executing the HWCheckConnection webject call.

The <CheckConnection> element is crucial for validating connectivity and ensuring the expected object type is available during connection checks.

Purpose

The purpose of the <CheckConnection> element is to:

Establish the default root object type for Windchill system validation.
Confirm whether Windchill is properly integrated and accessible via webjects.

Attribute

baseClassName: Specifies the fully qualified Windchill class name (for example, wt.epm.EPMDocument).; This is the object type the application attempts to fetch or interact with during the connection test.

Default Value

<CheckConnection baseClassName="wt.epm.EPMDocument"/>

This configuration assumes CAD documents are used as the base validation class.

Windchill BOM Traversal and Attribute Mapping

These configurations define how Windchill BOM structures are navigated in both directions and how object attributes are translated for use by Altair's webjects.

ExpandStructureDown

The ExpandStructureDown element describes the downward traversal of a Bill of Materials (BOM). It is used to identify child items linked to a parent object in a product structure.

Each <Relation> element includes the following:

objectClass: The Windchill object type being evaluated (for example, wt.epm.EPMDocument).
relClass: The relation class used to define the BOM link (for example, EPMMemberLink).
direction: Always direction="uses" for downward traversal.

Example:

<ExpandStructureDown>
  <Relation objectClass="wt.epm.EPMDocument" relClass="wt.epm.structure.EPMMemberLink" direction="uses"/>
  <Relation objectClass="wt.part.WTPart" relClass="wt.part.WTPartUsageLink" direction="uses"/>
</ExpandStructureDown>

ExpandStructureUp

The ExpandStructureUp element defines the upward traversal of a BOM structure. It helps identify parent items that use a given component.

Each <Relation> element includes the same structure as the ExpandStructureDown element, but with direction="usedBy".

Example:

<ExpandStructureUp>
  <Relation objectClass="wt.epm.EPMDocument" relClass="wt.epm.structure.EPMMemberLink" direction="usedBy"/>
  <Relation objectClass="wt.part.WTPart" relClass="wt.part.WTPartUsageLink" direction="usedBy"/>
</ExpandStructureUp>

These configurations are essential for building accurate visual BOMs and for traceability in multi-level assemblies.

WebjectsMapping

The WebjectsMapping element maps Windchill attributes to values used by Altair webjects for CAD/Part operations. This section ensures attribute consistency between Windchill and Altair tools.

Important: Do not modify the WebjectsMapping element without consulting Windchill IT or system integrators.

Each <Attribute> element defines:

key: The Windchill out-of-the-box (OTB) attribute name.
value: The target attribute name as used in the Altair UDM model. Can match or override the key.

Example:

<WebjectsMapping>
  <Attributes>
    <Attribute key="obid" value="obid"/>
    <Attribute key="number" value="number"/>
    <Attribute key="name" value="name"/>
    <Attribute key="masterReference" value="masterReference"/>
    <Attribute key="checkoutInfo.state" value="checkoutInfo.state"/>
    <Attribute key="versionInfo.identifier.versionId" value="versionInfo.identifier.versionId"/>
    <Attribute key="iterationInfo.identifier.iterationId" value="iterationInfo.identifier.iterationId"/>
    <Attribute key="versionInfo.identifier.versionLevel" value="versionInfo.identifier.versionLevel"/>
    <Attribute key="CADName" value="CADName"/>
    <Attribute key="view" value="view"/>
    <Attribute key="role" value="role"/>
    <Attribute key="fileName" value="fileName"/>
    <Attribute key="usedQuantityAmount" value="usedQuantityAmount"/>
  </Attributes>
</WebjectsMapping>

RESTURLSuffix Configuration

The RESTURLSuffix section defines the REST-style service endpoints that Altair products use to communicate with the Windchill server. These endpoints are appended to the base Windchill URL to invoke various server-side actions.

Purpose

Enable key operations such as querying data, checking connections, managing CAD documents, and syncing BOMs.
Each endpoint points to a deployed XML-based webject servlet on the Windchill server.

Configuration Guidelines

Ensure each path exists and is correctly deployed on your Windchill server under the /servlet/IE/tasks/ext/ directory.
If using custom servlet locations, update the suffix paths accordingly.
These are not full URLs — they are suffixes appended to the Windchill base URL at runtime.

Service Endpoint Summary

Table 1.
Tag	Description	Default Path
`LoginURLSuffix`	Validates Windchill connectivity	/HWCheckConnection.xml
`QueryURLSuffix`	Executes saved queries	/HWQuery.xml
`GetWTPartCadURLSuffix`	Links CAD data with WTParts	/HWGetWTPartCad.xml
`FetchURLSuffix`	Retrieves metadata and object information	/HWFetch.xml
`ExpandBOMURLSuffix`	Expands product structure/BOM	/HWExpandBOM.xml
`AddContentURLSuffix`	Adds file attachments	/HWAddContent.xml
`ListContentURLSuffix`	Lists file attachments	/HWListContent.xml
`DeleteContentURLSuffix`	Deletes attachments	/HWDeleteContent.xml
`GetDownloadHandlesURLSuffix`	Prepares handles for download operations	/HWGetDownloadHandles.xml
`GetUploadHandlesURLSuffix`	Prepares handles for upload operations	/HWGetUploadHandles.xml
`GetRelatedCadDocURLSuffix`	Retrieves associated CAD documents	/HWGetRelatedCadDoc.xml
`GetBOMOccurrenceURLSuffix`	Retrieves BOM occurrence data	/HWGetBOMOccurrence.xml
`GetTransformInfoURLSuffix`	Retrieves transform/positioning info	/HWGetTransformInfo.xml
`GetListEPMFTContentSuffix`	Lists EPM Feature Table content	/HWListEPMFTContent.xml
`UpdateObjectURLSuffix`	Updates metadata or object properties	/HWUpdateObject.xml

Example Configuration Block

<RESTURLSuffix>
  <LoginURLSuffix>/servlet/IE/tasks/ext/HWCheckConnection.xml</LoginURLSuffix>
  <QueryURLSuffix>/servlet/IE/tasks/ext/HWQuery.xml</QueryURLSuffix>
  <GetWTPartCadURLSuffix>/servlet/IE/tasks/ext/HWGetWTPartCad.xml</GetWTPartCadURLSuffix>
  <FetchURLSuffix>/servlet/IE/tasks/ext/HWFetch.xml</FetchURLSuffix>
  <ExpandBOMURLSuffix>/servlet/IE/tasks/ext/HWExpandBOM.xml</ExpandBOMURLSuffix>
  <AddContentURLSuffix>/servlet/IE/tasks/ext/HWAddContent.xml</AddContentURLSuffix>
  <ListContentURLSuffix>/servlet/IE/tasks/ext/HWListContent.xml</ListContentURLSuffix>
  <DeleteContentURLSuffix>/servlet/IE/tasks/ext/HWDeleteContent.xml</DeleteContentURLSuffix>
  <GetDownloadHandlesURLSuffix>/servlet/IE/tasks/ext/HWGetDownloadHandles.xml</GetDownloadHandlesURLSuffix>
  <GetUploadHandlesURLSuffix>/servlet/IE/tasks/ext/HWGetUploadHandles.xml</GetUploadHandlesURLSuffix>
  <GetRelatedCadDocURLSuffix>/servlet/IE/tasks/ext/HWGetRelatedCadDoc.xml</GetRelatedCadDocURLSuffix>
  <GetBOMOccurrenceURLSuffix>/servlet/IE/tasks/ext/HWGetBOMOccurrence.xml</GetBOMOccurrenceURLSuffix>
  <GetTransformInfoURLSuffix>/servlet/IE/tasks/ext/HWGetTransformInfo.xml</GetTransformInfoURLSuffix>
  <GetListEPMFTContentSuffix>/servlet/IE/tasks/ext/HWListEPMFTContent.xml</GetListEPMFTContentSuffix>
  <UpdateObjectURLSuffix>/servlet/IE/tasks/ext/HWUpdateObject.xml</UpdateObjectURLSuffix>
</RESTURLSuffix>