Configuring OAuth-OSLC authentication for DOORS Web Access

Create a oslcServiceProviders.xml file to store the base_url, consumer_key, and secret property values.

Before you begin

About this task

By default, the product looks for the oslcServiceProviders.xml file under the PUB_install_dir/config directory. The benefit of creating your oslcServiceProviders.xml file under this default PUB_install_dir/config directory is no further configuration is required. However, create a backup of this file when you want to upgrade to a later version of the product. After installation and upgrade, you can place the backup oslcServiceProviders.xml file under the PUB_install_dir/config directory of the newly installed product.
You can specify the oslcServiceProviders.xml file outside the default PUB_install_dir/config directory, but you must specify the location of the oslcServiceProviders.xml file with the com.ibm.rational.rpe.config.oslcServiceProviders property. If the location is an HTTP secured path, you must specify the authentication credentials with the com.ibm.rational.rpe.config.oslcServiceProviders.usr and com.ibm.rational.rpe.config.oslcServiceProviders.pwd properties. Specify these properties by using one of the following scopes:
  • Environment variables in your operating system
  • Java™ properties in your Java virtual machine (JVM)
  • Flags in your runtime environment. See the following topic for more information about configuring flags for client applications

Creating the oslcServiceProviders.xml file outside the default PUB_install_dir/config directory supports team collaboration environments. The oslcServiceProviders.xml file can be reused by multiple users when placing the file in a shared location, and set the com.ibm.rational.rpe.config.oslcServiceProviders property to point to the shared location.

Procedure

  1. Create a copy of the sample in the installation directory: PUB_install_dir/config/oslcServiceProviders-sample.xml
  2. In a text editor, open your copy of the oslcServiceProviders.xml file.
  3. In the title tags, provide a name for the data source provider.
  4. In the description tags, provide a description or notes for the data source provider.
  5. In the base_url tags, provide the base URL to the data source.

    To identify the URL in DOORS Web Access client, right-click an object URL from an open module and click Copy URL.

    To identify the URL in DWA, go to the Database Explorer view, open a module and select an object. Under the Attributes > Systems section, copy the value in the URL field. For example, by right-click the URL field and select the Copy shortcut menu option.

    Example: https://server:port/dwa

  6. In the pattern tags, provide the URL pattern of the data source.
    Typically, the base_url and pattern tags contain the same DWA data source URL value.
    When you have a list of data sources specified in the oslcServiceProviders.xml file, the pattern is used to identify which data source details match the data source requirements.

    Example: https://server:port/dwa

  7. In the consumer_key tags, provide the consumer key from the data source.

    To identify the consumer_key value, in DOORS click File > OSLC > Local keys.

  8. In the secret tags, provide the secret value from the data source.

    To identify the secret value, in DWA click File > OSLC > Local keys. Locate the OAuth secret field. The OAuth secret value is the value to enter in the IBM Engineering Lifecycle Optimization - Publishing secret property.

  9. Save the oslcServiceProviders.xml file to a location outside of the installation directory.