hybrid only icon

Enabling the launch-in-context menu

You must enable the launch-in-context menu to start manual or semi-automated runbooks from events.

Before you begin

Note: This information only applies to a hybrid deployment of Netcool® Operations Insight® using the classic Event Viewer. For more information, see Installing on a hybrid architecture.

This page describes how to configure a launch-in-context menu to Runbook Automation deployed within Netcool Operations Insight on Red Hat OpenShift.

You must add Netcool_OMNIbus_Admin and Netcool_OMNIbus_User in groups/group roles under Access Criteria (step 1.i). If a user does not belong to these groups, they cannot access the Launch Runbook launch-in-context menu.

About this task

The launch-in-context (LiC) feature enables the display of the Execute Runbook page with the event context (runbook and parameters) if a trigger for the event has been matched. Enabling this feature provides the following functions in the event console:
  • The context menu of all events has an extra entry, named LaunchRunbook.
  • Click LaunchRunbook to:
    • Start the Runbook Automation application, by using the runbook ID and parameter mappings as defined in the matching trigger.
    • Display an alert with an error message, if no trigger is matched.
For more information about how to create a trigger, see Create a trigger.

Use the Netcool/OMNIbus Web GUI to create the launch-in-context menu.

Procedure

  1. Create a launch-in-context menu and a corresponding menu entry.
    1. Log on to Netcool/OMNIbus Web GUI as an administrator.
    2. Select Administration > Event Management Tools > Tool Configuration.
    3. Click the Create Tool icon to create a new tool.
    4. Set the Name field to LaunchRunbook.
    5. From the Type drop-down field, select Script.
    6. Make sure the data source, for example OMNIbus, is selected in the data source configuration.
    7. Enter the following syntax in the Script field:
      var runbookId = '{$selected_rows.RunbookID}'; 
      var runbookParams = '{$selected_rows.RunbookParametersB64}'; 
      runbookParams = encodeURIComponent(runbookParams); 
      if (runbookId == '' || runbookId == ' ' || runbookId == ', ' || runbookId == '0' || runbookId == 0) {
        alert('This event is not linked to a runbook'); 
      } else {
        var url = 'https://<NOI_HOST_NAME>/aiops/<YOUR_SUBSCRIPTION_ID>/automations/runbooks/library/run?runbookId=' + runbookId + '&bulk_params=' + runbookParams;
        var wnd = window.open(url, '_blank');
      }
      

      Where: <NOI_HOST_NAME> is your Netcool Operations Insight hostname.

      <YOUR_SUBSCRIPTION_ID> is your subscription ID.

    8. Ensure the Execute for each selected row checkbox is not selected, as only single events can be selected as the context for launching a runbook.
    9. Select the appropriate group roles in the Access Criteria section, that is Netcool_OMNIbus_Admin and Netcool_OMNIbus_User.
    10. Click Save.

      For more information about configuring launch-in-context support, see Configuring launch-in-context integrations with Tivoli® products.

  2. Complete the following steps to add the Runbook Automation entry to the launch-in-context menu of the Netcool/OMNIbus event list:
    1. Log on to Netcool/OMNIbus Web GUI as an administrator.
    2. Select Administration > Event Management Tools > Menu Configuration.
    3. Select Alerts > Modify. Netcool/OMNIbus Web GUI displays the Menus Editor dialog box.
    4. Select LaunchRunbook from the available items.
    5. Log on to Netcool/OMNIbus Web GUI as an administrator.
    6. Select the arrow to add LaunchRunbook to the Current Items list. You can optionally rename the menu entry name or add a space between Launch and Runbook.
    7. Click Save.
    Note: It might still be possible to launch a runbook for an event even if a trigger does not exist anymore. This can happen if an event had a runbook ID assigned because a matching filter existed when the event was created.