DATA CENTER AND SERVER | CLOUD

Configuring ReqIF mappings

Owned by Bernhard Doleschel
Last updated: Oct 31, 2022 by Angelica Salazar
2 min read

The ReqIF feature is still under development. Changes may be made without prior notice.

Pre-requisites

As a Jira administrator,

  1. Enable ReqIF for your instance. See How to enable ReqIF.

  2. In case of restricted access, to create a ReqIF field mapping, the user must have “ReqIF Field Mapping“ permissions. See Managing User Permissions.

Mapping Configuration

The ReqIF interface must be configured for export and import of your Jira issues using the standardized ReqIF file format. The process follows the ReqIF standard 1.2.

  1. Select Requirements > ReqIF Field Mapping from the main navigation bar

  2. Select Create Mapping or edit existing mapping

  3. Mapping Name (mandatory): presented to the user when exporting or importing requirements. Specify idea, content and background to allow correct selection.

  4. Project (optimal): Mapping is only offered for given project. Some fields (e.g. issue type) can only be mapped later on when a certain project is selected.
    The mapping is valid for all projects if nothing is specified.
    Only mappings with Project specified can be used for import.

  5. Issue Specification Type (optional): Depend on export target/import source, specifies the mapping name for the type of a specification object.

  6. Folder Specification Type (optional): Depend on export target/import source, specifies the mapping name for the type of a specification (structural elements, folder).

  7. Folder Name (optional): Map the R4J folder item to a defined specification element.

  8. Folder Description (optional): Map the description of a R4J folder item to a defined specification element.

  9. Select Add Mapping for the Jira issues fields to be considered in the export/import. Recommended elements:

    1. Summary (the Jira headline of an issue)

    2. Description

    3. Issue Type (mandatory if Project is specified)

    4. Status

    5. Linked Issues (the linking to other issues)

  10. For enumerated fields (e.g. Issue Type), the mapping of the enumeration could be done.
    Default value for enumerated fields is “Skip” by default except for Issue Type which is mandatory. The default value is only used when evaluating ReqIF mapping during import.

The mapping created can be used for ReqIF Import and Export.

Issue Type Field Mapping

When the mapping specifies selected Project(s), issue type field mapping is enabled. At the bottom left of the mapping dialog, you can “Add Mapping for <your_selected_issuetype>“ which allows custom field mapping for each issue type. Any issue type left unmapped will follow the General mapping.

Unsupported fields

  • FORM_TOKEN

  • COMMENT

  • THUMBNAIL

  • LAST_VIEWED

  • WORKRATIO

  • SUBTASKS

  • SECURITY

  • TIMETRACKING

  • RESOLUTION_DATE

  • WORKLOG

  • TIME_SPENT (Export Only)

  • AGGREGATE_TIME_SPENT

  • AGGREGATE_TIME_ESTIMATE

  • AGGREGATE_TIME_ORIGINAL_ESTIMATE

  • AGGREGATE_PROGRESS

  • PROGRESS

  • VOTES

  • VOTERS

  • WATCHES

  • WATCHERS

  • Custom fields with type Cascading Select List

Known limitations

  • Issue Key is always included in the export

  • Projects cannot be created via ReqIF

  • Pages are not supported for ReqIF import and export

  • Custom field search is name-based (if custom fields with the same name exist, issues may occur)

  • Multiple steps status transition is not supported

    • Example: For Workflow Open > In Progress > Done 

    • When exporting issue in "Open" state then re-importing issue as "Done", "In Progress" is skipped in the process.

    • The "Open" state is retained, and status is not updated because multiple steps status transition is not yet supported.

References