Edit field mapping

ALM Octane and ALM or Jira 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.

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 Step 6: Run synchronizations.

Field mapping overview

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: ALM or Jira defects.

On the link configuration Field Mapping tab, view the automatic mapping and modify it if necessary, and map user defined and other optional fields. Mandatory fields must be mapped to synchronize records correctly. How do I get to the Link Configuration page?

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

Tip: Before you start synchronizing, it is highly recommended that you read Field mapping guidelines. For additional recommendations before synchronizing, see Prepare for ALM synchronization.

Back to top

Automatically map similar fields

To begin mapping, in the link configuration Field Mapping tab, click the Automatically map fields button (in edit mode).

Fields that have the same name and type in both sides of the mapping will be mapped automatically. For example, if ALM Octane and Jira both have memo fields named Description, these fields will be mapped to one another.

When done, run an integrity check as described in Step 6: Run synchronizations.

Back to top

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 ALM Octane. 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 ALM Octane 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 ALM Octane ID field in the ALM or Jira endpoint.

Required. You cannot manually set a field as required for synchronization.

Back to top

Map a pair of fields or define constant values

On the link configuration Field Mapping tab, view the existing mapping and modify it if necessary. How do I get to the Link Configuration page?

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

  1. Above the mapping grid, toggle between showing ALM Octane Fields and ALM/Jira 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 ALM Octane to ALM or Jira, vice versa, or as bidirectional.

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

    2. In the mapped field column (ALM Octane Field or ALM/Jira 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 ALM Octane 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 ALM Octane, enter created by ALM Octane Synchronizer as the mapped constant value. For details, see Prepare for ALM synchronization.

    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.

Back to top

Additional field mapping tasks

Back to top

See also: