Set up the Integration Bridge Agent

This section describes how to install and set up the Integration Bridge Agent to enable ALM Octane to integrate with external applications. This is required for synchronization, and can also be used by Trigger Webhook rules.

Tip: For ease of reading, we are using the term Integration Bridge to refer to the Integration Bridge Agent. For instructions on installing the Integration Bridge Server, see the Synchronizer Installation Guide, which can be accessed from the Synchronizer installation page.

Synchronization

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

  • Synchronizing with ALM on SaaS: Contact your SaaS operator and request setup of the Integration Bridge between ALM Octane and your ALM instance.

  • Synchronizing with JIRA/On-Premises ALM: To enable synchronization, you need to first install the Synchronizer as described in the Synchronizer Installation Guide. This is included in the Synchronizer installation package, from Micro Focus download sites. After you configure the Synchronizer, install and configure the Integration Bridge Agent as described in the following sections.

    You also need to contact your space admin and get API access keys (Settings > Spaces > API Access).

    Note: To verify if the required Synchronizer services are enabled for a specific tenant, look at the tenant’s details within Settings > Site. If the services are enabled, you will see a version number in the Bridge service and Synchronizer service columns.

Trigger Webhook rules

In advanced workflow scenarios, you can use Trigger Webhook rules to HTTP/S POST information to an endpoint URL to be used by a third-party application. For details, see Trigger webhooks for other applications. This may require you to install an Integration Bridge to serve as an intermediary between ALM Octane and the endpoint URL. In this case, ALM Octane sends the URL call to the integration bridge, and the bridge executes the call.

If the URL can be accessed from your network and/or is publicly visible, you do not need to install the integration bridge to run a Trigger Webhook rule.

Integration Bridge Agent system requirements

Verify that your system has the following minimum system requirements for each Integration Bridge Agent 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

Note:  

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

  • We recommend not installing the Integration Bridge Agent on the same Linux server as ALM or JIRA, or ALM Octane (if installed on-premises). Installing the Integration Bridge Agent 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 Agent application, and the corresponding service.

    On Linux, if you install the Integration Bridge Agent 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: