Creating Jira issues from problem records via BMC Helix iPaaS, powered by Jitterbit

The following image gives an overview of the capabilities that this integration supports:

This integration provides the following capabilities: 

The following image is an example of the Jira issue details displayed in the corresponding BMC Helix ITSM problem record:

BMC Helix ITSM to Jira data flows

The following image gives an overview of the data flow for creating a Jira issue from a BMC Helix ITSM problem:

The following image gives an overview of the data flow for adding a comment in a Jira issue from a BMC Helix ITSM activity note:

Jira to BMC Helix ITSM data flows

The following image gives an overview of the data flow for synchronizing comments and status updates from a Jira issue to a BMC Helix ITSM problem:

The following image gives an overview of the data flow for updating the status from a Jira issue to a BMC Helix ITSM problem:

Before you begin

You require the following items to successfully set up and use this integration: 

Task 1: To configure the integration

1. Log in to BMC Helix Innovation Studio.
2. On Workspace, click Multi-Cloud Broker.

3. To launch BMC Helix Multi-Cloud Broker, click Visit Deployed Application.
   

   Tip

   You can access BMC Helix Multi-Cloud Broker directly by entering the URL https://hostName:portNumber/helix/index.html#/com.bmc.dsm.mcsm/login and logging in as a tenant administrator.

4. Click Settings .
5. Select Start Here > Quick Configuration Guide.
   The Quick Configuration Guide page is displayed.

6. In the Step 1: Choose configuration tab, perform the following steps:

   Important

   In Choose Configuration, Helix iPaaS (powered by Jitterbit) is selected by default. Do not change this value.

   1. Under DevOps integration, select ITSM Problem to Jira Issue.
      
   2. Click Next.
7. In the Step 2: Perform configurations tab, perform the following steps:
   1. Add an operating organization, if you have not already done so.
   2. Add Atlassian as the vendor organization, if you have not already done so.
   3. To add vendor metadata configuration, click Map vendors and perform the following steps:
      1. On the Map Vendors page, click Map Vendor.

      2. Complete the fields as described in the following table:

         Field	Action
         Description	Enter a description for the vendor metadata configuration.
         Ticketing Technology Provider	From the list, select JIRA.
         Instance Name	If you are using multiple instances of Jira, enter the name of the Jira instance that you are using for this integration.
         Add Mapping	After you select the ticketing technology provider, click Add Mapping. BMC Helix Multi-Cloud Broker displays the default values in the Instance URL field, and the Vendor Field Mapping and Display Field Mapping sections.
         (Optional) Instance URL	Update the Jira server name and port in the default URL. The default value of this variable is https://[jira server name]:[port]/browse/{key}.
         Vendor Field Mapping	To perform a direct data synchronization between BMC Helix ITSM and Jira, only update the mappings in the Remedy to Vendor Sync Fields and Vendor to Remedy Sync Fields sections. You must not update any other sections.
         Display Field Mapping	By default, the basic Jira fields are mapped in this section. If you want to map additional fields to display in the BMC Helix ITSM UI, add the relevant mappings by clicking .
         Enable Local ITSM Communication	By default, this toggle key is enabled.  If you want to use BMC Helix Integration Service as the underlying integration platform, disable this toggle key.
         Resolves Problem Ticket When Vendor Closes It	Select this option if you want to close the problem record when a Jira issue is closed.
         Integration Platform	Select Jitterbit.

      3. Click Save.
   4. To fetch the problem records, click Define filter criteria to fetch records from ITSM to Helix Multi-Cloud Broker for problem, and perform the following steps:
      1. To select the filter criteria, click Advanced filter.
         
      2. Select the filters from the available fields, and click Next.
         The query filter expression is displayed. By default, the AND qualifier is applied when you select multiple filter criteria.

1. 1. 1. To change the qualifier for your filters, update the query, and then click Save. 

         Important

         Make sure that you enter a valid query with available fields and values.

         

      2. Click Close.
         When a problem record matches the operation and filter that you have selected, the system fetches that problem record to BMC Helix Multi-Cloud Broker.
2. In the Configure JIRA integration section, refer the configuration steps listed and select the check boxes as you complete each step.
3. Click Save.

Task 2: To download and import the integration template project file

1. Download the Create Atlassian Jira issue from BMC Helix ITSM problem Update 2024-04 file.
   This file contains the BMC Helix iPaaS Cloud Studio project Create Atlassian Jira issue from BMC Helix ITSM problem.

   Important

   Your ability to access product pages on the EPD website is determined by the license your company purchased.

2. Log in to BMC Helix iPaaS and navigate to Cloud Studio.
3. Select your organization.
4. On the projects page, click Import.
5. Click Browse and then select the Create Atlassian Jira issue from BMC Helix ITSM problem.json file you downloaded.
   The Project Name and Organization fields are automatically populated. The default project name is displayed. You can change the project name.
6. From the Environment list, select the environment to which you want to import this integration template, and click Import.
   The project opens after the integration template is imported. 
7. To open the project file at a later time, select the environment where the integration templates are available, select the project name, and click View/Edit.

Task 3: To update the project variables for the integration template

1. Next to the Environment name, click the ellipsis ... next to the project name and select Project Variables.
   
   
2. Update the project variables as described in the following tables:

   • BMC Helix iPaaS variables:
     

     Project variable	Action
     BHIP_API_NAME	Enter the name for API that is created in BMC Helix iPaaS to receive BMC Helix Multi-Cloud Broker webhook requests. The default value of this variable is set to BMCHelixITSMProblemAndJiraIssue.
     BHIP_API_User_Roles	Specify the organization roles that should have access to the new API. You can add multiple comma separated values. Important: If you do not specify any value, all the organization roles get access to the new API.
     BHIP_MCB_API_Profile_User_Name	Enter the user name for the security profile used with the BMC Helix iPaaS API for BMC Helix Multi-Cloud Broker. The integration template creates an API in BMC Helix iPaaS to handle requests from BMC Helix Multi-Cloud Broker.
     BHIP_MCB_API_Profile_User_Password	Enter the password for the security profile used with the BMC Helix iPaaS API for BMC Helix Multi-Cloud Broker. The integration template creates an API in BMC Helix iPaaS to handle requests from BMC Helix Multi-Cloud Broker.
     BHIP_Vendor_API_Profile_Type	Change the default value by selecting one of the following supported values, if required: BASIC ANONYMOUS APIKEY The default value is APIKEY.
     BHIP_Vendor_API_Profile_User_Name	Enter the user name for the security profile that you want to use with the vendor API.  Important: You need to provide a value for this variable, only if you select the BASIC option in BHIP_Vendor_API_Profile_Type.
     BHIP_Vendor_API_Profile_User_Password	Enter the password for the security profile that you want to use with the vendor API.  Important: You need to provide a value for this variable, only if you select the BASIC option in BHIP_Vendor_API_Profile_Type.
     BHIP_Vendor_API_Profile_ApiKey_Name	For security profile type APIKEY, enter a name for the API key. The default value is apiKey.
     BHIP_Host	Enter the BMC Helix iPaaS instance URL where you want to run this project. Important: Make sure that you do not enter any leading and trailing spaces.
     BHIP_User_Name	Enter the user name for the BMC Helix iPaaS instance.
     BHIP_User_Password	Enter the password for the BMC Helix iPaaS instance.
     Enable_BMC_Helix_To_Vendor_Integration	Perform any of the following actions: To enable the creation of Jira issues from BMC Helix ITSM problem records, and synchronization of comments, enter true. To disable creation of Jira issues from BMC Helix ITSM problem records, and synchronization of comments, enter false.
     Enable_Vendor_To_BMC_Helix_Integration	Perform any of the following actions: To enable the updation of BMC Helix ITSM problem records with the IDs of corresponding Jira tickets, and synchronization of comments, enter true. To disable the updation of BMC Helix ITSM problem records with the IDs of corresponding Jira tickets, and synchronization of comments, enter false.

   • Jira project variables:

     Project variable	Action
     Jira_Host_URL	Enter the host URL of the Jira instance in the following format: [http/https]://[hostname]:[port] Important: Make sure that you do not enter any leading and trailing spaces.
     JIRA_INSTANCE_TYPE	Select one of the following instance types from the list: Jira Cloud: Connect to Jira Software Cloud. Jira on-premises: Connect to Jira Server or Jira Data Center.
     Jira_User_Name	Enter the name of the user accessing Jira.
     Jira_User_Password	Enter the API token for Jira that you created earlier.
     Jira_Query_Project_Keys	Enter the Jira project key from which you want to filter Jira issues. You can add multiple project keys by specifying comma separated values; for example, JiraProject1, JiraProject2. Important: While adding a value in this variable, make sure that you include the project key specified in the Jira_Create_Issue_Project_Key variable. This enables the synchronization of problem records that are brokered from BMC Helix ITSM to Jira.
     Jira_Create_Issue_Project_Key	Enter the Jira project key under which you want to create a Jira issue from a BMC Helix ITSM problem record; for example, if you specify MCB as the project key, when a problem record is created in BMC Helix ITSM, a corresponding Jira issue is created under the Jira project with the specified key.Important: You can also specify the Jira project key by mapping a BMC Helix Multi-Cloud Broker field that contains the project key with the key field in the target application. To do this action, in the MCB Workflow, you update a transformation by deleting the existing mapping in the key field and then mapping it with the BMC Helix Multi-Cloud Broker field in the project element. Refer to the following image and perform the steps in the given sequence to map the fields:

   • BMC Helix Multi-Cloud Broker project variables:

     Project variable	Action
     MCB_Host	Enter the BMC Helix Multi-Cloud Broker host URL to which Jira issues should be synchronized. Important: Make sure that you do not enter any leading and trailing spaces.
     MCB_User_Name	Enter the user name that enables users to interact with BMC Helix Multi-Cloud Broker.
     MCB_User_Password	Enter the password for the provided username.
     MCB_Vendor_Name	Enter the value in the following format for multiple instances of Jira: JIRA.<Instance name> The instance name in the format is the name that you entered in the Instance Name field while configuring vendor metadata.
     MCB_Field_ID_For_Jira_Issue_Type	Enter the BMC Helix Multi-Cloud Broker field ID that contains the value for defining the Jira issue type during BMC Helix Multi-Cloud Broker to Jira operations. The default value of this field is 466000053 that is mapped with the Operational Category Tier 3 field in the problem record. If you use any other field from the problem record to contain the Jira issue type, enter the ID of that field in this variable. Important: If this variable is blank, by default, a Jira story is created.

Task 4: To Map the priority, severity, and status values between BMC Helix Multi-Cloud Broker and Jira

The values defined in Jira for status, priority, and severity can vary depending on your organization's configuration of Jira. You must map the values defined for your organization with the appropriate values in BMC Helix Multi-Cloud Broker. 

1. Select the Components tab in the project, and search for the MCB to Jira Field Transformations script. 

   Important

   Also, update the Jira To MCB Fields Mapping script to map the fields in Jira with the available field value IDs.

2. Next to MCB to Jira Field Mappings, click the ellipsis ...  and select View/Edit.

3. Update the script to map the field value IDs in BMC Helix Multi-Cloud Broker with the available Jira issue values for priority, severity, and status. 
   The following script is an example of available mappings. Update the Jira issue values based on the values available in your Jira project.

   <trans>
   
   If($JIRA_INSTANCE_TYPE == "CLOUD",
   //Priority mapping
   $priority = Dict();
   AddToDict($priority, '1000', 'Highest');
   AddToDict($priority, '2000', 'High');
   AddToDict($priority, '3000', 'Medium');
   AddToDict($priority, '4000', 'Low');
   AddToDict($priority, '', 'Lowest');
   
   ,
   //Priority mapping
   //$priority = Dict();
   AddToDict($priority, '1000', 'P1');
   AddToDict($priority, '2000', 'P2');
   AddToDict($priority, '3000', 'P3');
   AddToDict($priority, '4000', 'P4');
   AddToDict($priority, '', 'P4');
   );
   
   /*
   //Declare Severity mapping
   $mcsmToJiraMap["Severity"] = Dict();
   $mcsmToJiraMap["Severity"]["4-Low"] = "4 - Low";
   $mcsmToJiraMap["Severity"]["3-Medium"] = "3 - Medium";
   $mcsmToJiraMap["Severity"]["2-High"] = "2 - High";
   $mcsmToJiraMap["Severity"]["1-Severe"] = "1 - Severe";
   */
   
   // Status mapping
   $status = Dict();
   // Declare MCSM status Id to Jira Status
   AddToDict($status, '0', 'To Do');//MCSM(Draft) <-> Jira(To Do)
   AddToDict($status, '1', 'To Do');//MCSM(Under Review) <-> Jira(To Do)
   AddToDict($status, '2', 'To Do');//MCSM(Request For Authorization) <-> Jira(To Do)
   AddToDict($status, '3', 'In Progress');//MCSM(Assigned) <-> Jira(In Progress)
   AddToDict($status, '4', 'In Progress');//MCSM(Under Investigation) <-> Jira(In Progress)
   AddToDict($status, '5', 'In Progress');//MCSM(Pending) <-> Jira(Done)
   AddToDict($status, '6', 'Done');//MCSM(Completed) <-> Jira(Done)
   AddToDict($status, '7', 'Done');//MCSM(Rejected) <-> Jira(Done)
   AddToDict($status, '8', 'Closed');//MCSM(Closed) <-> Jira(Done)
   AddToDict($status, '9', 'Cancelled');//MCSM(Cancelled) <-> Jira(Done)  
   
   </trans>

   Important

   • For the Cloud instances of Jira, update the priority mappings in the first instance of the //Priority mapping section, after If($JIRA_INSTANCE_TYPE == "CLOUD",
   • For the OnPremises instances of Jira, update the priority mappings in the second instance of the //Priority mapping section after If($JIRA_INSTANCE_TYPE == "CLOUD",
   • You must define separate templates for Cloud and OnPremises instances of Jira
   • BMC Helix ITSM defines a workflow for the status transition of the ticket. Make sure that the status transitions defined in Jira for the mapped values apply the same restrictions for the status transition to work.
4. Click Test to validate your mappings, and correct any issues.
5. Click x to save your changes.

Task 5: Manually select the Jira project for your integration

Before you enable the integration, you need to manually select the Jira project for your integration in the workflow.

To select the Jira project for the Jira activities:

1. Log in to BMC Helix iPaaS and navigate to the Cloud Studio.
2. From the Environment list, select the environment where your integration template is available.
3. Select the project name, and click View/Edit.
4. Select the Components tab, and search for the Jira endpoints for the following activities:
   1. create
   2. update
5. Select the activity brick, click the ellipses (...), and select View/Edit.
   
6. On Step 1 of the activity page, click Refresh.
7. Then select the name of the Jira project from the list and click Next.
8. Click Next on Step 2 and Finished on Step 3. 
   Repeat this process for both, the create and update activities for the Jira connector. 

Task 6: To deploy and enable the project

Deployment is a one-time activity that initializes the integration configurations. The UI displays a message for the deployment status.

To deploy the project and then enable the integration:

1. To deploy the project, next to the project name, click the ellipsis ..., and select Deploy Project.
2. To enable the integration, next to the Enable Integrations operation, under 2.0 Integrations workflow, click the ellipsis ..., and select Run.

The following image shows the steps to deploy the project and enable it by deploying the workflow:

After you enable the integration, when a problem record is created in BMC Helix ITSM, a corresponding issue is created in Jira. When the vendor data in the Jira issue is updated, the corresponding BMC Helix ITSM problem record is updated. Comments added to Jira issue are synced with the BMC Helix ITSM problem record, and the converse is true.

(Optional) Task 7: To set the time for API debug mode

By default, the debug mode is set to 2 hours after you run the integration. Debug logs are updated for the time set for the debug mode. To increase the debug mode for a longer period of time, perform the following steps:

1. In BMC Helix iPaaS, select API Manager > My APIs.
2. Open any of the following APIs:
   • BMC_Helix_ITSM_Problem_And_Jira_Issue_MCB_To_Vendor—This API creates a Jira from a BMC Helix ITSM problem record.
   • BMC_Helix_ITSM_Problem_And_Jira_Issue_Vendor_To_MCB—This API updates the vendor data in BMC Helix Multi-Cloud Broker from a Jira issue update.
3. Select Enable Debug Mode Until: and set it for the required date and time.
4. Save and publish the API.

(Optional) Task 8: To map a custom field between BMC Helix ITSM and Jira

You can map custom fields between BMC Helix ITSM and Jira. To learn about the steps to customize the integration, see Mapping-custom-fields-for-integrations-by-using-BMC-Helix-iPaaS-powered-by-Jitterbit.