# IBM DOORS – Jira Integration

## Overview

The integration of IBM DOORS and Jira ensures that the product management and application development teams are on the same page when it comes to customer expectations and deadlines.\
On this page, we will look at the bi-directional integration of Requirement from IBM DOORS and Story from Jira.

## How to Create an Integration Between IBM DOORS - Jira

Configuring [system pre-requisites](https://docs.opshub.com/v7.216/integrate/integration-prerequisites) is mandatory for successful system configuration. Check out the pre-requisites for [IBM DOORS](https://docs.opshub.com/v7.216/connectors/doors#prerequisites) and [Jira](https://docs.opshub.com/v7.216/connectors/jira#prerequisites) systems before you proceed with the integration.

To create an integration between IBM DOORS and Jira, you need to:

* Log in into <code class="expression">space.vars.SITENAME</code>. The default credentials are: **User Name**: admin, **Password**: password.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-d7aeab072a12cb43c865cb1bc4aa81bf1b7c1e18%2FGetting_Started_With_Application_Image_1G_a.png?alt=media" alt="" width="800"></div>

> **Note**: Proxy parameters: Before you proceed with the configuration, check whether the system is behind a proxy server. If yes, then set up [proxy parameters](https://docs.opshub.com/v7.216/manage/administrator/proxy-setting) in <code class="expression">space.vars.SITENAME</code>.

* Click **Integrate** on the top right corner of the screen and then click the plus \[+] icon.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-b19d9fe7e591bbe5ca2605f5c79e6969cfc7cb5b%2FOverview_of_Integration_Image_1D.png?alt=media" alt="" width="1200"></div>

* The integration configuration page opens:
* Enter a unique name for the integration. For example, this integration is named *IBM DOORS – Jira Integration*.
* Click plus \[+] icon adjacent to the System 1 and System 2 fields one by one to configure IBM DOORS and Jira.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-c8ee6ccbdb39ea2309ca7c21a3e480953817394a%2FIBM_DOORS_4.png?alt=media" alt="" width="1200"></div>

* After you save the respective configuration, the system automatically will be added to the integration form. You can now proceed with adding projects in the integration.\
  Proceeding further, in the **Add Project(s) to Sync** section, select the projects you want to synchronize between IBM DOORS and Jira by clicking them.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-2bd04b03cd40264c53801c51d156e2f96c0cd33b%2FIBM_DOORS_5.png?alt=media" alt="" width="1200"></div>

* For example, we select Demo Module 1 from IBM DOORS and DemoProject from Jira.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-24f00523ce4aeafacd7e793a82934ad1ebb5aae8%2FIBM_DOORS_6.png?alt=media" alt="" width="1200"></div>

* If you select forward arrow (>) icon, the data would flow from IBM DOORS to Jira.
* If you select backward arrow (<) icon, the data flow would from Jira to IBM DOORS.
* If you want a bi-directional flow of data, select bi-directional arrow (<-->) icon.

Once the direction is selected, the arrows would turn grey. We have selected the bi-directional flow.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-65f8798eb7414e4b1d6ed7a576b6bc7e7b0fdf4f%2FIBM_DOORS_7.png?alt=media" alt="" width="1200"></div>

* The next step is to define entities that need to be integrated and fields that need to be integrated for every entity mapped.
* <code class="expression">space.vars.SITENAME</code> fetches entities available in both systems and shows them in entities list for both systems. From the **Select Entities to Sync** section, select the relevant entities for both systems. In this case, we select **Requirement** from IBM DOORS and **Story** from Jira.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-58869d1a5d1632db3c83de97f65a23fd039ff13e%2FIBM_DOORS_8.png?alt=media" alt="" width="1200"></div>

* Now, click the plus \[+] icon adjacent to Select fields to be Synced to create the mapping between these two entities. You will now be navigated to the Mapping Configuration screen.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-4048845844eaf067af5415b08deb1fc4b81030df%2FIBM_DOORS_9.png?alt=media" alt="" width="1200"></div>

Once you come to the mapping page from the integration page, following details are automatically populated in the **Mapping section**:

* Systems
* Projects
* Entities

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-b3796af58578102027d8005941d1d6b380cc127b%2FIBM_DOORS_10.png?alt=media" alt="" width="1200"></div>

> **Note**: For the first integration that you are configuring, we recommend you take only mandatory fields for mapping first and later edit the mapping to add more fields.

* If you wish, change the name for the mapping in the **Name** field.
* Now, click **Create from Scratch** to define the mapping from scratch.\
  OR
* Click **Auto Map** to automatically map all fields with same name. <code class="expression">space.vars.SITENAME</code> will allow you to remove or add more fields before saving mapping.

<code class="expression">space.vars.SITENAME</code> will load fields available in the selected entity and project fields. Refer to the image below:

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-247d480b3f052d46bc301ff0e18e4b612e16257d%2FIBM_DOORS_11.png?alt=media" alt="" width="1200"></div>

* Now, from the drop-down shown in the image below, select the **Mandatory fields** option for IBM DOORS, first.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-4d3ab504c1c02b1ecee634bc99f5397207696f0a%2FIBM_DOORS_12.png?alt=media" alt="" width="1200"></div>

> **Note**: The API of IBM DOORS doesn’t support mandatory fields to be fetched here, so you can directly look it up on its API.\
> However, for the purpose of this integration, we will not have any mandatory fields mapped from IBM DOORS to Jira.

Now go to Jira. Jira has a mandatory field: **Summary**.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-a7ca0e229faa747a8859015dd399d705210e696c%2FIBM_DOORS_13.png?alt=media" alt="" width="1200"></div>

* Map the Summary field in Jira to the OH\_Default field in IBM DOORS.

> **Note**: If Mandatory fields in one system don’t have a corresponding value in the other system, map the mandatory field in the system with the OH\_Default field in the other system.

* Now, proceed with mapping additional fields that you want to sync.
* On the right panel, the mapped fields are displayed in the following manner:

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-42bb1a851e24a6099b96b8b0cea3c7de0e7b4914%2FIBM_DOORS_14.png?alt=media" alt="" width="1200"></div>

* If you want to synchronize a field only in one direction, then you can disable sync of a field by clicking \[>] or \[<].
* The look-up type field, project, is marked with the value mapping icon ![](https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-e738613e7434e09ede58bd9212168a30936bfe5c%2FI_9.png?alt=media)

> **Note**: Value Mapping is used to map the values for the Lookup Type fields.

* Click ![](https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-e738613e7434e09ede58bd9212168a30936bfe5c%2FI_9.png?alt=media) against the Projects fields to map their corresponding values.
* From the Value Mapping pop-up that opens after clicking ![](https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-e738613e7434e09ede58bd9212168a30936bfe5c%2FI_9.png?alt=media), select the corresponding values from both systems by clicking them. We select Demo Module 1 from IBM DOORS and DemoProject from Jira.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-77d5f2795d17f9ae886e3979a475b92f16b0ffda%2FIBM_DOORS_15.png?alt=media" alt="" width="1000"></div>

* Click **Save** in the Value Mapping pop-up to save the mapping. It’s time to save the mapping now. Click the **Create Mapping** to create & save the mapping.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-46527d154c2316b025d1b5806a8cd16f37cb8cd1%2FIBM_DOORS_16.png?alt=media" alt="" width="1000"></div>

* Once you save the mapping successfully, you will get the following pop-up at the bottom of the page.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-dfa6ca5b82a3a30872790d13bf37f75f94761319%2FIBM_DOORS_17.png?alt=media" alt="" width="700"></div>

You will be further re-directed to the Integration page:

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-253f97ff10d7841a6af4cd80822c57832ca90bc3%2FIBM_DOORS_18.png?alt=media" alt="" width="1000"></div>

## Set Polling Time & Activate Integration

* Now on the integration page, in the **Start Polling Time** field, set the time to start synchronizing data in both the systems. The polling time for both systems needs to be set one by one.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-20a26998b3c59c500a23a5fa0c885d3937634e82%2FIBM_DOORS_19.png?alt=media" alt="" width="1200"></div>

To save the integration in active mode, slide the **Activate Integration** button to the right.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-afe5b86aef78073343d4136790fab12f62fb706d%2FIBM_DOORS_20.png?alt=media" alt="" width="500"></div>

* As the final step, click **Save** to save the integration.
* The integration will be created. You will also get a pop-up at the bottom of the screen confirming the integration has been successfully configured and activated.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-18a0932664c9dc6c52d1823faf9e5cf687e92e80%2FIBM_DOORS_21.png?alt=media" alt="" width="500"></div>

> **Note**: At this stage, test the integration by trying to synchronize data between the specified IBM DOORS and Jira projects.\
> **Note**: You shouldn’t be using the integration user credentials to create entities in the systems or the integration will not work.

## Additional Configurations

Now, once you have set the basic integration in place, you can edit the integration to map entities such as Comments, Attachments, and Relationships.

Refer to the videos on this page to learn in detail about [Comments](https://docs.opshub.com/v7.216/integrate/configure-integrations/mapping-configuration#comments) and [Attachments](https://docs.opshub.com/v7.216/integrate/configure-integrations/mapping-configuration#attachments) mapping.

* Go to the Integration Page and click the Integration you want to edit. In this case, we click the IBM DOORS-Jira integration.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-f4387d06bbf8ebd162864e98c209a9782cbb3d38%2FIBM_DOORS_22.png?alt=media" alt="" width="1200"></div>

* Once the integration configuration is open, click the edit icon as shown in the image below:

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-56f8dcdb8983f88503a450e1fe1f979102cd9265%2FIBM_DOORS_23.png?alt=media" alt="" width="800"></div>

> **Note**: You will have to de-activate an integration before you edit the integration.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-6231f0120ec3a10c63f8bd8112208cb59857a8da%2FIBM_DOORS_24.png?alt=media" alt="" width="700"></div>

* From the **Select Entities to Sync** section, click the mapping for which you want to enable comment and relationship synchronization.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-7a619f1c773df284d81fb1f4a0a4e01cdc510c6c%2FIBM_DOORS_25.png?alt=media" alt="" width="1200"></div>

> **Note**: Mapping of attachments is not supported for this integration.

* Once the mapping configuration page is open, click the edit icon to edit the mapping.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-21c3111cee814d8af27ec8ddd3f8a8dce02aecda%2FIBM_DOORS_26.png?alt=media" alt="" width="1000"></div>

## Map Comments and Relationships

### Map Comments

Refer to the video on this page to learn in detail about [Comments](https://docs.opshub.com/v7.216/integrate/configure-integrations/mapping-configuration#comments) mapping.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-7bf297be85835059b859cfb2283ec94e90661bdf%2FIBM_DOORS_27.png?alt=media" alt="" width="400"></div>

* For enabling comments, just toggle the comments toggle at bottom of fields mapping.
* By default, comments will be synchronized in both directions. For changing the default behavior, click the icon next to comments.
* If required, disable the direction in which comments need not be synchronized by clicking the \[>]\[<] buttons.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-d35d4d7ffe74c352a5a7903320ce2adfad5c9407%2FIBM_DOORS_28.png?alt=media" alt="" width="400"></div>

### Map Relationships

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-9af0887c16c56a48c2c28b553a8619633c1cb1af%2FIBM_DOORS_29.png?alt=media" alt="" width="500"></div>

* For syncing relationship and link between the entities in both systems, switch on the Relationship toggle.
* Now, click Map Relationships.
* Toggle the **Entity Type- Link Type** button to left to map entity types.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-75d226655d5717952cf69af8527cac81154d496e%2FIBM_DOORS_30.png?alt=media" alt="" width="500"></div>

* In the mapping, map the relationship between entities – SR in IBM DOORS to Story in Jira by selecting them from the respective boxes.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-ae3a5f05f1432301fca3b14a8865fdf0d192f9db%2FIBM_DOORS_31.png?alt=media" alt="" width="1000"></div>

* Click **Next** in the Relationship Configuration pop-up to map link type. We link `Oh_Childids` with `relates to`, which means SR from IBM DOORS, which is a child to the Requirement, relates to Story in Jira in the same manner.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-4ff2e07638bb9334b4c68d8983e1c7f60085716f%2FIBM_DOORS_32.png?alt=media" alt="" width="1000"></div>

* Now, click the **Update Mapping** to update the mapping.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-3b05af5202a23f2ac4f8233748ca5c29a07b8f99%2FIBM_DOORS_33.png?alt=media" alt="" width="1000"></div>

* You will see the following pop-up at the bottom of the screen notifying the mapping is updated and you will be taken to the integration configuration page.
* Activate the integration and save it.

<div align="center"><img src="https://3739347370-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1a8GpUm2lq3lKbytaYjt%2Fuploads%2Fgit-blob-bb037d9e14dc7cfb8ed74b77e2d1d697ef47f628%2FIBM_DOORS_34.png?alt=media" alt="" width="1200"></div>
