Opsgenie connector powered by Jitterbit

Opsgenie is an incident management platform included in all cloud plans of Jira Service Management. The BMC Helix iPaaS Opsgenie connector provides an interface for entering user-provided input such as credentials to create an authenticated Opsgenie connection. The connection provides the foundation to configure associated Opsgenie activities that interact with the connection as a source or target, within an operation. Together, a specific Opsgenie connection and its activities are referred to as an Opsgenie endpoint. You can create or update alerts by using the Opsgenie activities. 

Supported API versions and prerequisites

The Opsgenie connector uses the  Opsgenie REST API . Refer to the API documentation for information on the schema fields.

The Opsgenie 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 an Opsgenie connection

Configure the Opsgenie connection by using the Opsgenie connector to establish access to the Opsgenie endpoint. Once a connection is established, create operations that include connector 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. 

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

    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 Opsgenie connection. The name must be unique for each connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Opsgenie endpoint, which refers to both a specific connection and its activities.

    HostEnter the host URL of the Opsgenie instance.

    API KEY

    Enter API key generated for your integration in Opsgenie.

    For more information about generating API keys for integrations, see API Integration .

    Important

    If you click Delete while creating a new connection, an error is displayed. For more information, see  Component Dependencies, Deletion, and Removal

  4. After configuring the connection, you can configure one or more 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 an Opsgenie activity . For more information about operations, see  Operations .

To create an Opsgenie activity 

Add an Opsgenie activity to your operation to provide the configuration required place data into an Opsgenie endpoint, to be used as a target to consume data in an operation or source to provide data in an operation.

To create an Opsgenie activity, complete the following steps:

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

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

    Activity nameDescription
    Create AlertPlaces alert data into an Opsgenie endpoint and is intended to be used as a target in an operation.
    Update AlertPlaces alert data into an Opsgenie 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 an Opsgenie Create Alert activity 

An Opsgenie Create Alert activity creates a new alert in an Opsgenie endpoint and is intended to be used as a target to consume data in an operation. After configuring an Opsgenie connection, you can configure as many Opsgenie activities as you like for each Opsgenie connection.

To configure an Opsgenie Create Alert activity, complete the following steps:

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

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

    Field nameAction
    NameEnter a name to identify the Opsgenie Create Alert activity. The name must be unique for each Opsgenie Create Alert activity and must not contain forward slashes (/) or colons (:).
    Alert MessageEnter the message to be displayed in the alert. This is a mandatory field.
    Alert DescriptionEnter a short description for the alert.
    Alert PrioritySelect a priority for the alert. By default, priority is set to P3.


  3. Click Next.

  4. Review the request and response data schemas.
    The data schemas list the fields available for the Opsgenie Create Alert activity.
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more. 

    The Opsgenie connector uses the Opsgenie REST API . For more information about the schema fields, see the API documentation.

  5. Click Finished
    After an Opsgenie activity has been created, menu actions for the activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Opsgenie Create Alert activity operation patterns

The Create Alert activities can be used as a target with these operation patterns:

  • Transformation Pattern

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

Other patterns are not valid using Opsgenie Create Alert activities. For more information on the validation patterns, see the  Operation Validity  page.

A typical use case is to use an Opsgenie Create Alert activity in the Two-Transformation Pattern. In this example, the first transformation (Opsgenie  Create Alert Request) creates a request structure that is passed to the Opsgenie Create Alert activity. The second transformation (Opsgenie Create Alert Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Opsgenie Create Alert 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 an Opsgenie Update Alert activity 

An Opsgenie Update Alert activity updates alert data in an Opsgenie endpoint and is intended to be used as a target to consume data in an operation. After configuring an Opsgenie connection, you can configure as many Opsgenie activities as you like for each connection. 

To configure an Opsgenie Update Alert 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 identify the Opsgenie Update Alert activity. The name must be unique for each Opsgenie Update Alert activity and must not contain forward slashes (/) or colons (:).
    Select an action for the update

    This section displays the actions available in the Opsgenie endpoint. When reopening an existing activity configuration, only the selected action is displayed instead of reloading the entire action list. This list includes the following actions for the update:

    • Acknowledge Alert: Notify alert responders that alert has been seen and being worked on.

    • Close Alert: Close the alert.

    • Escalate Alert: Escalate alert to the next escalation rule via Escalate to Next action and process the next available escalation rule.

    • Snooze Alert: Stop alert notifications for an open alert for a define amount of time.
    • Un-Acknowledge Alert: Reverted alert state back to open and not-acknowledged.

    • Update Field: Update the message, description, or priority of the alert. Add the updated values in the transformation element of the operation that includes the Update Alert activity.

    Important: You must have a standard version of Opsgenie for the Escalate and Snooze actions.

    • Selected Action: Lists the selected action.

      • Search: Enter a part of the action name to filter the list. The search is not case-sensitive. If the alert action is already displayed within the table, the results are filtered in real time with each keystroke. To reload alert actions from the endpoint for the search, enter the search criteria and then click refresh.

      • Refresh: Click the refresh icon  or the word Refresh to reload the alert actions from the Opsgenie endpoint. This may be useful if you have recently added an alert action to the Opsgenie endpoint. This action refreshes all the metadata used to build the action table for the organization displayed in the configuration.

      • Selecting an action for the update: Within the table, click on a row to select the update action. You can select only one action. The information available for each action for an organization is fetched from the Opsgenie endpoint:

        • Action: The name of action.
        • Description: Short description or ID of the action.
    Important: If the table does not populate with available actions defined for the organization configured, the Opsgenie connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.


  3. Click Next

  4. Review the request and response data schemas. 
    The data schemas list the field available for the Opsgenie Update Alert activity.
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    The Opsgenie connector uses the Opsgenie REST API . For more information about the schema fields, see the API documentation.

  5. Click Finished
    After an Opsgenie activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu .

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Opsgenie Update Alert activity operation patterns

Opsgenie Update Alert activities can be used as a target with these operation patterns:

  • Transformation Pattern

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

Other patterns are not valid using Opsgenie Update Alert activities. For more information on the validation patterns, see the  Operation Validity  page.

A typical use case is to use an Opsgenie Update Alert activity in the Two-Transformation Pattern. In this example, the first transformation (Opsgenie Update Alert Request) creates a request structure that is passed to the Opsgenie Update Alert activity. The second transformation (Opsgenie Update Alert Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Opsgenie Update Alert 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

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

Comments