Adding a New OSLC Server
The Windchill RV&S OSLC Client can discover OSLC resources provided by the Windchill Modeler OSLC Server and the Windchill OSLC Server. To access these resources, the Windchill RV&S server administrator must add the Windchill Modeler OSLC Server and the Windchill OSLC Server.
To add the supported OSLC servers, edit the OslcServers.xml file located in <Windchill RV&S installdir>/data/oslc.
A sample of the OslcServer node is as follows:
Edit the following properties in the OslcServers.xml file:
Property | Description | ||||
|---|---|---|---|---|---|
ServerID | ID of the OSLC server.
| ||||
ServerType | Type of OSLC server. Supported OSLC server types are: • INTEGRITY_MODELER • WINDCHILL • WRVS
| ||||
RootCatalogURI | URI of the base catalog. The URI must contain the fully qualified domain name of the host. | ||||
AuthenticationURI | URI for the Windchill Modeler OSLC Server authentication. This property is required only for the BEARER_TOKEN authentication scheme. This property is required only for a Windchill Modeler OSLC Server. | ||||
AuthenticationScheme | Supported authentication scheme. The supported authentication scheme for the Windchill Modeler OSLC Server is BEARER_TOKEN. The supported authentication schemes for the Windchill OSLC Server are : • BASIC • OAuth2 The supported authentication schemes for the Windchill RV&S OSLC Server are: • BASIC • ISAM • OAUTH2 For more information on the support for client-side certificate-based authentication using IBM Security Access Manager (ISAM), see Windchill RV&S Server for IBM Security Access Manager and the Windchill RV&S OSLC Server guide. For more information on the Single Sign-On (SSO) configuration, see Windchill RV&S Single Sign-On Configuration Guide.
| ||||
ExternalOSLCLinkLookupURI | Reverse lookup URI of the Windchill Modeler OSLC Server or the Windchill OSLC Server. This property is required for external OSLC links (reverse lookup) requests. To register the Windchill Modeler OSLC Server or the Windchill OSLC Server for external OSLC links only, specify the ExternalOSLCLinkLookupURI property. Do not specify the RootCatalogURI property in such cases. For example, for Windchill Modeler: <scheme>://<host name>:<port>/oslc/links. For example, for Windchill: <scheme>://<host name>:<port>/Windchill/oslc/config/links/traceLinkResources. For more information on the external OSLC links, see
Viewing External OSLC Links Associated with Windchill RV&S Resources.
| ||||
Domains | Specify the information of the child properties and attributes of Domains, including Domain url and LinkTypes. | ||||
Domains>Domain | At least one Domain must be specified. In the url attribute, specify the URI of the domains supported by the target OSLC server. The url attribute is mandatory. Supported domains and the corresponding URIs are as follows: • Requirements Management domain: http://open-services.net/ns/rm# • Architecture Management domain: http://open-services.net/ns/am# • Configuration Management domain: http://open-services.net/ns/config# The Windchill Modeler OSLC Server provides support for the Requirements Management domain and the Architecture Management domain. The Windchill OSLC Server provides support for the Configuration Management domain. The Windchill RV&S OSLC Server provides support for the Requirements Management domain. | ||||
Domain>LinkTypes | Multiple link type names can be configured. Each link type must contain a name attribute as follows: <LinkType name="Validated By"/> At least one LinkType must be specified. The name attribute is mandatory for LinkType. If multiple LinkType elements have the same name attribute but with different case (upper/lower), the one mentioned first will be considered and the rest will be ignored. | ||||
Parameters | Multiple parameters are supported. Each parameter should contain the following three attributes for the Windchill Modeler OSLC Server and the Windchill OSLC Server: • resourceType (corresponding to the specified domain) The resource type supported by the Windchill Modeler OSLC Server for the Requirements Management domain is: ◦ http://open-services.net/ns/rm#requirement The resource type supported by the Windchill Modeler OSLC Server for the Architecture Management domain is: ◦ http://open-services.net/ns/am#resource The resource types supported by the Windchill OSLC Server for the Configuration Management domain are: ◦ http://open-services.net/ns/config#VersionResource ◦ http://open-services.net/ns/config#Component • selectAttributes The values for this attribute define the columns that appear in the query result when you query for the exposed OSLC fields provided by the supported OSLC servers. For the Windchill OSLC Server, the sample values for the selectAttributes attribute are as follows: “dcterms:title,oslc:shortId,oslc_config:versionId” For the Windchill Modeler OSLC Server, the sample values for the selectAttributes attribute are as follows: “dcterms:title,dcterms:modified” • whereAttributes The values for this attribute define the available filters that you can use for querying exposed OSLC fields provided by the Windchill OSLC Server. For the Windchill OSLC Server, the sample values for the whereAttributes attribute are as follows: “dcterms:title,oslc:shortId”
For the Windchill RV&S OSLC Server, specify the resourceType parameter only.
The resource types supported by the Windchill RV&S OSLC Server for the Requirements Management domain are: • http://open-services.net/ns/rm#Requirement • http://open-services.net/ns/rm#RequiremenCollection The requirements-domain-mapping.json mapping file contains the values for the where and select attributes under requirementCollectionsQuery or requirementsQuery for the query property. For more information on the requirements-domain-mapping.json file, see the Windchill RV&S OSLC Server guide. | ||||
Properties | The following properties are supported: • coreVersion Version of the supported OSLC specification. The Windchill Modeler OSLC Server supports OSLC Core Version 2.0 specification. The Windchill OSLC Server and Windchill RV&S OSLC Server support OSLC Core Version 3.0 specification. • modelerServerNameDecode Resolves the name of the Windchill Modeler Server in the query URI. Default value is false.
• windchillBasicPreview To view previews of Windchill OSLC links in the Windchill RV&S client, when the Windchill version is earlier than 12.1.0.0, set the value of the windchillBasicPreview property to true. If the property is set to false or is absent, previews of Windchill OSLC links might not be visible when the Windchill version is earlier than 12.1.0.0. If the property is set to true, previews of Windchill OSLC links will be displayed as basic HTML. | ||||
IsamHostURI | Virtual host URI of the Windchill RV&S OSLC Server configured on the ISAM virtual host junction. For example, https://host1.ptc.com:4444.
|
After editing the OslcServers.xml file, restart the Windchill RV&S server. Any edits to the OslcServers.xml file requires restart of the Windchill RV&S server for changes to take effect.
 | • The Windchill RV&S OSLC Server does not support creation of OSLC links between the same Windchill RV&S server from which the OSLC requests are initiated. • Updates to the OslcServers.xml file in the older releases are not retained after upgrading to the 13.1.0.0 release. Administrators must take the backup of the OslcServers.xml file before upgrading to the 13.1.0.0 release. After upgrading, administrators must restore the updates in the OslcServers.xml file. • Ensure that the OslcServers.xml file is configured correctly for the supported OSLC servers. If OSLC servers are configured incorrectly, DocStudio displays an error when you connect to the OSLC servers. • Ensure that the Windchill RV&S OSLC Client and the supported OSLC servers are part of the same domain. |