You can modify the scope of synchronization using favorites, and by specifying whether to include past releases. In ALM you can also create a subset of releases or requirements to synchronize.
When synchronization is run, the synchronizer looks for new records in ALM Octane and ALM or JIRA based on the favorites configured for the link. If no favorite is configured, all records are synchronized. If a favorite is configured, items included in the selected favorite are synchronized with the other endpoint as newly created items. It is recommended to use favorites, but not required.
Favorites are specifically useful when first configuring your link. Start by using a favorite that contains only one record, and expand it slowly. Run simulation synchronizations to verify that the synchronization works as you expect.
How to use favorites
In ALM Octane, a user with Synchronizer Admin role can create or modify Synchronizer filters in the Backlog module (for epics, features, and user stories) and the Defects module (for defects), using the Save filter to Synchronizer button .
We recommend that you save a Favorite in ALM Octane with the same name as the Synchronizer filter, to be able to modify the filter. If you modify the Favorite, you must overwrite the Synchronizer filter as well.
When defining a filter, do not use relative labels such as current user (“Me”), current release, last 24 hours, last 7 days, or last 30 days.
In ALM or JIRA, the selected favorite must be available to the integration user used by the integration bridge to connect to ALM or JIRA.
You can select from a maximum of 50 favorites for a specific ALM project.
Remember to schedule a full synchronization each time you modify a favorite to synchronize the newly included records. For details, see Full synchronizations.
You can select favorites to use for synchronization when creating or editing the link. For details, see:
- Optional: Select favorites (requirement and defect links)
- View or modify synchronization favorites (defect and requirement links)
- Once a record in one endpoint is mapped to a record in the other endpoint, these records continue to be synchronized even if they no longer match the link's favorite. Be sure that you want to synchronize data in a specific record or type of record before including it in your favorite.
- When a new requirement is created in the master endpoint, and the requirement is the child of requirements that were not previously synchronized, the parent requirements are also created in the other endpoint. If a favorite is defined, the parent requirements are synchronized even if they do not match the favorite.
By default only current and future releases are synchronized. Releases with an earlier end date in ALM Octane, ALM, or JIRA are not synchronized. However, you can also instruct synchronizer to include past releases.
To synchronize past releases:
Determine the end date of the oldest release you want to synchronize.
Specify this date on the Rules tab of your synchronization link, when selecting the Synchronize past releases... option. For details, see Specify how to handle existing or past releases (release links).
By default, ALM Octane Synchronizer synchronizes:
the entire ALM Requirements root folder, including sub-folders.
all current releases (with an end date that has not yet passed) in the ALMReleases root folder, including sub-folders.
To synchronize only a subset of the requirements or releases in your ALM project, you can specify an alternate root folder in the synchronization link.
Note: If you use both favorites and alternate root folders, Synchronizer considers the alternate root folder before the favorites.
In the ALM project's tree, create a sub-folder that contains only the requirements or releases that you want to synchronize. This sub-folder can also include additional sub-folders.
In the image below:
The user stories in ALM OctaneWorkspace1 are synchronized with the requirements in the ALMAG_Project1 folder instead of the Requirements folder.
The user stories in ALM OctaneWorkspace2 are synchronized with the requirements in the ALMAG_Project2 folder instead of the Requirements folder.
In both ALM projects, other folders in the Requirements folder are ignored by ALM Octane Synchronizer. If there are additional sub-folders under the AG_ProjectX folders, all mapped requirement types they contain are synchronized.
You could similarly set up an alternate root folder for releases.
For details on defining the alternate root folder in your synchronization link, see Optional (ALM only): Define an alternate root folder (requirement and release links).