Download Synchronizer and prepare ALM Octane

To begin, you download the Synchronizer package. You then need to prepare ALM Octane to enable communication between ALM Octane and the Synchronizer.

Download the Synchronizer

  1. Download the Synchronizer installation package from Micro Focus Marketplace.

  2. Under /opt/ extract the tar file:

    tar -xzvf <installation file name>

The file structure should now be /opt/sync/.

Back to top

Prepare ALM Octane

To enable communication between ALM Octane and the Synchronizer, perform the following steps within your ALM Octane environment. (In a cluster configuration, this must be done separately for each ALM Octane node.)

  • If you upgrade ALM Octane the following configuration changes are overwritten. Back up the files described below before upgrading, and restore them after upgrading.

  • This document provides paths for ALM Octane on Linux. If you are using ALM Octane on Windows, the paths are similar but use Windows format.

  1. Within /opt/octane/webapps, copy the file to

  2. Within the file, enter the correct internal URL of the Synchronizer. Note that the URLs cannot start or end with spaces.

  3. Open the /opt/octane/wrapper/wrapper.conf file. In the section headed #on-prem configuration, uncomment the following lines (remove the # character from the beginning of each line):

    This enables ALM Octane to communicate with the Synchronizer.

  4. If ALM Octane is configured behind a proxy, the Synchronizer must be identified as a non-proxy host. To do this, add the following line at the end of the wrapper.conf file:<next line number>=-Dhttp.nonProxyHosts=<Synchronizer host>

    For example, if the last line in the wrapper.conf file begins with, add the following line: 

  5. Restart the ALM Octane server. In a command line, enter:

    service octane restart

  6. The Synchronizer needs to use an API client ID and secret to communicate with ALM Octane. To generate these, go to /opt/octane/install and run the following:

    ./ <octane-server-url> <site-admin-name> <site-admin-password>

    In an ALM Octane on Windows installation, go to C:\Program Files\octane\install, and use generateadminapikey.bat.

    Example of output:

    Example: "client_id":"micro-services-key_12qw97wx4wp8phrr4wwqzkore"
  7. Save the client ID and secret. When you configure the Synchronizer, you will enter the client ID in the serviceApiKey property, and the secret in the serviceApiSecret property.

Back to top

Next steps: