Creating incidents from Dynatrace problems via BMC Helix iPaaS, powered by Jitterbit
As an administrator, you can integrate BMC Helix ITSM with Dynatrace to synchronize Dynatrace alerts with BMC Helix ITSM incidents. When an alert is generated for a problem in Dynatrace, a corresponding incident is created in BMC Helix ITSM, enabling administrators to manage Dynatrace alerts in BMC Helix ITSM.
BMC Helix Multi-Cloud Broker, along with BMC Helix iPaaS, powered by Jitterbit provides an out-of-the-box integration template to integrate BMC Helix ITSM and Dynatrace. You configure the integration in BMC Helix Multi-Cloud Broker and deploy the integration template to your BMC Helix iPaaS, powered by Jitterbit environment.
The following image provides an overview of the capabilities that this integration supports:
This integration provides the following capabilities:
Use case | Dynatrace to BMC Helix ITSM | BMC Helix ITSM to Dynatrace |
---|---|---|
Create tickets | Creates a BMC Helix ITSM incident for a Dynatrace problem. The host name, display ID, problem title, and problem ID are added to the Description field in the Problem details section of the BMC Helix Multi-Cloud Broker incident created. Important:
| NA |
Synchronize updates | Updates the vendor data in BMC Helix Multi-Cloud Broker when a Dynatrace problem is created. You can then view the Dynatrace problem details in the BMC Helix ITSM: Smart IT UI. | Closes a Dynatrace problem and removes the incident ID from the problem notification when the corresponding BMC Helix Multi-Cloud Broker incident is closed. The host details are removed from the problem details section in the BMC Helix Multi-Cloud Broker incident. |
Updates the incident when a new problem is created for the same notification | NA |
The following image is an example of the Dynatrace problem details displayed in the corresponding BMC Helix ITSM incident:
Dynatrace to BMC Helix ITSM data flow
The following image gives an overview of the data flow for creating or updating a BMC Helix ITSM incident from a Dynatrace problem:
BMC Helix ITSM to Dynatrace data flow
The following image gives an overview of the data flow for closing the Dynatrace problem when a BMC Helix ITSM incident is closed:
Before you begin
You require the following items to successfully set up and use this integration:
Required versions |
|
---|---|
Authentication and permissions |
To learn about assigning these permissions to users, seePersonal access tokens in the official Dynatrace documentation. |
Jitterbit Harmony subscription |
|
Application registration |
|
Limitations |
|
Task 1: To configure the integration
- Log in to BMC Helix Innovation Studio.
- On Workspace, click Multi-Cloud Broker.
To launch BMC Helix Multi-Cloud Broker, click Visit Deployed Application.
- Click Settings
.
Select Start Here > Quick Configuration Guide.
The Quick Configuration Guide page is displayed.
On the Step 1: Choose configuration tab, perform the following steps:
- Under Notifications, select Dynatrace Alert to ITSM Incident.
- Click Next.
- Under Notifications, select Dynatrace Alert to ITSM Incident.
- On the Step 2: Perform configurations tab, perform the following steps:
- Add an operating organization, if you have not already done so.
- Add Dynatrace as the vendor organization, if you have not already done so.
- To add the vendor metadata, click Manage Vendor Metadata and perform the following steps:
- On the Map Vendors page, click Map Vendor.
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 DynatraceAlert.
(Optional) Instance Name
If you are using multiple instances of Dynatrace, enter the name of the 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 Display Field Mapping section.
Instance URL
If you have clicked Add Mapping, this field is auto-populated with a default URL.
Update the instanceUrl value in the default URL.
The default value of this variable is https://<dynatrace server name>/ui/settings/builtin:problem.notifications?gtf=-2h&gf=all&id={notificationId}
Replace <dynatrace server name> with the host name of your Dynatrace instance. For example, update the value to https://dynatrace.bmc.com/ui/settings/builtin:problem.notifications?gtf=-2h&gf=all&id={notificationId}
Process Name
Enter a name for the process that is created in BMC Helix Innovation Studio.
The default value of this variable is com.bmc.dsm.ticket-brokering-lib:Connector Process DynatraceAlert.
Display Field Mapping
By default, the basic Dynatrace fields are mapped in this section.
If you want to map additional fields to be displayed in the BMC Helix ITSM UI, add the relevant mappings by clicking
.
Integration Platform
Select Jitterbit.
- Click Save.
- On the Map Vendors page, click Map Vendor.
- To fetch incidents from BMC Helix ITSM, click Define filter criteria to fetch records from ITSM to Helix Multi-Cloud Broker for incident, and perform the following steps:
- To select the filter criteria, click Advanced filter.
- 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. To change the qualifier for your filters, update the query, and then click Save.
- Click Close.
When an incident matches the operation and filter that you have selected, the system fetches that incident to BMC Helix Multi-Cloud Broker.
- To select the filter criteria, click Advanced filter.
- In the Configure Dynatrace integration section, refer to the configuration steps listed and select the check boxes as you complete each step.
- Click Save.
Task 2: To download and import the integration template project file
Download the Sync BMC Helix ITSM incidents and Dynatrace Alerts 2022-10-01 file.
This file contains the BMC Helix iPaaS Cloud Studio project Sync BMC Helix ITSM incidents and Dynatrace Alerts.- Log in to BMC Helix iPaaS and navigate to Cloud Studio.
- Select your organization.
- On the projects page, click Import.
- Click Browse and then select the Sync BMC Helix ITSM incidents and Dynatrace Alerts.json file you downloaded.
The Project Name and Organization fields are automatically populated. The default project name is displayed, but you can change it, as needed. - 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. - 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
- Next to the Environment name, click the ellipsis ... and select Project Variables.
- Update the project variables as described in the following tables:
BMC Helix iPaaS project 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 DynatraceAPIName.
Do not 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_User_Name
Enter the user name that should be used while creating the BMC Helix Multi-Cloud Broker API profile.
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 that should be used while creating the BMC Helix Multi-Cloud Broker API profile.
The integration template creates an API in BMC Helix iPaaS to handle requests from BMC Helix Multi-Cloud Broker.
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_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_User_Name
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_User_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_Host
Enter the BMC Helix iPaaS instance URL where you want to run this project.
Important: Make sure you don't 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 updation of Dynatrace alert status and removal of the incident ID from the problem notification, enter true.
- To disable the updation of Dynatrace alert status and removal of the incident ID from the problem notification, enter false.
Enable_Vendor_To_BMC_Helix_Integration
Perform any of the following actions:
- To enable the creation of BMC Helix ITSM incidents from Dynatrace alerts, and updation of vendor data in BMC Helix ITSM incidents, enter true.
- To disable the creation of BMC Helix ITSM incidents from Dynatrace alerts, and updation of vendor data in BMC Helix ITSM incidents, enter false.
Dynatrace variables:
Project variable
Action
Dynatrace_Host
Enter the Dynatrace instance URL where you want to run this project.
Dynatrace_API_Token
Enter the API token generated for Dynatrace.
DYNATRACE_NOTIFICATIONS
Add comma separated values of the names of the notifications you want to trigger when problems associated to the notifications are created. The notifications must be available in Dynatrace.
To learn more about adding notifications in Dynatrace, see Adding notifications in Dynatrace by using webhooks in the official Dynatrace documentation.
BMC Helix Multi-Cloud Broker project variables:
Project variable
Action
MCB_Host
Enter the BMC Helix Multi-Cloud Broker host URL to which Dynatrace alerts should be synchronized.
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 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 Dynatrace 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 ITSM customer.
ITSM_Customer_Last_Name
Enter the last name of the BMC Helix ITSM customer.
ITSM_Incident_Type
Enter any of the following incident types for which you want to create a Dynatrace alert:
- User Service Restoration
- User Service Request
- Infrastructure Restoration
- Infrastructure alert
- Security Incident
Dynatrace alerts are generated only for the incidents of the types defined in this variable. The default value of this variable is User Service Restoration.
Task 4: 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:
- To deploy the project, next to the project name, click the ellipsis ..., and select Deploy Project.
- 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 is created in Dynatrace, a corresponding incident is created in BMC Helix ITSM. Any additional alerts created for the problem are included in the same incident.
(Optional) Task 5: 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:
- In BMC Helix iPaaS, powered by Jitterbit, select API Manager > My APIs.
- Open the BMC_Helix_ITSM_Incident_And_Dynatrace_alert_Vendor_To_MCB API.
- Select Enable Debug Mode Until: and set it for the required date and time.
- Save and publish the API.