Skip to end of metadata
Go to start of metadata

Introduction

A BMC Helix Operations Management (BMC Helix Operations Management) Search Events activity finds an object at a BMC Helix Operations Management endpoint and is intended to be used as a source to provide data to an operation. After configuring a BMC Helix Operations Management connection, you can configure as many BMC Helix Operations Management activities as you like for each BMC Helix Operations Management connection.

Creating a BMC Helix Operations Management Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Use the Show dropdown to filter on Endpoints, and then click the BMC Helix Operations Management connection block to display activities that are available to be used with a BMC Helix Operations Management connection:

BMC Helix Operations Management activities

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.

Configuring a BMC Helix Operations Management Search Events Activity

Follow these steps to configure a BMC Helix Operations Management Search Events activity:

Step 1: Enter a Name and Specify Settings

BMC Helix Operations Management Search Events Activity Configuration Step 1

  • Name: Enter a name to identify the BMC Helix Operations Management Search Events activity. The name must be unique for each BMC Helix Operations Management Search Events activity and must not contain forward slashes (/) or colons (:).

  • Severity: Enter the severity criteria for which to search. Possible values include CRITICAL, MAJOR, MINOR, WARNING, INFO, OK, and UNKNOWN.

  • Status: Enter the status criteria for which to search. Possible values include OPEN, ACK, ASSIGNED, BLACKOUT, and CLOSED.

  • Message: Enter a part of the event message for which to search.

  • Maximum Number of Records to Process: Enter the maximum number of records to search.

  • Maximum Number of Records to be Fetched per Page: Enter the maximum number of records to display per page of the search results.

  • Select a Class: From within the table, select the event call for the events for which to search.

    • Selected Event Class: Lists the selected event class. The event class for the event name from BMC Helix Operations Management.

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

  • Optional Settings: Click to expand additional optional settings:

    • JSON input (This event definition overrides the prior selections): {"Key": "Value"} or [{"Key": "Value"}]. For example:

      "directFilterStatusCriteria": {
            "identifier": "status",
            "value": "OPEN",
            "operator": "WITHIN"
          },
          "directFilterSeverityCriteria": {
            "identifier": "severity",
            "value": "CRITICAL,INFO",
            "operator": "WITHIN"
          },
          "advanceFilter": {
            "filterConditions": [
              {
                "condition_operator": "AND",
                "slot_operator": "contains",
                "slot_value": "ms",
                "slot_name": "msg"
              }
            ],
            "eventClass": "EVENT"
          }
      
  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas

BMC Helix Operations Management Search Events Activity Configuration Step 2

  • Data Schema: The request and response data schemas for BMC Helix Operations Management are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The BMC Helix Operations Management connector uses the BMC Helix Operations Management REST API . Refer to the API documentation for information on the schema fields.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the BMC Helix Operations Management endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a BMC Helix Operations Management Search Events activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

After a BMC Helix Operations Management 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. See Activity Actions Menu for details.

BMC Helix Operations Management Search Events activities can be used as a source with these operation patterns:

Other patterns are not valid using BMC Helix Operations Management Search Events activities. See the validation patterns on the Operation Validity page.

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

BMC Helix Operations Management Search Events operation

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.

On This Page

Last updated:  Nov 05, 2020

  • No labels