ChatOps integrations

This section provides instructions for integrating with a ChatOps application, such as Slack or Microsoft Teams. The integration enables all stakeholders to collaborate and communicate.

In this topic:

Set up a Slack integration

To set up integration with Slack, add your workspace to a Slack workspace. This enables users to open Slack channels for discussions from within OpenText Software Delivery Management items, allowing stakeholders of backlog items or pipeline run failures to communicate. For details, see Collaborate.

If you configure the integration to expose OpenText Software Delivery Management data on Slack channels, information from the backlog item is sent to the channel.

Note: You can add your workspace to only one Slack workspace.

We recommend using different Slack workspaces for different OpenText Software Delivery Management workspaces.

To enable your workspace users to collaborate in Slack, define Slack as a collaboration tool in OpenText Software Delivery Management, and add your OpenText Software Delivery Management workspace to your Slack workspace.

  1. Prerequisite. Create a Slack app for OpenText Software Delivery Management to use. For details, see Create a Slack app for on-premises deployments.

  2. Open the Settings menu , click Spaces, and select your workspace.

  3. Click the DevOps tab, and select Collaboration Tools.

  4. Click the More dropdown button and select Slack as the collaboration tool if it is not already selected. The Add Collaboration Tool dialog box opens.

  5. In Slack, make sure you have a workspace to use for all communication related to this OpenText Software Delivery Management workspace. Add all of your OpenText Software Delivery Management workspace members to the Slack workspace.

    If you do not have such a workspace, click the link in the Add Collaboration Tool dialog box to open Slack and create a workspace.

    • When creating a new Slack workspace, make sure to use an email address that you can access. Slack sends a confirmation code to this address as part of the process.

      You can use the same email address to create different Slack workspaces.

    • You can add members to the Slack workspace at any time.

    When you finish creating the Slack workspace, go back to the OpenText Software Delivery Management browser tab.

  6. Consider whether to allow exposing internal OpenText Software Delivery Management information on the Slack channel.

    If you select the checkbox for this option in the Add Collaboration Tool dialog box, information about the relevant backlog items are sent to the Slack channels that it opens.

    Note: You can modify this setting at any time in the Collaboration Tools grid.

  7. Click Add to Slack to add your OpenText Software Delivery Management workspace to the Slack workspace.

    The OpenText Software Delivery Management chat application registered on Slack requests access to your Slack workspace.

    For SaaS OpenText Software Delivery Management, the name of the application is octanechatsapp. For on-premises OpenText Software Delivery Management, the application is set up by your site admin.

  8. (Optional) Select a different Slack workspace and choose whether to expose more or less information about your Slack workspace to OpenText Software Delivery Management.

  9. Click Authorize.

The integration with Slack is complete. The Chat w/ Slack button is now enabled in backlog items and in a pipeline run's Tests tab.

Troubleshooting: If the integration setup fails due to a communication failure, reporting an inaccessible redirect_url, contact your site admin to make sure that the configuration parameter SERVER_BASE_URL is defined correctly. For details, see Configuration parameters.

Back to top

Create a Slack app for on-premises deployments

To enable configuring Slack integration on your OpenText Software Delivery Management site, the site admin creates a Slack app and configures OpenText Software Delivery Management to use it.

To create a Slack app:

  1. Using a Slack account that belongs to OpenText Software Delivery Management's site admin, create a new Slack app for OpenText Software Delivery Management to use.

    A single Slack application can serve many OpenText Software Delivery Management instances. For detailed instructions, refer to the Slack API documentation.

  2. Complete the new Slack app's configuration and activate distribution:

    1. In Add features and Functionality, click Permissions and select any permission scope. OpenText Software Delivery Management does not rely on this configuration.

    2. In Manage Distribution, click Distribute App and configure sharing your app with other workspaces. Add an OAuth Redirect URL with OpenText Software Delivery Management's URL.

      Add the URL in the following format (port number is optional) and click Save URLs: http://<OpenText Software Delivery Management hostname / IP address> {:<port number>}/internal-api

      For example, http://myServer.myCompany.com:8081/internal-api

    3. In Remove Hard Coded Information, select the check box.

    4. Click the button to activate distribution.

    5. At https://api.slack.com/apps, make sure the app's distribution status is Distribution activated.

  3. Provide OpenText Software Delivery Management with the credentials required for working on behalf of the Slack app you created.

    1. In the Slack app's Basic Information > App Credentials area, locate the Client ID and Client Secret.

    2. Enter the client ID and secret values respectively into the OpenText Software Delivery Management configuration parameters: SLACK_INTEGRATION_CLIENT_ID, SLACK_INTEGRATION_SECRET.

      For details, see Configuration parameters.

    4. Back to top

Set up a Microsoft Teams integration

To prepare your system to integrate with Microsoft Teams, register the Teams app in Azure, and then enable your workspace users to collaborate in Microsoft Teams.

Registering Teams in Azure establishes a trust relationship between your application and the identity provider, the Microsoft identity platform. For more details, refer to the Azure documentation.

The integration with Microsoft Teams lets you send comments to a specific Teams channel.

To register Teams in Azure:

  1. Open the Azure portal using the organization's account.

  2. Log in as a tenant admin. This allows you to grant consent for the permissions that will be required later.

  3. Open the Active Directory service.

  4. In the navigation side pane, click App registrations, and click New application registration.

  5. In the App > Authentication section, create a redirect URI to:

    https://<server_base_url>/api/msteams-integration/auth-code

  6. In the App > API permissions section, grant the following Microsoft Graph API delegated permissions:

    Group.Read.All User.ReadBasic.All Team.ReadBasic.All ChannelMessage.Send offline_access

    Note: If you skip this step, you can provide consent to these permissions upon your login.

  7. Create a client secret for your app in the App > Certificates & Secrets section.

  8. Save the client secret which you need it to enable the integration.

To add Microsoft Teams as a collaboration tool:

  1. Prerequisite. To support the Microsoft Teams integration, OpenText Software Delivery Management must be configured to run in HTTPS. In Admin Settings > Site > Parameters, make sure that the SERVER_BASE_URL parameter matches your OpenText Software Delivery Management URL.

  2. Open the Settings menu , click Spaces, and select your workspace.

  3. Click the DevOps tab, and select Collaboration Tools.

  4. Click the More dropdown button and select Microsoft Teams as the collaboration tool if it is not already selected. You are prompted to set up the integration.

  5. Enter the required credentials: Application (client) ID, Directory (tenant) ID, and client secret. Click Configure. The credentials can be found in the Azure portal.

  6. Exit the admin settings section, and make sure you are logged in to OpenText Software Delivery Management as an admin.

  7. Go to any work item entity and click the Discuss on Teams button . You are prompted to provide consent for the requested permissions.

  8. Select the Consent on behalf of your organization checkbox and click Login. OpenText Software Delivery Management authenticates on behalf of your Microsoft users through the application that you created.

Non-admin users can collaborate in Microsoft Teams from within OpenText Software Delivery Management. For details, see Discuss on Microsoft Teams.

Back to top