Edit field mapping

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.

Agile Manager and ALM fields are mapped to specify pairs of fields with synchronized data. Field mapping includes specific field value mapping (for list fields), as well as the direction in which the data is synchronized.

For details about mapping user list field values, see Map user list fields.

When you first create a link, some system fields and field values are mapped automatically, as long as the field or field values have not been modified. To view an example, see Examples of automatically mapped fields.

Use the link configuration Field Mapping tab to view the automatic mapping and modify it if necessary, and to map user defined and other optional fields. Mandatory fields must be mapped to synchronize records correctly.

Tip: The Agile Manager Detected in Cycle field is no longer in use and does not need to be mapped.

To understand more about the various Agile Manager fields, consult the list of fields in the Site or Workspace > Fields configuration page. For details about using this page, see Configure custom and required fields. Alternatively, you can see how the fields are used inside the different backlog items.

For requirement links, select the sub node for each requirement type in the tree to view its field mapping.

Caution: Once a record in one endpoint is mapped to a record in the other endpoint, it is always synchronized if there is new data, regardless of whether the record still matches the link's filter.

Therefore, before you start synchronizing, it is highly recommended that you read Field mapping guidelines. For additional recommendations before synchronizing, see Adapt the data in your endpoints.

Notes about Type, Attributes, and Required in the Field Mapping tab

The Type and Attributes columns are populated automatically. The red asterisk indicating a field is Required is set by the system as well.

Type. If the type is Reference, that means this field links the entity to an item created in Agile Manager. For example, a release, a sprint, a user, or another backlog item. The possible values for this field depend on the items defined in the system.

Attributes. Some fields, such as IDs, are marked in the Attributes columns as R (Read only). This means the field values are set by the system and cannot be entered by the user, or set via synchronization. For example, the Agile Manager Defect ID is a read only field. You cannot map it to synchronize bidirectionally. However, you can map it for unidirectional synchronization, setting a custom Agile manager ID field in the ALM endpoint.

Required. You cannot manually set a field as required for synchronization. Setting a field as required in the Fields configuration page does not affect synchronization. For details, see Define required fields.

Map a pair of fields or define constant values

Click Edit Link to modify settings, and Save Link to save your changes.

  1. Above the grid, toggle between showing Agile Manager Fields and ALM/QC Fields to determine how the fields are listed in the grid.

  2. Select the row for the field you want to map, and define the following:

    1. In the Direction column , select whether you want to map the field from Agile Manager to ALM, vice versa, or as bidirectional.

      If the field has no corresponding field in the other endpoint, select Constant.

    2. In the mapped field column (Agile Manager Field or ALM Field, depending on how you are viewing the fields) select a field from the dropdown list. Use the search box to filter the fields displayed.

      If you are mapping a constant value, enter the value in the corresponding column cell. The constant value is assigned to the field when Synchronizer creates new entities, and is not updated in subsequent synchronizations.

      Example: If you created a Creation Method user-defined field in ALM to distinguish between entities created directly in ALM and those synchronized from Agile Manager, enter created by Synchronizer as the mapped constant value. For details, see Adapt the data in your endpoints.

    If you need to map multiple fields in the opposite endpoint, click in the Multi-Mapping column. When you do this, your direction options are limited to prevent conflicts.

Additional field mapping tasks:

Note: You must always run an integrity check after modifying a link's configuration. We also recommend running a simulation to prevent errors occurring in the actual synchronization.

For details, see Run synchronizations.