Download and install the Integration Bridge Agent

Download the Integration Bridge Agent from ALM Octane, and install it on a computer that can access both ALM Octane and the target endpoint (either ALM or JIRA for synchronization, or an endpoint for a Trigger webhook rule).

If you are installing on a Windows operating system, install the bridge as a Windows administrator user. You can run the bridge as a non-admin user with the relevant permissions.

On a Linux computer, any user can install the bridge.


  • The user installing the Integration Bridge needs to have the following ALM Octane roles:

    • Shared spaced admin
    • Synchronizer admin. Assign this role on the SiteUsers or WorkspaceUsers configuration page.
  • Linux: The user installing the Integration Bridge needs to have R/W permissions to the /tmp system folder.

  • Obtain a client ID and secret to enter during the Integration Bridge installation. The bridge uses these credentials to access ALM Octane.

    On the Settings Spaces > API Access page, add API Access keys for an Integration Bridge client. For details, see Create API access keys.

    ALM Octane generates a client ID and secret for the bridge.

Back to top

Download the bridge from ALM Octane

Download the bridge from one of these locations:

  • Synchronization. From the ALM Octane settings area, select Synchronizer.

  • Trigger webhook rules. While creating or editing a rule, select the Trigger webhook action. Check the Advanced settings checkbox, and click one of the download links on the right of the pane (either Windows or Linux).

On the link configuration page that opens, do one of the following:

If this is the first time you are installing the bridge In the checklist, click the link in the second step to download the bridge, according to your operating system.
If you are installing an additional bridge or performing an upgrade

Select More Actions > Download Integration Bridge, and select the relevant download according to your operating system.

Back to top

Install the Integration Bridge

  1. On the computer where you want to install the bridge, extract the downloaded zip file ( or You must extract this zip file to a path named only with English characters.

    The zip file contains the following:

    • The installation executable file.

    • A configuration file (server-connection.conf) containing the URL and shared space ID that the bridge will use to connect to ALM Octane. Note that this URL must end with /opb, which is the entry point for the Integration Bridge.

    • Linux: An integrity verifier (.bin.sig file), used for signature verification when packaging the installation files.

  2. Linux: In the folder containing the extracted files, run chmod +x alm-octane-integration-bridge.bin to obtain execution permissions on the installation file.

  3. Run the following file to begin the installation:

    Windows: alm-octane-integration-bridge.exe (Runs a GUI Wizard)

    Linux: alm-octane-integration-bridge.bin (CLI only)

  4. Follow the instructions in the installation process to complete the installation.

    When provided, accept the default values, which are configured to connect to your workspace.


    • The Integration Bridge must be installed to a path named only with ASCII characters, and must not contain consecutive spaces.

    • If you select the Modify an Existing Instance option, the bridge you select is uninstalled. After uninstalling, run the installation again to install a new instance.

    Tip: Linux:

    • You can cancel the installation at any step by typing quit.

    • You can return to a previous step in the installation process by typing back.

    • In the step for configuring the connection to ALM Octane:

      Settings Description
      Bridge name

      Define a name for the bridge.


      The URL of your ALM Octane site.

      Format: http(s)://<hostname or IP address>:<port number>/opb

      By default, this URL is provided for you, from the downloaded server-connection.conf file. 

      Caution: If you modify this URL, make sure not to end it with a slash ('/').

      Shared Space ID
      (Read only)

      This is automatically populated in the installer based on the server from where the bridge agent is downloaded.

      Client ID and Client Secret fields

      The client ID and secret with the Integration Bridge role, that ALM Octane generated on the Integration > API page.

      Proxy server

      If you will be using a proxy server to access ALM Octane, select Use proxy server.

      Enter details for the proxy server and the user who will be logging into the proxy server:

      • Host. A valid address for the proxy server.
      • Port. A valid port number (integer, between 1-65535)

      Tip: On Windows:

      You can click Test Connection to verify that the bridge can connect to ALM Octane.

      After you enter this information, the connection to ALM Octane is tested. If the test fails, you can reenter the connection settings or continue the bridge installation and modify the credentials later.

    • In the step for configuring the Integration Bridge service, accept the default service name and port number, or modify as needed.

      Tip: If you install multiple bridges, use a name that will help you associate the service with the corresponding bridge.

      Linux: The service name must contain only ASCII characters, and must not contain square brackets ([ ]).

  5. When the installation is finished, the Installation complete message is displayed.

    Note: If you are installing the Integration Bridge for Trigger webhook rule functionality, clear the Run credentials manager and define credentials for synchronizer links option. You can run Credentials Manager to set ALM credentials later if needed.

    Press ENTER to quit the installer.

  6. If you performed the installation on Linux as a non-root user, you must manually install the Integration Bridge service as a root user:

    <Bridge_installation_directory>/product/bin/ install
  7. If you selected the Run credentials manager and define credentials for synchronizer links option at the end of the installation, the Endpoint Credentials Manager opens.

    • Synchronization. Define credentials for connecting to ALM or JIRA, as described in Manage connection setup.

      Note: You must configure ALM or JIRA credentials before you configure your links.

      If the credentials manager does not open automatically, you can open it manually or configure the credentials using the CLI. For details, see Manage connection setup.

      In ALM Octane, the new bridge is identified within a few moments. If you do not see your new bridge, refresh the page. From there, click Create synchronization links to start creating your links.

    • Trigger webhook. To enable the Trigger webhook rule, do not enter more credentials. Close the Endpoint Credentials Manager application, and define the Trigger webhook rule action as described in Set up rules.

Back to top

Installing multiple bridges

Installing multiple bridges is necessary only in certain cases. For example:

  • If you need to synchronize ALM Octane with ALM or JIRA projects that reside on different networks.

  • If you define a large number of synchronization links and you want to distribute the load between multiple bridges.

  • If you install bridges for multiple ALM Octane sites. Each bridge communicates with one site.

    In this case, you must download each bridge separately, from the site with which it will communicate. The downloaded files contain the configuration necessary for the bridge to connect to the relevant site.

Recommendations if you install multiple bridges:

  • Use a separate set of ALM Octane credentials (client ID and secret) for each bridge.

  • Instead of using the default installation folder, provide a name that helps identify the bridge. For example, if you install multiple bridges to communicate with multiple ALM Octane sites, include the site name in the installation folder name.

Back to top