IBM Tivoli Business Service Manager:

IBM Tivoli Business Service Manager: Launching Event Displays with Dashboard Widgets David Schmidt Customer Solutions Integration Architect, Business Services Management Phil Riedel Tivoli Service Availability and Performance Management Integration Solution Test Team Copyright International Business Machines Corporation 2011. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. i

CONTENTS List of figures... iii 1 Introduction... 1 2 The finished dashboard... 1 3 Configuration overview... 4 3.1 Creating and identifying custom AEL pages... 4 3.2 Identifying service instances... 6 3.3 Backing up and editing TBSM files... 8 3.3.1 Editing the canvasopenurlactions.xml file... 9 3.3.2 Editing the ViewDefinition_CustomView.xml file... 10 3.4 Activating Configuration Changes... 12 4 Conclusion... 12 5 Notices... 12 5.1 Trademarks... 15 ii

LIST OF FIGURES Figure 1: Example dashboard showing two widgets... 2 Figure 2: AEL resulting from a single-click on Service1 widget... 3 Figure 3: AEL resulting from a single-click on Service2 widget... 4 Figure 4: Creating a new AEL portlet page... 5 Figure 5: Name the AEL portlet page, and copy the Page unique name... 6 Figure 6: Service instance identification... 7 Figure 7: Service name and template identification... 8 iii

1 Introduction Normally, a widget, an indicator that graphically represents the status of a business service on an IBM Tivoli Business Service Manager (TBSM) dashboard, is the collection point of events that affect its status. Finding the events that resulted in its current status is as easy as a right-click to display service effecting events on an Active Event List (AEL) display. However, if you are structuring your dashboard differently, for example, using a custom canvas for your dashboard and widgets that derive their status in more complex ways by querying for a particular set of events, displaying those events can be more difficult to do. Potential solutions include adding items to the right-click menu to display custom AEL pages and modifying single- or double-click behaviors to do the same. This paper explores modifying the single-click behavior of dashboard widgets on a custom canvas dashboard to automatically display an AEL page to view the events that make up the status of the widget. 2 The finished dashboard The goal is to have a dashboard that is populated with widgets that represent the status of business services. These widgets derive their status, or gauge positions, as function of a count of events, a count that can be a complex query of the IBM Tivoli Netcool /OMNIbus ObjectServer. Take, for example, the following dashboard with two service instance widgets represented on it: 1

Figure 1: Example dashboard showing two widgets The configuration work that is detailed in this paper shows how to enable a single-click action to display an AEL window with a custom query for each dashboard widget. For example, if you click the Service1 widget, an AEL with a customizable query is displayed. 2

Figure 2: AEL resulting from a single-click on Service1 widget And, if you click the Service2 widget, an AEL with its own unique customizable query is displayed. 3

Figure 3: AEL resulting from a single-click on Service2 widget The event counts in the AEL windows do not directly correlate to the counts that are displayed by the widgets because they are placeholder examples. They are simply enabling navigation. 3 Configuration overview The following basic steps are required to enable this navigation: Create or reuse custom AEL pages as the targets of widget navigation View and record the AEL Page name and Page unique name as indicated by the properties of the AEL View and record the names of the services and template names Back up and edit two TBSM configuration files Reinitialize the TBSM dashboard canvas process Each of these steps is presented in more detail. 3.1 Creating and identifying custom AEL pages First, you either create or reuse custom AEL pages. To create a new page, do the following steps: 1. From the TBSM console, click Settings > Page Management. 2. Click the New Page button and select Active Event List (AEL) as the portlet. 4

Figure 4: Creating a new AEL portlet page 3. Click OK and Save. You can now name the page and copy its Page unique name. 5

Figure 5: Name the AEL portlet page, and copy the Page unique name Do the same for your two AEL pages. Either create them or view their configuration, copying and saving the Page unique name from each for use later. 3.2 Identifying service instances Do the following steps: 1. In the TBSM console, expand Administration and click Service Configuration. 2. Select Services from the menu. You probably have a list of services that you already defined. Consider two from that list, named Service1 and Service2. 6

Figure 6: Service instance identification 3. To view their configuration, click Service1 and then Service2. Take note of their names and templates for later. 7

Figure 7: Service name and template identification 3.3 Backing up and editing TBSM files You now back up two configuration files and use a text editor to modify them. Both of these files are located on the TBSM/TIP Dashboard server. On a Linux system, they are in this file path by default: /opt/ibm/tivoli/tip/profiles/tbsmprofile/installedapps/tbsmcell/tbsm.ear/ sla.war/av/xmlconfig The two files you edit are named as follows: canvasopenurlactions.xml ViewDefinition_CustomView.xml Make a copy of each file before you continue, for example, by using the cp command: cp canvasopenurlactions.xml canvasopenurlactions.xml.bak 8

cp ViewDefinition_CustomView.xml ViewDefinition_CustomView.xml.bak 3.3.1 Editing the canvasopenurlactions.xml file To edit this file, do these steps: 1. Edit the canvasopenurlactions.xml file. Look for the section that starts with <openurlaction description="show service affecting events in an AEL." and ends with </openurlaction>. 2. Make two new copies of the entire section. For a short amount of time, you have three copies in the same file. You modify two of them. Within the new sections, make the changes that are indicated in blue text: <openurlaction description="show service affecting events in an AEL." displayname="this will Launch From Mapper 1." enabledisableexpression="" name="launchfrommapper1" permissioncheckerclassname="com.micromuse.sla.map.avcheckradinstancepermi ssionsimpl" rolerequired="ncw_user" visibleingui="true" target="javascript:new parent.tbsm_executecmsaction( URL );"> { "portletpageid": "com.ibm.isclite.admin.portletpicker.navigationelement.pagelayouta.modifi ed.1305820972341", "sendtoself": "false", "portletnamespace": " portletnamespace ", "iscnamespace": " iscnamespace ", "launchtype": "PORTAL_PAGE", "isael": "true", "parameters": [ { "name": "item_entityname", "value": " replace(webtopentityname,''+null,'schmidt') "}, { "name": "item_viewname", "value": " replace(webtopviewname,''+null,'rawevents') "}, { "name": "RADEntityName", "value": " entityname "}, { "name": "switchpage", "value": "true"}, { "name": "RADEventFilterType", "value": "RawEvents"} ] } </openurlaction> <openurlaction description="show service affecting events in an AEL." displayname="this will Launch From Mapper 2." enabledisableexpression="" name="launchfrommapper2" permissioncheckerclassname="com.micromuse.sla.map.avcheckradinstancepermi ssionsimpl" rolerequired="ncw_user" visibleingui="true" target="javascript:new parent.tbsm_executecmsaction( URL );"> { "portletpageid": "com.ibm.isclite.admin.portletpicker.navigationelement.pagelayouta.modifi ed.1305821142635", "sendtoself": "false", "portletnamespace": " portletnamespace ", "iscnamespace": " iscnamespace ", "launchtype": "PORTAL_PAGE", "isael": "true", 9

"parameters": [ { "name": "item_entityname", "value": " replace(webtopentityname,''+null,'schmidt') "}, { "name": "item_viewname", "value": " replace(webtopviewname,''+null,'rawevents') "}, { "name": "RADEntityName", "value": " entityname "}, { "name": "switchpage", "value": "true"}, { "name": "RADEventFilterType", "value": "RawEvents"} ] } </openurlaction> Pay attention to the following things in this file: The names LaunchFromMapper1 and LaunchFromMapper2 are used in the other configuration file modifications. The portletpageid values are the same ones that you copied from the AEL portlet page unique names. When opened, these AELs are created with the filter identified by the item_entityname value of replace(webtopentityname,''+null,'xxx') }. You can create your own filters in the AEL, and replace the name 'XXX' with whatever your filters are called. 3.3.2 Editing the ViewDefinition_CustomView.xml file To edit this file, do these steps: Edit the ViewDefinition_CustomView.xml file. Look for the section that starts with <templatemapping primarytemplatename = "DefaultTag"> and ends with </templatemapping>. Make two new copies of the entire section. For a short amount of time, you have three copies in the same file. You modify two of them. Within the new sections, make the changes that are indicated in blue text: <templatemapping primarytemplatename = "Mapper1"> <expandcollapsetemplate>false</expandcollapsetemplate> <expandcollapseinitiallytemplate>false</expandcollapseinitiallytemplate> <groupingfield>primarytagname</groupingfield> <groupinggraphlayout>tighttiledgrid</groupinggraphlayout> <groupinginitiallyexpanded>true</groupinginitiallyexpanded> <indicatormapping visualrepresentation = "RADPrototype"> </indicatormapping> clicktype = "~singleclicked" actionname = "LaunchFromMapper1"/> clicktype = "~doubleclicked" actionname = "InstantiateOneHopServiceMap"/> actionname = "ShowServiceInstanceEditor"/> 10

actionname = "InstantiateOneHopServiceMap"/> actionname = "ChooseChildrenTool"/> actionname = "ShowMemberTemplates"/> actionname = "ViewTools"/> actionname = "IntegrationTools"/> actionname = "MaintTools"/> </templatemapping> <templatemapping primarytemplatename = "Mapper2"> <expandcollapsetemplate>false</expandcollapsetemplate> <expandcollapseinitiallytemplate>false</expandcollapseinitiallytemplate> <groupingfield>primarytagname</groupingfield> <groupinggraphlayout>tighttiledgrid</groupinggraphlayout> <groupinginitiallyexpanded>true</groupinginitiallyexpanded> <indicatormapping visualrepresentation = "RADPrototype"> </indicatormapping> clicktype = "~singleclicked" actionname = "LaunchFromMapper2"/> clicktype = "~doubleclicked" actionname = "InstantiateOneHopServiceMap"/> actionname = "ShowServiceInstanceEditor"/> actionname = "InstantiateOneHopServiceMap"/> actionname = "ChooseChildrenTool"/> actionname = "ShowMemberTemplates"/> actionname = "ViewTools"/> actionname = "IntegrationTools"/> actionname = "MaintTools"/> </templatemapping> 11

Pay attention to the following things in this file: The names Mapper1 and Mapper2 are the names of the templates that the service instances have in their configurations. The LaunchFromMapper1 and LaunchFromMapper1 values are the same values that are named in the canvasopenurlactions.xml file. 3.4 Activating Configuration Changes After all the configuration work is complete, running the following command on the TBSM/TIP dashboard server activates the changes and enable the single-click navigation from service instance to AEL: /opt/ibm/tivoli/tbsm/bin/rad_reinitcanvas 4 Conclusion This paper outlined the configuration activities necessary to connect dashboard widgets to AEL pages (portlets) from custom dashboard canvases. Without this level of configuration, mouse-click events typically apply to all widgets in the same way. When you connect custom templates to these widgets, you can tie together unique actions to individual widgets. 5 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 give 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: 12

Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan, Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502 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 might 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 websites are provided for convenience only and do not in any manner serve as an endorsement of those websites. The materials at those websites are not part of the materials for this IBM product and use of those websites 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: IBM Corporation 2Z4A/101 11400 Burnet Road Austin, TX 78758 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases payment of a fee. 13

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 measurement 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. This information is for planning purposes only. The information herein is subject to change before the products described become available. 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. 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 IBM s application programming interfaces. Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows: 14

(your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights reserved. If you are viewing this information in softcopy form, the photographs and color illustrations might not be displayed. 5.1 Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered 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 Copyright and trademark information at www.ibm.com/legal/copytrade.shtml. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. 15