This documentation supports the 25.1 and consecutive patch versions of BMC Helix Multi-Cloud Broker.To view an earlier version, select the version from the Product version menu.

Reference for integration between xMatters and BMC Helix ITSM incidents by using BMC Helix iPaaS


You can integrate BMC Helix ITSM with xMatters to synchronize xMatters events with BMC Helix ITSM incidents. . When you create an incident with Incident Type as User Service Restoration and Resolution Category as Request > xMatters > Events in BMC Helix ITSM, an event is triggered in xMatters. This integration enables administrators to manage xMatters events in BMC Helix ITSM.

BMC Helix Multi-Cloud Broker, along with BMC Helix iPaaS provides an out-of-the-box integration template to integrate BMC Helix ITSMand xMatters. You configure the integration in BMC Helix Multi-Cloud Brokerand deploy the integration template to your BMC Helix iPaaSenvironment.

List of project variables

The following sections describe the variables that you can update as per your requirements.

  • BMC Helix iPaaSproject variables

    Project variable

    Action

    BHIP_API_Name

    Enter the name for the API that is created in BMC Helix iPaaSto receive BMC Helix Multi-Cloud Brokerwebhook requests.

    The default value of this variable is set to BMCHelixITSMIncidentAndxMattersEvent.

    If required, change the name.

    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_Username

    The integration template creates an API in BMC Helix iPaaSto handle requests from BMC Helix Multi-Cloud Broker.

    Enter the user name that should be used while creating the BMC Helix Multi-Cloud BrokerAPI profile.

    BHIP_MCB_API_Profile_Password

    The integration template creates an API in BMC Helix iPaaSto handle requests from BMC Helix Multi-Cloud Broker.

    Enter the password that should be used while creating the BMC Helix Multi-Cloud BrokerAPI profile.

    BHIP_Vendor_API_Profile_Type

    The integration templates create APIs to accept requests from a vendor.

    Enter one of the following API authentication mechanisms that you want to use with this API:

    • BASIC
    • ANONYMOUS
    • APIKEY

    The default value of this variable is BASIC.

    BHIP_Vendor_API_Profile_Username

    Enter the user name for the security profile that you want to use with the vendor API. 

    Important: Provide a value for this variable only if you select the BASIC option in BHIP_Vendor_API_Profile_Type.

    BHIP_Vendor_API_Profile_Password

    Enter the password for the security profile that you want to use with the vendor API. 

    Important: 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

    Enter the APIKEY name for the security profile that you want to use with the vendor API. 

    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 iPaaSinstance 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 iPaaSinstance.

    BHIP_User_Password

    Enter the password for the BMC Helix iPaaSinstance.

  • xMatters variables:

    Project variable

    Action

    xMatters_Host_URL

    Enter the xMatters instance URL where you want to run this project.

    Important: Make sure that you do not enter any leading and trailing spaces.

    xMatters_User_Name

    Enter the user name to access xMatters.

    xMatters_User_Password

    Enter the password for the xMatters user.

    xMatters_Form_Name

    Enter the name of the xMatters form to be populated.

    xMatters_Trigger_Name

    Enter the type of trigger used to define the purpose of the webhook; for example, Event Status Updates.

    xMatters_Client_Id

    Enter the xMatters Client ID. The value of the client ID for your company is available on the OAuth page of the Workflows tab.

    xMatters_Endpoint

    Enter the name of the xMatters endpoint used to establish the webhook connection.

    xMatters_Integration

    Enter the name of the workflow defined for the outbound integration. Enter Integrations.

    xMatters_Workflow_Name

    Enter the name of the xMatters workflow.

  • BMC Helix Multi-Cloud Brokerproject variables:

    Project variable

    Action

    MCB_Host

    Enter the BMC Helix Multi-Cloud Brokerhost URL to which the xMatters events should be synchronized.

    MCB_Username

    Enter the user name that enables users to interact with BMC Helix Multi-Cloud Broker.

    MCB_Password

    Enter the password for the provided user name.

    MCB_Vendor_Name

    This variable is autopopulated. Do not change the default value.

    MCB_Assigned_Group

    Enter the name of the support group to which you want to assign the incident.

    MCB_Assigned_Support_Organization

    Enter the name of the support organization to which you want to assign the incident.

    MCB_Assigned_Support_Company

    Enter the name of the support company to which you want to assign the incident.

    MCB_Assigned_Company

    Enter the name of the company for which you want to create the incident.

    MCB_Assigned_Company_Id

    Enter the ID of the company for which you want to create the incident.

    MCB_Assigned_Business_Unit

    Enter the name of the business unit to which you want to assign the incident.

    The following variables are inputs from BMC Helix ITSM. Either enter values for these variables or map appropriate xMatters fields if the data is available:

    Project variable

    Action

    ITSM_Company_Name

    Enter the company name for which the integration template needs to be run; for example, Apex Global.

    ITSM_Customer_First_Name

    Enter the first name of the BMC Helix ITSMcustomer.

    ITSM_Customer_Last_Name

    Enter the last name of the BMC Helix ITSMcustomer.

    ITSM_Incident_Type

    Enter any of the following incident types for which a corresponding xMatters alert should be created:

    • User Service Restoration
    • User Service Request
    • Infrastructure Restoration
    • Infrastructure Event
    • Security Incident

    The default value of this variable is set to User Service Restoration.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*