Dynatrace connector powered by Jitterbit

Use the BMC Helix iPaaS Dynatrace connector to easily integrate BMC Helix ITSM and Dynatrace to sync tickets and problems. A specific Dynatrace connection and its activities together are referred to as a Dynatrace endpoint. Use the connector to perform the following actions:

  • Configure the connection to create an authenticated Dynatrace connection by entering credentials
  • Configure associated Dynatrace activities that interact with the connection to be used either as a source to provide data within an operation, or as a target to consume data within an operation
  • Use the connector activities to perform the following actions: 
    • Create, get, and close problem records
    • Get and update problem record notifications

Supported API versions and prerequisites

The Dynatrace connector uses the  Dynatrace API changelog version 1.206 . For more information about the schema fields, see the API documentation.

The Dynatrace connector requires the use of an agent version  10.1  or later. These agent versions automatically download the latest version of the connector when required.

To configure the Dynatrace connection

Configure a Dynatrace connection by using the Dynatrace connector, establishing access to the Dynatrace endpoint. After a connection is established, you can configure one or more Dynatrace activities associated with that connection to be used either as a source to provide data to an operation or as a target to consume data in an operation. 

To configure a Dynatrace connection, complete the following steps:

  1. From the design canvas, open the Connectivity tab  of the design component palette:
  2. Perform one of the following actions:
    • To configure a new Dynatrace connection, use the Show list to filter on Connectors, and then click the Dynatrace connector block:
    • To configure an existing Dynatrace connection, use the Show list to filter on Endpoints, and then double-click the Dynatrace connector block:
  3. On the configuration screen for the Dynatrace connection, enter the following configuration values:

    Tip

    Fields with a variable icon  support using  global variables project variables , and Jitterbit variables . Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

    Field name

    Action

    Endpoint Name

    Enter a name to identify the Dynatrace connection. The name must be unique for each Dynatrace connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Dynatrace endpoint, which refers to both a specific connection and its activities.

    Dynatrace Host URL

    Enter the URL of your Dynatrace instance.

    API Token

    Value of the API token generated for your Dynatrace instance.

    After configuring a Dynatrace connection, you can configure one or more Dynatrace activities associated with that connection to be used either as a source (to provide data within an operation) or as a target (to consume data within an operation). For more information about creating an activity, see Creating a Dynatrace activity.

To create a Dynatrace activity 

  1. From the design canvas, open the Connectivity tab  of the design component palette.
  2. Use the Show list to filter on Endpoints, and then click the Dynatrace connection block to display activities that are available to be used with a Dynatrace connection:

    The following activities are available. For more information about configuring these activities, see the specific activity sections.

    Create ProblemInserts details of a new problem record into a Dynatrace endpoint and is intended to be used as a target in an operation.
    Get ProblemRetrieves existing problem record based on the Problem ID from the Dynatrace endpoint and is intended to be used as a source in an operation.
    Get All ProblemsRetrieves existing problem records from a Dynatrace endpoint and is intended to be used as a source in an operation.
    Get Problem Notification

    Retrieves notifications for existing problem records in Dynatrace.

    Update Problem Notification

    Updates the BMC Helix ITSM ticket details in the corresponding Dynatrace problem record; for example, the BMC Helix ITSM ticket Id.

    Close ProblemInserts data to close a problem record into a Dynatrace endpoint and is intended to be used as a target in an operation.
  3. To create an activity that can be configured, drag the activity block  from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see  Operation Creation and Configuration

To configure a Dynatrace Create Problem activity 

A Dynatrace Create Problem activity places details of a new problem record into a Dynatrace endpoint and is intended to be used as a target to consume data in an operation. After configuring a Dynatrace connection, you can configure as many Dynatrace activities as you like for each connection. 

To configure a Dynatrace Create Problem activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity block.

  2. On the configuration screen, enter a name and specify the activity settings.

    Field nameAction
    Name

    Enter a name to identify the Dynatrace Create Problem Events activity. The name must be unique for each Dynatrace Create Problem Events activity and must not contain forward slashes (`/`) or colons (`:`).

    Event TypeSelect the type of event you want to create. Valid values include:
    • AVAILABILITY_EVENT
    • CUSTOM_ALERT
    • ERROR_EVENT
    • PERFORMANCE_EVENT
    • RESOURCE_CONTENTION
    DescriptionEnter a short description for the problem event to create.
    SourceThe name or ID of the source of the event.
    MeTypes

    The type of the Dynatrace entity, for example HOST or SERVICE. For a complete list of meTypes, see the details for TagMatchRule object .

    TagsEnter the list of tags for the selected Dynatrace entity.
    Optional Settings

    Click to expand additional optional settings:

    • JSON input (This event definition overrides the prior selections): Enter the Key-Value pair for the alert fields. Use the {"Key": "Value"} or [{"Key": "Value"}] format. For example,
      {
      "start_time": "1612937307549",
      "timeoutMinutes": 10,
      "customProperties": {"key": "value"},
      "title": "<title>",
      "allowDavisMerge": "false"
      }

    Important: Fields with a variable icon  support using  global variables project variables , and Jitterbit variables . Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  3. Click Next.

  4. Review the request and response data schemas.
    The data schemas list the fields available for the Dynatrace Create Problem activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    For more information about transformations, see  Transformations

  5. Click Finished
    After a Dynatrace activity has been created, you can access the menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu .

From the operation settings, you can chain operations from the same or different workflows.

Dynatrace Create Problem operation patterns

Dynatrace Create Problem activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Transformation Pattern  (as the first or second source)

For more information about the validation patterns, see the  Operation Validity  page.

A typical workflow uses a Dynatrace Create Problem activity in the Two-Transformation Pattern. In this example, the first transformation (Dynatrace Create Problem Events Request) creates a request structure that is passed to the Dynatrace Create Problem Events activity. The second transformation (Dynatrace Create Problem Events Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Dynatrace Create Problem Response) and a message is then logged by the Write to Operations Log script:


Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs

To configure a Dynatrace Get Problem activity 

A Dynatrace Get Problem activity retrieves a problem record based on the Problem ID into a Dynatrace endpoint and is intended to be used as a source to consume data in an operation. After configuring a Dynatrace connection, you can configure as many Dynatrace activities as you like for each Dynatrace connection. 

To configure a Dynatrace Get Problem activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity block.

  2. On the configuration screen, enter a name and specify the activity settings.

    Field nameAction
    NameEnter a name to use to identify the Dynatrace Get Problem activity. The name must be unique for each Dynatrace Get Problem activity and must not contain forward slashes (/) or colons (:).
    Problem IDEnter the Problem ID or select the variable for the Problem ID which you want to retrieve.
  3. Click Next

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the ALM Octane Create activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    For more information about transformations, see Transformations .

  5. Click Finished
    After a Dynatrace activity has been created, you can access the menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu .

From the operation settings, you can chain operations from the same or different workflows.

Dynatrace Get Problem operation patterns

Dynatrace Get Problem activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Transformation Pattern  (as the first or second source)

For more information about the validation patterns, see the  Operation Validity  page.

A typical workflow uses a Dynatrace Get Problem activity in the Two-Transformation Pattern. In this example, the first transformation (Dynatrace Get Problem Request) creates a request structure that is passed to the Dynatrace Get Problem Details activity. The second transformation (Dynatrace Get Problem Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Dynatrace Get Problem Response) and a message is then logged by the Write to Operation Log script:

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs

To configure a Dynatrace Get All Problems activity 

A Dynatrace Get All Problems activity retrieves problem records into a Dynatrace endpoint and is intended to be used as a source to consume data in an operation. After configuring a Dynatrace connection, you can configure as many Dynatrace activities as you like for each Dynatrace connection.

To configure a Dynatrace Get All Problems activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity block.

  2. On the configuration screen, enter a name and specify the activity settings.

    Field nameAction
    NameEnter a name to use to identify the Dynatrace Get All Problems activity. The name must be unique for each Dynatrace Get All Problems activity and must not contain forward slashes (/) or colons (:).
    Optional Settings

    Click to expand additional optional settings:

    • optional parameters JSON input: Enter the Key-Value pair for problem records to retrieve. Use the {"Key": "Value"} or [{"Key": "Value"}] format. For example,

      {
      "relativeTime": "10mins",
      "startTimestamp": 1613999199686,
      "endTimestamp": 1613999199689,
      "status": "OPEN" ,
      "impactLevel": "APPLICATION" ,
      "severityLevel": "CUSTOM_ALERT " ,
      "tag": "tag=tag1&tag=tag2",
      "expandDetails": true
      }

    Important: Fields with a variable icon  support using  global variables project variables , and Jitterbit variables . Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  3. Click Next.

  4. Review the request and response data schemas.
    The data schemas list the fields available for the ALM Octane Create activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    For more information about transformations, see Transformations

  5. Click Finished.
    After a Dynatrace activity has been created, you can access the menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu .

From the operation settings, you can chain operations from the same or different workflows.

Dynatrace Get All Problem operation patterns

Dynatrace Get All Problems activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Transformation Pattern  (as the first or second source)

For more information about the validation patterns, see the  Operation Validity  page.

A typical workflow uses a Dynatrace Get All Problems activity in the Two-Transformation Pattern. In this example, the first transformation (Dynatrace Get All Problems Request) creates a request structure that is passed to the Dynatrace Get All Problems activity. The second transformation (Dynatrace Get All Problems Response) receives the response structure, which is then written to a variable by a Variable Write activity (Dynatrace Get All Problems Write) and a message is then logged by the Write to Operations Log script:

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs

To configure a Dynatrace Get Problem Notification activity

A Dynatrace Get Problem Notification activity places data to get a problem notification in a Dynatrace endpoint and is intended to be used as a target to consume data in an operation. After configuring a Dynatrace connection, you can configure as many Dynatrace activities as you like for each Dynatrace connection.

To configure a Dynatrace Get Problem Notification activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity block.

  2. On the configuration screen, enter a name and specify the activity settings. 

    Field name

    Action

    Name

    Enter a name to identify the Dynatrace Get Problem Notification activity. The name must be unique for each Dynatrace Get Problem Notification activity and must not contain forward slashes (/) or colons (:).

    Notification ID

    Enter the notification ID or select the variable for the problem event for which you want notifications.

  3. Click Next.

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the Get Problem Notification activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more. 
    For more information about transformations, see  Transformations .

  5. Click Finished.
    After a Dynatrace activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu .

From the operation settings, you can chain operations from the same or different workflows.

Dynatrace Get Problem Notification operation patterns

Dynatrace Get Problem Notification activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Transformation Pattern

For more information about the validation patterns, see the Operation Validity page.

A typical use case is to use a Dynatrace Get Problem Notification activity in the Two-Transformation Pattern. In this example, the first transformation (Dynatrace Get Problem Notification Request) creates a request structure that is passed to the Dynatrace Get Problem Notification activity. The second transformation (Dynatrace Get Problem Notification Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Dynatrace Get Problem Notification Response) and a message is then logged by the Write to Operation Log script:



Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the  operation logs .

To configure a Dynatrace Update Problem Notification activity

A Dynatrace Update Problem Notification activity places data to update a BMC Helix ITSM ticket ID in a problem notification in a Dynatrace endpoint and is intended to be used as a target to consume data in an operation. After configuring a Dynatrace connection, you can configure as many Dynatrace activities as you like for each Dynatrace connection.

To configure a Dynatrace Update Problem Notification activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity block.

  2. On the configuration screen, enter a name and specify the activity settings. 

    Field name

    Action

    Name

    Enter a name to identify the Dynatrace Update Problem Notification activity.

    The name must be unique for each Dynatrace Close Problem activity and must not contain forward slashes (/) or colons (:).

    Notification ID

    Enter the notification ID or select a variable for the problem event for which you want update notifications.

  3. Click Next.

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the Update Problem Notification activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more. 
    For more information about transformations, see  Transformations .

  5. Click Finished.
    After a Dynatrace activity has been created, you can access menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu .

From the operation settings, you can chain operations from the same or different workflows.

Dynatrace Update Problem Notification operation patterns

Dynatrace Update Problem Notification activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Transformation Pattern
For more information about the validation patterns, see the Operation Validity  page.

A typical use case is to use a Dynatrace Update Problem Notification activity in the Two-Transformation Pattern. In this example, the first transformation (Dynatrace Update Problem Notification Request) creates a request structure that is passed to the Dynatrace Update Problem Notification activity. The second transformation (Dynatrace Update Problem Notification Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Dynatrace Update Problem Notification Response) and a message is then logged by the Write to Operation Log script:


Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the  operation logs .

To configure a Dynatrace Close Problem activity 

A Dynatrace Close Problem activity places data to close a problem record into the Dynatrace endpoint and is intended to be used as a target to consume data in an operation. After configuring a Dynatrace connection, you can configure as many Dynatrace activities as you like for each Dynatrace connection.

To configure a Dynatrace Close Problem activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity block.

  2. On the configuration screen, enter a name and specify the activity settings. 

    Field nameAction
    NameEnter a name to use to identify the Dynatrace Close Problem activity. The name must be unique for each Dynatrace Close Problem activity and must not contain forward slashes (/) or colons (:).
    Problem IDEnter the Problem ID or select the variable for the Problem ID to close.
    MessageEnter the comment to be added to the Problem record to close it. This field is mandatory.
  3. Click Next.

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the Dynatrace Close Problem activity. If the operation uses a transformation, the data schemas are displayed again during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    For more information about transformations, see Transformations .

  5. Click Finished.
    After a Dynatrace activity has been created, you can access the menu actions for that activity from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu .

From the operation settings, you can chain operations from the same or different workflows.

Dynatrace Close Problem operation patterns

Dynatrace Close Problem activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Transformation Pattern (as the first or second source)

For more information about the validation patterns, see the Operation Validity  page.

A typical workflow uses a Dynatrace Close Problem activity in the Two-Transformation Pattern. In this example, the first transformation (Dynatrace Close Problem Request) creates a request structure that is passed to the Dynatrace Close Problem activity. The second transformation (Dynatrace Close Problem Response) receives the response structure, which is then written to a variable by a Variable Write activity (Dynatrace Write Close Problem Response) and a message is then logged by the Write to Operations Log script:


Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs

Was this page helpful? Yes No Submitting... Thank you

Comments