General Settings → ChatOps

ChatOps

In the ChatOps tab, you enable and configure ChatOps settings for SBM. You configure ChatOps settings in utility mode after your database has been initialized.

If you are upgrading a distributed SBM installation, you will see the ChatOps server component listed on the same server that hosts SBM Common Services.

Setting up a Chat Server

Before you begin, you must set up one of the following chat servers:

Once you have verified that the service is up and running, create an administrator account, a team name, and a chat bot for SBM. For example:

Each chat server has different setup and configuration requirements. For tips with setting up the various chat servers, see solution S142891.

Enabling ChatOps

To enable the ChatOps communication server that is provided with SBM:

  1. Select Enable ChatOps.
  2. Click Configure Login Server. This launches a batch file that enables you to configure ChatOps Login Server settings. The ChatOps Login Server authenticates chat server requests to SBM. In the configuration script:
    • Generate two sets of SSL certificates and their private keys.
    • Select the Expert install option, and then configure the ChatOps Login Server settings:
      • Enter port numbers or use the default ports (3100 for the ChatOps Login Server and 3000 ChatOps Bot Server).
      • Enter the IP address for the current server or enter localhost.
      • Use the auto-generated SSL certificates or use your own SSL certificates.

    When you are finished, you must start the ChatOps Login Server service on the Manage Services tab. If you re-run the batch file or make any changes, you must restart this service.

  3. Click Configure Bot Server. This launches a batch file that enables you to configure ChatOps Bot Server settings. The ChatOps Bot Server mediates communication between SBM and the chat server that you select. In the configuration script:
    • Generate two sets of SSL certificates and their private keys.
    • Select which type of chat server you want to use:
      • Mattermost
      • Slack
      • Microsoft Teams
    • Select the Expert install option, and then configure the ChatOps Bot Server settings:
      • Enter the name of your bot (like sbm-bot)
      • Enter the HTTP listener port for your bot (the default is 3080). For Microsoft Teams, you must set up an HTTPS proxy using this port.
      • Enter the ChatOps REST API user name and password
        Note: These are the credentials for your ChatOps user account; not the chat server user or an SBM user account. You will use these credentials again when you set up ChatOps in SBM Application Administrator.
      • Enter the port number of your ChatOps Bot Server (the default is 3000)
      • Enter the endpoint of your ChatOps Login Server (this server). For example: 
        https://serverName:3100
      • Decide if you want to use NLU or not.
      • Use the auto-generated SSL certificates or use your own SSL certificates.
    • Enter information about your chat server:
      • For Mattermost, enter the following:
        • The host name of your Mattermost server
        • The port numbers for your Mattermost server (accept the defaults)
        • Your Mattermost team name (sbm-team)
        • Your Mattermost bot username (sbm-bot again) and enter a password for the bot
        • Decide if you want to use TLS or not. If not, select no for both prompts.
        • Enter the hostname of the ChatOps Bot Server again.
      • For Slack, enter the following:
        • Your client ID and password for the Slack app
        • Your local IP address and port information for token requests
        • Timeout and delay time settings
        • Your Slack team subdomain (myteam in myteam.slack.com)
        • Your Slack user name (must be admin) and password
        • Your HTTP proxy information
      • For Microsoft Teams, enter the following:
        • Your Microsoft App ID and password
        • Your Microsoft authentication server endpoint (the host name and port of your HTTPS proxy)
        • Your Microsoft tenant ID (the Azure Directory ID)

    When you are finished, you must start the ChatOps Bot Server service on the Manage Services tab. If you re-run the batch file or make any changes, you must restart this service.

  4. If SBM Common Services is installed on the same machine as ChatOps, you must also import each of the public ChatOps SSL certificates SBM into the truststore. Click Manage Trusted Certificates and then import your certificates.

    If SBM Common Services is installed on a separate machine, use the Manage Trusted Certificates option on that server to import each of your public ChatOps certificates into the truststore on the SBM Common Services machine.

  5. Apply your changes in SBM Configurator. Make sure both ChatOps services are running on the Manage Services tab.
  6. If you are using Microsoft Teams, you must perform the following additional steps:
    1. Edit the manifest.json file located here: 
      installDir\SBM\Common\chatops\hubot-enterprise-bot\lib\adapters\msteams\manifest
    2. Replace <your app ID> with your Microsoft App ID.
    3. Replace <bot name> with the name of your SBM chat bot.
    4. Save your changes.
    5. In the same directory, run the create_manifest.ps1 script. This creates a manifest .zip file that you will upload to Microsoft Teams.
    6. Open Microsoft Teams, click ... | Manage team.
    7. Under Apps, click the Upload a custom app link.
    8. Enter the location of your manifest .zip file.

After you are finished in SBM Configurator, log in to SBM Application Administrator, open the ChatOps page under More, and then enter connection information for your SBM server that hosts ChatOps. Enter any additional required ChatOps settings, and then click Activate Bot. This enables the Open Chat feature in the Actions menu on work items in SBM Work Center.

Tip: To enable the item link that appears at the beginning of a chat session, configure Notification Server settings and provide a Web server host name under Link Settings.

ChatOps Configuration and Log Files

Refer to the following files as needed:

Copyright © 2007–2019 Micro Focus or one of its affiliates. All rights reserved.