Define additional properties and enable the service

After configuring and installing Synchronizer, define additional properties as described in the following section. When you are done, enable the Synchronizer service in ALM Octane.

Define additional properties

After you configure the sync.yml file, perform the following steps (depending on your environment).

  1. Set the environment property JAVA_HOME to where the Java JDK is installed, and not the JRE.

  2. In a cluster deployment:

    Create a shared disk space which is accessible from all Synchronizer nodes. For all nodes configure the sync/repository/rootFolder property value in the .yml configuration file to point to this shared disk space.

  3. If Synchronizer is on a different URL than ALM Octane:

    In the file /opt/sync/conf/, uncomment the line for SYNC_BASE_URL. Set its value to the public base URL of the Synchronizer (for example:

  4. If your ALM Octane environment does not have a load balancer:

    By default, ALM Octane generates authentication cookies per host (FQDN) and not per domain. If you do not have a load balancer, you must add a parameter to the ALM Octane octane.conf file, or you will not be able to access Synchronizer.

    1. In the ALM Octane octane.conf file, add the parameter

      hp-sso {
      creation-domain = ""
    2. Define its value to your subdomain and domain, but make sure the subdomain and domain are identical for both ALM Octane and Synchronizer. (In any case, enter the maximum URL section that is shared by both.)

    3. Restart ALM Octane.

    Note: This will not work if you have previously modified the HPSSO.xml file. In this case, please contact Support.

Back to top

Enable the Synchronizer service in ALM Octane

Within ALM Octane, you will now enable the Synchronizer service in each relevant space.

  1. Open ALM Octane as a site admin, and click the settings icon.

  2. Select Site > Spaces.

  3. Select the space for which you want to enable the Synchronizer service.

  4. Click Enable Synchronizer Service. This will take several seconds to run.

    After successfully enabling the service you will see its version in the corresponding column.

  5. Select Users, and assign a dedicated user the Synchronizer Admin role.

  6. Log in as a Synchronizer Admin. Click Settings and then Synchronizer to access the Synchronizer UI.

You are now ready to perform synchronization.

Back to top