TrueSight Operations Management connector powered by Jitterbit

The BMC Helix iPaaS TrueSight Operations Management connector provides an interface for entering user-provided input such as credentials to create an authenticated TrueSight Operations Management connection. Use the connector to configure associated TrueSight Operations Management activities that interact with the connection as a source or target within an operation. You can use the connector activities to create, get, update, and search events. Together, a specific TrueSight Operations Management connection and its activities are referred to as a TrueSight Operations Management endpoint. You can use the TrueSight Operations Management connector to easily integrate Helix ITSM and TrueSight Operations Management to sync tickets and problems.

The connector supports TrueSight Operations Management version 11.3.04 or later.

Supported API versions and prerequisites

The TrueSight Operations Management connector uses the  TrueSight Operations Management API v11.3.04 . For more information about the schema fields, see the API documentation.

The TrueSight Operations Management 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 TrueSight Operations Management connection

Configure the TrueSight Operations Management connection by using the TrueSight Operations Management connector. After a connection is established with the TrueSight Operations Management endpoint, you can configure one or more TrueSight Operations Management 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 TrueSight Operations Management 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 TrueSight Operations Management connection, use the Show list to filter on Connectors, and then click the TrueSight Operations Management connector block.
    • To configure an existing TrueSight Operations Management connection, use the Show list to filter on Endpoints, and then double-click the TrueSight Operations Management connector block.
  3. On the configuration screen for the TrueSight Operations Management 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 TrueSight Operations Management connection. The name must be unique for each TrueSight Operations Management connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the TrueSight Operations Management endpoint, which refers to both a specific connection and its activities.

    TSOM TSPS HOST URL

    Enter the URL of your TrueSight Operations Management - TrueSight Presentation Server (TSPS) instance.

    TSOM TSIM HOST URLEnter the URL of your TrueSight Operations Management - TrueSight Infrastructure Management (TSIM) instance.

    User Name

    Enter the user name to log in to TrueSight Operations Management.

    PasswordEnter the password for the user to log in to TrueSight Operations Management.
    Tenant Name/IDEnter the tenant ID for TrueSight Operations Management.


    Important

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

  4. Click Save Changes
    After configuring a TrueSight Operations Management connection, you can configure one or more TrueSight Operations Management activities associated with that connection. For more information about creating an activity, see
    Creating a TrueSight Operations Management activity.

To create a TrueSight Operations Management 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 TrueSight Operations Management connection block to display activities that are available to be used with a TrueSight Operations Management connection.

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

    Create EventsInserts data for a new event into a TrueSight Operations Management endpoint and is intended to be used as a target in an operation.
    Update EventsInserts event update data into a TrueSight Operations Management endpoint and is intended to be used as a target in an operation.
    Get EventsRetrieves event data from a TrueSight Operations Management endpoint and is intended to be used as a source in an operation.
    Search EventsSearches for event data from a TrueSight Operations Management endpoint and is intended to be used as a source 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 TrueSight Operations Management Create Events activity 

A TrueSight Operations Management Create Events activity inserts data for a new event into a TrueSight Operations Management endpoint and is intended to be used as a target to consume data in an operation. After configuring a TrueSight Operations Management connection, you can configure as many TrueSight Operations Management activities as you like for each connection. 

To configure a TrueSight Operations Management Create Events 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 select the Event Class for the activity.

    Field nameAction
    Name

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

    Select an Event Class for the event

    This section displays event classes available in the TrueSight Operations Management endpoint.
    When reopening an existing activity configuration, only the selected event class is displayed instead of reloading the entire event class list.

    • Selected Event Class: After an event class is selected, it is listed here.
    • Search: Enter any part of the event class name into the search box to filter the list of event classes. The search is not case-sensitive. If event classes are already displayed within the table, the table results are filtered in real time with each keystroke. To reload event classes from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon  or the word Refresh to reload event classes from the TrueSight Operations Management endpoint. This may be useful if you have recently added event classes to TrueSight Operations Management. This action refreshes all metadata used to build the table of event classes displayed in the configuration.
    • Selected an Event Class: Within the table, click anywhere on a row to select an event class. Only one event class can be selected. The information available for each event class is fetched from the TrueSight Operations Management endpoint:
      • Name: The event class name from TrueSight Operations Management.
      • Type: The event class type from TrueSight Operations Management.

    Important: If the table does not populate with available event classes, the TrueSight Operations Management connection might not be successful. Make sure the TrueSight Operations Management connection is configured correctly by reopening the connection and retesting the credentials.



  3. Click Next.

  4. Enter the settings for the Create Events activity.

    Field name

    Action

    Event Message

    Enter the event message in the following format, date trapSendingAgent trapMessage.

    • Date: Date when Infrastructure Management trap was received. Time of the computer where HP OpenView is installed.
    • Trap Sending Agent: Infrastructure Management Remote Agent that raised the event because of which the trap was generated.
    • Trap Message: Event received on ProactiveNetAgentHostname Description: ProactiveNetEventDescription event URL: URLToOpenProactiveNetEventDetailsPage
    Routing ID

    URL of where the event should be created.

    This parameter is optional. If this parameter is not provided, the event is created on the TrueSight Infrastructure Management server (default cell) receiving the API request.

    • If you are using a TrueSight Infrastructure Management server, enter the hostname of that server.
    • If you are using a TrueSight Infrastructure Management cell, enter the URL of the remote cell, in the format:
      http://<serverName>/<TSIMHostNameCellName>/pncell_<TSIM_name>.
      For example, http://hostname.bmc.com/bppmws/pncell_clm-tsom
    Routing ID Type

    Infrastructure Management Server type.

    Valid values include:

    • SERVER_NAME: For TrueSight Infrastructure Management server
    • CELL_NAME: For TrueSight Infrastructure Management cell

    Event Severity

    Enter a severity level for the event.

    Valid values include:

    • INFO
    • OK
    • WARNING
    • CRITICAL
    • MAJOR
    • MINOR
    • UNKNOWN
    Additional fields for event creationClick Add to define additional event fields to be included in the event.
    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,

      {

      "EventType" : "CUSTOM",

      "msg" : "Application Server CPU usage:reached threshold=40",

      }

    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.



     

  5. Click Next.

  6. Review the request and response data schemas.
    The data schemas list the fields available for the TrueSight Operations Management Create Events 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 TrueSight Operations Management connector uses the  TrueSight Operations Management API v11.3.04 . For more information about the schema fields, see the API documentation.
     

  7. Click Finished
    After a TrueSight Operations Management 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 .

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.

TrueSight Operations Management Create Events activity operation patterns

TrueSight Operations Management Create Events 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 by using TrueSight Operations Management Create Events activities. For more information about the validation patterns, see the  Operation Validity  page.

A typical workflow uses a TrueSight Operations Management Create Events activity in the Two-Transformation Pattern. In this example, the first transformation (TrueSight Operations Management Create Events Request) creates a request structure that is passed to the TrueSight Operations Management Create Events activity. The second transformation (TrueSight Operations Management Create Events Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write TrueSight Operations Management Create Events 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 the workflows are ready, deploy and run the operation and validate behavior by checking the  operation logs

To configure a TrueSight Operations Management Update Events activity 

A TrueSight Operations Management Update Events activity inserts event update data into a TrueSight Operations Management endpoint and is intended to be used as a target to consume data in an operation. After configuring a TrueSight Operations Management connection, you can configure as many TrueSight Operations Management activities as you like for each TrueSight Operations Management connection. 

To configure a TrueSight Operations Management Update Events 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 event class for the activity.

    Field nameAction
    NameEnter a name to use to identify the TrueSight Operations Management Update Events activity. The name must be unique for each TrueSight Operations Management Update Events activity and must not contain forward slashes (/) or colons (:).
    Select an Event Class for the event

    This section displays event classes available in the TrueSight Operations Management endpoint.
    When reopening an existing activity configuration, only the selected event class is displayed instead of reloading the entire event class list.

    • Selected Event Class: After an event class is selected, it is listed here.
    • Search: Enter any part of the event class name into the search box to filter the list of event classes. The search is not case-sensitive. If event classes are already displayed within the table, the table results are filtered in real time with each keystroke. To reload event classes from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon  or the word Refresh to reload event classes from the TrueSight Operations Management endpoint. This may be useful if you have recently added event classes to TrueSight Operations Management. This action refreshes all metadata used to build the table of event classes displayed in the configuration.
    • Selected an event Class: Within the table, click anywhere on a row to select an event class. Only one event class can be selected. The information available for each event class is fetched from the TrueSight Operations Management endpoint:
      • Name: The event class name from TrueSight Operations Management.
      • Type: The event class type from TrueSight Operations Management.

    Important: If the table does not populate with available event classes, the TrueSight Operations Management connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  3. Click Next

  4. Enter the settings for the activity. 

    Field nameAction
    MC UEID

    Unique ID of the event that you want to update.

    For example, ty5sq9.2062fba9.0

    Event Message

    Enter the event message in the following format, date trapSendingAgent trapMessage.

    • Date: Time when Infrastructure Management trap was received. Time of the computer where HP OpenView is installed.
    • Trap Sending Agent: Infrastructure Management Remote Agent that raised the event because of which the trap was generated.
    • Trap Message: Event received on ProactiveNetAgentHostname Description: ProactiveNetEventDescription event URL: URLToOpenProactiveNetEventDetailsPage
    Routing ID

    URL of where the event should be created.

    This parameter is optional. If this parameter is not provided, the event is created on the TrueSight Infrastructure Management server (default cell) receiving the API request.

    • If you are using a TrueSight Infrastructure Management server, enter the hostname of that server.
    • If you are using a TrueSight Infrastructure Management cell, enter the URL of the remote cell, in the format:
      http://<serverName>/<TSIMHostNameCellName>/pncell_<TSIM_name>.
      For example, http://hostname.bmc.com/bppmws/pncell_clm-tsom
    Routing ID Type

    Infrastructure Management Server type.

    Valid values include:

    • SERVER_NAME: For TrueSight Infrastructure Management server
    • CELL_NAME: For TrueSight Infrastructure Management cell
    Event Severity

    Enter a severity level for the event.

    Valid values include:

    • INFO
    • OK
    • WARNING
    • CRITICAL
    • MAJOR
    • MINOR
    • UNKNOWN
    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.

    {
    "mc_priority": "PRIORITY_5",
    "mc_host": "clm-xyz-ty567q9"
    }

    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.




  5. Click Next

  6. Review the request and response data schemas. 
    The data schemas list the fields available for the TrueSight Operations Management Update Events 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 TrueSight Operations Management connector uses the  TrueSight Operations Management API v11.3.04 . For more information about the schema fields, see the API documentation.

  7. Click Finished
    After a TrueSight Operations Management 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 .

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.

TrueSight Operations Management Update Events activity operation patterns

TrueSight Operations Management Update Events 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 by using TrueSight Operations Management Update Events activities. For more information about the validation patterns, see the  Operation Validity  page.

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

Important

If you add field values in the connector activity and the transformation, values defined in the transformation take precedence over the values defined in the activity configuration.

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

To configure a TrueSight Operations Management Get Events activity 

A TrueSight Operations Management Get Events activity retrieves event data from a TrueSight Operations Management endpoint and is intended to be used as a source to consume data in an operation. After configuring a TrueSight Operations Management connection, you can configure as many TrueSight Operations Management activities as you like for each TrueSight Operations Management connection.

To configure a TrueSight Operations Management Get Events 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 TrueSight Operations Management Get Event activity. The name must be unique for each TrueSight Operations Management Get Events activity and must not contain forward slashes (/) or colons (:).
    Event ID

    Enter the ID of the event you want to retrieve.

    Select a Class

    This section displays event classes available in the TrueSight Operations Management endpoint.
    When reopening an existing activity configuration, only the selected event class is displayed instead of reloading the entire event class list.

    • Selected Event Class: After an event class is selected, it is listed here.
    • Search: Enter any part of the event class name into the search box to filter the list of event classes. The search is not case-sensitive. If event classes are already displayed within the table, the table results are filtered in real time with each keystroke. To reload event classes from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon  or the word Refresh to reload event classes from the TrueSight Operations Management endpoint. This may be useful if you have recently added event classes to TrueSight Operations Management. This action refreshes all metadata used to build the table of event classes displayed in the configuration.
    • Selected an event Class: Within the table, click anywhere on a row to select an event class. Only one event class can be selected. The information available for each event class is fetched from the TrueSight Operations Management endpoint:
      • Name: The event class name from TrueSight Operations Management.
      • Type: The event class type from TrueSight Operations Management.

    Important: If the table does not populate with available event classes, the TrueSight Operations Management 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 fields available for the TrueSight Operations Management Get Events 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 TrueSight Operations Management connector uses the  TrueSight Operations Management API v11.3.04 . For more information about the schema fields, see the API documentation.

  5. Click Finished.
    After a TrueSight Operations Management 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 .

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.

TrueSight Operations Management Get Events activity operation patterns

TrueSight Operations Management Get Events 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 by using TrueSight Operations Management Get Events activities. For more information about the validation patterns, see the  Operation Validity  page.

A typical workflow uses a TrueSight Operations Management Get Events activity in the Two-Transformation Pattern. In this example, the first transformation (TrueSight Operations Management Get Events Request) creates a request structure that is passed to the TrueSight Operations Management Get Events activity. The second transformation (TrueSight Operations Management Get Events Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write TrueSight Operations Management Get Events 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.

Important

If you add field values in the connector activity and the transformation, values defined in the transformation take precedence over the values defined in the activity configuration.

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

To configure a TrueSight Operations Management Search Events activity 

A TrueSight Operations Management Search Events activity searches for event data from a TrueSight Operations Management endpoint and is intended to be used as a source to consume data in an operation. After configuring a TrueSight Operations Management connection, you can configure as many TrueSight Operations Management activities as you like for each TrueSight Operations Management connection.

To configure a TrueSight Operations Management Search Events 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 TrueSight Operations Management Search Events activity. The name must be unique for each TrueSight Operations Management Search Events activity and must not contain forward slashes (/) or colons (:).
    SeverityEnter the severity of the events to search for.

    Valid values include:

    • INFO
    • OK
    • WARNING
    • CRITICAL
    • MAJOR
    • MINOR
    • UNKNOWN
    Status

    Enter the status of the events to search for.

    Valid values include:

    • OPEN
    • ACK
    • ASSIGNED
    • BLACKOUT
    • CLOSED
    MessageEnter the message included in the events to search for. Use the format date trapSendingAgent trapMessage, where:
    • Date: Time when Infrastructure Management trap was received. Time of the computer where HP OpenView is installed.
    • Trap Sending Agent: Infrastructure Management Remote Agent that raised the event because of which the trap was generated.
    • Trap Message: Event received on ProactiveNetAgentHostname Description: ProactiveNetEventDescription event URL: URLToOpenProactiveNetEventDetailsPage
    Select a Class

    This section displays event classes available in the TrueSight Operations Management endpoint.
    When reopening an existing activity configuration, only the selected event class is displayed instead of reloading the entire event class list.

    • Selected Event Class: After an event class is selected, it is listed here.
    • Search: Enter any part of the event class name into the search box to filter the list of event classes. The search is not case-sensitive. If event classes are already displayed within the table, the table results are filtered in real time with each keystroke. To reload event classes from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon  or the word Refresh to reload event classes from the TrueSight Operations Management endpoint. This may be useful if you have recently added event classes to TrueSight Operations Management. This action refreshes all metadata used to build the table of event classes displayed in the configuration.
    • Selected an Event Class: Within the table, click anywhere on a row to select an event class. Only one event class can be selected. The information available for each event class is fetched from the TrueSight Operations Management endpoint:
      • Name: The event class name from TrueSight Operations Management.
      • Type: The event class type from TrueSight Operations Management.

    Important: If the table does not populate with available event classes, the TrueSight Operations Management connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

    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.
      {
      "totalResultCount":"5",
      "startIndex":"1",
      "slotList":[
      "mc_ueid",
      "msg",
      "severity",
      "status",
      "CLASS"
      ],
      "className":"EVENT"
      }

    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 TrueSight Operations Management Search Events 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 TrueSight Operations Management connector uses the  TrueSight Operations Management API v11.3.04 . For more information about the schema fields, see the API documentation.

  5. Click Finished.
    After a TrueSight Operations Management 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 .

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.

TrueSight Operations Management Search Events activity operation patterns

TrueSight Operations Management Search Events 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 by using TrueSight Operations Management Search Events activities. For more information about the validation patterns, see the  Operation Validity  page.

A typical workflow uses a TrueSight Operations Management Search Events activity in the Two-Transformation Pattern. In this example, the first transformation (TrueSight Operations Management Search Events Request) creates a request structure that is passed to the TrueSight Operations Management Search Events activity. The second transformation (TrueSight Operations Management Search Events Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write TrueSight Operations Management Search Events 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.


Important

If you add field values in the connector activity and the transformation, values defined in the transformation take precedence over the values defined in the activity configuration.

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