Reference for integration between BMC Helix ITSM change requests and Jira issues by using BMC Helix iPaaS
List of project variables
The following sections describe the variables that you can update as per your requirements:
BMC Helix iPaaS variables:
Project variable
Action
BHIP_API_NAME
The integration template creates an API in the BMC Helix iPaaS API Manager to handle requests from BMC Helix Multi-Cloud Broker and Jira.
Enter a prefix for the webhook APIs created in the BMC Helix Multi-Cloud Broker API Manager.
BHIP_API_User_Roles
Enter comma-separated values of the organization roles assigned for the BMC Helix iPaaS API; for example: Admin, User.
Only a user with these roles can access the APIs.
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 a password for the BMC Helix Multi-Cloud Broker API security profile.
BHIP_Vendor_API_Profile_Type
The security profile type defines the authentication type used by the Jira webhook API to access the BMC Helix iPaaS API, and is added in the BMC Helix iPaaS API Manager.
Enter one of the following values:
- BASIC
- ANONYMOUS
BHIP_Vendor_API_Profile_User_Name
The integration template creates an API in the BMC Helix iPaaS API Manager to handle requests from Jira. The API is created and accessed by using security profile credentials which the integration template includes in the webhook created in Jira. Jira uses the credentials to communicate with the API.
Enter the user name for the Jira API security profile.
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 a password for the Jira API security profile.
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 the security profile type APIKEY, enter a name for the API key to create the Jira profile.
The default value is apiKey.Important:
Provide a value for this variable, only if you select the APIKEY option in BHIP_Vendor_API_Profile_Type.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 in the URL.
BHIP_User_Name
Enter the login ID to access the BMC Helix iPaaS instance.
Important:
The BMC Helix iPaaS login credentials are required to create the API in BMC Helix iPaaS by using RestAPI. The credentials are required because BMC Helix iPaaS does not provide the login status of a user.BHIP_User_Password
Enter the password for the login ID.
Enable_BMC_Helix_To_Vendor_Integration
Enable the creation of Jira issues from BMC Helix ITSM change requests, and synchronization of updates and comments.
By default, this variable is set to true.
If you want to disable the creation of Jira issues, and synchronization of updates and comments, set the default value to false.Enable_Vendor_To_BMC_Helix_Integration
Enable the creation of BMC Helix ITSM change requests from Jira issues, and synchronization of updates and comments.
By default, this variable is set to true.
If you want to disable the creation of BMC Helix ITSM change requests from Jira issues, and synchronization of updates and comments, set the default value to false.
Jira project variables:
Project variable
Action
Jira_Host
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_JQL_Query
Enter a JQL query in "" to specify the Jira issues for which BMC Helix ITSM change requests should be created.
For example, specify "Priority=High" so that the Jira issues with High priority are brokered to BMC Helix ITSM .
Important:
- Do not enter a value for this variable if you are implementing only the BMC Helix ITSM to Jira use case.
- Do not include a project condition in this variable.
Jira_Query_Project_Keys
Enter the Jira project key from which you want to filter Jira issues to broker to BMC Helix ITSM . 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 change requests 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 change request; for example, if you specify MCB as the project key, when a change request 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 with which Jira issues should be synchronized in the following format:
[http/https]://[hostname]:[port]
Important:Make sure that you do not enter any leading and trailing spaces in the URL.
MCB_User_Name
Enter the user name to access BMC Helix Multi-Cloud Broker .
MCB_User_Password
Enter the password for the provided username.
MCB_Vendor_Name
For multiple instances of Jira, enter the value in the following format:
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 which is mapped with the Operational Category Tier 3 field in the change record. If you use any other field from the change 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.