Version Fields for Global Configurations

Global Configurations resolution depends on OSLC link types and associated Jira Version Fields.

Using standard Version Field mapping

Following is the standard mapping used to determine the Jira Version Field to use, to a resolve a Global Configuration, depending on the OSLC Link Type.

Customizing the Version Field mapping

The standard mapping is logical and is recommended to use in most cases. If your organization has a need to change the Version Field used for Global Configuration resolution, you may customize this mapping for a given Jira space.

Creating a mapping file

Here are the steps to customize the Version Field mapping for a given Jira space:

1. Determine the identifier of the Jira space to customize:
   1. Log as a Jira space administrator in OSLC Connect for Jira Cloud.
   2. Click the gear icon on top right and click Manage Spaces in the drop down menu.
   3. Select the Jira space in the list.
   4. In the Browser URL, locate the project query parameter at the end of the URL and copy its numeric value (e.g. 10201).
2. Create a mapping file for your Jira space, that customizes the Version Fields to use:
   1. Create a new file named linkType_<id>_deliverables.properties, where <id> is the Jira space identifier retrieved in previous step (e.g. linkType_10201_deliverables.properties).
   2. Copy the complete content of the mapping template below in this file.

      AFFECTS_REQUIREMENT=FOUND_IN
      AFFECTS_TEST_RESULT=FOUND_IN
      BLOCKS_TEST_EXECUTION_RECORD=FOUND_IN
      ELABORATED_BY_ARCHITECTURE_ELEMENT=FOUND_IN
      IMPLEMENTS_REQUIREMENT=PLANNED_FOR
      RELATED_TEST_CASE=FOUND_IN
      RELATED_TEST_EXECUTION_RECORD=FOUND_IN
      RELATED_TEST_PLAN=FOUND_IN
      RELATED_TEST_SCRIPT=FOUND_IN
      TESTED_BY_TEST_CASE=PLANNED_FOR
      TRACKS_REQUIREMENT=PLANNED_FOR

   3. Review this list of OSLC link types and determine which ones should be associated to a Jira Version Field different from the standard.
   4. Customize the necessary link types:
      1. Replace PLANNED_FOR by FOUND_IN to use Affects Versions field.
      2. Replace FOUND_IN by PLANNED_FOR to use Fix Versions field.
   5. Mind that all link types must remain declared in the file, even the ones still using default mapping.
   6. Save the edited content.

Deploying a mapping file

Once the mapping file is ready, contact the OSLC Connect for Jira Cloud server administrator to deploy this mapping file. Here are the steps the server administrator must follow:

1. Check the value associated to the oslc.broker.deliverable-type-mapping.location context parameter. See Configuring Broker for details on context parameters. The value references a directory in the file system of the server, where mapping files are stored.
2. If this context parameter is not yet defined, i.e. if it is the first time a mapping file is to deploy:
   1. Choose a directory in the file system that suits your needs. This directory will contain mapping files. You should plan to regularly backup the content of this directory.
   2. Declare the oslc.broker.deliverable-type-mapping.location context parameter, using the directory location as value.
   3. Restart the web application server. This is necessary for OSLC Connect for Jira Cloud to start using the new context parameter. You should plan this restart outside of business hours.
3. Copy the mapping file provided by the Jira space administrator in the directory associated to the oslc.broker.deliverable-type-mapping.location context parameter. This mapping file will be automatically loaded by the product, you do not need to restart the web application server for this action.
4. Notify the Jira space administrator that his mapping file is deployed, so he can confirm the mapping is customized as expected.