User s Guide. OMEGAMON XE for WebSphere MQ Integrator. Version 110 GC July 2002

Transcription

1 User s Guide OMEGAMON XE for WebSphere MQ Itegrator Versio 110 GC July 2002 Cadle Corporatio 201 North Douglas Street El Segudo, Califoria

2 Registered trademarks ad service marks of Cadle Corporatio: AF/OPERATOR, AF/PERFORMER, AF/REMOTE, Availability Commad Ceter, Cadle, Cadle Commad Ceter, Cadle Direct logo, Cadle Electroic Customer Support, Cadle logo, Cadle Maagemet Server, Cadle Maagemet Workstatio, Cadle Techologies, CL/CONFERENCE, CL/SUPERSESSION, CommadWatch, CadleNet Commad Ceter, CT, CT/Data Server, CT/DS, DELTAMON, eba, eba*servicemoitor, eba*servicenetwork, ebusiess Assurace, ebusiess Istitute, ETEWatch, ItelliWatch, ItelliWatch Piacle, MQSecure, MQView, OMEGACENTER, OMEGAMON, OMEGAMON/e, OMEGAMON II, OMEGAMON Moitorig Aget, OMEGAVIEW, OMEGAVIEW II, PQEdit, Solutios for Networked Applicatios, Solutios for Networked Busiesses, ad Trasplex. Trademarks ad service marks of Cadle Corporatio: Alert Adapter, Alert Adapter Plus, Alert Emitter, AMS, Amsys, AutoBridge, AUTOMATED FACILITIES, Availability Maagemet Systems, Cadle Alert, Cadle Busiess Parter Logo, Cadle Commad Ceter/SetielMaager, Cadle CommadPro, Cadle CIRCUIT, Cadle edelivery, CadleLight, CadleNet, CadleNet 2000, CadleNet ebp, CadleNet ebp Access, CadleNet ebp Admiistrator, CadleNet ebp Broker Access, CadleNet ebp Cofiguratio, CadleNet ebp Coector, CadleNet ebp File Trasfer, CadleNet ebp Host Coect, CadleNet ebp Object Access, CadleNet ebp Object Browser, CadleNet ebp Secure Access, CadleNet ebp Service Directory, CadleNet ebp Uiversal Coector, CadleNet ebp Workflow Access, CadleNet ebusiess Assurace, CadleNet ebusiess Exchage, CadleNet ebusiess Platform, CadleNet ebusiess Platform Admiistrator, CadleNet ebusiess Platform Coector, CadleNet ebusiess Platform Coectors, CadleNet ebusiess Platform Powered by Roma Techology, CadleNet ebusiess Platform Service Directory, CadleNet Portal, CCC, CCP, CEBA, CECS, CICAT, CL/ENGINE, CL/GATEWAY, CL/TECHNOLOGY, CMS, CMW, Commad & Cotrol, Coect-Notes, Coect-Two, CSA ANALYZER, CT/ALS, CT/Applicatio Logic Services, CT/DCS, CT/Distributed Computig Services, CT/Egie, CT/Implemetatio Services, CT/IX, CT/Workbech, CT/Workstatio Server, CT/WS,!DB Logo,!DB/DASD,!DB/EXPLAIN,!DB/MIGRATOR,!DB/QUICKCHANGE,!DB/QUICKCOMPARE,!DB/SMU,!DB/Tools,!DB/WORKBENCH, Desig Network, DEXAN, e2e, ebaa, ebaauditor, eban, ebanetwork, ebaapractice, ebp, ebusiess Assurace Network, ebusiess at the speed of light, ebusiess at the speed of light logo, ebusiess Exchage, ebusiess Istitute, ebx, Ed-to-Ed, ENTERPRISE, Eterprise Cadle Commad Ceter, Eterprise Cadle Maagemet Workstatio, Eterprise Reporter Plus, EPILOG, ER+, ERPNet, ESRA, ETEWatch Customizer, HostBridge, IterFlow, Cadle IterFlow, Lava Cosole, MessageMate, Messagig Mastered, Milleium Maagemet Blueprit, MMNA, MQADMIN, MQEdit, MQEXPERT, MQMON, NBX, NetGlue, NetGlue Extra, NetMirror, NetScheduler, OMA, OMC Gateway, OMC Status Maager, OMEGACENTER Bridge, OMEGACENTER Gateway, OMEGACENTER Status Maager, OMEGAMON Maagemet Ceter, OSM, PC COMPANION, Performace Pac, PowerQ, PQCofiguratio, PQScope, Respose Time Network, Roma, Roma Applicatio Maager, Roma Broker, Roma BSP, Roma Coector, Roma Developer, Roma FS/A, Roma FS/Access, RomaNet, Roma Network, Roma Object Access, Roma Secure, Roma WF/Access, Roma Workflow Access, RTA, RTN, SetielMaager, Somerset, Somerset Systems, Status Moitor, The Milleium Alliace, The Milleium Alliace logo, The Milleium Maagemet Network Alliace, TMA2000, Tracer, Uified Directory Services, Volcao ad ZCopy. Trademarks ad registered trademarks of other compaies: AIX, DB2, MQSeries ad WebSphere are registered trademarks of Iteratioal Busiess Machies Corporatio. SAP is a registered trademark ad R/3 is a trademark of SAP AG. UNIX is a registered trademark i the U.S. ad other coutries, licesed exclusively through X/Ope Compay Ltd. HP-UX is a trademark of Hewlett-Packard Compay. SuOS is a trademark of Su Microsystems, Ic. All other compay ad product ames used herei are trademarks or registered trademarks of their respective compaies. Copyright July 2002, Cadle Corporatio, a Califoria corporatio. All rights reserved. Iteratioal rights secured. Threaded Eviromet for AS/400, Patet No. 5,504,898; Data Server with Data Probes Employig Predicate Tests i Rule Statemets (Evet Drive Samplig), Patet No. 5,615,359; MVS/ESA Message Trasport System Usig the XCF Couplig Facility, Patet No. 5,754,856; Itelliget Remote Aget for Computer Performace Moitorig, Patet No. 5,781,703; Data Server with Evet Drive Samplig, Patet No. 5,809,238; Threaded Eviromet for Computer Systems Without Native Threadig Support, Patet No. 5,835,763; Object Procedure Messagig Facility, Patet No. 5,848,234; Ed-to-Ed Respose Time Measuremet for Computer Programs, Patet No. 5,991,705; Commuicatios o a Network, Patet Pedig; Improved Message Queuig Based Network Computig Architecture, Patet Pedig; User Iterface for System Maagemet Applicatios, Patet Pedig. NOTICE: This documetatio is provided with RESTRICTED RIGHTS. Use, duplicatio, or disclosure by the Govermet is subject to restrictios set forth i the applicable licese agreemet ad/or the applicable govermet rights clause. This documetatio cotais cofidetial, proprietary iformatio of Cadle Corporatio that is licesed for your iteral use oly. Ay uauthorized use, duplicatio, or disclosure is ulawful. 2 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

3 Cotets Preface About This Book Adobe Portable Documet Format What s New I This Release Chapter 1. Itroductio What is OMEGAMON XE for WebSphere MQ Itegrator? Operatig Eviromet Chapter 2. Cofigurig OMEGAMON XE for WebSphere MQ Itegrator Authorizig the Aget Settig Aget Parameters Aget Performace Cosideratios Activatig the CadleMoitor Node Chapter 3. Usage Scearios Overview Usig the CadleMoitor Node Moitorig Applicatio Put ad Get Message Performace Determiig Applicatio Delivery Failure of Messages Debuggig a Message Flow Determiig Whe a Message Flow Has Failed Verifyig the Broker/Cotrol Ceter Cofiguratio Collectig Requested System Trace Data for a Broker o a Uavailable System Stoppig a Message Flow with a Full Output Queue Automatically Startig a Broker That Is Stopped Performig Broker Capacity Plaig Esurig Adequate Message Flow Respose Time Prevetig Iadvertet Use of Trace Active Startig ad Stoppig Message Flows at Periodic Itervals Cotets 3

4 User Not Receivig All Publicatios to Subscriptios User s Subscriptio to Topic Fails Security Chapter 4. Situatios ad Take Actio Commads Predefied Situatios Take Actio Commads Chapter 5. Workspaces Overview ACL Etries Workspace Aget Status Workspace (aget-level summary) Broker Evets Workspace Broker Iformatio Workspace Broker Statistics Workspace Broker Status Workspace (broker-level summary) Broker Summary Workspace (multiple brokers moitored) CadleMoitor Node Statistics Workspace Compoets Workspace Executio Group Iformatio Workspace Executio Group Statistics Workspace Message Flow Evets Workspace Message Flow Iformatio Workspace Message Flow Statistics Workspace Message Processig Node Attributes Workspace Message Processig Node Iformatio Workspace Message Processig Nodes Neighbors Workspace Product Evets Workspace Retaied Publicatios Workspace Subscriptios Workspace Appedix A. Guide to Cadle Customer Support Base Maiteace Pla Ehaced Support Services Customer Support Cotact Iformatio Idex OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

5 P Preface This guide explais the features ad reportig capabilities OMEGAMON XE for WebSphere MQ Itegrator. It icludes scearios to demostrate how this product ca be used to meet your site s eeds. Preface 5

6 About This Book About This Book Who should read this book This book is iteded for system admiistrators of WebSphere MQ Itegrator. It explais how you ca use OMEGAMON XE for WebSphere MQ Itegrator to help verify ad aalyze your message broker topologies. Where to look for more iformatio For more iformatio related to this product ad other related products, please see the techical documetatio CD-ROM that came with your product techical documetatio iformatio available o the Cadle Web site at olie help provided with this ad the other related products. Orderig additioal documetatio To order additioal product mauals, cotact your Cadle Customer Support represetative. We would like to hear from you Cadle welcomes your commets ad suggestios for chages or additios to the documetatio set. A user commet form, located at the back of each maual, provides simple istructios for commuicatig with the Cadle Iformatio Developmet departmet. You ca also sed to UserDoc@cadle.com. Please iclude "OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110" i the subject lie. 6 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

7 Adobe Portable Documet Format Adobe Portable Documet Format Pritig this book Cadle supplies documetatio i the Adobe Portable Documet Format (PDF). The Adobe Acrobat Reader will prit PDF documets with the fots, formattig, ad graphics i the origial documet. To prit a Cadle documet, do the followig: 1. Specify the prit optios for your system. From the Acrobat Reader Meu bar, select File > Page Setup ad make your selectios. A settig of 300 dpi is highly recommeded as is duplex pritig if your priter supports this optio. 2. To start pritig, select File > Prit... o the Acrobat Reader Meu bar. 3. O the Prit pop-up, select oe of the Prit Rage optios for All Curret page Pages from: [ ] to: [ ] 4. (Optioal). Select the Shrik to Fit optio if you eed to fit oversize pages to the paper size curretly loaded o your priter. Pritig problems? The prit quality of your output is ultimately determied by your priter. Sometimes pritig problems ca occur. If you experiece pritig problems, potetial areas to check are: settigs for your priter ad priter driver. (The dpi settigs for both your driver ad priter should be the same. A settig of 300 dpi is recommeded.) the priter driver you are usig. (You may eed a differet priter driver or the Uiversal Priter driver from Adobe. This free priter driver is available at the halftoe/graphics color adjustmet for pritig color o black ad white priters (check the priter properties uder Start > Settigs > Priter). For more iformatio, see the olie help for the Acrobat Reader. the amout of available memory i your priter. (Isufficiet memory ca cause a documet or graphics to fail to prit.) For additioal iformatio o pritig problems, refer to the documetatio for your priter or cotact your priter maufacturer. Preface 7

8 Adobe Portable Documet Format Cotactig Adobe If additioal iformatio is eeded about Adobe Acrobat Reader or pritig problems, see the Readme.pdf file that ships with Adobe Acrobat Reader or cotact Adobe at 8 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

9 W What s New I This Release This product has a ew ame This product (formerly Cadle Commad Ceter for MQSeries Itegrator) has bee reamed to OMEGAMON XE for WebSphere MQ Itegrator. You will see the ew ame i the product help ad documetatio. Cadle moitorig agets have ew ames Cadle's itelliget moitorig agets that comprise the OMEGAMON XE suite of products ad use the CadleNet Portal user iterface have bee reamed. You will see the ew ames i the product help ad documetatio. Withi these applicatios, some of the paels may ot reflect the ew ame. However, all of the itelliget fuctioality of OMEGAMON XE is available for these agets. The ew product ames will be added to the applicatios i a subsequet release. Ehacemets OMEGAMON XE for WebSphere MQ Itegrator, V110 release ehacemets iclude: Support for the WebSphere MQ Itegrator o z/os product A ew moitorig aget is provided, to help you maage the IBM WebSphere MQ Itegrator product that rus o OS/390 ad z/os systems. The (ew) Message Processig Node Attribute workspace displays all attribute values for a selected message processig ode withi a message flow. What s New I This Release 9

10 Additioal colums are added to these workspaces the Broker Iformatio workspace the Broker Statistics workspace the (reamed) Compoets workspace the Executio Group Statistics workspace The additioal colums display: the broker s process ID ad its associated cofiguratio maager queue maager iformatio about the platform o which the (respective) broker, compoet, or executio group rus the (respective) broker s or executio group s job o OS/390 ad z/os systems the executio group s process ID ad status Predefied liks to other products If you purchased the OMEGAMON DE feature package for CadleNet Portal, ad if you use oe of the followig products o the system o which your broker rus: Cadle Commad Ceter for MQSeries OMEGAMON XE for OS/390 UNIX System Services OMEGAMON XE for UNIX OMEGAMON XE for Widows NT the predefied liks from selected workspaces i OMEGAMON XE for WebSphere MQ Itegrator let you lik directly to a workspace i the other Cadle product. This allows you to quickly diagose WebSphere MQ or Operatig System problems. Documetatio chages iclude: The Istallatio Roadmap documet, available with this product s V100 release, is discotiued. Messages are documeted i the Cadle Products Messages Maual. Historical reportig iformatio for this product is documeted i: Historical Data Collectio Guide for OMEGAMON XE ad CadleNet Commad Ceter. 10 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

11 1 Itroductio Itroductio This chapter provides a brief overview of OMEGAMON XE for WebSphere MQ Itegrator s features ad explais how they ca help you moitor your message broker topologies. Chapter cotets What is OMEGAMON XE for WebSphere MQ Itegrator? Operatig Eviromet Itroductio 11

12 What is OMEGAMON XE for WebSphere MQ Itegrator? What is OMEGAMON XE for WebSphere MQ Itegrator? Overview The icreasig importace of e-busiess has made the role of eterprise applicatio itegratio ad middleware systems crucial to the success of your corporatio. Specifically, the performace ad availability of these systems drives your competitive edge. OMEGAMON XE for WebSphere MQ Itegrator helps hoe your competitive edge by providig you with the meas to verify, aalyze, ad tue your WebSphere MQ Itegrator Versio 2.1 message broker topologies. You ca use OMEGAMON XE for WebSphere MQ Itegrator to: Esure the validity of your WebSphere MQ Itegrator eviromet by detectig broker ad message flow problems before they have a impact upo your availability ad service levels. Help resolve o-goig problems. Reduce the amout of time ivolved i the deploymet of WebSphere MQ Itegrator applicatios by debuggig message flows ad usig the statistics gathered to tue your eviromet. This ot oly improves performace, but reliability ad availability as well. Esure that the architecture of your WebSphere MQ Itegrator eviromet fuctios accordig to your desig. This allows you to see if your WebSphere MQ Itegrator system is cofigured properly, ad serves as a excellet startig poit for aalysis. Issue WebSphere MQ Itegrator commads so you ca directly maage your eviromet or respod to problem situatios by meas of Take Actio commads. Create stadard resposes for situatios that automatically issue commads accordig to criteria defied for your eviromet. The use of situatios provides early detectio of impedig problems, ad permits quick problem resolutio. This feature improves service levels ad also allows people ad resources to be allocated to other tasks. 12 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

13 What is OMEGAMON XE for WebSphere MQ Itegrator? Graphically display WebSphere MQ Itegrator performace statistics ad compoet status by meas of OMEGAMON XE for WebSphere MQ Itegrator s easy to uderstad user iterface, CadleNet Portal. The OMEGAMON XE for WebSphere MQ Itegrator workspaces The workspaces are the heart of the OMEGAMON XE for WebSphere MQ Itegrator product. Together they provide you with status, defiitio, ad statistical iformatio for the compoets of your WebSphere MQ Itegrator system. The OMEGAMON XE for WebSphere MQ Itegrator workspaces iclude: Iformatio workspaces The Broker Iformatio workspace displays the activity status of the broker, ames the broker s associated queue maager, ad idicates whether or ot the aget ca coect to the broker s queue maager. See Broker Iformatio Workspace o page 87. The Executio Group Iformatio workspace displays executio groups defied for the broker as well as defiitio iformatio for each executio group. See Executio Group Iformatio Workspace o page 99. The Message Flow Iformatio workspace displays defied message flows by executio group as well as defiitio iformatio for each. See Message Flow Iformatio Workspace o page 105. The Message Processig Node Attributes workspace displays all attribute values for a message processig ode (whe you drill dow from a row i the Message Processig Node Iformatio workspace). See Message Processig Node Attributes Workspace o page 110. The Message Processig Node Iformatio workspace displays defied message processig odes by their executio group ad message flow. See Message Processig Node Iformatio Workspace o page 112. Itroductio 13

14 What is OMEGAMON XE for WebSphere MQ Itegrator? The Message Processig Nodes workspace lists all message processig odes i the eterprise that have the same queue ame (whe you drill dow from a row i the Message Processig Node Iformatio workspace). See Message Processig Nodes o page 114. Evets workspaces The Broker Evets workspace lists evets geerated by the WebSphere MQ Itegrator broker as they occur. See Broker Evets Workspace o page 85. The Message Flow Evets workspace lists evets geerated by the CadleMoitor ode as they occur. See Message Flow Evets Workspace o page 103. Statistics workspaces The Broker Statistics workspace provides message flow statistics summarized at the broker level. See Broker Statistics Workspace o page 89. The CadleMoitor Node Statistics workspace provides message flow statistics at the idividual ode level at which they are collected. See CadleMoitor Node Statistics Workspace o page 94. The Executio Group Statistics workspace provides message flow statistics summarized at the executio group level. See Executio Group Statistics Workspace o page 100. The Message Flow Statistics workspace provides message flow statistics summarized at the message flow level. See Message Flow Statistics Workspace o page OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

15 What is OMEGAMON XE for WebSphere MQ Itegrator? Aget maaged systems workspaces The Compoets workspace displays a list of WebSphere MQ Itegrator compoets ad their state at the aget level. See Compoets Workspace o page 97. The Product Evets workspace displays product evets geerated by the aget whe a problem occurs that affects the aget's ability to collect WebSphere MQ Itegrator data. See Product Evets Workspace o page 117. Other workspaces The Aget Status workspace summarizes evet ad WebSphere MQ Itegrator compoet iformatio at the aget level. See Aget Status Workspace (aget-level summary) o page 84. The ACL Etries workspace displays ACL etries per topic, which defie access to topics for publish ad subscribe. See ACL Etries Workspace o page 83. The Broker Summary workspace summarizes broker status ad defiitio data whe multiple brokers are moitored by the same aget. See Broker Summary Workspace (multiple brokers moitored) o page 93. The Broker Status workspace summarizes evet ad defiitio iformatio at the broker level. See Broker Status Workspace (broker-level summary) o page 92. The Neighbors workspace displays a list of eighbors to the broker i the publish ad subscribe topology, as well as their coectio attributes. See Neighbors Workspace o page 115. The Retaied Publicatios workspace displays a list of topic ad subscriptio poits that have a retaied publicatio. See Retaied Publicatios Workspace o page 119. The Subscriptios workspace displays a list of subscriptios to topics. See Subscriptios Workspace o page 120. Itroductio 15

16 Operatig Eviromet Operatig Eviromet Overview This sectio describes the operatig eviromet i which the OMEGAMON XE for WebSphere MQ Itegrator fuctios. What is OMEGAMON XE? OMEGAMON XE is a suite of products that assists you i moitorig your maiframe ad distributed systems o a variety of platforms usig a variety of workstatios. It provides a way to moitor the availability ad performace of all the systems i your eterprise from oe or several desigated workstatios. It provides may useful reports you ca use to track treds ad uderstad ad troubleshoot system problems. You ca use OMEGAMON XE to establish your ow performace thresholds create situatios, which are coditios to moitor create ad sed commads to systems i your maaged eterprise by meas of the Take Actio feature. Take Actio eables you to, for istace, restart a process that is ot fuctioig properly or sed a message. create comprehesive reports about system coditios moitor for alerts o the systems ad platforms you are maagig trace the causes leadig up to a alert defie your ow queries, usig the attributes provided by OMEGAMON XE for WebSphere MQ Itegrator, to moitor coditios of particular iterest to you Compoets of the eviromet The cliet-server-aget implemetatio icludes a cliet, kow as CadleNet Portal 16 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

17 Operatig Eviromet a server, kow as the Cadle Maagemet Server (CMS ) ad its Cadle Maagemet Workstatio (CMW ) iterface a CadleNet Portal server that performs commo CadleNet Portal fuctios ad serves to lighte the CadleNet Portal cliet moitorig agets that collect ad distribute data to a CMS. The OMEGAMON XE for WebSphere MQ Itegrator moitorig aget is such a aget. A additioal feature package, OMEGAMON DE, is available with OMEGAMON XE. This feature package provides all the capability of OMEGAMON XE, plus additioal capabilities as described later i this chapter. What is CadleNet Portal? CadleNet Portal is the user iterface ito your OMEGAMON XE product set. It provides a view of your eterprise from which you ca drill dow to more closely examie compoets of your systems eviromet. Its applicatio widow cosists of a Navigator that shows all the systems i your eterprise where Cadle agets are istalled, ad a workspace that icludes table ad chart views of system ad applicatio coditios. CadleNet Portal rus situatios at regular itervals to check that your applicatios ad system resources are ruig, ad ruig well. A failed test causes evet idicators to appear i the Navigator. CadleNet Portal offers two modes of operatio: desktop ad browser. I desktop mode, the applicatio software is istalled o your system. I browser mode, the system admiistrator istalls the applicatio o the web server ad you start CadleNet Portal from your browser. I browser mode, the software is dowloaded to your system the first time you log o to CadleNet Portal, ad thereafter oly whe there are software updates. What is the Cadle Maagemet Workstatio? Whe usig OMEGAMON XE for WebSphere MQ Itegrator, the Cadle Maagemet Workstatio (CMW) is geerally ot used. For example, OMEGAMON XE for WebSphere MQ Itegrator has o CMW reports. However you ca use the CMW to perform CMS admiistrative fuctios. Itroductio 17

18 Operatig Eviromet Further Iformatio about the CMW ad CadleNet Portal Further iformatio about admiisterig the CMS usig the CMW ca be foud i the Cadle Maagemet Workstatio Admiistrator s Guide as well as i the CMW olie Help. For further iformatio about CadleNet Portal, refer to the CadleNet Portal olie Help ad the Admiisterig OMEGAMON Products: CadleNet Portal guide. What is OMEGAMON DE? The OMEGAMON DE feature package for CadleNet Portal offers a dashboard view of your eterprise. This feature provides a sigle poit of cotrol from which you ca maage the resources your busiess-critical applicatios rely o, icludig a rage of operatig systems, servers, databases, maiframes, ad Web compoets. It eables you to pull together the data ad fuctioality built ito all the Cadle moitorig solutios, such as OMEGAMON XE for WebSphere MQ Itegrator. OMEGAMON DE provides all the capability of OMEGAMON XE, plus additioal capabilities such as: Multiple applicatios ca be displayed i oe workspace I a sigle workspace, you ca build a table or chart with data from oe type of moitorig aget, ad aother table or chart with data from a differet aget. Withi that workspace, you ca show views from as may differet aget types as are icluded o that brach of the Navigator. You ca lik applicatio workspaces You ca defie a lik from a workspace associated with oe type of moitorig aget to a workspace associated with aother type of aget. You ca defie eterprise-specific Navigator views The Navigator physical view shows the hierarchy of your maaged eterprise by operatig platform ad type of Cadle aget. The Navigator busiess view shows the hierarchy of ay maaged objects defied through the CMW. You ca also defie Navigator views for ay logical groupig, such as a departmetal or site hierarchy. Detailed iformatio about OMEGAMON DE is provided i the CadleNet Portal olie Help. 18 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

19 Operatig Eviromet Historical Data Collectio You ca use the facilities of CadleNet Portal s historical data collectio fuctio to store ad save the data beig collected by your OMEGAMON XE for WebSphere MQ Itegrator moitorig aget or agets. The historical data collectio fuctio permits you to specify the attribute group or groups for which data is to be collected the iterval at which data is to be collected the iterval at which data is to be warehoused (if you choose to do so) the locatio (either at the aget or at the CMS) at which the collected data is to be stored Iformatio about usig the Historical Data Collectio fuctio ca be foud i the CadleNet Portal olie Help ad i the Historical Data Collectio Guide for OMEGAMON XE ad CadleNet Commad Ceter. Where to Fid More Iformatio Iformatio cocerig OMEGAMON XE for WebSphere MQ Itegrator ad CadleNet Portal is available through olie helps provided with the product. The helps for this product ad for the user iterface are merged together, providig oe seamless system. The scope of this guide, however, is to provide supplemetal iformatio specific to OMEGAMON XE for WebSphere MQ Itegrator. I several cases, istructios cocerig user actios are specific to the user iterface, ad thus reside i the CadleNet Portal olie Help or Admiisterig OMEGAMON Products: CadleNet Portal guide. You will be referred to the applicable documetatio wheever appropriate. Itroductio 19

20 Operatig Eviromet 20 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

21 2 Cofigurig OMEGAMON XE for WebSphere MQ Itegrator Itroductio This chapter describes the authority requiremets of the moitorig aget, explais how to set the parameters for the moitorig aget, ad discusses the steps required to activate the CadleMoitor Node. Chapter cotets Authorizig the Aget Settig Aget Parameters Aget Performace Cosideratios Activatig the CadleMoitor Node Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 21

22 Authorizig the Aget Authorizig the Aget Itroductio This sectio describes the actios required i order to authorize the OMEGAMON XE for WebSphere MQ Itegrator moitorig aget (hereafter called the aget ) to receive the correct broker data. Authorizig the aget O OS/390 ad z/os To authorize the aget o OS/390 ad z/os, follow the steps below. 1. RKANMOD ad TKANMODL (or, depedig o your RTE cofiguratio, RKANMODL) datasets for the aget's started task procedure eed to be APF authorized. 2. The userid for the aget's started task should have read access to files i the moitored brokers' compoet directories. 3. The userid for the aget's started task eeds proper authorizatio to MQOPEN ad MQPUT to SYSTEM.BROKER.ADMIN.QUEUE ad SYSTEM.BROKER.CONTROL.QUEUE. It eeds proper authorizatio to use SYSTEM.BROKER.MODEL.QUEUE as a model queue durig MQOPEN processig. It eeds proper authorizatio to MQOPEN (for create) ad MQGET from KQI.AGENT.REPLY.QUEUE (or the ame your site defied i aget parameters to be the aget reply queue). 4. Oe of the followig must be true for the aget to operate properly. The userid for the aget s started task procedure must be specifically permitted (i RACF) to the UNIXPRIV class SUPERUSER.PROCESS.GETPSENT (see istructios that follow, below). If preferred, the userid for the aget's started task procedure ca be set to UID=0. I a RACF eviromet this is doe usig ICHRIN03 or the STARTED Class (Started Geeral Resource Class). Security products other tha RACF may require differet techiques. 22 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

23 Authorizig the Aget The symptoms that will occur if oe of the above is ot true are: message KQIA153E givig retur code i the aget log; missig job ame, start date ad time, ad ASID iformatio for a broker or executio group; ad sporadic reportig that a broker or executio group has a status of "started" whe it is ot. UNIXPRIV SUPERUSER.PROCESS.GETPSENT is described i IBM maual "UNIX System Services Plaig" i chapter "Establishig UNIX Security", sectio "Usig UNIXPRIV Class Profiles". The istructios required to set this up for the aget are as follows: 1. Defie a profile i the UNIXPRIV class to protect the resource called SUPERUSER.PROCESS.GETPSENT: RDEFINE UNIXPRIV SUPERUSER.PROCESS.GETPSENT UACC(NONE) 2. Assig the aget s started task procedure userid (xxxxxxx): PERMIT SUPERUSER.PROCESS.GETPSENT CLASS(UNIXPRIV) ID(xxxxxxx) ACCESS(READ) 3. Activate the UNIXPRIV class, if it is ot curretly active at your istallatio: SETROPTS CLASSACT(UNIXPRIV) 4. Activate SETROPTS RACLIST processig for the UNIXPRIV class, if it is ot already active: SETROPTS RACLIST(UNIXPRIV) Note If SETROPTS RACLIST processig is already i effect for the UNIXPRIV class, refresh SETROPTS RACLIST processig so that the chaged profile i the UNIXPRIV class will take effect: SETROPTS RACLIST(UNIXPRIV) REFRESH 5. See Additioally, for agets o all platforms o page 26. Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 23

24 Authorizig the Aget O UNIX To authorize the aget o UNIX, follow the steps below. 1. Create a userid accout for the aget, if ecessary. The aget s userid accout must: belog to groups mqm (this must be the primary group) ad mqbrkrs. have authority to subscribe to broker evet publicatios (see Additioally, for agets o all platforms below). have authority to do MQOPEN ad MQPUT to SYSTEM.BROKER.ADMIN.QUEUE ad SYSTEM.BROKER.CONTROL.QUEUE. It eeds proper authorizatio to use SYSTEM.BROKER.MODEL.QUEUE as a model queue durig MQOPEN processig. It eeds proper authorizatio to MQOPEN (for create) ad MQGET from KQI.AGENT.REPLY.QUEUE (or the ame your site defied i aget parameters to be the aget reply queue). The aget s userid accout requiremets are similar to the broker s, however the aget s userid accout does ot have to exactly match the broker s for groups ot metioed above. If desired, you ca use the broker s accout. 2. You must start the aget with either the same userid as the WebSphere MQ Itegrator broker or with a userid that belogs to similar groups as the broker s userid (as described above). However, ever start the aget usig a userid that has a higher authority tha the broker s authority or that has root authority uless the WebSphere MQ Itegrator broker also rus with root authority. 3. See Additioally, for agets o all platforms o page OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

25 Authorizig the Aget O Widows To authorize the aget o Widows, follow the steps below. 1. Create a userid accout for the aget, if ecessary. The aget userid should be a part of the same domai as is associated with the WebSphere MQ Itegrator User Name Server (if applicable) ad brokers to be moitored. The aget s userid accout must: belog to groups mqm (this must be the primary group), mqbrkrs, ad Admiistrators. Note that if the userid is beig defied i a domai other tha the local system, it should belog to group "Domai mqbrkrs" istead of "mqbrkrs". have authority to subscribe to broker evet publicatios (see Additioally, for agets o all platforms below). have authority to do MQOPEN ad MQPUT to SYSTEM.BROKER.ADMIN.QUEUE ad SYSTEM.BROKER.CONTROL.QUEUE. It eeds proper authorizatio to use SYSTEM.BROKER.MODEL.QUEUE as a model queue durig MQOPEN processig. It eeds proper authorizatio to do MQOPEN (for create) ad MQGET from KQI.AGENT.REPLY.QUEUE (or the ame your site defied i aget parameters to be the aget reply queue). The aget s userid accout requiremets are similar to the broker s, however the aget s userid accout does ot have to exactly match the broker s for groups ot metioed above. If desired, you ca use the broker s accout. 2. To set the accout for the aget: I Maage Cadle Services, right-click o the aget ad select Chage Startup. I the log o as sectio, chage from usig the system accout to specify the userid ad password for a accout that meets the requiremets described above (or use the broker s accout). If the userid is defied i a domai other tha the local system, be sure to specify the domai ame whe specifyig the userid i the "This Accout" field, as i "<domai>\<userid>". If the aget rus as a NT Service usig the system accout, it caot subscribe successfully to broker evet publicatios. Whe the aget does ot Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 25

26 Authorizig the Aget receive broker evet publicatios, much data i OMEGAMON XE for WebSphere MQ Itegrator reports will be missig or iaccurate. 3. See Additioally, for agets o all platforms o page 26. Additioally, for agets o all platforms Additioally, depedig o your site's ACL etries, you may be required to authorize the aget to receive broker evet publicatios i the WebSphere MQ Itegrator Cotrol Ceter. You do ot have to perform this step if your site uses the IBM defaults. However, if ACL etries i the Topics tab of the WebSphere MQ Itegrator Cotrol Ceter have bee modified such that subscribe access to topics begiig with $SYS/Broker has bee restricted, this step is required. A ACL etry for topics begiig with $SYS/Broker must be added to set Subscribe access to Allow for the userid of the Cadle aget. The pricipal for the ACL etry should give the userid of the aget, or it ca give a group to which the aget's userid belogs, such as mqbrkrs. The ACL etry must be deployed to all brokers to be moitored by OMEGAMON XE for WebSphere MQ Itegrator. This chage will allow the aget to receive the broker evet publicatios. If the aget is restricted from receivig these publicatios, much data i OMEGAMON XE for WebSphere MQ Itegrator reports will be missig or iaccurate. (Specifically, the Broker Evets workspace will display o data.) 26 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

27 Settig Aget Parameters Settig Aget Parameters Itroductio This sectio itroduces the aget parameter file, explais how to implemet chages to the file, ad describes the parameters that ca be used i the file. What is the aget parameter file? The parameters that determie the operatioal ad moitorig characteristics of the aget reside i a file that is created durig the istallatio of OMEGAMON XE for WebSphere MQ Itegrator. This file is dowloaded alog with the OMEGAMON XE for WebSphere MQ Itegrator product. O OS/390 ad z/os The aget parameter file member ame is KQIXML. If you use the istallatio locatio defaults, the KQIXML member resides i the followig partitioed dataset: &rhilev.rkandatv O UNIX The aget parameter file is amed kqi.xml. Note that if you specify broker ad agetid parameters at aget startup, the ame of the aget parameter file is customized. The aget parameter file ame for a aget started with optioal parameters is of the form: <hostname>_qi_<brokername>_##_<agetid>.xml If you use the istallatio locatio defaults, the aget parameter file resides i: $CANDLEHOME/cofig Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 27

28 Settig Aget Parameters O Widows The aget parameter file is amed kqi.xml. Note that if you use the Create Istace optio of Maage Cadle Services to replicate the aget, the ame of the aget parameter file is customized. The aget parameter file ame for a created istace is of the form: kqi_<taskame>.xml If you use the istallatio locatio defaults, the aget parameter file resides i: C:\Cadle\cma The default aget parameter file The aget parameter file, as shipped with OMEGAMON XE for WebSphere MQ Itegrator, cotais a base set of parameters that employ the product defaults. However, these parameters ca be chaged to suit the eeds of your site. O UNIX ad Widows Your iitial kqi.xml file resembles the followig: <KqiAget versio= 110 defaultretaibrokerevets= 10 defaultretaiflowevets= 10 retaiproductevets= 10 discoveryiterval= 300 defaultstatisticiterval= 60 defaultflowevetiterval= 15 defaultreplyqueuename= KQI.AGENT.REPLY.QUEUE defaultreplyqueuemodel= SYSTEM.BROKER.MODEL.QUEUE defaulttakeactioauthusers= * > </KqiAget> Note that this default file represets the core parameters that will be used i reportig ad moitorig for the aget o UNIX ad Widows systems. As o idividual brokers or queue maagers are specified i the file, ruig with the parameters show here results i all brokers beig moitored by the aget. 28 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

29 Settig Aget Parameters O OS/390 ad z/os Your iitial KQIXML file resembles the followig: <KqiAget versio= 110 agetid= A1 defaultretaibrokerevets= 10 defaultretaiflowevets= 10 retaiproductevets= 10 discoveryiterval= 300 defaultstatisticiterval= 60 defaultflowevetiterval= 15 defaultreplyqueuename= KQI.AGENT.REPLY.QUEUE defaultreplyqueuemodel= SYSTEM.BROKER.MODEL.QUEUE defaulttakeactioauthusers= * > <MoitorBroker ame= MQP1BRK compoetdirectory= /var/wmqi/mqp1brk > </MoitorBroker> </KqiAget> O OS/390 ad z/os systems, all brokers to be moitored must be specified i the parameter file usig the MoitorBroker tag. Ruig with the parameters show here results i broker MQP1BRK beig moitored by the aget. To moitor additioal brokers, add additioal MoitorBroker tag specificatios as ecessary. Sytax of the aget parameter file The parameters withi the kqi.xml file (or KQIXML member) are i XML format. As such, XML sytax covetios must be adhered to as show i the sample files ad parameter descriptios. However, the actual codig is ot colum-specific, so the spacig ad lie separatio show i this chapter are ot critical. Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 29

30 Settig Aget Parameters Makig chages to the aget parameter file Ay chages to the aget parameter file fall ito two categories: chages to a existig parameter; or the additio of ew parameters to the file. Makig chages to a existig parameter To make chages to a parameter that already appears withi the file, substitute the origial parameter value with your ew value, eclosed withi a set of double quotes ( ). For example: defaultstatisticiterval= origial value would become: defaultstatisticiterval= ew value Addig ew parameters to the file To add ew parameters to the aget parameter file, you must first determie if a appropriate XML tag already exists for the parameter. If the appropriate XML tag already exists, isert the ew parameter strig ito the tag block. For example, to add the agetid parameter to the default kqi.xml file: <KqiAget versio= 110 defaultretaibrokerevets= 10 defaultretaiflowevets= 10 retaiproductevets= 10 discoveryiterval= 300 defaultstatisticiterval= 60 defaultflowevetiterval= 15 defaultreplyqueuename= KQI.AGENT.REPLY.QUEUE defaultreplyqueuemodel= SYSTEM.BROKER.MODEL.QUEUE defaulttakeactioauthusers= * > </KqiAget> would become: <KqiAget versio= 110 agetid= ew_value defaultretaibrokerevets= 10 defaultretaiflowevets= OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

31 Settig Aget Parameters retaiproductevets= 10 discoveryiterval= 300 defaultstatisticiterval= 60 defaultflowevetiterval= 15 defaultreplyqueuename= KQI.AGENT.REPLY.QUEUE defaultreplyqueuemodel= SYSTEM.BROKER.MODEL.QUEUE defaulttakeactioauthusers= * > </KqiAget> If the appropriate XML tag does ot exist, the isert the correct opeig ad closig XML tags before icludig the parameter strig. Refer to the sample below: <KqiAget versio= 110 agetid= A1 defaultretaibrokerevets= 10 defaultretaiflowevets= 10 retaiproductevets= 10 discoveryiterval= 300 defaultstatisticiterval= 120 defaultflowevetiterval= 30 defaultreplyqueuename= SOME.NAME defaultreplyqueuemodel= SYSTEM.BROKER.MODEL.QUEUE defaulttakeactioauthusers= * > <MoitorBroker ame= MySpecialBrokerName statisticiterval= 60 flowevetiterval= 20 retaibrokerevets= 5 retaiflowevets= 5 > takeactioauthusers= A?B,C* > </MoitorBroker> <MoitorBroker ame= AotherBrokerName > </MoitorBroker> <CoectQueueMaager ame= MY.BROKER.QMGR replyqueuename= SOME.OTHER.NAME replyqueuemodel= MY.SPECIAL.MODEL.QUEUE > </CoectQueueMaager> </KqiAget> Note that each tag block ecapsulates the parameters specific to that compoet. This sample file is icluded i istallatios o UNIX ad Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 31

32 Settig Aget Parameters Widows. The file is amed kqismpl.xml ad ca be used as a template for makig chages to your kqi.xml file. O UNIX, the kqismpl.xml file ca be foud i the followig directory: $CANDLEHOME/<Platform>/qi/files where <Platform> is either aix433 or sol273. O Widows, the kqismpl.xml file ca be foud i the followig directory: C:\Cadle\Cma 32 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

33 Settig Aget Parameters Aget parameter descriptios The array of parameters that ca be used i the kqi.xml file (or KQIXML member), alog with their associated XML tags, are described below: KqiAget The KqiAget tag ecapsulates all parameters for the aget. Ay attributes followig this tag apply to the aget as a whole ad provide moitorig ad coectio defaults that ca be overridde at the idividual broker or queue maager level. All associated attributes are optioal. The versio attribute specifies the versio of the OMEGAMON XE for WebSphere MQ Itegrator product for which the parameters were set. The default is 110. This attribute is reserved for future product use. Do ot alter this attribute from its default value uless directed to do so by Cadle Support persoel. The agetid attribute provides a short idetifier (maximum legth of four alpha-umeric characters) for the OMEGAMON XE for WebSphere MQ Itegrator aget. Note: If your site iteds to ru more tha oe KqiAget o the same host, assig each aget a uique agetid. If your site iteds to ru more tha oe broker with the same ame o differet hosts, assig each aget that moitors a broker a uique agetid. The use of uique agetids i these cases distiguishes the broker maaged system ames i the Cadle Maagemet Server (CMS) so that CadleNet Portal displays them correctly. The default is (oe). Supply a alpha-umeric character strig with o blaks. The value will be used to create a uique maaged system ame. The defaultretaibrokerevets attribute determies how may WebSphere MQ Itegrator Broker Evets to retai per broker for viewig i reports. These evets are always reported as pure evets for situatios ad if historical situatios are active, they ca be viewed historically. The default is 10 evets. The value must be greater tha 0. Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 33

34 Settig Aget Parameters The defaultretaiflowevets attribute determies how may Message Flow Evets to retai per broker for viewig i reports. These evets are always reported as pure evets for situatios ad if historical situatios are active, they ca be viewed historically. The default is 10 evets. The value must be greater tha 0. The retaiproductevets attribute determies the total umber of Product Evets to retai for viewig i reports. These evets are always reported as pure evets for situatios ad if historical situatios are active, they ca be viewed historically. The default is 10 evets. The value must be greater tha 0. The discoveryiterval attribute determies the period of time i secods betwee the aget s rediscovery of brokers created o the system. This attribute ca be set to a high value whe you are o loger creatig ew brokers, uless you have a dyamic eviromet i which ew brokers are created frequetly. The default is 300 secods. The value must be greater tha 0. The defaultstatisticiterval attribute determies the miimum period of time i secods betwee the collectio of broker statistics, such as message flow statistics. The default is 60 secods. The value must be greater tha 0. The defaultflowevetiterval attribute determies the period of time i secods for the Message Flow Evet samplig iterval. This iterval does ot apply to Broker Evets or Product Evets. The default is 15 secods. The value must be greater tha 0. The defaultreplyqueuename attribute specifies the ame of the queue that will be used for the aget s receipt of replies ad publicatios for ay queue maager to which the aget coects. Note that the queue will be created as a temporary dyamic queue if it does ot already exist. If the give ame is less tha 33 characters log, the actual ame of the temporary queue created will be made uique by the queue maager. This value will be used uless a replyqueuename parameter is specifically amed for that queue maager. The default is KQI.AGENT.REPLY.QUEUE. 34 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

35 Settig Aget Parameters The defaultreplyqueuemodel attribute specifies the ame of the queue that will be used as a model for creatio of the aget reply queue for ay queue maager to which the aget coects. This value will be used uless a replyqueuemodel parameter is specifically amed for that queue maager. The default is SYSTEM.BROKER.MODEL.QUEUE. The defaulttakeactioauthusers attribute specifies which CadleNet Portal users are authorized to issue the Take Actio commads associated with this aget. Note that there ca be multiple etries associated with this attribute, ad that each etry ca be a mask which ca iclude the * ad? wildcard characters. A CadleNet Portal user whose ID matches ay mask i this list is authorized to issue the Take Actio commads that are hadled by the KQIAget. Note CadleNet Portal user IDs are defied withi the CMS ad do ot ecessarily exist o the ode o which the aget is ruig. This default value applies for ay commads that are ot associated with a particular broker, ad for ay broker-related commads for brokers that do ot have a specific list of users specified by meas of the takeactioauthusers parameter. The default is * which allows all CadleNet Portal users to issue Take Actio commads associated with this aget. The commadtimeoutiterval attribute specifies the period of time i secods before the aget issues a message idicatig that the broker is ot respodig. The default is 60 secods. The value must be greater tha 0. Importat: Do ot alter this attribute from its default value uless directed to do so by Cadle Support persoel. The maximumcommadretrycout attribute specifies the umber of times that the aget will attempt to reissue a commad before stoppig. The default is 4 retries. The value must be greater tha 0. Importat: Do ot alter this attribute from its default value uless directed to do so by Cadle Support persoel. The maximumagetcollectiothreads attribute ca be used to icrease or decrease the umber of brokers that the aget ca moitor. Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 35

36 Settig Aget Parameters The default is 20 threads. The value must be greater tha 0. If you will be usig oe aget to moitor more tha four brokers per system, icrease the default thread cout by 4 for each additioal broker moitored. Importat: Do ot alter this attribute from its default value uless ecessary. See Aget Performace Cosideratios o page 39. MoitorBroker The MoitorBroker tag ecapsulates parameters which apply to a sigle broker to be moitored by the aget. Oe or more MoitorBroker tags may be specified. O UNIX ad Widows: If o brokers are specified, all brokers ruig o the same host system as the aget will be moitored, as determied by self-discovery. If ay brokers are specified, the ay other brokers that you wish to moitor must also be explicitly specified usig MoitorBroker tags ad attributes. All associated attributes are optioal except for the ame attribute. O OS/390 ad z/os: OMEGAMON XE for WebSphere MQ Itegrator does ot curretly support self-discovery of brokers o OS/390 or z/os systems. Each broker to be moitored must be explicitly specified usig MoitorBroker tags ad attributes. All associated attributes are optioal except for the ame attribute ad the compoetdirectory attribute. The ame attribute specifies the ame of a WebSphere MQ Itegrator Broker that should be moitored by this aget. The ame attribute is required. The statisticiterval attribute determies the same iformatio as the defaultstatisticiterval attribute explaied above, but overrides that default for this particular broker. If this attribute is ot specified, the defaultstatisticiterval value will be used. If specified, the value must be greater tha 0. The flowevetiterval attribute determies the same iformatio as the defaultflowevetiterval attribute explaied above, but overrides that default for this particular broker. If this attribute is ot specified, the defaultflowevetiterval value is used. If specified, the value must be greater tha OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

37 Settig Aget Parameters The retaibrokerevets attribute determies the same iformatio as the defaultretaibrokerevets attribute explaied above, but overrides that default for this particular broker. If this attribute is ot specified, the defaultretaibrokerevets value is used. If specified, the value must be greater tha 0. The retaiflowevets attribute determies the same iformatio as the defaultretaiflowevets attribute explaied above, but overrides that default for this particular broker. If this attribute is ot specified, the defaultretaiflowevets value is used. If specified, the value must be greater tha 0. The compoetdirectory attribute specifies the directory path created whe the broker to be moitored was customized. This is the same as the compoet directory ame required as iput to the mqsicreatebroker commad with the -c parameter. The compoet directory is described i the WebSphere MQ Itegrator for z/os Customizatio ad Admiistratio Guide. This attribute is required o OS/390 ad z/os systems. It is igored if specified o UNIX or Widows systems. The takeactioauthusers attribute idicates which CadleNet Portal users are authorized to issue the Take Actio commads associated with this aget, o this particular broker. Note that there ca be multiple etries associated with this attribute, ad that each etry ca be a mask which ca iclude the * ad? wildcard characters. A CadleNet Portal user whose ID matches ay mask i this list is authorized to issue the Take Actio commads that are hadled by the KqiAget ad are specific to this moitored broker. Note CadleNet Portal user IDs are defied withi the CMS ad do ot ecessarily exist o the ode o which the aget is ruig. This value applies for ay commads that are asssociated with the specified moitored broker oly ad overrides ay defaulttakeactioauthusers attribute specificatio. If this attribute is ot specified, the defaulttakeactioauthusers value is used. Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 37

38 Settig Aget Parameters CoectQueueMaager The CoectQueueMaager tag ecapsulates parameters which apply to a queue maager that the aget will coect to. Oe or more CoectQueueMaager tags may be specified. The ame attribute is required. However, there is o eed to specify this tag if oly the ame attribute will be give. I this case, aget level defaults will be used for the remaiig attributes, ad the aget will automatically coect to the moitored broker s associated queue maager. However, if the default reply ad model queue ames are ot sufficiet for a broker queue maager, the additioal parameters below should be specified: The ame attribute specifies the ame of the queue maager that the aget will coect to. The replyqueuename attribute specifies the ame of the queue that will be used for the aget s receipt of replies ad publicatios for this queue maager. Note that the queue will be created as a temporary dyamic queue if it does ot already exist. If the give ame is less tha 33 characters log, the actual ame of the temporary queue created will be made uique by the queue maager. If this attribute is ot specified, the defaultreplyqueuename is used. The replyqueuemodel attribute specifies the ame of the queue that will be used as a model for creatio of the aget reply queue o this queue maager. If this attribute is ot specified, the defaultreplyqueuemodel is used. 38 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

39 Aget Performace Cosideratios Aget Performace Cosideratios Moitorig a large umber of brokers To miimize performace overhead, Cadle recommeds ruig oly oe KqiAget per host system. However, if the performace of the aget becomes egatively impacted from moitorig a large umber of brokers, you ca split the moitorig duties amog multiple agets. Here are some guidelies. For most distributed systems, oe aget per host system should suffice as the aget is desiged to moitor all brokers o such a system, or to moitor a subset of brokers, as specified i the aget parameter file. Busy systems, such as OS/390 ad z/os systems, may eed to adjust the aget parameter that limits the umber of brokers* moitored (ad durig a testig phase cofirm that the aget is ot too busy to do a good job), or split the broker moitorig duties amog multiple** agets. The aget is too busy if the CPU usage is high or if the respose time is high for requests made for data from that aget, either for CadleNet Portal workspace reports or situatio moitorig. This may take some experimetatio to determie. The objective of dividig moitorig duties amog two or more agets is to obtai a comfortable level of adequate respose time versus CPU usage (by all agets). * Refer to the maximumagetcollectiothreads parameter. ** Refer to the agetid parameter. Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 39

40 Activatig the CadleMoitor Node Activatig the CadleMoitor Node Itroductio I additio to the OMEGAMON XE for WebSphere MQ Itegrator moitorig aget described i the precedig sectios, aother itegral part of OMEGAMON XE for WebSphere MQ Itegrator is the CadleMoitor ode. This sectio itroduces the CadleMoitor ode ad explais how to itegrate it ito the broker eviromet ad itegrate it ito the WebSphere MQ Itegrator Cotrol Ceter. What is the CadleMoitor ode? The CadleMoitor ode collects statistics o message flow performace ad ca optioally produce evet messages that will be detected by OMEGAMON XE for WebSphere MQ Itegrator. The CadleMoitor ode is a simple pass-through ode with oe iput termial ad oe output termial. Messages passig through the CadleMoitor ode are propagated betwee its i ad out termials without chage. See the ext chapter for much more iformatio about the CadleMoitor ode. Broker itegratio of the CadleMoitor ode There are several actios that must be performed to itegrate the CadleMoitor ode ito the broker eviromets so that the moitorig of message flows ca occur. O OS/390 ad z/os To itegrate the CadleMoitor ode ito a broker eviromet o OS/390 or z/os, choose either the permaet itegratio procedure or the temporary itegratio procedure described i this sectio. Durig istallatio ad cofiguratio with CICAT, the "HFS Cadlehome directory" is created with a user-specified ame. That directory is idetified as <Cadlehome> i the statemets below. The broker's userid must have read access to all files ad subdirectories i the <Cadlehome>/kqi directory. 40 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

41 Activatig the CadleMoitor Node To permaetly itegrate the CadleMoitor ode ito a broker eviromet o OS/390 or z/os, follow these steps: 1. I the broker s compoet directory, fid ad edit the mqsicompcif file for the broker. Make the followig chages: Chage the "LILPATH=" statemet to add the Cadle path by appedig to the ed of the existig statemet: :<Cadlehome>/kqi/lil Chage the eviromet variable sectio to add the KQI_CONFIG_FILE_PATH variable by addig the followig lie after "(ENVIRONMENTBEGIN)" ad before "(ENVIRONMENTEND)": KQI_CONFIG_FILE_PATH=<Cadlehome>/kqi/lil 2. Save ad Exit the mqsicompcif file. 3. From the same broker compoet directory, issue the "mqsicustomize" commad. Note that oe of the chages made to the mqsicompcif file will require that you re-ru ay other customizatio job or commad. 4. Issue the followig commad i USS with a userid with proper authority. Replace <Cadlehome> as idicated at the begiig of this sectio, ad replace <IstallatioPath> with the broker's istallatio path: l -sf <Cadlehome>/kqi/messages/E_US/CadleMoitorNode.cat <IstallatioPath>/messages/E_US/CadleMoitorNode.cat 5. Restart the broker. Alteratively, you ca perform a temporary istallatio of a CadleMoitor ode. Temporary istallatio of the CadleMoitor ode will modify the broker's eviromet oly util the ext time mqsicustomize is ru, uless steps are take to make the chage permaet as described above. To temporarily itegrate the CadleMoitor ode ito a broker eviromet o OS/390 or z/os, follow the steps below. 1. I the broker s HFS compoet directory, fid ad edit the ENVFILE file for the broker. Make the followig chage: Add the followig statemet to the ed of the file: KQI_CONFIG_FILE_PATH=<Cadlehome>/kqi/lil 2. Save ad exit the ENVFILE. Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 41

42 Activatig the CadleMoitor Node 3. Issue the followig commad i USS with a userid with proper authority. Replace <Cadlehome> as idicated at the begiig of this sectio, ad replace <IstallatioPath> with the broker s istallatio path: l -sf <Cadlehome>/kqi/messages/E_US/CadleMoitorNode.cat <IstallatioPath>/messages/E_US/CadleMoitorNode.cat 4. Issue these commads, i order, o the z/os operator cosole. Where <STPN> is the broker s started task procedure ame ad <existig lil path> is the curret LILPATH defied i the mqsicompcif file. Note that these commads restart the broker compoet: F <STPN>,PC F <STPN>,CB L= <existig lil path>:<cadlehome>/kqi/lil F <STPN>,SC O UNIX The step to itegrate the CadleMoitor ode ito a broker eviromet o UNIX is documeted as part of istallatio (because root authority is required). Refer to the Advaced Aget Cofiguratio chapter of Istallig Cadle Products o UNIX. O Widows To itegrate the CadleMoitor ode ito a broker eviromet o Widows, follow the steps below. 1. Verify that the file kqipode.lil was copied ito the appropriate directory durig the istallatio of the OMEGAMON XE for WebSphere MQ Itegrator moitorig aget. If for ay reaso the file was ot able to be istalled ito the broker s bi directory, you must maually copy kqipode.lil from the directory: \Cadle\cma to the WebSphere MQ Itegrator bi directory o a system that is ruig a broker. A example of a typical bi locatio is: C:\Program Files\IBM\WebSphere MQ Itegrator 2.1\bi Also verify that the kqipode.lil file i the WebSphere MQ Itegrator bi directory exactly matches (i terms of size ad date-time) the oe that resides i the \Cadle\cma directory. A mismatch of the release-level of these files will cause a failure of the products s statistics ad message flow evets reportig. 42 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

43 Activatig the CadleMoitor Node 2. Verify that the OMEGAMON XE for WebSphere MQ Itegrator moitorig aget has bee properly cofigured as directed withi the product istallatio documetatio. 3. Restart your brokers so that the CadleMoitor ode ca be used. Cotrol Ceter itegratio of the CadleMoitor ode There are several actios that must be performed to itegrate the CadleMoitor ode ito the WebSphere MQ Itegrator Cotrol Ceter so that the moitorig of message flows ca occur. Follow the steps below: 1. Choose the appropriate CadleMoitor ode file. The CadleMoitor ode resides i a file that is created durig the istallatio of OMEGAMON XE for WebSphere MQ Itegrator. Several versios of this file are dowloaded alog with the product. Choose the CadleMoitor ode file that is appropriate for your versio of WebSphere MQ Itegrator: If you are usig WebSphere MQ Itegrator versio the use the CadleMoitor ode file amed amed kqicm201.exe. If you are usig WebSphere MQ Itegrator versio the use the CadleMoitor ode file amed amed kqicm202.exe. If you are usig WebSphere MQ Itegrator versio 2.1 the use the CadleMoitor ode file amed amed kqicm210.exe. If you used the istallatio locatio defaults, the file will reside i the followig locatio: C:\Cadle\cma Execute the CadleMoitor ode file o a system where the WebSphere MQ Itegrator Cotrol Ceter is istalled ad used. 2. Uzip (extract) the files cotaied withi the CadleMoitor ode file ito the directory where IBM s WebSphere MQ Itegrator is istalled. A example of a typical istallatio locatios would be: C:\Program Files\IBM\WebSphere MQ Itegrator 2.1\ Cofigurig OMEGAMON XE for WebSphere MQ Itegrator 43

44 Activatig the CadleMoitor Node 3. For the WebSphere MQ Itegrator Cotrol Ceter, the majority of the required files were properly placed i Step 2. However, the two files cotaied withi the CadleMoitor directory that was created uder the WebSphere MQ Itegrator directory must be copied to the followig locatio: C:\Program Files\IBM\WebSphere MQ Itegrator 2.1 \Tool\repository\private\<hostame>\<CofigMgr Qmgr Name>\MessageProcessigNodeType Note: The MessageProcessigNodeType directory level may have to be created if it does ot already exist. <hostame> is the ame of the host system for your cofiguratio maager. <CofigMgr Qmgr Name> is the ame of the queue maager associated with your Cofiguratio Maager. Both of these directory levels should already exist ad should ot have to be created. 4. Start the WebSphere MQ Itegrator Cotrol Ceter ad go to the Message Flows tab. 5. I the left pae, right-click o Message Flows, select Create, the click Message Flow Category. 6. Name the category Cadle ad fiish. 7. Right-click o the Cadle category, select Add, the click Message Flow. 8. I the list displayed, select CadleMoitor ad fiish. 9. Right-click o CadleMoitor, the select Check I. 10. Start usig the CadleMoitor ode i message flows. Refer to Usig the CadleMoitor Node o page 47 for iformatio cocerig ode placemet ad attribute settigs. Note: Steps must be take to itegrate the CadleMoitor ode ito your brokers eviromets prior to deployig a cofiguratio that uses the CadleMoitor ode to moitor your brokers. See Broker itegratio of the CadleMoitor ode o page 40 for more iformatio. 44 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

45 3 Usage Scearios Itroductio This chapter provides scearios that illustrate how you ca use OMEGAMON XE for WebSphere MQ Itegrator to meet your site s moitorig ad aalytical eeds. Chapter cotets Overview Usig the CadleMoitor Node Moitorig Applicatio Put ad Get Message Performace Determiig Applicatio Delivery Failure of Messages Debuggig a Message Flow Determiig Whe a Message Flow Has Failed Verifyig the Broker/Cotrol Ceter Cofiguratio Collectig Requested System Trace Data for a Broker o a Uavailable System Stoppig a Message Flow with a Full Output Queue Automatically Startig a Broker That Is Stopped Performig Broker Capacity Plaig Esurig Adequate Message Flow Respose Time Prevetig Iadvertet Use of Trace Active Startig ad Stoppig Message Flows at Periodic Itervals User Not Receivig All Publicatios to Subscriptios Usage Scearios 45

46 Overview Overview The goal of this sectio is to provide you with some examples of issues ad eeds commo to may WebSphere MQ Itegrator eviromets, ad show you how OMEGAMON XE for WebSphere MQ Itegrator would best be applied for maximum beefit i those situatios. Each sceario presets a case i which you will eed to moitor some aspect or compoet of your WebSphere MQ Itegrator eviromet, followed by a discussio of how to set up OMEGAMON XE for WebSphere MQ Itegrator to gather pertiet iformatio. 46 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

47 Usig the CadleMoitor Node Usig the CadleMoitor Node Itroductio This sectio describes how the CadleMoitor ode ca be used i message flows. The key to makig full use of OMEGAMON XE for WebSphere MQ Itegrator s moitorig ad aalytical potetial lies with the CadleMoitor ode. Recall that the CadleMoitor ode collects statistics o message flow performace ad ca optioally produce evet messages that will be detected by OMEGAMON XE for WebSphere MQ Itegrator. Messages passig through the CadleMoitor ode are propagated betwee its i ad out termials without chage. Positioig the CadleMoitor ode The primary use of the CadleMoitor ode is to produce the statistics which are displayed i the high-level statistics workspaces of this product (that is, the Broker Statistics, Executio Group Statistics, ad Message Flow Statistics workspaces). I order to esure that the correct statistics are gathered, it is importat that the ode be properly placed i message flows. Some geeral ode applicatios are discussed below. Moitorig the iput or output of a message flow Whe desigig a message flow to be moitored by OMEGAMON XE for WebSphere MQ Itegrator, a CadleMoitor ode should be placed just followig the MQIput ode. This permits the CadleMoitor ode to gather the iformatio required for iput rate calculatios. The type attribute of a CadleMoitor ode placed i this positio should be set to iput. If you oly wish to place a sigle CadleMoitor ode i a message flow, the iput positio is the best choice as most statistics are geerated from this positio. However, aother importat locatio for placig the CadleMoitor ode would be just before ay MQOutput, MQReply, or Publicatio ode, i order to permit output rate calculatios. I this istace, the type attribute of the CadleMoitor ode should be set to output. I determiig queue time statistics, queue times are calculated usig the Put date ad time of the message i the queue. This becomes a importat Usage Scearios 47

48 Usig the CadleMoitor Node cosideratio if the iput queue to a message flow will cotai messages with times that do ot accurately reflect whe the message was Put ito the iput queue. I this case, for a CadleMoitor ode with a type attribute of iput, the collectqueuetime attribute should be set to o so that queue times will ot be collected for these messages. Put date ad times are ot accurate idicators whe origi cotext is preserved for a message durig the Put by a applicatio to the iput queue to the message flow. This commoly occurs whe a applicatio is a message mover that trasfers messages from oe queue to aother, or whe ay applicatio passes or sets origi cotext for a message. I particular, if the iput queue to Message Flow B is the output queue of Message Flow A, WebSphere MQ Itegrator passes the origi cotext so that the Put date ad time for the message i Message Flow B will ot allow accurate calculatio of queue time. As such, the collectqueuetime attribute for a CadleMoitor ode placed i Message Flow B should be set to o. Moitorig other aspects of a message flow The placemet of the CadleMoitor ode is ot limited to the extremities of a message flow. It is possible to place the CadleMoitor ode aywhere withi a message flow ad gather statistics o that particular portio of the message flow. Whe placed i this cotext, the type attribute of the CadleMoitor ode should be set to other. The results are viewable i this product s low-level statistics workspace, the CadleMoitor Node Statistics workspace. Producig evet messages A secodary use of the CadleMoitor ode ivolves producig user-defied message flow evets that ca be detected i the Message Flow Evets situatios ad i the Message Flow Evets workspace. Whe placig the CadleMoitor ode for this purpose, the type attribute should be set to other. The evetmessage attribute should be set to display the message text that you wish to appear i the workspace whe the CadleMoitor ode has bee etered. OMEGAMON XE for WebSphere MQ Itegrator will iclude other iformatio cocerig the evet i order to help idetify which portio of the message flow was affected, as well as isolate which message was beig processed at the time the evet occurred. 48 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

49 Usig the CadleMoitor Node The placemet of the CadleMoitor ode for such evets is etirely at your discretio. However, it is ot recommeded that the ode be placed i portios of the message flow that are typically associated with ormal processig. For example, settig the evetmessage attribute for ay iput or output type ode would produce a udesirable umber of evets. Istead, it is recommeded that this feature is best used i paths of a message flow that represet processig failures or other irregular coditios that warrat a alert evet otificatio. Note that i this capacity, the CadleMoitor ode oly serves as a alert mechaism ad caot perform error recovery as it is a pass-through ode oly. Summary of CadleMoitor ode properties Set the properties of the CadleMoitor ode whe you place it i a message flow usig the WebSphere MQ Itegrator Cotrol Ceter. Optios are: The type attribute determies the type of statistics gathered. It ca be set to: iput - to record etry of messages ito the message flow. For example, specify iput whe placig the CadleMoitor ode just followig the MQIput ode. output - to record exit of messages from the message flow. For example, specify output whe placig the CadleMoitor ode just before ay MQOutput, MQReply, or Publicatio ode. other - to gather statistics o a particular portio of the message flow. For example, specify other whe placig the CadleMoitor ode wherever ecessary to debug your message flows. (This is the default value.) The collectqueuetime attribute specifies whether the ode should collect queue timigs. It ca be set to: o - queue times will ot be collected for these messages. yes - queue times will be collected for these messages. (This is the default value.) The evetmessage attribute causes a evet to be produced whe the ode is etered if the value is set to other tha. It ca be used to: specify message text for otificatio whe debuggig usig type other. For example specify text to iclude i a alert. (The default value for evetmessage is.) Usage Scearios 49

50 Moitorig Applicatio Put ad Get Message Performace Moitorig Applicatio Put ad Get Message Performace Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used i a performace moitorig situatio where the put ad get message time betwee applicatios is excessively log. CadleMoitor ode requiremets To properly determie the time take for oe applicatio to get the messages that were put by aother applicatio, you will eed two CadleMoitor odes withi the moitored message flow: Place oe CadleMoitor ode just followig the MQIput ode so that the etry of the message ito the message flow will be recorded. The type attribute for this CadleMoitor ode must be set to iput. Place oe CadleMoitor ode just prior to the MQOutput ode so that the exit of the message from the message flow will be recorded. The type attribute for this CadleMoitor ode must be set to output. What you will eed to do Oce you have placed ad set the CadleMoitor odes as described above, allow OMEGAMON XE for WebSphere MQ Itegrator to ru so that the product ca gather the appropriate statistics, the do the followig: 1. Ope the Message Flow Statistics workspace ad examie the results for the Curret Average Queue Time ad Curret Average Flow Time attributes. For a detailed descriptio of these attributes ad their values, refer to the Help for OMEGAMON XE for WebSphere MQ Itegrator. 2. If you determie that the results reported for the Curret Average Queue Time attribute are excessively log, the you should cosider icremetig the Additioal Istaces value for the moitored message flow. Additioal Istaces specifies the umber of additioal istaces of the message flow that the executio group should ru to allow for more multi-processig of messages. 50 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

51 Moitorig Applicatio Put ad Get Message Performace 3. If you determie that the results reported for the Curret Average Flow Time are excessively log, the you will eed to debug the moitored message flow. To perform this task, you will eed to add CadleMoitor odes before each processig ode i the message flow. This will help you determie which ode is causig the problem. The type attribute for these CadleMoitor odes must be set to other. See Debuggig a Message Flow o page 54. Usage Scearios 51

52 Determiig Applicatio Delivery Failure of Messages Determiig Applicatio Delivery Failure of Messages Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used i a situatio where messages destied for a applicatio are ot beig received by that applicatio. CadleMoitor ode requiremets To properly determie the message cout for messages set from oe applicatio to aother, you will eed two CadleMoitor odes withi the moitored message flow: Place oe CadleMoitor ode just followig the MQIput ode so that the etry of the message ito the message flow will be recorded. The type attribute for this CadleMoitor ode must be set to iput. Place oe CadleMoitor ode just prior to the MQOutput ode so that the exit of the message from the message flow will be recorded. The type attribute for this CadleMoitor ode must be set to output. What you will eed to do Oce you have placed ad set the CadleMoitor odes as described above, allow OMEGAMON XE for WebSphere MQ Itegrator to ru so that the product ca gather the appropriate statistics, the do the followig: 1. Ope the Message Flow Iformatio workspace ad examie the results for the Status attribute. The Status colum for the moitored message flow should have a value of Started. 2. Ope the Message Flow Statistics workspace ad examie the results for the Curret Message Iput Cout versus the Curret Message Output Cout attributes. A discrepacy betwee these values idicates that messages are beig lost i the moitored message flow. For a detailed descriptio of these attributes ad their values, refer to the Help for OMEGAMON XE for WebSphere MQ Itegrator. 52 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

53 Determiig Applicatio Delivery Failure of Messages 3. Ope the Message Flow Evets workspace ad determie whether there were ay possible exceptios caused by a ode member of the moitored message flow. For iformatio o the workspace, refer to Message Flow Evets Workspace o page 103. Usage Scearios 53

54 Debuggig a Message Flow Debuggig a Message Flow Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used to debug the operatio of a message flow. CadleMoitor ode requiremets To properly determie which ode i the message flow is causig a problem, you will eed to place a CadleMoitor ode before each processig ode withi the message flow. The type attribute for these CadleMoitor odes must be set to other. What you will eed to do Oce you have placed ad set the CadleMoitor odes as described above, allow OMEGAMON XE for WebSphere MQ Itegrator to ru so that the product ca gather the appropriate statistics, the do the followig: 1. Ope the CadleMoitor Node Statistics workspace ad examie the results for the flow times of the CadleMoitor odes i the message flow. For more iformatio o the workspace, refer to CadleMoitor Node Statistics Workspace o page Compare statistics for odes that are adjacet i the message flow. The differeces i flow times for the CadleMoitor odes will provide the time spet by a message i ay oe of the processig odes i the message flow. 3. Perform a similar compariso for each CadleMoitor ode withi the message flow util you determie which processig ode is producig the udesirable results. 54 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

55 Determiig Whe a Message Flow Has Failed Determiig Whe a Message Flow Has Failed Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used to determie ad otify you of a failure withi a message flow. CadleMoitor ode requiremets To determie whe a message flow has failed, you will eed to place CadleMoitor odes as eeded after failure termials. The type attribute for these CadleMoitor odes must be set to other, ad you should iput text ito the evetmessage attribute that describes the failure i a meaigful way. What you will eed to do Oce you have placed ad set the CadleMoitor odes as described above, allow OMEGAMON XE for WebSphere MQ Itegrator to ru so that the product ca gather the appropriate statistics, the do the followig: 1. Use CadleNet Portal to defie situatios for Message Flow Evets so that a alert will be raised each time a message flows dow a failure path. If ecessary, refer to CadleNet Portal olie Help or the Admiisterig OMEGAMON Products: CadleNet Portal guide for iformatio o defiig a situatio. Usage Scearios 55

56 Verifyig the Broker/Cotrol Ceter Cofiguratio Verifyig the Broker/Cotrol Ceter Cofiguratio Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used to verify that the broker cofiguratio matches your expected cofiguratio as depicted i the WebSphere MQ Itegrator Cotrol Ceter. What you will eed to do Oce you have cofigured OMEGAMON XE for WebSphere MQ Itegrator, allow the product to ru so that the product ca gather the appropriate iformatio, the do the followig: 1. Examie the various Iformatio workspaces, such as Executio Group Iformatio, Message Flow Iformatio, Message Processig Node Iformatio, Neighbors, Subscriptios, Retaied Publicatios, ad ACL Etries. These workspaces cotai data from the broker perspective as opposed to the WebSphere MQ Itegrator Cofiguratio Maager or the WebSphere MQ Itegrator Cotrol Ceter perspective. 2. To determie if the proper cofiguratio was deployed to the broker, compare the data withi the workspaces with what you expected. 56 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

57 Collectig Requested System Trace Data for a Broker o a Uavailable System Collectig Requested System Trace Data for a Broker o a Uavailable System Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used to collect IBM s requested System trace data for a broker that is located upo a system that is ot physically available to you. What you will eed to do Oce you have cofigured OMEGAMON XE for WebSphere MQ Itegrator, allow the product to ru so that the product ca gather the appropriate iformatio, the do the followig: 1. Ope the Take Actio pael withi CadleNet Portal. If ecessary, refer to the CadleNet Portal olie Help for iformatio o performig this procedure. 2. Issue the QI Chage Trace Broker commad with the destiatio set to the appropriate broker. For additioal detail about the QI Chage Trace Broker commad, refer to Take Actio Commads o page 73. Usage Scearios 57

58 Stoppig a Message Flow with a Full Output Queue Stoppig a Message Flow with a Full Output Queue Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used to quickly stop a message flow that is failig due to a full output queue. This sceario is iteded for users who do ot always start Cofiguratio Maager ad Cotrol Ceter so that they may coserve system resources. What you will eed to do Oce you have cofigured OMEGAMON XE for WebSphere MQ Itegrator, allow the product to ru so that the product ca gather the appropriate iformatio, the do the followig: 1. Ope the Take Actio pael withi CadleNet Portal. If ecessary, refer to the CadleNet Portal olie Help for iformatio o performig this procedure. 2. Issue the QI Stop Message Flow(s) commad with the destiatio set to the appropriate broker. Set the argumets to the appropriate executio group ad message flow ames. For additioal detail about the QI Stop Message Flow(s) commad, refer to Take Actio Commads o page OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

59 Automatically Startig a Broker That Is Stopped Automatically Startig a Broker That Is Stopped Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used to automatically restart a broker aytime that it is stopped. What you will eed to do Oce you have cofigured OMEGAMON XE for WebSphere MQ Itegrator, allow the product to ru so that the product ca gather the appropriate iformatio, the do the followig: 1. Use CadleNet Portal to defie a situatio for the Broker Iformatio workspace to check if the Broker Status is ot Started. If ecessary, refer to CadleNet Portal olie Help or the Admiisterig OMEGAMON Products: CadleNet Portal guide for iformatio o defiig a situatio. 1. Set the actio for the situatio to use the QI Start Broker reflex automatio/take actio commad to restart the broker. For additioal detail about the QI Start Broker commad, refer to Take Actio Commads o page 73. Note: There is a predefied situatio for the Compoets workspace that ca be used for the same purpose, but that situatio will also start the Cofiguratio Maager or User Name Server if either of these stops. Usage Scearios 59

60 Performig Broker Capacity Plaig Performig Broker Capacity Plaig Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used to help you perform capacity plaig for your brokers. CadleMoitor ode requiremets To properly determie the message cout for messages set from oe applicatio to aother, you will eed two CadleMoitor odes withi the moitored message flow: Place oe CadleMoitor ode just followig the MQIput ode so that the etry of the message ito the message flow will be recorded. The type attribute for this CadleMoitor ode must be set to iput. Place oe CadleMoitor ode just prior to the MQOutput ode so that the exit of the message from the message flow will be recorded. The type attribute for this CadleMoitor ode must be set to output. What you will eed to do Oce you have placed ad set the CadleMoitor odes as described above, allow OMEGAMON XE for WebSphere MQ Itegrator to ru so that the product ca gather the appropriate statistics, the do the followig: 1. Ope the various Statistics workspaces, such as Message Flow Statistics for idividual message flows, Executio Group Statistics for summarizatio over a etire executio group, or Broker Statistics for summarizatio over a etire broker. 2. Examie the workspace statistics ad further lik to their historical workspaces as well. If ecessary, refer to the CadleNet Portal olie Help for iformatio o performig this procedure. 3. If you fid that for a particular message flow the Curret Message Iput Rate is higher tha expected, or the Curret Average Queue Time is elogated, add more istaces to the flow withi Cotrol Ceter. 60 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

61 Performig Broker Capacity Plaig 4. If you fid that for a particular executio group the Curret Message Iput Rate is higher tha expected, or the Curret Average Queue Time is elogated, add a ew executio group ad assig istaces as appropriate. 5. If you fid that for a particular broker the Curret Message Iput Rate is higher tha expected, or the Curret Average Queue Time is elogated, cosider addig a ew broker with a cofiguratio that will offload some processig from the curret broker. Usage Scearios 61

62 Esurig Adequate Message Flow Respose Time Esurig Adequate Message Flow Respose Time Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used to help you esure that the respose times from your message flows are adequate to meet your site s eeds. CadleMoitor ode requiremets To properly determie the message cout for messages set from oe applicatio to aother, you will eed two CadleMoitor odes withi the moitored message flow: Place oe CadleMoitor ode just followig the MQIput ode so that the etry of the message ito the message flow will be recorded. The type attribute for this CadleMoitor ode must be set to iput. Place oe CadleMoitor ode just prior to the MQOutput ode so that the exit of the message from the message flow will be recorded. The type attribute for this CadleMoitor ode must be set to output. What you will eed to do Oce you have placed ad set the CadleMoitor odes as described above, allow OMEGAMON XE for WebSphere MQ Itegrator to ru so that the product ca gather the appropriate statistics, the do the followig: 1. Ope the Message Flow Statistics workspace for idividual message flows. For a detailed descriptio of these attributes ad their values, refer to the Help for OMEGAMON XE for WebSphere MQ Itegrator. 2. Examie the workspace statistics ad further lik to their historical workspaces as well. If ecessary, refer to the CadleNet Portal olie Help for iformatio o performig this procedure. 3. If you fid that for a particular message flow the Curret Average Flow Time is higher tha expected, debug the message flow as described i Debuggig a Message Flow o page 54. Comparig the Average Flow Times for each sectio of the message flow will help you idetify where time is beig lost. 62 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

63 Prevetig Iadvertet Use of Trace Active Prevetig Iadvertet Use of Trace Active Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used guard agaist trace active iadvertetly beig used ad affectig broker performace. What you will eed to do Oce you have cofigured OMEGAMON XE for WebSphere MQ Itegrator, allow the product to ru so that the product ca gather the appropriate iformatio, the do the followig: 1. Use CadleNet Portal to defie a situatio for the Broker Iformatio, Executio Group Iformatio, ad Message Flow Iformatio workspaces to check that the Trace Level ad User Trace Level attributes are ot equal to oe. This will trigger a alert wheever trace is active so that you ca determie whether the tracig activity is valid. If ecessary, refer to CadleNet Portal olie Help or the Admiisterig OMEGAMON Products: CadleNet Portal guide for iformatio o defiig a situatio. Usage Scearios 63

64 Startig ad Stoppig Message Flows at Periodic Itervals Startig ad Stoppig Message Flows at Periodic Itervals Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used to automatically start ad stop message flows at certai times of the day. What you will eed to do Oce you have cofigured OMEGAMON XE for WebSphere MQ Itegrator, allow the product to ru so that the product ca gather the appropriate iformatio, the do the followig: For idividual message flows 1. Use CadleNet Portal to defie a situatio for the Message Flow Iformatio workspace s Status attribute with additioal matches for the Local Time attribute. This will determie whe a message flow should be started or stopped. If ecessary, refer to CadleNet Portal olie Help or the Admiisterig OMEGAMON Products: CadleNet Portal guide for iformatio o defiig a situatio. 2. Set the actio for the situatio to use the QI Start Message Flow(s) or QI Stop Message Flow(s) reflex automatio/take actio commad to start or stop the message flow by specifyig both the executio group ame argumet as well as the message flow ame argumet. For all message flows withi a executio group 1. Use CadleNet Portal to defie a situatio for the Executio Group Iformatio workspace s Started Message Flows attribute with additioal matches for the Local Time attribute. This will determie whe all message flows withi the executio group should be started or stopped. If ecessary, refer to CadleNet Portal olie Help or the Admiisterig OMEGAMON Products: CadleNet Portal guide for iformatio o defiig a situatio. 2. Set the actio for the situatio to use the QI Start Message Flow(s) or QI Stop Message Flow(s) reflex automatio/take actio commad to start or stop all message flows by specifyig oly the executio group ame argumet 64 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

65 Startig ad Stoppig Message Flows at Periodic Itervals ad o message flow ame argumet. For additioal detail about the QI Start Message Flow(s) or QI Stop Message Flow(s) commads, refer to Take Actio Commads o page 73. Usage Scearios 65

66 User Not Receivig All Publicatios to Subscriptios User Not Receivig All Publicatios to Subscriptios Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used by a applicatio user with o access to the Cotrol Ceter to verify their subscriptios. What you will eed to do Oce you have cofigured OMEGAMON XE for WebSphere MQ Itegrator, allow the product to ru so that the product ca gather the appropriate iformatio, the do the followig: 1. Ope the Subscriptios workspace for each broker from which the user expects their applicatio to be receivig publicatios. 2. If the user s subscriptio oly appears i a sigle broker, examie the report data to determie if the user has specified the Local optio for the subscriptio by viewig the Local Oly colum for a value of Yes. This settig will prevet the subscriptio from beig propagated to eighborig brokers. 66 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

67 User s Subscriptio to Topic Fails Security User s Subscriptio to Topic Fails Security Itroductio This sceario describes how OMEGAMON XE for WebSphere MQ Itegrator ca be used whe a user s applicatio attempts to subscribe to a topic ad fails security. What you will eed to do Oce you have cofigured OMEGAMON XE for WebSphere MQ Itegrator, allow the product to ru so that the product ca gather the appropriate iformatio, the do the followig: 1. Ope the ACL Etries workspace to determie if the applicatio s user ID matches a Pricipal that is allowed Subscribe access to the desired topic, or if its user ID is a member of a group that matches a Pricipal which allows Subscribe access to the topic. Usage Scearios 67

68 User s Subscriptio to Topic Fails Security 68 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

69 4 Situatios ad Take Actio Commads Itroductio This chapter describes the predefied situatios ad take actio commads provided with OMEGAMON XE for WebSphere MQ Itegrator. Chapter cotets Predefied Situatios Take Actio Commads Situatios ad Take Actio Commads 69

70 Predefied Situatios Predefied Situatios Itroductio OMEGAMON XE for WebSphere MQ Itegrator provides predefied situatios. Most predefied situatios are desiged to eable you to moitor critical activity ad serve as templates for creatig customized situatios for your ow use. The predefied situatios for this product have ames which begi with the letters QI. Predefied situatios are activated oce they are distributed to the ode that you wish to moitor. Oce they have bee cofigured correctly, the situatio alerts provided with OMEGAMON XE for WebSphere MQ Itegrator will trigger evet otificatio. For iformatio o creatig or modifyig situatios, refer to CadleNet Portal olie Help or the Admiisterig OMEGAMON Products: CadleNet Portal guide. Note: Cadle suggests that, if you choose to modify a predefied situatio, you first make a copy to esure fallback if ecessary. Alerts The followig situatios issue alerts based o critical status criteria. Except where oted, these situatios apply to broker maaged systems. Alerts will be raised if: The Broker Iformatio.Broker Status value is foud to be ot started. (QI_Broker_Not_Started) The Broker Iformatio.Queue Maager Status value is foud to be ot coected. (QI_Broker_QMgr_Not_Coected) A Broker Evets row occurs for a Status Stop evet. (QI_Status_Stop_Evet) A Message Flow Evets row occurs. (QI_Message_Flow_Evets) 70 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

71 Predefied Situatios A Product Evets row occurs. This situatio applies to aget maaged systems. (QI_Product_Evets) A Broker Evets row occurs for a Publicatio Expiratio evet type. (QI_Publicatio_Expiry_Evet) A Broker Evets row occurs for a Subscriptio Expiratio evet type. (QI_Subscriptio_Expiry_Evet) The Message Flow Statistics.Average Flow Secods value is foud to exceed a threshold. (QI_Average_Flow_Time High) The Compoets.Compoet Status value is foud to be ot started. This situatio demostrates reflex automatio: if the situatio becomes true, the proper commad is issued to start the compoet. This situatio applies to aget maaged systems. (QI_Automatio_Start_Compoet) Historical situatios The followig situatios are provided to track table data historically. Except where oted, these situatios apply to broker maaged systems. Historical data is available by specifyig time-spas i a workspace for a report. The followig historical situatios are active upo product istallatio: A Broker Iformatio log etry is added every 15 miutes (oe row per broker). If a Broker Evets row occurs, a etry is added to the historical log. If a Message Flow Evets row occurs, a etry is added to the historical log. If a Product Evets row occurs, a etry is added to the historical log. This situatio applies to aget maaged systems. A Broker Statistics log etry is added every 15 miutes (oe row per broker). A Executio Group Statistics log etry is added every 15 miutes (oe row per executio group). Situatios ad Take Actio Commads 71

72 Predefied Situatios A Message Flow Statistics log etry is added every 15 miutes (oe row per message flow per executio group). A CadleMoitor Node Statistics log etry is added every 15 miutes (oe row per ode per CadleMoitor ode). A Compoets log etry is added every 15 miutes (oe row per WebSphere MQ Itegrator compoet created o your system). This situatio applies to aget maaged systems. The followig historical situatios are iactive upo product istallatio. To activate them, you must activate historical data collectio for the idicated product attribute group. Note each attribute group correspods to a product workspace. Iformatio about usig the Historical Data Collectio fuctio ca be foud i the CadleNet Portal olie Help ad i the Historical Data Collectio Guide for OMEGAMON XE ad CadleNet Commad Ceter. A Executio Group Iformatio log etry is added every 15 miutes (oe row per executio group). A Message Flow Iformatio log etry is added every 15 miutes (oe row per message flow). A Message Processig Node Iformatio log etry is added every 15 miutes (oe row per message processig ode). A Neighbors log etry is added every 15 miutes (oe row per eighbor coectio). A ACL Etries log etry is added every 15 miutes (oe row ACL etry per topic). A Subscriptios log etry is added every 15 miutes (oe row per subscriptio). A Retaied Publicatios log etry is added every 15 miutes (oe row per retaied publicatio). 72 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

73 Take Actio Commads Take Actio Commads Itroductio Take Actio commads allow you to quickly iitiate commads from withi OMEGAMON XE for WebSphere MQ Itegrator. These commads would otherwise have to be etered either from a commad prompt, or from the WebSphere MQ Itegrator Cotrol Ceter. You ca ivoke the commads preseted here from the Take Actio view, from a situatio (whe it becomes true), from the Navigator, or from a row i a table view. For more iformatio o how to sed a commad, refer to the CadleNet Portal olie Help. The Take Actio commads for this product (commads set to this product s aget) have ames which begi with the characters QI:. Who ca issue Take Actio commads? You ca cofigure OMEGAMON XE for WebSphere MQ Itegrator so that oly a desigated set of users ca successfully issue its Take Actio commads. Authorized Take Actio users ca be specified: at the aget level, usig the defaulttakeactioauthusers parameter. at the moitored broker level, usig the takeactioauthusers parameter. See Aget parameter descriptios o page 33 for details. Commad restrictios o OS/390 ad z/os O OS/390 ad z/os: The Take Actio commads for OMEGAMON XE for WebSphere MQ Itegrator require the broker ame to be the same as the started task procedure ame that is started or stopped for the broker. O OS/390 ad z/os: This product will ot start or stop a queue maager. If you fid it ecessary to issue a commad that is ot supported by the aget, you ca issue it as a system commad (a OS/390 cosole commad) istead. Use the exact sytax of the commad as documeted by IBM. Note that the exact commad issued by the aget varies based o the host platform o which the aget rus (chiefly for OS/390 ad z/os). Also, Situatios ad Take Actio Commads 73

74 Take Actio Commads although the commads ca be issued by the aget o all supported platforms, some differeces exist i the supported actios (agai, chiefly for OS/390 ad z/os). Differeces i actios, if they exist, are oted for each commad. Commads for aget maaged systems The Take Actio commads for OMEGAMON XE for WebSphere MQ Itegrator aget maaged systems are described below. Note: The ame of the Compoet i the commads described below ca be a broker ame, CofigMgr (o Widows), or UserNameServer uless otherwise oted. QI Start Compoet The QI Start Compoet commad starts a WebSphere MQ Itegrator compoet. O UNIX ad Widows: This commad will also start the compoet's associated queue maager if it is ot already active. O Widows oly: This commad ca also be used to start the cofiguratio maager (compoet=cofigmgr). O OS/390 ad z/os: This product will ot start a queue maager, see Commad restrictios o OS/390 ad z/os o page 73. This commad caot be used to start a user ame server (compoet=usernameserver). Idetify the compoet to be started by specifyig its ame withi the Edit Argumet pop-up. The destiatio of this commad must be set to the aget maaged system. The sytax of the commad set to the aget is: QI:mqsiStart CompoetName QI Stop Compoet The QI Stop Compoet commad stops a WebSphere MQ Itegrator compoet. O Widows oly: This commad ca also be used to stop the cofiguratio maager (compoet=cofigmgr). 74 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

75 Take Actio Commads O OS/390 ad z/os: This commad caot be used to stop a user ame server (compoet=usernameserver). Idetify the compoet to be stopped by specifyig its ame withi the Edit Argumet pop-up. The destiatio of this commad must be the aget maaged system. The sytax of the commad set to the aget is: QI:mqsiStop CompoetName QI Stop Compoet ad its Queue Maager O UNIX ad Widows: The QI Stop Compoet ad its Queue Maager commad stops the WebSphere MQ Itegrator compoet ad its associated queue maager. O Widows oly: This commad ca also be used to stop the cofiguratio maager (compoet=cofigmgr). O OS/390 ad z/os: This product will ot stop a queue maager see Commad restrictios o OS/390 ad z/os o page 73. Therefore the actio of the QI Stop Compoet ad its Queue Maager commad is the same as for the QI Stop Compoet commad; it stops a WebSphere MQ Itegrator compoet. Idetify the compoet to be stopped by specifyig its ame withi the Edit Argumet pop-up. The destiatio of this commad must be the aget maaged system. The sytax of the commad set to the aget is: QI:mqsiStop-q CompoetName QI Chage Trace Compoet The QI Chage Trace Compoet commad chages the trace characteristics for WebSphere MQ Itegrator compoets. O Widows oly: This commad ca also be used to chage trace characteristics for the cofiguratio maager (compoet=cofigmgr). Idetify the compoet by specifyig its ame withi the top field of the Edit Argumet pop-up. If the compoet ame cotais spaces, the etire strig must be eclosed withi two sets of double quotes (for example, aaaaaa bbbb cc ). Specify the ew trace parameters withi the lower field of the Edit Situatios ad Take Actio Commads 75

76 Take Actio Commads Argumet pop-up. The format of the argumet should use the same format as used by IBM's mqsichagetrace commad, usig two sets of double quotes for ay double quotes used. For chage trace commads targeted to z/os brokers, follow the IBM Customizatio ad Admiistratio Guide precisely for the chagetrace commad parameters, except use two sets of double quotes istead of sigle quotes. Remember that o z/os ay lowercase label ames must be i quotes, ad commas must separate parameters. For example, o OS/390 ad z/os, supply this argumet to tur o ormal trace for the default executio group: u=yes,e=""default"",l=ormal O aother broker platform, the followig argumet has the same result: -u -e default -l ormal The destiatio of this commad must be the aget maaged system. The sytax of the commad set to the aget is: QI:mqsiChageTrace CompoetName Parms Commads for broker maaged systems The Take Actio commads for OMEGAMON XE for WebSphere MQ Itegrator broker maaged systems are described below. QI Start Broker The QI Start Broker commad starts a WebSphere MQ Itegrator broker. O OS/390 ad z/os: The product does ot curretly support the f broker,startcompoet commad form of startig the broker. The s broker commad form is used. Specify the ame of the broker to be started withi the Edit Argumet pop-up. The destiatio of this commad must be a broker maaged system. The sytax of the commad set to the aget is: QI:mqsiStart BrokerName QI Stop Broker The QI Stop Broker commad stops a WebSphere MQ Itegrator broker. 76 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

77 Take Actio Commads O OS/390 ad z/os: The product does ot curretly support the f broker,stopcompoet commad form of stoppig the broker. The p broker commad form is used. Specify the ame of the broker to be stopped withi the Edit Argumet pop-up. The destiatio of this commad must be a broker maaged system. The sytax of the commad set to the aget is: QI:mqsiStop BrokerName QI Stop Broker ad its Queue Maager O UNIX ad Widows: The QI Stop Broker ad its Queue Maager commad stops the WebSphere MQ Itegrator broker ad its associated queue maager. O OS/390 ad z/os: This product will ot stop a queue maager see Commad restrictios o OS/390 ad z/os o page 73. Therefore the actio of the QI Stop Broker ad its Queue Maager commad is the same as for the QI Stop Broker commad; it stops a WebSphere MQ Itegrator broker. Specify the ame of the broker to be stopped withi the Edit Argumet pop-up. The destiatio of this commad must be a broker maaged system. The sytax of the commad set to the aget is: QI:mqsiStop-q BrokerName QI Chage Trace Broker The QI Chage Trace Broker commad chages the trace characteristics for WebSphere MQ Itegrator brokers. Idetify the broker by specifyig its ame withi the top field of the Edit Argumet pop-up. If the broker ame cotais spaces, the etire strig must be eclosed withi two sets of double quotes (for example, aaaaaa bbbb cc ). Specify the ew trace parameters withi the lower field of the Edit Argumet pop-up. The format of the argumet should use the same format as used by IBM's mqsichagetrace commad, usig two sets of double quotes for ay double quotes used. For chage trace commads targeted to z/os brokers, follow the IBM Customizatio ad Admiistratio Guide precisely for the chagetrace commad parameters, except use two sets of double quotes Situatios ad Take Actio Commads 77

78 Take Actio Commads istead of sigle quotes. Remember that o z/os ay lowercase label ames must be i quotes, ad commas must separate parameters. For example, o OS/390 ad z/os, supply this argumet to tur o ormal trace for the default executio group: u=yes,e=""default"",l=ormal O aother broker platform, the followig argumet has the same result: -u -e default -l ormal The destiatio of this commad must be a broker maaged system. The sytax of the commad set to the aget is: QI:mqsiChageTrace BrokerName Parms QI Start Message Flow(s) The QI Start Message Flow(s) commad starts oe or all of the message flows associated with a executio group. Idetify the executio group to which the message flow belogs withi the top field of the Edit Argumet pop-up. Specify the message flow to be started withi the lower field of the Edit Argumet pop-up. Leavig the lower field blak will cause the commad to start all message flows withi the executio group. The destiatio of this commad must be a broker maaged system. The sytax of the commad set to the aget is: QI:mflowStart ExecutioGroup MessageFlow QI Stop Message Flow(s) The QI Stop Message Flow(s) commad stops oe or all of the message flows associated with a executio group. Idetify the executio group to which the message flow belogs withi the top field of the Edit Argumet pop-up. Specify the message flow to be stopped withi the lower field of the Edit Argumet pop-up. Leavig the lower field blak will cause the commad to stop all message flows withi the executio group. The destiatio of this commad must be a broker maaged system. The sytax of the commad set to the aget is: QI:mflowStop ExecutioGroup MessageFlow 78 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

79 Take Actio Commads QI Delete Retaied Publicatio The QI Delete Retaied Publicatio commad deletes a retaied publicatio for the give topic ad subscriptio poit. Idetify the topic of the publicatio to be deleted withi the top field of the Edit Argumet pop-up. Idetify the subscriptio poit of the publicatio to be deleted withi the lower field of the Edit Argumet pop-up. If o subscriptio poit is specified, the publicatio for the default subscriptio poit will be deleted. The destiatio of this commad must be a broker maaged system. The sytax of the commad set to the aget is: QI:retaiedPubDelete Topic SubscriptioPoit Usig take actio commads i situatios You ca use the commads described i this sectio i situatios that you write. This feature of situatios is built-i to OMEGAMON products ad is documeted i CadleNet Portal olie Help ad i the Admiisterig OMEGAMON Products: CadleNet Portal guide. The term reflex automatio refers to a situatio that issues a commad. To issue oe of this aget s commads from a situatio, eter the QI: sytax form of the commad o the Actio tab of the Situatios Editor. Show below is a example of the QI Start Compoet commad used i a situatio. This example is from predefied situatio QI_Automatio_Start_Compoet, which substitutes a attribute from this product s Compoets workspace. The Attribute Subsitutio butto was used to choose the attribute (this prevets misspelligs ad iserts the ampersad character which is eeded for attribute substitutio). Note that the sigle quotes eclosig the commad parameter are required. I all cases we recommed that you create a workig, maual versio of a Take Actio commad before attemptig to automate its use by addig it to a situatio. Situatios ad Take Actio Commads 79

80 Take Actio Commads 80 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

81 5 Workspaces Itroductio This chapter itroduces the workspaces provided i the OMEGAMON XE for WebSphere MQ Itegrator user iterface. Chapter cotets Overview ACL Etries Workspace Aget Status Workspace (aget-level summary) Broker Evets Workspace Broker Iformatio Workspace Broker Statistics Workspace Broker Status Workspace (broker-level summary) Broker Summary Workspace (multiple brokers moitored) CadleMoitor Node Statistics Workspace Compoets Workspace Executio Group Iformatio Workspace Executio Group Statistics Workspace Message Flow Evets Workspace Message Flow Iformatio Workspace Message Flow Statistics Workspace Message Processig Node Attributes Workspace Message Processig Node Iformatio Workspace Message Processig Nodes Neighbors Workspace Product Evets Workspace Retaied Publicatios Workspace Subscriptios Workspace Workspaces 81

82 Overview Overview About workspaces OMEGAMON XE for WebSphere MQ Itegrator is istalled with default views that are displayed i workspaces. Where applicable, liks have bee provided withi the workspace to lik from a paret view to a more detailed view about a selected row, or to a related workspace (for example, a workspace cotaiig historical iformatio). The format ad appearace of the views withi a workspace may be customized to suit your prefereces. For iformatio o customizig workspaces ad views, refer to the CadleNet Portal olie Help. For detailed desriptios of idividual attributes withi a workspace, refer to the Help for OMEGAMON XE for WebSphere MQ Itegrator. 82 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

83 ACL Etries Workspace ACL Etries Workspace Descriptio The ACL Etries workspace is selectable for the broker maaged system. It displays Access Cotrol List etries per topic, which defie access to topics for publish ad subscribe. Default views This workspace cotais the followig default views: Eterprise Evet Log shows, as a table, all situatios raised for the eterprise. ACL Etries shows, as a table, all ACL Etries for the broker. Iformatio preseted i the ACL Etries table view The ACL Etries table view displays data provided by the ACL Etries attributes, which are: Broker Publish Origi Node Subscribe Persistet Topic Pricipal For a detailed descriptio of these attributes ad their values, refer to the Help for OMEGAMON XE for WebSphere MQ Itegrator. Workspaces 83

84 Aget Status Workspace (aget-level summary) Aget Status Workspace (aget-level summary) Descriptio The Aget Status workspace is selectable for the aget maaged system. It summarizes evet ad WebSphere MQ Itegrator compoet iformatio at the aget level. Default views This workspace cotais the followig default views: Product Evets shows, as a table, the most recet retaied product evets. Compoets shows, as a table, all created compoets o the system that the aget is moitorig. Accessig this workspace To access this workspace, i the Navigator physical view select the WMQI Aget folder ico. 84 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

85 Broker Evets Workspace Broker Evets Workspace Descriptio The Broker Evets workspace is selectable for the broker maaged system. This workspace lists evets geerated by the WebSphere MQ Itegrator broker as they occur. The umber of evets show depeds o the umber retaied by the aget as set withi the aget parameter file. The aget receives broker evets data by meas of a subscriptio to WebSphere MQ Itegrator broker evets publicatios. If a particular evet is ot published by WebSphere MQ Itegrator the it is ot available for display i this workspace. Note Broker Evets attributes are ot recommeded as a situatio mechaism for detectig the status of a broker. Istead, use the Broker_Iformatio.Broker_Status attribute for this purpose, as demostrated i the product-provided situatios. Default views This workspace cotais the followig default views: Eterprise Evet Log shows, as a table, all situatios raised for the eterprise. Broker Evets shows, as a table, the most recet retaied broker evets. Iformatio preseted i the Broker Evets table view The Broker Evets table view displays data provided by the Broker Evets attributes, which are: Broker Evet Evet Date ad Time Evet Qualifier 1 Evet Qualifier 2 Evet Type Origi Node Qualifier Descriptio 1 Qualifier Descriptio 2 For a detailed descriptio of these attributes ad their values, refer to the Help for OMEGAMON XE for WebSphere MQ Itegrator. Workspaces 85

86 Broker Evets Workspace Note the Broker Evets attributes also provide data for the Broker Evets History workspace. Predefied liks By default, you ca lik from this Broker Evets table view to Broker Evets History. (Broker Evets short term history collectio is active by default. If the evet occurs, a etry is added to the historical log.) 86 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

87 Broker Iformatio Workspace Broker Iformatio Workspace Descriptio The Broker Iformatio workspace is selectable for the broker maaged system. This workspace displays the status of the broker, its process ID, iformatio about the platform o which it rus, its job o OS/390 ad z/os systems, its associated cofiguratio maager queue maager, its associated queue maager, ad whether or ot the aget ca coect to the broker s queue maager. Default views This workspace cotais the followig default views: Eterprise Evet Log shows, as a table, all situatios raised for the eterprise. Broker Iformatio shows, as a table, broker status ad defiitio data. Iformatio preseted i the Broker Iformatio table view The Broker Iformatio table view displays data provided by the Broker Iformatio attributes, which are: Address Space Idetifier Process Idetifier Broker Queue Maager Broker Status Queue Maager Coectio Status Cofiguratio Maager Queue Maager Release Data Source Name Start Date ad Time Executio Groups System Name Jobame Taskame Trace Level Migratio Needed Trusted Queue Maager Origi Node User Name Server Queue Maager Platform UUID Platform Versio Workspaces 87

88 Broker Iformatio Workspace For a detailed descriptio of these attributes ad their values, refer to the Help for OMEGAMON XE for WebSphere MQ Itegrator. Note the Broker Iformatio attributes also provide data for the Broker Iformatio History workspace ad the Neighbor Broker Iformatio workspace. Predefied liks By default, you ca lik from this Broker Iformatio table view to Broker Statistics ad Broker Iformatio History. (Broker Iformatio short term history collectio is active, by default, with a collectio iterval of 15 miutes.) Additioal predefied liks usig OMEGAMON DE If you have the OMEGAMON DE feature package for CadleNet Portal AND... If you have the Cadle Commad Ceter for MQSeries moitorig aget o your aget maaged system, you ca lik to the: Queue Maager Status workspace. Chael Performace workspace. If you have the OMEGAMON XE for Widows NT moitorig aget o your aget maaged system, you ca lik to the: Process Storage workspace (filtered by Process ID). If you have the OMEGAMON XE for UNIX moitorig aget o your aget maaged system, you ca lik to the: Process workspace (filtered by Process ID). If you have the OMEGAMON XE for OS/390 UNIX System Services moitorig aget o your aget maaged system, you ca lik to the: Processes workspace (filtered by Process ID). 88 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

89 Broker Statistics Workspace Broker Statistics Workspace Descriptio The Broker Statistics workspace is selectable for the broker maaged system. This high-level statistics workspace provides message flow statistics summarized at the broker level. To obtai data for this workspace, the broker must have at least oe deployed CadleMoitor ode with a type attribute of iput or output. Default views This workspace cotais the followig default views: Curret Message Rates shows, as a bar chart, the message iput rate ad message output rate for the broker. Curret Average Message Time shows, as a bar chart, average queue ad flow times for the broker. Broker Statistics shows, as a table, statistical data summarized for the broker. Note: Move the cursor over differet areas of a chart to display flyover details about the items i the chart. Iformatio preseted i the Broker Statistics table view The Broker Statistics table view displays data provided by the Broker Statistics attributes, which are listed o the followig page: Workspaces 89

90 Broker Statistics Workspace Address Space Idetifier Overall Average Queue Time Broker Overall Maximum Flow Time Curret Average Flow Time Overall Maximum Message Size Curret Average Message Size Overall Maximum Queue Time Curret Average Message Time Overall Message Iput Cout Curret Average Queue Time Overall Message Iput Rate Curret Message Iput Cout Overall Message Output Cout Curret Message Iput Rate Overall Message Output Rate Curret Message Output Cout Overall Miimum Flow Time Curret Message Output Rate Overall Miimum Message Size First Message Date ad Time Overall Miimum Queue Time Jobame Taskame Platform Last Message Date ad Time Platform Versio Moitored Executio Groups Process Idetifier Moitored Message Flows Start Date ad Time Origi Node Started Message Flows Overall Average Flow Time Status Overall Average Message Size System Name Overall Average Message Time For a detailed descriptio of these attributes ad their values, refer to the Help for OMEGAMON XE for WebSphere MQ Itegrator. Note the Broker Statistics attributes also provide data for the Broker Statistics History workspace. Predefied liks By default, you ca lik from the Broker Statistics table view to Broker Iformatio ad Broker Statistics History. (Broker Statistics short term history collectio is active, by default, with a collectio iterval of 15 miutes.) Additioal predefied liks usig OMEGAMON DE If you have the OMEGAMON DE feature package for CadleNet Portal AND... If you have the OMEGAMON XE for Widows NT moitorig aget o your aget maaged system, you ca lik to the: 90 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

91 Broker Statistics Workspace Process Storage workspace (filtered by Process ID). If you have the OMEGAMON XE for UNIX moitorig aget o your aget maaged system, you ca lik to the: Process workspace (filtered by Process ID). If you have the OMEGAMON XE for OS/390 UNIX System Services moitorig aget o your aget maaged system, you ca lik to the: Processes workspace (filtered by Process ID). Reset of statistics Cumulative statistics with Overall attribute ames are maitaied iterally at the CadleMoitor ode level. These statistics are simultaeously reset to 0 for all CadleMoitor odes whe a deploy operatio to a broker ivolves ay message flow cotaiig a CadleMoitor ode, or whe ay CadleMoitor ode detects a overflow coditio for statistics. A reset of statistics icludes all statistics maitaied for the broker i order to preserve the itegrity of summarized statistics. The CadleMoitor ode produces a Evet Log message whe a reset occurs due to a umerical overflow coditio, ad the moitorig aget logs a message whe a reset is detected. At the time of a reset of statistics, workspaces will show that the Overall statistics have started over from zero. Historical workspaces will show data prior to the reset combied with data followig the reset for the iterval i which the reset occurred. This esures that o historical data is lost. I subsequet itervals, the historical workspaces will show the Overall values as havig started over from zero. Workspaces 91

92 Broker Status Workspace (broker-level summary) Broker Status Workspace (broker-level summary) Descriptio The Broker Status workspace is selectable for the broker maaged system. It summarizes evet, status, ad defiitio iformatio for the broker. Default views This workspace cotais the followig default views: Broker Evets shows, as a table, the most recet retaied broker evets. Message Flow Evets shows, as a table, the most recet retaied message flow evets. Broker Iformatio shows, as a table, broker status ad defiitio data. Accessig this workspace To access this workspace, i the Navigator physical view select oe of the broker maaged system folder icos. If oly oe broker is moitored, the broker maaged system folder ico is merged with the WMQI Broker folder ico. 92 OMEGAMON XE for WebSphere MQ Itegrator User s Guide, V110

93 Broker Summary Workspace (multiple brokers moitored) Broker Summary Workspace (multiple brokers moitored) Descriptio The Broker Summary workspace is selectable for the WMQI Broker folder ode whe multiple brokers are moitored by the same aget. It lists iformatio about each broker moitored. Default views This workspace cotais the followig default views: Eterprise Evet Log shows, as a table, all situatios raised for the eterprise. Broker Iformatio shows, as a table, the broker status ad defiitio data for each broker moitored by the aget. Accessig this workspace To access this workspace, i the Navigator physical view select the WMQI Broker folder ico. Workspaces 93