Synchronization steps

Caution: Before setting up synchronization on a production system, we recommend synchronizing an experimental ALM Octane workspace and ALM or JIRA project.


Before you begin, perform the following prerequisite steps. These steps need to be performed once for every ALM or JIRA instance.

To integrate: Perform the following:
ALM <-> ALM Octane on SaaS  Contact your SaaS operator and request setup of the Integration Bridge between ALM Octane and your ALM instance.
  • ALM <-> ALM Octane on premises

  • JIRA <-> ALM Octane on SaaS

  • JIRA <-> ALM Octane on premises

  1. Install the Synchronizer as described in the Synchronizer Installation Guide. This is included in the Synchronizer installation package, from Micro Focus download sites.
  2. After you configure the Synchronizer, you need to install and configure the Integration Bridge, as described here: Set up the Integration Bridge.

Synchronization workflow

Working with ALM Octane Synchronizer involves the following steps:

Step Description
Define the synchronization scope

Create favorites for ALM Octane Synchronizer to use when looking for new records in ALM, JIRA, or ALM Octane.

If no favorite is configured, all records are considered for synchronization.

You can perform this step before setting up ALM Octane Synchronizer, or come back and do it later.

Tip: We recommend creating integration favorites before your first synchronization. Run a simulation using your favorite to verify that synchronization works as you expect.

Review and adapt data for ALM synchronization

Review and adapt data for JIRA synchronization

Make recommended modifications to your ALM or JIRA project and ALM Octane workspace to ensure smooth synchronization.

Obtain API access for the Integration Bridge

Shared space admin: Add an entry for the Integration Bridge on the Settings Spaces > API Access page. Assign this entry the Integration Bridge role.

ALM Octane generates a client ID and secret for the Integration Bridge to use when connecting to ALM Octane.

For details, see Set up API access.

Define a Synchronizer Admin user

Shared space admin: Define a Synchronizer Admin user to manage the synchronization links.

The Synchronizer admin role is required for all of the remaining steps.

Set up the Integration Bridge

The Integration Bridge connects between ALM Octane and ALM or JIRA, and must be installed on a machine that has access to both systems.

When configuring the Integration Bridge connection to ALM Octane, enter the client ID and secret obtained in the previous step.

Create a synchronization link

Use the wizard to help you define your connection data to ALM or JIRA, the favorites used to filter data, and the directions in which the endpoints are updated.

View and edit link configuration

Check the mappings and settings that were created automatically for your link, and make any adjustments necessary.

Run synchronizations

Run an integrity check to prevent errors during synchronization, and an optional simulation to understand details about the data that will be updated.

Run manual synchronizations or enable synchronizations to run automatically.

Review link summaries and error details

Review the status of your links and investigate any errors that may have occurred during synchronization.

You can view the run history for a specific link in the Run History tab.

Configure ALM Octane Synchronizer notifications

Configure Synchronizer to send notifications about issues occurring during synchronizations.

Link notifications are configured for all links in a workspace. Bridge notifications are configured per bridge.

See also: