Configuring the Windchill RV&S OSLC Server
You must configure properties for the Windchill RV&S OSLC Server and the Windchill RV&S server before starting the Windchill RV&S OSLC Server. Use the production.json file located in <installdir>/config/ to configure these properties.
For more information on configuring the server properties, refer to, Configuring the OSLC Server Properties.
After you configure the server properties, for supported domains, you must map OSLC types and fields, in specific domain mapping .json files.
Windchill RV&S server supports the Requirements Management and the Change Management domains. For information on mapping supported domains, refer to,
Mapping Supported Domains.
Configuring the Windchill RV&S OSLC Server Properties
You must manually edit the following configuration properties under the oslc property in the production.json file for the Windchill RV&S OSLC Server:
|
Property
|
Description
|
||
|---|---|---|---|
|
alias
|
Name of the Windchill RV&S server. This property is used to display delegated UIs and the value specified here must match the name specified in the is.properties file of the Windchill RV&S server.
For example, the alias property could have a value of OSLCServer1, if the is.properties file has the following properties set:
mksis.wrvsOslcServerList=OSLCServer1
mksis.oslc.server.OSLCServer1.baseUrl
For example:
mksis.oslc.server.myOSLCServer1.baseUrl=https://localhost:3001/oslc/r
|
||
|
scheme
|
Protocol scheme supported by the Windchill RV&S OSLC Server.
Supported protocol is http or https.
Default protocol is https.
|
||
|
host
|
Host name of the Windchill RV&S OSLC Server.
Default host name is localhost.
|
||
|
port
|
Port number of the Windchill RV&S OSLC Server.
Default port number is 3001.
|
||
|
context
|
Context URI of the Windchill RV&S OSLC Server.
Default is /oslc/r.
|
||
|
storageImpl
|
Reserved property. Do not modify.
|
||
|
services
|
Reserved property. Do not modify.
|
||
|
contentType
|
Reserved property. Do not modify.
|
||
|
sslPrivateKey
|
Private key for the SSL certificate.
Default value is server.key.
Update the private key corresponding to your SSL certificate.
|
||
|
sslCertificate
|
Name of the SSL certificate.
Default value is server.cert.
Update the value per the name of the SSL certificate installed on your Web server.
|
||
|
useClientAuthForSSL
|
Reserved property. Do not modify.
|
||
|
allowedOrigins
|
Allow list of domains for permitting cross-origin requests to the Windchill RV&S OSLC Server.
Specify the domain name in the <scheme>://<host>:<port> format, where <scheme> is http or https.
For example, to allow connection requests for accessing the delegated UI from a Windchill instance hosted at https://myexample.com:8888, specify the domain name https://myexample.com:8888 as the value of this property.
Multiple domains are supported. To specify multiple domains, provide the domain names per the format separated by a comma. For example, https://myexample.com:8888,http://localhost:8080.
|
||
|
supportedDomains
|
Specify the domain services to be exposed. You can use this property when you want specific domains exposed irrespective of the domains that are supported. Windchill RV&S supports the Requirements Management (rm) and the Change Management (cm) domains. So the valid values are rm and cm.
You can specify multiple domains as follows (case-sensitive):
"supportedDomains": "rm,cm"
You can specify a single domain as follows (case-sensitive):
"supportedDomains": "rm"
If this property is not specified, then all supported domains are exposed.
|
||
|
isamScheme
|
Supported scheme on the ISAM virtual host junction for the Windchill RV&S OSLC Server.
Supported scheme is https.
|
||
|
isamHost
|
Host name of the Windchill RV&S OSLC server configured on the ISAM virtual host junction.
|
||
|
isamPort
|
Port number of theWindchill RV&S OSLC Server configured on the ISAM virtual host junction.
|
||
|
appendSlash
|
Append a slash to the start of the project name in the URIs if the Windchill RV&S OSLC Server is configured with the ISAM authentication scheme.
|
||
|
oauthAuthorizationURI
|
URI for obtaining OAuth authorization.
Contact the PingFederate administrator for the OAuth authorization URI.
|
||
|
oauthAccessTokenURI
|
URI for obtaining OAuth access token.
Contact the PingFederate administrator for the OAuth access token URI.
|
||
|
oauthRequestTokenURI
|
URI for obtaining OAuth request token.
Contact the PingFederate administrator for the OAuth request token URI.
|
 |
• For a SSO-enabled configuration, the OSLC clients can automatically discover the three OAuth URIs that are required to act as an OAuth Consumer. These URIs are returned in the service provider catalog if the oauthAuthorizationURI, oauthAccessTokenURI, and oauthRequestTokenURI properties are specified in the production.json file.
For more information on the supported SSO configuration for Windchill RV&S, see Windchill RV&S Single Sign-On Configuration Guide.
• The OSLC APIs utilize the OAuth tokens for connecting to the target OSLC servers in the Refreshed Web Interface when SSO is enabled.
|
Configuring the Windchill RV&S Server Properties for the Windchill RV&S OSLC Server
You must manually edit the following configuration properties under the ilm property in the production.json file for the connection between the Windchill RV&S server and the Windchill RV&S OSLC Server:
|
Property
|
Description
|
||
|---|---|---|---|
|
scheme
|
Protocol scheme on which the Windchill RV&S server is running.
Supported protocol is https.
|
||
|
host
|
Host name of the Windchill RV&S server.
Default host name is the host name set during installation of the Windchill RV&S OSLC Server.
|
||
|
port
|
Port number of the Windchill RV&S server.
The default port number is the port number set during installation of the Windchill RV&S OSLC Server.
|
||
|
baseContext
|
Base URI for the Windchill RV&S REST services.
|
||
|
strictSSL
|
Support for trusted or self-signed certificates for the connections.
If value is set to true, only trusted certificates are supported for the connections.
If value is set to false, both trusted and self-signed certificates are supported for the connections.
Default value is false.
|
||
|
docStudioContext
|
Provides the context to the linked Windchill RV&S item in the resource previews.
|
||
|
isSSO
|
Support for Single Sign-On (SSO) configuration.
Set the value of this property to true if an OSLC server is connected to SSO-enabled Windchill RV&S server.
Default value is false.
Based on an SSO or non-SSO scenario, the selectionUIContext and previewUIContext property values will change. Refer to these properties described further in this table.
|
||
|
isamScheme
|
Supported scheme on the ISAM virtual host junction for the Windchill RV&S server.
Supported scheme is https.
|
||
|
isamHost
|
Host name of the Windchill RV&S server configured on the ISAM virtual host junction.
|
||
|
isamPort
|
Port number of the Windchill RV&S server configured on the ISAM virtual host junction.
|
||
|
selectionUIContext
|
Property to generate the URL of the extended Web UI for the selection UI of Windchill RV&S.
For a non-SSO scenario, the property value should be:
"/extended-web-ui/oslc/selection"
For an SSO scenario, the property value should be:
"/extended-web-ui/oslc/redirect/selection"
|
||
|
previewUIContext
|
Property to generate the URL of the extended Web UI for the preview UI of Windchill RV&S.
For a non-SSO scenario, the property value should be:
"/extended-web-ui/oslc/previews"
For an SSO scenario, the property value should be:
"/extended-web-ui/oslc/redirect/previews"
|
|
|
When using selection UIs and preview UIs in browsers that support storage APIs where the web page does not have access to the browser storage, users might be prompted to click a link to grant storage access. The link, Click here to allow storage access, must be clicked for the selection UIs and preview UIs to be loaded.
|