Configure the OData Connector
ThingWorx Navigate supports using the OData connector with Windchill REST Services to access data for your custom task.
 |
WindchillConnector (ptc-windchill-demo-thing) is removed as of ThingWorx Navigate 9.2. If necessary, update your custom tasks to use the OData connector.
|
Prerequisites
You must have ThingWorx Integration Runtime configured before using the OData connector. In general, ThingWorx Integration Runtime is configured by the ThingWorx Navigate installation tool as part of the installation process.
Create the Connector
There are two options available for setting up the OData connector: either you can create a new instance of the connector, or you can use the out-of-the-box connector ptc-windchill-OData-connector. Choose the best option for your use case.
For custom tasks that use Info*Engine tasks, it is recommended that you use the out-of-the-box ptc-windchill-OData-connector. This is because the Info*Engine services are already available on out-of-the-box connector.
To create a new instance of the OData Connector, follow these steps:
1. In ThingWorx Composer, browse Modeling > Integration Connectors, and then click New.
2. In the Choose Template window, select the ODataConnector Thing Template, and click OK.
3. Enter a name and a project for the connector.
Now you’re ready to configure the connector.
Configure the Connector
1. In Composer, open the connector you created or search for ptc-windchill-OData-connector and open it. The General Information page opens.
2. Click on the Configuration tab. The Configuration page opens.
Your configuration depends on your authentication method: Single Sign-on, Windchill Authentication, or Fixed Authentication.
Single Sign-on
Follow these steps if you have Single Sign-on configured:
1. Under Generic Connector Connection Settings, for the Authentication Type, select SSO.
2. Under Authorization Server ID, enter the AuthorizationServerSettingsID value you provided in sso-settings.json, such as PingFed1.
3. Under Authorization Server Scopes Settings, click Add. The AuthorizationServerScopesSettings window opens.
4. Under Scope, enter the Windchill scope you registered in PingFederate, such as WINDCHILL.
5. Click Add.
6. Under CSRF Settings, enter this information:
◦ Relative URL For CSRF Get Request—/servlet/odata
◦ CSRF Token Name—CSRF_NONCE
7. Under HTTP Connector Connection Settings, enter this information:
◦ Base URL—The Windchill URL. The URL must end with /oauth. Use this format:
[https]://[Windchill Host]:[port]/[Windchill-web-app]/oauth
This format specifies that the connection uses the OAuth standard and enables requests for data in the resource provider.
◦ Relative URL—/servlet/odata
There’s no need to enter the username and the password.
8. Click Save. The OData connector is now configured to work in your Single Sign-on environment.
Windchill Authentication
Follow these steps if you have Windchill Authentication configured:
1. Under Generic Connector Connection Settings, for the Authentication Type, select None.
2. Under CSRF Settings, enter this information:
◦ Relative URL For CSRF Get Request—/servlet/odata
◦ CSRF Token Name—CSRF_NONCE
3. Under HTTP Connector Connection Settings, enter this information:
◦ Base URL—The Windchill server that receives the Info*Engine Request from the ODataConnector. Use this format:
[https]://[Windchill Host]:[port]/[Windchill-web-app]/sslClientAuth
◦ Relative URL—/servlet/odata
◦ Connection URL—/servlet/WindchillGW/wt.httpgw.HTTPServer/ping
There’s no need to enter a username and password.
4. Click Save. The OData connector is now configured to work in your WindchillAuthentication environment.
Fixed Authentication
Follow these steps if you have Fixed Authentication configured:
1. Under Generic Connector Connection Settings, for the Authentication Type, select Fixed.
2. Under CSRF Settings, enter this information:
◦ Relative URL For CSRF Get Request—/servlet/odata
◦ CSRF Token Name—CSRF_NONCE
3. Under HTTP Connector Connection Settings, enter this information:
◦ Username—Your Windchill administrator user name
◦ Password—Your Windchill administrator password
◦ Base URL—The Windchill server that receives the Info*Engine Request from the ODataConnector. Use this format:
[https]://[Windchill Host]:[port]/[Windchill-web-app]
◦ Relative URL—/servlet/odata
4. Click Save. The OData connector is now configured to work in your Fixed Authentication environment.
Expose Services on the Connector
After configuring the connector, the next steps depend on your custom tasks:
• For custom tasks that do not use Info*Engine tasks, expose the necessary services on the connector. For information on exposing services, see the topics Exposing Services on the Integration Connectors and Creating a New API Map for the Service in the Help Center.
• For custom tasks that use Info*Engine tasks, continue to the topic Execute Info*Engine Services with the OData Connector.