Title Page

Monitor Version 7.1 webMethods Monitor User’s Guide

Copyright 
&  Docu‐
ment ID

Cerebra, Glue, Infravio X‐Broker, Infravio X‐Registry, Infravio, My webMethods Server, My webMethods, webMethods Access, webMethods Administrator, 
webMethods Broker, webMethods Central Configuration, webMethods Dashboard, webMethods Designer, webMethods Developer, webMethods Fabric, 
webMethods Glue, webMethods Infrastructure Data Collector, webMethods Infravio X‐Broker, webMethods Infravio X‐Registry, webMethods Installer, 
webMethods Integration Server, webMethods logo, webMethods Mainframe, webMethods Manager, webMethods Modeler, webMethods Monitor, 
webMethods Optimize for Infrastructure, webMethods Optimize for Process, webMethods Optimize, webMethods Portal, webMethods Process Engine, 
webMethods Servicenet, webMethods Task Engine, webMethods Trading Networks, webMethods Workflow, and webMethods are either registered 
trademarks or trademarks of webMethods, Inc.
Acrobat, Acrobat, and Reader are registered trademarks of Adobe Systems Incorporated.  Amdocs and ClarifyCRM are registered trademarks of Amdocs.  
Ariba is a registered trademark of Ariba, Inc.  BEA, BEA WebLogic Server, Jolt, and Tuxedo are registered trademarks, and BEA WebLogic Platform is a 
trademark of BEA Systems, Inc.  Action Request System, BMC Software, PATROL, and Remedy are registered trademarks of BMC Software, Inc.  BroadVision 
is a registered trademark of BroadVision, Inc.  Chem eStandards and CIDX are trademarks of CIDX, The Chemical Industry Data Exchange.  SiteMinder and 
Unicenter are registered trademarks of CA, Inc.  PopChart is a registered trademark of CORDA Technologies, Inc.  Kenan and Arbor are registered trademarks 
of Alcatel‐Lucent.  Data Connection and SNAP‐IX are registered trademarks of Data Connection Corporation.  D&B and D‐U‐N‐S are registered trademarks of 
Dun & Bradstreet Corporation.  Eclipse is a trademark of Eclipse Foundation, Inc.  Entrust is a registered trademark of Entrust, Inc.  papiNet is a registered 
trademark of the European Union and the United States.  Financial Information eXchange, F.I.X, and F.I.X Protocol are trademarks of FIX Protocol Ltd.  
UCCnet and eBusinessReady are registered trademarks, and 1SYNC and Transora are trademarks of GS1 US.  Hewlett‐Packard, HP, HP‐UX, OpenView, PA‐
RISC, and SNAplus2 are trademarks of Hewlett‐Packard Company.  i2 is a registered trademark of i2 Technologies, Inc.  AIX, AS/400, CICS, ClearCase, DB2, 
Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere, and 
z/OS are registered trademarks; and Communications System for Windows NT, DB2 Universal Database, IMS, MVS, and SQL/DS are trademarks of IBM 
Corporation.   InnoDB is a trademark of Innobase Oy.  Itanium is a registered trademark of Intel Corporation.  Linux is a registered trademark of Linus 
Torvalds.  W3C is a registered trademark, and X Window System is a trademark of the Massachusetts Institute of Technology.  MetaSolv is a registered 
trademark of Metasolv Software, Inc.  ActiveX, Microsoft, Outlook, Visual Basic, Visual SourceSafe, Windows, Windows NT, and Windows Server are 
registered trademarks of Microsoft Corporation.   Six Sigma is a registered trademark of Motorola, Inc.  Firefox and Mozilla are registered trademarks of the 
Mozilla Foundation.  MySQL is a registered trademark of MySQL AB.  nCipher is a trademark of nCipher Corporation Ltd.   Eclipse is a trademark of Eclipse 
Foundation, Inc.  Entrust is a registered trademark of Entrust, Inc.  papiNet is a registered trademark of the European Union and the United States.  Financial 
Information eXchange, F.I.X, and F.I.X Protocol are trademarks of FIX Protocol Ltd.  UCCnet and eBusinessReady are registered trademarks, and 1SYNC and 
Transora are trademarks of GS1 US.  Hewlett‐Packard, HP, HP‐UX, OpenView, PA‐RISC, and SNAplus2 are trademarks of Hewlett‐Packard Company.  i2 is a 
registered trademark of i2 Technologies, Inc.  AIX, AS/400, CICS, ClearCase, DB2, Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, 
OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere, and z/OS are registered trademarks; and Communications System for Windows 
NT, DB2 Universal Database, IMS, MVS, and SQL/DS are trademarks of IBM Corporation.  InnoDB is a trademark of Innobase Oy.  Itanium is a registered 
trademark of Intel Corporation.   Teradata is a registered trademark of NCR Corporation. Netscape is a registered trademark of Netscape Communications 
Corporation.  ServletExec is a registered trademark, and New Atlanta is a trademark of New Atlanta Communications, LLC.  SUSE is a registered trademark 
of Novell, Inc.  Appia is a registered trademark and Javelin Technologies is a trademark of NYFIX, Inc.  CORBA is a registered trademark of Object 
Management Group, Inc.  JD Edwards, OneWorld, Oracle, PeopleSoft, Siebel, and Vantive are registered trademarks; and Infranet, PeopleSoft Pure Internet 
Architecture, Portal, and WorldSoftware are trademarks of Oracle Corporation.  Perforce is a trademark of Perforce Software.  JBoss and Red Hat are 
registered trademarks of Red Hat, Inc.  PIP and RosettaNet are trademarks of RosettaNet, a non‐profit organization.   SAP and R/3 are registered trademarks 
of SAP AG.  PVCS is a registered trademark of Serena Software, Inc.  SWIFT and SWIFTNet are registered trademarks of Society for Worldwide Interbank 
Financial Telecommunication SCRL.  SPARC and SPARCStation are registered trademarks of SPARC International, Inc.  BAAN and SSA are registered 
trademarks; and SSA Global is a trademark of SSA Global Technologies, Inc.  EJB, Enterprise JavaBeans, Java, JavaServer, JDBC, JSP, J2EE, Solaris, Sun, and 
Sun Microsystems are registered trademarks; and Java Naming and Directory Interface, JavaServer Pages, SOAP with Attachments API for Java, and SunSoft 
are trademarks of Sun Microsystems, Inc.  Sybase is a registered trademark of Sybase, Inc.  VERITAS is a registered trademark, and VERITAS Cluster Server is 
a trademark of Symantec Corporation.  UNIX is a registered trademark of The Open Group.  Unicode is a trademark of Unicode, Inc.  VeriSign is a registered 
trademark of Verisign, Inc. 
Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG. 
Other product and company names mentioned herein may be the trademarks of their respective owners.
Copyright © 2007 webMethods, Inc. All rights reserved.
Copyright © 2007 Software AG and/or its suppliers, Uhlandstrasse 12, 64297 Darmstadt, Germany. All rights reserved.

Document ID: MON-UG-71-20070831

 Contents

Contents

About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 1. Introduction to webMethods Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

About webMethods Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Types of Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Monitor Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Monitor and the My webMethods User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Logging In to and Out of Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
My webMethods Pages that Provide Access to Monitor Functionality . . . . . . . . . . . . . . . . . . . . . . . . 15
Monitor Functionality in the Administration Navigation Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Monitor Functionality in the Monitoring Navigation Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Producing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Archiving Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 2. Configuring Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Configuring the Central Users Feature for Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
About the Central Users Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Configuring the Central Users Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Configuring Integration Servers in My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Making Monitor Aware of the My webMethods Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Configuring Database Connection Retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Granting Users Access to the My webMethods Monitoring Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Granting Users the Ability to Perform Monitor Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Identifying the Logged Data Users Can Perform Actions Against . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
How Data Level Security Works with Functional Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Setting up Data Level Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Enabling Data Level Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Identifying Processes a Role Can Act On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Identifying Services a Role Can Act On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Identifying Documents a Role Can Act On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Setting Up to Generate Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Setting Up to Archive Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

webMethods Monitor User’s Guide Version 7.1 3

 Contents

Chapter 3. Service Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Before You Can Monitor Logged Service Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Searching for Logged Service Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Performing a Keyword Search for Logged Service Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Performing an Advanced Search for Logged Service Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Viewing Information for a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Viewing Detailed Information for a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Information Displayed on the Service Detail Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Actions You Can Take from the Service Detail Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Statuses of Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Resubmitting Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Resubmitting a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Editing the Pipeline Before Resubmitting a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Chapter 4. Document Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Before You Can Monitor Logged Document Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Searching for Logged Document Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Performing a Keyword Search for Logged Document Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Performing an Advanced Search for Logged Document Data . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Viewing Detailed Information for a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Information Displayed on the Document Detail Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Actions You Can Take from the Document Detail Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Resubmitting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Resubmitting a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Editing Document Information Before Resubmitting the Document . . . . . . . . . . . . . . . . . . . . . . 61

Chapter 5. Process Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Before You Can Monitor Logged Process Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Types of Processes You Can Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
About Integration Process Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Setting Up Integration Process Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Defining an Integration Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Executing an Integration Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Searching for Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Performing a Keyword Search for Logged Process Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Performing an Advanced Search for Logged Process Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Viewing Information for Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Viewing Detailed information for a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Information Displayed on the Process Instance Detail Page . . . . . . . . . . . . . . . . . . . . . . . . 76
Actions You Can Take from the Process Instance Detail Page . . . . . . . . . . . . . . . . . . . . . 81

webMethods Monitor User’s Guide Version 7.1 4

 Contents

Statuses of Process Instances and Process Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Process Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Step Statuses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Viewing Detailed Information for Process Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Actions You Can Take from the Process Step Detail Page . . . . . . . . . . . . . . . . . . . . . . . . . 85
Viewing KPI Data That Is Associated with a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Viewing KPI Data That Is Associated with a Process Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Stopping, Suspending, and Resuming Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Stopping a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Suspending a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Resuming a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Resubmitting Process Instances and Process Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Requirements for Resubmitting Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Resubmitting Process Instances from the Beginning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Resubmitting Processes from a Step and Optionally Editing Pipeline Information . . . . . . . . . . . 89

Chapter 6. Working with Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Before You Can Work with Process Models from My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Searching for Process Models That Are Available for Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Performing a Keyword Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Performing an Advanced Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Viewing Detailed Information for a Process Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Information Displayed on the Edit Process Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Actions You Can Take from the Edit Process Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Enabling and Disabling Process Model Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Determining the Enabled Version of a Process Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Enabling a Process Model for Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Setting Up Logging for a Process Model Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Configure Logging Settings for a Process Model Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Improve Process Logging Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Deleting Unused Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Chapter 7. Archiving or Deleting Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Before You Archive and Delete Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Items to Consider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Archiving or Deleting Logged Data from My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Archiving or Deleting Logged Data Using Built-in Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Archiving or Deleting Logged Data Using Stored Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Viewing the Results of an Archive Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

webMethods Monitor User’s Guide Version 7.1 5

 Contents

Chapter 8. Working with Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Before You Can Generate Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Generating Reports about Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Viewing a Instance Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Viewing Reports of Started, Completed, or Failed Process Instances . . . . . . . . . . . . . . . . . . . . 123
Viewing an Instance Detail Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Generating Reports about Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Viewing a Process Models Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Viewing a Step Report for a Process Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Generating Task Users Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Generating Task Roles Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Using Third-Party Reporting Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Appendix A. Archive and Delete Audit Data Stored Procedures Reference . . . . . . . . . . . 133
Stored Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

webMethods Monitor User’s Guide Version 7.1 6

 About This Guide

About This Guide

This guide describes how to set up and use webMethods Monitor to monitor business 
processes, services, and documents. Additionally, it describes how to work with process 
models that are in your production environment, how to generate reports for logged 
process instances and tasks, and how to archive data from the IS Core Audit Log and 
Process Audit Log database components. webMethods Monitor functions are accessed 
through the My webMethods interface.

Document Conventions

Convention Description
Bold Identifies elements on a screen.
Italic Identifies variable information that you must supply or change 
based on your specific situation or environment. Identifies terms the 
first time they are defined in text. Also identifies service input and 
output variables.
Narrow font Identifies storage locations for services on the webMethods 
Integration Server using the convention folder.subfolder:service.
Typewriter Identifies characters and values that you must type exactly or 
font messages that the system displays on the console.
UPPERCASE Identifies keyboard keys. Keys that you must press simultaneously 
are joined with the “+” symbol.
\ Directory paths use the “\” directory delimiter unless the subject is 
UNIX‐specific.
[ ] Optional keywords or values are enclosed in [ ]. Do not type the [ ] 
symbols in your own code.

Additional Information
The webMethods Advantage Web site at http://advantage.webmethods.com provides you 
with important sources of information about webMethods products:
Troubleshooting Information. The webMethods Knowledge Base provides 
troubleshooting information for many webMethods products. 
Documentation Feedback. To provide feedback on webMethods documentation, go to 
the Documentation Feedback Form on the webMethods Bookshelf.

webMethods Monitor User’s Guide Version 7.1 7

 About This Guide

Additional Documentation. Starting with 7.0, you have the option of downloading the 
documentation during product installation to a single directory called 
“_documentation,” located by default under webMethods installation directory. In 
addition, you can find documentation for all webMethods products on the 
webMethods Bookshelf.

webMethods Monitor User’s Guide Version 7.1 8

Chapter 1. Introduction to webMethods Monitor

About webMethods Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Monitor and the My webMethods User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Logging In to and Out of Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

My webMethods Pages that Provide Access to Monitor Functionality . . . . . . . . . . . . . . . . . . . . 15

Producing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Archiving Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

webMethods Monitor User’s Guide Version 7.1 9

 1. Introduction to webMethods Monitor

About webMethods Monitor

webMethods Monitor allows you to view data that other webMethods components have 
previously logged about business processes, services, and documents. For more 
information, see “Types of Logged Data” on page 11. The webMethods components store 
the logged data in the IS Core Audit Log, Process Audit Log, or Process Tracker database 
components. When you use Monitor to view logged data, Monitor retrieves the data from 
these database components.
To use Monitor, you must set up the IS Core Audit Log and Process Audit Log database 
components. If you are also using webMethods Optimize for Process, you also need to set 
up the Process Tracker database component. For information about setting up these 
database components, see the webMethods Installation Guide. You identify the information 
that you want logged to these database components by setting up logging. For more 
information about setting up logging, see the webMethods Logging Guide and webMethods 
Optimize for Process Administrator’s Guide.
The following diagram shows an overview of how data is logged into the database 
components for use by Monitor. The audit subsystem, which resides within the Integration 
Server, is the mechanism that logs data from most webMethods components. The 
Integration Server and components that run within the Integration Server (e.g., Process 
Engine) interact directly with the audit subsystem. Broker, which runs outside of the 
Integration Server, interacts with the audit subsystem via the Logging Utility. Optimize 
for Process interacts directly with the Process Tracker database component. For more 
details about how logging is performed, see the webMethods Logging Guide. 

Integration Server
webMethods components log
Logging data to the logging database.
Utility audit
subsystem

IS Core Process Audit webMethods Monitor

Audit Log Log displays logged data
that it retrieves from
the logging database.

Monitor
Optimize for Process Process via
logging database
Tracker My webMethods

In addition to simply viewing logged data for documents, using Monitor you can 
resubmit documents, and optionally edit the document before resubmitting it. Similarly, if 
you have services and business processes set up to log the pipeline data, you can also 
resubmit those services and business processes; optionally you can alter the pipeline 

webMethods Monitor User’s Guide Version 7.1 10

 1. Introduction to webMethods Monitor

before resubmitting them. For more information about the actions you can take, see 
“Monitor Actions” on page 12.
You can also use Monitor to remove data from the IS Core Audit Log and Process Audit 
Log database components. You can have Monitor do either of the following:
Move data from the IS Core Audit Log and Process Audit Log database components 
to an Archive database component, which is outside of the webMethods logging 
database, and then delete the data from the IS Core Audit Log and Process Audit Log 
database components
Delete the data from the IS Core Audit Log and Process Audit Log database 
components without archiving it first
For more information about archiving and deleting data from the logging database, see 
Chapter 7, “Archiving or Deleting Logged Data”.

Types of Logged Data

webMethods components log the following types of data that you can monitor using 
webMethods Monitor:
Data about flow and coded (for example, Java) services that run in Integration Server. Data 
logged for services includes when services start, their statuses, their duration, 
whether they completed successfully or failed, the client that called the service, and 
the Integration Server port on which the client connected.
Data about the following types of documents:
In doubt documents; a document is considered “in doubt” when a trigger is 
configured for exactly‐once processing and the Integration Server cannot 
determine whether the document is a copy of one the trigger has already 
processed.
Failed documents; a document is considered “failed” when a transient error occurs 
while publishing, delivering, or retrieving the document for a trigger.
Retries exceeded documents; a document is considered “retries exceeded” when the 
Integration Server has repeated failed attempts to publish or deliver the 
document.
Broker documents; you can configure your system to log specified documents 
that Broker clients publish or subscribe to.
Data that the Process Engine logs for process instances. You can use this logged data to:
Identify process instances
See the path a process instance took at run time
Track when process instances and process steps started and when they ended

webMethods Monitor User’s Guide Version 7.1 11

 1. Introduction to webMethods Monitor

Track when process instance and step status changes
Track whether process instances and steps completed successfully or failed
View values of logged fields and custom data logged for steps in the process
View error messages associated with a process
View the control actions (e.g., resubmit) taken against a process
Analysis data that Optimize for Process logs for process instances. If you have Optimize for 
Process installed, you can set up analysis of your processes. Then you can view 
metrics that relate to your business processes, such as the average time to complete a 
process or the number of times a step was executed.
Data that a user-created service logged for integration processes:
Identify process instances
Track the status of a process and its steps
View values of logged fields and custom data logged for steps in the process
View error messages associated with a process
For more information about logging, see the webMethods Logging Guide.

Monitor Actions
When you have Monitor installed, you can do the following using the My webMethods 
user interface:
Monitor and resubmit services. For more information, see Chapter 3, “Service 
Monitoring”.
Monitor and resubmit documents. For more information, see Chapter 4, “Document 
Monitoring”.
Monitor, suspend, resume, and resubmit process instances. For more information, see 
Chapter 5, “Process Monitoring”.
Enable process models and define settings that are used by running process instances 
of the models. For more information, see Chapter 6, “Working with Process Models”.
Generate reports about process instances, process models, task users, and task roles. 
For more information, see Chapter 8, “Working with Reports”.
Archive and delete data from the logging database. For more information, see 
Chapter 7, “Archiving or Deleting Logged Data”.

webMethods Monitor User’s Guide Version 7.1 12

 1. Introduction to webMethods Monitor

Monitor and the My webMethods User Interface

You interact with Monitor via the My webMethods user interface. That is, you use My 
webMethods to access the Monitor functionality to:
View logged data that other webMethods components have logged

Resubmit process instances, services, and documents

Work with process models

Generate reports for process instances, process models, task users, and task roles

Archive or delete logged data from the logging database
Using My webMethods administrative functions, Monitor administrators can control the 
the Monitor privileges that users and groups of users have. Granting or denying Monitor 
privileges is based on the My webMethods roles to which the users and/or groups of user 
belong. Using My webMethods you can control access to:
The Monitor pages that a role can access within the My webMethods user interface. For 
example, you can configure My webMethods so that specific roles can view pages 
related to monitoring process instances, but not allow those roles to view pages 
related to monitoring services. For more information, see “Granting Users Access to 
the My webMethods Monitoring Pages” on page 25.
The Monitor actions a role can perform. For example, you can allow specific roles to view 
logged data about documents, but not resubmit the documents. For more 
information, see “Granting Users the Ability to Perform Monitor Actions” on page 27.
The specific logged data (i.e., specific business processes, services, or documents) upon which
a role can act. This is referred to as content‐based access or data level security. For example, 
you can allow specific roles to act upon only logged data associated with services that 
you identify. For more information, see “Identifying the Logged Data Users Can 
Perform Actions Against” on page 30.
You create roles in My webMethods that include the users and/or groups of users to 
which you want to grant access. For example, you might create the Human Resources 
role, and then assign users and/or groups of users who work in the Human Resources 
department to the Human Resources role. You can then grant the Human Resources role 
access to view Monitor pages to view and resubmit process instances, and content‐based 
access to only view and resubmit process instances that are used by the human resources 
department. 
For more information about the My webMethods user interface and its administrative 
functions, see Getting Started with My webMethods and the My webMethods Server 
Administrator’s Guide.

webMethods Monitor User’s Guide Version 7.1 13

 1. Introduction to webMethods Monitor

Logging In to and Out of Monitor

To access Monitor functionality, you log into the My webMethods user interface. The 
Administrator user account is defined for you at installation; this user account is assigned 
the password “manage”.

Important! You should change the default password (manage) for the Administrator user 
account.

For more information about logging in and logging out of My webMethods, see the 
Getting Started with My webMethods guide.

To log into My webMethods to access Monitor functionality

1 Open a Web browser and enter the URL for the My webMethods Server.
2 On the My webMethods Login page:
In the User Name box, type your user name, for example, Administrator.
In the Password box, type your password, for example, manage. 

Important! Before using Monitor, it is required that you configure the Central Users feature. 
This feature allows Monitor to perform actions on the Integration Server using existing 
My webMethods user accounts. This precludes any need to duplicate your My 
webMethods user accounts in the Integration Server. The Central Users feature will use 
the users and groups created in My webMethods to determine permissions when 
performing Monitor actions. For details, see “Configuring the Central Users Feature for 
Monitor” on page 21.

To log out of My webMethods

Click Logout at the top of any My webMethods page.

webMethods Monitor User’s Guide Version 7.1 14

 1. Introduction to webMethods Monitor

My webMethods Pages that Provide Access to Monitor

Functionality
From My webMethods, you access Monitor functionality from both the Administration 
and Monitoring navigation paths. The following sections describe the navigation 
selections to use to access Monitor functionality.

Important! Functionality available via the My webMethods user interface is based on the 
privileges assigned to your My webMethods roles. If you do not have all privileges, My 
webMethods might not display pages, buttons, and/or other user interface controls 
required to perform the actions describe in this guide. If a procedure instructs you to use 
an item that is not available, see your system administrator about acquiring the proper 
privileges to allow you to perform the action.

Monitor Functionality in the Administration Navigation Path

Administration
Navigation Selections Use to...
User Management Define users, groups, roles and control access to Monitor 
privileges.
For more information about defining users, groups, and 
roles, see the My webMethods Server Administrator’s Guide. 
For more information about controlling access to Monitor 
privileges, see: 
“Granting Users Access to the My webMethods 
Monitoring Pages” on page 25
“Granting Users the Ability to Perform Monitor 
Actions” on page 27
“Identifying the Logged Data Users Can Perform 
Actions Against” on page 30
Business > Enable process models for execution and define settings that 
Business Processes are used by running process instances of the models. For 
more information, see Chapter 6, “Working with Process 
Models”.

webMethods Monitor User’s Guide Version 7.1 15

 1. Introduction to webMethods Monitor

Administration
Navigation Selections Use to...
Business > Archive and delete logged data from the IS Core Audit Log 
Data Management > and Process Audit Log database components. You can also 
Archive Audit Data view the results of the archive or delete operation. For more 
information, see Chapter 7, “Archiving or Deleting Logged 
Data”.
My webMethods > Identify the Integration Server with which the My 
System Settings webMethods Server is to interact. This is the server on which:
The WmMonitor package is installed

Contains the services and Integration Server documents 
you want to monitor
Runs the Process Engine that executes process instances
For more information, see “Configuring Integration Servers in 
My webMethods” on page 23.

Monitor Functionality in the Monitoring Navigation Path

Monitoring Navigation
Selections Use to...
Business > View the details about individual process instances, including 
Process Instances drilling down to view information about the steps within a 
process. You can also use this link to suspend and resume 
process instances. For more information about using this 
functional task, see Chapter 5, “Process Monitoring”.
Integration > Services View logged data that Integration Servers have logged for 
services and to resubmit services. For more information about 
using this link, see Chapter 3, “Service Monitoring”.
Integration > Documents View and resubmit documents that have been logged to the 
logging database. For more information about using this link, 
see Chapter 4, “Document Monitoring”.

webMethods Monitor User’s Guide Version 7.1 16

 1. Introduction to webMethods Monitor

Monitoring Navigation
Selections Use to...
Reports > Generate aggregate reports on process instances, process 
Process Instances models, task users, and task roles. For more information 
about using this link, see Chapter 8, “Working with Reports”.
Reports >
Process Models
Reports >
Task Users
Reports >
Task Roles

Producing Reports
You can generate reports that show aggregated data about process instances and tasks 
that have executed. Monitor generates the reports using the Staging and Reporting 
database components. The Staging database component holds process status data that has 
been extracted from the Process Audit Log database component. The data in the Staging 
database component is aggregated into daily statistics and loaded into the Reporting 
database component.
For instructions on setting up the Staging and Reporting database components, see 
“Setting Up to Generate Reports” on page 35. For instructions on creating and viewing 
reports, including information about using third‐party reporting tools, see Chapter 8, 
“Working with Reports”.  

Note: Reporting is available only on data collected after January 1, 2003. Also, the reports 
are only available in English. They are not localized and are not available in the language 
packs.

Archiving Logged Data

You should remove data from the IS Core Audit Log and the Process Audit Log database 
components on a regular basis to maintain your logging database at peak performance. 
You can have Monitor just delete the information from the IS Core Audit Log and the 
Process Audit Log database components, or you can have Monitor archive the data and 
then delete it. 
If you want to archive logged data, you must set up the Archive database component. For 
instructions, see “Setting Up to Archive Data” on page 36. For instructions on archiving 
data, see Chapter 7, “Archiving or Deleting Logged Data”.

webMethods Monitor User’s Guide Version 7.1 17

 1. Introduction to webMethods Monitor

webMethods Monitor User’s Guide Version 7.1 18

Chapter 2. Configuring Monitor

Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Configuring the Central Users Feature for Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Configuring Integration Servers in My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Configuring Database Connection Retries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Granting Users Access to the My webMethods Monitoring Pages . . . . . . . . . . . . . . . . . . . . . . . 25

Granting Users the Ability to Perform Monitor Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Identifying the Logged Data Users Can Perform Actions Against . . . . . . . . . . . . . . . . . . . . . . . . 30

Setting Up to Generate Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Setting Up to Archive Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

webMethods Monitor User’s Guide Version 7.1 19

 2. Configuring Monitor

Configuration Tasks
The following table lists webMethods Monitor configuration and setup tasks and where 
to find information about each task.

Configuration Task For more information, see...

Set up logging, so webMethods components log  webMethods Logging Guide
data for the items (process instances, services, 
and documents) that you want to monitor.
Configure the Central Users feature that  “Configuring the Central Users 
enables Monitor to perform actions on the  Feature for Monitor” on page 21
Integration Server using your My webMethods 
user account. 
Make My webMethods Server aware of the  “Configuring Integration Servers in 
Integration Servers that contain data you want  My webMethods” on page 23
to monitor and on which you have installed 
Monitor.
Make Monitor aware of the My webMethods  “Making Monitor Aware of the My 
Server that will provide the Monitor user  webMethods Server” on page 24
interfaces.
Configure the number of times that Monitor  “Configuring Database Connection 
attempts to connect to the Process Audit Log  Retries” on page 24
database component when it needs to obtain 
process information.
Grant users the ability to access the My  “Granting Users Access to the My 
webMethods pages from which you access  webMethods Monitoring Pages” on 
Monitor functionality. page 25
Grant users the ability to perform Monitor  “Granting Users the Ability to 
actions (e.g., start or stop business processes or  Perform Monitor Actions” on 
resubmit processes, services, and documents). page 27
Identify the logged data (processes, services,  “Identifying the Logged Data Users 
and documents) that you want to allow users to  Can Perform Actions Against” on 
have access to. page 30
Enable and disable process models. “Enabling and Disabling Process 
Model Versions” on page 102
Set up to allow analysis of business processes  webMethods Optimize for Process 
using webMethods Optimize for Process. Administrator’s Guide

webMethods Monitor User’s Guide Version 7.1 20

 2. Configuring Monitor

Configuration Task For more information, see...

Set up to create reports about process instances,  “Setting Up to Generate Reports” on 
process models, task users, and task roles page 35
Set up to be able to archive and delete data in  “Setting Up to Archive Data” on 
the logging database. page 36

Configuring the Central Users Feature for Monitor

When you install Monitor, you also configure the Central Users feature using the 
Integration Server Administrator. For more information about installing Monitor, see the 
webMethods Installation Guide. Configure Central Users before using Monitor. 

About the Central Users Feature

When a user issues a Monitor request from My webMethods, internally My webMethods 
Server invokes a service in the WmMonitor package on the Integration Server to handle 
that request. The service is invoked using the credentials (i.e., user name and password) of 
the My webMethods user. As a result, the Integration Server must authenticate the My 
webMethods user who issued the Monitor request. The Integration Server authenticates 
the user through the Central Users feature.
You configure Central Users in the Integration Server Administrator. For more 
information, see the webMethods Integration Server Administrator’s Guide.
When the Integration Server receives a Monitor request from the My webMethods Server 
and the user issuing the request is not an Integration Server user, the Integration Server 
uses Central Users to authenticate the user. Using Central Users means that My 
webMethods user accounts do not need to be duplicated on the Integration Server.

Configuring the Central Users Feature

To use My webMethods Server credentials to authenticate Monitor requests issued to the 
Integration Server, configure Central Users as described below. If you do not configure 
Central Users, you must ensure that each Monitor user defined in My webMethods has a 
corresponding user account defined in the Integration Server.

To enable and configure Central Users

1 In the Integration Server Administrator (of the supporting Integration Server):
Settings > JDBC Pools 
2 Use the Create a new Pool Alias Definition link to create an MwS pool alias for My 
webMethods Server. Use the portal database user ID and password.

webMethods Monitor User’s Guide Version 7.1 21

 2. Configuring Monitor

Once you’ve created the MwS pool alias, you’ll see MwS show up as an option in the 
Pool Alias Definitions list.
3 Assign the MwS pool alias to the CentralUsers functional alias definition. In the 
Functional Alias Definitions list, click the Edit link in the CentralUsers row.
4 Select MwS in the Associated Pool Alias field.
5 Click Save Settings.
6 Click the Restart link in the CentralUsers row to restart the alias definition so the new 
settings take effect.
7 Test the new alias definition by clicking the triangle icon (in the Test column) in the 
CentralUsers row.
8 Restart the Integration Server.
9 In the Integration Server Administrator:
Security > ACLs 
10 In the Select ACL field, select MonitorAdministrators ACL.
11 Click the Add button under the Allowed list to open the Select Role/Group dialog box.
The Select Role/Group dialog box shows the groups on the current Integration Server.
12 In the Provider field, select Central.
13 Type an asterisk (*) in the Search field and then click Go to get the list of roles and 
groups to populate. 

Note: The role and group list population might not work with Internet Explorer 6.x.

14 Select My webMethods Users to add that role to the Allowed list; the Select Role/Group 

dialog box automatically closes.
15 Next, in the Select ACL field, select MonitorUsers ACL.
16 Click the Add button under the Allowed list to open the Select Role/Group dialog box.
17 In the Provider field, select Central.
18 Type an asterisk (*) in the Search field and then click Go to get the list of roles and 
groups to populate. 

Note: The role and group list population might not work with Internet Explorer 6.x.

19 Select My webMethods Users to add that role to the Allowed list; the Select Role/Group 

dialog box automatically closes.
20 Click Save Changes. When the screen refreshes, you will see that the Select ACL field 
has reverted to the first item in the list.

webMethods Monitor User’s Guide Version 7.1 22

 2. Configuring Monitor

Configuring Integration Servers in My webMethods

You can enable Monitor to monitor data on multiple Integration Servers by configuring 
those servers at the My webMethods System Settings page. You must configure at least 
one Integration Server using the My webMethods System Settings page. Then, that 
default Integration Server for your installation appears on the System Settings page as the 
default server. Once any additional Integration Servers are successfully configured on this 
page, a Server drop‐down menu appears at the top of most Monitor pages to enable users 
to select from the servers available to them.

To configure one or more Integration Servers

1 From My webMethods: 
Administration > My webMethods > System Settings.
The System Settings page displays, with all currently configured Integration Servers 
displayed in the System Settings panel.
2 Click Add to add a new Integration Server (or a combined Integration Server and 
Analytic Engine host pair, if you are using Monitor with Optimize for Process). 
3 Enter a name for your new server in the NAME column, and then do one of the 
following:
To add an Integration Server for a BPM‐only host, enter the host name or network 
address and port number in the INTEGRATION SERVER (MONITOR) HOST and PORT 
columns, and select the check box in the USE SSL column if the server uses an SSL 
connection.
To add a combined Integration Server/Analytic Engine pair of hosts, enter the 
host names or network addresses and the appropriate port numbers in both the 
INTEGRATION SERVER (MONITOR) HOST and PORT columns and the ANALYTIC ENGINE
HOST and PORT columns.

Note: Depending on the type of your installation environment, the Analytic Engine 
fields might be missing from the System Settings page.

4 Click Save to save your configuration information.
5 Click Check Server Status to check the status of all configured servers.
6 Click the Delete button in the appropriate row to delete a server configuration row, or 
click Add to configure another server.

Note: The default server or server pair cannot be deleted.

webMethods Monitor User’s Guide Version 7.1 23

 2. Configuring Monitor

7 The default server or server pair has its radio button selected in the DEFAULT column. 
To change the default server or server pair, select the radio button beside the server(s) 
you want to make the default and then click Save. For any new My webMethods user, 
the default server or server pair will be selected. Once a user selects a server or server 
pair on a Monitor page, that server or server pair becomes that user’s default.

Note: You can click Check Server Status to verify that a specified Integration Server or 

Analytic Engine is accessible.

Making Monitor Aware of the My webMethods Server

To make sure users have access to the Monitor capabilities, you need to make Monitor 
aware of the My webMethods Server where the Monitor user interface is installed.

To make Monitor aware of the My webMethods Server

1 In the Integration Server Administrator (of the supporting Integration Server):
Packages > Management
2 In the WmMonitor row, click the Home icon.
3 Complete the first five fields in the Configuration Settings with the appropriate 
information.

Note: The default MWS port number is 8585. If this port number was changed during 
the My webMethods Server installation, the same port number specified during 
installation also needs to be specified here in the MWS Port field.

4 Change any of the remaining configuration fields as desired.
5 Click Submit.

Configuring Database Connection Retries

You can configure the number of times that Monitor attempts to connect to a database 
component (e.g., the Process Audit Log database component) when it needs to read 
process information. If Monitor fails to connect to a database component in the number of 
tries you configure, Monitor logs the error to the Integration Server Error Log.

To configure the number of time Monitor attempts to connect to a database component

webMethods Monitor User’s Guide Version 7.1 24

 2. Configuring Monitor

1 In the Integration Server Administrator (of the supporting Integration Server):
Packages > Management.
The Package List table displays the list of packages in the Integration Server.
2 Click the Home icon for the WmMonitor package.
3 In the Database Retries, specify the number of times Monitor should attempt to connect 
to a database component. The default is 3.
4 Click Submit. 

Granting Users Access to the My webMethods Monitoring Pages

Monitor administrators can configure the users who are allowed to view monitoring 
information, for example, to view logged data. To do so, administrators configure the 
access that users have to My webMethods pages. This is referred to as granting access 
privileges.
You grant users access by granting access privileges to roles to which a user belongs. If a 
user belongs to more than one role, the user will have access to a My webMethods page as 
long as access privileges have been granted to at least one of the user’s roles. For more 
information about defining roles, see the My webMethods Server Administrator’s Guide. 

To grant access privileges to Monitor pages within My webMethods

1 In My webMethods: Administration > System-Wide > User Management > Roles.

2 Search for and edit the role to which you want to assign privileges. If you need more 
detailed instructions for this step, see the My webMethods Server Administrator’s Guide.
3 On the Edit Role page, click the Access Privileges tab.
4 Select the access privileges you want to assign to the role. The following table shows 
the items to select on the Access Privileges tab based on the Monitor functionality you 
want users to be able to perform.

Select the following check boxes on the Access

To allow users to... Privileges tab

View process models that are  Select the Administration > Business > Business

available for monitoring. Processes check box, as shown below:

webMethods Monitor User’s Guide Version 7.1 25

 2. Configuring Monitor

Select the following check boxes on the Access

To allow users to... Privileges tab

Archive data in the webMethods  Select the Administration > Business > Data

logging database.  Management check box, as shown below:

View information about process  Select the Monitoring > Business > Processes

instances. Instances check box, as shown below:

Note: To allow users to act on process 
instances, for example, to resubmit process 
instances, see “Granting Users the Ability to 
Perform Monitor Actions” on page 27.

View information about services. Select the Monitoring > Integration > Services 

check box, as shown below:

Note: To allow users to act on services, for 
example, to resubmit services, see “Granting 
Users the Ability to Perform Monitor 
Actions” on page 27.

webMethods Monitor User’s Guide Version 7.1 26

 2. Configuring Monitor

Select the following check boxes on the Access

To allow users to... Privileges tab

View information about  Select the Monitoring > Integration > Documents 

documents. check box, as shown below:

Note: To allow users to act on documents, for 
example, to resubmit documents, see 
“Granting Users the Ability to Perform 
Monitor Actions” on page 27.

View all types of reports: Select the Monitoring > Reports check box, as 

shown below:
Process Instances

Model Models

Task Users

Task Roles

View some, but not all types of  Under Monitoring > Reports, select the check 

reports. boxes for the types of reports you want users 
to be able to view. Below shows a sample of 
granting access only to Process Instances 
reports:

5 Click Apply.

Granting Users the Ability to Perform Monitor Actions

Monitor administrators can configure the Monitor actions that users can perform. This is 
referred to as granting functional privileges. When a user has been granted the ability to 
perform Monitor actions, the buttons associated with that action become active for the 
user. For example, if you grant the ability to resubmit documents, when the user accesses 
the Documents page, the Resubmit button is active.

webMethods Monitor User’s Guide Version 7.1 27

 2. Configuring Monitor

To allow a user to perform Monitor actions, you grant functional privileges to roles to 
which a user belongs. If a user belongs to more than one role, the user will have the ability 
to perform a Monitor action as long as the functional privilege has been granted to at least 
one of the user’s roles. For more information about defining roles, see the My webMethods 
Server Administrator’s Guide.

To grant functional privileges for Monitor actions

1 In My webMethods: Administration > System-Wide > User Management > Roles.

2 Search for and edit the role to which you want to assign privileges. If you need more 
detailed instructions for this step, see the My webMethods Server Administrator’s Guide.
3 On the Edit Role page, click the Functional Privileges tab.
4 Select the functional privileges you want to assign the role. The following table shows 
the items to select on the Functional Privileges tab based on the Monitor actions you 
want users to be able to perform.

Select the following check boxes on the Functional

To allow users to... Privileges tab

Perform all types of Monitor  Under Business Monitoring, select the 

actions for process instances: Processes check box, as shown below:
Stop, suspend, and resume 
process instances
Resubmit process instances

Modify the pipeline for a 
process instance and resubmit 
it
Perform some, but not all types of  Under Business Monitoring locate Processes. 
actions for process instances. Under Processes, select the check boxes for 
the actions you want the role to be able to 
perform. Below shows a sample of granting 
only the ability to resubmit process 
instances:

webMethods Monitor User’s Guide Version 7.1 28

 2. Configuring Monitor

Select the following check boxes on the Functional

To allow users to... Privileges tab

Perform all types of Monitor  Under Integration Monitoring, select the 

actions for services: Services check box, as shown below:
Resubmit services

Modify the pipeline for a 
service and resubmit it

Perform some, but not all types of  Under Integration Monitoring locate Services. 

actions for services. Under Services, select the check boxes for the 
actions you want the role to be able to 
perform. Below shows a sample of granting 
only the ability to resubmit services:

Perform all types of Monitor  Under Integration Monitoring, select the 

actions for documents: Documents check box, as shown below:
Resubmit services

Modify a document and 
resubmit it

webMethods Monitor User’s Guide Version 7.1 29

 2. Configuring Monitor

Select the following check boxes on the Functional

To allow users to... Privileges tab

Perform some, but not all types of  Under Integration Monitoring locate Documents. 

actions for documents. Under Documents, select the check boxes for 
the actions you want the role to be able to 
perform. Below shows a sample of granting 
only the ability to resubmit documents:

Archive data or archive and delete  Under Data Management, select the Archiving 

data from the IS Core Audit Log  check box, as shown below:
and Process Audit Log database 
components.

5 Click Apply.

Identifying the Logged Data Users Can Perform Actions Against

Monitor administrators can limit the data a user can view or act on. This type of access 
control is referred to as data level security. If a user belongs to more than one role, the user 
will have access to all data granted to all the roles.

How Data Level Security Works with Functional Privileges

Functional privileges are global across all the data to which a user has been granted 
access. For example, assume the following:
The role HR is granted the functional privileges to start and stop process instances 
and data level security access to the newHire process. As a result, users assigned to 
the HR role can view, start, and stop instances of the newHire process.
The role Interns is granted data level security access to the ProblemReporting process. 
As a result, users assigned to the Interns role can view instances of the ProblemReport 
process.
If a user is assigned to both the HR and the Interns roles, because functional privileges are 
global and the HR role has the privilege to start and stop processes, the user assigned to 
both roles will be able to start and stop not only instances of the newHire process, but also 
instances of the ProblemReporting process.

webMethods Monitor User’s Guide Version 7.1 30

 2. Configuring Monitor

If you want to limit privileges, for example, give a user the ability to start and stop 
instances of the newHire process, but only be able to view instances of the 
ProblemReporting process, set up two user accounts. For example, you might set up user 
account joeHR and assign it to the HR role and joeIntern and assign it to the Interns role. 
As a result, when logged as joeHR, the user can view, start, and stop newHire process 
instances. When logged in as joeIntern, the user can only view ProblemReport instances.

Setting up Data Level Security

The following table lists the steps you take to set up data level security for logged data.

For more
Step Task Notes information, see...

1 Enable data level Before you can use the data level  “Enabling Data 

security security feature with Monitor, you  Level Security” 
must enable Monitor to honor data  on page 31
level security.
After enabling data level security, you 
configure data level security for the 
roles to which a user belongs. If a user 
belongs to more than one role, the user 
will have the ability to view and act on 
the data identified in all their roles.

2 Set data level You identify the processes to which a  “Identifying 

security for role has access. Processes a Role 
processes Can Act On” on 
page 32

3 Set data level You identify the services to which a  “Identifying 

security for role has access. Services a Role 
services Can Act On” on 
page 33

4 Set data level You identify the document types of the  “Identifying 

security for documents to which a role has access. Documents a Role 
documents Can Act On” on 
page 34

Enabling Data Level Security

When data level security is disabled, users are not restricted as to what data they can 
access; they can access all logged data. If you want to limit the data to which users have 
access, enable data level security and then specifically identify the data to which the roles 
have access. 

webMethods Monitor User’s Guide Version 7.1 31

 2. Configuring Monitor

To enable data level security for Monitor

1 In the Integration Server Administrator (of the supporting Integration Server):
Packages > Management.
The Package List table displays the list of packages in the Integration Server.
2 Click the Home icon for the WmMonitor package.
3 Select the Enable Data Level Security check box.
4 In the Data Level Security Administrator field, type the user name of a user who has 
complete access to all My webMethods data and all pages of the My webMethods 
user interface. By default, this field is set to Administrator, which is the webMethods 
default administrator.
5 Click Submit. 

Identifying Processes a Role Can Act On

When data level security is disabled, users who have access privileges to process instances 
pages can view logged data for all process instances. 
When you enable data level security, by default roles have no access to processes. You 
must configure data level security for roles to identify the processes a role can view and 
act on. After configuring data level security for roles, if a user belongs to multiple roles, 
that user will be able to work with all the processes identified in all the roles to which the 
user belongs.

To identify the processes a role can act on

1 In My webMethods: Administration > System-Wide > User Management > Roles.

2 Search for the role for which you want to configure data level security and edit the 
role. If you need more detailed instructions for this step, see the My webMethods Server 
Administrator’s Guide.
3 On the Edit Role page, click the Data Level Security tab; then click the Business Process
link.
My webMethods displays the list of all processes that the role currently has access to.
4 To delete processes that you no longer want the role to be able to access:
a Select the check boxes beside the processes you want to delete.
b Click Delete.

webMethods Monitor User’s Guide Version 7.1 32

 2. Configuring Monitor

5 To add additional processes that you want to allow the role to access:
a Click Add Processes.
b Use the Add Processes page to identify the processes to which you want the role 
to have access.
c Click OK to save your changes.
6 Click Apply on the Edit Role page.

Identifying Services a Role Can Act On

When data level security is disabled, users who have access privileges to pages that 
display service information can view logged data for all services. 
When you enable data level security, by default roles have no access to services. You must 
configure data level security for roles to identify the services a role can view and act on. 
After configuring data level security for roles, if a user belongs to multiple roles, that user 
will be able to work with all the services identified in all the roles to which the user 
belongs.

To identify the services a role can act on

1 In My webMethods: Administration > System-Wide > User Management > Roles.

2 Search for the role for which you want to configure data level security and edit the 
role. If you need more detailed instructions for this step, see the My webMethods Server 
Administrator’s Guide.
3 On the Edit Role page, click the Data Level Security tab; then click the Service link.
My webMethods displays the list of all services that the role can currently access.
4 To delete services that you no longer want the role to be able to access:
a Select the check boxes beside the services you want to delete.
b Click Delete.
5 To add additional services that you want to allow the role to access
a Click Add Services.
b Use the Add Services page to identify the services to which you want the role to 
have access.
c Click OK to save your changes.
6 Click Apply on the Edit Role page.

webMethods Monitor User’s Guide Version 7.1 33

 2. Configuring Monitor

Identifying Documents a Role Can Act On

When data level security is disabled, users who have access privileges to pages that 
display document information can view logged data for all documents. 
When you enable data level security, by default roles have no access to documents. You 
must configure data level security for roles to identify the documents a role can view and 
act on. After configuring data level security for roles, if a user belongs to multiple roles, 
that user will be able to work with all the documents identified in all the roles to which the 
user belongs.

To identify the documents a role can act on

1 In My webMethods: Administration > System-Wide > User Management > Roles.

2 Search for the role for which you want to configure data level security and edit the 
role. If you need more detailed instructions for this step, see the My webMethods Server 
Administrator’s Guide.
3 On the Edit Role page, click the Data Level Security tab; then click the Document link.
My webMethods displays the list of all documents that the role can currently access.
4 To delete documents that you no longer want the role to be able to access:
a Select the check boxes beside the documents you want to delete.
b Click Delete.
5 To add additional documents that you want to allow the role to access:
a Click Add Documents.
b Use the Add Documents page to identify the documents to which you want the 
role to have access.
c Click OK to save your changes.
6 Click Apply on the Edit Role page.

webMethods Monitor User’s Guide Version 7.1 34

 2. Configuring Monitor

Setting Up to Generate Reports

To set up to generate reports

1 Install the Staging and Reporting database components, then connect Integration 
Server to them. For instructions, see the webMethods Installation Guide.
2 Populate the Staging and Reporting database components using these services: 

Service Description
pub.monitor.reporting.processDataMart: Copy logged data for process instances and 
extract process steps from the Process Audit Log 
database component into the Staging 
database component.
pub.monitor.reporting.processDataMart: Accumulate the data and load it into the 
transformAndLoad Reporting database component.
pub.monitor.reporting.processDataMart: Aggregate the data into daily metrics in the 
aggregateDay Reporting database component.

webMethods recommends that you schedule the services to run automatically, at 
specific times or intervals. Running the services regularly minimizes the time 
required to process the data. For instructions on scheduling services, see the 
webMethods Integration Server Administrator’s Guide. For instructions on using the 
services, see the webMethods Monitor Built‐In Services Reference Guide. 

Note: Do not run these services on Integration Servers that run process instances in 
your production environment. These services consume large amounts of CPU and 
adversely affect performance.

The Process Audit Log, Reporting, and Staging database components have a 1‐to‐1‐to‐
1 relationship. You cannot copy data from multiple Process Audit Log database 
components into the same Reporting database component.

If the amount of data to process is very large, you can schedule the 
pub.monitor.reporting.processDataMart:extract and pub.monitor.reporting.processDataMart:
transformAndLoad services to run more than once a day. Schedule the 
pub.monitor.reporting.processDataMart:aggregateDay service separately, so it is run only a 
single time per day. It is not useful to run this service more often.
3 The services that populate the Reporting database component use batch processing; 
each service uses the same batches of data. The default batch size is 100, which 
equates to about 100 rows from the WMPROCESS table. However, this number does 
not represent exactly 100 processes per batch because the services take all rows 
associated with a process from the WMPROCESS and WMPROCESSSTEP tables. 

webMethods Monitor User’s Guide Version 7.1 35

 2. Configuring Monitor

Multiple rows in the WMPROCESS table might apply to the same process, and all 
rows with the same timestamp will be processed in the same batch. One row in the 
WMPROCESS table might correspond to several rows in the WMPROCESSSTEP 
table, depending on how many steps run in a process. You might want to adjust the 
batch size after taking all these considerations into account. Configure the batch size 
as follows:
a In the Integration Server Administrator (of the supporting Integration Server), go 
to the Packages > Management page.
b Click the Home icon for the WmMonitor package.
c In the Reporting Batch Size field, specify the batch size to use.
d Click Submit.

Setting Up to Archive Data

To set up to archive data

1 Install the Archive database component, then connect Integration Server to it. For 
instructions, see the webMethods Installation Guide.
2 Configure the Archive database component. To do so, run the 
pub.monitor.archive:setOperationParameters service from Developer and specify the input 
parameters described below. The setOperationParameters service sets the values that you 
specify in the OPERATION_PARAMETER table of the Archive database component. 
For more information about the setOperationParameters service, see the webMethods 
Monitor Built‐In Services Reference Guide.  

Parameter Entry

PROCESSAUDIT_DBLINK If you want to archive from the Process Audit Log 
database component and it is installed on a different 
database server from the Archive database 
component, specify the name of the DBlink you 
created for Archive to use to link to the Process Audit 
Log database component.
ISCOREAUDIT_DBLINK If you want to archive from the IS Core Audit Log 
database component and it is installed on a different 
database server from the Archive database 
component, specify the name of the DBlink you 
created for Archive to use to link to the IS Core Audit 
Log database component.

webMethods Monitor User’s Guide Version 7.1 36

 2. Configuring Monitor

Parameter Entry

PROCESS_SCHEMA If you want to archive from the Process Audit Log 
database component, identify it by specifying:
For Oracle, specify the database user

For SQL Server, specify the database name
ISCORE_SCHEMA If you want to archive from the IS Core Audit Log 
database component, identify it by specifying:
For Oracle, specify the database user

For SQL Server, specify the database name

3 Set database permissions to allow the Archive database component to act on the IS 
Core Audit Log and Process Audit Log database components. To do so, use the 
GRANT command to give the Archive database user permission to select and delete 
from the Process Audit Log database component, the IS Core Audit Log database 
component, or both, depending on the data you want to archive.
4 Configure the number of days of audit information that Monitor should retain when 
performing an archive operation. The default is 14 days.
a In the Integration Server Administrator (of the supporting Integration Server) go 
to the Packages > Management page. The Package List table displays the list of 
packages in the Integration Server.
b Click the Home icon for the WmMonitor package.
c Specify the number of days of audit information to retain using the Archive Results
Days setting.
d Click Submit. 

webMethods Monitor User’s Guide Version 7.1 37

 2. Configuring Monitor

webMethods Monitor User’s Guide Version 7.1 38

Chapter 3. Service Monitoring

Before You Can Monitor Logged Service Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Searching for Logged Service Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Viewing Information for a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Resubmitting Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

webMethods Monitor User’s Guide Version 7.1 39

 3. Service Monitoring

Before You Can Monitor Logged Service Data

Before logged service data is available for monitoring, service logging must be set up. The 
types and amounts of data that Monitor displays for a service depend on the service’s 
logging setup. For detailed information on possible service logging setups, see the 
webMethods Logging Guide.
After service logging is set up, an administrator:
Must configure My webMethods to allow you to access the My webMethods pages for 
viewing logged service data. For more information, see “Granting Users Access to the 
My webMethods Monitoring Pages” on page 25. 
Can also restrict the services that you are able to view. For more information, see 
“Identifying the Logged Data Users Can Perform Actions Against” on page 30 and 
“Identifying Services a Role Can Act On” on page 33. 
Must configure whether you can resubmit services or whether you can modify the 
pipeline for services before resubmitting them. For more information, see “Granting 
Users the Ability to Perform Monitor Actions” on page 27. 

Searching for Logged Service Data

The following table lists tasks related to searching for logged service data and where to 
find more information about each task.

Task For more information, see...

Search for services with names that contain  “Performing a Keyword Search for 
keywords that you specify. Logged Service Data” on page 41 and 
the Getting Started with My 
webMethods guide
Perform a detailed search for specific logged  “Performing an Advanced Search for 
services data. Logged Service Data” on page 42

webMethods Monitor User’s Guide Version 7.1 40

 3. Service Monitoring

Task For more information, see...

Set the following search options for the  Getting Started with My webMethods
Services page:
The search tab that Monitor displays 
when initially displaying the Services 
page
The search you want Monitor to execute, 
if any, when initially displaying the 
Services page
The maximum number of search results 
you want Monitor to display in response 
to a search
Save searches for logged service data. Getting Started with My webMethods 
Re‐execute saved searches for logged service  Getting Started with My webMethods 
data.

Performing a Keyword Search for Logged Service Data

Use this search to find logged service data by specifying keywords found in the names of 
the services.

Note: Whether the search is case‐sensitive or case‐insensitive depends on how the 
underlying database (for example, Oracle, DB2, or SQL server) handles the queries that 
Monitor issues to obtain data.

To perform a keyword search for logged service data

1 In My webMethods: Monitoring > Integration > Services.

2 Click the Keyword tab if it is not already displayed.
3 If Monitor is configured to use multiple Integration Servers, use the Server selection 
box (above the Search tabs) to specify which server you want to search. The Server 
selection box defaults to the last server specified by the currently logged in user. If the 
current user has not selected a server, the default server set by the My webMethods 
Server Administrator on the System Settings page will be used.

webMethods Monitor User’s Guide Version 7.1 41

 3. Service Monitoring

4 In the text box, type the keywords that are contained in the service names of the 
services you want to find. For example, you might specify:
The fully qualified name of the service (for example, 
OrderPartner.Services:processOrder) 

A partial service name (for example, processOrder) to select all services that 
contain the specified keyword
If you leave the text box blank, Monitor searches for all logged service data that you 
are authorized to view. For more information about how to specify keywords, see the 
Getting Started with My webMethods guide.
5 Click Go to execute the search.
Monitor displays the search results below the search panel. For information about 
how to work with the search results, see “Viewing Information for a Service” on 
page 45 and “Resubmitting Services” on page 49. For information about saving the 
search criteria to re‐use at a later time, see the Getting Started with My webMethods 
guide.

Performing an Advanced Search for Logged Service Data

Use an advanced search to specify detailed criteria to search for specific logged service 
data. To set the maximum number of search results that Monitor returns, see information 
about setting search options in the Getting Started with My webMethods guide.

Note: Whether the search is case‐sensitive or case‐insensitive depends on how the 
underlying database (for example, Oracle, DB2, or SQL server) handles the queries that 
Monitor issues to obtain data.

To perform an advanced search for logged service data

1 In My webMethods: Monitoring > Integration > Services.

2 Click the Advanced tab if it is not already displayed.

Note: The top, unlabeled text box on the Advanced tab and the Service Name field are 

both for specifying the full or partial name of the services you want to find. Use only 
one of these fields.

3 If Monitor is configured to use multiple Integration Servers, use the Server selection 
box (above the Search tabs) to specify which server you want to search. The Server 
selection box defaults to the last server specified by the currently logged in user. If the 

webMethods Monitor User’s Guide Version 7.1 42

 3. Service Monitoring

current user has not selected a server, the default server set by the My webMethods 
Server Administrator on the System Settings page will be used.
4 Fill in one or more of the following advanced criteria fields:

In this field... Specify...

Service Name The fully qualified name (for example, 

OrderPartner.Services:processOrder) or partial service name 
(for example, processOrder) of the services you are searching for. 
If you leave this field blank, Monitor does not restrict the search 
by service name.
Server ID The Integration Server on which the services ran or are running. 
Type the Integration Server’s DNS name and port (for example, 
integration.east.rubicon.com:5555) or partial DNS name or 
port for example, rubicon). If you leave this field blank, Monitor 
does not restrict the search by server.
Status The status of the service you are searching for. To select multiple 
statuses, click CTRL while selecting each status. If you leave this 
field blank, Monitor does not restrict the search by status. For 
more information about the statuses, see “Statuses of Services” on 
page 48.
User The full or partial user name of the client that invoked the service. 
If you leave this field blank, Monitor does not restrict the search 
by user.

webMethods Monitor User’s Guide Version 7.1 43

 3. Service Monitoring

In this field... Specify...

Filter By A date and time range to use to narrow the search
Range
Field Description

Filter By Type of date and time range you want to use:
Date Last Updated to search for services based on 
the last date and time information was logged for 
the service.
Start Date to search for services based on when the 
service was started.
Range The dates and times for the range. You can either:
Click a predefined time period from the Range list.

Use the calendar picker to specify a Start Date and 
End Date, then select the numbers for the hours 
and minutes from their respective lists.

Note: If you want to add the search results to a My 
webMethods custom page, it is recommended that 
you use a predefined time period from the Range list. 
When you do, the search results on the custom page 
will be dynamic showing data relative to the current 
date (e.g., yesterday). If you specify exact start & end 
dates, the search results always contain data for the 
specific dates you use.

Context ID The context ID of the service for which you are searching. You 
must specify the full context ID.
Parent Context The context ID of the parent service that invoked the service(s) for 
ID which you are searching. You must specify the full context ID.
Use this field to find all services invoked by the specified parent 
service. You can find the context ID for a service by viewing the 
Service Detail page. For more information, see “Viewing Detailed 
Information for a Service” on page 46.
Activity Full or partial message entered into the Full Message field using the 
Message pub.prt.log:logActivityMessages service. If you leave this field 
blank, Monitor does not restrict the search by Activity Message 
content.

webMethods Monitor User’s Guide Version 7.1 44

 3. Service Monitoring

In this field... Specify...

Root Context ID The root context ID of the service(s) for which you are searching. 

You must specify the full context ID.
Use this field to find all services that were invoked one after 
another starting with the specified root service. You can find the 
context ID for a service by viewing the Service Detail page. For 
more information, see “Viewing Detailed Information for a 
Service” on page 46.
Show root level Whether you want Monitor to include all services it finds in the 
services only search results or only root‐level services. Select this check box to 
have Monitor display only root‐level services.
The root‐level service is the initial service that was invoked by a 
client. This initial (root‐level) service can, in turn, invoke other 
services, which also can continue to invoke others. Only the 
service originally invoked by the client is considered the root‐level 
service.
Search Whether you want Monitor to use an AND condition or an OR 
Condition condition with the search criteria you specify.
Select AND if you want Monitor to find services that match all 
of the search criteria you specify.
Select OR if you want Monitor to find services that match any 
of the search criteria you specify.

5 Click Go to execute the search.
Monitor displays the search results below the search panel. For information about 
how to work with the search results, see “Viewing Information for a Service” on 
page 45 and “Resubmitting Services” on page 49. For information about saving the 
search criteria to re‐use at a later time, see the Getting Started with My webMethods 
guide.

Viewing Information for a Service

This section describes information about that Monitor displays about services. It includes 
viewing:
Detailed information for a service

Statuses for services

webMethods Monitor User’s Guide Version 7.1 45

 3. Service Monitoring

Viewing Detailed Information for a Service

You can view detailed information for the services that Monitor displays in the search 
results on the Monitoring > Integration > Services page.

To view detailed information for a service in the search results

1 Search for the service you want to view. For more information, see “Searching for 
Logged Service Data” on page 40.
2 In the search results, locate the service for which you want to view details and click 
View Detail. Monitor displays the Service Detail page.
For a description of the information that Monitor displays on the Service Detail page, 
see “Information Displayed on the Service Detail Page” below. For a list of the actions 
you can take from the Service Detail page, see “Actions You Can Take from the Service 
Detail Page” on page 48.

Information Displayed on the Service Detail Page

The following table describes the information that Monitor displays on the Monitoring > 
Integration > Services > Service Detail page.

Tab Description
Service Information Monitor displays information that identifies the service on the 
Service Information tab. 
Field Description

Service Name The fully‐qualified name of the service.

Root Context ID The context ID of the root‐level service. 
Parent Context The context ID of the service that invoked of the 
ID service. 
Context ID The context ID of the service. 

webMethods Monitor User’s Guide Version 7.1 46

 3. Service Monitoring

Tab Description
Server ID The DNS name and port number of the 
Integration Server on which the service ran or is 
running. 
User The user name of the client that invoked the 
service.
Timestamp The date and time on which the activity indicated 
by Current Status (for example, Failed) was logged.
Current Status The current status of the service. For more 
information, see “Statuses of Services” on 
page 48.
Duration The length of time the service took to execute or 
has been active.
Error Message The error message associated with the service. 
Monitor only displays the Error Message field 
when the Current Status is Failed.
Root Service The fully qualified name of the root service of the 
service whose details Monitor is displaying.
Child Services The fully qualified names of all services that the 
service whose details Monitor is displaying 
invoked. 
History Statuses the service went through and the date and time each 
status occurred. For a list of statuses, see “Statuses of Services” on 
page 48.
Activity Messages If the service logged user‐defined messages by calling the 
pub.prt.log:logActivityMessages service, this area shows the logged 
messages, and dates and times on which the messages were 
logged.
Control Actions If the service has been resubmitted, this area shows the user names 
of the users who resubmitted the service, the Integration Servers 
on which the service was resubmitted, and the dates and times 
when the service was resubmitted.

Note: Each time a service is resubmitted, Integration Server assigns 
it a new context ID.

Service Errors If errors occurred while the service was running, this area shows 

detailed error stack trace data for all errors and the dates and times 
the errors were logged.

webMethods Monitor User’s Guide Version 7.1 47

 3. Service Monitoring

Actions You Can Take from the Service Detail Page

You can perform the following actions from the Monitoring > Integration > Services > 
Service Detail page:
Save the input pipeline for the service to an XML file using the Save Pipeline to File 
button. You might want to save the pipeline for a service if you want to test the service 
or a similar service and want to have actual data available for the test.
Resubmit the service. For more information, see “Resubmitting Services” on page 49.

Edit the pipeline for a root‐level service before resubmitting the service. For more 
information, see “Resubmitting Services” on page 49.

Statuses of Services
Monitor displays statuses for services using both a status keyword (e.g., Completed or 
Started) and also by using status icons. The following lists the location where Monitor 
displays statuses and status icons for a service:
On the Services page, Monitor displays:
A status icon at the beginning of the row for each service. The icon is located after 
the check box for the row.
The status keyword in the STATUS column.
On the Service Detail page, Monitor displays the status keyword in the Current Status field 
on the Service Information tab.
The following table lists the possible service status icons along with their meanings:

Status Icon Meaning

The service completed successfully.

The service is running; however, it has encountered errors.

Service completed, but it encountered errors. 

The following table lists the possible service statuses along with their meanings:

Status Meaning
Completed The service has completed processing.
Failed The service stopped processing because it encountered an error.
Resubmitted Execution of the service has been resubmitted.
Started The service has started and is currently executing.

webMethods Monitor User’s Guide Version 7.1 48

 3. Service Monitoring

Resubmitting Services
You can resubmit root‐level services whose input pipeline was logged. The services can 
have any status.
When you resubmit a service, Monitor changes the status of the service to Resubmitted. It 
then starts a new instance of the service and sets its status to Started. Monitor uses the 
context ID of the original service as the parent context ID for the new instance of the 
service. All logged information for the original service (now in Resubmitted status) 
remains unchanged. All information about the resubmission will be logged for the new 
instance of the service.
If you want to edit the pipeline before resubmitting the service, you must resubmit the 
service from the Service Detail page. After you update the pipeline, the changes you make 
are only available while you are still on the Service Detail page. If you leave this page, the 
changes you make are not maintained. As a result, if you want to edit the pipeline before 
resubmitting, you must edit the pipeline and then immediately resubmit the service. The 
pipeline for the original instance of the service is left unchanged. Monitor logs the 
updated pipeline with the new instance of the service.

Resubmitting a Service
You can resubmit one or more services from the search results panel of the Monitoring > 
Integration > Services page. 

To resubmit services

1 Search for the services you want to resubmit. For more information, see “Searching 
for Logged Service Data” on page 40.
2 In the search results, select the check boxes beside the services that you want to 
resubmit.
3 Click Resubmit.

Editing the Pipeline Before Resubmitting a Service

You can edit a service pipeline before you resubmit the service.

Important! The changes you make to the pipeline are only available while you are viewing 
the Service Detail page. If you leave this page, the changes you make are lost. To resubmit 
with the updated pipeline, you must resubmit the service immediately from the Service 
Detail page, as described in the procedure below.

webMethods Monitor User’s Guide Version 7.1 49

 3. Service Monitoring

To edit the pipeline for a service and then resubmit the service

1 Search for the service whose pipeline you want to edit. For more information, see 
“Searching for Logged Service Data” on page 40.

2 In the search results, locate the service that you want to resubmit and click  View
Detail. Monitor displays the Service Detail page.
3 Click Edit Pipeline.
4 On the Edit Pipeline page, update the fields you want to change:
a Click the hyperlinked field value.
b Specify a new value for the field.
c Click OK.
5 After you have modified all the fields you want changed, click Save.
Monitor re‐displays the Service Detail page.
6 To resubmit the service, click the Resubmit button on the Service Detail page.

webMethods Monitor User’s Guide Version 7.1 50

Chapter 4. Document Monitoring

Before You Can Monitor Logged Document Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Searching for Logged Document Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Viewing Detailed Information for a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Resubmitting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

webMethods Monitor User’s Guide Version 7.1 51

 4. Document Monitoring

Before You Can Monitor Logged Document Data

Before logged document data is available for monitoring, document logging must be set 
up. The following types of documents are logged to the logging database:
Broker‐logged documents, that is documents that are identified for logging and that 
Broker clients publish or subscribe to.
In doubt, failed, and retries exceeded documents. 

Note: You monitor Trading Networks documents from the Trading Networks Web 
Manager.

For detailed information on setting up document logging, see the webMethods Logging 
Guide. After document logging is setup, an administrator:
Must configure My webMethods to allow you to access the My webMethods pages for 
viewing logged document data. For more information, see “Granting Users Access to 
the My webMethods Monitoring Pages” on page 25. 
Can also restrict the documents that you are able to view. For more information, see 
“Identifying the Logged Data Users Can Perform Actions Against” on page 30 and 
“Identifying Documents a Role Can Act On” on page 34. 
Must configure whether you can resubmit documents or whether you can modify the 
documents before resubmitting them. For more information, see “Granting Users the 
Ability to Perform Monitor Actions” on page 27. 

Searching for Logged Document Data

The following table lists tasks related to searching for logged document data and where to 
find more information about each task.

Task For more information, see...

Search for documents with names that contain  “Performing a Keyword Search for 
keywords that you specify. Logged Document Data” on page 53 
and the Getting Started with My 
webMethods guide
Perform a detailed search for specific logged  “Performing an Advanced Search for 
document data. Logged Document Data” on page 54

webMethods Monitor User’s Guide Version 7.1 52

 4. Document Monitoring

Task For more information, see...

Set the following search options for the  Getting Started with My webMethods
Documents page:
The search tab that Monitor displays 
when initially displaying the Documents 
page
The search you want Monitor to execute, 
if any, when initially displaying the 
Documents page
The maximum number of search results 
you want Monitor to display in response 
to a search
Save searches for logged document data. Getting Started with My webMethods
Re‐execute saved searches for logged  Getting Started with My webMethods
document data.

Performing a Keyword Search for Logged Document Data

Use this search to find logged document instance data by specifying keywords found in 
the names of the documents.

Note: Whether the search is case‐sensitive or case‐insensitive depends on how the 
underlying database (for example, Oracle, DB2, or SQL server) handles the queries that 
Monitor issues to obtain data.

To perform a keyword search for logged document data

1 In My webMethods: Monitoring >Integration > Documents.

2 Click the Keyword tab if it is not already displayed.
3 If Monitor is configured to use multiple Integration Servers, use the Server selection 
box (above the Search tabs) to specify which server you want to search. The Server 
selection box defaults to the last server specified by the currently logged in user. If the 
current user has not selected a server, the default server set by the My webMethods 
Server Administrator on the System Settings page will be used.

webMethods Monitor User’s Guide Version 7.1 53

 4. Document Monitoring

4 In the text box, type the keywords that are contained in the document names of the 
documents you want to find. For example, you might specify:
The full document name as it exists on the Broker (for example, 
wm::is::OrderProcess::Implementation::CanonicalOrder) 

The full document name as it exists on the Integration Server (for example, 
OrderProcess.Implementation:CanonicalOrder) 

A partial document name (for example, OrderProcess) to select all documents 
that contain the specified keyword
If you leave the text box blank, Monitor searches for all logged document data that 
you are authorized to view. For more information about how to specify keywords, see 
the Getting Started with My webMethods guide.
5 Click Go to execute the search.
Monitor displays the search results below the search panel. For information about 
how to work with the search results, see “Viewing Detailed Information for a 
Document” on page 58 and “Resubmitting Documents” on page 60. For information 
about saving the search criteria to re‐use at a later time, see the Getting Started with My 
webMethods guide.

Performing an Advanced Search for Logged Document Data

Use an advanced search to specify detailed criteria to search for specific logged document 
data. To set the maximum number of search results that Monitor returns, see information 
about setting search options in the Getting Started with My webMethods guide.

Note: Whether the search is case‐sensitive or case‐insensitive depends on how the 
underlying database (for example, Oracle, DB2, or SQL server) handles the queries that 
Monitor issues to obtain data.

To perform an advanced search for logged document data

1 In My webMethods: Monitoring > Integration > Documents.

2 Click the Advanced tab if it is not already displayed.

Note: The top, unlabeled text box on the Advanced tab and the Document Name field are 

both for specifying the full or partial name of the services you want to find. Use only 
one of these fields.

3 If Monitor is configured to use multiple Integration Servers, use the Server selection 
box (above the Search tabs) to specify which server you want to search. The Server 
selection box defaults to the last server specified by the currently logged in user. If the 

webMethods Monitor User’s Guide Version 7.1 54

 4. Document Monitoring

current user has not selected a server, the default server set by the My webMethods 
Server Administrator on the System Settings page will be used.
4 Fill in one or more of the following advanced criteria fields:

In this field... Specify...

Document Name The fully qualified name or partial name of the documents you 

are searching for. For example, you might specify the:
Full name of a Broker document, such as: 
wm::is::OrderProcess::Implementation::CanonicalOrder

Full name of an IS document, such as: 
OrderProcess.Implementation:CanonicalOrder

Partial name of a document, such as: OrderProcess
 If you leave this field blank, Monitor does not restrict the search 
by document name.
Document ID The full or partial document ID of the document you are 
searching for. The Broker or Integration Server that publishes the 
document generates the ID when it publishes the document. If 
you leave this field blank, Monitor does not restrict the search by 
document ID.
Type The type of documents you are searching for (for example, 
Broker, In Doubt, Retries). To select multiple types, click CTRL 
while selecting each type. To specify all types, leave the field 
blank, and Monitor does not restrict the search by type.

webMethods Monitor User’s Guide Version 7.1 55

 4. Document Monitoring

In this field... Specify...

Client ID The client ID associated with the documents you are searching 
for. Specify a partial client ID to search for documents associated 
with multiple clients.
The format for:
Broker IDs is Broker@host:port (for example, 
CustOps@qatest07:6849). To specify a partial client ID, you 
might specify only CustOps.
The format for IDs of Broker clients is 
clientprefix_folder1.folder2.foldern_trigger (for example, 
smitha_documenthistory.history.triggers_MsgHistory
WithNoResServiceTrigger). To specify a partial client ID, 
you might specify only smitha.
The value you specify for Client ID depends on the types of 
documents you are searching for.
To search for this type of
document... Specify...

Broker  IDs of the Brokers that logged the 
documents
In Doubt  IDs of the Broker clients associated 
with the triggers that originally 
processed the documents
Failed and Retries Exceeded  IDs of the original destination 
when failure/retries  Broker clients
exceeded occurred during 
delivery
Failed documents when  IDs of the Broker clients associated 
failure occurred during  with the triggers for which 
retrieval Integration Server originally tried to 
retrieve the documents

Note: For Failed and Retries Exceeded documents when failure 

occurred during publication, there is no client ID on which to 
search.

webMethods Monitor User’s Guide Version 7.1 56

 4. Document Monitoring

In this field... Specify...

Range A date and time range for the last date and time information was 
logged for the document. You can either:
Click a predefined time period from the Range list.

Use the calendar picker to specify a Start Date and End Date, 

then select the numbers for the hours and minutes from their 
respective lists.

Note: If you want to add the search results to a My webMethods 
custom page, it is recommended that you use a predefined time 
period from the Range list. When you do, the search results on the 
custom page will be dynamic showing data relative to the current 
date (e.g., yesterday). If you specify exact start & end dates, the 
search results always contain data for the specific dates you use.

Search Whether you want Monitor to use an AND condition or an OR 
Condition condition with the search criteria you specify.
Select AND if you want Monitor to find documents that match 
all of the search criteria you specify.
Select OR if you want Monitor to find documents that match 
any of the search criteria you specify.

5 Click Go to execute the search.
Monitor displays the search results below the search panel. For information about 
how to work with the search results, see “Viewing Detailed Information for a 
Document” on page 58 and “Resubmitting Documents” on page 60. For information 
about saving the search criteria to re‐use at a later time, see the Getting Started with My 
webMethods guide.

webMethods Monitor User’s Guide Version 7.1 57

 4. Document Monitoring

Viewing Detailed Information for a Document

You can view detailed information for the documents that Monitor displays in the search 
results on the Monitoring > Integration > Documents page.

To view detailed information for a document in the search results

1 Search for the document you want to view. For more information, see “Searching for 
Logged Document Data” on page 52.
2 In the search results, locate the document for which you want to view details and click 
View Detail. Monitor displays the Document Detail page.
For a description of the information that Monitor displays on the Document Detail 
page, see “Information Displayed on the Document Detail Page” below. For a list of 
the actions you can take from the Service Detail page, see “Actions You Can Take from 
the Document Detail Page” on page 59.

Information Displayed on the Document Detail Page

The following table describes the information that Monitor displays on the 
Monitoring > Integration > Documents > Document Detail page.

Tab Description
Document Monitor displays information that identifies the document on the 
Information Document Information tab. 
Field Description

Document Name The fully‐qualified name of the document.

Document ID The identifier of the document.
Client ID One of the following:
Broker documents, ID of the publishing 
Broker
For In Doubt documents, Failed documents 
that failed during delivery or retrieval, and 
Retries Exceeded documents that could not 
be delivered, ID of the intended recipient
For Failed documents that failed during 
publishing and for Retries Exceeded 
documents that could not be published, no 
client ID is listed.

webMethods Monitor User’s Guide Version 7.1 58

 4. Document Monitoring

Tab Description
Type The type of document, which will be one of the 
following:
Broker
Failed
In Doubt
Retries Exceeded
Enqueued If the document was logged by a Broker, date 
and time the Broker first enqueued the document 
(that is, added it to the first subscriberʹs queue)
Timestamp The date and time the document was logged.
Control Actions If the document has been resubmitted:
User name of the user who resubmitted the document

Broker documents, the Broker to which the document was 
delivered (always the Broker to which the Monitor‐equipped 
Integration Server is connected)
For In Doubt, Failed, and Retries Exceeded documents, see 
“Resubmitting Documents” on page 60
Dates and times the document was resubmitted

Actions You Can Take from the Document Detail Page

You can perform the following actions from the Monitoring > Integration > Documents > 
Document Detail page:
Resubmit the document. In addition to resubmitting documents from the Document 
Detail page, you can also resubmit documents from the Documents page. For more 
information about resubmitting, see “Resubmitting Documents” on page 60.
Edit the fields using within a document before resubmitting it. For more information, 
see “Resubmitting Documents” on page 60.

webMethods Monitor User’s Guide Version 7.1 59

 4. Document Monitoring

Resubmitting Documents
When you resubmit a document, Monitor logs a new instance of the document. All logged 
information for the original document remains unchanged. All information about the 
resubmission will be logged for the new instance of the document.
If you want to edit the fields in the document before resubmitting it, you must resubmit 
the document from the Document Detail page. After you update the document, the 
changes you make are only available while you are still on the Document Detail page. If 
you leave this page, the changes you make are not maintained. As a result, if you want to 
edit the document before resubmitting, you must edit the document and then 
immediately resubmit it. The fields for the original instance of the document are left 
unchanged. Monitor logs the updated document with the new instance of the document.
You can resubmit any type of document. The following table describes how Monitor 
resubmits each type of document:

Document Monitor...
Broker documents Publishes the documents to the Broker to which the 
Monitor‐equipped Integration Server is connected.
In Doubt documents Delivers the documents to the triggers that originally 
processed the documents.
Failed documents
Failed during delivery Delivers the documents to the original destination 
Broker clients.
Failed during publication Publishes the documents to the Broker to which the 
Monitor‐equipped Integration Server is connected.
Failed during retrieval Delivers the documents to the triggers for which 
Integration Server originally tried to retrieve the 
documents.
Retries exceeded documents
Exceeded during delivery Delivers the documents to the original destination 
Broker clients.
Exceeded during  Publishes the documents to the Broker to which the 
publication Monitor‐equipped Integration Server is connected.

webMethods Monitor User’s Guide Version 7.1 60

 4. Document Monitoring

Resubmitting a Document
You can resubmit one or more documents from the search results panel of the 
Monitoring > Integration> Documents page. 

To resubmit documents

1 Search for the documents you want to resubmit. For more information, see “Searching 
for Logged Document Data” on page 52.
2 In the search results, select the check boxes beside the documents that you want to 
resubmit.
3 Click Resubmit.

Editing Document Information Before Resubmitting the

Document
You can edit the fields of a document before you resubmit the document.

Important! The changes you make to the document are only available while you are 
viewing the Document Detail page. If you leave this page, the changes you make are lost. 
To resubmit with the updated document, you must resubmit the document immediately 
from the Document Detail page, as described in the procedure below.

To edit the fields in a document and then resubmit the document

1 Search for the document you want to edit. For more information, see “Searching for 
Logged Document Data” on page 52.

2 In the search results, locate the document that you want to resubmit and click  View
Detail. Monitor displays the Document Detail page.
3 Click Edit Document.
4 On the Edit Document page, update the fields you want to change:
a Click the hyperlinked field value.
b Specify a new value for the field.
c Click OK.
5 After you have modified all the fields you want changed, click Save.
Monitor re‐displays the Document Detail page.
6 To resubmit the document, click the Resubmit button on the Document Detail page.

webMethods Monitor User’s Guide Version 7.1 61

 4. Document Monitoring

webMethods Monitor User’s Guide Version 7.1 62

Chapter 5. Process Monitoring

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Before You Can Monitor Logged Process Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Types of Processes You Can Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Searching for Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Viewing Information for Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Stopping, Suspending, and Resuming Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Resubmitting Process Instances and Process Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

webMethods Monitor User’s Guide Version 7.1 63

 5. Process Monitoring

Overview
This chapter describes monitoring logged data for process instances. 
In addition to monitoring data that has been logged for process instances, you can 
perform some management tasks of process models. For more information, see Chapter 6, 
“Working with Process Models”.

Before You Can Monitor Logged Process Data

Before logged data is available for process instances, process logging must be set up. For 
detailed information about how to set up process logging, see the webMethods Logging 
Guide and information about integrationProcessLogging services in the webMethods Monitor 
Built‐In Services Reference Guide.
After process logging is setup, an administrator:
Must configure My webMethods to allow you to access the My webMethods pages for 
viewing logged process instance data. For more information, see “Granting Users 
Access to the My webMethods Monitoring Pages” on page 25. 
Can also restrict the process instances that you are able to view. For more information, 
see “Identifying the Logged Data Users Can Perform Actions Against” on page 30 
and “Identifying Processes a Role Can Act On” on page 32. 
Must configure whether you can perform the following actions against process 
instances:
Stop, suspend, and resume process instances
Resubmit process instances
Modify the pipeline for a process instance and resubmit it
 For more information, see “Granting Users the Ability to Perform Monitor Actions” 
on page 27. 

webMethods Monitor User’s Guide Version 7.1 64

 5. Process Monitoring

Types of Processes You Can Monitor

The table below describes the types of processes that you can monitor from My 
webMethods.

Process Type Description

webMethods‐ A webMethods‐executed process is one that is modeled, executed, and 
executed monitored using webMethods tools.
Modeling the process. A webMethods‐executed process is modeled 
in webMethods Designer in the Developer perspective. 
Executing the process. At run time, the Process Engine manages the 
execution of the webMethods‐executed processes. The Process 
Engine also logs data that you can monitor from My webMethods.
Displaying the type in My webMethods. On the Administration > 
Business > Business Processes page of My webMethods, the Type 
column for this type of process is listed as webMethods.
Note: If the page does not include a Type column, all processes in 
your system are webMethods‐executed processes. 
Externally  An externally executed process is one that is modeled and monitored 
executed using webMethods tools; however, the process is executed by an 
external application.
Modeling the process. An externally executed process is one that is 
based on a process model that was designed in webMethods 
Designer in the Business Analyst perspective.
Executing the process. Although the process model was created in 
webMethods Designer, it is only a diagram of a process that is 
executed by some external (non‐webMethods) application. The 
external application uses the Optimize Web Service Data Collector 
to collect business process data about the externally executed 
process. You can monitor the data obtained via the Optimize Web 
Service Data Collector from My webMethods. For more 
information about the Optimize Web Service Data Collector and 
creating externally executed processes, see the webMethods 
Optimize for Process Administrator’s Guide.
Displaying the type in My webMethods. On the Administration > 
Business > Business Processes page of My webMethods, the Type 
column for this type of process is listed as External.

webMethods Monitor User’s Guide Version 7.1 65

 5. Process Monitoring

Process Type Description

Integration  An integration process is a process that is composed of one or more 
process services that run on Integration Servers. You form an integration 
process by creating services that invoke one service after another.
Modeling the process. No model exists for an integration process.

Executing the process. The Integration Server executes the services 

that you include in the integration process. To track the progress 
and results of the process, code your services to log data by 
invoking services in the pub.monitor.integrationProcessLogging folder of 
the WmMonitor package. You can monitor the logged data from 
My webMethods. For more information about creating integration 
processes and logging data for them, see “About Integration 
Process Logging” and “Setting Up Integration Process Logging” 
below.
Displaying the type in My webMethods. On the Administration > 
Business > Business Processes page of My webMethods, the Type 
column for this type of process is listed as Integration.

About Integration Process Logging

Integration process logging provides data about integration processes, which are 
processes that are composed of one or more services that run on Integration Servers. You 
form integration processes by creating services that invoke one service after another. No 
model exists for an integration process.
You determine the data that is logged for an integration process by invoking built‐in 
services that are provided with Monitor in the pub.monitor.integrationProcessLogging folder of 
the WmMonitor package. When data is logged for an integration process, you can then 
monitor and track its progress using Monitor pages in My webMethods.

Note: Although you can view information about integration processes via Monitor, 
integration processes are not eligible for stopping, suspending, resuming, or resubmitting.

Setting Up Integration Process Logging

This section illustrates how to use the pub.monitor.integrationProcessLogging services in your 
integration processes. For details about the services in the 
pub.monitor.integrationProcessLogging folder, see Chapter 4 in the webMethods Monitor Built‐In 
Services Reference Guide.

webMethods Monitor User’s Guide Version 7.1 66

 5. Process Monitoring

Defining an Integration Process

The following sample shows how you might use the pub.monitor.integrationProcessLogging 
services to define an integration process, the steps for an integration process, and the 
fields you want to log for an integration process. See the table below the sample for more 
details.

1
2

Flow
Operations Description

1 To add a definition for the integration process, invoke the 
pub.monitor.integrationProcessLogging:createProcessMetadata service. The process definition is 
comparable to an entry for a process model that was created with Designer. 
After you add a process definition, you can then add steps to the process.

2 To add a definition for a step that is part of the integration process, invoke the 
pub.monitor.integrationProcessLogging:createStepMetadata service. The step definition is 
comparable to an entry for a step added to a process model that was created with 
Designer.
After you add a step definition, you can add definitions for one or more logged fields 
that are associated with the step. 

3 To add a logged field and associate it with a step, invoke the 
pub.monitor.integrationProcessLogging:createLoggedFieldMetadata service. The logged field 
definitions are comparable to custom data in a process model that was created with 
Designer.
In the sample above, two logged fields are defined for and associated with the first 
step of the integration process.

4 Continue using the pub.monitor.integrationProcessLogging:createStepMetadata service to add 
additional steps and pub.monitor.integrationProcessLogging:createLoggedFieldMetadata service 
to add logged fields for the steps. In the sample above, a second and third step are 
added. One logged field is defined for and associated with the third step.

webMethods Monitor User’s Guide Version 7.1 67

 5. Process Monitoring

Executing an Integration Process

After defining an integration process, including defining the process steps and logged 
fields, you can then create running instances of the integration process. The following 
sample shows how you might use the pub.monitor.integrationProcessLogging services to create 
and execute an instance of an integration process that you have already defined. See the 
table below the sample for more details.

1
2
3
4

webMethods Monitor User’s Guide Version 7.1 68

 5. Process Monitoring

Flow
Operations Description

1 Each process requires a unique process instance ID. You can either create one on your 
own, or use the pub.monitor.integrationProcessLogging:generateProcessInstanceID service to 
generate a unique process instance ID. 

Note: This service does not add data to the Process Audit Log database component. 
That is, it does not start a new instance of the integration process.

2 To log a running instance of an integration process, create a process instance. To 
create a new process instance, invoke the 
pub.monitor.integrationProcessLogging:createProcessInstance service. As input to this service, 
you must identify the process definition for which you are creating the instance. The 
process definition must already exist in the Process Audit Log database component, 
which you add using the pub.monitor.integrationProcessLogging:createProcessMetadata 
service, as shown in the sample in “Defining an Integration Process” on page 67.
After you create the process instance, its process status is Started. Use the 
pub.monitor.integrationProcessLogging:updateProcessInstanceStatus service if you want to 
change the process status.

3 To start logging information about the first step in the integration process, create an 
instance of the first step. To create a step instance, invoke the 
pub.monitor.integrationProcessLogging:createStepInstance service. As input to this service, you 
identify:
The process instance in which the step is running. You would specify the same 
process instance ID that you specified as input to the 
pub.monitor.integrationProcessLogging:createProcessInstance service in the previous 
INVOKE flow operation. 
The step definition for which you are creating the instance. The step definition 
must already exist in the Process Audit Log database component, which you add 
using the pub.monitor.integrationProcessLogging:createStepMetadata service.
After you create the step instance, the step status is Started. Use the 
pub.monitor.integrationProcessLogging:updateStepInstanceStatus service if you want to change 
the step status.

4 After the step instance is logged, execute the service(s) for the first step of the 
integration process. The next flow operations are based on the outcome of this step.

webMethods Monitor User’s Guide Version 7.1 69

 5. Process Monitoring

Flow
Operations Description

5 This series of flow operations shows how the logic you might perform when a step 
fails:
The step status is set to Failed using the 
pub.monitor.integrationProcessLogging:updateStepInstanceStatus service.
The process status is set to Failed using the 
pub.monitor.integrationProcessLogging:updateProcessInstanceStatus service.
An error message is logged for the process using the 
pub.monitor.integrationProcessLogging:createProcessError service.
A service you code is invoked to exit the integration process.

6 This series of flow operations shows the logic you might perform when a step is 
successful:
Values are set for logged fields that are associated with the step using the 
pub.monitor.integrationProcessLogging:createLoggedFieldInstance service.
The step status is set to Completed using the 
pub.monitor.integrationProcessLogging:updateStepInstanceStatus service.

7 This series of flow operations handles the second step in the integration process. The 

flow operations are similar to those described above in  4 ,  5 , and  6 .

8 This series of flow operations handles the third step in the integration process. The 

flow operations are similar to those described above in  4 ,  5 , and  6 .

webMethods Monitor User’s Guide Version 7.1 70

 5. Process Monitoring

Searching for Process Instances

The following table lists tasks related to searching for logged process data and where to 
find more information about each task.

Task For more information, see...

Search for process instance with names and  “Performing a Keyword Search for 
process instance IDs that contain keywords that  Logged Process Data” on page 71
you specify.
Perform a detailed search for specific logged  “Performing an Advanced Search 
process data. for Logged Process Data” on 
page 72
Set the following search options for the Process  Getting Started with My webMethods 
Instances page:
The search tab that Monitor displays when 
initially displaying the Process Instances 
page
The search you want Monitor to execute, if 
any, when initially displaying the Process 
Instances page
The maximum number of search results 
you want Monitor to display in response to 
a search
Save searches for logged process data. Getting Started with My webMethods 
Re‐execute saved searches for logged process  Getting Started with My webMethods 
data.

Performing a Keyword Search for Logged Process Data

Use this search to find data that was logged about process instances on the current date. 
To view logged process instance data for later dates or a wider date range, use the 
advanced search; see “Performing an Advanced Search for Logged Process Data” on 
page 72.
To locate process instance data, you specify keywords found in the names of the models 
used for process instances and their process instance IDs. 

Note: Whether the search is case‐sensitive or case‐insensitive depends on how the 
underlying database (for example, Oracle, DB2, or SQL Server) handles the queries that 
Monitor issues to obtain data.

webMethods Monitor User’s Guide Version 7.1 71

 5. Process Monitoring

To perform a keyword search for logged process instance data

1 In My webMethods: Monitoring > Business > Process Instances.

2 Click the Keyword tab if it is not already displayed.
3 If Monitor is configured to use multiple Integration Servers, use the Server selection 
box (above the Search tabs) to specify which server you want to search. The Server 
selection box defaults to the last server specified by the currently logged in user. If the 
current user has not selected a server, the default server set by the My webMethods 
Server Administrator on the System Settings page will be used.
4 In the text box, type the keywords that are contained in the name of the models used 
for the process instances or instance IDs of the process instances you want to find. For 
more information about how to specify keywords, see the Getting Started with My 
webMethods guide.
If you leave the text box blank, Monitor returns data for all process instances that you 
are authorized to view, honoring the maximum results search option. For more 
information about setting the maximum results search option, see the Getting Started 
with My webMethods guide.
5 Click Go to execute the search.
Monitor displays the search results below the search panel. For more information 
about how to work with search results, see “Viewing Information for Process 
Instances” on page 76, “Stopping, Suspending, and Resuming Process Instances” on 
page 86, and “Resubmitting Process Instances and Process Steps” on page 87. For 
more information about saving the search criteria to re‐use at a later time, see the 
Getting Started with My webMethods guide.

Performing an Advanced Search for Logged Process Data

Use an advanced search to specify detailed criteria to search for specific logged process 
instance data. By default, Monitor only returns information for processes logged on the 
current date. Use the Range fields to specify a different time period.
To set the maximum number of search results that Monitor returns, see information about 
setting search options in the Getting Started with My webMethods guide.

Note: Whether the search is case‐sensitive or case‐insensitive depends on how the 
underlying database (such as Oracle, DB2, or SQL Server) handles the queries that 
Monitor issues to obtain data.

webMethods Monitor User’s Guide Version 7.1 72

 5. Process Monitoring

To perform an advanced search for logged process instance data

1 In My webMethods: Monitoring > Business > Process Instances.
2 Click the Advanced tab if it is not already displayed.
3 If Monitor is configured to use multiple Integration Servers, use the Server selection 
box (above the Search tabs) to specify which server you want to search. The Server 
selection box defaults to the last server specified by the currently logged in user. If the 
current user has not selected a server, the default server set by the My webMethods 
Server Administrator on the System Settings page will be used.
4 In the text box, optionally type the keywords that are contained in either the model 
names used for the process instances or the instance IDs of the process instances you 
want to find. For more information about how to specify keywords, see the Getting 
Started with My webMethods guide.
If you leave the text box blank and specify no other search criteria, Monitor 
returns data for all process instances that you are authorized to view, honoring 
the maximum results search option. For more information about setting the 
maximum results search option, see the Getting Started with My webMethods guide.
If you leave the text box blank and specify other search criteria, Monitor does not 
restrict the search based on keywords.

webMethods Monitor User’s Guide Version 7.1 73

 5. Process Monitoring

5 Fill in one or more of the following advanced criteria fields:

In this field... Specify...

Process The exact name of one or more models used for the process 
instances you want to display. To select multiple entries, hold 
down CTRL while you select each name.
For webMethods‐executed process models, the entries in the 
Process list identify the model version, in addition to simply a 
process model name. The entries have the following format:
processModelName ‐ modelVersion
where:
processModelName is the name of the process model.

modelVersion identifies the model version as it was 
assigned in Designer.
If you want to search process instances based on specific 
logged fields, choose from the Process list a process instance 
that has logged fields. The screen will refresh and you will 
now see the Filter section on the Search panel. In the Filter fields, 
specify the desired criteria related to the logged fields you 
want to search.
Status The status of the process instances you want to display. 
To search for all statuses, select All.

To search for multiple, but not all, statuses, hold down 
CTRL while you select each status.
For more information about statuses, see “Statuses of Process 
Instances and Process Steps” on page 81.
Filter By The type of date and time range you want to use.
Choose Date Last Updated to search for process instances 
based on the last date and time that information was 
logged for process instances.
Choose Start Date to search for process instances based on 
when process instances were started.

webMethods Monitor User’s Guide Version 7.1 74

 5. Process Monitoring

In this field... Specify...

Range The dates and times for the range. You can choose either of the 
following:
Click a predefined time period from the Range list. By 
default, Monitor uses Today.
Use the calendar picker to specify a Start Date and End Date, 
and then select the numbers for the hours and minutes 
from their respective lists.

Note: If you want to add the search results to a My 
webMethods custom page, it is recommended that you use a 
predefined time period from the Range list. When you do, the 
search results on the custom page will be dynamic showing 
data relative to the current date (e.g., yesterday). In contrast, if 
you specify exact start and end dates, the search results will 
always contain data for the specific dates you use.

Search Condition Whether you want Monitor to use an AND condition or an OR 

condition with the search criteria you specify.
Select AND if you want Monitor to find process instances 
that match all of the search criteria you specify.
Select OR if you want Monitor to find process instances 
that match any of the search criteria you specify.

6 Click Go to execute the search.
Monitor displays the search results below the search panel. For more information 
about how to work with search results, see “Viewing Information for Process 
Instances” on page 76, “Stopping, Suspending, and Resuming Process Instances” on 
page 86, and “Resubmitting Process Instances and Process Steps” on page 87. For 
more information about saving the search criteria to re‐use at a later time, see the 
Getting Started with My webMethods guide.

webMethods Monitor User’s Guide Version 7.1 75

 5. Process Monitoring

Viewing Information for Process Instances

This section describes information that Monitor can display about process instances. It 
includes viewing:
Detailed information for a process instance

Statuses for process instances and steps within a process instance

Monitors associated with process instances

Detailed information for steps within a process instance

Viewing Detailed information for a Process Instance

You can view detailed information for the process instances that Monitor displays in the 
search results on the Monitoring > Business > Process Instances page.

To view detailed information for a process instance in the search results

1 Search for the business process instance that you want to view. For more information, 
see “Searching for Process Instances” on page 71.
2 In the search results, locate the process instance for which you want to view details 
and click  View Detail. Monitor displays the Process Instance Detail page.
For a description of the information that Monitor displays on the Process Instance 
Detail page, see “Information Displayed on the Process Instance Detail Page” below. 
For a list of actions you can take from the Process Instance Detail page, see “Actions 
You Can Take from the Process Instance Detail Page” on page 81.

Information Displayed on the Process Instance Detail Page

The following table describes the information that Monitor displays on the 
Monitoring > Business > Process Instances page.

Tab Description
Process Monitor displays the following fields that identify the process instance.
Instance
Field Description
Information
Process The name of the process model associated with 
the process instance.
Model Version The name of the model version used for the 
process instance. This field is only applicable for 
webMethods‐executed processes.

webMethods Monitor User’s Guide Version 7.1 76

 5. Process Monitoring

Tab Description
Start Date / Time The date and time the process instance started.
Last Updated The last date and time that information was 
logged for this process instance.
Instance Id The unique identifier for the process instance. If a 
process instance ID consists of multiple parts (for 
example, order numbers from two or more 
different order systems), Monitor creates one row 
for each part.
Instance Iteration The number of times the process instance has 
been submitted. 
Status The status of the process instance. For more 
information, see “Process Statuses” on page 81.
Duration The length of time a process instance has been 
active.
For active process instances, the length of time 
that this process instance has been executing. 
Duration is calculated by subtracting the start 
time of the process instance from the current 
system time. 
For inactive process instances, the length of time 
the process instance was active. Duration is 
calculated by subtracting the start time of the 
process instance from the time the process 
instance became inactive.
For timed out or stopped process instances, the 
length of time the process instance was active. 
Duration is calculated by subtracting the start 
time of the process instance from the time the 
cancel or timeout action occurred.

Note: For steps that execute in parallel, Duration 
does not include the overlapping execution time. 

webMethods Monitor User’s Guide Version 7.1 77

 5. Process Monitoring

Tab Description
Process An image of the process model as it was designed in Designer, if an 
Diagram image is available for a webMethods‐executed or externally executed 
process model. Because no model exists for an integration processes, 
Monitor cannot display a process diagram for integration processes.
The image contains status icons next to steps that have executed or are 
currently executing. For more information, see “Step Statuses” on 
page 83.
For webMethods‐executed process models only, if transition logging is 
enabled and your My webMethods Model Image Format user preference is 
set to SVG, the transition lines along the path that the process took are 
thicker than the transition lines along paths that the process did not 
take. For more information about logging, see the webMethods Logging 
Guide. For more information about setting your My webMethods user 
preferences, see the Getting Started with My webMethods guide.
Step Summary Information about the execution of the steps within the process 
instance.
Field Description

START DATE / TIME The date and time a step began executing.

LAST UPDATED The date and time a step was last updated.
INSTANCE The number of times the process instance 
ITERATION executed, including resubmissions. For externally 
executed processes, this value will always be 1. 
STEP NAME The name of the step. 
STEP ITERATION The number of times the step was executed. 
STATUS The status for the step. For more information, see 
“Step Statuses” on page 83. 
DURATION The length of time a step took to execute. 
Control This tab contains information when control actions (that is, suspend, 
Actions resume, resubmit, or stop) have been performed against the process 
instance. Because you can only perform control actions against 
webMethods‐executed processes, Monitor only displays this tab when 
displaying details for a webMethods‐executed process.
Field Description

DATE / TIME The date and time the control action was 

performed. 

webMethods Monitor User’s Guide Version 7.1 78

 5. Process Monitoring

Tab Description
ACTION The action taken on the process instance 
(suspend, resume, resubmit, or stop).
INSTANCE The instance ID for the process instance. 
ITERATION
STEP NAME The name of the step.
STEP ITERATION The number of times the step executed. 
USER The user associated with the process instance.
SERVER ID The server on which the process instance 
executed.
Activity The Process Instance Detail page displays this tab only when the 
Messages process instance ran a service that logged user‐defined messages. 
Field Description

DATE / TIME The date and time that the activity message was 

logged.
STEP NAME The name of the step that logged the activity 
message. 
ENTRY TYPE The message type (Information, Debug, Error, or 
Warning). 
BRIEF MESSAGE A shortened version of the message.
FULL MESSAGE The full version of the message. 
Logged Fields This tab only contains information when the process instance logged 
run‐time values for custom fields. Users can choose to log custom field 
values when creating the process model.
Field Description

DATE / TIME The date and time the custom field was logged. 

STEP NAME The name of the step that logged the custom field.
INSTANCE The number of times the process instance 
ITERATION executed, including resubmissions. For externally 
executed processes, this value will always be 1. 
STEP ITERATION The number of times the step executed. 
FIELD NAME The name of the custom logged field. 
FIELD VALUE The value of the logged field.

webMethods Monitor User’s Guide Version 7.1 79

 5. Process Monitoring

Tab Description
Process This tab displays error information for the process instance. Only errors 
Errors for the entire process instance are shown here; step errors are shown in 
the Process Step Detail page. For more information about step detail, 
see “Viewing Detailed Information for Process Steps” on page 84.
Field Description

DATE / TIME The date and time the error occurred. 

ERROR The type of error that occurred. The following lists 
some typical errors:
Process Timeout. The process timed out before 
it could be completed.
Step Timeout. A step timed out before it could 
be completed. 
Retries Exceeded. A step was executed more 
than defined maximum number of times.
Out of Sequence. A step attempted to execute 
out of sequence. 
runtime error. The process instance 
encountered a run‐time event (for example, 
failure to validate an account) that prevented 
it from completing successfully.
ERROR MESSAGE Text of the error message.
If the error is a run‐time error (for example, if at 
run time an account was rejected), this column 
also displays the run‐time error code. 
STACK TRACE The full exception message that was thrown by 
one of the services executing within the process 
instance.
SERVICE NAME The name of the service that threw the exception.
SERVER ID Identification of the server on which the error 
occurred. 
Server ID is not available fore externally executed 
process errors.

webMethods Monitor User’s Guide Version 7.1 80

 5. Process Monitoring

Actions You Can Take from the Process Instance Detail Page
You can perform the following actions from the Monitoring > Business > Process Instances 
 > Process Instance Detail page:
View detailed information about steps in the process instance. For more information, 
see “Viewing Detailed Information for Process Steps” on page 84. From the Process 
Step Detail page, you can perform the following additional actions:
Save the input pipeline for a process step to an XML file by clicking Save Pipeline to
a File.
Edit the pipeline for a process step before resubmitting the process instance. For 
more information, see “Resubmitting Process Instances and Process Steps” on 
page 87. 
Restart a process step. For more information, see “Resubmitting Process Instances 
and Process Steps” on page 87.
View monitors associated with steps in the process instance. For more information, 
see “Viewing KPI Data That Is Associated with a Process Step” on page 85.
Stop, suspend, and resume process instances. For more information, see “Stopping, 
Suspending, and Resuming Process Instances” on page 86.

Statuses of Process Instances and Process Steps

Monitor displays statuses for process instances and for the execution of steps within a 
process instance. It indicates the status using a keyword (e.g., Completed or Started) and 
also by using status icons.

Note: The meanings for each status that is described in this section are for webMethods‐
executed and externally executed processes. Although integration processes use the same 
status keywords (e.g., Completed, Waiting, etc.), user‐created services set the statuses. As 
a result, the user‐created services might use the status keywords differently than defined 
by the webMethods product suite.

Process Statuses
Monitor displays process status information on the Process Instances page and also on the 
Process Instance Detail page. The following lists the locations where Monitor displays 
statuses and status icons for a process instance:
On the Process Instances page, Monitor displays:
A status icon at the beginning of the row for each process instance. The icon is 
located after the check box for the row.
The status keyword in the STATUS column.

webMethods Monitor User’s Guide Version 7.1 81

 5. Process Monitoring

On the Process Instance Detail page, Monitor displays the status keyword in the Status 

field on the Process Instance Information tab.
The following table lists the possible process status icons along with their meanings:

Process Status Icon Meaning

The process instance was completed successfully.

Either:
The process instance has been suspended.

The process is running; however, one or more steps might be 
executing with errors.
Process completed, but one or more steps executed with errors.

The following table lists the possible process statuses along with their meanings:

Process Status Meaning

Completed The process instance has completed processing.
Expired The time specified in a process model for an event to occur expired 
before the event was satisfied. For example, the time set for a join 
condition expired before a document required by the join 
condition arrived.
Failed Either the process instance stopped because one or more steps 
executed with errors or the process instance is no longer being 
tracked and is missing information. 
Resumed Execution of the process instance was suspended, but has now 
been resumed.
Retries Exceeded An attempt was made to execute a step in the process more times 
than is allowed by the maximum retries step property defined in 
the process model. This field is applicable only to webMethods‐
executed process instances.
Started The process instance has started, but not all steps have completed.
Stopped The process instance was stopped.
Suspended Execution of the process instance has been paused.
Waiting A step in the process is waiting for an event to occur, for example, 
a step is waiting for a document to arrive.

webMethods Monitor User’s Guide Version 7.1 82

 5. Process Monitoring

Step Statuses
Monitor displays status information for the execution of steps within a process instance 
on the Process Instance Detail page. The following lists the locations where Monitor 
displays statuses and status icons for a process step:
On the Process Diagram tab, Monitor displays a status icon next to each completed and 
currently executing step. The following table lists the status icons used on this tab and 
their meaning: 

Step Status Icon Meaning

The step is currently running.

The step has completed successfully.

The step failed.

The step is waiting, for example, to receive an external 
document.

On the Step Summary tab, Monitor displays:

A status icon at the beginning of the row for each process step.
The status keyword in the STATUS column.
The following table lists the possible step status icons that Monitor displays on the 
Step Summary tab along with the meaning of each status icon:

Step Status Icon Meaning

The step instance was completed successfully.

Either:
The step instance has been suspended.

The step is running; however, one or more errors might 
have occurred.
Step completed, but with errors.

webMethods Monitor User’s Guide Version 7.1 83

 5. Process Monitoring

The following table lists the possible step statuses that Monitor displays on the Step
Summary tab along with the meaning of each status icon:

Step Status Meaning

Completed The step has completed processing.
Expired The time specified for the step in the process model for an 
event to occur expired before the event was satisfied. For 
example, the time set for a join condition expired before a 
document required by the join condition arrived.
Failed Either the step stopped because one or more errors occurred or 
the step is no longer being tracked and is missing information. 
Resumed Execution of the step was suspended, but has now been 
resumed.
Retries Exceeded An attempt was made to execute the step more times than is 
allowed.
Started The step has started, but not completed.
Stopped The step was stopped.
Suspended Execution of the step has been paused.
Waiting The step is waiting for an event to occur, for example, the step 
might be waiting for a document to arrive.

Viewing Detailed Information for Process Steps

You can view detailed information for each step listed on the Step Summary tab of the 
Monitoring > Business > Process Instances > Process Instance Detail page.

To view detail information for a step within a process instance

1 Display detailed information for the process instance that contains the step for which 
you want to view information. For help with this step, see “Viewing Information for 
Process Instances” on page 76.
2 On the Step Summary tab of the Process Instance Detail page, locate the step for which 
you want to view detailed information and click  Detail. Monitor displays the 
Process Step Detail page.
If the status of the process instance is Resubmitted or Suspended and the input 
pipeline for the step you are viewing has been logged, you can view the pipeline by 
clicking View Pipeline. For more information about setting up logging data for process 
instances, see information about setting the logging level in “Setting Up Logging for a 
Process Model Version” on page 104.

webMethods Monitor User’s Guide Version 7.1 84

 5. Process Monitoring

Actions You Can Take from the Process Step Detail Page
You can perform the following actions from the Monitoring > Business > Process 
Instances > Process Instance Detail page:
Save the input pipeline for a process step to an XML file by clicking Save Pipeline to a
File. You might want to save the pipeline for a step if you want to test the step or a 
similar step and want to have actual data available for the test.
Edit the pipeline for a process step before resubmitting the process step. For more 
information, see “Resubmitting Process Instances and Process Steps” on page 87. 
Restart the process step. For more information, see “Resubmitting Process Instances 
and Process Steps” on page 87.

Viewing KPI Data That Is Associated with a Process Instance

When you use webMethods Optimize for Process, you can create key performance indicators 
(KPIs) to measure critical success factors of a process instance. For example, in an order 
management process, you might define KPIs for how many orders were received, their 
dollar amounts, and whether they were processed successfully. Optimize for Process 
creates and stores data for each KPI. You can view the KPI values to see how they have 
varied over time. For more information about KPIs, see the webMethods Optimize for Process 
User’s Guide.

To view KPI data that is associated with a process instance

1 Search for the process instance for which you want to view KPI data. For more 
information, see “Searching for Process Instances” on page 71.
2 In the search results, locate the process instance for which you want to view KPI data 
and click  KPI Summary.
For more information, see the webMethods Optimize for Process User’s Guide.

Viewing KPI Data That Is Associated with a Process Step

From the Step Summary tab on the Process Instance Detail page, you can view KPI data that 
is associated with specific steps in a process instance. 

To view KPI data that is associated with a step within a process instance

webMethods Monitor User’s Guide Version 7.1 85

 5. Process Monitoring

1 Display detailed information for the process instance that contains the step for which 
you want to view KPI data. For help with this step, see “Viewing Information for 
Process Instances” on page 76.
2 On the Step Summary tab of the Process Instance Detail page, locate the step for which 
you want to view KPI data and click  KPI Summary. 
For more information, see the webMethods Optimize for Process User’s Guide.

Stopping, Suspending, and Resuming Process Instances

This section describes how to:
Permanently stop a process instance from executing. You can stop a process instance that is 
in any status except Completed, Failed, or Stopped.
Suspend a process instance to temporarily pause its execution. You can suspend a process 
instance that is in any status except Completed, Failed, or Suspended.
Resume a currently suspended process instance that has the status Suspended.
From My webMethods, you can only stop, suspend, and resume webMethods‐executed 
process instances.

Stopping a Process Instance

You stop a process from the Monitoring > Business > Process Instances > Process Instance 
Detail page. 

To stop a process instance

1 Display detailed information for the process instance that you want to stop. For help 
with this step, see “Viewing Information for Process Instances” on page 76.
2 On the Process Instance Information tab on the Process Instance Detail page, click Stop.

Suspending a Process Instance

You suspend a process from the Monitoring > Business > Process Instances > Process 
Instance Detail page. 

To suspend a process instance

webMethods Monitor User’s Guide Version 7.1 86

 5. Process Monitoring

1 Display detailed information for the process instance that you want to suspend. For 
help with this step, see “Viewing Information for Process Instances” on page 76.
2 On the Process Instance Information tab on the Process Instance Detail page, click 
Suspend. 

Resuming a Process Instance

You resume a suspended process from the Monitoring > Business > Process Instances > 
Process Instance Detail page. 

To resume a process instance

1 Display detailed information for the process instance that you want to resume. For 
help with this step, see “Viewing Information for Process Instances” on page 76.
2 On the Process Instance Information tab on the Process Instance Detail page, click 
Resume. 

Resubmitting Process Instances and Process Steps

You resubmit a process instance by resubmitting a step within a process instance. To 
resubmit a process instance from the beginning, resubmit the start step of the process 
instance. For a list of requirements a process instance must meet to be eligible for 
resubmission, see “Requirements for Resubmitting Process Instances” on page 88. 
Monitor resubmits the process to the same Integration Server on which the process 
originally ran.
When you resubmit a process step, Monitor changes the status of both the process 
iteration and the resubmitted step iteration to Resubmitted. The statuses of the rest of the 
steps in the process iteration are left unchanged. 
Monitor then starts a new iteration of the process instance at the resubmitted step. The 
Process Engine executes the resubmitted step and subsequent steps again and logs 
information for the process using the same instance identifier and an incremented 
iteration count. The Process Engine does not re‐execute steps prior to the resubmitted step 
and, therefore, logs no information for those steps.
You can edit the pipeline for the process step before resubmitting it. To edit the pipeline, 
you must resubmit the service from the Process Step Detail page. After you update the 
pipeline, the changes you make are only available while you are still on the Process Step 
Detail page. If you leave this page, the changes you make are not maintained. As a result, 
if you want to edit the pipeline before resubmitting, you must make your edits and then 
immediately resubmit the process step. The pipeline for the original iteration of the step is 
left unchanged. Monitor logs the updated pipeline with the new iteration of the step.

webMethods Monitor User’s Guide Version 7.1 87

 5. Process Monitoring

Requirements for Resubmitting Process Instances

You can only resubmit a process instance if:
It is a webMethods‐executed process instance. You cannot resubmit externally 
executed and integration processes from My webMethods. 
The process instance has one of the following statuses:

Completed Resumed

Failed Stopped

Note: From the Monitoring > Business > Process Instances page, you can only resubmit 
process instances that have a Failed status. To resubmit processes in the other statuses, 
you must resubmit from the Process Step Detail page

The input pipeline must be logged for at least one of the steps within the process. For 
more information about setting up logging data for process instances, see information 
about setting the logging level in “Setting Up Logging for a Process Model Version” 
on page 104.
The step from which you want to resubmit the process instance must be enabled for 
resubmission. For more information, see information about resubmit enabling in 
“Setting Up Logging for a Process Model Version” on page 104.
You must have the authority to resubmit process instances. For more information, see 
“Granting Users the Ability to Perform Monitor Actions” on page 27 and “Identifying 
the Logged Data Users Can Perform Actions Against” on page 30. 
If steps for referenced processes are downstream from the resubmitted step, the 
Process Engine attempts to resubmit those referenced processes. The referenced 
processes must also meet these requirements for resubmission.
In this situation, if data level security is enabled, in addition to having the authority to 
resubmit the parent process, you must also have the authority to resubmit the child, 
referenced processes. If you do not have this authority, the steps for the referenced 
processes will fail. If you attempt to resubmit at the referenced process step and do 
not have the authority to resubmit the referenced process, you will be unable to even 
start the resubmission. For more information about data level security, see 
“Identifying the Logged Data Users Can Perform Actions Against” on page 30.

webMethods Monitor User’s Guide Version 7.1 88

 5. Process Monitoring

Resubmitting Process Instances from the Beginning

From the search results panel of the Monitoring > Business > Process Instances page, you 
can resubmit one or more process instances that have a Failed status. The resubmission 
begins from their start step. 

Note: If you want to edit the pipeline for the start step before resubmitting or if you want to 
resubmit a process instance from a step other than the start step, see “Resubmitting 
Processes from a Step and Optionally Editing Pipeline Information” on page 89.

To resubmit process instances from the beginning

1 Search for the process instances you want to resubmit. For more information, see 
“Searching for Process Instances” on page 71.
2 In the search results, select the check boxes beside the process instances that you want 
to resubmit.
3 Click Resubmit. 

Resubmitting Processes from a Step and Optionally Editing

Pipeline Information
From the Process Step Detail page, you can resubmit a process instance from a step in the 
process, including the start step. Additionally, you can modify pipeline data for a step 
before resubmitting the process instance. 

Important! The changes you make to the pipeline are only available while you are viewing 
the Process Step Detail page. If you leave this page, the changes you make are lost. To 
resubmit a step with your changes, you must resubmit the step immediately from the 
Process Step Detail page, as described in the procedure below.

To resubmit a step in a process instance and optionally edit pipeline information before resubmission

1 Search for the process instance that you want to resubmit. For more information, see 
“Searching for Process Instances” on page 71.
2 In the search results, locate the process instance that you want to resubmit and click 
View Detail. Monitor displays the Process Instance Detail page.
3 On the Step Summary tab of the Process Instance Detail page, locate the step that you 
want to resubmit and click  Detail. Monitor displays the Process Step Detail page.

webMethods Monitor User’s Guide Version 7.1 89

 5. Process Monitoring

4 To edit the input pipeline for a step:
a On the Step Information tab, click Edit Pipeline.
b On the Edit Step page, for each field value you want to change:
1 Click the hyperlinked field value that you want to change. If the value of a 
field is not displayed with an active hyperlink, you cannot change that field 
value. 
2 Specify a new value for the field.
3 Click OK.
c After updating all the fields you want to change, click Save. Monitor re‐displays 
the Process Step Detail page.
5 Click Resubmit.

webMethods Monitor User’s Guide Version 7.1 90

Chapter 6. Working with Process Models

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Before You Can Work with Process Models from My webMethods . . . . . . . . . . . . . . . . . . . . . . 93

Searching for Process Models That Are Available for Monitoring . . . . . . . . . . . . . . . . . . . . . . . . 93

Viewing Detailed Information for a Process Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Enabling and Disabling Process Model Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Determining the Enabled Version of a Process Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Enabling a Process Model for Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Setting Up Logging for a Process Model Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Deleting Unused Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

webMethods Monitor User’s Guide Version 7.1 91

 6. Working with Process Models

Overview
In addition to monitoring process instances, you can perform some management tasks for 
process models. The table below describes the tasks you can perform for process models:

Tasks Process Types

Search for and view information about process models. webMethods‐executed
For more information, see “Searching for Process  Externally executed
Models That Are Available for Monitoring” on page 93 
and “Viewing Detailed Information for a Process  Integration process
Model” on page 97.
Identify process model versions that you want the Process webMethods‐executed
Engine to use for execution.
For more information, see “Enabling and Disabling 
Process Model Versions” on page 102.
Determine the version of a process model that is  webMethods‐executed
enabled for execution.
For more information, see “Determining the Enabled 
Version of a Process Model” on page 103.
Identify whether Optimize for Process should collect analysis webMethods‐executed
metrics for process instances based on a process model.
Externally executed
For more information, see “Enabling a Process Model 
for Analysis” on page 104.
Define settings the Process Engine should use for logging. webMethods‐executed
For more information, see “Setting Up Logging for a 
Process Model Version” on page 104.
Identify the steps within a process model where a process can webMethods‐executed
be resubmitted.
For more information, see “Setting Up Logging for a 
Process Model Version” on page 104.
Delete process models. webMethods‐executed
For more information, see “Deleting Unused Process  Externally executed
Models” on page 107.
Integration process

webMethods Monitor User’s Guide Version 7.1 92

 6. Working with Process Models

Before You Can Work with Process Models from My webMethods

Before you can work use My webMethods to manage process models, an administrator 
must configure My webMethods to allow you to access the My webMethods pages for 
process models. For more information, see “Granting Users Access to the My 
webMethods Monitoring Pages” on page 25. 

Searching for Process Models That Are Available for Monitoring

You use Monitor to search for and view information about the process models. Monitor 
searches for the following types of processes:
webMethods-executed processes, which are process models that were created in 
Designer in the Developer perspective and that have been built and uploaded for 
execution.
Externally executed processes, which are process models that were created in Designer 
in the Business Analyst perspective and that have been uploaded for analysis.
Integration processes, which are processes definitions that were established by using 
pub.monitor.integrationProcessLogging:createProcessMetadata service. For more information 
about this service and all services you can use for integration process logging, see the 
information about integrationProcessLogging services in the webMethods Monitor Built‐In 
Services Reference Guide.
For more information about process types, see “Types of Processes You Can Monitor” on 
page 65.

Performing a Keyword Search

You can specify a simple keyword search to locate models. If you need a more‐detailed 
search, see “Performing an Advanced Search” on page 94.
To find matching process models, Monitor uses the keyword to search against fields 
related to process models. The fields that Monitor uses depend on the type of process:
For webMethods-executed processes, Monitor locates process models where the keyword 
is contained in either the name or the description of the model.
For externally executed processes, Monitor locates process models where the keyword is 
contained in the name of the model only.
For integration processes, Monitor locates processes where the keyword is contained in 
the process name. 

webMethods Monitor User’s Guide Version 7.1 93

 6. Working with Process Models

To search for models using a keyword

1 In My webMethods:
Administration > Business > Business Processes.
2 Click the Keyword tab if it is not already displayed.
3 If Monitor is configured to use multiple Integration Servers, use the Server selection 
box (above the Search tabs) to specify which server you want to search. The Server 
selection box defaults to the last server specified by the currently logged in user. If the 
current user has not selected a server, the default server set by the My webMethods 
Server Administrator on the System Settings page will be used.
4 In the text box, type a keyword. 
If you leave the text box blank, Monitor returns data for all models that you are 
authorized to view, honoring the maximum results search option. For more 
information about how to specify keywords and how to set the maximum results 
search option, see the Getting Started with My webMethods guide. 
5 Click Go to execute the search. Monitor displays the search results below the search 
panel.
For more information about saving the search criteria to re‐use at a later time, see the 
Getting Started with My webMethods guide.

Performing an Advanced Search

To locate a specific process model, use an Advanced search to specify detailed search 
criteria.

To search for models using an advanced search

1 In My webMethods: 
Administration > Business > Business Processes.
2 Click the Advanced tab if it is not already displayed.
3 If Monitor is configured to use multiple Integration Servers, use the Server selection 
box (above the Search tabs) to specify which server you want to search. The Server 
selection box defaults to the last server specified by the currently logged in user. If the 
current user has not selected a server, the default server set by the My webMethods 
Server Administrator on the System Settings page will be used.
4 In the text box, optionally type a keyword. For information about how Monitor uses 
the keywords, see “Performing a Keyword Search” on page 93. For more information 
about how to specify keywords, see the Getting Started with My webMethods guide.

webMethods Monitor User’s Guide Version 7.1 94

 6. Working with Process Models

If you leave the text box blank and specify no other search criteria, Monitor 
returns data for all models that you are authorized to view, honoring the 
maximum results search option. For more information about setting the 
maximum results search option, see the Getting Started with My webMethods guide.
If you leave the text box blank and specify other search criteria, Monitor does not 
restrict the search based on keywords.
5 Fill in the following fields to specify additional search criteria:

In this field... Specify...

Process Name The exact name of the model you want to display. You can only 

select one process model from the Process Name list.
Process For webMethods‐executed and integration processes, keywords 
Description that are contained in the process model description.

Note: If you specify a keyword in this field, Monitor will not 
return any externally executed or integration processes.

Process Type The type of model you want to display. Select one of the 

following:
All to search for processes of all types

External to locate externally executed processes only

webMethods to locate webMethods‐executed processes only

Integration to locate integration processes only.
For more information about each process type, see “Types of 
Processes You Can Monitor” on page 65.

webMethods Monitor User’s Guide Version 7.1 95

 6. Working with Process Models

In this field... Specify...

Execution Whether the webMethods‐executed process models you want to 
Enabled display have been enabled for execution. For more information 
about enabling process models, see “Enabling and Disabling 
Process Model Versions” on page 102.
Select this option... To display...

Yes Only enabled process models
No Disabled process models
All All process models regardless of whether 
they are enabled or disabled

Note: If you select Yes, Monitor will not include any externally 
executed process models and integration processes in the search 
results because Execution Enable applies only to webMethods‐
executed process models.

Analysis Enabled Whether the process models you want to display have been 

enabled for analysis. The analysis is performed using 
webMethods Optimize for Process. This field is only available if 
Optimize for Process is installed. For more information about 
enabling analysis for models, see “Enabling a Process Model for 
Analysis” on page 104.
Select this option... To display...

Yes Only process models with analysis enabled
No Only process models with analysis disabled
All All process models regardless of whether 
analysis has been enabled or disabled

Note: If you select Yes, Monitor will not include any integration 
processes in the search results because integration processes 
cannot be enabled for analysis.

6 Click Go to execute the search.
For more information about saving the search criteria to re‐use at a later time, see the 
Getting Started with My webMethods guide.

webMethods Monitor User’s Guide Version 7.1 96

 6. Working with Process Models

Viewing Detailed Information for a Process Model

Perform the following procedure to view detailed information about a process model.

To view detailed information for a model

1 Search for the process model you want to view. For instructions, see “Searching for 
Process Models That Are Available for Monitoring” on page 93.
2 In the search results, locate the process model for which you want to view details and 
click  Edit Configuration Details.

Information Displayed on the Edit Process Page

The table below lists the information that Monitor can display on the Edit Process page for 
process models. The actual information that Monitor can displays for a specific process 
model depends on the type of process (e.g., webMethods‐executed, externally executed, 
or integration process) and the webMethods components that you have installed. 

Tab Description
Process Monitor displays the following fields that identify the process 
Information model:
Field Description

Process Name The name assigned to the process model in the 

tool where the model was created.
Model Version Identifies the version of the process model. The 
model version is applicable only for 
webMethods‐executed process models. The 
model version is set in Designer.
You can only have a single version of externally 
executed and integration processes, and the 
model version for these types of processes is 
always set to 1. 
Description A description provided for the process model in 
the tool where the model was created.

Note: For integration processes, this is the value 
specified for the processLabel input variable of the 
pub.monitor.integrationProcessLogging:createProcessMeta
data service.

webMethods Monitor User’s Guide Version 7.1 97

 6. Working with Process Models

Tab Description
Created By User name of the person who created the process 
model.

Note: For integration processes, this the user 
name of the user that invoked the 
pub.monitor.integrationProcessLogging:createProcessMeta
data service to add the integration process.

Date Deployed Date and time the process model was last 

updated in the Process Audit Log database 
component:
For a webMethods-executed process model
version, this is the last time the version was 
built and uploaded for execution from 
Designer.
For an externally executed process model, this is 
the last time the process model was 
uploaded for analysis from Designer.
For an integration process, this is when the 
pub.monitor.integrationProcessLogging:createProcess
Metadata service was used to log information 
about the process.
Execution Whether the Process Engine will use this version 
Enabled of a webMethods‐executed process model to start 
new process instances. You can only enable one 
version of a webMethods‐executed process 
model at a time.
This field is not applicable to externally executed 
and integration processes because the Process 
Engine does not manage the execution of these 
types of processes.

webMethods Monitor User’s Guide Version 7.1 98

 6. Working with Process Models

Tab Description
Analysis Whether the version of the process model is 
Enabled enabled for analysis. This column is available 
only when Optimize for Process is installed 
because webMethods Optimize for Process 
performs the analysis. 

Note: This field is applicable only to 
webMethods‐executed and externally executed 
process models. You cannot enable an integration 
process for analysis.

Analysis Specifies how long Optimize for Process waits 
Process before it considers the instances that are based on 
Timeout this process model version to be timed out. This 
field is used by Optimize for Process during 
process analysis. 
Used Indicates whether the process model version has 
been used for at least one process instance. 
Yes indicates that the process model version 
has been used at least once. 
No indicates that the process model version 
has never been used; that is, there have never 
been any instances of this model version. 
When a version of a model has never been 
used, you can delete the model version. For 
instructions, see “Deleting Unused Process 
Models” on page 107.
Unavailable indicates that Monitor is currently 
not able to provide use information because 
the server used to log instances of the model 
version is not available.
Process Diagram Monitor displays the model image as it was designed in Designer.

Note: Because integration processes are not modeled, Monitor 
cannot display a model image for an integration process.

webMethods Monitor User’s Guide Version 7.1 99

 6. Working with Process Models

Tab Description
Process Quality of Monitor displays logging settings that the Process Engine uses for 
Service Settings a webMethods‐executed process. For more information, see 
“Setting Up Logging for a Process Model Version” on page 104.

Note: Monitor only displays Process Quality of Service Settings for 

webMethods‐executed process models.

Field Description

Logging Level How much data you want the Process Engine to 

log for process instances that use this process 
model version.
Log Transitions Whether you want the Process Engine to log 
process transitions.

Note: These fields are applicable only to webMethods‐executed 
processes. They do not apply to externally executed and 
integration processes.

Step Quality of Monitor displays the steps that are in the process model version 

Service Settings and whether process instances that use the model version can be 
resubmitted at a step. For more information, see “Setting Up 
Logging for a Process Model Version” on page 104.

Note: Monitor only displays Step Quality of Service Settings for 

webMethods‐executed process models. The Resubmit Enabled field 
is applicable only to webMethods‐executed processes. It does not 
apply to externally executed and integration processes.

Actions You Can Take from the Edit Process Page

You can perform the following actions from the Administration > Business > Business 
Processes > Edit Process page:
Enable or disable execution for a version of a webMethods‐executed process model. 
For more information, see “Enabling and Disabling Process Model Versions” on 
page 102.
Enable or disable analysis for process models; this affects whether Optimize for 
Process performs analysis for the process instances based on the models. For more 
information, see “Enabling a Process Model for Analysis” on page 104.

webMethods Monitor User’s Guide Version 7.1 100

 6. Working with Process Models

Use the Analysis Process Timeout field to define how many milliseconds, seconds, 

minutes, hours, days, or weeks a process can run before Optimize for Process 
considers the process to be timed out.
Edit details about one or more steps in the process model. On the Process Diagram tab, 
click Edit Steps. For more information, see the webMethods Optimize for Process 
Administrator’s Guide.
Edit details about one or more events associated with an externally executed process 
model. On the Process Diagram tab, click Edit Events. For more information, see the 
webMethods Optimize for Process Administrator’s Guide.
Define how much data you want the Process Engine to log for webMethods‐executed 
processes. For more information, see “Setting Up Logging for a Process Model 
Version” on page 104.
Define whether you want the Process Engine to log process transitions for 
webMethods‐executed processes. For more information, see “Setting Up Logging for 
a Process Model Version” on page 104.
Identify the steps within a webMethods‐executed process for which you want to 
allow resubmission. For more information, see “Setting Up Logging for a Process 
Model Version” on page 104.

webMethods Monitor User’s Guide Version 7.1 101

 6. Working with Process Models

Enabling and Disabling Process Model Versions

Whether you have the ability to enable or disable the execution of process models 
depends on the process type.

Process Type Description of enabling or disabling a process model for execution

webMethods-executed You can enable or disable webMethods‐executed process 
model versions for execution. When you initially build and 
upload a process model from Designer, the version will be 
disabled.
When a process model version is:
Enabled, the Process Engine will use the enabled version 
when starting new process instances.
Disabled, the Process Engine will not use the model version 
for new process instances.
Only one version of a process model can be enabled at a time. 
If there are no enabled versions of a process model, the 
Process Engine will not start any process instances of the 
process model.

Important! If you disable all versions of a model that is called by 
another process, the parent process will fail at the step that 
calls the disabled process.

Externally executed You cannot disable the execution of an externally executed 

process model from My webMethods because an external 
application manages the execution of an externally executed 
process.
Integration process You cannot disable the execution of an integration process 
from My webMethods because an integration process is a 
series of services executed one after another, and the Process 
Engine does not govern whether those services can be 
executed.

To enable or disable a webMethods-executed model version

1 Search for the model version you want to enable or disable. For instructions, see 
“Searching for Process Models That Are Available for Monitoring” on page 93.

2 In the search results, click   Edit Configuration Details for the model version that you 

want to enable or disable.

webMethods Monitor User’s Guide Version 7.1 102

 6. Working with Process Models

3 To enable a model version, on the Process Information tab select the Execution Enabled 

check box. When you enable a process model version, Monitor disables the currently 
enabled version (if there was an enabled version).
4 To disable a model version, on the Process Information tab clear the Execution Enabled 
check box.
5 Click Save.

Determining the Enabled Version of a Process Model

You can have multiple versions of a webMethods‐executed process model; however, only 
one version can be enabled at a time. To determine the version that is enabled (if any), 
perform this procedure.

To determine the enabled version of a webMethods-executed process model

1 In My webMethods:
Administration > Business > Business Processes.
2 Click the Advanced tab if it is not already displayed.
3 Select the name of the webMethods‐executed process model for which you want to 
determine the enabled version from the Process Name list.
4 Click Go to execute the search.

In the search results, the enabled version (if any) has a   check mark in the Execution
Enabled column.

webMethods Monitor User’s Guide Version 7.1 103

 6. Working with Process Models

Enabling a Process Model for Analysis

If a process model is enabled for analysis, when a running process instance of the model 
version is executing, Optimize for Process collects metrics about the running process 
instance, such as, how long it took the process instance to run, how long it took each step 
in the process to run, the number of errors that occurred. You can then view the collected 
metrics on the Monitoring > Business > Process Overview page. For more information, see 
the webMethods Optimize for Process User’s Guide.
Before you can enable a process model for analysis, Optimize for Process must be 
installed. Additionally, whether you can enable a process model for analysis, depends on 
the process type.

Process Type Whether you can enable the process model for analysis
webMethods-executed Yes, you can enable webMethods‐executed process model 
versions for analysis. You can only enable the version of the 
process model that is execution enabled.
Externally executed Externally executed process models are always enabled for 
analysis.
Integration process No, you cannot enable integration processes for analysis.

To enable or disable a process model version for analysis

1 Search for the process model you want to enable for analysis. For instructions, see 
“Searching for Process Models That Are Available for Monitoring” on page 93.

2 In the search results, click   Edit Configuration Details for the webMethods‐executed 

model version or externally executed process model that you want to enable for 
analysis.
3 To enable a process model version for analysis, on the Process Information tab select the 
Analysis Enabled check box. 
4 To disable a process model version for analysis, on the Process Information tab clear the 
Analysis Enabled check box. 
5 Click Save.

Setting Up Logging for a Process Model Version

Process Engines can log data for webMethods‐executed process instances. You can view 
this data and perform actions on it in Monitor. You specify the data to log for process 
instances by configuring logging settings on process model versions.

webMethods Monitor User’s Guide Version 7.1 104

 6. Working with Process Models

For each process model version, you specify the amount and type of data to log on the 
Logging Level setting. If you want to be able to resubmit process instances from Monitor at 
certain steps, you must set the logging level to a level that will log the input pipelines for 
those steps, and you must enable resubmission for each of those steps using the Resubmit
Enabled setting.
Monitor shows all possible paths that process instances can take. If you want to see the 
path the process instances actually took at run time, use the Log Transitions setting to 
enable process transition logging for the process model version. The lines for the path that 
was actually taken will appear in bold.    

Important! If you regenerate a process model version, the logging settings return to the 
default values, and you will have to reset them if you want different settings.

Configure Logging Settings for a Process Model Version

To configure the logging settings for a process model version:

1 In My webMethods:
Administration > Business > Business Processes 
2 Find the process model version you want to work with and then click Edit Configuration
Details.
3 On the Process Quality of Service Settings tab, click one of the Logging Level values 
described in the table below. When choosing the logging level to use, consider what 
you want to be able to do from Monitor later, as indicated by the table’s middle three 
columns.  

Important! Designer contains a Minimum Logging Level setting for each process model 

version. This setting in Designer controls the lowest logging level you can set here.

If a process instance will send data about its steps to Optimize, you must set the 
logging level to 5 - Process and all steps.

webMethods Monitor User’s Guide Version 7.1 105

 6. Working with Process Models

You want to log... And you want to do this in Monitor... Set to...

View View
process step Resubmit a
status? status? process?
Nothing (that is, disable process  No No No 1 - None
logging)
Process status when steps fail At  No At failed  2 - Errors
failed  step only
Input pipelines for failed steps step
Run‐time values for document 
fields
Process status Yes No At failed  3 - Process
step only
Input pipelines for failed steps
Run‐time values for document 
fields
Optionally, transitions
Process status and start step  Yes For  At start or  4 - Process
status start  failed step and start
step steps
Input pipelines for start steps 
and failed steps
Run‐time values for document 
fields
Optionally, transitions
Process status and all step  Yes For all  At any  5 - Process
statuses steps step that  and all
has logged  steps
Input pipelines for every step input 
Run‐time values for document  pipeline
fields
Optionally, transitions

4 If you chose a logging level that allows you to log transitions, and you want to do so, 
scroll right and select the Log Transitions check box.
5 If you chose a logging level that logs input pipelines for process steps, the Step Quality
of Service Settings tab lists those steps. Select the Resubmit Enabled check box for each 
step at which you want to be able to resubmit process instances.
6 Click Save.

webMethods Monitor User’s Guide Version 7.1 106

 6. Working with Process Models

Improve Process Logging Performance

To improve process logging performance, consider the following factors:
Choose 2 - Errors only, 3 - Process only, or 4 - Process and start steps as your logging level. 
Choose 5 - Process and all steps only when you need ultimate quality of service.
Store input pipelines only when absolutely necessary. It is usually sufficient to store 
pipelines for failed steps only. Remove all unnecessary data from pipelines to 
minimize the volume of data to store.
For process steps that run services, there are two areas in which you could 
inadvertently log the same information twice:
Process Engines can write start and successful completion or failure log entries for 
process steps that run services. Services can write log entries that convey the same 
information.
Process Engines can store input pipelines for services that are run by process 
steps. Services can also log input pipelines.
Coordinate your logging for these services to avoid logging the same information 
twice.   

Note: When coordinating logging, keep in mind that when a service is run by a process 
step, that service is actually called by a wrapper service, making it a nested service (as 
opposed to a top‐level service).

For instructions on setting up service logging, and for complete information on logging in 
general, see the webMethods Logging Guide.

Deleting Unused Process Models

If a process model has not been used, you can delete information about the process model 
from the Process Audit Log database and the Monitor display. You can delete any type of 
process (webMethods‐executed, externally executed, or integration process) as long as 
that process has never been used for a process instance.

Note: Before you can delete a webMethods‐executed process model version, you must first 
disable that process model. For instructions, see “Enabling and Disabling Process Model 
Versions” on page 102.

To delete unused process models

1 Search for the unused process models you want to delete. For instructions, see 
“Searching for Process Models That Are Available for Monitoring” on page 93.

webMethods Monitor User’s Guide Version 7.1 107

 6. Working with Process Models

2 In the search results, select the check boxes beside the unused process models that you 
want to delete.
3 Click Delete.

webMethods Monitor User’s Guide Version 7.1 108

Chapter 7. Archiving or Deleting Logged Data

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Before You Archive and Delete Logged Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Archiving or Deleting Logged Data from My webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Archiving or Deleting Logged Data Using Built-in Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Archiving or Deleting Logged Data Using Stored Procedures . . . . . . . . . . . . . . . . . . . . . . . . . 115

Viewing the Results of an Archive Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

webMethods Monitor User’s Guide Version 7.1 109

 7. Archiving or Deleting Logged Data

Overview
Software AG recommends that you remove data from the IS Core Audit Log and the 
Process Audit Log database components on a regular basis to maintain your logging 
database at peak performance. To remove data, you can either archive or delete it:
When you archive, the data is removed from the database components after it is moved 
to the Archive database component.
When you delete, the data is removed from the database components, but not moved to 
any other location.
Because Monitor reads the data that it displays from the IS Core Audit Log and Process 
Audit Log database components, after you archive or delete data, you can no longer view 
that data in My webMethods. However, if you archive the data, you can still query the 
Archive database component using SQL statements.
The following table lists the methods that you can use to archive or delete document, 
process, server, and service data from the IS Core Audit Log and the Process Audit Log 
database components:

Method for archiving or deleting data For more information, see...

Using Monitor via My webMethods “Archiving or Deleting Logged Data 
from My webMethods” on page 112
Using Monitor built‐in services in the  “Archiving or Deleting Logged Data 
pub.monitor.archive folder Using Built‐in Services” on page 114
Scheduling Monitor archive built‐in services  “Archiving or Deleting Logged Data 
in Integration Server Using Built‐in Services” on page 114
Running stored procedures from your  “Archiving or Deleting Logged Data 
Oracle or SQL Server database client Using Stored Procedures” on page 115

Archiving is an asynchronous operation and should have little system impact, but stored 
procedures are especially useful for preserving Integration Server resources in 
high‐volume situations.

webMethods Monitor User’s Guide Version 7.1 110

 7. Archiving or Deleting Logged Data

Before You Archive and Delete Logged Data

The following lists requirements and items to consider before you archive or delete data.

Requirements
Before you can archive data, you must set up the Archive database component. For 
instructions, see “Setting Up to Archive Data” on page 36.
To archive or delete from My webMethods, an administrator must configure: 
My webMethods to allow access to the My webMethods pages for archiving and 
deleting data. For more information, see “Granting Users Access to the My 
webMethods Monitoring Pages” on page 25. 
Whether you can archive data. For more information, see “Granting Users the 
Ability to Perform Monitor Actions” on page 27.

Items to Consider
Optionally configure the number of days of audit information that Monitor should 
retain when performing an archive operation. The default is 14 days. For instructions, 
see “Setting Up to Archive Data” on page 36.
If you use an Oracle database, you can identify one or more people to receive e‐mail 
alerts when the Oracle Purge operation completes. For more information, see the 
webMethods Optimize for Process Administrator’s Guide

webMethods Monitor User’s Guide Version 7.1 111

 7. Archiving or Deleting Logged Data

Archiving or Deleting Logged Data from My webMethods

From the My webMethods user interface, you can archive or delete data using the 
following procedure.

To archive or delete logged data using My webMethods

1 In My webMethods:
Administration > Business > Data Management > Archive Audit Data
2 Specify the age of the data that you want to retain in the IS Core Audit Log and the 
Process Audit Log database components. Data that is older than the retention period 
that you specify is archived or deleted.

Option Description

Number of days to retain Monitor keeps data the number of days (including 

(ending with today) today) that you specify. For example, if you specify 15, 
Monitor keeps data that is 15 or less days old and 
archives/deletes data that is 16 days or older.
Retention period start date The date of the oldest data you want to keep. The 
(ending with today) period will end with and include today. Use the 
calendar picker and hour and minute boxes to set the 
date.
For example, if you specify 11/3/2006, Monitor keeps 
data from 11/3/2006 up to and including today and 
archives/deletes data that was added before 11/3/2006.

Note: Processes and services have a start timestamp and an end timestamp; Monitor 
archives or deletes them based on the end timestamp. Documents and server data 
have a single timestamp, and Monitor archives or deletes them based on that 
timestamp.

webMethods Monitor User’s Guide Version 7.1 112

 7. Archiving or Deleting Logged Data

3 Select the check boxes for the types of data to archive or delete.

Select this option... To archive data for...

Processes Process log entries, input pipelines, error data, and 
run‐time values for user‐specified input and output 
document fields.
Referenced processes, process‐related service data 
(services, service error data, and user‐defined messages).
Process control data (resubmit, suspend, and resume 
actions).
Services Service log entries, input pipelines, error data, user‐defined 
messages, and service control data (resubmit actions).

Note: Monitor can archive user‐defined messages for a service 
only if customized logging is set up for the service in 
Developer. That is, if service logging is globally enabled in 
Integration Server but customized logging is not set up for the 
service in Developer, Monitor cannot archive used‐defined 
messages written by the service.

Documents Logged documents for all Broker clients and document control 
data (resubmit actions).
Server Data Integration Server server, session, and guaranteed delivery log 
entries, and error log entries that are not associated with logged 
processes, services, or documents (for example, errors that 
occur during startup or during the run of unlogged processes, 
services, activations, and documents).

4 Select the check boxes to indicate the status of the data that you want to archive. 
Monitor will archive or delete only data with that status. The status check boxes are 
available only for processes and services. Because documents and server data do not 
have statuses, you cannot use status as a basis for archiving.

Option Description

COMPLETED Archives or deletes logged data for processes or services 
whose status is Completed.
COMPLETED-FAILED Archives or deletes data for services whose status is 
Completed, Failed, or Resubmitted, or for processes whose 
status is Completed, Failed, Stopped, or Resubmitted.

webMethods Monitor User’s Guide Version 7.1 113

 7. Archiving or Deleting Logged Data

5 Indicate the number of primary items and accompanying items to archive or delete at 
a time in the Archiving Batch Size box. For example, you might want to archive or delete 
100 processes and accompanying services, activity logs, and errors at a time. Choose a 
number that takes the size of each record and other performance factors into 
consideration. If the record size is large, consider reducing the batch size; if the record 
size is small, increasing the batch size might increase the speed of the archive or 
delete.
6 Indicate whether to archive or delete the data by clicking one of the following:

Option Description

Archive and Delete Copies the data from the IS Core Audit Log and Process Audit 

Log database components to the Archive database component 
and deletes the data from the IS Core Audit Log and Process 
Audit Log database components.
Delete only Deletes the data from the IS Core Audit Log and Process Audit 
Log database components.

Archiving or Deleting Logged Data Using Built-in Services

The the pub.monitor.archive folder in the WmMonitor package contains services for archiving 
and deleting logged data. You can run the services in Developer, or you can use 
Integration Server Administrator to schedule the services to run automatically at specific 
times or intervals. Running the services regularly minimizes the time required to process 
the data.
To schedule a service for archiving or deleting, build a wrapper service that calls the 
service and sets the service’s input parameters, then run the wrapper service as a 
scheduled task from Integration Server Administrator. The wrapper service executes for 
the first time immediately after you schedule the task. For instructions on scheduling 
services, see the webMethods Integration Server Administrator’s Guide.
The archive and delete services are located in the Integration Server_directory\packages\ 
WmMonitor\pub\monitor\archive directory and are described in webMethods Monitor 
Built‐In Services Reference Guide. 

Note: For Oracle, SQL Server, and DB2, the default values for all archive and delete service 
parameters are stored in the OPERATION_PARAMETER in the Archive database 
component. You can change the defaults in the table by running the 
pub.monitor.archive:setOperationParameters service. You can override the defaults for specific 
archive or delete actions by specifying values on the relevant parameters when you run 
the archive and delete services.

webMethods Monitor User’s Guide Version 7.1 114

 7. Archiving or Deleting Logged Data

Archiving or Deleting Logged Data Using Stored Procedures

When you installed the Archive database component, you also installed stored 
procedures for archiving or deleting data between database components installed in 
Oracle, SQL Server, or DB2. You access the stored procedures for archiving through your 
database application. 
The stored procedures for archiving data from the IS Core Audit Log database 
component, Process Audit Log database component, or both to the Archive database 
component are listed below.

Procedure Description
Oracle: Archives or deletes documents logged for 
DOCUMENT_ARCHIVE.START_ Broker clients from the WMDOCUMENT table 
DOCUMENTARCHIVE in the IS Core Audit Log database and 
document control data (such as resubmit 
SQL Server and DB2: actions) from the WMCONTROL table in the 
DOCUMENT_ARCHIVE_START_ Process Audit Log database.
DOCUMENTARCHIVE
Oracle: Archives or delete process data and control 
PROCESS_ARCHIVE.START_ data (such as resubmit actions) from the 
PROCESSARCHIVE WMCONTROL, 
WMCUSTOMFIELDDEFINTION, 
SQL Server and DB2:
WMCUSTOMPROCESSDATA, WMPROCESS, 
PROCESS_ARCHIVE_START_
WMPROCESSASSOC, 
PROCESSARCHIVE
WMPROCESSDEFINITION, 
WMPROCESSIMAGE, WMPROCESSRECENT, 
WMPROCESSSTEP, WMSTEPDEFINITION, 
and WMSTEPTRANSITIONDEFINTION tables 
in the Process Audit Log database component, 
and archives or deletes process‐related service 
data from the WMSERVICEACTIVITYLOG, 
WMSERVICE, and WMERROR tables in the IS 
Core Audit Log database.

webMethods Monitor User’s Guide Version 7.1 115

 7. Archiving or Deleting Logged Data

Procedure Description
Oracle: Archives or deletes server data from the 
SERVER_ARCHIVE.START_ WMERROR, WMSESSION, WMTXIN, and 
SERVERARCHIVE WMTXOUT tables in the IS Core Audit Log 
database.
SQL Server and DB2:
SERVER_ARCHIVE_START_
SERVERARCHIVE Note: Archiving server data archives only 
top‐level errors. To archive lower‐level errors 
associated with services or processes, you must 
first archive those services or processes.

Oracle: Archives or deletes service log entries, input 
SERVICE_ARCHIVE.START_ pipelines, error data, and user‐defined 
SERVICEARCHIVE messages from the WMSERVICE, WMERROR, 
and WMSERVICEACTIVITYLOG tables in the 
SQL Server and DB2: IS Core Audit Log database and service control 
SERVICE_ARCHIVE_START_ data (such as resubmit actions) from the 
SERVICEARCHIVE WMCONTROL table in the Process Audit Log 
database.

Parameters

p_retaindate Long Start date for the period to keep the indicated type of data in the 

source database component. The period will end with and include 
today. p_retaindate is in epoch time (milliseconds since midnight, 
01/01/1970).
Supply the p_retaindate parameter or the p_retaindays parameter. Do not 
supply both.
p_retaindays String Number of days to keep the indicated type of data in the source 
database component, ending with and including today.
Supply the p_retaindays parameter or the p_retaindate parameter. Do not 
supply both.
p_action String Tells the procedure whether to archive or delete the indicated type 
of data from the source database component.
Set to... To...

ARCHIVE Default. Copy the data from the source database 
component to the Archive database component and 
delete the data from the source database component.
DELETE Delete the data from the source database component.

webMethods Monitor User’s Guide Version 7.1 116

 7. Archiving or Deleting Logged Data

p_status String Tells the PROCESSARCHIVE or SERVICEARCHIVE procedure 

the statuses on which to archive or delete the indicated type of data. 
Data for processes or services whose status is other than those specified 
is retained in the source database component.
Code Meaning

2 Archive or delete data for processes or services whose 
status is Completed.
4 Archive or delete data for processes or services whose 
status is Failed.
1024 Archive or delete data for processes whose status is 
Stopped.
32768 Archive or delete data for processes and services whose 
status is Resubmitted.
32776 Archive or delete data for services whose status is 
Activity.
p_batchsize String Number of primary items and accompanying items to archive or 
delete at a time. For details, see step 5 on page 114 in “Archiving or 
Deleting Logged Data from My webMethods”. 

Usage Notes
p_batchsize parameter: Suppose you want to archive or delete 100 processes and 
accompanying services, activity logs, and errors at a time. Choose a number that takes 
the size of each record and other performance factors into consideration. If the record 
size is large, consider reducing the batch size; if the record size is small, increasing the 
batch size might increase the speed of the archive or delete.

Examples
p_retaindays parameter: Suppose today’s date is September 30 and you want to archive 
or delete data for services that finished running more than 15 days ago (that is, before 
September 15). You would specify this parameter as 15.

Viewing the Results of an Archive Operation

If you installed the Archive database component in Oracle, SQL Server, or DB2, you can 
view the progress of an archive operation

To view the results of an archive operation

In My webMethods, go to Administration > Business > Data Management > Archive Audit Data
Results.

webMethods Monitor User’s Guide Version 7.1 117

 7. Archiving or Deleting Logged Data

webMethods Monitor User’s Guide Version 7.1 118

Chapter 8. Working with Reports

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Before You Can Generate Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Generating Reports about Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Generating Reports about Process Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Generating Task Users Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Generating Task Roles Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Using Third-Party Reporting Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

webMethods Monitor User’s Guide Version 7.1 119

 8. Working with Reports

Overview
The following table lists the reports that you can view and where to find instructions for 
how to generate each report:

For instructions for how to

Report Description create the report, see...
Process Instances Reports about the execution of  “Generating Reports 
Report process instances. about Process Instances” 
on page 121
Process Models Reports about the process models  “Generating Reports 
Report that are available for execution  about Process Models” 
and the steps within the process  on page 125
model.
Task Users Report Reports that show how users  “Generating Task Users 
performed tasks that were  Reports” on page 126
executed as part of a process.
Task Roles Report Reports that show how roles  “Generating Task Roles 
performed tasks that were  Reports” on page 129
executed as part of a process.

Additionally, you can create reports using Third‐Party reporting tools. For more 
information, see “Using Third‐Party Reporting Tools” on page 131.
See “Before You Can Generate Reports” on page 121 for information about setup that is 
required before you can use Monitor to generate reports and the permissions you need to 
generate reports from My webMethods.

Important! Report generation can be a processing‐intensive action. Depending on the 
amount of data in the database, it can take several minutes to view the resulting report. 
You might want to limit the requested data sets as much as possible.

webMethods Monitor User’s Guide Version 7.1 120

 8. Working with Reports

Before You Can Generate Reports

Before you can generate reports, an administrator must:
Install the Staging and Reporting database components and populate them with the 
data from which to generate the reports. For more information, see “Setting Up to 
Generate Reports” on page 35.
Configure My webMethods to allow access to the My webMethods pages for 
generating reports. For more information, see “Granting Users Access to the My 
webMethods Monitoring Pages” on page 25. 

Generating Reports about Process Instances

You can generate the following types of reports about process instances:
Instance Summary Report. The Instance Summary Report summarizes all the instances 
of a process model that ran during one day, one week, one month, one quarter, or one 
year. You specify the time period that you want to report on and whether to aggregate 
the data by a day, week, month, quarter, or year. For example, you might set the time 
period to the last month and the aggregation period to weekly to generate weekly 
summaries of all the instances that ran in the past month. For more information, see 
“Viewing a Instance Summary Report” on page 122. 
Reports of Started, Completed, or Failed Process Instances. You generate this report from 
the Instance Summary Report. This report lists each instance that has a specified 
status (i.e., Started, Completed, or Failed) that occurred during a single aggregation 
period. For example, if the Instance Summary Report contains weekly summaries of 
process instances that ran in the last month, you can generate a report to view all 
instances from one of the weekly aggregations and that have the Completed status. 
For more information, see “Viewing Reports of Started, Completed, or Failed Process 
Instances” on page 123.
Instance Detail Report. For an instance listed in the report of a specific status, you can 
generate an Instance Detail Report to view details about a single instance. For more 
information, see “Viewing an Instance Detail Report” on page 124.
The following illustrates how the different types of process instance reports are related.

Instance Summary Report Status-Specific Report Instance Detail Report

Summary of process instances that ran List of the instances that ran during one Details of one instance listed in the
during one day, one week, one month, aggregation period in the Instance Status-Specific Report.
one quarter, or one year. Summary Report that have a specified
status.

webMethods Monitor User’s Guide Version 7.1 121

 8. Working with Reports

Viewing a Instance Summary Report

The Instance Summary Report summarizes the process instances that ran over a specified 
time period. To generate an Instance Summary Report, you specify:
One or more process models whose instances you want to summarize

The time period for which to generate the report

An aggregation period to identify how you want Monitor to summarize the process 
instances, that is, daily, weekly, monthly, quarterly, or yearly
The generated report will include one section for each process model that you select. In 
each section for a process model, each row represents a single aggregation period.
For example, if you select two process models, Model1 and Model2, a time period of a 
year (e.g., January 1 to December 31), and a quarterly aggregation period, the generated 
report would include two sections, one for Model1 and a second for Model2. In the 
Model1 section, there would be four rows. Each row would represent a summary of all 
instances that occurred during one quarter of the year (e.g., one row summarizing the 
instances that occurred January through March, a second row summarizing the instances 
that occurred April through June, a third row summarizing the instances that occurred 
July through September, and a fourth row summarizing the instances that occurred 
October through December).

To view an Instance Summary Report

1 In My webMethods: Monitoring > Reports > Process Instances.

2 Click the Basic tab if it is not already displayed.
3 Define the report criteria:

In this field... Specify...

Model The process models for the process instances to include in the 
report. The list in the Model field contains all models that are 
available for execution. You can select multiple models. If you do 
not select any models, the report contains information for all 
models.

Note: You cannot generate an Instance Summary Report for a 
specific version of a process model. Monitor generates the report 
for all versions of the selected models.

webMethods Monitor User’s Guide Version 7.1 122

 8. Working with Reports

In this field... Specify...

Aggregation The aggregation period for the report. You can set the aggregation 
period to Daily, Weekly, Monthly, Quarterly, or Yearly. 
Range The time period for the report. Specify the date and time 
information was logged for the process instances you want 
included in the report. To specify the range, you can either:
Click a predefined time period from the Range list.

Use the calendar picker to specify a Start Date and End Date, 

then select the numbers for the hours and minutes from their 
respective lists.
If you do not specify a time period, the report contains all past 
instances that meet the other criteria you specify.

4 Click Go. 
For more information about saving the report criteria to re‐use at a later time, see 
information about saving search criteria in the Getting Started with My webMethods 
guide.

Note: Only the first iteration of a process instance is shown in the Instance Summary 
Report.

Viewing Reports of Started, Completed, or Failed Process

Instances
From the Instance Summary Report, you can generate additional reports to find out 
information about process instances that have a specific status. In the Instance Summary 
Report, each row contains the number of process instances that have a Started, 
Completed, and Failed status. From a row, you can generate a report to view all the 
instances that are summarized in that row and that have one of the Started, Completed, or 
Failed statuses.
For example, if a row in the Instance Summary Report lists all instances that ran in a 
quarter and the Failed column lists 11, you can generate a report to view the 11 Failed 
instances that ran during that quarter.

webMethods Monitor User’s Guide Version 7.1 123

 8. Working with Reports

To view a status-specific report for a process instances in a Started, Completed, or Failed status

1 Create a Instance Summary Report that includes the process instances for which you 
want to view a status information. For instructions, see “Generating Reports about 
Process Instances” on page 121.
2 In the results of the Instances Summary Report, click the value in a Started, Completed, 
or Failed column to view all the instances in the aggregation period that have the 
selected status.

Note: Search criteria that you selected when you created the Instance Summary Report is 
still in effect for the status‐specific report. For example, if the Instance Summary Report 
shows process instances from the last 7 days, the status‐specific report is also filtered by 
the same criteria.

Viewing an Instance Detail Report

After displaying a status‐specific report of process instances, you can use that report to 
display an Instance Detail Report for a single process instance.
For example, if you are viewing a status‐specific report showing the 11 failed process 
instances that ran in a quarter, you can generate an Instance Detail Report for one of the 
failed.

To view an Instance Detail Report for a process instance

1 Create a status‐specific process instance report that includes the process instance for 
which you want to view a detail report. For instructions, see “Viewing Reports of 
Started, Completed, or Failed Process Instances” on page 123.
2 Locate the process instance for which you want to view a Instance Detail Report and 
click the value in the PROCESS INSTANCE ID column.

Note: Search criteria that you selected when you created the Instance Summary Report and 
status‐specific report is still in effect for the Instance Detail Report. For example, if the 
Instance Summary Report and status‐specific report shows process instances from the last 
7 days, the Instance Detail Report is also filtered by the same criteria.

Note: Only the first iteration of a process is shown in the Instance Detail Report.

webMethods Monitor User’s Guide Version 7.1 124

 8. Working with Reports

Generating Reports about Process Models

You can create the following types of reports about process models:
Model Summary Report. Lists information about process models that are available for 
execution. This includes all types: 
webMethods‐executed process models that have been built and uploaded for 
execution
Externally executed process models that have been uploaded for analysis
Integration processes that have been defined by using the 
pub.monitor.integrationProcessLogging:createProcessMetadata service to log metadata to 
the Process Audit Log database component
For more information, see “Viewing a Process Models Report” on page 125.
Step Report for a Process Instance. Provides details about the steps that are part of a 
process model. For more information, see “Viewing a Step Report for a Process 
Model” on page 126

Note: You cannot generate process model reports for specific model versions.

Viewing a Process Models Report

Use a Process Models Report to list information about process models that are available 
for execution. The generated report will include one row for each process model. On the 
row for a process model, Monitor lists:
Total steps number of steps in the process model

Number of automated steps, that is steps that require no human involvement, for 
example a step that executes a service
Number of human steps, that is a step that represents a task, which a person must 
perform

To view a Process Model Report

1 In My webMethods: Monitoring > Reports > Process Models.

2 Click the Basic tab if it is not already displayed.

webMethods Monitor User’s Guide Version 7.1 125

 8. Working with Reports

3 In the Model field, select the process models that you want included in the report. You 
can select multiple models. If you do not select any models, the report contains 
information for all models.
4 Click Go. 
For more information about saving the report criteria to re‐use at a later time, see 
information about saving search criteria in the Getting Started with My webMethods 
guide.

Viewing a Step Report for a Process Model

From the Process Models Report, you can generate additional reports to find out 
information about steps in a process model. In the Process Models Report, each row 
contains the number of automated steps, human steps, and total steps. From a row, you 
can generate a report to view details about the summarized steps.
For example, if a row in the Process Models Report lists 12 in the Total Steps column, you 
can generate a Step Report to view information about each of the 12 steps in the process 
model. The generated report will include one row for each step. 

To view a Step Report for a process model

1 Create a Process Models Report that includes the process model for which you want 
to view a Step Report. For instructions, see “Viewing a Process Models Report” on 
page 125.
2 In the results of the Process Models Report, locate the process model for which you 
want to view a Step Report and click the value in the AUTOMATED STEPS, HUMAN
STEPS, or TOTAL STEPS column.

Generating Task Users Reports

The Task Users Report provides information about how users perform tasks. For example, 
you can use the report to view how long it takes a user to perform tasks or how many 
times tasks that the user started completed successfully or failed.
To identify the users to include in the report, you specify the user names and/or the roles 
to which the users belong. To identify the tasks to include in the report, you specify the 
process models that contain the tasks and the steps within the process models that 
represent the tasks.
When you generate a Task Users Report, you specify a time period that you want to report 
on and whether to aggregate the users’ data by a day, week, month, quarter, or year. For 
example, you might want to set the time period to the last quarter and the aggregation 
period to monthly to generate a report that lists users’ performance for each month of the 
quarter.

webMethods Monitor User’s Guide Version 7.1 126

 8. Working with Reports

The generated report will include one section for each combination of a user and a task 
within a process model. In each section for a user and task, each row represents the user’s 
performance of that task during one of the aggregation periods.
For example, the report criteria might specify user Jill, the tasks ReviewOrder and 
ApproveOrder that are both in the process model Model1, a time period of one month 
(e.g., January 1 through January 31), and a weekly aggregation period. The generated 
report would include two main sections, one for Jill’s performance of the ReviewOrder 
task and another for Jill’s performance of the ApproveOrder task. Within each section, 
each row shows the Jill’s performance of the task during one week of the month.

Note: As tasks are executed, the Task Engine logs information about the task to the Process 
Audit Log database component. When the Reporting database component is populated 
using the services in the pub.monitor.reporting.processDataMart folder, the services obtain 
information that the Task Engine logged. For more information about the Task Engine, see 
the webMethods Task Engine User’s Guide. For more information about populating the 
Reporting database component, see “Setting Up to Generate Reports” on page 35.

To view a Task Users Report

1 In My webMethods: Monitoring > Reports > Task Users.

2 Click the Basic tab if it is not already displayed.
3 Define the report criteria:

In this field... Specify...

Model The process models that contain the tasks to include in the 
report. The list in the Model field contains all models that are 
available for execution. You can select multiple models. If you 
do not select any models, the report contains information for 
all models.

Note: You cannot specify model versions. Monitor generates the 
report for all versions of the selected models.

Aggregation The aggregation period for the report. You can set the 
aggregation period to Daily, Weekly, Monthly, Quarterly, or Yearly. 

webMethods Monitor User’s Guide Version 7.1 127

 8. Working with Reports

In this field... Specify...

Range The time period for the report. Specify the date and time 
information was logged for the tasks you want included in the 
report. To specify the range, you can either:
Click a predefined time period from the Range list.

Use the calendar picker to specify a Start Date and End Date, 

then select the numbers for the hours and minutes from 
their respective lists.
If you do not specify a time period, the report contains all past 
tasks that meet the other criteria you specify.
Step The steps within in the selected process models that represent 
the tasks that you want included in the report. 
If you do not select any tasks, the report contains all task steps 
in the selected models.

Note: The Step field is populated with step names if you select a 
model in the Model field.

User The users that you want included in the report. 
If you do not select any users, the report contains all users that 
are associated with the tasks identified by the report criteria.
Role The My webMethods roles to which the users you want 
included in the report belong.
If you do not select any roles, the report contains all roles that 
meet the other criteria you specify.

4 Click Go.
For more information about saving the report criteria to re‐use at a later time, see 
information about saving search criteria in the Getting Started with My webMethods 
guide.

webMethods Monitor User’s Guide Version 7.1 128

 8. Working with Reports

Generating Task Roles Reports

The Task Roles Report provides information about how roles perform tasks. For example, 
you can use the report to view how long it takes the users assigned to a role to perform 
tasks, how many times tasks that the users started completed successfully or failed, and 
identify what roles are performing the different tasks.
To identify the roles to include in the report, you specify the role names or you can select 
users that belong to the roles. To identify the tasks to include in the report, you specify the 
process models that contains the tasks and the steps within the process models that 
represent the tasks.
When you generate a Task Roles Report, you specify a time period that you want to report 
on and whether to aggregate the roles’ data by a day, week, month, quarter, or year. For 
example, you might want to set the time period to the last year and the aggregation period 
to quarterly to generate a report that lists roles’ performance for each quarter of the year.
The generated report will include one section for each combination of a role and a task 
within a process model. In each section for a role and task, each row represents the role’s 
performance of that task during one of the aggregation periods.
For example, the report criteria might specify the Human_Resources role, the tasks 
IdentifyNewHire and NewHireOfficeSetup that are both in the process model 
NewHireModel, a time period of one month (e.g., January 1 through January 31), and a 
daily aggregation period. The generated report would include two main sections, one for 
the Human_Resources role’s performance of the IdentifyNewHire task and another for 
the Human_Resources role’s performance of the NewHireOfficeSetup task. Within each 
section, each row shows the Human_Resources role’s performance of the task during each 
day of the month.

Note: As tasks are executed, the Task Engine logs information about the task to the Process 
Audit Log database component. When the Reporting database component is populated 
using the services in the pub.monitor.reporting.processDataMart folder, the services obtain 
information that the Task Engine logged. For more information about the Task Engine, see 
the webMethods Task Engine User’s Guide. For more information about populating the 
Reporting database component, see “Setting Up to Generate Reports” on page 35.

To view a Task Roles Report

1 In My webMethods: Monitoring > Reports > Task Roles.

2 Click the Basic tab if it is not already displayed.

webMethods Monitor User’s Guide Version 7.1 129

 8. Working with Reports

3 Define the report criteria:

In this field... Specify...

Model The process models that contain the tasks to include in the 
report. The list in the Model field contains all models that are 
available for execution. You can select multiple models. If you 
do not select any models, the report contains information for 
all models.

Note: You cannot specify model versions. Monitor generates the 
report for all versions of the selected models.

Aggregation The aggregation period for the report. You can set the 
aggregation period to Daily, Weekly, Monthly, Quarterly, or Yearly. 
Range The time period for the report. Specify the date and time 
information was logged for the tasks you want included in the 
report. To specify the range, you can either:
Click a predefined time period from the Range list.

Use the calendar picker to specify a Start Date and End Date, 

then select the numbers for the hours and minutes from 
their respective lists.
If you do not specify a time period, the report contains all past 
tasks that meet the other criteria you specify.
Step The steps within in the selected process models that represent 
the tasks that you want included in the report. 
If you do not select any tasks, the report contains all task steps 
in the selected models.

Note: The Step field is populated with step names if you select a 
model in the Model field.

User The users that belong to the roles that you want included in 
the report. 
If you do not select any users, the report contains all users that 
meet the other criteria you specify.
Role The My webMethods roles to include in the report.
If you do not select any roles, the report contains all roles that 
meet the other criteria you specify.

4 Click Go.

webMethods Monitor User’s Guide Version 7.1 130

 8. Working with Reports

For more information about saving the report criteria to re‐use at a later time, see the 
section on saving search criteria in the Getting Started with My webMethods guide.

Using Third-Party Reporting Tools

You can use a third party reporting tool to access and create reports from the reporting 
database. For a description of the Reporting database component schema, see the 
database documentation on the webMethods Bookshelf.

webMethods Monitor User’s Guide Version 7.1 131

 8. Working with Reports

webMethods Monitor User’s Guide Version 7.1 132

Appendix A. Archive and Delete Audit Data Stored Procedures
Reference

Stored Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

webMethods Monitor User’s Guide Version 7.1 133

 A. Archive and Delete Audit Data Stored Procedures Reference

Stored Procedures
The stored procedures for archiving data from the IS Core Audit Log database 
component, Process Audit Log database component, or both to the Archive database 
component are listed below.

Procedure Description
Oracle: Archives or deletes documents logged for 
DOCUMENT_ARCHIVE.START_ Broker clients from the WMDOCUMENT table 
DOCUMENTARCHIVE in the IS Core Audit Log database and 
document control data (such as resubmit 
SQL Server and DB2: actions) from the WMCONTROL table in the 
DOCUMENT_ARCHIVE_START_ Process Audit Log database.
DOCUMENTARCHIVE
Oracle: Archives or delete process data and control 
PROCESS_ARCHIVE.START_ data (such as resubmit actions) from the 
PROCESSARCHIVE WMCONTROL, 
WMCUSTOMFIELDDEFINTION, 
SQL Server and DB2:
WMCUSTOMPROCESSDATA, WMPROCESS, 
PROCESS_ARCHIVE_START_
WMPROCESSASSOC, 
PROCESSARCHIVE
WMPROCESSDEFINITION, 
WMPROCESSIMAGE, WMPROCESSRECENT, 
WMPROCESSSTEP, WMSTEPDEFINITION, 
and WMSTEPTRANSITIONDEFINTION tables 
in the Process Audit Log database component, 
and archives or deletes process‐related service 
data from the WMSERVICEACTIVITYLOG, 
WMSERVICE, and WMERROR tables in the IS 
Core Audit Log database.

webMethods Monitor User’s Guide Version 7.1 134

 A. Archive and Delete Audit Data Stored Procedures Reference

Procedure Description
Oracle: Archives or deletes server data from the 
SERVER_ARCHIVE.START_ WMERROR, WMSESSION, WMTXIN, and 
SERVERARCHIVE WMTXOUT tables in the IS Core Audit Log 
database.
SQL Server and DB2:
SERVER_ARCHIVE_START_
SERVERARCHIVE Note: Archiving server data archives only 
top‐level errors. To archive lower‐level errors 
associated with services or processes, you must 
first archive those services or processes.

Oracle: Archives or deletes service log entries, input 
SERVICE_ARCHIVE.START_ pipelines, error data, and user‐defined 
SERVICEARCHIVE messages from the WMSERVICE, WMERROR, 
and WMSERVICEACTIVITYLOG tables in the 
SQL Server and DB2: IS Core Audit Log database and service control 
SERVICE_ARCHIVE_START_ data (such as resubmit actions) from the 
SERVICEARCHIVE WMCONTROL table in the Process Audit Log 
database.

Parameters

p_retaindate Long Start date for the period to keep the indicated type of data in the 

source database component. The period will end with and include 
today. p_retaindate is in epoch time (milliseconds since midnight, 
01/01/1970).
Supply the p_retaindate parameter or the p_retaindays parameter. Do 
not supply both.
p_retaindays String Number of days to keep the indicated type of data in the source 
database component, ending with and including today.
Supply the p_retaindays parameter or the p_retaindate parameter. Do 
not supply both.
p_action String Tells the procedure whether to archive or delete the indicated 
type of data from the source database component.
Set to... To...

ARCHIVE Default. Copy the data from the source database 
component to the Archive database component and 
delete the data from the source database component.
DELETE Delete the data from the source database component.

webMethods Monitor User’s Guide Version 7.1 135

 A. Archive and Delete Audit Data Stored Procedures Reference

p_status String Tells the PROCESSARCHIVE or SERVICEARCHIVE procedure 

the statuses on which to archive or delete the indicated type of data. 
Data for processes or services whose status is other than those 
specified is retained in the source database component.
Code Meaning

2 Archive or delete data for processes or services whose 
status is Completed.
4 Archive or delete data for processes or services whose 
status is Failed.
1024 Archive or delete data for processes whose status is 
Stopped.
32768 Archive or delete data for processes and services 
whose status is Resubmitted.
32776 Archive or delete data for services whose status is 
Activity.
p_batchsize String Number of primary items and accompanying items to archive or 
delete at a time. For details, see step 5 on page 114 in “Archiving or 
Deleting Logged Data from My webMethods”. 

Usage Notes
p_batchsize parameter: Suppose you want to archive or delete 100 processes and 
accompanying services, activity logs, and errors at a time. Choose a number that takes 
the size of each record and other performance factors into consideration. If the record 
size is large, consider reducing the batch size; if the record size is small, increasing the 
batch size might increase the speed of the archive or delete.

Examples
p_retaindays parameter: Suppose today’s date is September 30 and you want to archive 
or delete data for services that finished running more than 15 days ago (that is, before 
September 15). You would specify this parameter as 15.

webMethods Monitor User’s Guide Version 7.1 136

 Index

Index

A authorization
access privileges, description 15 accessing My webMethods pages 15
accessing Monitor via My webMethods 13
actions, Monitor C
documents 59 Central Users
list of actions 12 configuring 21
process instances 81 description 21
process models 100 enabling 21
process steps 85 configuring 25, 27
resubmitting documents 60 access privileges
resubmitting process instances 87 documents pages 27
resubmitting services 49 pages for archiving and deleting 26
resuming process instances 87 process instances pages 26
services 48 process model pages 25
stopping process instances 86 reports pages 27
suspending process instances 86 services pages 26
advanced search archiving and deleting data 17
documents 54 Central Users 21
process instances 72 data level security 31
process models 94 documents roles can act on 34
services 42 enabling 31
analysis enabling process models 104
processes roles can act on 32
Archive database component
services roles can act on 33
DBlink to IS Core Audit log 36
database component connection retries 24
DBlink to Process Audit log 36
functional privileges
setting database permissions 37
actions against documents 29
archiving and deleting data
actions against process instances 28
accessing tasks in My webMethods 16
actions against services 29
configuring 17
archiving and deleting data 30
allowing users to perform 30
Integration Server hosting WmMonitor package 23
allowing users to view pages 26
Integration Server My webMethods interacts with 23
Archive Results Day 37
My webMethods access privileges 25
from My webMethods 112
My webMethods functional privileges 27
methods 110
reason to 110 conventions used in this document 7
requirements for 111
setup before you can generate 17 D
using built-in services 114 data level security
using stored procedures 115 configuring Monfitor for 31
viewing results 117 definition 30

webMethods Monitor User’s Guide Version 7.1 137

 Index

documents roles can act on 34 allowing users to act on 29

enabling Monitor for 31 allowing users to view 27
interaction with functional privileges 30 documents roles can act on 34
processes roles can act on 32 detailed information
services roles can act on 33 Control Actions 59
steps to setting up 31 Document Information 58
database components viewing 58
Archive failed, definition 11
DBlink to IS Core Audit log 36 in doubt, definition 11
DBlink to Process Audit log 36 keyword search 53
setting database permissions 37 requirements for monitoring 52
configuring connection retries 24 resubmitting
Database Retries 24 description 60
Reporting editing document information first 61
installing 35 from search results 61
Staging retries exceeded, definition 11
installing 35 viewing detailed information for 58
that hold logged data you can monitor 10
defining E
My webMethods users, groups, roles 15 enabling
definitions Central Users 21
access privileges 25 process model analysis 104
data level security 30 process model execution 102
failed documents 11
functional privileges 27 F
in doubt documents 11 failed documents, definition 11
retries exceeded documents 11 functional privileges, description 27
deleting information about unused models 107
diagrams G
data logging 10
generating
disabling
Instance Detail Report 124
process model analysis 104
Instance Summary Report 122
process model execution 102
Model Summary Report 125
documentation
process instance status reports 124
additional 8
Step Report 126
conventions 7
Task Roles Report 129
feedback 7
Task Users Report 127
documents
accessing data in My webMethods 16
actions you can take 59 I
advanced search 54 in doubt documents, definition 11
archiving or deleting 113 Instance Detail Report
configuring description 121, 124
viewing 124

webMethods Monitor User’s Guide Version 7.1 138

 Index

Instance Summary Report defining users, groups, roles 15

description 121, 122 functional privileges and data level security 30
viewing 122 functional privileges, description 27
integration process logging identifying Integration Servers 16
description 66 working with
sample service defining an integration process 67 documents 16
sample service for process instance 68 process instances 16
set up 66 process models 15
Integration Servers reports 17
accessing pages for configuring in My webMethods 16 services 16
identifying one that host WmMonitor package 23 My webMethods Monitor actions a user can use 27
IS Core Audit Log database component My webMethods pages a user can view 25
Archive database component DBlink to 36
ISCOREAUDIT_DBLINK 36 P
Process Audit Log database component
K Archive database component DBlink to 36
key performance indicators (KPI) 85 process instances
keyword search accessing data in My webMethods 16
documents 53 actions you can take 81
process instances 71 advanced search 72
process models 93 archiving or deleting 113
services 41 configuring
KPI (key performance indicators) 85 allowing users to act on 28
allowing users to view 26
L processes roles can act on 32
logged fields detailed information
searching 74 Activity Messages 79
logging Control Actions 78
integration process logging 66 Logged Fields 79
logging data Process Diagram 78
diagram of how information is logged 10 Process Errors 80
types of logged data you can monitor 11 Process Instance Information 76
logging into Monitor 14 Step Summary 78
viewing 76
keyword search 71
M
reports 121
Model Summary Report requirements for monitoring 64
description 125
resubmitting
viewing 125
description 87
My webMethods editing pipeline first 89
access privileges, description 25
from any step 89
archiving and deleting data 16 from beginning 89
configuring Integration Server it interacts with 23
requirements 88

webMethods Monitor User’s Guide Version 7.1 139

 Index

resuming 87 requirements for monitoring 93

sample service for integration process logging 68 sample service for integration process logging 67
statuses viewing detailed information for 97
Completed 82 process steps
descriptions 81 actions you can take 85
Expired 82 detailed information, viewing 84
Failed 82 resubmitting 89
green icon 82 statuses
red icon 82 Completed 84
Resumed 82 descriptions 83
Retries Exceeded 82 Expired 84
Started 82 Failed 84
Stopped 82 green icon 83
Suspended 82 red icon 83
Waiting 82 Resumed 84
yellow icon 82 Retries Exceeded 84
stopping 86 Started 84
suspending 86 Stopped 84
time out for analysis 101 Suspended 84
viewing Waiting 84
yellow icon 83
detailed information for 76
viewing detailed information for 84
input pipelines 84
viewing KPI data 85
KPI data 85
PROCESSAUDIT_DBLINK 36
process step details 84
program code conventions 7
process models
pub.monitor.archive:setOperationParameters service 36
accessing data in My webMethods 15
actions you can take 100
advanced search 94
R
configuring to allow users to view 25 Reporting database component
deleting information about unused models 107 installing 35
detailed information reports
Process Diagram 99 accessing data in My webMethods 17
Process Information 97 configuring
Process Quality of Service Settings 100 allowing users to view 27
Step Quality of Service Settings 100 descriptions 120
viewing 97 Instance Detail Report
determining execution enabled version 103 description 121, 124
disabling analysis 104 viewing 124
disabling execution 102 Instance Summary Report
enabling analysis 104 description 121, 122
enabling execution 102 viewing 122
keyword search 93 Model Summary Report
reports 125 description 125
viewing 125

webMethods Monitor User’s Guide Version 7.1 140

 Index

process instance status reports resuming process instances 87

description 121, 123 retries exceeded documents, definition 11
viewing 124
process instances 121 S
process models 125 searching
reporting batch size 35 advanced search
requirements for generating 121 documents 54
setting the batch size 35 process instances 72
Step Report
process models 94
description 125, 126
services 42
viewing 126
for services 40
Task Roles Report
keyword search
description 129
documents 53
viewing 129
process instances 71
Task Users Report
process models 93
description 126
services 41
viewing 127
re-executing saved searches 41, 53, 71
using third-party tools 131
saving search criteria 41, 53, 71
when large amounts of data 35
setting search options 41, 53, 71
requirements
services
archiving and deleting data 111
generating reports 121 accessing data in My webMethods 16
monitoring actions you can take 48
documents 52 advanced search 42
process instances 64 archiving or deleting 113
process models 93 configuring
services 40 allowing users to act on 29
resubmitting allowing users to view 26
documents services roles can act on 33
description 60 detailed information
editing document information first 61 Activity Messages 47
from search results 61 Control Actions 47
process instances History 47
description 87 Service Errors 47
editing pipeline first 89 Service Information 46
from any step 89 viewing 46
from beginning 89 keyword search 41
requirements 88 requirements for monitoring 40
process steps 89 resubmitting
services description 49
description 49 editing pipeline information first 49
editing pipeline information first 49 from search results 49
from search results 49 searching for 40

webMethods Monitor User’s Guide Version 7.1 141

 Index

statuses Model Summary Report 125

Completed 48 process instance details 76
descriptions 48 process instance status reports 124
Failed 48 process model details 97
green icon 48 process step details 84
red icon 48 service details 46
Resubmitted 48 Step Report 126
Started 48 Task Roles Report 129
yellow icon 48 Task Users Report 127
viewing detailed information for 46
sessions, archiving or deleting 113 W
setOperationParameters 36 webMethods Monitor
Staging database component access privileges 15
installing 35 actions you can take against logged data 12
statuses configuration tasks 20
process instances 81 data level security 30
process steps 83 functional privileges 27
services 48 logging into and out of 14
Step Report types of data to monitor 11
description 125, 126 user interface 13
viewing 126 WmComauth package
stopping process instances 86 see also common authorization
suspending process instances 86 WmMonitor package
configuring Archive Results Day 37
T configuring Database Retries 24
Task Roles Report configuring Integration Server that hosts 23
description 129
viewing 129
Task Users Report
description 126
viewing 127
tasks, reports 126, 129
troubleshooting information 7

U
user interface, My webMethods 13

V
viewing
document details 58
Instance Detail Report 124
Instance Summary Report 122

webMethods Monitor User’s Guide Version 7.1 142