IBM Netcool/OMNIbus 8.1 Web GUI Event List: sending NodeClickedOn data using Netcool/Impact Licensed Materials Property of IBM
Note: Before using this information and the product it supports, read the information in Notices at the end of this document. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents About this publication...iv Intended audience... iv... 1 Worked example... 1 Check the connection to the IBM Netcool/Impact server... 2 Create an Impact policy: samplereturndatafromeventviewer... 3 Add a parameter to your policy... 4 Add an Event Viewer and a DASH Table widget to your page and add a wire... 6 Edit the Table widget and set the Impact policy as the dataset... 7 Test it out... 8 Trademarks... 11 Contents iii
About this publication The IBM Netcool/OMNIbus Web GUI Event list sends a JSON formatted string via the NodeClickedOn function. If you are integrating with an widget or other consumer that can not parse JSON formatted strings, you can use Netcool/Impact to pre-format the string into a format suitable for the target consumer. This document outlines how to do this using a worked example. Intended audience This publication is intended for Netcool solutions engineers who need to send the data from a NodeClickedOn Event List event to another widget or object. About this publication iv
Netcool/OMNIbus 8.1 Web GUI provides a choice of either an Active Event List (AEL) or the Java applet free Event Viewer to view events from the Netcool/OMNIbus ObjectServer. Among the many functions provided by these Event Lists is the ability to send the event data from a selected event to another widget or object. This is done via the NodeClickedOn object and the data is made available via a JSON formatted string containing the event data. The following is an example of a JSON formatted string generated by the NodeClickedOn function within a Web GUI Event List: product={"omnibuswebgui":{"displaycontext":{"filtername":"serial- 2792523","filterType":"user_transient","registerFilter":"true","forceOverwri te":"true","sql":"serial=2792523","viewname":"default","viewtype":"global"," datasource":"omnibus","fields":{"tooltip":"","backgroundcolor":"#ff0000","datasource":"omnibus","origin":"true","uri":"/providers/om NIbusWebGUI/datasets/eventData/items/2792523","background-colordarker":"#d90000","properties":"5,No,istpc101,Port to port Connect,The connection from host vio59501a port C9522410 to switch issanb384b (F819BB54) port 209 is missing. Alert ID = 18773 View Alert = https://istpc101.innovate.ibm.com:9569/layout.jsp?page=alerts View R,4/10/14 3:42:14 PM,4/14/14 10:53:34 AM,6,Problem,Not Set,Probe is running on isprb01.innovate.ibm,tpc 56 TPC-PORT-TO-PORT-CONNECTION- MISSI,2,792,523,,Nimbus_Infra,Public,Nobody,No,TPC Rules,4/14/14 10:53:34 AM","label":"","relatedItemsUri":"/providers/OMNIbusWebGUI/datasets/eventDat a/items/2792523/relateditems","foregroundcolor":"#000000","type":"eventdata","typelabel":"","id":"2792523","descripti on":"","severity":"5","acknowledged":"no","node":"istpc101","alertgroup":"po rt to port Connect","Summary":"The connection from host vio59501a port C9522410 to switch issanb384b (F819BB54) port 209 is missing. Alert ID = 18773 View Alert = https://istpc101.innovate.ibm.com:9569/layout.jsp?page=alerts View R","FirstOccurrence":"4/10/14 3:42:14 PM","LastOccurrence":"4/14/14 10:53:34 AM","Tally":"6","Type":"Problem","ExpireTime":"Not Set","Agent":"Probe is running on isprb01.innovate.ibm","manager":"tpc 56 TPC-PORT-TO-PORT- CONNECTION- MISSI","Serial":"2,792,523","NmosSerial":"","Location":"Nimbus_Infra","Owner GID":"Public","OwnerUID":"Nobody","Flash":"No","Class":"TPC Rules","StateChange":"4/14/14 10:53:34 AM"}}}} If the target widget or object is not capable of parsing and consuming JSON formatted strings however, then Netcool/Impact can be used to intercept the data, parse it, reformat it and present it to the widget in a format it can understand and use. Worked example This document contains the steps for doing so and provides a worked example. This section provides the steps to pre-format and send a NodeClickedOn JSON formatted string to a table widget. The key part of the solution is when the table widget receives the JSON data payload from the Event Viewer, it passes it off to Impact which then reformats it and returns it in a format that the table widget can consume: namely an array of name/value pairs. The following sections step through an example implementation of this. 1
Check the connection to the IBM Netcool/Impact server The first step in getting IBM Netcool/Impact to feed data to a DASH widget is to ensure the connection between DASH and Impact is correctly configured and operational. This is done by clicking on the "Connections" option under the "Console Settings" menu. The Connections dialogue box lists the connections that the DASH server has to. The connection to the IBM Netcool/Impact server should be shown in the list and the Status should be "Working" as in the following screen shot. 2
If this connection is not present, you will need to add a new connection to your IBM Netcool/Impact server. This can be done by clicking on the "Create new remote provider" button and entering the host/port details for the IBM Netcool/Impact server. If the connection is present but not working, it may be that the IBM Netcool/Impact server is down or that the host/port information is not correct. Create an Impact policy: samplereturndatafromeventviewer The next step is to create an Impact policy that will receive the JSON message, access the key pieces of information and put them into an array for consumption by the table widget. In this example, we will populate the first slot of the array (ie. arrayofobjects[0]) with a dummy value. We will then extract both the Node and Severity fields from the JSON message and store these in the second slot of the array (ie. arrayofobjects[1]). The policy looks as follows: // CREATE AN ARRAY FOR THE DASH WIDGET TO CONSUME var arrayofobjects = []; // CREATE A DUMMY VALUE AND ADD TO THE ARRAY obj1=newobject(); obj1.name="name"; obj1.status="major"; arrayofobjects[0]=obj1; // ENSURE JSON STRING IS DEFINED AND NOT NULL if (typeof product!= 'undefined' && product!= null) { // DRILL DOWN INTO JSON STRING TO GET TO THE EVENT FIELDS var result= Packages.com.ibm.json.java.JSONObject.parse(product); var records = result.get("omnibuswebgui"); var dc= records.get("displaycontext"); var fields = dc.get("fields"); // CREATE NEW OBJECT TO STORE THE TARGET DATA obj2 = NewObject(); // POPULATE Name AND Status FIELDS IN ARRAY FROM Node AND // Severity FIELDS FROM THE TARGET EVENT var mynode = fields.get("node"); var smynode = String(mynode); obj2.name=smynode; 3
var mysev = fields.get("severity"); var smysev = String(mysev); obj2.status = smysev; // STORE NEW OBJECT INTO ARRAY arrayofobjects[1] = obj2; // DELETE TEMPORARY VARIABLES delete result; delete records; delete dc; delete fields; delete mynode; delete smynode; delete mysev; delete smysev; } delete product; Add a parameter to your policy The next step is to add an output parameter to the Impact policy. This parameter will hold the array that we have constructed within the policy that will be passed back to the table widget that called the policy initially. To create an output parameter for the policy, click on the button "Configure Policy Settings" from within the policy editor as follows: Create a new output parameter - give it a label (eg. "EventViewerNodeClickedOn") and enter the array variable from your policy. Pay attention to this parameter name including the case of the characters as this will be needed in a later step. 4
The type of parameter to select is: "Array Of Impact Object" per the following screenshot: Click on "Ok" and then save and close your policy. 5
Add an Event Viewer and a DASH Table widget to your page and add a wire Next, create a new page, add both an Event Viewer widget and a Table widget, and then click on the "Show wires" button to display the wires dialogue panel: Create a new wire that sends "NodeClickedOn" from the Event Viewer to the Table widget per the following example: Close the wire configuration dialogue box and click "Save" to save your page. 6
Edit the Table widget and set the Impact policy as the dataset Next edit the Table widget and set the "Selected Dataset". When you search the available datasets, you should be able to find your policy (eg. "samplereturndatafromeventviewer") and the output parameter you created within the policy (eg. "EventViewerNodeClickedOn"). Select this dataset item and ensure that the "executepolicy" check box is enabled per the following screen shot: Click OK to save the table widget configuration and then "Save and Exit" your DASH page. 7
Test it out Now when you click on an event in the Event Viewer, the wire will send the NodeClickedOn to the table. The table is configured to send the data payload to Impact to the named policy and will pass the data to Impact within the "CurrentContext". The policy will then locate the JSON string located within the payload, unpack it, construct the array and then pass it back via the output parameter: EventViewerNodeClickedOn. The table widget will then take the output of the policy as its input to load. The resulting table will contain the dummy value from the policy (obj1) as the first entry as well as the clicked-on value (obj2) that it extracted from the JSON string, and include the fields Node and Severity in both cases. The following screen shot shows the result: 8
Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106-0032, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: About this publication 9
IBM Corporation 958/NH04 IBM Centre, St Leonards 601 Pacific Hwy St Leonards, NSW, 2069 Australia IBM Corporation 896471/H128B 76 Upper Ground London SE1 9PZ United Kingdom IBM Corporation JBF1/SOM1 294 Route 100 Somers, NY, 10589-0100 United States of America Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without notice. Dealer prices may vary. This information is for planning purposes only. The information herein is subject to change before the products described become available. About this publication 10
Trademarks This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. If you are viewing this information softcopy, the photographs and color illustrations may not appear. IBM, the IBM logo and ibm.com are trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at www.ibm.com/legal/copytrade.shtml. Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Adobe, Acrobat, Portable Document Format (PDF), PostScript, and all Adobe-based trademarks are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, or service names may be trademarks or service marks of others. About this publication 11