Set up the Integration Bridge

The Integration Bridge is a component that needs to be installed on your system, to enable ALM Octane to integrate with external applications. This is required for synchronization, and for the Call URL rule action.


You can synchronize SaaS ALM Octane workspaces with ALM projects in order to view and/or update your defects in both endpoints. For details, see Synchronize ALM Octane with ALM.

Before you can set up synchronization, you need to install an Integration Bridge:

  • For SaaS users: Contact your SaaS operator and request setup of the Integration Bridge between ALM Octane and your ALM instance.

  • For on-premise users: Contact your shared space administrator and get API access keys (Settings > Shared Space > API Access).

Call URL

In advanced workflow scenarios, you can use the Call URL action to trigger a third-party script within an endpoint URL (see Enabling and handling rules that call URL scripts). This may require you to install an Integration Bridge to serve as an intermediary between ALM Octane and the URL. In this case, ALM Octane sends the URL call to the integration bridge, and the bridge executes the call.

The following table describes when a bridge is needed:


Your site admin needs to check if the URL is accessible.

  • If the URL can be accessed from your network, no bridge is needed.

  • If the URL cannot be accessed from your network, install an Integration Bridge on a server that can open a connection to the target server of the Call URL action.

  • If the URL is publicly visible, contact your SaaS administrator and request that SaaS enable a call to the URL.

  • If the URL is inside your private network and it is not publicly visible, you need to install an Integration Bridge inside your network.

When you install the Integration Bridge, you install both an Integration Bridge application, and a service that manages the application. The service makes sure that the Integration Bridge is automatically started when your system starts.

Integration Bridge system requirements

Verify that your system has the following minimum system requirements for each Integration Bridge that you install:

Operating system

One of the following:

  • Windows Server 2008 R2 SP1 64-bit
  • Windows Server 2012 R2 SP1 64-bit
  • Red Hat Enterprise Linux 6.2, 6.3, 6.4, 6.5, 6.7, or 7.2 (64 Bit)
  • SUSE Linux Enterprise 11 Service Pack 3
CPU Quad Core CPU
Memory (RAM) 8 GB
Free disk space 80 GB
Heap size Maximum 4 GB


  • The Integration Bridge must be installed to a path named only with ASCII characters.

  • We recommend not installing the Integration Bridge on the same Linux server as ALM or ALM Octane (if installed on-prem). Installing the Integration Bridge on the same server as one of these would cause severe competition for the same resources, impacting stability and performance.

  • On Windows, the installation includes both the Integration Bridge application, and the corresponding service.

    On Linux, if you install the Integration Bridge as a root user, the installation includes the service as well.

    If you install the bridge using a non-root user, you will need to manually install the service as a root user.

Next steps: