The integration of IBM Doors with 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

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

  • First, install OpsHub Integration Manager.
    Note:
  • Kindly setup a VM (new or an existing one) for installing OpsHub Integration Manager. Here are pre-requisites for installation.
  • The steps for installation of OpsHub Integration Manager are given here.

Integration configuration is the process of defining the flow, conditions, time, and parameters for integrating the entities between two systems. Follow the steps given below to integrate IBM Doors and Jira.

Click the Integrate button shown in the image below.

installation of OpsHub Integration Manager steps
installation of OpsHub Integration Manager steps
  • installation of OpsHub Integration Manager steps Click on the top right corner of the screen. You will be prompted to enter the Integration Name and name of systems you want to integrate.
  • Enter a unique name for the integration. For example, this integration is named doors – Jira.
  • Click configure IBM Doors adjacent to the System 1 and System 2 fields one by one to configure IBM Doors and Jira.
    configure IBM Doors

    Note: However, before you proceed with the integration you must know the pre-requisites that you need to fulfil to successfully integrate these systems using OpsHub Integration Manager.

  • The following pages: [[IBM Doors]] and [[Jira]] detail out the pre-requisites and system configuration process for installing these systems onto OpsHub Integration Manager.
  • After you save the respective configuration form after completion of the system configuration, the system automatically will be added to the integration form. You can now proceed to 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.
    IBM Doors and Jira
  • For example, we select Demo Module 1 from IBM Doors and DemoProject from Jira.
    Demo Module 1
  • Click the forward arrow IBM Doors to Jira if you want to integrate any project only from IBM Doors to Jira, bi-directional arrow IBM Doors to Jira if that project needs to be synced bi-directionally, or backward arrow IBM Doors to Jira if for that projects’ synchronization is needed only from Jira to IBM Doors. Once the projects are selected the arrows would turn grey as shown in the image below.
    IBM Doors to Jira
  • The next step is to define entities that needs to be integrated and fields that needs to be integrated for every entity mapped.
  • OpsHub Integration Manager 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.
    IBM Doors to Jira
  • Now, click IBM Doors to Jira adjacent to Select fields to be Synced to create the mapping between these two entities. You will, now, be navigated to Mapping Configuration screen.
    Mapping Configuration

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

  • Systems
  • Projects
  • Entities
mapping page from the integration page

Note: For the first integration that you are configuring, we would 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 the Create from Scratch button to define the mapping from scratch.
    Or,
  • Click Auto Map to automatically map all fields with same name. OpsHub Integration Manager will allow you to remove or add more fields before saving mapping.
  • OpsHub Integration Manager will load fields available in the selected entity and project fields. For reference, please look at the image below.
    OpsHub Integration Manager
  • Now from the drop-down shown in the image below, select the Mandatory fields option for IBM Doors first.
    OpsHub Integration Manager
  • 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.
    Jira has a mandatory field
  • 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 this manner.
    mapped fields
  • If you want to synchronize a field only in one direction, then you can disable sync of a field by clicking mapped fields or mapped fields .
  • The look-up type field, project, is marked with the value mapping icon mapped fields.
    Note: Value Mapping is used to map the values for the Lookup Type fields.
  • Click mapped fields against the Projects fields to map their corresponding values.
  • From the Value Mapping pop-up that opens after clicking Value Mapping pop-up, select the corresponding values from both systems by clicking them. We select Demo Module 1 from IBM Doors and DemoProject from Jira.
    Value Mapping pop-up
  • Click Save in the Value Mapping pop-up to save the mapping.
  • It’s time to save the mapping now. Click the Create Mapping button to create & save the mapping.
    save the mapping
  • Once you save the mapping successfully, you will get the following pop-up at the bottom of the page.
    mapping successfully
  • You will be further re-directed to the Integration page.
    Integration page


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.
    Integration page
  • To save the integration in active mode, slide the Activate Integration button to the right.
    Activate Integration
  • As the final step, click Save button 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.
    configured and activated

    IMPORTANT POINT: At this stage, test the integration by trying to synchronize data between the specified IBM Doors and Jira projects. Please 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.

  • Go to the Integration Page and click the Integration you want to edit. In this case, we click the IBM Doors-Jira integration.
    IBM Doors-Jira integration
  • Once the integration configuration is open, click the edit icon as shown in the image below.
    IBM Doors-Jira integration

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

    IBM Doors-Jira integration
  • From the Select Entities to Sync section, click the mapping for which you want to enable comment and relationship synchronization.
    Select Entities to Sync

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

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


Map Comments

Map Comments
  • 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 Map Comments next to comments.
  • If required, disable the direction in which comments need not be synchronized by clicking the Map Comments buttons.
    Map Comments
  • Once these changes are done, click the Save button to save comments configuration.


Map Relationships

Map Relationships
  • 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.
    Map Relationships
  • In the mapping, map the relationship between entities – SR in IBM Doors to Story in Jira by selecting them from the respective boxes.
    map the relationship between entities
  • Now, click Next button 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.
    Relationship Configuration
  • Now click the Update Mapping button to update the mapping.
    update the mapping
  • 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.
    Activate the integration