Configuring the Windchill DPT Extension
1. Import the extension along with the required PTC reference config Things and verify the ThingWorx entities.
a. Windchill_Digital_Product_Traceability-extension — Import this ZIP file to ThingWorx Platform. Verify that the following entities exist in ThingWorx Composer after the DPT extension is imported:
 |
The Windchill product version in the imported extension is displayed in the following format: xx.x.xxx. The first four digits represent the Windchill release, and the last two digits represent the Critical Patch Set (CPS) release number.
For example, a CPS 03 release of Windchill 12.0.0 is represented as 12.0.003 in the extension.
|
|
Entity
|
Description
|
Type
|
||
|---|---|---|---|---|
|
DPTAdminConfigThing
|
This config Thing includes the service for creating the DPTEndUserGroup and DPTConfiguratorGroup, and assigning the necessary permissions to the ThingWorx Platform entities.
|
ConfigThing
|
||
|
OslcDataServicesThing
|
This Thing contains the services for OSLC resource that are invoked from Windchill.
|
Thing
|
||
|
OslcFlowsThing
|
This Thing contains the flow services that fetches data from the remote OSLC system using ThingWorx Flow.
|
Thing
|
||
|
OslcValidationFlowThing
|
This Thing contains the default validation flow thing.
|
Thing
|
||
|
OslcValidationServicesThing
|
This Thing contains validation services for OSLC resources that are invoked from Windchill.
|
Thing
|
||
|
PTC-PLM
|
• PTC-PLM:TRACELINKS model tag is used to tag all entities available in the extension. For more information, see the help topic Tags in the ThingWorx Platform Help Center.
• PTC-PLM: TRACELINKS-DPT-EXTENSION-PROPERTIES model tag, by default, enables the Windchill DPT extension to use the DPTExtensionPropertiesConfigThing.
• PTC-PLM:TRACELINKS ROOT SELECTION DIALOG model tag, when added to the configuration Thing, the root is displayed in the Select Context table. When the tag is not added, the complete tree structure is displayed in the Select Context table. This tag is specific to PTC Modeler.
• PTC-PLM:TRACELINKS-OSLC-QUERY-SEARCH model tag, when added to the configuration Thing, uses the external resource search picker to display the external OSLC resource. When this tag is not added, the selection dialog box displays the external OSLC resource. Out of the box, the PTC-PLM:TRACELINKS-OSLC-QUERY-SEARCH tag is added to the PTCModelerConfigThing, and PTCCodebeamerConfigThing. PTC does not recommend adding the PTC-PLM:TRACELINKS-OSLC-QUERY-SEARCH tag to the PTCPolarionConfigThing.
• PTC-PLM:TRACELINKS-OSLC-QUERY-SELECT-ALL model tag should be specified for the IBM Rational Doors NG reference configuration Thing when using PTC-PLM:TRACELINKS-OSLC-QUERY-SEARCH tag.
|
ModelTagVocabulary
|
||
|
PTC-PLM-VALIDATION-FLOWS
|
PTC-PLM-VALIDATION:modeler model tag is used to identify a validation flow thing. For more information, see the topic Tags in the ThingWorx Platform Help Center.
|
ModelTagVocabulary
|
||
|
PTC.PLM.TraceLinks.AttributeMappingConfigDataShape
|
This Data Shape is used in OSLCResourceAttributeMappingConfigTable for attribute mapping.
|
DataShape
|
||
|
PTC.PLM.TraceLinks.DPTExtensionPropertiesThingTemplate
|
This Thing Template contains the configuration properties for Windchill_Digital_Product_Traceability-extension.
|
ThingTemplate
|
||
|
PTC.PLM.TraceLinks.OslcDataServicesThingShape
|
This Thing Shape contains the service contract defined for Windchill.
|
ThingShape
|
||
|
PTC.PLM.TraceLinks.OslcDataServicesThingTemplate
|
This Thing Template contains data services defined for Windchill
|
ThingTemplate
|
||
|
PTC.PLM.TraceLinks.OslcFlowsTemplate
|
This Thing Template contains the flow services.
|
ThingTemplate
|
||
|
PTC.PLM.TraceLinks.OslcMappingConfigThingTemplate
|
This Thing Template is used to create configuration thing for each external system.
|
ThingTemplate
|
||
|
PTC.PLM.TraceLinks.OslcValidationServicesThingTemplate
|
This Thing Template contains validation services for Windchill.
|
ThingTemplate
|
||
|
PTC.PLM.TraceLinks.ResourceShapeAttributeMappingDataShape
|
This Data Shape is used in OSLCResourceShapeConfigTable for attribute mapping.
|
DataShape
|
||
|
PTC.PLM.TraceLinks.SearchAttributeMappingConfigDataShape
|
This Data Shape is used in OSLCSearchResultConfigTable for attribute mapping.
|
DataShape
|
||
|
TRACELINKS
|
TRACELINKS :OSLC-FLOWS model tag is used to tag all entities available in the extension. For more information, see the topic Tags in the ThingWorx Platform Help Center.
|
ModelTagVocabulary
|
||
|
Windchill_Digital_Product_Traceability-xx.x.xxx.jar
|
This Resource is a part of the Windchill_Digital_Product_Traceability-extension.
|
Resource
|
|
|
Ensure that correct permissions are enabled on the above listed entities. For more information, see Default Permissions for ThingWorx Platform Entities.
|
|
|
A Model Tag is made up of Vocabulary and Terms. For example, in PTC-PLM-ValidationFlows:modeler tag, PTC-PLM-ValidationFlows is the Vocabulary, and modeler is the value for Terms. The value of a model tag is unique for a Thing.
|
b. Windchill_Digital_Product_Traceability_Config_Things — Extract the folder and import the required PTC reference configuration Thing along with the DPTExtensionPropertiesConfigThing to the ThingWorx Platform. Use the imported reference configuration Things as a reference for out-of-the-box supported and validated configurations.
|
Entities
|
Description
|
||||||||
|---|---|---|---|---|---|---|---|---|---|
|
PTCDoorsConfigThing
|
This config Thing contains reference configurations for IBM Rational Doors NG, including all Windchill to IBM Rational Doors NG OSLC data mappings and configurations.
|
||||||||
|
PTCModelerConfigThing
|
This config Thing contains reference configurations for PTC Modeler, including all Windchill to PTC Modeler OSLC data mappings and configurations.
|
||||||||
|
PTCRVSConfigThing
|
This config Thing contains reference configurations for PTC RV&S, including all Windchill to PTC RV&S OSLC data mappings and configurations.
|
||||||||
|
PTCCodebeamerConfigThing
|
This config Thing contains reference configurations for Codebeamer, including all Windchill to Codebeamer OSLC data mappings and configurations.
|
||||||||
|
PTCPolarionConfigThing
|
This config Thing contains reference configurations for Siemens Polarion, including all Windchill to Siemens Polarion OSLC data mappings and configurations.
|
||||||||
|
PTCJiraConfigThing
|
This config Thing contains reference configurations for Jira (SodiusWillert), including all Windchill to Jira OSLC data mappings and configurations.
|
||||||||
|
DPTExtensionPropertiesConfigThing
|
When tagged with TRACELINKS-DPT-EXTENSION-PROPERTIES model tag, Windchill DPT extension can use the following defined properties.
• CACHE-EXPIRY- Determines the validity of the cache entries. The default is set to 5 minutes.
• SCHEDULER-INTERVAL—Determines the frequency at which the cache entries are automatically purged. The default is set to 30 minutes.
• CACHE-USERS—Determines the number of users in the cache entries. The default is set to 200.
• CACHE-RESOURCES—Determines the number of resources that can be cached per user. The default is set to 100.
• LARGE-PREVIEW-SHOW-DIMENSIONS—Determines whether to show large preview in a new tab. When set to No, the default, large preview opens in a new tab. When set to Yes, the preview opens in a pop-up window.
• OSLC-QUERY-PAGESIZE—Determines the number of remote objects that should be displayed per page. Out of the box, it is set to 50.
• DEFINE-RESOURCETYPE-ATTRIBUTE—Specifies the attribute name of the PTC Modeler OSLC server that returns the value of the resource type. The default value is set to ptc_im_am:dynamicUmlClassName.
|
c. Execute the DPTAdminConfigThing service by following these steps:
i. Log in to the ThingWorx platform as an Administrator.
ii. Navigate to > > > tab.
iii. Click Execute.
After successfully running the service, the following message appears: “Permissions applied successfully”
iv. Verify that the DPTEndUserGroup and DPTConfiguratorGroup are created in > . Ensure that the necessary permissions are assigned to the ThingWorx Platform entities.
For more information, see Default Permissions for ThingWorx Platform Entities.
|
|
• The PostDPTExtensionImport service can only be executed by a ThingWorx administrator.
• Existing members and permissions of DPTEndUserGroup and DPTConfiguratorGroup are retained after executing the service.
|
2. In ThingWorx Flow, use the following instructions and create a new connection for the OSLC system with which integration is required. See the topic Creating and Managing Connections in ThingWorx Platform Help Center:
a. Create a Connection for OSLC system.
▪ For basic authentication, select the OSLC Basic connection type.
▪ For SSO configuration, create an OAuth connection.
|
|
You must accept the grant approval for the OSLC OAuth session connection object. For more information, see Creating OAuth Client Connection for ThingWorx.
|
b. Enter the following information in the Add Connection window:
▪ Connection Label — Type a name for the Connection. The connection name specified here is used in the configuration Thing.
▪ Catalog URL — Type the catalog URL of OSLC server of the external system. Refer to the PTC RV&S OSLC Client guide (12.3.0.0 onwards) on Reference Documents, OSLC integration with Integrity Modeler, and OSLC integration with IBM Rational DOORS Next Generation in the PTC Modeler Help Center.
|
|
Refer to the documentation for your supported version of PTC RV&S and PTC Modeler applications.
|
▪ Login credentials to the service account of the external system to access the OSLC server.
▪ Concurrent Requests — Specify the number of simultaneous resource requests invoked from ThingWorx Flow. The default value is 5.
Administrators can modify the number of requests based on the configuration of the server.
c. Save the connection.
d. Click Close.
3. Configure ThingWorx Platform to integrate with OSLC servers of the external system. In ThingWorx Platform, create a configuration Thing.
To create a configuration Thing:
a. Navigate to > and specify the values of the attributes. Select PTC.PLM.TraceLinks.OslcMappingConfigThingTemplate as the Base Thing Template.
b. In the Configuration tab, configure the mappings as explained in the following tables. You can refer to the PTC reference configuration things as an reference and enter the details for OSLC system.
▪ OSLCServerMappingConfigTable
|
Attribute
|
Description
|
||
|---|---|---|---|
|
Server
|
Name of the external OSLC server.
|
||
|
BaseUrl
|
Base URL of the external OSLC server.
|
||
|
ConnectionObject
|
Name of the Connection created for the external OSLC server.
|
||
|
Tag
|
Value of Terms that is defined in the PTC-PLM-Validation-Flows model tag vocabulary to identify the remote server.
This step is optional. This step is required only when you use a validation flow.
For more information on adding tags, see the topic Tags in the ThingWorx Platform Help Center.
|
▪ Attribute Mapping for OSLCResourceMappingConfigTable
|
Attribute
|
Description
|
|---|---|
|
WindchillType
|
Internal name of the Requirement or Architecture Resource from Type Management in Windchill. The trace link is created to the Resource.
|
|
OSLCResourceType
|
Type of the Requirement Resource, Architecture Resource, or their subtypes defined in the external OSLC server. The value of the OSLCResourceType is the name of the resources and their subtypes as configured in the external OSLC server. For example, in PTC Modeler, Activity is defined as a subtype of Architecture domain Resource. A user can define the name as Resource|Activity where, Activity is the subtype for the OSLC type Resource that belongs to the Architecture domain. The name specified for an Architecture Resource type should pipe separated.
|
For information about the internal name of Requirement or Architecture Resource, see Types and Attributes in System Compatibility and Requirements.
 |
Do not remap an OSLC resource type to Windchill object type if the OSLC resource type is already mapped to a Windchill object type. Remapping of Windchill object type to OSLC resource type, initially defined in ThingWorx, after the object has been traced in Windchill, can lead to data corruption.
|
▪ OSLCResourceAttributeMappingConfigTable
|
Attribute
|
Description
|
|---|---|
|
WindchillTableId
|
Table ID in Windchill which displays the data from external OSLC server.
To add multiple Table ID values, use a comma-separated list.
|
|
WindchillType
|
Internal name of the Requirement or Architecture Resource from Type and Attribute Management in Windchill.
|
▪ Attribute Mapping for OSLCResourceAttributeMappingConfigTable
|
Attribute
|
Description
|
||
|---|---|---|---|
|
WindchillAttribute
|
Name of the Windchill attribute to be displayed in the Windchill table.
|
||
|
OSLCResourceAttribute
|
Name of the OSLC resource attribute.
|
||
|
WindchillAttributeDataType
|
Data type of the Windchill attribute. String, Timestamp, and RichText are the data type values supported out-of-the-box.
|
||
|
IsPreview
|
When IsPreview is selected for an attribute, it displays the HTML representation of the traced remote object as exposed by the external OSLC server.
Select the IsPreview checkbox to display small and large previews.
IsPreview is available on the attributes of data type String and RichText. Small preview is displayed for both the data types, however, large preview is displayed only for attributes of data type String.
|
▪ OSLCResourceShapeConfigTable
|
Attribute
|
Description
|
|---|---|
|
OSLCResourceType
|
Supported resource types of Requirement domain, Architecture domain, or Change domain, as defined in the external OSLC server. The value of the OSLCResourceType is the name of the resources, as configured in the external OSLC server.
|
|
OSLCResourceShapeURI
|
URI of the OSLC resource shape for those OSLC servers that do not expose resource shape with OSLC query service, but expose resource shape with another service. For example, IBM Rational Doors NG OSLC server exposes resource shape with Creation Factory service.
|
▪ Attribute Mapping for OSLCResourceShapeConfigTable
|
Attribute
|
Description
|
|---|---|
|
WindchillAttribute
|
Name of the Windchill attribute to be displayed in the Filter Criteria pane of the external resource search picker.
|
|
OSLCResourceAttribute
|
To add a value for an OSLC attribute, follow the naming convention prefix:propertyName. Here, the prefix is the affix added before the property name and propertyName is the attribute name defined by the OSLC server. For example, for an attribute state exposed by PTC RV&S OSLC server, the OSLCResourceAttribute value is dcterms:state.
|
|
OSLCAttributeDataType
|
Data type of the OSLC resource. String, LangString, XMLLiteral, Boolean, DateTime, Decimal, Double, Float, and Integer are the supported OSLC data type values.
|
▪ OSLCSearchResultConfigTable
|
Attribute
|
Description
|
|---|---|
|
WindchillType
|
Supported Windchill resource types for Requirement domain, Architecture domain, or Change domain.
|
▪ Attribute Mapping for OSLCSearchResultConfigTable
|
Attribute
|
Description
|
||
|---|---|---|---|
|
WindchillAttribute
|
Name of the Windchill attribute to be displayed in the Search Result Table pane of the external resource search picker.
|
||
|
OSLCResourceAttribute
|
Name of the OSLC resource attribute.
|
||
|
WindchillAttributeDataType
|
Data type of the Windchill attribute. String, Timestamp, and RichText are the data type values supported out-of-the-box.
|
▪ OSLCRemoteConfigTable
|
Attribute
|
Description
|
||
|---|---|---|---|
|
ReverseLookupURL
|
Relative URL of the reverse lookup service for external OSLC servers. For example, for Codebeamer specify /cb/api/oslc/links/traceLinkResources.
|
||
|
Method
|
HTTP request method supported by the reverse lookup service. Valid values are GET and POST.
|
||
|
TraceableUrlPrefix
|
Prefix used along with the part or traceable object URL. For example, for Codebeamer specify cb:traceLinkTargetURI.
|
|
|
The reverse lookup functionality is supported for PTC Modeler, PTC RV&S, and Codebeamer OSLC servers. Ensure that the attribute values mentioned above are defined in the reference configuration files of the supported OSLC servers only.
|
c. Click Save and Continue.