Note: This topic is relevant for ALM Synchronizer for Agile Manager only. For details about the NextGen Synchronizer see NextGen Synchronizer, or search using the NextGen Synchronizer filter.
If you are still using ALM Synchronizer, we recommend migrating to the more robust NextGen Synchronizer embedded in Agile Manager's configuration area.
Before synchronizing records between Agile Manager and ALM, you must adapt your ALM project to match the various fields supported for user stories and defects in Agile Manager.
For example, Agile Manager defects can also have a feature and theme defined. To synchronize these fields, you must create corresponding fields in ALM.
Note: Some of these steps have corresponding actions in Agile Manager.
Create new requirement types.
In ALM Customization, create new, user-defined requirement types that represent Agile Manager themes, features, and user stories.
Note: Do not base new requirement types on the Folder type.
Create or modify the requirement tree.
In ALM, create a requirement tree with a maximum of three levels (representing themes, features, and user stories).
Requirements in the first level under the root are mapped to Agile Manager themes.
Requirements in the second level under the root are mapped to Agile Manager features.
Requirements in the third level under the root are mapped to Agile Manager user stories.
Synchronizer retains the hierarchy during synchronization, and by default synchronizes the entire ALM Requirements root folder and all of its sub-folders.
Caution: Synchronization may fail if you do not map all requirement types, including Theme, Feature, and User Story.
Note: You can also configure a link to synchronize only a subset of the requirements tree by defining an alternate root folder for the link. For details, see Synchronizing requirements in alternate root folders.
Create user defined fields for additional Agile Manager fields.
In ALM, create user-defined fields to synchronize with fields that do not exist by default in ALM, but are used in Agile Manager, such as themes, features, and teams.
Defects Create user defined fields in ALM for the Theme, Feature, and Team fields. Requirements
- Create a user defined field in ALM for the Team field.
- If you use group stories, create a user defined field in ALM for the Story Group field.
- To synchronize ranking, create a user defined field in ALM for the Rank field. This field must be a Number field, and have read-write permissions.
Note: For user stories, the theme and feature is represented in ALM by the requirement's location in the tree.
For more details about synchronizing group stories, see Notes about Agile Manager Group Stories and Synchronizer.
When do you this, consider the following:
Themes and feature names must be unique in both ALM and Agile Manager, and team names must be unique in ALM. If duplicate values are found during synchronization, that defect or requirement is not synchronized.
Caution: In Agile Manager, a workspace team and a feature team can technically have the same name. However, this is not recommended within the same release to prevent confusion or errors when synchronizing. For details, see Notes for synchronizing team fields.
In Agile Manager, records assigned to a specific feature must also have a Theme defined. If you map the Feature field to be synchronized from ALM to Agile Manager (or in a bidirectional synchronization), you must also map the Theme field.
Synchronizer generates an error if it finds a record in ALM that is assigned to a Feature, but no Theme.
Prepare ALM and Agile Manager to synchronize ALM and Agile Manager IDs.
To do this:
Create the following user defined fields:
In ALM. Create a user defined Number field named Agile Manager ID.
In Agile Manager. Create a user defined Numeric field name ALM or QC ID.
Site administrators can create Agile Manager custom fields in the Site > Fields configuration page.
- When mapping fields later on, map these two fields and select the Synchronize back on create option for this mapped pair. For details, see Synchronize back on create.