Informatica Cloud Application Integration
(December 2015)
Process Console and Process
Server Guide
Informatica Cloud Application Integration Process Console and Process Server Guide December 2015
Copyright (c) 1993-2015 Informatica LLC. All rights reserved.
This software and documentation contain proprietary information of Informatica LLC and are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica LLC. This Software may be protected by U.S. and/or international Patents and other Patents Pending.
Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as provided in DFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013©(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable.
The information in this product or documentation is subject to change without notice. If you find any problems in this product or documentation, please report them to us in writing.
Informatica, Informatica Platform, Informatica Data Services, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange, PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange Informatica On Demand, Informatica Identity Resolution, Informatica Application Information Lifecycle Management, Informatica Complex Event Processing, Ultra Messaging and Informatica Master Data Management are trademarks or registered trademarks of Informatica LLC in the United States and in jurisdictions throughout the world. All other company and product names may be trade names or trademarks of their respective owners.
Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies. All rights reserved. Copyright © Sun Microsystems. All rights reserved. Copyright © RSA Security Inc. All Rights Reserved. Copyright © Ordinal Technology Corp. All rights reserved. Copyright © Aandacht c.v. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright © Meta Integration Technology, Inc. All rights reserved. Copyright © Intalio. All rights reserved. Copyright © Oracle. All rights reserved. Copyright © Adobe Systems Incorporated. All rights reserved. Copyright © DataArt, Inc. All rights reserved. Copyright © ComponentSource. All rights reserved. Copyright © Microsoft Corporation. All rights reserved. Copyright © Rogue Wave Software, Inc. All rights reserved. Copyright © Teradata Corporation. All rights reserved. Copyright © Yahoo! Inc. All rights reserved. Copyright © Glyph & Cog, LLC. All rights reserved. Copyright © Thinkmap, Inc. All rights reserved. Copyright © Clearpace Software Limited. All rights reserved. Copyright © Information Builders, Inc. All rights reserved. Copyright © OSS Nokalva, Inc. All rights reserved. Copyright Edifecs, Inc. All rights reserved. Copyright Cleo Communications, Inc. All rights reserved. Copyright © International Organization for Standardization 1986. All rights reserved. Copyright © ej-technologies GmbH. All rights reserved. Copyright © Jaspersoft Corporation. All rights reserved. Copyright © International Business Machines Corporation. All rights reserved. Copyright © yWorks GmbH. All rights reserved. Copyright © Lucent Technologies. All rights reserved. Copyright (c) University of Toronto. All rights reserved. Copyright © Daniel Veillard. All rights reserved. Copyright © Unicode, Inc. Copyright IBM Corp. All rights reserved. Copyright © MicroQuill Software Publishing, Inc. All rights reserved. Copyright © PassMark Software Pty Ltd. All rights reserved. Copyright © LogiXML, Inc. All rights reserved. Copyright © 2003-2010 Lorenzi Davide, All rights reserved. Copyright © Red Hat, Inc. All rights reserved. Copyright © The Board of Trustees of the Leland Stanford Junior University. All rights reserved. Copyright © EMC Corporation. All rights reserved. Copyright © Flexera Software. All rights reserved. Copyright © Jinfonet Software. All rights reserved. Copyright © Apple Inc. All rights reserved. Copyright © Telerik Inc. All rights reserved. Copyright © BEA Systems. All rights reserved. Copyright © PDFlib GmbH. All rights reserved. Copyright © Orientation in Objects GmbH. All rights reserved. Copyright © Tanuki Software, Ltd. All rights reserved. Copyright © Ricebridge. All rights reserved. Copyright © Sencha, Inc. All rights reserved. Copyright © Scalable Systems, Inc. All rights reserved. Copyright © jQWidgets. All rights reserved. Copyright © Tableau Software, Inc. All rights reserved. Copyright© MaxMind, Inc. All Rights Reserved. Copyright © TMate Software s.r.o. All rights reserved. Copyright © MapR Technologies Inc. All rights reserved. Copyright © Amazon Corporate LLC. All rights reserved. Copyright © Highsoft. All rights reserved. Copyright © Python Software Foundation. All rights reserved. Copyright © BeOpen.com. All rights reserved. Copyright © CNRI. All rights reserved.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/), and/or other software which is licensed under various versions of the Apache License (the "License"). You may obtain a copy of these Licenses at http://www.apache.org/licenses/. Unless required by applicable law or agreed to in writing, software distributed under these Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
This product includes software which was developed by Mozilla (http://www.mozilla.org/), software copyright The JBoss Group, LLC, all rights reserved; software copyright © 1999-2006 by Bruno Lowagie and Paulo Soares and other software which is licensed under various versions of the GNU Lesser General Public License Agreement, which may be found at http:// www.gnu.org/licenses/lgpl.html. The materials are provided free of charge by Informatica, "as-is", without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.
The product includes ACE(TM) and TAO(TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California, Irvine, and Vanderbilt University, Copyright (©) 1993-2006, all rights reserved.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (copyright The OpenSSL Project. All Rights Reserved) and redistribution of this software is subject to terms available at http://www.openssl.org and http://www.openssl.org/source/license.html.
This product includes Curl software which is Copyright 1996-2013, Daniel Stenberg, <[email protected]>. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://curl.haxx.se/docs/copyright.html. Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
The product includes software copyright 2001-2005 (©) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://www.dom4j.org/ license.html.
The product includes software copyright © 2004-2007, The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://dojotoolkit.org/license.
This product includes ICU software which is copyright International Business Machines Corporation and others. All rights reserved. Permissions and limitations regarding this software are subject to terms available at http://source.icu-project.org/repos/icu/icu/trunk/license.html.
This product includes software copyright © 1996-2006 Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at http:// www.gnu.org/software/ kawa/Software-License.html.
This product includes OSSP UUID software which is Copyright © 2002 Ralf S. Engelschall, Copyright © 2002 The OSSP Project Copyright © 2002 Cable & Wireless Deutschland. Permissions and limitations regarding this software are subject to terms available at http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by Boost (http://www.boost.org/) or under the Boost software license. Permissions and limitations regarding this software are subject to terms available at http:/ /www.boost.org/LICENSE_1_0.txt.
This product includes software copyright © 1997-2007 University of Cambridge. Permissions and limitations regarding this software are subject to terms available at http:// www.pcre.org/license.txt.
This product includes software copyright © 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http:// www.eclipse.org/org/documents/epl-v10.php and at http://www.eclipse.org/org/documents/edl-v10.php.
This product includes software licensed under the terms at http://www.tcl.tk/software/tcltk/license.html, http://www.bosrup.com/web/overlib/?License, http:// www.stlport.org/doc/ license.html, http://asm.ow2.org/license.html, http://www.cryptix.org/LICENSE.TXT, http://hsqldb.org/web/hsqlLicense.html, http://
httpunit.sourceforge.net/doc/ license.html, http://jung.sourceforge.net/license.txt , http://www.gzip.org/zlib/zlib_license.html, http://www.openldap.org/software/release/ license.html, http://www.libssh2.org, http://slf4j.org/license.html, http://www.sente.ch/software/OpenSourceLicense.html, http://fusesource.com/downloads/license-agreements/fuse-message-broker-v-5-3- license-agreement; http://antlr.org/license.html; http://aopalliance.sourceforge.net/; http://www.bouncycastle.org/licence.html; http://www.jgraph.com/jgraphdownload.html; http://www.jcraft.com/jsch/LICENSE.txt; http://jotm.objectweb.org/bsd_license.html; . http://www.w3.org/Consortium/Legal/ 2002/copyright-software-20021231; http://www.slf4j.org/license.html; http://nanoxml.sourceforge.net/orig/copyright.html; http://www.json.org/license.html; http:// forge.ow2.org/projects/javaservice/, http://www.postgresql.org/about/licence.html, http://www.sqlite.org/copyright.html, http://www.tcl.tk/software/tcltk/license.html, http:// www.jaxen.org/faq.html, http://www.jdom.org/docs/faq.html, http://www.slf4j.org/license.html; http://www.iodbc.org/dataspace/iodbc/wiki/iODBC/License; http:// www.keplerproject.org/md5/license.html; http://www.toedter.com/en/jcalendar/license.html; http://www.edankert.com/bounce/index.html; http://www.net-snmp.org/about/ license.html; http://www.openmdx.org/#FAQ; http://www.php.net/license/3_01.txt; http://srp.stanford.edu/license.txt; http://www.schneier.com/blowfish.html; http:// www.jmock.org/license.html; http://xsom.java.net; http://benalman.com/about/license/; https://github.com/CreateJS/EaselJS/blob/master/src/easeljs/display/Bitmap.js; http://www.h2database.com/html/license.html#summary; http://jsoncpp.sourceforge.net/LICENSE; http://jdbc.postgresql.org/license.html; http://
protobuf.googlecode.com/svn/trunk/src/google/protobuf/descriptor.proto; https://github.com/rantav/hector/blob/master/LICENSE; http://web.mit.edu/Kerberos/krb5-current/doc/mitK5license.html; http://jibx.sourceforge.net/jibx-license.html; https://github.com/lyokato/libgeohash/blob/master/LICENSE; https://github.com/hjiang/jsonxx/ blob/master/LICENSE; https://code.google.com/p/lz4/; https://github.com/jedisct1/libsodium/blob/master/LICENSE; http://one-jar.sourceforge.net/index.php?
page=documents&file=license; https://github.com/EsotericSoftware/kryo/blob/master/license.txt; http://www.scala-lang.org/license.html; https://github.com/tinkerpop/ blueprints/blob/master/LICENSE.txt; http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html; https://aws.amazon.com/asl/; https://github.com/ twbs/bootstrap/blob/master/LICENSE; https://sourceforge.net/p/xmlunit/code/HEAD/tree/trunk/LICENSE.txt; https://github.com/documentcloud/underscore-contrib/blob/ master/LICENSE, and https://github.com/apache/hbase/blob/master/LICENSE.txt.
This product includes software licensed under the Academic Free License (http://www.opensource.org/licenses/afl-3.0.php), the Common Development and Distribution License (http://www.opensource.org/licenses/cddl1.php) the Common Public License (http://www.opensource.org/licenses/cpl1.0.php), the Sun Binary Code License Agreement Supplemental License Terms, the BSD License (http:// www.opensource.org/licenses/bsd-license.php), the new BSD License (http://opensource.org/ licenses/BSD-3-Clause), the MIT License (http://www.opensource.org/licenses/mit-license.php), the Artistic License (http://www.opensource.org/licenses/artistic-license-1.0) and the Initial Developer’s Public License Version 1.0 (http://www.firebirdsql.org/en/initial-developer-s-public-license-version-1-0/).
This product includes software copyright © 2003-2006 Joe WaInes, 2006-2007 XStream Committers. All rights reserved. Permissions and limitations regarding this software are subject to terms available at http://xstream.codehaus.org/license.html. This product includes software developed by the Indiana University Extreme! Lab. For further information please visit http://www.extreme.indiana.edu/.
This product includes software Copyright (c) 2013 Frank Balluffi and Markus Moeller. All rights reserved. Permissions and limitations regarding this software are subject to terms of the MIT license.
See patents at https://www.informatica.com/legal/patents.html.
DISCLAIMER: Informatica LLC provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of noninfringement, merchantability, or use for a particular purpose. Informatica LLC does not warrant that this software or documentation is error free. The information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and documentation is subject to change at any time without notice.
NOTICES
This Informatica product (the "Software") includes certain drivers (the "DataDirect Drivers") from DataDirect Technologies, an operating company of Progress Software Corporation ("DataDirect") which are subject to the following terms and conditions:
1. THE DATADIRECT DRIVERS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT INFORMED OF THE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS. Part Number: ICRT-CONSOLE-UG-M1512-0001
Table of Contents
Preface . . . 8
Informatica Resources. . . 8
Informatica Documentation. . . 8
Informatica Cloud Web Site. . . 9
Informatica Cloud Communities. . . 9
Informatica Cloud Marketplace. . . 9
Informatica Cloud Connector Documentation. . . 9
Informatica Cloud Trust Site. . . 9
Informatica Global Customer Support. . . 9
Chapter 1: Process Console Overview. . . 11
Getting Started. . . 11
Search. . . 13
Part I: Using Process Console at Runtime. . . 14
Chapter 2: Process Monitoring. . . 15
Active Processes. . . 15
Using Selection Filters for Active Processes. . . 16
Examining and Managing Processes. . . 21
Active Process Detail Page. . . 22
The Canvas View. . . 25
Executing View. . . 27
Outline View. . . 27
Log View. . . 30
Managing Selected Processes. . . 32
Variable Attachments. . . 32
Reports (Process Developer). . . 34
Alarm Queue. . . 36
Receive Queue. . . 36
Dispatch Service . . . 38
Creating a Custom Dispatch Configuration. . . 38
Request Dispatch Service . . . 39
Additional Controls Related to the Dispatch Service. . . 41
Chapter 3: Process Rewind and Exception Management Overview. . . 42
Process Rewind. . . 42
Restoring Variable Data When Rewinding a Process. . . 44
Tips for Using Process Rewind. . . 44
Migrating Running Processes when Warnings are Generated. . . 48
Chapter 4: Task Monitoring (Process Developer). . . 50
Active Tasks (Process Developer). . . 50
Work Queues (Process Developer). . . 52
Chapter 5: Managing the Catalog and Resources. . . 53
Deploying a Business Process Archive. . . 53
Contributions. . . 54
Contribution Detail. . . 56
Process Definitions. . . 57
Deployed Process Detail. . . 59
Deployed Process Version Detail. . . 60
Process Version Life Cycles. . . 61
Updating a Process Version. . . 62
Setting a Process Version Offline or Online. . . 62
Logging Level. . . 63
Process Version Persistence Type. . . 63
Exception Management Type. . . 64
Invoke Recovery Type. . . 64
Process Instance Retention. . . 65
Deployed Process Detail Graph. . . 65
Indexed Properties. . . 66
Service Definitions. . . 67
Task Properties. . . 68
Resources. . . 69
Viewing Catalog Resources. . . 70
Part II: Administering the Process Server. . . 73
Chapter 6: Server Monitoring. . . 74
Server Statistics. . . 75
Deployment Logs. . . 76
Server Log. . . 78
Setting the Process Server Logging Level. . . 80
Deleting the Process Server Log. . . 81
System Logging for WebLogic Users. . . 81
System Performance. . . 81
Chapter 7: Admin. . . 83
Server Status. . . 83 Tenant Detail. . . 84 Cluster. . . 85 Table of Contents 5WebSphere Cluster Properties. . . 86
WebLogic Properties. . . 87
License. . . 87
Chapter 8: Configure Server. . . 89
Server Properties. . . 90 ICS Properties. . . 94 Logging Properties. . . 95 Global Function . . . 97 Monitoring Thresholds . . . 98 URN Mappings. . . 102
Chapter 9: Configure Services. . . 106
Alert Service. . . 107
Identity Service. . . 108
Creating a Trusted Keystore File. . . 108
Identity Service for JDBC Connections. . . 109
LDAP Connections. . . 110
Connection Tab . . . 113
Setting User and Group Attributes. . . 114
Test Tab. . . 115
Import/Export Identity Configuration Section. . . 117
Cache Tab. . . 117
Manual Configuration for a JDBC Identity Service on Tomcat. . . 118
Email Service. . . 119
Messaging Service. . . 120
Setting Up a Messaging Service. . . 121
Websphere Users. . . 123
Enabling XA Transaction Handling. . . 123
Datasource Service. . . 124
Central Service. . . 128
Chapter 10: Maintenance. . . 130
Scheduled Processes. . . 131
Creating a New Process Schedule. . . 131
Managing and Modifying Execution Schedules. . . 133
Storage. . . 134
Manual Maintenance. . . 134
Deleting Completed and Faulted Processes. . . 135
Deleting Offline Contributions. . . 135
Delete Server Log. . . 135
Chapter 11: Agents. . . 138
Agent Process Engine Sizing Guide. . . 138
Managing the H2 Database for Agent Processes. . . 140
Chapter 12: Using the Informatica Cloud Secure Agent Manager. . . 141
Stopping and Restarting the Secure Agent on Windows. . . 141
Configure the Proxy Settings on Windows. . . 142
Configure a Login for a Windows Secure Agent Service. . . 142
Deleting a Secure Agent. . . 143
Uninstalling the Secure Agent on Windows. . . 143
Preface
Welcome to Informatica Cloud Application Integration, purpose-built tools that enable you to integrate users, systems, and processes. The following information is available in the online help:
• Application Integration Guide explains how to use Process Designer (cloud-based only), to visually
create real-time application integration processes and "guides" that enable end users to interact with a business process and related data through a series of steps with user-friendly screens and prompts. Using Process Designer, you can also define service connectors and connections that allow business processes to access internal and external data sources.
• Process Console Guide explains how to use Process Console to monitor and administer runtime
execution of guides and processes.
• Process Developer Guide explains how to use Process Developer, the Eclipse-based IDE that
developers can download to develop processes and prepare to deploy them using the Process Console or other supported deployment mechanisms.
• Human Tasks Guide (Process Developer) explains how to use Process Developer to develop human
workflow activities based on the Human Tasks extension to WS-BPEL 2.0. This is currently available only for on-premises use with Informatica Business Process Manager (ActiveVOS).
• APIs, SDKs, and Services Reference provides details on using the Software Development Kit (SDK) and
APIs, along with common libraries, resources, and example code. Although this information is intended primarily for developers, application integrators working in Process Designer may also find samples or useful background information related to process design and other topics.
• Salesforce Guide provides details related to the Informatica Cloud Real Time for Salesforce Package. You
can license this optional component to install the Process Designer tools as a managed package in your Salesforce organization.
• Connector Guides provides documentation on the individual connectors available for Cloud Application
Integration that is not in the Application Integration Guide.
For more information on Informatica Business Process Manager, refer to this InfoCenter:
http://infocenter.activevos.com/infocenter/ActiveVOS/v92/index.jsp. You can also learn more at:
Informatica Business Process Manager (ActiveVOS) Resources.
Informatica Resources
Informatica Documentation
The Informatica Documentation team makes every effort to create accurate, usable documentation. If you have questions, comments, or ideas about this documentation, contact the Informatica Documentation team
through email at [email protected]. We will use your feedback to improve our documentation. Let us know if we can contact you regarding your comments.
The Documentation team updates documentation as needed. To get the latest documentation for your product, navigate to Product Documentation from https://mysupport.informatica.com.
Informatica Cloud Web Site
You can access the Informatica Cloud web site at http://www.informatica.com/cloud. This site contains information about Informatica Cloud editions and applications.
Informatica Cloud Communities
Use the Informatica Cloud Community to discuss and resolve technical issues in Informatica Cloud. You can also find technical tips, documentation updates, and answers to frequently asked questions.
Access the Informatica Cloud Community at:
https://network.informatica.com/community/informatica-network/products/cloud-integration
To find resources on using Cloud Application Integration (the Informatica Cloud Real Time service), access the community at:
https://network.informatica.com/community/informatica-network/products/cloud-integration/cloud-application-integration/content
Developers can learn more and share tips at the Cloud Developer community:
https://network.informatica.com/community/informatica-network/products/cloud-integration/cloud-developers
Informatica Cloud Marketplace
Visit the Informatica Marketplace to try and buy Informatica Cloud Connectors, Informatica Cloud integration templates, and Data Quality mapplets:
https://community.informatica.com/community/marketplace/informatica_cloud_mall
Informatica Cloud Connector Documentation
You can access documentation for Informatica Cloud Connectors at the Informatica Cloud Community:
https://community.informatica.com/cloud/index.htm
You can also download individual connector guides: https://community.informatica.com/docs/DOC-2687.
Informatica Cloud Trust Site
You can access the Informatica Cloud trust site at http://trust.informaticacloud.com. This site provides real time information about Informatica Cloud system availability, current and historical data about system performance, and details about Informatica Cloud security policies.
Informatica Global Customer Support
You can contact a Customer Support Center by telephone or online.
For online support, click Submit Support Request in the Informatica Cloud application. You can also use Online Support to log a case. Online Support requires a login. You can request a login at
https://mysupport.informatica.com.
The telephone numbers for Informatica Global Customer Support are available from the Informatica web site at https://www.informatica.com/services-and-training/support-services/contact-us.html.
C
H A P T E R
1
Process Console Overview
The Process Console provides options to monitor and manage your processes, whether they are running on the Informatica Cloud Server or on a Secure Agent you create in a new runtime environment.
When you use the Process Console in Informatica Cloud, the Home page looks similar to the illustration below. However, the options available depend on:
• Permissions on your user account.
• Whether you select an agent or the Cloud Server from the Console list.
• Other deployment options based on the product version you are using.
Note: Because the available options vary significantly based on your situation, this online help may contain topics that are not applicable.
Getting Started
Refer to the following topics to learn about options commonly used in Process Console:
Process Console Basics
Starting and stopping the Process Server “Server Status” on page 83
Using Search “Search” on page 13
Importing and exporting a server configuration file “Server Status” on page 83
Deployment How To’s
Deploy processes “Deploying a Business Process Archive” on page 53
View and manage contributions “Contributions” on page 54
View deployed processes “Process Definitions” on page 57
View deployed services “Service Definitions” on page 67
Service Setup How To’s
Set up Identity service “Identity Service” on page 108
Set up an email service “Email Service” on page 119
Set up JMS messaging service “Messaging Service” on page 120
Add an alert service for engine alerts “Alert Service” on page 107
Add a monitoring service “Monitoring Thresholds ” on page 98
Configure Process Central settings “Central Service” on page 128
Active Processes How To’s
View active processes “Active Tasks (Process Developer)” on page 50
View a running, suspended or faulted process “Active Process Detail Page” on page 22
Analyze problems from an execution log “Log View” on page 30
Suspend, fix, and resume a process Chapter 3, “Process Rewind and Exception Management Overview” on page 42
Fix a running process migrated to a new process
version “Migrating Running Processes when Warnings are Generated” on page 48
Use viewing filters “Using Selection Filters for Active Processes” on page 16
View and monitor tasks from People activities Chapter 4, “Task Monitoring (Process Developer)” on page 50
Configure how many simultaneous requests can run concurrently for process throttling control
“Dispatch Service ” on page 38
Process Server Configuration How To’s
Set server properties “Server Properties” on page 90
Set logging properties “Logging Properties” on page 95
Add global custom function contexts “Global Function ” on page 97
Process Maintenance How To’s
Work with process versions “Process Version Life Cycles” on page 61
Clean out old processes “Process Instance Retention” on page 65
Scheduling process execution “Scheduled Processes” on page 131
Process Server Maintenance How To’s
Scheduling database and logs deletion “Storage” on page 134
Server monitoring “Server Log” on page 78
Server monitoring Metrics “System Performance” on page 81
Search
The Search feature allows you to quickly find an active process instance or catalog resource. Search includes an auto-complete feature.
If you enter a Process Id, the Active Process Details page displays the process instance. Active Process details displays in a new browser tab or window.
If you enter a Resource Name, the matching Resource Detail page displays. Here are some tips for using Search.
• Begin typing the name of a resource. When you enter a minimum of three characters, a list of matching resources is displayed.
• Begin typing the name of a resource and press CTRL + spacebar to view a list of matching resources .
• Wildcards are allowed, such as "*.wsdl".
Part I: Using Process Console at
Runtime
This part contains the following chapters:
• Process Monitoring, 15
• Process Rewind and Exception Management Overview, 42
• Task Monitoring (Process Developer), 50
C
H A P T E R
2
Process Monitoring
The Monitor menu in the Process Console provides access to process, task, and server monitoring options that include:
• Active Process: View the list of process instances that have been or are currently executing. See
“Examining and Managing Processes” on page 21 for information.
• “Alarm Queue” on page 36: (On-premises) View a list of active receive, onMessage, and onEvent activities queued for incoming messages.
• “Receive Queue” on page 36: (On-premises) View a list of active 'On Alarm' Process activities.
• “Dispatch Service ” on page 38: (Agent) View details for services governed by the DispatchThrottle policy.
Active Processes
The Active Processes page shows a list of process instances that are executing or completed. The version that this instance is attached to is also shown. States can be running, suspended, completed, compensatable (for a subprocess), or faulted.
From the Monitor menu, choose Process Monitoring > Active Processes.You can select filter criteria to select specific processes or simply click Submit to view all processes. For more details, see “Using Selection Filters for Active Processes” on page 16.
After you submit the selection options, a list of Active Processes displays.
Using Selection Filters for Active Processes
You can filter the active processes list by using a wide range of properties and functions. Select the filters to apply and then select Submit.
The selection filters include:
• State. Select one of the process states that are shown in the table that follows this list.
• Created between. Date and time range for process starts.
• Completed between. Date and time range for process completions.
• Group. The group this process belongs to, if it belongs to one. The Group name is specified in the process deployment descriptor (PDD) and is displayed on the Deployed Process Version Detail page. There is a default System group, which is hidden by default. Remove the checkmark from Hide System to display System processes.
• Additional query. Use the Expression Builder to create a query based on an extensive set of criteria. Select the Dialog (...) button at the end of the row to open the Expression Builder.
The states that you can select are:
Process State Meaning
All All states of process instances.
Compensatable A sub-process is complete and eligible for compensation.
Completed Normal completions.
Faulted Processes completed with a fault.
Pre-Migration Copy The old running process executing against the old process version. This process instance is saved temporarily until the new process instance has been resumed or terminated.
Running Normally running processes.
Suspended A process suspended for any reason.
Suspended (Activity) Suspended on a BPEL suspend activity.
Suspended (Faulting) Suspended on a faulting activity. You can update variables on a faulting process prior to resuming it. For details, see “Process Exception Management” on page 45.
Suspended (Invoke Recovery)
Suspended on a faulting invoke activity after a process recovery. You can update variables on a faulting process prior to resuming it. For details, see “Process Exception Management” on page 45.
Suspended (Manual) Manually suspended process.
Suspended (Migration Error)
Error-level information for a running process that has been migrated to a new process version. Error-level indicates the current execution point cannot be determined.
Suspended (Migration Warning)
Warning-level information for a running process that has been migrated to a new process version. Warning-level indicates differences found in the new version may need attention before resuming the process.
Using the Expression Builder
You can create and submit a query for retrieving processes for display. In the Expression Builder, double-click the properties and functions to build the query, and select OK.
The expression appears in the Additional query text box. You can edit the expression and can use it in conjunction with the other criteria in the Selection Filters. When you select Submit in the Filters area, Process Server retrieves processes that meet the criteria selected.
The following table describes the functions, variables, and properties you can use for filtering the active processes list.
Criterion Example Expression
Process Properties
End Date getProcessProperty(''End Date'') >= "2007/02/17 10:03 AM"
Use the Date selector to enter a correctly formatted date. Group getProcessProperty("Gro up") = ‘NorthWestRegion’ Id getProcessProperty(''Id'') = '102' Initiator getProcessProperty(“Initi ator”) = 'Joe' Name getProcessProperty(''Na me'') = 'LoanApproval'
Criterion Example Expression
Namespace getProcessProperty(''Na mespace'') = 'http:// services.acme.com'
Start Date getProcessProperty(''End Date'') <= "2006/02/17 10:03 AM"
Use the Date selector to enter a correctly formatted date.
State Property Codes for process states: 1 - Running 2 - Suspended 3 - Completed 4 - Faulted 5 - Compensatable Example: getProcessProperty(''Stat e'') = '1'
State Reason Property Codes indicating the reason why a process is suspended: 2 - Suspended (Activity). Suspended at a BPEL suspend activity 1- Suspended (Faulting). Suspended as a result of an uncaught fault 0 - Suspended (Manual) and Pre-Migration Copy. Suspended manually. 8 - Suspended (Migration Warning) 7 - Suspended (Migration Error) Example: getProcessProperty(''Stat e'Reason') = '1'
Title Display text for process name, as specified in the abx:setProcessTitle(titleS tring) custom function. Example: getProcessProperty("Title ") = 'titleString' Version getProcessProperty("Ver sion") = '2' Active Processes 19
Criterion Example Expression
Indexed Properties. For details, see the “Indexed Properties” on page 66 topic.
For details, see the
“Indexed Properties” on page 66 topic.
Functions
contains() contains(getProcessProp erty("Title"),"proc") (maps to the SQL LIKE operator)
getParentId() getParentId() = ‘101’ (returns all subprocesses whose parent process Id is 101)
getProcessProperty("...") See Process Property examples above getProcessProperty("...") = RHS getProcessProperty("Stat eReason") = (7,0) (maps to the SQL IN operator) getIndexedPropertyValue("...") getIndexedPropertyValue ('amount') >= 50000 hasWaitingAlarm() hasWaitingAlarm()
hasWaitingReceive() hasWaitingReceive() (For processes with a waiting receive or OnMessage)
hasWaitingReceive(“partnerLinkName”[,op”]) hasWaitingReceive('{http: //services.acme.com}AR', 'Invoice')
isParentProcess() isParentProcess() (returns all processes that invoke another process)
isParentProcess() OR isSubProcess() (returns all processes involved either as parent or subprocess)
isSubProcess() isSubProcess() (returns all processes that are subprocesses of parent processes)
Criterion Example Expression
nextAlarmTime() nextAlarmTime() > ‘2007-12-31 14:30’ (returns all processes which have an alarm scheduled for any time after 2:30 pm on December 31, 2007) not(...) (getProcessProperty(''Na me'') = 'LoanApproval' not(getProcessProperty('' EndDate'') >= '2005-02-01 4 am'))
Examining and Managing Processes
After you select filter criteria, you see a list of active processes similar to the following:
If you select either the ID or Title for a process, you can view a comprehensive snapshot of the process on the Process View page for a running, suspended, faulted, or completed process instance.
An active process may call a subprocess, indicated by a plus sign next to the process ID. Expand the process to see its subprocesses. A subprocess may have additional state information, including compensatable. See the Process Developer Help fo information on creating a BPEL process to be used as a subprocess.
Note: Information may not updated immediately after an event occurs. It is typically updated between 30 and 60 seconds after an event. If you are not seeing what you think should be there, you may just need to update your browser.
For information on how to change the state of a process in this list, see “Managing Selected Processes” on page 32.
Active Process Detail Page
When you select a process instance from the Active Processes page, the Active Process Detail page opens in a new browser tab or window. This page presents many details about a process instance and allows you to suspend the process and perform process exception management.
The following shows this page and indicates areas on it.
The following view components are available:
Area What It Has
1 Outline view Shows the structural elements of a BPEL process and the current process execution state of each activity. You can select an element to view its properties and values.
2 Executing view
Shows the current process execution state for a running process, stopping on the currently executing activity. If the process is completed, the execution view is blank.
3 Logs view Shows execution details that you can use to analyze data changes, faults, and other details. You can also suspend a process and perform a process rewind of activities.
4 Process view Shows the main process flow on a canvas. If the process has event, fault, and
compensation handlers, you can view them by selecting the corresponding activity from the Outline. For example, select a Catch handler to view all fault handlers. You can also select an activity to view its properties. The BPEL tab shows the source XML code for the process.
5 Properties view
Appears for a selected element selected from the canvas any other component. For example, when the Process element is selected from the Outline view, you can see process properties and their current values, such as the current state and start date.
Additional windows open from the toolbar for Variables, Correlation Sets, Partnerlinks, and Debug threads for a convenient way to edit data and step/retry activities.
Toolbar
A toolbar allows you to select different views of this page and contains features for performing process exception management.
Top Row The items on the top row let you select the default (all components), outline (outline + canvas), properties (properties + canvas), or canvas-only view. You can also display different views with URL view parameter with the following arguments:
1: Default, show all components (Outline, Canvas, Properties) 2: Canvas only
3: Outline and Canvas 4: Canvas and Properties
Bottom Row
Pressing one of these buttons brings up on of the following dialogs: 1. Variables
2. Partner Links 3. Correlation Sets 4. Debug Threads
For additional information, see Chapter 3, “Process Rewind and Exception Management Overview” on page 42.
The Variables, Partner Links, and Correlation Sets dialogs work similarly. Here, for example, is a Variables dialog:
As you type in a variables name, a picklist appears showing variables that match what you are typing (left dialog). After you choose one, the dialog displays information about the variable.
The Debug Threads dialog lets you suspend a process, step through it, and edit a variable, partner link, or correlation set.
From right to left, this window's toolbar buttons are: • Step • Retry • Complete • Suspend • Resume
The Canvas View
The Canvas view of Process Details shows the main process flow and the execution path through the process. You can also view the process fault, event, and compensation handlers has them by selecting it from the Outline. For example, select a Catch to display all fault handlers.
In the upper-right panel of the page, you see the main flow of a BPEL process. The process diagram reflects the layout rendering within the Process Developer.
Each process activity has an icon, a label, and an execution state indicator, as shown in the following illustration.
1 Activity icon. Activity icons are the same as those supplied with Process Developer.
2 Activity label, which can be the activity type, name, type:name, or custom text
3 Execution state indicator. For a description of each indicator, see “Outline View” on page 27.
The canvas view looks similar to the following example.
To view details, do the following:
• Select an activity from the diagram to view its properties.
• Select an activity from the diagram to put the activity in focus in the Outline, or vice versa.
• Select a People activity (if you are using Process Developer) to see details about active tasks.
To print the diagram, select a browser printing option from the right-mouse menu. The diagram prints with the same caption that appears in the canvas view. The timestamp indicates when the Process Details page was opened or refreshed.
Printing Tips:
• To print a large diagram, select scaling options in your Printer options dialog, such as Fit to Page or print as x% of Normal Size.
• Save the diagram as an image file to print later. See also “Outline View” on page 27.
Executing View
The Executing view is a filter conveniently showing only currently executing activities. This view is useful to locate the execution point to perform process exception management.
Use hte Filter picklist to tell Process Console what it should display. Your choices are All, Execution, Faults, Data Change, and Rewind Points.
See also:
• “Outline View” on page 27
• “Log View” on page 30
Outline View
Use the Outline view to select an activity so to put it in focus on the canvas. The activities are not necessarily shown in execution order: the order matches the order in which the activities were created. Also, some of the items on the outline are containers, such as a flow or a sequence and these may be hidden on the canvas. If you select a flow, the first activity within the flow is put in focus. If you select a collapsed container, shown with a plus sign, you will see a drill-down view of the activities within the container. If you select partnerlinks or variables, you will see them in the Properties view.
The following illustration shows an Outline view of a process instance.
Outline View Menu Bar
The Suspend, Resume, and Terminate buttons are enabled only if the process is currently running or suspended. Using these features, you can perform process exception management by correcting, resuming, retrying or completing a suspended or suspended-faulting activity. For details, see Chapter 3, “Process Rewind and Exception Management Overview” on page 42.
Structural Elements of a BPEL Process
To view details about a process element, select it. The following table describes each element. Only elements that exist in the process are displayed here.
Process Element
in Outline Details Displayed in Properties
Activities The activities section of the Outline begins with a flow (or other) activity that represents the main container for the whole process. Within the flow, there is a list of all process activities. The activities are in the same order as in the BPEL XML code. If the process was designed in Process Developer, the order matches the Outline view order. The activity list shown is not necessarily in execution order.
For each activity, you can view the execution state and activity definition.
Correlation sets These elements display the message properties (the definition and current value) that track different conversations carried on by the process. A correlation set contains a message property to ensure that each process conversation is uniquely identified.
Process Element
in Outline Details Displayed in Properties
Event handlers Event handlers run concurrently with a process scope and invoke an activity based on an alarm or message received. The information displayed is name, state, and details of event handling activity. Scopes can have their own local fault handlers.
Fault handlers Fault handlers run concurrently with a process scope and invoke an activity based on an alarm or message received. They display catch faults thrown by process activities. This includes name, state, and details of fault handling activity. Scopes can have their own local fault handlers.
Human Interactions This is an Informatica extension for human tasks. It displays logical people groups, tasks, and notifications
Links If an activity is the source of a link, the link is displayed below the activity node. Link properties are displayed, including link status (whether or not the link executed), the transition condition, if it exists, and the link’s target activity.
Partner links The types of partner links; that is the Web services that are invoked. It displays the partner role and/or my role.
This may be the endpoint reference of the partner link service. You can see the address information in the Properties view. Scopes can have their own local partner links.
Process name This is the local part of the process-qualified name. It shows the current state, start/end time of process instance, and deployment details for the process. Fault details may also be displayed.
Termination handlers Activities can be terminated in a process through fault handling, early termination by a completion condition on a parallel forEach or through the execution of a Process Developer extension break activity.
Variables These display the message or other data received, manipulated, and sent from the process. A variable may include attachments. For a variable type, you will see the message, schema type, or schema element.
The current value of the variable is also displayed. For a running process, the value is current as of the time you opened or refreshed the Process Details window.
If the variable has attachments, they are also displayed and can be downloaded.
Process States
The process can have the following execution states:
State Meaning
Completed Normal completion
Faulted Completed with a fault or termination
Running Snapshot of the executing process when you open the Process Details window. The process continues to run, but the Process Details window is not updated unless you select Refresh.
State Meaning
Suspended (Faulting)
Execution is stopped on a faulting activity. The activity has an uncaught fault and the process is configured for suspension on an uncaught fault.
Suspended (Manual) The process stops running when you select Suspend from the Process Details window.
Additional states are shown when applicable for process migration warnings and errors.
Log View
In the Active Process Detail window, select the Logs tab next to the Outline to view a time-based list of executing activities. You can use the log to analyze process execution events, including data changes and faults. Navigate within the execution log to any point in time, for example, an iteration in While loop, and view the process state and data at that execution point. You can step through the events to see how a process changed over time.
See also Chapter 3, “Process Rewind and Exception Management Overview” on page 42.
Note: If you do not see the Logs tab, it means logging is not enabled. Go to the Admin > Configure Server > Logging Properties page to enable logging for future process instances. Alternately, you can modify the deployment descriptor file in Process Developer to enable logging, and then redeploy the process.
The following shows an execution log.
Use the execution log as follows:
• Select a Filter to show data changes, faults, activity execution states, rewind points, or all. The Data Change filter shows variables whose content has changed, and also shows partner links and Logical People Groups that have been changed dynamically in an assign activity.
• Highlight an event and select Go To Execution Point to put the event in focus on the canvas. The process’s state and data are based on a snapshot created at the selected log event.
• After selecting Go To Execution Point, return to the currently executing activity in a running process by selecting Go To Current in the upper-right corner of the window.
• Once you select an event, switch back to Outline view to see a graph of the process in the selected execution state. Also from the outline, you can inspect the variables at that point in time.
Activity States
You can determine the execution status of each activity by looking at the icon next to the activity.
Icon Explanation
Executing
Ready to Execute
Finished
Faulted. Occurs when a fault is thrown during the execution of an activity.
Suspended (Faulting). Occurs when a fault is thrown during the execution of an activity and the fault is uncaught. If desired, you can make corrections or resume suspended (faulting) processes. See “Process Exception Management” on page 45.
Terminated. Occurs when the process is manually terminated.
Dead Path
Suspended
(none) Inactive (the initial state of an activity)
For a running process, the icon next to an activity may change if you refresh the Process Details window. Fault information includes:
Column Explanation
Fault Name BPEL or engine fault name
Fault Namespace BPEL or engine fault namespace
Fault Source Process activity that threw the fault
Fault Message Data Data in the throw or catch fault variable
Fault Attachments Content external to the variable may be included and can be downloads
You can get further information about faults:
• Select the faulted activity to view the fault name.
• For a faulting activity, you can correct data, retry or complete the activity. See “Process Exception Management” on page 45.
Tip: You can view the entire process log as a text file and download it by selecting View Log (the magnifier icon) on the Outline tab.
Managing Selected Processes
As you are testing or managing processes, you may want to select a group of running, suspended, faulted, or completed processes and take some action on them.
On the Active Processes page, do the following:
1. Display a list of processes you want to work with. If desired, use the Selection Filters to create a customized list. For details, see “Using Selection Filters for Active Processes” on page 16. 2. Select some or all of the processes displayed on the current page.
You can select up to the maximum records displayed per page. You cannot select processes on
subsequent pages. Enter a checkmark in the Select All/None box. Set the number of records per page, if desired.
3. From the Action picklist, select one of the following:
• Terminate: Terminates running processes.
• Suspend: Suspends running processes.
• Resume: Resumes suspended processes.
• Delete: Deletes faulted or completed processes.
4. Select Execute to take the action on the selected, displayed processes.
A list of processes is displayed confirming the action you want to take. Note that any Process Retention setting you have configured on the Storage page or for an individual process definition is ignored.
You can also schedule the deletion of completed and faulted processes as well as delete all active processes tied to a contribution, explained in “Contributions” on page 54.
Variable Attachments
If a process is running, you can also add and remove variable attachments.
You can do the following to view, download, add, and remove process variable attachments: 1. Select a process from the Active Processes list.
2. In the Active Process Detail window’s Outline View, expand the list of variables.
3. Select a variable from the list to view the variable instance data and attachments, as shown in the following illustration for a running process.
Adding an Attachment
While a process is running, you can add one or more attachments to a variable. In the Active Process Detail page, expand a variable to display the Attachments header. Select Add to open the Add Variable
Attachment dialog, as shown in the example.
You can browse to locate a file to attach. You can also add, edit, or delete attachment properties and values. Deleting an Attachment
To delete an attachment for a running process, select Delete, next to the Download link. Viewing or Downloading an Attachment
For a running, faulted, or completed process, select the Download link to open a dialog that asks where to open or save the file.
Reports (Process Developer)
The Dashboard and Report pages display business activity monitoring reports. These pages help you understand statistics about active processes. Process Server includes several basic reports, and you can deploy your own custom reports to the server.
The Dashboard gives you a quick status of where your system is by displaying thumbnail reports of the most frequently needed information. You can click on a thumbnail to link to a larger display of the report on the Reports page.
The Reports page has two main categories of reports:
• Process Management: Process-based reports show data about any active process
An active process or task is one that has started, and perhaps completed, execution. A report may provide greater state detail about running, faulted, or suspended processes and similar detail about unclaimed, started, or suspended tasks.
Reports have the following features:
• A report consists of data retrieved from the database at an interval basis set internally. The date and time of the report is displayed.
• You can select a link on a report item to view details about the active process or human task.
• Toolbar icons on a displayed report allow you to open and save a report to applications such as Microsoft Word or Excel.
• Top processes and tasks (for the Top reports) are the most active, based on a 24-hour rolling window
Report Viewer Toolbar
Use the report viewer toolbar as follows:
• Toggle table of contents. For user-defined reports that define table of contents entries, you can turn the display on or off. The basic Process Server reports do not use a table of contents.
• Run report. For user-defined reports that include runtime parameters, you can select parameters to display different report data. The basic Process Server reports do not use runtime parameters.
• Export data. You can select data elements from a report and then select export preferences for the data.
• Export report. Export a report in a format compatible with applications such as Microsoft Word or Excel.
• Print report. Print a report in HTML or PDF format.
User-Defined Reports
You can create your own reports in Process Developer and deploy them to the server. During deployment, you can specify a Process group name or Contribution group name for a report category. Using a group name, your reports can be grouped like the process and task reports on the Reports page.
Process Developer provides a project template that contains the configuration details needed for creating reports for deployment to the server. The template contains a connection to database tables and views as well as style elements for the layout and display of reports.
A comprehensive report creation environment lets you create text or graphical reports. For details, see the Creating Reports for the Process Server in Process Developer Help.
Alarm Queue
Under Selection Filter, select these Alarm Queue options to determine which process activities appear when you view active alarms in the On Alarm list:
Option Description
Deadline Between Beginning and Ending date and time for alarm.
Process ID Process instance ID. You can find this ID on the Active Processes page (see
“Examining and Managing Processes” on page 21 for more information).
Process Name Local part of the process-qualified name (qname) .
Group The Group this process belongs to (optional). The Group name displays in the On Alarm list.
Hide System Uncheck to display the default System processes. The System processes are hidden by default.
Receive Queue
View a list of active receive, onMessage, and onEvent activities. These activities are queued for incoming messages.
Use the controls on this page to set the size for how many queued receives to hold in memory to reduce the number of queries to the database. Sizing depends on server memory constraints.
Unmatched Correlated Receive Timeout
Clock icon: Duration chooser dialog box displays. For details, see “Server Properties” on page 90. Unmatched Correlated Receive Count
Based on values you see in “System Performance” on page 81 regarding the number of requests in the queue and the number of rejected requests, you may wish to increase or decrease this value.
Queued Receive Cache Size
The size of the cache used to hold activity information while the system is busy with other requests. You can also change any of the values displayed for these three fields.
If events are displayed, select a receive and then select a partner link to view details. A window opens where you can see the BPEL process location in which the receive activity executes. You can also see the
correlation property alias and data, if any, associated with this receive activity If you click on:
• Process ID: Active Process page displays.
• Partner Link: Customer Link page displays
The information displayed for a receive queue item is:
Item Meaning
Process ID Process Instance ID. You can find this Id on the Active Processes page.
Partner Link The partner link for the item in the receive queue. A partner link is a communication exchange between two partners. In the most basic form, the process is a partner link of an external service, receiving a request from it. A partner link defines the role that the process plays (if any) and the role that the partner service plays (if any) in the particular exchange
Port Type The port type, which is a port type in WSDL is a set of related operations such as receive, reply, and invoke include operations.
Operation The operation that just executed.
Note: Receives for system processes, especially for Human tasks, are not displayed, unless you ask for them by partner link name or Process ID.
Selection Filter
Select one or more options from the Selection Filter option list to view a selection of active receives. You can find this information on the “Deployed Process Version Detail” on page 60 page, which shows the BPEL source code
You do not need to enter the fully qualified name for the operation.
Dispatch Service
To see the Dispatch Service option, first select an agent from the Console.
Occasionally, a service has a heavily used process with one-way operation requests (as opposed to request-response types). One-way requests follow a fire-and-forget semantic that dispatches requests to the engine as fast as possible and does not wait for a reply. During runtime, if many thousands of these requests, plus request-response requests, try to execute simultaneously, the result can either be an overwhelmed invoked service or resources on the server.
You can solve this problem by using a Request Dispatch Service. This service controls the maximum number of concurrently executing requests by putting requests in queues and dispatching them in batches. It also controls the number of new requests dispatched while allowing running processes to complete.
The dispatch service applies to all inbound requests except for subprocess invokes.
Process Server has a default dispatch configuration. In addition, you can create a dispatch configuration for a service or process group. In a multitenant-enabled versions of Process Server, you can configure the service for each tenant.
You can also create your own configuration by selecting Monitor > Process Monitoring > Dispatch Services and then pressing the Add Configuration button.
At runtime, the dispatch configuration used for a request is chosen based on matching the configuration name in the following order of precedence: Service Name, Process Group, Tenant, System Default. A dispatch server applies to all inbound requests except for subprocess invokes.
Creating a Custom Dispatch Configuration
You can also create your own configuration by selecting Monitor > Process Monitoring > Dispatch Services and then pressing the Add Configuration button.
A dispatch server applies to all inbound requests except for subprocess invokes.
At runtime, the dispatch configuration that a request uses is chosen based on matching the configuration name in the following order of precedence: Service Name, Process Group, Tenant, System Default.
Setting a Dispatch Configuration
The a dispatch configuration has the following properties: Name
The name must match a process service name, a process group name (added within the deployment descriptor), or tenant. Tenant is applicable only with a multitenant license. Once you add and save a name, the name cannot be changed. If needed, you can delete the configuration and add a new one. If the name is not an exact process service or process group name, Process Server does not know how to use the configuration.
Max Concurrent
Maximum number of inbound receives that can be processed concurrently. The default is 250. When creating a dispatch service, this setting and the Max Queued setting should be the same. The only time you might want to set this value larger than Max Queued is if you define a persistent dispatch service. This kind of service stores information until there is room for it in memory.
Max In-Memory
Maximum number of pending requests to hold in memory. The default is 2500. Max Queued
Maximum number of pending requests to hold in the queue (both storage and memory). The default is 2500. Any additional requests waiting to be queued will never execute.
When creating a dispatch service, this setting and the Max Concurrent setting should be the same. See Max Concurrent for more information.
Timeout (seconds)
Maximum amount of time, in seconds, that a single request may hold up another request from being executed. The default is 300. If the timeout is exceeded, a pending request is allowed to execute. Persistent
If this checkbox is selected, buffered requests are held in storage for recovery. If it is not selected, buffered requests are only held in memory. The default is in-memory as this avoids additional overhead. Change or use the default values for the other properties, described above for the system default.
Request Dispatch Service
Use the information in the Request Dispatch Service page to monitor the configuration execution and update the configuration to tune performance and adapt to a changing load. You can monitor the live information for each per configuration for your server nodes.
Note: Dispatch control applies to all inbound receives except for subprocess invokes. Monitoring statistics include the following
Statistic Explanation
Name The name assigned to the request dispatch service
Executing Number of requests currently running in an engine node
Queued Number of requests currently queued, waiting to execute. New requests are dispatched to the engine as processes started by previous requests enter a quiescent state. A quiescent state applies to processes eligible to leave memory: final state, suspended, or running with no invoke activities running.
Average Time
(ms) Average execution time per request, displayed as hh:mm:ss.milliseconds. This includes the time per request for the process to reach a quiescent state. Consumed Total number of requests consumed and executed by the engine
Rejected Total number of requests that were rejected by the engine; (for example, unmatched receive, validation errors
Status Statuses are as follows:
- Active: The manager is actively dispatching queued messages to the engine. - Suspended Messages remain on the queue until dispatch is resumed.
- Pending Delete Queued requests are waiting to be consumed. You may need to refresh the browser just after selecting Delete Configuration to remove the configuration from view.
Refresh the browser to see updated statistics.
You can take the following actions for one or more selected configurations: Delete Configuration
Removes the configuration. The status will be Pending Delete until you refresh the browser. If there are queued requests, the configuration is removed once all existing requests are consumed. No new requests are added.
Purge Queued Requests
Deletes all waiting requests from the queue. These requests are never executed. This action exists for unusual circumstances that require clearing the queue.
Reset Statistics
Sets execution counts and averages to zero. Resume Execution
Resumes dispatching new requests to the engine. Suspend Execution
Stops dispatching new requests to the engine. Messages remain on the queue until dispatch is resumed.
Additional Controls Related to the Dispatch Service
As you monitor dispatch services, you can use other configuration settings to help monitor and manage an overflow of requests to the Process Server. If there appear to be issues, it could be because the dispatch service's Max Queued value is being exceeded.
Use the following commands to determine if requests are being rejected:
• On the Admin > Server Properties page, you can set a value for Unmatched Correlated Receive Timeout. For details, see “Server Properties” on page 90.
• On the Admin > Monitoring Thresholds page, you can add a property for Discarded unmatched correlated receives. For details, see “Monitoring Thresholds ” on page 98.
• Check the Process Server Log for errors related to rejected requests. For details, see “Server Log” on page 78.
C
H A P T E R
3
Process Rewind and Exception
Management Overview
You can make changes to a running process by suspending it and then debugging it, changing variable data or executing, retrying, or completing activities. There are many ways a process can be suspended, including a deployment or engine setting for suspending a process on an uncaught fault, a suspend activity in the process, and manual suspend.
Change a suspended process in one of the following ways:
• “Process Exception Management” on page 45
Suspend the process at the currently executing activity. You can execute, retry, or complete the activity and change variable data for the currently executing activity or scope. There is no effect on the compensation and termination handling activities of the enclosing scope.
• “Process Rewind” on page 42
Process rewind lets you go back to a point in time to reexecute activities. Suspend the process and select any ready-to-execute activity as the starting point for re-execution. This allows you to cancel executing activities and reexecute activities that are already executed. As desired, you can execute, retry, or complete activities and change variable data.
Compensation or termination handling does not occur on previously executed or canceled activities.
If you are migrating running processes to a new process version, refer to “Migrating Running Processes when Warnings are Generated” on page 48.
Process Rewind
Using Rewind, you can go back to an earlier execution point and re-execute activities. You can execute, retry, or complete activities and change variable data. The logging level set for the process affects what data can be restored. If your process is enabled for execution logging, instead of Execution with
