Note: This topic is relevant for NextGen Synchronizer only. For details about the ALM Synchronizer, see ALM Synchronizer for Agile Manager or search using the ALM Synchronizer filter.
NextGen Synchronizer enables administrators to configure synchronization between ALM and Agile Manager directly in the Agile Manager configuration area.
Synchronizer checks ALM and Agile Manager for recent updates in the synchronized items, and updates the other endpoint accordingly. You can configure the direction in which changes are synchronized between the endpoints: from ALM to Agile Manager, from Agile Manager to ALM, or both ways.
Synchronization links and endpoints
Synchronization is defined by links, which you create and manage in the Agile Manager Integrations > Synchronizer configuration tab. This configuration tab is visible only to Integration Administrator users.
Links are created between a pair of endpoints, namely an ALM project and an Agile Manager workspace. You can set automatic synchronizations, or run manual synchronizations to synchronize records between the endpoints.
Each synchronization link defines the following:
-
The type of entities synchronized (defects, user stories / requirements, or releases).
-
The directions in which the endpoints are updated (ALM > Agile Manager, Agile Manager > ALM, or both).
-
The favorites used to find records with new data in each endpoint.
Creating multiple links
Each link synchronizes a specific entity type between a single ALM project and a single Agile Manager workspace. Create separate links to synchronize defects, requirements, and releases between the same two endpoints.
You can create multiple links between a single Agile Manager workspace and multiple ALM projects, even if the ALM projects are stored in different versions of ALM. In such a case, use Agile Manager favorites to separate the synchronized data inside the workspace.
To prevent data leaks between workspaces, Synchronizer does not support multiple links between a single ALM project and multiple Agile Manager workspaces in the same site.
ALM Version Control
If you synchronize with an ALM project that uses version control, NextGen Synchronizer conforms to the versioning rules. Changes made by the synchronization process are checked in with a comment: Modified by NextGen Synchronizer.
During synchronization, Agile Manager connects to ALM using the credentials of an ALM user that you specify.
-
When synchronizing an entity that is checked out by that user, the entity is updated and checked in.
-
When synchronizing an entity that is checked out by a different user, the ALM entity is not modified.
-
If the synchronization is governed by the Agile Manager Manager side, a synchronization error occurs due to the locked entity on ALM.
-
If the synchronization is governed by the ALM side, the Agile Manager entity is updated based on the last checked-in version on ALM.
-
For system requirements, see Integration Bridge system requirements.
Synchronization steps
Working with Synchronizer involves the following steps.
| Step | Description |
|---|---|
| Create Agile Manager and ALM favorites |
Create favorites for Synchronizer to use when looking for new records in ALM or Agile Manager. If no favorite is configured, all records are considered for synchronization. You can perform this step before setting up 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. |
| Adapt the data in your endpoints | Make recommended modifications to your ALM project and Agile Manager workspace to ensure smooth synchronization. |
| Define an Integration Administrator user |
Define an Integration Administrator user to manage the synchronization links. |
| Obtain API client details for the Integration Bridge |
Add an Integration Bridge client on the Integrations > API configuration page. Agile Manager generates a client ID and secret for the Integration Bridge to use when connecting to Agile Manager. |
| Install the Integration Bridge |
The Integration Bridge connects between Agile Manager and ALM, and must be installed on a machine that has access to both systems. When configuring the Integration Bridge connection to Agile Manager, enter the client ID and secret obtained in the previous step. |
|
Create a synchronization link and then |
Use the wizard to help you define your connection data to ALM, the favorites used to filter data, and the directions in which the endpoints are updated. Then, continue with mapping link fields and field values. |
|
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 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:
