Configuring an IBM Netcool/OMNIbus event tool for launch-in-context to RBA

To start manual or semi-automated runbooks from events that are listed in the Netcool/OMNIbus Event Viewer, you must enable the launch-in-context menu.

To use the launch-in-context tool, you must add it to the list of available Netcool/OMNIbus tools using the Tool Creation option within Netcool/OMNIbus Web GUI. You must then add the tool to the list of tools that appear on the pop-up menu in the Netcool/OMNIbus Event List using the Menu Configuration option within Netcool/OMNIbus Web GUI.

Launch-in-context is only available if you create a matching trigger. For more information about how to create a trigger, see Creating a trigger.

You must define different OMNIbus event tools depending on the installation topology, that is if you have a single Netcool/OMNIbus installation with both the event viewer and the RBA DASH integration installed, or two separate Netcool/OMNIbus installations. The following table outlines the differences between the tools. The sections below the table guide you through the tool creation.

Table 1. Installation topology and tool type
Installation topology	RBA DASH integration installed into the same Netcool/OMNIbus Web GUI server that is used as the OMNIbus event console	OMNIbus event console and RBA DASH integration installed into different Netcool/OMNIbus Web GUI servers
Browser tabs	One single browser-level tab for DASH, containing separate DASH-level tabs for the OMNIbus Event Viewer and for RBA.	Two browser-level tabs for two separate DASH instances, with the following characteristics: - One tab for the OMNIbus Event Viewer. - When you launch RBA from an event for the first time, a second DASH tab is added at the browser level displaying the login for DASH where the RBA DASH integration is installed. After login, you go directly to the Run runbook page. - When you launch RBA again from the DASH tab with the OMNIbus Event Viewer, the related runbook opens in the second RBA DASH tab.
Session life time	One single session timeout for both OMNIbus and RBA tabs. You might be prompted to re-authenticate for the single session. If re-authentication is not done, unfinished or unsaved work might be lost.	You might get prompted to re-authenticate for both DASH tabs independently. If re-authentication is not done, unfinished or unsaved work might be lost.

For information about supported characters in runbook parameters, see Supported characters for launch-in-context.

Create a launch-in-context tool configuration for a single Netcool/OMNIbus installation

To create a launch-in-context tool configuration, use the following steps:

Log on to Netcool/OMNIbus Web GUI as an administrator.
Navigate to Administration > Event Management Tools > Tool Configuration
Click Create Tool.
Set the Name field to LaunchRunbookPD.
From the Type drop-down field, select Script.
Make sure the data source, for example Netcool/OMNIbus, is selected in the data source configuration.

In the Script Commands field, enter the following JavaScript snippet:

var runbookId = '{$selected_rows.RunbookID}';

if (runbookId == '' || runbookId == ' ' || runbookId == ',' || runbookId == '0' || runbookId == 0) {
   alert("This event is not linked to a runbook");
}
else {
    var launchEvent = {
        name: 'http://ibm.com/isclite#launchPage',
        NavigationNode: 'ARBTaskLIC',
        switchPage: true,
        payload: {
             rbid: runbookId,
             bulk_params: '{$selected_rows.RunbookParametersB64}'
        }
    };
    {$param.portletNamespace}sendPortletEvent(launchEvent);
}

Note:

Do not add any comments to this script. All lines after a comment line will be ignored.
You can modify the alert message text This event is not linked to a runbook as required. For example, you can translate the message text to your preferred language.

Ensure the Execute for each selected row check box is not selected, since only single events can be selected as the context for launching a runbook.
Select the appropriate group roles in the Access Criteria field. For example, Netcool_OMNIbus_Admin and Netcool_OMNIbus_User.
Click Save.

Create a launch-in-context tool configuration for an environment with two Netcool/OMNIbus installations

To create a launch-in-context tool configuration for a setup with two Netcool/OMNIbus installations, complete the following steps:

Log on to the Netcool/OMNIbus Web GUI where the Event Viewer is configured.
Select Administration > Event Management Tools > Tool Configuration.
Click Create Tool icon to create a new tool.
Set the Name field to LaunchRunbookPD.
From the Type drop-down field, select Script.
Make sure the data source, for example OMNIbus, is selected in the data source configuration.

In the Script Commands field, enter the following JavaScript snippet:

var runbookId = '{$selected_rows.RunbookID}';
var runbookParams = '{$selected_rows.RunbookParametersB64}';
runbookParams = runbookParams.replace('=', '%3D');
runbookParams = encodeURIComponent(runbookParams);
if (runbookId == '' || runbookId == ' ' || runbookId == ',' || runbookId == '0' || runbookId == 0) {
   alert("This event is not linked to a runbook");
}
else {
    var url = 'https://<RBA_DASH_HOSTNAME>:<RBA_DASH_PORT>/ibm/action/launch?pageID=ARBTaskLIC&rbid=' + runbookId + '&bulk_params=' + runbookParams + '&ISC.NEWINSTANCE=false';

    var wnd = window.open(url, '_blank');
}

Where <RBA_DASH_HOSTNAME> is the fully qualified domain name of the Netcool/OMNIbus Web GUI server where the RBA DASH integration is installed.

Where <RBA_DASH_PORT> is the DASH port number of the Netcool/OMNIbus Web GUI server where the RBA DASH integration is installed (WebSphere Application Server port WC_defaulthost_secure, default port number: 16311).

Ensure the Execute for each selected row and Window for each selected row check boxes are not selected, since only single events can be selected as the context for launching a runbook.
Select the appropriate group roles in the Access Criteria section. For example, Netcool_OMNIbus_Admin and Netcool_OMNIbus_User.
Click Save.

If the Netcool/OMNIbus Web GUI server where the RBA DASH integration is installed is at a recent DASH fix pack level, you will have to white list the launch route. Use the following steps to complete this task:

Log on to the Netcool/OMNIbus Web GUI server where the RBA DASH integration is installed with a user ID that has the authority to administer DASH console settings.
Select Console Settings > Console Properties.
Search the property URIS_TO_AVOID_CSRF_CHECK.
1. If this property does not exist: this indicates that the DASH fix pack level does not yet support this property. Close the Console Properties view without changing any properties. If you experience problems while launching a runbook from an event (for example, you get redirected to the DASH login page even though single sign-on has been configured between the two WebSphere Application Servers that run the Netcool/OMNIbus Web GUI servers), then disable the referrer header in your browser, and try again.
2. If this property does exist: click the property name to open the property editor. Then, append the following JavaScript snippet to the existing property value:
```
;/ibm/action/launch;/ibm/console/navigation.do;/ibm/console/xLaunch.do
```
  If you experience problems while launching a runbook from an event, modify the URL in the JavaScript snippet by replacing /ibm/action/launch with /ibm/console/xLaunch.do, and try again.

Create a menu entry in the launch-in-context menu of the Netcool/OMNIbus event list

To add the tool to the list that appears on the pop-up menu in the Netcool/OMNIbus event list, use the following steps:

Log on to Netcool/OMNIbus Web GUI as an administrator.
Navigate to Administration > Event Management Tools > Menu Configuration.
Select Alerts > Modify
Netcool/OMNIbus Web GUI displays the Menus Editor dialog box.
Select LaunchRunbookPD from the available items.
Select the right-arrow button to add LaunchRunbookPD to the Current Items list. You can optionally rename the menu entry name. You can also rearrange the order of the menu items.
Click Save.

For more information, see CT_createmenuentry.html#topic_q53_mxm_h5.

Add Netcool roles to Runbook Automation user groups

Add some Netcool roles to the Runbook Automation user group ARBUserGroup to grant the users in that group access to the Netcool/OMNIbus Event Viewer and to the launch-in-context menu item for Runbook Automation:

Log on to Netcool/OMNIbus Web GUI as an administrator.
Navigate to Console Settings > Group roles.
Search for group ARBUserGroup and click the group name link.
On the Group Roles page, select the roles ncw_user and netcool_rw.
Click Save.

Repeat this procedure for each Runbook Automation user group that should have access to the Netcool/OMNIbus Event Viewer and the launch-in-context menu item for Runbook Automation.

Add the Runbook Automation console integration to your customized Netcool/OMNIbus DASH views

Allow users who are working with customized DASH views to use the Runbook Automation launch-in-context feature.

Log on to Netcool/OMNIbus Web GUI as an administrator.
Navigate to Console Settings > Views.
Select the view that needs to be configured for launch-in-context to Runbook Automation.
Expand the Console Integrations in This View section and click Add... to open the table of available console integrations. Search and select the console integration Runbook Automation and add it to the view.

Note: In addition use the WebSphere Application Server administrative console to ensure that all users who need to use the Runbook Automation user interface are members of the appropriate Runbook Automation user groups, as described in User groups and roles.