Set up Slack

Integrating with Slack enables all stakeholders of a backlog item or a pipeline run failure to collaborate and communicate.

Overview

When you set up integration with Slack, you add your ALM Octane workspace to a Slack workspace. Then, users can open Slack channels for discussions from within ALM Octane items. For details, see Collaborate with an item's stakeholders.

If you configure the integration to expose ALM Octane data on Slack channels, information from the backlog item is sent to the channel.

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

We recommend using different Slack workspaces for different ALM Octane workspaces.

Back to top

Configure integration with Slack

To enable your ALM Octane workspace users to collaborate in Slack, define Slack as a collaboration tool in ALM Octane, and add your ALM Octane workspace to your Slack workspace:

DevOps admin permissions are required.

  1. Prerequisite On-premises: Create a Slack app for ALM Octane to use. For details, see Create a Slack app for ALM Octane (On-premises only).

  2. In ALM Octane, in Settings , click Spaces and select your workspace.

  3. Click the DevOps tab. On the left side of the pane, select Collaboration Tools.

  4. Click + to add Slack as a collaboration tool. The Add Collaboration Tool dialog box opens.

  5. In Slack, make sure you have a workspace to use for all communication related to this ALM Octane workspace. Add all of your ALM Octane 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 ALM Octane browser tab.

  6. Consider carefully whether to allow exposing internal ALM Octane information on the Slack channel.

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

    Note: You can modify this setting at any time in the collaboration tool grid.

  7. Click to add your ALM Octane workspace to the Slack workspace.

    The ALM Octane chat application registered on Slack requests access to your Slack workspace.

    For SaaS ALM Octane, the name of the application is octanechatsapp. For on-premises ALM Octane, the application is set up by your site admin.

  8. Optionally, select a different Slack workspace and select whether to expose more or less information about your Slack workspace to ALM Octane.

  9. Click Authorize.

The integration with Slack is complete. The Chat w/ Slack button is now enabled in backlog items and in the Failure Analysis tab of pipeline runs with failures.

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 the ALM Octane Installation and Administration Guide.

Back to top

Create a Slack app for ALM Octane (On-premises only)

To enable configuring Slack integration on your ALM Octane site, create a Slack app and configure ALM Octane to use it:

Site admin permissions are required.

  1. Using a Slack account that belongs to ALM Octane's site admin, create a new Slack app for ALM Octane to use.

    One Slack application can serve many ALM Octane instances. For detailed instructions, see https://api.slack.com/slack-apps.

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

    1. In Add features and Functionality, click Permissions and select any permission scope. ALM Octane 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 ALM Octane's URL.

      Add the URL in the following format (port number is optional) and click Save URLs: http://<ALM Octane 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 ALM Octane 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 ALM Octane configuration parameters: SLACK_INTEGRATION_CLIENT_ID, SLACK_INTEGRATION_SECRET.

      For details, see Set configuration parameters (technical preview).

  4. Back to top