Add ALM Octane as a request provider

You can add and modify ALM Octane instances to provide work items for Dimensions CM.

Add an ALM Octane request provider

You can add one or more instances of ALM Octane as request providers for Dimensions CM projects/streams.

ALM Octane 16.0.100 and later: To integrate with Dimensions CM, ALM Octane users and API access accounts require the following permission: Integrations > Get API response with user data.

To add an ALM Octane instance:

  1. Log in to the Dimensions CM Administration Console.
  2. In the Database Management section, select Request providers. The Request Providers page opens.
  3. In the toolbar, click New . The New Request Provider dialog box opens.
  4. Enter the following details:

    Type From the Type list, select ALM Octane.
    ID Enter a unique ID for the provider instance.
    Name Enter a user-friendly name for the ALM Octane provider instance.
  5. Click Next.

  6. Specify connection details for the ALM Octane instance:

    Server URL

    Enter the ALM Octane server URL in one of these formats:

    https://<host>:<port>

    https://<host>:<port>/ui/?p=<spaceID>/<workspaceID>

    If you provide an ALM Octane URL with space and workspace IDs, additional attributes are filled automatically.

    Space Specify an ALM Octane space ID, for example, 1001.
    Workspace Specify an ALM Octane workspace ID, for example, 1002.

    Client ID
    and
    Client secret

    To access ALM Octane using a single API account, enter the Client ID and Client Secret keys generated in ALM Octane.

    For details about creating API access keys, see the ALM Octane help.

    To access ALM Octane using your login and password, leave the fields empty. In this case, you need the same login and password for both ALM Octane and Dimensions CM.

  7. Click Next.
  8. Define which streams and projects will use work items from the ALM Octane instance. Move these projects/streams from the Available streams and projects list to Mapped to provider streams and projects.

    SHIFT+click to select a range of projects/streams. CTRL+click to select multiple non-consecutive projects/streams.

    To use work items from this ALM Octane instance in all Dimensions CM projects/streams, select <All streams and projects>.

  9. Click Finish.

After you connect an ALM Octane request provider, it is displayed in the ALM Octane node in the side navigation pane. To view the provider's details and mappings, expand the node and click the provider instance.

Back to top

Change projects/streams for an ALM Octane provider

You can change the projects/streams assigned to an existing ALM Octane instance.

To remap projects/streams to an ALM Octane provider:

  1. Log in to the Dimensions CM Administration Console.
  2. In the Database Management section, select Request providers. The Request Providers page opens.
  3. In the side navigation pane, expand the ALM Octane node and select an ALM Octane instance.

  4. In the content pane, in the Mapping section, click Change mapped streams/projects .
  5. In the dialog box that opens, change the mappings as needed.

    To assign projects/streams, move them from the Available streams and projects list to Mapped to provider streams and projects.

    To remove the assigned projects/streams, move them from the Mapped to provider streams and projects list back to Available streams and projects.

    SHIFT+click to select a range of projects/streams. CTRL+click to select multiple non-consecutive projects/streams.

  6. Click OK.

Back to top

Modify an ALM Octane instance

When you edit an ALM Octane instance, you can change its ID, name, connection details, and project/stream mappings.

To edit an ALM Octane request provider:

  1. Log in to the Dimensions CM Administration Console.
  2. In the Database Management section, select Request providers. The Request Provider page opens.
  3. In the side navigation pane, expand the ALM Octane node and select an ALM Octane instance.

  4. In the toolbar, click Edit .
  5. In the Edit Request Provider dialog box, make the changes and click Finish.

Back to top

Remove ALM Octane instances

You can remove ALM Octane request providers if you no longer use them to supply requests.

Caution: After you remove an ALM Octane provider, Dimensions CM clients will keep only the IDs of its used requests, removing other request details, such as title and owner.

To remove one or more ALM Octane instances:

  1. Log in to the Dimensions CM Administration Console.
  2. In the Database Management section, select Request providers. The Request Provider page opens.
  3. In the side navigation pane, select the ALM Octane node.

  4. In the content pane, in the Requests Providers section, select one or more ALM Octane request providers to remove.

  5. Click Delete request provider and confirm.

Back to top

See also: