TraceLinks Reviewer WinDU Task
This section describes the prerequisites steps for running the TraceLinks Reviewer diagnostic task in the Windchill Diagnostic Utility (WinDU). This task scans all trace links in Windchill and generates a CSV report listing their validity status.
Prerequisites
Before running the TraceLinks Reviewer diagnostic task, complete the following steps:
1. Add an OSLC connector in ThingWorx Flow:
◦ For non-SSO environments, add a basic OSLC connector.
◦ For SSO-enabled environments, add an OAuth-based (Named User) OSLC connector.
For more information about supported OSLC types, see Supported OSLC Connector Types in the ThingWorx Flow Help Center.
 |
• Ensure that the connector is configured with the credentials of a user who has the necessary privileges to access OSLC data across the system (for example, an OSLC server system administrator).
• Create a separate OSLC connector for each external OSLC server.
|
2. Enter the Connector Label used to configure the OSLC connector in the OSLC-CONNECTION_NAME property on the Properties tab of the reference configuration Thing (for example, PTCCodebeamerConfigThing).
3. Create an application key in ThingWorx Platform.
For more information, see Application Keys in the ThingWorx Platform Help Center.
4. Run the captureIntegrationConnection.[sh|bat] utility.
Execute the following command from the Windchill shell:
captureIntegrationConnection.[sh|bat] -n <Connection Name> -b <Base URL> -a <Authentication Delegate Class Name> -h "<Request Headers>" -s "<Base64 Encoded Secrets>"
Specify the following parameters in the utility:
|
Parameter
|
Description
|
||
|---|---|---|---|
|
<Connection Name>
|
Name of the DPT integration connection.
For ThingWorx, specify twx.
|
||
|
<Base URL>
|
Base URL for the ThingWorx connection.
|
||
|
<Authentication Delegate Class Name>
|
Name of the authentication delegate class.
For ThingWorx, specify com.ptc.windchill.integrations.auth.TWXAuthDelegate.
|
||
|
<Request Headers>
|
Request headers.
For ThingWorx, specify x-thingworx-session=false|Content-Type=application/json|Accept=application/json.
|
||
|
<Base64 Encoded Secrets>
|
Secret application key for ThingWorx.
|
Example:
captureIntegrationConnection.[sh|bat] -n twx -b https://thingworx-dev.acme.com -a com.ptc.windchill.integrations.auth.TWXAuthDelegate -h "x-thingworx-session=false|Content-Type=application/json|Accept=application/json" -s "appkey=YWJjZDEyMzQtZW1NiaDcLWlqay1sbW5Fyc3R1OTA="
|
|
• You can modify the batch size using the com.ptc.linkreviewer.batchsize property. The default value is 200.
• The TraceLinks Reviewer diagnostic task can be scheduled using the Windchill Diagnostic Task Scheduler.
|
Executing the TraceLinks Reviewer Task
Once all prerequisites are completed, run the TraceLinks Reviewer diagnostic task in the Windchill Diagnostic Utility. For more information, see Windchill Diagnostic Utility Guide.