Configuring the Windchill adapter properties

To configure the necessary properties of the adapter with particular values for the current deployment, first read this guide and then visit the Adapter welcome page at https://oslc-windchill.acme.com:port/oslc-windchill/ and click the wheel icon on the upper right corner which leads to the configuration page at https://oslc-windchill.acme.com:port/<context-path>/configuration/admin.

The configuration page offers these forms for setting properties, each form is provided on a separate “tab” of the page:

The valid attributes for each Property are as follows, the values shown as strings are only examples and must be modified for the actual configuration in place:

Attribute Description
name The name of the context initialization parameter to be created.
description Optional, human-readable description of this context initialization parameter.
value The parameter value that will be presented to the application.
panel The panel where this value can be set.

Windchill-related Adapter Properties

Attribute Description
name Windchill Server
description This is a read-only value of the Context Parameter set for the URL to the Windchill web server to which the Adapter must connect to.
value Displays the (already set) URL of the server on which Windchill is installed for information purposes.
panel Windchill pane
Attribute Description
name Product OSLC attribute
description Name of the Windchill attribute defined on the type Product on which the Adapter shall store related OSLC resource information.
value Enter the name of the Windchill attribute you created for the type Product
panel Windchill pane
Attribute Description
name Change Request OSLC attribute
description Name of the Windchill attribute defined on the type ChangeRequest on which the Adapter shall store related OSLC resource information.
value Enter the name of the Windchill attribute you created for the type ChangeRequest
panel Windchill pane

License-related Adapter Properties

The adapter may implement license-restricted use such that each instance of the adapter must acquire the contractual number of licenses (see EULA Notices). This “Licensing” tab will be present when license-restricted use is in effect--and it will be hidden when license-restricted is not in effect.

Attribute Description
name License Server Port
description Internet Protocol Port used by the listening License Server.
value 27000 (e.g. typical for FlexLM)
panel Licensing pane
Attribute Description
name License Server Host
description Fully-qualified Domain Name of a listening License Server.
value rlia-tls.acme.org, for example
panel Licensing pane

After the port and host for a license server has been entered, the “Signal” icon can be clicked to test if there is a service listening on the configured port that is reachable from the host on which the adapter is running. Using the test is optional and the settings here can be saved even if the test indicates that the target server is not currently reachable. It may be that the license server specified is out of service when provisioning the adapter. Note that the license server selected must be available when users attempt to use the services of the adapter.

The “signal” widget will also attempt to access a license-restricted resource ( at the URL “services/cm/changeRequest/is/access/granted” ) if the configuration for the license server is correct. If that access is granted, then all other services of the adapter are also granted. When that access is not granted, all other services of the adapter likewise are denied.

The Checkin and Checkout icons next to the Signal icon can be used to test the release and request of licenses from the license server.

Attribute Description
name License Server Log Path
description Absolute, OS-specific path to the location of a log output file for License operations.
value C:\\Logging\\Outputs\\, for example
panel Licensing pane

Tracked Resource Set-related Adapter Properties

Attribute Description
name Username
description Username of the account used by the adapter to retrieve the URI that will be exposed to RELM.
value Enter the name of the Windchill user which is granted the relevant access to retrieve the change requests from Windchill
panel TRS pane
Attribute Description
name Password
description Password of the account used by the adapter to retrieve the URI that will be exposed to RELM.
value Enter the password of the Windchill user which is granted the relevant access to retrieve the change requests from Windchill
panel TRS pane
Attribute Description
name Refresh interval
description Delay in seconds between queries to Windchill in order to update the Base/Changelog.
value Enter the number of seconds the adapter will wait between two queries to update the Base/Changelog. Typical values range from 10 seconds 120 seconds. The lesser the value the sooner LQE will be notified, but the more resources the adapter will consume.
panel TRS pane
Attribute Description
name Number of resources per page in TRS responses
description Number of resources displayed in a TRS Changelog page or TRS Base page.
value Enter a positive integer specifying the number of resources a Base or Changelog page should hold. Typical values range from 100 to 1000. Retrieving more resources in a page avoids having to get too many pages to retrieve the Base/Changelog, so would use little less resources, but it takes more time to compute so one needs to ensure the query will not timeout.
panel TRS pane
Attribute Description
name Limit on resources per TRS request to Windchill
description Maximum number of resources the adapter will ask Windchill for in each of its requests.
value Enter a positive integer specifying the number of resources the adapter should ask for in each of its requests. Typical values range from 100 to 1000. Retrieving more resources at any given time will speed up the sync between the adapter and Windcihll, but will use more resources on the Windchill side.
panel TRS pane

Note 1: It is mandatory that the following values match the values you choose for the Internal Name when you created the Product and Change Request attributes. See Extending the Windchill Data Model for reference.