Escolar Documentos
Profissional Documentos
Cultura Documentos
Version 8.0
December 2009
This document applies to webMethods Designer Version 8.0 and to all subsequent releases. Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions. Copyright 20062009 Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or their licensors. The name Software AG, webMethods, and all Software AG product names are either trademarks or registered trademarks of Software AG and/or Software AG USA, Inc. and/or their licensors. Other company and product names mentioned herein may be trademarks of their respective owners. Use of this software is subject to adherence to Software AGs licensing conditions and terms. These terms are part of the product documentation, located at http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s). This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to "License Texts, Copyright Notices and Disclaimers of Third Party Products." This document is part of the product documentation, located at http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).
Table of Contents
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Documentation Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Online Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Editor and Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Moving and Aligning Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Canvas Clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Process Development Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Capabilities Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . External Tools Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Appearance Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Colors And Fonts Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Build and Upload Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default Documentation Fields Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Default Documentation Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing Default Documentation Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Default Documentation Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing and Exporting Default Documentation Fields . . . . . . . . . . . . . . . . . . . . Optimize Server Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Audit Database Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Debugging Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Properties View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Outline View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Outline View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Navigator View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Solutions View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Working with Process Projects and Processes in the Solutions View . . . . . . . . . . Creating Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Associating Assets with Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Associations from Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Renaming Process Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Assets from the Solutions View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing and Exporting Assets from the Solutions View . . . . . . . . . . . . . . . . . . . Creating Process Projects in the Solutions View . . . . . . . . . . . . . . . . . . . . . . . . . Working with Process Projects in the Solutions View . . . . . . . . . . . . . . . . . . . . . . 9 10 10 15 16 16 20 21 23 24 24 26 27 28 30 33 35 36 37 37 37 38 39 40 41 42 43 44 46 47 49 50 51 51 52 53 54 54 54 55
Creating Processes in the Solutions View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Working with Processes in the Solutions View . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Team Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Saved Searches View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Search View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Package Navigator View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Build Report View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Problems View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Error Log View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Trace View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Step Data View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Breakpoints View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Process Development Perspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Managing Perspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Process Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Creating Process Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Deleting Process Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Creating Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Configuring Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Deleting Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Printing Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Saving Process Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Copying Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Documenting Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Adding Documentation Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Assigning Documentation Field Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Removing Documentation Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Working with Process Notes and Annotations . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Generating Documentation Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Importing and Exporting Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Importing Designer Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Exporting Designer Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Importing Modeler Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Modeler to Designer Conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Importing BPEL Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Exporting BPEL Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Importing XPDL Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 XPDL to Designer Conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Quality of Service Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Renaming Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Resizing Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Moving Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Renaming Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Resizing Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Swimlane Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Steps to Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Steps to Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Step Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Step Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Empty Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring IS Service Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Task Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Rule Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Web Service Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Referenced Process Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Receive Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using E-forms in Receive Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Reply Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Publish Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Terminate Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Gateway Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subprocesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Subprocesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Steps to Subprocesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Subprocess Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Showing and Hiding Step Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Step Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Step Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
110 111 111 112 113 113 114 115 115 116 117 118 118 119 120 121 126 127 128 129 130 132 136 141 146 150 157 165 167 170 174 178 180 181 182 182 187 189 190 191
Auto-Populating Step Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging Step Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step Input and Output Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying Referenced Process Start and Return Documents . . . . . . . . . . . . . . . . . . Step Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step Transition Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Standard Exception Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Step Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Step Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Step Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step Transition Condition Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subprocess Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subprocess Loop Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Subprocess Loop Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subprocess Loop Condition Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Join Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Join Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Join Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subscription Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Subscription Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Subscription Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Subscription Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Correlation Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Correlation Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying Correlations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Building and Uploading Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Building and Uploading Processes from the Command Line . . . . . . . . . . . . . . . . . . . . Process Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Generation Sample 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Generation Sample 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IS Service Step and Rule Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Receive Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Referenced Process Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reply Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Publish Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subprocess Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Task Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Terminate Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
192 192 194 196 197 199 201 201 202 203 205 206 207 207 208 209 210 212 212 213 214 214 215 217 217 219 220 222 225 226 229 231 231 235 236 237 237 238 239 240
Web Service Step Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating New Process Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Releasing New Process Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Associated Fields from Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . Process-Level KPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step-Level KPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Step-Level KPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying Step-Level KPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Step-Level KPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Dimensions from Step-Level KPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . Uploading KPIs to Optimize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Debugging Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
241 242 243 244 244 245 246 247 247 248 248 249 250 250 251 251 253 255 257
Document Conventions
Convention Bold Narrow font UPPERCASE Italic Description Identifies elements on a user interface. Identifies storage locations for services on webMethods Integration Server, using the convention folder.subfolder:service. Identifies keyboard keys. Keys you must press simultaneously are joined with a plus sign (+). Identifies variables for which you must supply values specific to your own situation or environment. Identifies new terms the first time they occur in the text. Identifies text you must type or messages displayed by the system. Indicates a set of choices from which you must choose one. Type only the information inside the curly braces. Do not type the { } symbols. Separates two mutually exclusive choices in a syntax line. Type one of these choices. Do not type the | symbol. Indicates one or more options. Type only the information inside the square brackets. Do not type the [ ] symbols. Indicates that you can type multiple options of the same type. Type only the information. Do not type the ellipsis (...).
Monospace font
{} | [] ...
Documentation Installation
You can download the product documentation using the Software AG Installer. Depending on the release of the webMethods product suite, the location of the downloaded documentation will be as shown in the table below. For webMethods... 6.x 7.x 8.x The documentation is downloaded to... The installation directory of each product. A central directory named _documentation in the main installation directory (webMethods by default). A central directory named _documentation in the main installation directory (Software AG by default).
Online Information
You can find additional information about Software AG products at the locations listed below. Note: The Empower Product Support Web site and the Software AG Documentation Web site replace Software AG ServLine24 and webMethods Advantage. If you want to... Access the latest version of product documentation. Find information about product releases and tools that you can use to resolve problems. See the Knowledge Center to: Read technical articles and papers. Download fixes and service packs. Learn about critical alerts. See the Products area to: Download products. Get information about product availability. Access older versions of product documentation. Submit feature/enhancement requests. Go to... Software AG Documentation Web site http://documentation.softwareag.com Empower Product Support Web site https://empower.softwareag.com
10
If you want to... Access additional articles, demos, and tutorials. Obtain technical information, useful resources, and online discussion forums, moderated by Software AG professionals, to help you do more with Software AG technology. Use the online discussion forums to exchange best practices and chat with other experts. Expand your knowledge about product documentation, code samples, articles, online seminars, and tutorials. Link to external Web sites that discuss open standards and many Web technology topics. See how other customers are streamlining their operations with technology from Software AG.
11
12
Process Development Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Editor and Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Development Perspectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Swimlanes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subprocesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Step Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subprocess Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Join Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subscription Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Correlation Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Building and Uploading Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KPIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
13
14
15
16
The main toolbar is the topmost toolbar in Designer, just below the menu. Most Designer toolbar buttons are always available. Some, however, are available in some perspectives but not others, and some are available based on the editor that has focus. Process Development views usually have their own buttons as well. The process editor toolbar is a part of the process editor. Process editor toolbar buttons are always visible when a process is displayed (open) in the process editor; you can click only the buttons that are relevant to the selected asset or assets on the canvas. For example, you can only click Go Into Subprocess if a subprocess is selected. The following toolbar buttons affect process assets and their display in the process editor: Main Toolbar Button Description Launch Blaze Advisor Launch webMethods Developer Tip! If you select an Integration Server document or service and then launch Developer, the selected document or service opens there. If Developer is already running, Designer uses the open instance. Search Back Forward Canvas Zoom Default is 100%. Auto-layout the process Default (Horizontal or Vertical) is set in Preferences. Business Analyst Process Developer Upload for Analysis Only Upload KPIs Build and upload for execution Requires Process Developer mode. See Capabilities Preferences on page 26. Debug Selected Process Requires Process Developer mode. See Capabilities Preferences on page 26.
17
Description Refresh Documents Click to refresh all Integration Server (IS) documents used in the process currently displayed in the process editor. Requires Process Developer mode. See Capabilities Preferences on page 26. Business Analyst Mode Show only basic properties, preferences, and functions See Capabilities Preferences on page 26. Process Developer Mode Show advanced properties, preferences, and functions See Capabilities Preferences on page 26.
Description Change Line Shape Select the line shape option for the open process. Choose Curved, Straight, or Custom. Default line shape is set in Preferences. Designer saves the selection for each process. Show: Inputs/Outputs Check or clear the box to show step inputs and outputs for the open process. Default behavior (show or hide) is set in Preferences. Designer saves the selection for each process. Show: Notes Check or clear the box to show or hide all notes for the open process. Default behavior (show or hide) is set in Preferences. Designer saves the selection for each process. Show: Step Types Check or clear the box to show or hide all step types for the open process. Step types are displayed as small icon decorations that represent how the step is implemented (as a rule service, task, etc.). Default behavior (show or hide) is set in Preferences. Designer saves the selection for each process.
You can configure the default behavior of many process aspects on the Appearance page in the Software AG Preferences window. Window > Preferences > Software AG > Process Development > Appearance. You can set the process editor to show or hide inputs/outputs, notes, and step types by default. You can set the default step type, the way steps are configured when you create them by drag and drop actions, and whether inputs and
18
outputs update automatically. You can set auto-layout and pool orientations, transition line shape and text type, and whether you want Designer to automatically switch perspectives for you when you open new processes. On the Colors and Fonts page in the Software AG Preferences window (Window > Preferences > Software AG > Process Development > Appearance > Colors and Fonts), you can set the default colors for swimlanes, swimlane labels, pool labels, subprocesses, and notes. You can also set the default font styles including font name, size, weight, angle, and color for step labels, transition labels, and annotations. Many functions in Designer are available in the (right-click) context menus of the step, subprocess, transition line, pool, swimlane, or note currently selected. The available options depend on conditions such as the step type and current perspective. If you have the Process Simulation feature installed, you can create a process simulation from an open process in the process editor. For more information on process simulation, see Process Simulation on page 257. Main Toolbar Button Description Simulate Process Click to create a process simulation from the process that is currently displayed in the process editor. With a subprocess selected in the process editor, you have the following options on the process editor toolbar: Process Editor Toolbar Button Description Go Into Subprocess Click to drill into a selected subprocess. You can also perform this action by right-clicking a collapsed subprocess and selecting Drill into subprocess. Back to Parent Process Click to return to the previously viewed layer from the current subprocess view. Home Click to return to the standard process view. Related Topics Moving and Aligning Steps on page 20 Using the Canvas Clipboard on page 21 Using Keyboard Shortcuts on page 23 Configuring Process Development Preferences on page 24 Appearance Preferences on page 28
19
Process Development Views on page 41 Process Development Perspectives on page 69 Working with Process Notes and Annotations on page 87 Subprocesses on page 180 Process Simulation on page 257
20
Press the Enter key or click an empty spot on the process editors canvas when you are finished.
Related Topics Configuring Process Development Preferences on page 24 Process Development Editor and Tools on page 16 Using the Canvas Clipboard on page 21 Using Keyboard Shortcuts on page 23 Steps on page 121
21
Step IDs are recalculated to use a new, unique ID in the target process Transition IDs are recalculated to use a new, unique ID in the target process Transition references are updated to the new source and target step IDs If the target process has a data item of the same name as the pasted assets, the pasted step updates its references to use the existing data item If the target process has a data item of the same name as the pasted assets, but with different type or description information, Designer renames the pasted data item, by appending a suffix of _<number>. So a pasted myInput becomes myInput_1. To paste one or more steps or notes on the process editors canvas Do one of the following: Right-click and select Paste to paste to a specific location on the canvas. CTRL+V or Edit > Paste to paste to an unspecified location on the canvas. When you paste steps, Designer automatically selects them so you can easily relocate them on the process editors canvas if you want to. Relative positions of multiple steps is preserved when you paste. If the target process editors canvas has an asset selected, steps and/or notes are pasted relative to the selected asset. If there is nothing selected on the target canvas, steps and/or notes are pasted relative to the top left of the canvas. If you paste a step or a note very close to the edge of a pool, swimlane, or expanded subprocess, the container expands to accommodate the pasted item. Note: You can undo a paste. CTRL+Z, Edit > Undo Paste, or right-click and select Undo Paste. You can also redo a paste that you undo. CTRL+Y, Edit > Redo Paste, or rightclick and select Redo Paste. Related Topics Configuring Process Development Preferences on page 24 Process Development Editor and Tools on page 16 Moving and Aligning Steps on page 20 Using Keyboard Shortcuts on page 23 Steps on page 121
22
ALT+F11
23
Related Topics Configuring Process Development Preferences on page 24 Process Development Editor and Tools on page 16 Moving and Aligning Steps on page 20 Using the Canvas Clipboard on page 21
24
Capabilities Preferences on page 26 Search Preferences in webMethods Designer BPM and CAF Workspace Metadata Help and webMethods Designer BPM and CAF CentraSite Metadata Help 3 Click to expand the Software AG entry and set preferences for each of the following sections.
CentraSite Preferences in webMethods Designer BPM and CAF CentraSite Metadata Help External Tools Preferences on page 27 Integration Servers Preferences in webMethods Designer Service Development Help Workspace Index Preferences in webMethods Designer BPM and CAF Workspace Metadata Help 4 Click to expand the Software AG > Process Development entry and set preferences for each of the following sections.
Appearance Preferences on page 28 Colors And Fonts Preferences on page 30 Build and Upload Preferences on page 33 Default Documentation Fields Preferences on page 35 Optimize Server Preferences on page 38 Process Audit Database Preferences on page 39 Process Debugging Preferences on page 40 5 6 To apply default preferences on a page, click Restore Defaults. Click Apply to save your changes and keep the Preferences window open. Click OK to save your changes and close the Preferences window. Click Cancel to close the Preferences window without saving your changes. Tip! You can use the Forward and Back buttons in the Preferences window to navigate through Preferences pages you have visited. Related Topics Process Development Preferences on page 24 Appearance Preferences on page 28 Colors And Fonts Preferences on page 30 CAF Development Preferences in webMethods Designer CAF Development Help Service Development Preferences in webMethods Designer Service Development Help
25
Process Simulation Preferences in webMethods Designer BPM Process Simulation Help Task Development Preferences in webMethods Designer BPM Task Development Help Workspace Index Preferences in webMethods Designer BPM and CAF Workspace Metadata Help CentraSite Preferences in webMethods Designer BPM and CAF CentraSite Metadata Help CentraSite Plug-ins User Guide
Capabilities Preferences
You can configure Eclipse capabilities preferences to support additional functionality. In order to access the Error Log view in Designer, Plug-in Development capabilities must be enabled. This adds the PDE Runtime node to the available views. This preference is enabled by default when you install Designer. Plug-in Development capabilities allow Designer to have two different modes of operation: Business Analyst mode and Process Developer mode. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability preference. This enables Process Developer mode. You can control the Process Developer capability in Window > Preferences > General > Capabilities, but there is an easier way. While the process editor has focus, on the main toolbar, select Process Developer if you want advanced options, and select Business Analyst if you want basic options. Only one of these options, or modes, is enabled at a time. The Process Developer capability status in Window > Preferences > General > Capabilities always reflects the current state of the button selection (enabled for Process Developer mode and disabled for Business Analyst mode). Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. For more information on Eclipse capabilities, see Eclipse documentation.
26
To enable the Plug-in Development Capability 1 2 3 4 5 6 In Designer: Window > Preferences > General > Capabilities Click Advanced to open the Advanced Capabilities Settings window. Expand the Development node. Select the Plug-in Development check box if it is not already selected. Click OK to save your changes and close the Advanced Capabilities Settings window and return to the Preferences window. Click Apply to apply your changes without closing the Preferences window. Click OK to apply your changes and close the Preferences window. When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. To enable / disable the Process Developer Capability 1 2 In Designer: make sure the process editor has focus. On the main toolbar, select Process Developer if you want advanced options, and select Business Analyst if you want basic options. Only one of these options, or modes, is enabled at a time. The Process Developer check box at Window > Preferences > General > Capabilities always reflects your current mode selection.
Related Topics Error Log View on page 63 Configuring Process Development Preferences on page 24 Search Preferences in webMethods Designer BPM and CAF Workspace Metadata Help and webMethods Designer BPM and CAF CentraSite Metadata Help
27
Description Click Browse to select the path. The default path is set to ..\..\Developer\bin\developer.bat. Click Browse to select the path. The default path is set to ..\..\blaze\Advisor65\bin\builder.bat.
To apply default preferences on a page, click Restore Defaults. Click Apply to save your changes and keep the Preferences window open. Click OK to save your changes and close the Preferences window. Click Cancel to close the Preferences window without saving your changes.
Related Topics Configuring Process Development Preferences on page 24 Using Blaze Rules with BPM and CAF Process Rules on page 215
Appearance Preferences
To configure Process Development Appearance preferences 1 2 In Designer: Window > Preferences > Software AG > Process Development > Appearance You can configure the following Process Development Appearance preferences on the Appearances page: Preference Show notes by default Show step type by default Show inputs and outputs on steps by default Show ToolTips Automatically add inputs / outputs to steps Replace existing inputs/outputs with automatically added inputs/outputs Description Select the check box to enable. Enabled by default. Select the check box to enable. Disabled by default. Select the check box to enable. Disabled by default. Select the check box to enable. Enabled by default. Select the check box to enable. Enabled by default. Select the check box to enable. Disabled by default. Available only when Automatically add inputs / outputs to steps is enabled.
28
Preference Automatically change step name when drag and drop document or service over existing step Default Activity Step type
Description Select the check box to enable. Enabled by default. New activities added to a process will be of the selected type. Select from the list: Empty, IS Service, Task, Rule, Web Service, or Referenced Process. Default is Empty. Choose Always, Never, or Prompt. Default is Always. Choose Horizontal or Vertical. Default is Horizontal. Choose Horizontal or Vertical. Default is Horizontal. Choose Curved, Straight, or Custom. Default is Curved. Choose the priority of the information you want Designer to show on the transition line. Choose Condition Expression, Transition Description, or None. Default is Condition Expression. For example: if Condition Expression is selected, and a line has no condition defined but does have a transition description, the Transition Description is displayed on the line.
Automatically update task business data with the task step inputs/outputs Default pool orientation Default auto layout orientation Default transition line shape Transition line text
Choose the directory containing all custom image jars. Default is ..\Designer\resources\ Choose Always, Never, or Prompt. Default is Prompt.
By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode. When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26.
29
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. Note: Automatic perspective switching, whether or not you set Designer to prompt you first, only happens when you open a process or process simulation file. When you click back and forth between a process and a process simulation file after they have been opened, Designer does not change perspective. This allows you to view a file in a different perspective than its default. The Process Simulation feature is required to view process simulation files. See Process Simulation on page 257. Related Topics Configuring Process Development Preferences on page 24 Pools on page 110 Step Inputs and Outputs on page 187 Documenting Processes on page 85 Steps on page 121 Swimlanes on page 114 Subprocesses on page 180 Step Transitions on page 197 Process Simulation on page 257
30
Description Choose the default colors for Swimlanes, Swimlane Labels, Pool Labels, Subprocesses, and Notes. Click the color box to open the Color window and select a new color. Select a font from the list. Default is Tahoma. Select a font size from the list. Default is 8. Click the Bold button to apply bold formatting to your default font. Click the Italic button to apply italic formatting to your default font. Click the Font Color button to choose the default font color from a palette. Default is black.
31
Description Select a font from the list. Default is Tahoma. Select a font size from the list. Default is 8. Click the Bold button to apply bold formatting to your default font. Click the Italic button to apply italic formatting to your default font. Click the Font Color button to choose the default font color from a palette. Default is black.
Select a font from the list. Default is Tahoma. Select a font size from the list. Default is 8. Click the Bold button to apply bold formatting to your default font. Click the Italic button to apply italic formatting to your default font. Click the Font Color button to choose the default font color from a palette. Default is black.
3 4
To apply default preferences on a page, click Restore Defaults. Click Apply to save your changes and keep the Preferences window open. Click OK to save your changes and close the Preferences window. Click Cancel to close the Preferences window without saving your changes.
By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode. When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26.
32
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. Note: Automatic perspective switching, whether or not you set Designer to prompt you first, only happens when you open a process or process simulation file. When you click back and forth between a process and a process simulation file after they have been opened, Designer does not change perspective. This allows you to view a file in a different perspective than its default. The Process Simulation feature is required to view process simulation files. See Process Simulation on page 257. Related Topics Configuring Process Development Preferences on page 24 Pools on page 110 Step Inputs and Outputs on page 187 Documenting Processes on page 85 Steps on page 121 Swimlanes on page 114 Subprocesses on page 180 Step Transitions on page 197 Process Simulation on page 257
33
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. Basic Build and Upload preferences include Save before building/uploading processes and Automatically build/upload referenced processes when building parent process. These two preferences apply to both basic and advanced actions. In Business Analyst mode, you can Upload for Analysis Only, but you cannot Build and upload for execution. In Process Developer mode, you can do both. To configure Build and Upload preferences 1 2 In Designer: Window > Preferences > Software AG > Process Development > Build and Upload You can configure the following Build and Upload preferences: Preference Save before building/uploading processes Description Choose Always, Never, or Prompt. Default is Prompt. Note: By default, when you add a step to a process model and then Edit Data Mapping, the step in the model is saved if Save before building/uploading processes is enabled. If it is not enabled, Designer prompts you to save the step. Choose Always, Never, or Prompt. Default is Always.
Automatically build/upload referenced processes with parent process Automatically enable process for execution after build/upload Automatically deploy task to Task Engine Automatically upload KPIs on build Prompt to upload KPIs
Choose Always, Never, or Prompt. Default is Prompt. Choose Always, Never, or Prompt. Default is Prompt. For Upload KPIs menu and toolbar button actions. Does not apply to uploading KPIs with a build. Choose Always or Never. Default is Always.
34
Preference Display stack traces in Build Report when encountering exceptions Stack Trace Line Limit
Maximum number of stack trace lines included in the Build Report view when encountering exceptions. This value is used only when Display stack traces in Build Report when encountering exceptions is enabled. The default value is 10.
3 4
To apply default preferences on a page, click Restore Defaults. Click Apply to save your changes and keep the Preferences window open. Click OK to save your changes and close the Preferences window. Click Cancel to close the Preferences window without saving your changes.
Related Topics Configuring Process Development Preferences on page 24 Building and Uploading Processes on page 220 KPIs on page 244 Build Report View on page 62
35
Related Topics Configuring Process Development Preferences on page 24 Adding Default Documentation Fields on page 36 Editing Default Documentation Fields on page 37 Removing Default Documentation Fields on page 37 Importing and Exporting Default Documentation Fields on page 37 Documenting Processes on page 85
Related Topics Editing Default Documentation Fields on page 37 Removing Default Documentation Fields on page 37 Importing and Exporting Default Documentation Fields on page 37 Default Documentation Fields Preferences on page 35 Documenting Processes on page 85
36
Related Topics Adding Default Documentation Fields on page 36 Removing Default Documentation Fields on page 37 Importing and Exporting Default Documentation Fields on page 37 Default Documentation Fields Preferences on page 35 Documenting Processes on page 85
Related Topics Adding Default Documentation Fields on page 36 Editing Default Documentation Fields on page 37 Importing and Exporting Default Documentation Fields on page 37 Default Documentation Fields Preferences on page 35 Documenting Processes on page 85
37
If you imported, new fields appear in the Default Documentation Fields list. Note: If you import default documentation fields you already have, they remain unchanged. Only new fields will be added.
Related Topics Adding Default Documentation Fields on page 36 Editing Default Documentation Fields on page 37 Removing Default Documentation Fields on page 37 Default Documentation Fields Preferences on page 35 Documenting Processes on page 85
Test Connection 3 4
To apply default preferences on a page, click Restore Defaults. Click Apply to save your changes and keep the Preferences window open. Click OK to save your changes and close the Preferences window. Click Cancel to close the Preferences window without saving your changes.
38
URL
Database user Password Select a running Integration Server that has the Process Audit pool configured
To apply default preferences on a page, click Restore Defaults. Click Apply to save your changes and keep the Preferences window open.
39
Click OK to save your changes and close the Preferences window. Click Cancel to close the Preferences window without saving your changes. Related Topics Configuring Process Development Preferences on page 24 Building and Uploading Processes on page 220
40
Description Enter the number of seconds the Process Debugging session should wait for you to mark a task step as complete. A value of 0 means never time out. The default value is 180. Enter the maximum percentage of Designer memory a Process Debugging session should be allowed to consume. The default value is 100. Once the threshold is reached, Designer prompts you to decide whether to end the debugger session. If you choose to end the session, the Process Debugger adds a row to the Trace view. If you choose not to end the session, the Process Debugging session will continue to prompt you as long as Designers memory consumption remains at the threshold set for the Peak Memory Use (percent) preference. You can change the Peak Memory Use (percent) threshold at any time during a debugging session. You might choose to do this to prevent the prompt from recurring if you decide to continue a session that consumes a higher percentage of Designer memory than currently set in Preferences.
3 4
To apply default preferences on a page, click Restore Defaults. Click Apply to save your changes and keep the Preferences window open. Click OK to save your changes and close the Preferences window. Click Cancel to close the Preferences window without saving your changes.
Related Topics Configuring Process Development Preferences on page 24 Process Debugging on page 253 Process Simulation on page 257
41
The following Process Development views are available: Designer View Properties view Outline view Navigator view Solutions view Registry Explorer view Package Navigator view Saved Searches view Search view Build Report view Problems view Error Log view Trace view Step Data view Breakpoints view Related Topics Process Development Perspectives on page 69 Description See Properties View on page 42. See Outline View on page 43. See Navigator View on page 46. See Solutions View on page 47. See Registry Explorer View in webMethods Designer BPM and CAF CentraSite Metadata Help. See Package Navigator View on page 61. See Saved Searches View on page 60. See Search View on page 61. See Build Report View on page 62. See Problems View on page 63. See Error Log View on page 63. See Trace View on page 63. See Step Data View on page 67. See Breakpoints View on page 68.
Properties View
The Properties view displays information about the currently selected asset in Designer, including processes, steps, pools, transitions, annotations (notes), and process simulation resources (with the Process Simulation feature). Based on the type of asset selected, the Properties view is organized into pages that allow you to see and configure specific aspects of the asset. When you select an asset in an editor or in a view, information about it appears in the Properties view. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode.
42
When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. If you close the Properties view and want to reopen it, click Window > Show View > Properties. Related Topics Process Development Views on page 41 Configuring Processes on page 78 Configuring Pools on page 111 Configuring Swimlanes on page 115 Configuring Steps on page 129 Appearance Preferences on page 28 Search View on page 61 Registry Explorer View in webMethods Designer BPM and CAF CentraSite Metadata Help Process Simulation on page 257
Outline View
The Outline view is a standard Eclipse view. In Designer, it provides a tree view of the elements that are displayed in the process editor. Use it to locate elements on the process editors canvas. This is especially helpful when the process editor contains many and/or a complex set of elements. When you select an element in the Outline view, it becomes the selected element on the canvas. As a result, other views that are specific to the selected element, such the Properties view, also display information for the selected element. If you have the Process Simulation feature installed, you can also use the Outline view to manage processes in an open process simulation file. The Process Simulation feature is required to view process simulation files. See Process Simulation on page 257. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode.
43
When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. The Outline view is shown by default in the Process Development and Process Debugging perspectives. If you close the Outline view and want to reopen it, click Window > Show View > Outline. Related Topics Using the Outline View on page 44 Process Development Views on page 41 Process Simulation on page 257
Expand the nodes as needed to display the hierarchical view of the process. You can perform the following actions in the Outline view.
44
Description To hide external pools and the steps within them, click View Menu (in the upper right corner) and select Filters > Hide External Pools. Designer places a check mark next to the Hide External Pools menu item to indicate external pools are currently hidden. To show external pools, repeat this step by clicking Menu again and selecting Filters > Hide External Pools again. Designer removes the check mark next to the Hide External Pools menu item.
To hide swimlanes, click View Menu (in the upper right corner) and select Filters > Hide Swim Lanes. Designer places a check mark next to the Hide Swim Lanes menu item to indicate swimlanes are currently hidden. To show swimlanes, repeat this step by clicking View Menu again and selecting Filters > Hide Swim Lanes again. Designer removes the check mark next to the Hide Swim Lanes menu item.
Display an area of the process that is not on the visible part of the process editors canvas
You can update the display of the process on the canvas to show another area of the process. To do so, click Canvas View. Designer replaces the tree view with a thumbnail of the entire process. When the process extends beyond the visible area of the Process Development canvas, Designer displays a blue box to show the area of the process that it is currently displaying on the canvas. Drag the blue box to cover the area of the process you want Designer to display on the canvas. To return to the tree view, click Tree View.
Expand nodes in the tree until you find the step, swimlane, or pool and click it. The selected item is highlighted in the process editor.
45
Description Select a KPI nested under a step and click it. The step that contains the KPI is highlighted in the process editor. Note: KPIs cannot be reused in multiple steps; each step has its own KPIs. Use the Add Process, Remove Process, and Refresh Processes buttons to manage the processes in the currently open process simulation file.
Add, remove, and refresh processes in the currently open process simulation file Note: requires the Process Simulation feature. See Process Simulation on page 257. Related Topics
Process Development Views on page 41 Outline View on page 43 Solutions View on page 47 Navigator View on page 46 Process Simulation on page 257
Navigator View
The Navigator view is a standard Eclipse view that provides a tree view of all the assets in your workspace. You can use the Navigator view to open files for editing or select assets for operations such as exporting. If you are using Team Development, use the Navigator view to share assets in your workspace with other team members. For more information about using the Navigator view or Team Development, see Eclipse documentation. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode.
46
When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. The Navigator view is shown by default in the Process Development and Process Debugging perspectives. If you close the Navigator view and want to reopen it, click Window > Show View > Navigator. Note: An alternative to viewing your workspace using the Navigator view is to use the Solutions view. In the Navigator view, the tree structure lists files that are in your workspace. The Solutions view provides a simpler view that shows only your webMethods assets. In the Solutions view, the tree structure lists only the assets (e.g., processes, tasks, and user interfaces) and not the individual files that make up those assets. If you have the Process Simulation feature installed, the Solutions view also shows process simulations. The Process Simulation feature is required to view process simulation files. See Process Simulation on page 257. Related Topics Process Development Views on page 41 Solutions View on page 47 Outline View on page 43 Team Development on page 60 Process Simulation on page 257
Solutions View
The Solutions view shows webMethods assets in your workspace; that is, it shows processes, tasks, and user interfaces. Assets are grouped by solution, which is a logical grouping you can form to relate the processes, tasks, and user interfaces that you use for a solution. This allows you to visually comprehend all the assets that make up one of your solutions. Note: If you have the Process Simulation feature installed, the Solutions view also shows process simulations. The Process Simulation feature is required to view process simulation files. See Process Simulation on page 257.
47
The Solutions view always contains the Default Solution, which contains all processes, tasks, and user interfaces in your workspace. You can create additional solutions that contain only the processes, tasks, and user interfaces that you associate with it. For example, you might create a New_Orders solution to group the assets that handle processing orders; this will allow you to easily comprehend the processes, tasks, and user interfaces that are used to process orders. You can associate a single resource with multiple solutions. For example, you might create a Report_Problems process and associate it with all of your solutions. Note: An alternative to viewing your workspace using the Solutions view is to use the Navigator view. In the Navigator view, the tree structure lists files that are in your workspace. An asset in the Solutions view can relate to multiple files in your workspace. You can perform actions for each node in the Solutions view. The actions vary based on the type of node. Use a nodes context (right-click) menu to view the actions you can perform. You can adjust and update the Solutions view tree using the Collapse All and Refresh buttons on its toolbar. You can also Import and Export files in the Solutions view. The Solutions view is shown by default in the Process Development and Process Debugging perspectives. If you close the Solutions view and want to reopen it, click Window > Show View > Solutions. Related Topics Creating Solutions on page 50 Deleting Solutions on page 51 Associating Assets with Solutions on page 51 Removing Associations from Solutions on page 52 Renaming Process Assets on page 53 Team Development on page 60 Related Assets in webMethods Designer BPM and CAF Workspace Metadata Help and webMethods Designer BPM and CAF CentraSite Metadata Help Navigator View on page 46 Process Development Views on page 41 Process Simulation on page 257
48
49
Creating Solutions
To create a solution 1 Display the New Solution window. To do so, perform one of the following sets of steps:
From the File menu: In Designer: File > New > Solution
You can create a new solution this way in the Process Development and Process Debugging perspectives.
From the Solutions view: 1 In Designer, if the Solutions view is not visible, display it: Window > Show View > Solutions. The Solutions view is shown by default in the Process Development and Process Debugging perspectives. 2 Right-click any solution node in the Solutions view and select New Solution.
2 3 4
In the New Solution window, specify the name of the solution in the Project name field. Ensure the Use default location check box is selected. Do not clear this check box. Click Finish.
Related Topics Solutions View on page 47 Deleting Solutions on page 51 Navigator View on page 46 Process Simulation on page 257
50
Deleting Solutions
To delete a solution, you must delete it from the Navigator view. However, you can use the Solutions view to identify the files you need to delete. To delete a solution 1 2 In Designer, if the Solutions view is not visible, display it: Window > Show View > Solutions. Right-click the solution you want to delete and select Show Files. Designer displays the Navigator view and highlights the file associated with the solution you selected in the Solutions view. Note: You cannot delete the 3 4 Default Solution. Delete.
In the Navigator view, right-click the selected folder and select In the Confirm Project Delete window, select one of the following:
Also delete contents under <workspace_name> to remove the solution from your workspace and also delete the files associated with the solution from your file system. Do not delete contents to remove the solution from your workspace, but leave the files associated with the solution in your file system.
Related Topics Solutions View on page 47 Navigator View on page 46 Creating Solutions on page 50
51
Note: The Solutions view always displays the Default Solution, which contains all processes, tasks, and user interfaces in your workspace. Create additional solutions to form logical groups of processes, process simulations, tasks, and user interfaces for each of your solutions. If you have the Process Simulation feature installed, the Solutions view also shows process simulations. The Process Simulation feature is required to view process simulation files. See Process Simulation on page 257.
To associate a process project with a solution 1 2 In Designer, if the Solutions view is not visible, display it: Window > Show View > Solutions In the Solutions view, under the Processes (or Simulations folder, if you have the Process Simulation feature installed), right-click the process project that you want to associate with a solution, select Associate With Solution, then select the name of the solution with which to associate the selected item. Designer places a check mark next to the solutions name in the menu to indicate that the asset is now associated with that solution. Additionally, Designer adds the tree structure for the process project to the selected solution. Related Topics Creating Solutions on page 50 Removing Associations from Solutions on page 52 Process Simulation on page 257
52
To remove a process project association from a solution 1 2 In Designer, if the Solutions view is not visible, display it: Window > Show View > Solutions In the Solutions view, under the Processes (or Simulations folder, if you have the Process Simulation feature installed), right-click the process project with which you want to remove the association, select Associate With Solution, then select the name of the solution from which to remove the association. Designer removes the check mark next to the solutions name in the menu to indicate that the asset is no longer associated with that solution. Additionally, Designer removes the tree structure for the process project from the solution. Related Topics Associating Assets with Solutions on page 51 Renaming Process Assets on page 53 Process Simulation on page 257
To rename a process asset 1 2 3 In Designer, if the Solutions view is not visible, display it: Window > Show View > Solutions Right-click the asset you want to rename and select Rename... . Edit the current assets name and press Enter.
Related Topics Solutions View on page 47 Removing Associations from Solutions on page 52 Creating Process Projects on page 75 Creating Process Projects in the Solutions View on page 54 Working with Process Projects in the Solutions View on page 55
53
Related Topics Solutions View on page 47 Process Development Editor and Tools on page 16 Importing and Exporting Processes on page 90
If you select the Processes node in the Default Solution, Designer adds the new process project to your workspace, but does not associate it with any solution that you created. Once created, Designer displays the new process project in the Default Solution in the Solutions view.
54
If you select the Processes node under one of the solutions you created, Designer adds the new process project to your workspace and associates it with this solution. Once created, Designer displays the new process project in this solution in the Solutions view.
In the New Process Project window in the Project name field, type a name for the process project. The project name cannot have any of the following characters: *|\:"<>./?
If you want to create the process project in a different workspace from the one Eclipse is currently using: a b Clear the Use default location check box. Click Browse and identify the location where you want to create the new process project.
Click Finish. Note: You can also create a process project when you create a process. See Creating Processes on page 77.
Related Topics Solutions View on page 47 Creating Process Projects on page 75 Working with Process Projects in the Solutions View on page 55 Renaming Process Assets on page 53 Deleting Process Projects on page 76
55
To... View the file in your workspace that corresponds to a process project
Take this action in the Solutions view... Right-click a Show Files. process project and select
Designer displays the Navigator view and highlights the file associated with the process project. Associate a process project with a solution that you created Right-click a process project and select Associate With Solution, then select the name of the solution with which to associate the selected process project. Designer places a check mark next to the solutions name in the menu to indicate the process project is now associated with that solution. Remove the association of a process project with a solution Right-click a process project and select Associate With Solution, then select the name of the solution from which to remove the association. Designer removes the check mark next to the solutions name in the menu to indicate the process project is no longer associated with that solution. Add a new process to the process project Refresh the contents of the process project Related Topics Solutions View on page 47 Working with Process Projects and Processes in the Solutions View on page 49 Associating Assets with Solutions on page 51 Removing Associations from Solutions on page 52 Creating Process Projects on page 75 Creating Process Projects in the Solutions View on page 54 Renaming Process Assets on page 53 Right-click a process project and select New Process. Complete the New Process window. Right-click a Refresh. process project and select
56
In the New Process window, type the Process Name. The process name cannot have any of the following characters: *|:"<>.? Note: Process names can contain spaces, but if they contain spaces at the end of the name, Eclipse will warn you that the name is invalid. Although Designer does not enforce this restriction, it is a good practice to avoid trailing spaces in process names.
Select the Process Project from the list or Click New to create a new process project for your new process.
If you create a new process project, Designer displays the New Process Project window. Type a Project name and select the workspace in which to save it. For more about creating process projects, see Creating Process Projects on page 75.
Click Finish.
Related Topics Solutions View on page 47 Creating Processes on page 77 Configuring Processes on page 78 Working with Processes in the Solutions View on page 58 Processes on page 77
57
Designer displays the Navigator view and highlights the file associated with the process. View dependencies of a process Right-click a process.
Select Show Dependencies > In Library or Show Dependencies > In Workspace. For more information, see Showing Asset References and Dependencies in webMethods Designer BPM and CAF Workspace Metadata Help. Because Designer uses metadata to determine dependent assets, if you have set your Designer preferences to disable workspace indexing, the Search view might not list all dependencies. See Enabling or Disabling Workspace Indexing in webMethods Designer BPM and CAF Workspace Metadata Help.
58
Select Show References > In Library or Show References > In Workspace. For more information, see Showing Asset References and Dependencies in webMethods Designer BPM and CAF Workspace Metadata Help. Note: Because Designer uses metadata to determine referenced assets, if you have set your Designer preferences to disable workspace indexing, the Search view might not list all references. See Enabling or Disabling Workspace Indexing in webMethods Designer BPM and CAF Workspace Metadata Help. Refresh the contents of a process Add a referenced process step to the current open process in the process editor Right-click a process and select Refresh.
Select a process and drag it onto the canvas. This will create a step with the same name as the process dropped there, and will configure the step type to be Referenced Process. Right-click a process and select Publish.
Right-click a process and select Delete. CTRL+click to select multiple processes, then right-click and select Delete.
Related Topics Solutions View on page 47 Working with Process Projects and Processes in the Solutions View on page 49 Related Assets in webMethods Designer BPM and CAF Workspace Metadata Help and webMethods Designer BPM and CAF CentraSite Metadata Help Registry Explorer View in webMethods Designer BPM and CAF CentraSite Metadata Help Processes on page 77 Creating Processes on page 77
59
Creating Processes in the Solutions View on page 57 Working with Processes in the Solutions View on page 58 Configuring Processes on page 78 Configuring Referenced Process Steps on page 150
Team Development
Eclipse supports team development through the use of a source control system (VCS). These are sometimes also referred to as source code control systems (SCC). Some examples are Concurrent s System (CVS) and Perforce. You can: Obtain assets from a VCS and put them into your workspace from the Navigator view. Copy assets from your workspace into a VCS. You also do this from the Navigator view; however, from the Solutions view, you can easily locate the files associated with assets you want to copy. For information about how to interact with a VCS using the Navigator view, see documentation provided with your VCS that describes the Eclipse plug-in to your VCS. To locate the files associated with the assets that you want to copy to your VCS 1 2 In Designer, if the Solutions view is not visible, display it: Window > Show View > Solutions Right-click the asset you want to copy to your VCS, and select Show Files. Designer displays the Navigator view and highlights the file(s) associated with the asset you selected in the Solutions view. This indicates the files you should add to your VCS for the selected asset. Related Topics Navigator View on page 46 Solutions View on page 47
60
Related Topics Search View in webMethods Designer BPM and CAF Workspace Metadata Help and webMethods Designer BPM and CAF CentraSite Metadata Help
Search View
The Search view is a standard Eclipse view. Designer displays the results of a search in the Search view. When you choose to show references or dependencies in the Solutions or Registry Explorer view, the results are shown in the Search view. See Showing Asset References and Dependencies in webMethods Designer BPM and CAF Workspace Metadata Help and Showing Asset References and Dependencies in webMethods Designer BPM and CAF CentraSite Metadata Help. Related Topics Search View in webMethods Designer BPM and CAF Workspace Metadata Help and webMethods Designer BPM and CAF CentraSite Metadata Help
61
You cannot drag synchronous publish and wait adapter notification document type from the Package Navigator directly onto the process editor. To create a synchronous request, create a receive step and then drag and drop the synchronous publish and wait request document onto the step. Similarly, to create a synchronous reply, create a reply step and then drag and drop the synchronous publish and wait reply document onto the step. A synchronous publish and wait adapter notification requires both the request and the reply. If you close the Package Navigator view and want to reopen it, click Window > Show View > Package Navigator. Related Topics Process Development Views on page 41 Capabilities Preferences on page 26 Appearance Preferences on page 28 Properties View on page 42 Package Navigator in webMethods Designer Service Development Help
62
Problems View
The Problems view is a default Eclipse view that displays system-generated errors, warnings, or information associated with a resource. For example, if a receive step in your process does not have a subscription document specified, the error is automatically logged in this view. The Problems view also displays errors and warnings generated by Simulation (in the Process Simulation perspective). The Problems view is displayed by default in the Process Development perspective. If you close the Problems view and want to reopen it, or if you want to open it in another perspective, go to Window > Show View > Related Topics Process Development Views on page 41 Problems.
Related Topics Process Development Views on page 41 Process Development Workspace on page 16
Trace View
The Trace view is displayed in the Process Debugging perspective. You use the Trace view to control your navigation through steps, and to see the progress of those steps, including errors, during a process debugging session. Click a line that corresponds to a step in the Trace view to select the corresponding step in the Step Data view, where you can see the pipeline data associated with the step selected in the Trace view. You can expand the information displayed to see more details of the output data from the pipeline of the selected step, providing an opportunity to troubleshoot the behavior of the overall process at the step level. The Trace view has a toolbar you can use to perform actions on the process as you debug it. The following buttons are available, and key combinations are listed below each one:
63
Description Step into a subprocess Note: If you Step Into a subprocess that contains a single referenced process step, that step is immediately run. The Step Into button is then disabled, as the only step in the subprocess has already been accessed.
Run the next step in the process. If the next step is a collapsed subprocess, run all the steps in the collapsed container. Step out of a subprocess If you Step Into an empty subprocess, the Step Out button is not enabled, as there are no steps to execute in the subprocess. Select the Step Over button to proceed to the next step in the parent process.
Run the process to the next set breakpoint or to the end of the process if no breakpoints have been set. Force exception conditions for a process. Use the items in this menu to execute the following: Process-wide Timeout This option is only available if a Timeout Error Handler Step is configured in the Properties view of the process. See Configuring Processes on page 78. You can execute a Process-wide Timeout at any point in the process. This action causes the process to execute the Timeout Error Handler Step in parallel with all remaining steps in the process. It does not cause the process to end. You can execute a process-wide timeout multiple times. After the process completes the execution of the Timeout Error Handler Step, the Process-wide Timeout option is re-enabled, allowing you to select it again to force another Process-wide Timeout.
64
Button
Description Process-wide Cancel This option is only available if a Cancel Handler Step is configured in the Properties view of the process. See Configuring Processes on page 78. You can execute a Process-wide Cancel at any point in the process. This action causes the process to complete the execution of all currently running steps and then execute the Cancel Handler Step. The process will not execute any other remaining steps. After the Cancel Handler Step completes, the process ends and the View Menu items are disabled. Join timeout Step(s) This option is only available if the process contains join steps for which timeout values are configured. See Configuring Join Conditions on page 210. The Join timeout Step(s) menu option has a submenu that contains one entry for each join step that has a configured timeout value. Each submenu entry is the combination of a join timeout step Label followed by its Step ID. Tip! For example, a submenu item for a join timeout step with the Label Get_Orders_timeout and the Step ID S14 would be Get_Orders_timeout (S14). Submenu entries are enabled only when they are available for execution. You can execute a join step timeout after at least one of the transitions into the join step has arrived, but before all of the transitions arrive; that is, until the join condition is satisfied. After selecting a submenu entry, it continues to remain enabled until the join condition is satisfied. Executing a join timeout step causes the process to execute the join timeout step and any additional steps in its path. If the timeout step path does not result in a terminate-type step, after the steps in the join timeout step path complete, the debugging session continues to execute other steps in the process. After the join step has timed out, that join step and any subsequent steps are no longer available for execution.
65
Below the toolbar, the Trace view shows a table that contains the following information about the steps in the process being debugged, and, on completion, the status of the process itself. You can click column headings to change the sort order of the steps. Column Status Indicator Description green square = step or process completed yellow triangle = step or process completed with warnings red circle = step or process completed with errors Step Step ID Start Time End Time Duration Status Message Step name Step ID Step start time, and process start time at end of debugging session. Step end time, and process end time at end of debugging session. Step duration time, and process duration at end of debugging session. Details of step or process status, corresponding to Indicator Status
The End Time and Duration options share a column in the table. You can choose which to show by right-clicking anywhere in the table and selecting Toggle between End Time and Duration. Designer retains your setting until you change it again. There is one additional button in the Trace view. It is displayed above the table. Cancel the debugging session and remove all process annotations in the process editor that were made by the Process Debugging session. This includes restoring the colors of the transition lines that were altered. When the Debugger encounters exceptions, they are displayed in the Trace view. If you want to see more of the error information, hold your cursor over the error row. Designer displays extended error data, including a stack trace, if appropriate. You can copy the text in the window. Press the F2 key for focus (once the window has focus, the prompt to do so disappears), and then CTRL+C to copy. The text is highlighted in blue once it has been copied, so you know when you can paste. If you end the debugging session in response to a prompt that you have reached the Peak Memory Use (percent) set in Process Debugging Preferences on page 40, Designer adds a descriptive row to the Trace view. If you close the Trace view and want to reopen it, go to Window > Show View > Related Topics Step Data View on page 67 Breakpoints View on page 68 Trace.
66
Process Development Views on page 41 Process Development Perspectives on page 69 Process Debugging on page 253
Note: No pipeline data is shown in the final row in the table. It represents the overall process status. The Step Data views toolbar has the following buttons: Button Expand/collapse all items Expand/collapse all items Description The button is a toggle. Click to expand a collapsed tree, or to collapse an expanded one. Initially, Designer displays the collapsed view, and will automatically expand all items. This can be changed in Process Debugging preferences. See Process Debugging Preferences on page 40. Click to copy the pipeline data for the selected step to the copy buffer. Click to copy the pipeline data for the all steps to the copy buffer.
Copy the pipeline for this step to the copy buffer Copy the pipelines for all steps to the copy buffer
If you close the Step Data view and want to reopen it, go to Window > Show View > Step Data.
67
Related Topics Trace View on page 63 Breakpoints View on page 68 Process Development Views on page 41 Process Development Perspectives on page 69 Process Debugging on page 253
Breakpoints View
The Breakpoints view is displayed in the Process Debugging perspective. You use the Breakpoints view when you debug a process using a run trace. The Breakpoints view contains a list of the steps in your process. Select the check box associated with the step at which you want to stop debugging. You can also use the Breakpoints view during a step trace. During a step trace, the debugging session runs all the steps in a collapsed subprocess or referenced process. If a breakpoint is set in the subprocess or referenced process, the trace stops at that breakpoint. All other breakpoints are ignored during a step trace. You can set or clear breakpoints at any time before or during a step or run trace. The debugging session evaluates each steps breakpoints just before execution. After you stop at a breakpoint, you can select the step in the Trace view and review the data in the Step Data view. Click any of the enabled buttons in the Trace view to resume debugging the process. If you close the Breakpoints view and want to reopen it, go to Window > Show View > Breakpoints. Related Topics Trace View on page 63 Step Data View on page 67 Process Development Views on page 41 Process Development Perspectives on page 69 Process Debugging on page 253
68
69
Description By default, the Process Development perspective includes basic process design functionality and property information to allow the non-developer to create processes; allows uploading processes for analysis only. Process Developer mode provides advanced configuration and property access to further define processes. In Business Analyst mode, you can Upload for Analysis Only, but you cannot Build and upload for execution. In Process Developer mode, you can do both. Tip! When the process editor has focus, select Business
Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. Process Debugging The Process Debugging perspective includes functionality that allows process debugging, and also supports design and property information of the Process Development perspective; allows uploading processes for analysis as well as building and uploading processes for execution.
By default, Designer initially opens in the Process Development perspective. You can switch perspectives using the Window > Open Perspective menu. After the first time you run Designer, it opens in the last perspective used. Each perspective is configured to display certain views, as shown below. Some views, such as the Search view and Build Report view, are automatically shown when they have information to display. All views are available from the Window > Show View menu. Default Process Development Views in Perspectives View Properties Outline Navigator Solutions Registry Explorer Process Development Process Debugging
70
View Package Navigator Problems Saved Searches Trace Step Data Breakpoints Other Process Development Views View Search Build Report Error Log Description
Process Development
Process Debugging
Designer shows this view automatically when you perform a search. Designer shows this view automatically when you build a process and upload it for execution. The Error Log view is available in all perspectives from Window > Show View > Other > PDE Runtime > Error Log. Plug-in Development must be enabled in Capabilities Preferences on page 26 in order to have access to the Error Log view.
Pipeline
Designer shows this view automatically when you edit a flow service. See What Does the Pipeline View Contain? in webMethods Designer Service Development Help.
Related Topics Process Development Views on page 41 Managing Perspectives on page 71 Process Simulation on page 257
Managing Perspectives
You can switch perspectives, change the views they show, save your changes, and reset them to restore their default settings. You can configure Designer preferences to automatically switch to the Process Development perspective when you open a process file. See Appearance Preferences on page 28.
71
You can also configure automatic switching to the Process Simulation perspective when you open a process simulation file. See Process Simulation Preferences in webMethods Designer BPM Process Simulation Help. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode. When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. Note: Automatic perspective switching, whether or not you set Designer to prompt you first, only happens when you open a process or process simulation file. When you click back and forth between a process and a process simulation file after they have been opened, Designer does not change perspective. This allows you to view a file in a different perspective than its default. The Process Simulation feature is required to view process simulation files. See Process Simulation on page 257.
To switch to a different perspective 1 2 In Designer: Window > Open Perspective Click the perspective you want to open.
To change the views in a perspective 1 2 3 4 In Designer: Window > Show View If the view you want is not listed there, click Other to choose from a comprehensive list of views. Click the view you want to show. Repeat until the views you want are showing.
To save a perspective If you add views to a perspective and want to keep them, you can save the perspective to always show the views you have added.
72
1 2
In Designer: Window > Save Perspective As... In the Save Perspective As... window, enter or edit the name of the perspective. If you choose an existing perspective, you will be prompted to choose whether or not to overwrite it.
To reset a perspective You can reset a perspective to its default settings. 1 2 In Designer: Window > Reset Perspective Accept the prompt to reset the perspective to its default settings.
Related Topics Process Development Perspectives on page 69 Process Development Views on page 41 Appearance Preferences on page 28 Process Simulation on page 257
73
74
Process Projects
Process projects serve as the parent structures for Designer processes and their assets. A single process project can contain one or more processes. You can create a process project without a process in it, but a process must belong to a process project, and cannot exist outside of it. Related Topics Creating Process Projects on page 75 Creating Process Projects in the Solutions View on page 54 Working with Process Projects in the Solutions View on page 55 Associating Assets with Solutions on page 51 Removing Associations from Solutions on page 52 Renaming Process Assets on page 53 Deleting Process Projects on page 76
In the New Process Project window, type the project name. If you want to create the process project in a different workspace from the one Eclipse is currently using: a b Clear the Use default location check box. Click Browse and identify the location where you want to create the new process project.
Click Finish. Note: The new process project is automatically associated with the default solution. You can also create new process projects in the Solutions view. This allows you to specify a solution with which you want the new process project to be associated. See Creating Process Projects in the Solutions View on page 54. Note: You can also create a process project when you create a process. See Creating Processes on page 77.
75
Related Topics Process Projects on page 75 Renaming Process Assets on page 53 Deleting Process Projects on page 76 Processes on page 77 Solutions View on page 47 Creating Process Projects in the Solutions View on page 54 Working with Process Projects in the Solutions View on page 55 Associating Assets with Solutions on page 51 Removing Associations from Solutions on page 52
Related Topics Process Projects on page 75 Creating Process Projects on page 75 Renaming Process Assets on page 53 Solutions View on page 47 Creating Process Projects in the Solutions View on page 54 Working with Process Projects in the Solutions View on page 55 Associating Assets with Solutions on page 51 Removing Associations from Solutions on page 52 Processes on page 77
76
Processes
A process is the top-level asset in a process project. It contains steps and logic, and it is the asset that is ultimately built and executed in the Process Engine, and uploaded to the Process Audit Database for analysis. For more information about designing and implementing processes, see Getting Started with BPM. Related Topics Creating Processes on page 77 Configuring Processes on page 78 Creating Processes in the Solutions View on page 57 Working with Processes in the Solutions View on page 58 Deleting Processes on page 83 Copying Processes on page 84 Saving Process Images on page 84 Documenting Processes on page 85 Importing and Exporting Processes on page 90 Printing Processes on page 83 Process Projects on page 75 Step Transitions on page 197 Process Generation on page 225
Creating Processes
To create a process 1 2 3 In Designer: File > New > Process.
In the New Process window, type the Process Name. Select the Process Project from the list or Click New to create a new process project for your new process.
77
If you create a new process project, Designer displays the New Process Project window. Type a Project name and select the workspace in which to save it. For more about creating process projects, see Creating Process Projects on page 75.
Note: Process names can contain spaces, but if they contain spaces at the end of the name, Eclipse will warn you that the name is invalid. Although Designer does not enforce this restriction, it is a good practice to avoid trailing spaces in process names. 4 Click Finish.
Tip! You can also create new processes in the Solutions view. Related Topics Creating Process Projects on page 75 Configuring Processes on page 78 Deleting Processes on page 83 Copying Processes on page 84 Printing Processes on page 83 Solutions View on page 47 Creating Processes in the Solutions View on page 57 Working with Processes in the Solutions View on page 58
Configuring Processes
You can configure process information on the following pages in the Properties view. Click the process editors canvas to select the open process. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode. When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus.
78
Basic Properties Pages Page Name General Description Process Name: process name Important! Changing a process-wide property, such as renaming a process or a package, results in Designer prompting you to regenerate the process. Process ID: system-generated process identifier. Not editable. The Process ID consists of the process project name, any intermediate folders, and the process name, each separated by a slash ( / ), if all characters are simple ASCII characters. If any non-ASCII characters are used, Designer uses an encoding scheme to render all characters in the Process ID in ASCII. Version: process version. Default is 1. See Process Versions on page 242. Created By: user name of the process author. Not editable. Description: descriptive information about the process, for documentation purposes only. Text in process descriptions is searchable. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Process-level KPIs. See KPIs on page 244.
KPIs
79
Advanced Properties Pages Page Name Run Time Description Generated Package Name: by default, the name of the generated Integration Server package is set to the name of the project. You can edit the package name. Only ASCII characters are allowed. Important! Changing a process-wide property, such as renaming a process or a package, results in Designer prompting you to regenerate the process. Quality of Service: settings that affect process run-time behavior. See Quality of Service Settings on page 108. RosettaNet Synchronous: select this setting to generate a flag in the Process Fragment called "synch" with a value of "true". The Process Engine then passes this value to the RosettaNet Conversation Manager private data structure used to communicate with RosettaNet. Error Error Handler Step: the step that the Process Engine executes when any unanticipated error occurs within the execution of a process instance. Also known as a process-wide error step. If a step with no error transition fails, the process executes the logic defined in the Error Handler Step. If a step with no error transition fails and there is no designated Error Handler Step, the process fails. Cancel Handler Step: the step that the Process Engine executes, along with any downstream transitions, when its status is changed to Cancel by webMethods Monitor or a service invoke. Also known as a process-wide cancel step. Note: Designer supports debugging the Cancel Handler Step. When using the Trace view in the Process Debugging perspective, you can manually force the cancellation of a process. See Trace View on page 63.
Cancel
80
Description Maximum Process Execution Time: static or business calendar value, after which the process instance fails. Also known as a process-wide timeout. Click Static Value and specify a timeout by entering integers in the days, hours, minutes, seconds, and ms (milliseconds) fields. A value of "0" represents no join timeout. Click Business Calendar Value to select a timeout based on a business calendar in My webMethods Server. The following fields must be completed to use a business calendar timeout: Business Calendar
Base Date The initial date and time from which the timeout is calculated. Set automatically to Process Start Time. Choose Business Calendar Select a business calendar from the list.
Important! In order to be available here, the calendar must exist in My webMethods Server, you must have an Integration Server configured with the CentralUsers JDBC pool that points to the My webMethods Server instance where the calendar exists, and you must have defined an Integration Server Name in Designer that points to the configured, and online, Integration Server. You must also have Process Engine installed and running. For more information on configuring the CentralUsers JDBC pool, see Administering webMethods Integration Server. For more information about creating and using business calendars, see Working with BPM Tasks: webMethods Task Engine Users Guide. Execute event as follows
Days After Base Date Select the number of days after the Base Date to set the timeout.
Note: If you are using a negative offset, the Days After Base Date value cannot be zero (0).
81
Page Name
Hour(s) Select the number of hours to offset the Days After Base Date value. A negative value represents hours before the end of the business day.
Minute(s) Select the number of minutes to offset the Days After Base Date value. A negative value represents minutes before the end of the business day.
Timeout Error Handler Step: the step that the Process Engine executes when a process instance exceeds the Maximum Process Execution Time. Note: Designer supports debugging the Timeout Handler Step. When using the Trace view in the Process Debugging perspective, you can manually force a process-wide timeout. See Trace View on page 63. Related Topics Processes on page 77 Creating Processes in the Solutions View on page 57 Working with Processes in the Solutions View on page 58 Documenting Processes on page 85 Copying Processes on page 84 Deleting Processes on page 83 Printing Processes on page 83 KPIs on page 244 Quality of Service Settings on page 108 Process Generation on page 225 Process Simulation on page 257
82
Deleting Processes
To delete a process 1 In Designer, if the Solutions view is not visible, display it: Window > Show View > 2 Right-click a Solutions. Delete.
To delete multiple processes at once, CTRL+click to select, then right-click and select Delete. Related Topics Processes on page 77 Creating Processes on page 77 Configuring Processes on page 78 Printing Processes on page 83 Copying Processes on page 84 Documenting Processes on page 85
Printing Processes
To print a process 1 2 3 Click the process editors canvas to select a process. Click File > Page Setup. In the Page Setup window, configure the following:
In the Orientation section, select Portrait or Landscape. The default is Landscape. In the Scaling section, select Adjust to: and then select a zoom percentage or select Fit to page(s): and select the number of pages across which to print the process. The default is Fit to page(s): 1 across. In the Margin (inches) section, set the Left, Right, Top, and Bottom margins. The defaults for each of these is 0.0.
4 5 6
Click OK to save your settings. If you want to preview your process before printing, select File > Preview. Click File > Print.
83
Creating Processes on page 77 Configuring Processes on page 78 Deleting Processes on page 83 Copying Processes on page 84 Documenting Processes on page 85
An image of the process is also saved when you generate an HTML Documentation Report. Related Topics Processes on page 77 Printing Processes on page 83 Copying Processes on page 84 Documenting Processes on page 85
Copying Processes
You can copy an open process and save it with a new process name. The source process retains its mapping services, while the new target process has no mappings. Important! The Save As... menu option creates a copy of the process. It does not create a copy of all the underlying (and generated) services.
To copy a process and save it with a new name 1 2 Click the process editors canvas to select a process. Click File > Save As....
84
In the Save As window, do the following: a b Enter or select the process project in which to save the process. The process project must exist; you cannot create a new process project in this window. Enter the file name (.process name) of the new process. The field is pre-populated with the file name of the source process.
Related Topics Processes on page 77 Printing Processes on page 83 Saving Process Images on page 84 Documenting Processes on page 85
Documenting Processes
Process documentation enhances the collaborative effort inherent and critical to many process projects. For example, the initial process may be designed by a business analyst, who then passes the project on to a developer. Using process documentation, the business analyst can describe elements of the process design, methodology, and intent to the developer. This information is stored with the process project, and can also be collected into a printable HTML report. Information about KPI definitions, step transition conditions, step inputs and outputs, and process annotations are also captured in the HTML Documentation Report. Text in documentation fields is searchable. Related Topics Adding Documentation Fields on page 86 Assigning Documentation Field Values on page 86 Removing Documentation Fields on page 87 Working with Process Notes and Annotations on page 87 Default Documentation Fields Preferences on page 35 Generating Documentation Reports on page 89 Printing Processes on page 83
85
Click the process editors canvas to select the entire process Select a service step, task step, or swimlane Add Documentation Field.
2 3
On the Documentation page in the Properties view, click Type a name for the new field.
Related Topics Assigning Documentation Field Values on page 86 Removing Documentation Fields on page 87 Documenting Processes on page 85 Default Documentation Fields Preferences on page 35
Click the process editors canvas to select the entire process Select a service step, task step, or swimlane
On the Documentation page in the Properties view, select the field in the Documentation Fields list whose value you want to assign. Documentation fields specific to this component as well as default documentation fields are listed. In the Value for Field: <field name> box, enter or edit the information about the field or process that you want to store. You can click the field label to show or hide the text box underneath it. Note: The description must include only text. Preface a URL with http:// or https:// to create a clickable link in the HTML output; URLs are not clickable in the text box.
86
Related Topics Adding Documentation Fields on page 86 Removing Documentation Fields on page 87 Documenting Processes on page 85 Default Documentation Fields Preferences on page 35 Generating Documentation Reports on page 89 Working with Process Notes and Annotations on page 87
Click the process editors canvas to select the entire process Select a service step, task step, or swimlane Remove Documentation
Related Topics Adding Documentation Fields on page 86 Assigning Documentation Field Values on page 86 Working with Process Notes and Annotations on page 87 Generating Documentation Reports on page 89 Default Documentation Fields Preferences on page 35
87
Important! Annotations cannot be attached to steps that are not located in the same pool as the annotation. A step and its annotations must be located in the same pool in order to be connected. Ensure that each annotation is located inside the same pool as the step it annotates. You can show and hide all notes at any time. You can also move, resize, change the color of, and delete individual notes; and you can set the default note color on the Colors And Fonts page of the Preferences window. See Colors And Fonts Preferences on page 30. To ... Add a new note Edit a note Do this: Click Add Note on the process editors toolbar.
Edit the text directly on the note showing in the process editor, or select the note and edit its Note Text property on the General page of the Properties view. Click Show: Notes on the process editors toolbar. A check indicates notes are showing. Clear the check box to hide notes. Click and drag the edges of the note to make it larger or smaller. Click and drag the note to another location on the canvas. Right-click the note and select Choose Color. Select a new color in the Color window. Select the note and press Delete.
Show or hide all notes Resize a note Move a note Change a notes color Delete a note
You can also move, resize, and delete individual annotations; and you can set the default annotation font style on the Colors And Fonts page of the Preferences window. See Colors And Fonts Preferences on page 30. To ... Add a new annotation Edit an annotation Do this: Click Add Annotation on the process editors toolbar.
Edit the text directly on the annotation showing in the process editor, or select the annotation and edit its Note Text property on the General page of the Properties view. Edit the Font Name, Font Size, Bold, Italic, and Font Color on the General page of the Properties view.
Click and drag an anchor point to a step to connect the two with a dotted line. Click and drag the note to another location on the canvas. Right-click the annotation and select Delete.
88
Related Topics Adding Documentation Fields on page 86 Assigning Documentation Field Values on page 86 Removing Documentation Fields on page 87 Generating Documentation Reports on page 89 Default Documentation Fields Preferences on page 35 Process Development Editor and Tools on page 16
89
Description You can format your HTML Documentation Report using a CSS. Click the button preceding Default Style, Classic Style, or Custom CSS. If you choose to use a Custom CSS, your style sheet must be located in the same folder as the Save to Location. Specify the file name in the text box.
Save to Location
Documentation Report files are saved by default to the root of the workspace parent directory with the name of the process project (c:\Documents and Settings\<user name>\<process name>.html), but you can specify a name and location of your choice. Click Browse to navigate to and select the directory in which you want to save the report.
Note: Standard Windows file naming limitations apply. If you enter a file name that is not allowed, Designer prompts you to enter a different name. 3 Once the report has finished generating, Designer opens it automatically using Eclipses default browser. The default browser setting is at Window > Preferences > General > Web Browser.
Related Topics Adding Documentation Fields on page 86 Assigning Documentation Field Values on page 86 Removing Documentation Fields on page 87 Working with Process Notes and Annotations on page 87 Default Documentation Fields Preferences on page 35
90
Designer can format imported XPDL processes to match the tools used to create them, and can create process simulations directly from imported XPDL files that contain simulation information. XPDL 2.1 is supported, and is backward-compatible with XPDL 2.0 and 1.0. Note: The Designer Process Simulation feature must be installed in order to create a process simulation. Related Topics Importing Designer Processes on page 91 Exporting Designer Processes on page 92 Importing Modeler Processes on page 93 Importing BPEL Processes on page 97 Exporting BPEL Processes on page 98 Importing XPDL Processes on page 99
Click Next. Designer displays the Process File Import Wizard. Click Browse to select a .process file to import. Select the Process Project from the list OR Click New to create a new process project for your new process.
If you create a new process project, Designer displays the New Process Project window. Type a Project name and select the workspace in which to save it. For more about creating process projects, see Creating Process Projects on page 75.
Click Finish.
To import a Designer process that contains one or more referenced processes If a process contains one or more referenced processes, you can import them together in either of two ways:
91
Import each process separately, using File > Import > Software AG > described above.
Process File as
Import the entire process project that contains both the parent process and the referenced child process or processes, using Import > General > Existing Projects into Workspace. Related Topics Importing and Exporting Processes on page 90 Exporting Designer Processes on page 92 Importing Modeler Processes on page 93 Importing BPEL Processes on page 97 Exporting BPEL Processes on page 98
Process File.
If you want to select multiple processes in a process project, select the check box corresponding to the process project on the left to select the entire process project on the right. Click the .project file to clear the check box; only .process files can be exported. If you want to select one or more process files manually, without selecting the entire process project on the left, select the name of the process project and then select the boxes corresponding to the process files you want on the right. If you want to remove a check mark, select the box again to clear it.
4 5 6
When you have selected the files for export, click Browse to select the directory in your file system where you want to place the exported files. If you want Designer to Overwrite existing files without warning, select the check box in the Options section. The option is not enabled by default. Click Finish.
Note: If you select anything besides process files for export, when you click Finish, Designer will prompt you to remove the non-process files before you can complete the export.
92
Related Topics Importing and Exporting Processes on page 90 Importing Designer Processes on page 91 Importing Modeler Processes on page 93 Importing BPEL Processes on page 97 Exporting BPEL Processes on page 98
Connect to Design Server (default) Offline In Connect to Design Server mode, enter the Server, User, and Password. In Offline mode, enter the User, and then Browse to select the Modeler 6.x Installation Directory to access the repository file where the offline model is stored.
Note: The repository file in Modeler exists only if Offline mode has been used at least once. 4 5 6 Click Next. In the Select Process Models to be imported window, select the process or processes to import. Click Finish to perform the import. Designer displays the number of selected processes, upgraded processes, and errors. A summary of the import process is saved in the ModelUpgradeLog.txt file, which is located in your workspace at
<workspace_name>\.metadata\plugins\com.process.webmethods.upgrade.impl\logs
93
Important! After you import a Modeler 6.x process, check to make sure all referenced documents and services exist on the specified Integration Server for each step. Note: When you import Modeler 6.x steps with external subscription documents, Designer creates two steps: a receive step and an activity step; the receive step is configured to use the subscription document. In Modeler 6.x, you could define a complex join condition based on the arrival of the subscription document, like Receive-OrderDoc OR Transition-from-Step2. Designer adds extra flow steps after the receive steps in order to keep the complex join condition intact. Related Topics Importing and Exporting Processes on page 90 Importing Designer Processes on page 91 Exporting Designer Processes on page 92 Importing BPEL Processes on page 97 Exporting BPEL Processes on page 98 Modeler to Designer Conversions on page 94 Modeler to Designer Conversions Some conversions are made to make Modeler processes work in Designer. The following is a reference of those conversions. Process Conversions Modeler 6.x Flow step Flow step + document subscription Workflow step Any step + inputs/outputs Internal group External group Note Task External step Web Service step Subprocess (inline) Designer Activity step + Integration Server service type Receive step with subscription receive protocol + receive document Activity step + Task type Activity step + inputs/outputs External pool External pool Note (annotation) Note (annotation) n/a Activity step + Web service type All steps moved into main process
94
Modeler 6.x Referenced process step Empty step Terminate step Any step + transition Any step + document subscription Any step + join Logical server Global data Data properties Web Service interaction To Do list Process documentation Step documentation Join Join type: OR Join type: XOR Join type: AND Join type: Complex Join type: XPATH Transition condition Transition condition: XPATH Transition condition: Retries exceeded Transition condition: Error Transition condition: Timeout Transition condition: Else Transition condition: If > Then
Designer Activity step + Referenced Process type Activity step + Empty type Terminate step Activity step + transition Receive step with subscription receive protocol + receive document Activity step + join Integration Server Name n/a n/a n/a n/a Process properties Step properties Join Join type: OR Join type: XOR Join type: AND Join type: Complex n/a Transition condition n/a Transition condition: Step iterations exceeded Transition condition: Error Transition condition: Timeout Transition condition: Else Transition condition: If condition
Note: The Modeler Process Key is retained when importing a Modeler 6.x process into Designer. The Process Key is used when you Upload for Analysis Only, and allows the imported Modeler process to work in My webMethods Server. See Process Versions on page 242 for more information about uploading a process for analysis. Step Conversions
95
Modeler 6.x Flow step properties Description Logged fields Step duration Join duration Maximum iterations Correlation service Service invoke Documentation Step label Enable resubmission Workflow step properties Description Logged fields Logical server Documentation Project Implementation module Step duration Join duration Maximum iterations Correlation service Service invoke Logical server Step label Enable resubmission Web Service step properties Description Step label Logged fields
Designer Activity step + Integration Server service type properties n/a Logged fields n/a Join timeout n/a Correlation service Service invoke Documentation Label n/a Activity step + Task type properties n/a Logged fields Integration Server Name Documentation n/a n/a n/a n/a Join timeout Maximum iterations Correlation service Service invoke Integration Server Name Label n/a Activity step + Web service type properties n/a Label Logged fields
96
Modeler 6.x Logical server Documentation Invoke Receive Reply Web Service Port type Operation Input Output Enable resubmission Empty step properties Description Logical server Step label Documentation Terminate step properties Description Step label Logical server Documentation Related Topics
Designer Integration Server Name Documentation Activity step + Web service type Receive step Reply step Activity step + Web service type Port type Operation Inputs/outputs Inputs/outputs n/as Activity step + Empty type properties n/a Integration Server Name Label Documentation Terminate step properties n/a Label Integration Server Name Documentation
97
a b
Browse to select a .bpel file to import. Enter or select the parent folder (process project) where you want to save the imported process. The process project must already be defined when you import the process. Enter the New File Name (process name) for the process you are importing. The process name cannot have any of the following characters: *|:"<>.?
Note: Process names can contain spaces, but if they contain spaces at the end of the name, Eclipse will warn you that the name is invalid. Although Designer does not enforce this restriction, it is a good practice to avoid trailing spaces in process names. 4 Click Finish.
Related Topics Importing and Exporting Processes on page 90 Importing Designer Processes on page 91 Exporting Designer Processes on page 92 Importing Modeler Processes on page 93 Exporting BPEL Processes on page 98
BPEL File.
If you want to select multiple processes in a process project, select the check box corresponding to the process project on the left to select the entire process project on the right. Select the .project file to clear the check box; only .process files can be exported as BPEL. If you want to select one or more process files manually, without selecting the entire process project on the left, select the name of the process project and then select the boxes corresponding to the process files you want on the right. If you want to remove a check mark, select the box again to clear it.
When you have selected the files for export, click Browse to select the directory in your file system where you want to place the exported files.
98
5 6
If you want Designer to Overwrite existing files without warning, select the check box in the Options section. The option is not enabled by default. Click Finish. Note: If you select anything besides process files for export, when you click Finish, Designer will prompt you to remove the non-process files before you can complete the export.
Related Topics Importing and Exporting Processes on page 90 Importing Designer Processes on page 91 Exporting Designer Processes on page 92 Importing Modeler Processes on page 93 Importing BPEL Processes on page 97
Processes
99
Informational messages
XPDL data objects to which generated Integration Server documents correspond Process simulation resources created and their corresponding scenarios/steps
Import errors To import an XPDL process 1 2 3 In Designer: File > Import > Software AG > In the Import window, click Next. In the XPDL Import Wizard window, do the following: a b Click the Browse button to navigate to the XPDL file you want to import. In the Open window, click Open to select the file and populate the Select file field. From the Select process project list, select an existing process project into which to import the XPDL file. If you want to create a new process project for the XPDL file, click New Project to open the New Process Project window. For instructions on creating a new process project, see Creating Process Projects on page 75. c Optionally, edit the name of the process resulting from the XPDL import in the Process name field. XPDL File.
Note: Importing XPDL files containing multiple WorkflowProcess elements results in multiple Designer processes (.process files). Importing XPDL files containing multiple WorkflowProcess elements that contain activities with SimulationInformation results in multiple Designer simulations (.simulation files). Multiple imported processes or simulations are automatically named based on identifying information (Name or ID) of the WorkflowProcess elements in the XPDL. d From the Select an Integration Server list, select an Integration Server that will serve as the server for the steps in the imported process, and where the imported XPDL that refers to data will be located. If you need to configure Integration Servers, click the Configure Integration Servers link to open the Integration Servers preferences page. See Integration Servers Preferences in webMethods Designer Service Development Help.
Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. e Click Next.
100
If the XPDL you are importing contains inputs/outputs, Designer displays the Inputs and Outputs window. Do the following: a To create Integration Server documents, select the Create Integration Server Documents check box in the Inputs / Outputs section. This enables you to create Integration Server documents for the DataObjects selected in the table. If the XPDL does not contain any data to be mapped to Integration Server documents, the Inputs / Outputs section is not enabled. The table displays the following information: DataObject A DataObject is an XPDL element that contains one or more DataField elements. A DataObject can contain internally defined DataFields, such as Strings and Numbers, or DataFields that refer to Complex XML Data Types defined in schema definitions (XSDs). Name of the externally referenced data as used in the XPDL file being imported. A DataField is a child of a DataObject. The URL of the XSD (schema definition) where the Complex XML Data Type (data definition) resides Select the check box to create the Integration Server document for the DataObject in the same row. You can also use the Select All and Clear All buttons to select or clear all the check boxes in the table at once. b c Click Finish. If you selected DataObjects from which to create Integration Server documents, you must specify their creation location (or locations). The Create a New Document Type window is pre-populated with Server, URL, and Element name values. You can edit the Element name in the text box. Server The Integration Server selected on the Inputs / Outputs page of the wizard. If no selection is made, Default is displayed to represent the default Integration Server. The address of the selected Server The Integration Server package containing the folder where you create the new Integration Server document
DataField
URL Package
101
The folder where you create the new Integration Server document The default Element name is based on the corresponding DataObject on the Inputs / Outputs page of the wizard. You can edit this name.
Expand the Integration Server tree to select the target folder for the new Integration Server document and populate the Package and Folder fields.
Tip! A valid package containing a valid folder must exist in order that you may select them. You cannot create a new package or folder in the Create a New Document Type window. e Click Finish to create the new Integration Server document.
Note: If you click Next in the Create a New Document Type window, you can select a source for your Integration Server document in the Select a Source window. These options are pre-selected based on the data type being imported. Internally defined data types select None, which is the default option. Externally referenced data types select XML Schema and also display the External Document URL. If you click Finish, you bypass the viewing of these pre-selected options. f If you are creating multiple Integration Server documents, populate the Package and Folder fields, and optionally edit the Element name in the Create a New Document Type window for each one. Then click Finish.
If the XPDL being imported has been edited using multiple tools, you must choose the tool whose layout you want to import. In the Select Tool ID section of the XPDL Layout window, click the Select layout list to see the available options and select the one you want. These options are dependent upon the information in the XPDL file. If the XPDL being imported contains simulation information, and you have the Designer Process Simulation feature installed, you can create one or more process simulations (.simulation files) from the import as well. a b If the import wizard finds simulation information, it displays the Create Simulation window with the option to Create simulation already selected. If the import wizard finds information for a single simulation, the Simulation Name field is populated with the same name entered for the Process name in the XPDL Import Wizard window. You can edit the process simulation name without affecting the process name. If the import wizard finds information for multiple simulations, the resulting .simulation files are automatically named based on identifying information (Name or ID) of the WorkflowProcess elements in the XPDL.
If you do not wish to create any process simulations, clear the Create simulation check box.
102
7 8
Click Finish to start the import. The Progress Information window displays the import progress. When the import is complete, click Save to save the import report to a file (*.txt). This action opens the Save As window, where you can specify a file name and location for the report. Click Close to close the Progress Information window. Designer automatically opens all processes (.process files) created from the imported XPDL. Simulations (.simulation files) do not open automatically. You can open them in the Solutions view.
Related Topics XPDL to Designer Conversions on page 103 Importing and Exporting Processes on page 90 Solutions View on page 47 Process Simulation on page 257 XPDL to Designer Conversions Some conversions are made to imported XPDL to make its processes work in Designer. The following is a reference of those conversions and how imported XPDL elements, properties, and values are mapped to their resulting Designer processes. Tip! For more information about XPDL, see the specification at http://www.wfmc.org/standards/docs/TC-1025_xpdl_2_2005-10-03.pdf. Process Conversions XPDL Element Name WorkflowProcess NodeGraphicsInfo Designer Process Model Part Process file Process step attributes (color, location, etc.) The information is dependent on the tool used to create the XPDL file. ConnectorGraphicsInfo Transition connectors This can include the bendpoints in the lines, if the information is present. Activity Pool Process step Pool If the imported process has a single pool, it is imported as internal. All additional pools are imported as external.
103
Designer Process Model Part Swimlane Annotation node, connected to a flow object if it has an association defined Subprocess (inline) Not handled Split/Join gateway, as appropriate XOR splits are not handled.
StartEvent
Receive step that triggers a process If a StartEvent does not map to a receive step, this is recorded in the log file and the Allow this step to start new process instance box is checked.
IntermediateEvent
Receive step that does not trigger a process (the Allow this step to start new process instance box is not checked) Several EndEvent types may be specified: Terminate: Terminate step Message: Publish step Message with Implementation tag: Reply step All others: Empty step
EndEvent
Step type (in the steps Properties view) Various types listed below Task step Receive step For example, a TaskReceive could be a SimpleService if its Implementation attribute is WebService.
TaskReference TaskSend
A copy of the task being referenced Web Service step or IS Service step, depending on TaskSend attributes
104
Designer Process Model Part Web Service step The wizard prompts you to decide whether to import the definition (generate the code to reference current Web services from Integration Server). If you do not import them, the wizard prompts you to specify their location. IS Service step
IS Service step If the Implementation attribute is WebService: WebService step If the Implementation attribute is Other or unspecified AND Performers are defined: Task step
TaskApplication SubFlow
IS Service step Referenced process If the parent and the child are in the same XPDL file, the parent is set to reference the child that is imported with it. If the reference is to a pool, a separate process (.process file) is created for the pool (child).
Reference Deadline
A copy of the activity being referenced If the activity has a Deadline attribute, its Exception name becomes the timeout transition, and the timeout transitions description is set to the deadline. Note: Due to syntax differences in the XPDL generated by various tools, timeout values specified are not retained on import, and must be set manually.
105
Designer Process Model Part Attribute of an XPDL Activity which maps to a resource assigned to a process step in a Designer process simulation (.simulation file) Properties and values in the XPDL correspond to resource information in the process. In the resulting Designer process simulation, SimulationInformation maps to a simulation resource for a process step with the naming convention <activity name>_Activity Resource. Simulation step scenarios are created for Designer activity steps (empty, IS service, task, rule, Web service, or referenced process steps). SimulationInformation is mapped for these step types only. SimulationInformation properties include: Cost: assigned to the Fixed Cost of the resource TimeEstimation: the Duration value is assigned to a Designer simulation scenario, which has a Process Time property. Other TimeEstimation values are ignored, as they do not correspond to existing simulation properties. These include WaitingTime and WorkingTime.
TransitionRef
Transitions as indicated (join or split) Transition types are imported, and the condition text is in the description. The transition text imported is the description of the TransitionRefs.
Integration Server documents Simple types do not require generation on Integration Server. Complex types (XSD) create Integration Server documents. Multiple references to the same document point to the same Integration Server.
106
Designer Process Model Part Message transitions between steps in different pools Not handled Task step attribute that can be one of two types, Human or Role Note: Roles must be generated.
DataField Application
Integration Server document if referred to by InputSets or OutputSets Integration Server service, unless it is a rule (rule service), a Web service (Web service step), or a form (task) Task step Rule step
Form BusinessRule Imported joins are mapped as follows: Imported Join Type AND OR XOR XOREVENT Inclusive Exclusive Parallel COMPLEX none Related Topics
107
108
Description Store process tracking information in memory only. For complete information about working with this field, see Administering webMethods Process Engine.
Sets the minimum logging threshold for this process at run time. At generation time, the Minimum Logging Level is set in My webMethods Server. On subsequent generations, if the Minimum Logging Level has been raised in Designer, the level in My webMethods Server is also raised. If the Minimum Logging Level in Designer has been lowered on subsequent generations, the level in My webMethods Server is not lowered, since it is still above the minimum. You must explicitly lower the logging level in My webMethods Server. Important! My webMethods Server users cannot reduce the logging level of the process below the value specified here at design time. If you will be feeding process data to webMethods Optimize, or using it for running historical data fit distributions in Process Simulation, you must set the Minimum Logging Level to 5-Process and all steps (default). For more information on process logging, including detailed descriptions of logging levels, see Monitoring BPM, Services, and Documents with BAM: webMethods Monitor Users Guide. 1-None 2-Errors only 3-Process and errors only 4-Process and start steps 5-Process and all steps (default)
Related Topics Processes on page 77 Correlation Services on page 217 Building and Uploading Processes on page 220
109
Pools
Pools are constructs that help organize your process project. You can create pools that represent different organizations, or different parts of a single organization, such as departments. A Designer process can have one internal pool and unlimited external pools. The process editors is, by default, an internal pool. If you choose to create a new internal pool, the canvas pool becomes an external pool. Only steps in internal pools are generated and executed. Each pool, whether internal or external, can have unlimited swimlanes, which further subdivide the organizational structure you employ. You can choose to create horizontal or vertical pools, and you can change the orientation of an existing pool. You can set the default pool orientation in Window > Preferences > Software AG > Process Development > Appearance, and the default pool label color in Window > Preferences > Software AG > Process Development > Appearance > Colors And Fonts. You can right-click a pool and then select Choose Pool Label Color to change its pool label color. Transitions between steps in different pools indicate message flows, rather than control flows. Message flows are shown with dotted lines, whereas control flows are shown with solid lines. Message flow lines indicate that the process needs to send or receive information from outside the pool. Control flow lines (transitions between steps in the same pool) indicate the flow of control throughout the process. Related Topics Adding Pools on page 111 Configuring Pools on page 111 Renaming Pools on page 112 Resizing Pools on page 113 Removing Pools on page 113 Swimlanes on page 114 Appearance Preferences on page 28 Colors And Fonts Preferences on page 30 Process Development Editor and Tools on page 16
110
Adding Pools
To add a pool to the process editors canvas 1 2 Click Add Pool and then click the process editors canvas to place it.
Select the pool type from the Set Pool Type window. The default pool type is External Organization.
Related Topics Pools on page 110 Configuring Pools on page 111 Renaming Pools on page 112 Resizing Pools on page 113 Removing Pools on page 113 Swimlanes on page 114
Configuring Pools
You can configure a pools label, description, orientation, and type in the Properties view. You can set the default pool orientation in Window > Preferences > Software AG > Process Development > Appearance, and the default pool label color in Window > Preferences > Software AG > Process Development > Appearance > Colors And Fonts. You can right-click a pool and then click Choose Pool Label Color to change its pool label color. To configure the properties of a pool 1 2 Select the title bar area of the pool. On the General page in the Properties view, enter or edit descriptive information about the pool: Property Name External Label Description Orientation Description Select the check box to designate the pool as external. A process can have one internal pool and unlimited external pools. Name of the pool. Default is Pool1. Description of the pool, for documentation purposes. Text in pool descriptions is searchable. Select Horizontal or Vertical from the list. The default is set in Window > Preferences > Software AG > Process Development > Appearance.
111
Note: A process project can have only one internal pool. If you change the type of a pool from External to Internal, the default internal pool (the process editors canvas) will become an external pool. Only steps in internal pools are generated and executed. Related Topics Pools on page 110 Adding Pools on page 111 Renaming Pools on page 112 Resizing Pools on page 113 Removing Pools on page 113 Swimlanes on page 114 Appearance Preferences on page 28 Colors And Fonts Preferences on page 30
Renaming Pools
You can rename pools using their shortcut menus or by selecting the pool name and editing it. To rename a pool 1 2 OR 1 2 Right-click the pool to open its context menu. Select Rename <current pool name>. Select the pool name. Edit the highlighted text.
Related Topics Pools on page 110 Adding Pools on page 111 Configuring Pools on page 111 Resizing Pools on page 113 Removing Pools on page 113 Swimlanes on page 114
112
Resizing Pools
You can resize pools from their bottom and right edges and bottom right corners. Pools must always be at least as large as their contents, including the swimlanes. If you resize a swimlane to be smaller, by dragging its bottom edge upward, the swimlanes below it will resize only as much as their contents are accommodated by their swimlanes. To resize a pool 1 2 Select the title bar area of the pool. Click and drag one of the resize handles of the pool to resize it.
Note: If there are process steps in the pool, Designer will not allow you to resize the pool to a size at which the steps are not visible. Related Topics Pools on page 110 Adding Pools on page 111 Configuring Pools on page 111 Renaming Pools on page 112 Removing Pools on page 113 Swimlanes on page 114 Resizing Swimlanes on page 118
Removing Pools
To remove a pool from the process editor 1 2 3 Select the title bar area of the pool. Press Delete. If there were steps in the pool, click OK in the Warning window that advises you that all steps in the pool are removed when the pool is removed, and that you can use Undo (CTRL+Z) to retrieve the pool and its steps.
Related Topics Pools on page 110 Adding Pools on page 111 Configuring Pools on page 111 Renaming Pools on page 112
113
Swimlanes
Swimlanes are subdivisions of pools. Where a pool typically represents a single process, swimlanes typically serve to further subdivide a process, such as by department. Each swimlane designates an actor, which becomes a property inherited by all steps in the swimlane. A pool can have unlimited swimlanes, which you can organize by color. A pool initially contains one swimlane, and the Actor property shares the name of the pool (by default, Pool). Additional swimlanes use the Swimlane actor by default. You can edit the actors of all swimlanes in a pool. You can right-click a pool to move swimlanes up and down in a horizontal pool, or left and right in a vertical pool. Steps within the swimlane move with it. You can set the default swimlane and swimlane label colors in Window > Preferences > Software AG > Process Development > Appearance > Colors And Fonts. You can right-click a swimlane and then click Choose Swimlane Color to change the swimlane color. You can also right-click a swimlane and then click Choose Swimlane Label Color to change the swimlane label color. Related Topics Adding Swimlanes on page 115 Configuring Swimlanes on page 115 Moving Swimlanes on page 116 Resizing Swimlanes on page 118 Changing Swimlane Colors on page 118 Removing Swimlanes on page 119 Adding Steps to Swimlanes on page 120 Steps on page 121 Pools on page 110
114
Adding Swimlanes
To add a swimlane to a pool, do the following: To add a swimlane to a pool 1 2 3 Right-click the pool. The location where you click will be relative to the placement of the new swimlane. In a horizontal pool, select either Add Swimlane Above or Add Swimlane Below from the context menu. In a vertical pool, select either Add Swimlane Left or Add Swimlane Right from the context menu.
Related Topics Swimlanes on page 114 Configuring Swimlanes on page 115 Moving Swimlanes on page 116 Resizing Swimlanes on page 118 Changing Swimlane Colors on page 118 Removing Swimlanes on page 119 Adding Steps to Swimlanes on page 120
Configuring Swimlanes
In the Properties view, you can configure the actor and description for a swimlane. You can also configure the fields to include in your HTML Documentation Report. To configure the properties of a swimlane 1 2 Select the swimlane. On the General page in the Properties view, edit the following:
Actor: by default, the Actor is Swimlane1. Description: description of the swimlane, for documentation purposes. Text in swimlane descriptions is searchable.
On the Documentation page in the Properties view, enter or edit Documentation Fields and values you want to include in your HTML Documentation Report. Documentation fields are searchable.
115
Related Topics Swimlanes on page 114 Adding Swimlanes on page 115 Moving Swimlanes on page 116 Renaming Swimlanes on page 117 Resizing Swimlanes on page 118 Changing Swimlane Colors on page 118 Removing Swimlanes on page 119 Adding Steps to Swimlanes on page 120 Documenting Processes on page 85
Moving Swimlanes
You can move swimlanes in a pool, and their steps move with them. You can use the context menu or simply drag and drop swimlanes within a pool. To move a swimlane 1 2 Select a swimlane. In a horizontal pool, right-click the swimlane and select Move Swimlane Down or Move Swimlane Up from the context menu. Uppermost swimlane can only move down, and bottommost swimlane can only move up. or Drag and drop a swimlane to another spot within the same pool. 3 In a vertical pool, right-click the swimlane and select Move Swimlane Left or Move Swimlane Right from the context menu. Leftmost swimlanes can only move right, and rightmost swimlanes can only move left. or Drag and drop a swimlane to another spot within the same pool. Related Topics Swimlanes on page 114 Adding Swimlanes on page 115 Configuring Swimlanes on page 115 Renaming Swimlanes on page 117
116
Resizing Swimlanes on page 118 Changing Swimlane Colors on page 118 Removing Swimlanes on page 119 Adding Steps to Swimlanes on page 120 Documenting Processes on page 85
Renaming Swimlanes
You can rename a swimlanes using its shortcut menu, by selecting the swimlane name and editing it, or by editing the Actor field on the General page of the Properties view. To rename a swimlane 1 2 OR 1 2 OR 1 2 Select the swimlane. On the General page of the Properties view, edit the Actor field. Right-click the swimlane to open its context menu. Select Rename <current swimlane name>. Select the swimlane name. Edit the highlighted text.
Related Topics Swimlanes on page 114 Adding Swimlanes on page 115 Configuring Swimlanes on page 115 Moving Swimlanes on page 116 Resizing Swimlanes on page 118 Changing Swimlane Colors on page 118 Removing Swimlanes on page 119 Adding Steps to Swimlanes on page 120 Documenting Processes on page 85
117
Resizing Swimlanes
You can resize swimlanes from their bottom edges, with the exception of the bottommost swimlane in a pool, which cannot be resized. Swimlanes must always be at least as large as their contents. To resize a swimlane 1 2 Select the swimlane. Click and drag one of the resize handles of the swimlane to resize it.
Related Topics Swimlanes on page 114 Adding Swimlanes on page 115 Configuring Swimlanes on page 115 Moving Swimlanes on page 116 Renaming Swimlanes on page 117 Changing Swimlane Colors on page 118 Removing Swimlanes on page 119 Adding Steps to Swimlanes on page 120 Documenting Processes on page 85
118
To change the color of a swimlane label 1 2 3 4 Right-click the swimlane. Click Choose Swimlane Label Color. In the Color window, select the color you want the swimlane label to have. Click OK.
Related Topics Swimlanes on page 114 Adding Swimlanes on page 115 Configuring Swimlanes on page 115 Moving Swimlanes on page 116 Renaming Swimlanes on page 117 Resizing Swimlanes on page 118 Removing Swimlanes on page 119 Adding Steps to Swimlanes on page 120 Documenting Processes on page 85
Removing Swimlanes
To remove a swimlane from a pool 1 2 Select the swimlane. Press Delete.
Note: Removing a swimlane does not remove the steps in that swimlane. Steps will remain in the pool, and become part of the swimlane below (or, in a vertical pool, to the left of) the one removed. If the removed swimlane is the rightmost or bottom swimlane in a pool, steps become part of the neighboring swimlane. Related Topics Swimlanes on page 114 Adding Swimlanes on page 115 Configuring Swimlanes on page 115 Moving Swimlanes on page 116 Renaming Swimlanes on page 117
119
Resizing Swimlanes on page 118 Changing Swimlane Colors on page 118 Adding Steps to Swimlanes on page 120 Documenting Processes on page 85 Pools on page 110
To add a step to a swimlane 1 Click the button on the process editor toolbar for the step type you want to add. Button Description Activity Step Subprocess Receive Step Reply Step Publish Step Terminate Step Gateway Step 2 Click the spot in the swimlane where you want to place the step.
120
You can also add a step by dragging a document or service from the Package Navigator, or by dragging an existing process or task from the Solutions view, and dropping it into a swimlane. Finally, you can copy one or more steps and paste them into a swimlane. Note: Relative positions of multiple steps is preserved when you paste. If the target process editors canvas has an asset selected, steps and/or notes are pasted relative to the selected asset. If there is nothing selected on the target canvas, steps and/or notes are pasted relative to the top left of the canvas. If you paste a step or a note very close to the edge of a pool, swimlane, or expanded subprocess, the container expands to accommodate the pasted item. Related Topics Swimlanes on page 114 Adding Swimlanes on page 115 Configuring Swimlanes on page 115 Moving Swimlanes on page 116 Renaming Swimlanes on page 117 Resizing Swimlanes on page 118 Changing Swimlane Colors on page 118 Removing Swimlanes on page 119 Adding Steps to Swimlanes on page 120 Steps on page 121 Package Navigator View on page 61 Solutions View on page 47
Steps
You create steps onto the process editors canvas and connect them to create a process. Steps are categorized by what they do, specified in their properties, and also by their function in the process. The outlines of receive and publish step icons represent the types of message events each step carries in a process. Start (receive) steps are designated by thin outlines, intermediate receive and publish steps are designated by hollow outlines, and end (terminate) steps are designated by thick outlines. Steps are named by default using the step type and the numeral 1, such as Activity1. Additional steps increment the numeral value, such as Activity2, Activity3, and so on.
121
Note: If you delete a step with a default name, that name is not reused in the process model. For example, if you add steps named Activity1 and Activity2 and then delete Activity2, the next step is named Activity3. The following types of steps are available: Activity Steps An activity step can invoke something, such as an Integration Server service, a rule, a Web service, a task, or a referenced process; or it can be empty, and not invoke anything. Empty steps are useful as visual indicators of transitions and joins. Note: Generated Web service connectors reference Web service descriptors on Integration Server. For more information on Web service descriptors, see the webMethods Web Services Developers Guide. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode. When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. You can configure activity steps to be one of the following step types: Empty IS Service Task Rule Web Service Referenced Process Receive Steps A receive step receives a Integration Server subscription document, a Trading Networks document, or a SOAP message to trigger a Web service; and can only have outgoing transitions. A receive step must be configured to receive one and only one document or message, whether the step is configured to start a new process instance or not. Receive
122
steps can not only start new process instances, but they can also be used to receive intermediate documents and connect to running process instances. Not every receive step can start a process, but every process must have at least one receive step that can. When a receive step is configured to start a new process instance, the arrival of its document or message is the trigger that tells the Process Engine to begin running the process. Receive steps can be configured to be synchronous. This allows you to associate a receive step with a reply type, using the reply steps Reply To property. The receive step publishes the input to the service and waits for the reply document. Invoking the receive step kicks off this receive-reply process and sends you the results synchronously; you dont have to publish any events yourself. You can also use the JMS protocol to use JMS to trigger a process. If you use the JMS protocol for one receive step in a process, you must also use it in any other receive steps in that process. To use the JMS protocol, a JMS connection alias named PE_NONTRANSACTIONAL_ALIAS must be defined in the Integration Server JMS Settings for use by the Process Engine. When you select the JMS protocol, Designer automatically uses this connection alias to communicate, and automatically generates the Destination using a String of the form <projectname>_<processname>_SUBQUEUE. In Developer and in the Designer flow service editor, the auto-generated Destination can be seen in the subscription trigger of the generated process. When you publish a document using JMS to trigger the process, you must specify this auto-generated Destination. For information on defining a JMS connection alias, see Administering webMethods Integration Server. For information on the JMS connection alias in the Process Engine, see Administering webMethods Process Engine. Note: When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. If you want to turn off the service generation and execution of services associated with a receive step, you can disable the option by clearing the Generate Service check box on the Implementation page in the Properties view. By default, the option is enabled for new processes created in Designer, and disabled for processes imported from Modeler 6.x. Reply Steps A reply step is used to send a reply to a receive step with Simple service protocol, using a synchronously executed Integration Server (IS) flow service. Flow services can either be invoked as flow services or as Web services. When a synchronous flow is generated, the service can be invoked as a Web service, like any other Integration Server (IS) service. Reply steps only reply to receive steps using the Simple service protocol. A reply step is unrelated to a receive step that uses the JMS receive protocol.
123
Adapter Notification (AN) Steps An adapter notification (AN) step refers to a request from a third-party back-end system that is processed by the Adapter Run Time (ART) directly. For example, an SAP adapter notification receives requests from an SAP back-end system. An adapter notification can be synchronous or asynchronous. The Publish and the Send adapter notification types are asynchronous, meaning that it involves a document that is published to the Broker. The Publish and Wait adapter notification type is synchronous, meaning that it involves a Request AND a Reply document that conform to the assigned assigned service to invoke. The Receive Protocol and Receive Document fields and the Reply Step and Reply To fields on the Implementation page of the Properties view are automatically populated in adapter notification steps, and are not editable. Synchronous Publish and Wait adapter notifications use the Simple Service (For Synchronous Reply) receive protocol. Asynchronous Publish adapter notifications use the Subscription (For Broker Documents) receive protocol. Asynchronous Send adapter notifications use the JMS (For JMS Triggered Processes) receive protocol. Adapter notification steps can be created only using the data from the back-end system with which it is associated, such as SAP. You cannot create an adapter notification step using the process editor toolbar; you must drag and drop the adapter notification document you want to use in the step from the Package Navigator view. In some cases, Designer automatically creates the step for you; in some cases, you must create the steps first and then drag and drop the adapter notification document you want to use in them. If you drag an asynchronous Publish or asynchronous Send adapter notification document type from the Package Navigator onto the process editor, Designer automatically creates a receive step in the process. You cannot drag a synchronous Publish and Wait adapter notification document type from the Package Navigator directly onto the process editor. To create a synchronous request, create a receive step and then drag and drop the synchronous publish and wait request document onto the step. Similarly, to create a synchronous reply, create a reply step and then drag and drop the synchronous publish and wait reply document onto the step. A synchronous publish and wait adapter notification requires both the request and the reply. An adapter notification step cannot be the last step in a business process because it always implies subsequent processing of a received document or reply step. For more information on SAP adapters, see the webMethods SAP Adapter Users Guide. Publish Steps A publish step publishes a document to an Integration Server, where it can be subscribed to by other processes. Terminate Steps A terminate step signifies the end of a process. A process may end prior to reaching the terminate step, based on other logic in the process, but if that is not the case, the process ends when it reaches the terminate step.
124
You can use a Terminate step after catching an error. This stops the process immediately; Designer does not wait for any other process paths to complete. You can configure the status you want to Terminate step to give to the process: Canceled, Completed, and Failed. The default is Canceled, which webMethods Monitor shows as stopped. Completed shows as completed, and Failed shows as failed. If you catch the error without a Terminate step, the rest of the process continues if there are other active paths. If there are no other active paths, the process is marked as Completed. If you have no Error Handler Step and no Terminate step in your process and Designer encounters an error, the process fails. If you use a Terminate step as your Error Handler Step, the process is marked Failed when Designer encounters an error. Gateway Steps Gateway steps facilitate explicitly modeling transitions in processes. They do not have generated flow services. Like empty steps, gateway steps are useful as visual indicators of transitions and joins. Related Topics Adding Steps to Processes on page 126 Changing Step Images on page 127 Changing Step Types on page 128 Configuring Steps on page 129 Adding Steps to Subprocesses on page 182 Adding Steps to Swimlanes on page 120 Building and Uploading Processes on page 220 Moving and Aligning Steps on page 20 Process Simulation on page 257
125
You can also add a step by dragging a document or service from the Package Navigator, or by dragging an existing process or task from the Solutions view, and dropping it onto the canvas. Tip! Designer can rename the step for you, based on the document or service you drag and drop. The Automatically change step name when drag and drop document or service over existing step preference is enabled by default. See Appearance Preferences on page 28. Note: You cannot add an Adapter Notification step using the process editors toolbar. Adapter Notification steps require data from a back-end system, such as SAP. These steps can only exist if the adapter notification documents exist. See Configuring Receive Steps on page 157 and Configuring Reply Steps on page 167. Related Topics Steps on page 121 Adding Steps to Swimlanes on page 120 Adding Steps to Subprocesses on page 182 Package Navigator View on page 61 Solutions View on page 47
126
5 6
Note: You cannot change the display images of receive, reply, publish, subprocess, terminate, or gateway steps. Related Topics Steps on page 121 Changing Step Types on page 128 Adding Steps to Swimlanes on page 120 Adding Steps to Subprocesses on page 182 Configuring Steps on page 129 Solutions View on page 47
127
128
Configuring Steps
You configure a step based on its type and what it does in the process. Basic step properties include General properties, Inputs/Outputs, Transitions, Documentation, and KPIs. Advanced step properties vary with the type of step being configured. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode. When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. Adapter notification steps can be created only using the data from the back-end system with which it is associated, such as SAP. You cannot create an adapter notification step using the process editor toolbar; you must drag and drop the adapter notification document you want to use in the step from the Package Navigator view. In some cases, Designer automatically creates the step for you; in some cases, you must create the steps first and then drag and drop the adapter notification document you want to use in them. If you drag an asynchronous publish or asynchronous send adapter notification document type from the Package Navigator onto the process editor, Designer automatically creates a receive step in the process. The Receive Protocol and Receive Document fields are automatically populated, and are not editable. You cannot drag synchronous publish and wait adapter notification document type from the Package Navigator directly onto the process editor. To create a synchronous request, create a receive step and then drag and drop the synchronous publish and wait request document onto the step. Similarly, to create a synchronous reply, create a reply step and then drag and drop the synchronous publish and wait reply document onto the step. A synchronous publish and wait adapter notification requires both the request and the reply. The Receive Protocol and Receive Document fields in the request and the Reply Document and Reply To fields in the reply are automatically populated, and are not editable. Related Topics Changing Step Images on page 127
129
Changing Step Types on page 128 Configuring Empty Steps on page 130 Configuring IS Service Steps on page 132 Configuring Task Steps on page 136 Configuring Rule Steps on page 141 Configuring Web Service Steps on page 146 Configuring Referenced Process Steps on page 150 Configuring Receive Steps on page 157 Configuring Reply Steps on page 167 Configuring Publish Steps on page 170 Configuring Terminate Steps on page 174 Configuring Gateway Steps on page 178 Configuring Subprocess Steps on page 182 Process Simulation on page 257
130
Basic Properties Pages Page Name General Description Label: step name. Default is Activity1. Empty steps do not have flow services. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Empty steps do not have Edit Data Mapping links because they do not have data to map. Step inputs and outputs. See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Transitions Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
131
Advanced Properties Pages Page Name Implementation Description Type: activity step type Empty. See Steps on page 121. Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Joins Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition. Related Topics Steps on page 121 Configuring Steps on page 129 Process Simulation on page 257
132
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. You can double-click an IS Service step, or right-click it and select Open Flow Service Editor from the context menu, to open the underlying structure of the service in the flow service editor.
133
Basic Properties Pages Page Name General Description Label: step name. Default is Activity1. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is nonASCII. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Edit Data Mapping: map process step data to implemented service input signature (in the Input section) and output signature (in the Output section). Step inputs and outputs. See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Tip! Remember to save services after mapping and before returning to the process editor. Designer will prompt you to save your changes only if you close the flow service editor or quit the program altogether. Transitions Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
134
Advanced Properties Pages Page Name Implementation Description Type: activity step type IS Service. See Steps on page 121. Service: Integration Server service called by the step. Select Browse... to open the Choose Service window and locate a service on an Integration Server or in CentraSite. Select New... to open the New Flow Service window and create a new service on a configured Integration Server. Select View... to open the selected service in the flow service editor. The View... button is available only when a service is specified in the Service field. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Step Retry Interval: Number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads.
135
Description Selected input and output document fields to log. See Logging Step Inputs and Outputs on page 192. Inputs are logged before the step executes, and outputs are logged after the step executes. Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition.
Joins
Related Topics Steps on page 121 Configuring Steps on page 129 IS Service Step and Rule Step Generation on page 231 Process Simulation on page 257
136
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. E-form support in a task must be added in the task editor, even if the process is e-form driven. For information on adding e-form support to a task, see Adding E-form Support to a Task in webMethods Designer BPM Task Development Help. For more information on using e-forms, see Implementing E-form Support for BPM.
137
Basic Properties Pages Page Name General Description Label: step name. Default is Activity1. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Important! Renaming a task step in a Designer process does not change the name of the task implementation. If you want to rename a task that is in a running process, you must rename it in Designer and then republish the modified task to My webMethods Server and Designer. See Changing the Name of a Task in webMethods Designer BPM Task Development Help. For more information on task naming, see About Task Names in webMethods Designer BPM Task Development Help. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is nonASCII. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Edit Data Mapping: map process step data to implemented service input signature (in the Input section) and output signature (in the Output section). Step inputs and outputs. See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Tip! Remember to save services after mapping and before returning to the process editor. Designer will prompt you to save your changes only if you close the flow service editor or quit the program altogether.
138
Description Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197.
Documentation
Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
139
Advanced Properties Pages Page Name Implementation Description Type: activity step type Task. See Steps on page 121. Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Step Retry Interval: Number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads. Task Information: Browse available tasks and select one to populate the Task Name and Task Type ID fields. Once these are populated, select a Task Rule Set from the list. Note: Tasks in the workspace are designated with a workspace icon badge to differentiate them from tasks in CentraSite, which use a CentraSite icon badge. You can specify a task that is not in your local environment by typing in the Task Type ID. If the task is used anywhere else in your environment (and stored in metadata), the name will be automatically populated. If the task is not in your environment, you can enter in your own mnemonic as a Task Name.
140
Description Selected input and output document fields to log. See Logging Step Inputs and Outputs on page 192. Inputs are logged before the step executes, and outputs are logged after the step executes. Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition.
Joins
Related Topics Steps on page 121 Configuring Steps on page 129 Task Step Generation on page 239 Process Simulation on page 257
141
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus.
142
Basic Properties Pages Page Name General Description Label: step name. Default is Activity1. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is nonASCII. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Edit Data Mapping: map process step data to implemented service input signature (in the Input section) and output signature (in the Output section). Step inputs and outputs. See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Tip! Remember to save services after mapping and before returning to the process editor. Designer will prompt you to save your changes only if you close the flow service editor or quit the program altogether. Transitions Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
143
144
Description Type: activity step type Rule. See Steps on page 121. Blaze Repository: the name of the Blaze repository. This field does not affect generation or run time; it is a convenience field used only when opening Blaze Advisor to edit the rule entity associated with the step. Blaze Project Folder: the name of the Blaze project folder. This field does not affect generation or run time; it is a convenience field used only when opening Blaze Advisor to edit the rule entity associated with the step. Blaze Project: the name of the Blaze project. This field does not affect generation or run time; it is a convenience field used only when opening Blaze Advisor to edit the rule entity associated with the step. Service: Rule service called by the step. See Process Rules on page 215. Select Browse... to open the Choose Service window and locate a service on an Integration Server or in CentraSite. Select View... to open the selected service in the flow service editor. The View... button is available only when a service is specified in the Service field. Rule services can only be created by deploying a Blaze rule to Integration Server using Blaze Advisor. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Step Retry Interval: Number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads.
145
Description Selected input and output document fields to log. See Logging Step Inputs and Outputs on page 192. Inputs are logged before the step executes, and outputs are logged after the step executes. Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition.
Joins
Related Topics Steps on page 121 Configuring Steps on page 129 IS Service Step and Rule Step Generation on page 231 Process Simulation on page 257 Using Blaze Rules with BPM and CAF
146
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus.
147
Basic Properties Pages Page Name General Description Label: step name. Default is Activity1. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is nonASCII. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Edit Data Mapping: map process step data to implemented service input signature (in the Input section) and output signature (in the Output section). Step inputs and outputs. See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Tip! Remember to save services after mapping and before returning to the process editor. Designer will prompt you to save your changes only if you close the flow service editor or quit the program altogether. Transitions Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
148
Advanced Properties Pages Page Name Implementation Description Type: activity step type Web Service. See Steps on page 121. Service: Integration Server Web service connector called by the step. Select Browse... to open the Choose Service window and locate a service on an Integration Server or in CentraSite. Select New... to open the New Web Service Descriptor window and create a new Web service descriptor. Select View... to open the selected service in the flow service editor. The View... button is available only when a service is specified in the Service field. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. Note: Generated Web service connectors reference Web service descriptors on Integration Server. For more information on Web service descriptors, see the webMethods Web Services Developers Guide. Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Step Retry Interval: Number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads.
149
Description Selected input and output document fields to log. See Logging Step Inputs and Outputs on page 192. Inputs are logged before the step executes, and outputs are logged after the step executes. Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition.
Joins
Related Topics Steps on page 121 Configuring Steps on page 129 Web Service Step Generation on page 241 Process Simulation on page 257
150
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus.
151
Basic Properties Pages Page Name General Description Label: step name. Default is Activity1 if you create the step using the Activity step button and change it to a referenced process step, and <Process Name> if you drag a process from the Solutions view and drop it on the process editors canvas. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is nonASCII. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Edit Data Mapping: map process step data to implemented service input signature (in the Input section) and output signature (in the Output section). Step inputs and outputs. See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Tip! Remember to save services after mapping and before returning to the process editor. Designer will prompt you to save your changes only if you close the flow service editor or quit the program altogether. Transitions Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197.
152
Description Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
153
154
Description Type: activity step type Referenced Process. See Steps on page 121. Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Step Retry Interval: Number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads. Allow this step to dynamically invoke one or more referenced processes at run time: Select the check box to specify that the referenced process is to be dynamically generated. Selecting this option removes the Referenced Process option, and thus the option to populate the Process Name and Process ID fields. Tip! Input to and output from a dynamic referenced process comes from the pipeline using the document type pub.prt.SubprocessMode. A single dynamic referenced process can invoke multiple referenced processes, or multiple instances of one or more referenced processes. You can configure whether or not the parent process must wait for a child process to complete. For more information on pub.prt.SubprocessMode document types and configuring dynamic referenced processes in Referenced Process steps, see Administering webMethods Process Engine. Referenced Process: Open the Processes window to browse available processes and select one to populate the Process Name and Process ID fields. This option is not available when Allow this step to dynamically invoke one or more referenced processes at run time is selected. Note: Processes in the workspace are designated with a workspace icon badge to differentiate them from processes in CentraSite, which use a CentraSite icon badge.
Note: A process with a start step (a receive step with the Allow this step to start new process instance box checked on the General page in webMethods Designer BPM Process Development Help Version 8.0 155 the Properties view) that receives a Trading Networks (TN) document cannot be used as a Referenced Process.
Description Selected input and output document fields to log. See Logging Step Inputs and Outputs on page 192. Inputs are logged before the step executes, and outputs are logged after the step executes. Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition.
Joins
Select Inputs for Start documents (which referenced process subscription documents should be used to invoke the referenced process) and Outputs for Return documents (which referenced process publish documents should return to the parent process). See Specifying Referenced Process Start and Return Documents on page 196.
Related Topics Steps on page 121 Configuring Steps on page 129 Referenced Process Step Generation on page 236 Process Simulation on page 257
156
157
Basic Properties Pages Page Name General Description Select or clear the Allow this step to start new process instance check box. Selecting this option makes the step a start step. See Steps on page 121 and Correlation Services on page 217. Note: Receive steps that start processes and those that do not start processes can use e-forms. For more information about using eforms, see Using E-forms in Receive Steps on page 165 and Implementing E-form Support for BPM. Note: Start steps that receive Trading Networks (TN) documents cannot be used in referenced process steps. Label: step name. Default is Receive1. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is non-ASCII. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Edit Data Mapping: map process step data to implemented service output signature. Step outputs. (Receive steps do not have inputs.) See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Tip! Remember to save services after mapping and before returning to the process editor. Designer will prompt you to save your changes only if you close the flow service editor or quit the program altogether.
158
Description Transition Type: type of condition for the step to transition to a following step. Receive steps cannot have inbound transitions. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197.
Documentation
Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
159
160
Description Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Note: For intermediate receive steps, correlation retry behavior is defined in the subscription trigger. See the Publish-Subscribe Developers Guide. Step Retry Interval: Number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads. Generate Service: Select the check box to turn off the service generation and execution of services associated with a receive step. By default, this option is enabled for new processes created in Designer, and disabled for processes imported from Modeler 6.x. Receive Protocol: type of receive protocol to use. Select Subscription (For Broker Documents), Simple Service (For Synchronous Reply), or JMS (for JMS Triggered Processes) from the list. Note: The Receive Protocol is not editable in Adapter Notification (AN) steps.
161
Page Name
Description Select a subscription protocol to subscribe to and receive it when it is published. Select a simple service (synchronous) protocol to associate a receive step with a reply type, using the reply steps Reply To property. The receive step publishes the input to the service and waits for the reply document. Select the JMS protocol to use JMS to trigger a process. Note: If you use the JMS protocol for one receive step in a process, you must also use it in any other receive steps in that process. To use the JMS protocol, a JMS connection alias named PE_NONTRANSACTIONAL_ALIAS must be defined in the Integration Server JMS Settings for use by the Process Engine. When you select the JMS protocol, Designer automatically uses this connection alias to communicate, and automatically generates the Destination using a String of the form <projectname>_<processname>_SUBQUEUE. In Developer and in the Designer flow service editor, the auto-generated Destination can be seen in the subscription trigger of the generated process. When you publish a document using JMS to trigger the process, you must specify this auto-generated Destination. For information on defining a JMS connection alias, see Administering webMethods Integration Server. For information on the JMS connection alias in the Process Engine, see Administering webMethods Process Engine. Receive Document: select the document type to receive from the Choose Document window. Note: The Receive Document is not editable in Adapter Notification (AN) steps. Note: Selecting an e-form sourced IS document as the steps Receive Document automatically enables the E-form (For E-form Triggered Processes) check box. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it.
162
Page Name
Description E-form (For E-form Triggered Processes): Selecting an e-form sourced IS document as the steps Receive Document automatically enables this check box. See Using E-forms in Receive Steps on page 165. E-form Content Repository: Select Browse... to specify a My webMethods Server content repository where e-form instances are monitored by the Process Engine listener. See Using E-forms in Receive Steps on page 165 and Implementing E-form Support for BPM. Important! Incoming e-forms instances must have the correct file name extension (for example, .xml for InfoPath forms, .xdp for LiveCycle forms). Otherwise, they will not trigger the receive step. E-form Template Name: Selecting an e-form sourced IS document as the steps Receive Document automatically populates this field. Receive steps that start processes and those that do not start processes can use e-forms. For more information about using eforms, see Using E-forms in Receive Steps on page 165 and Implementing E-form Support for BPM. Subscription Filter: the instances of a subscription document that can trigger the process. See Subscription Filters on page 212. Receive steps using a synchronous receive protocol do not have subscription filters.
163
Description Selected input and output document fields to log. See Logging Step Inputs and Outputs on page 192. Inputs are logged before the step executes, and outputs are logged after the step executes. A correlation service is used to correlate received documents to a running instance of the process. See Correlation Services on page 217. Select one of the following options: Not Used: Default selection, used when you do not need a correlation service Field: Select a field from the steps subscription document to use as the correlation key Service: Select an Integration Server service to use as the correlation key. Select Browse... to open the Choose Service window and locate a service on an Integration Server or in CentraSite. Select New... to open the New Flow Service window and create a new service on a configured Integration Server. Select View... to open the selected service in the flow service editor. The View... button is available only when a service is selected. Note: For intermediate receive steps, correlation retry behavior is defined in the subscription trigger. See the Publish-Subscribe Developers Guide. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it.
Correlation
Note: Receive steps cannot have joins. Related Topics Steps on page 121 Configuring Steps on page 129 Using E-forms in Receive Steps on page 165 Receive Step Generation on page 235 Process Simulation on page 257
164
Using E-forms in Receive Steps Designer supports the use of Microsoft InfoPath and Adobe LiveCycle e-forms in processes. Receive steps that start processes and those that do not start processes can use e-forms. Important! Task steps can also use e-forms. E-form support in a task must be added in the task editor, even if the process is e-form driven. For information on adding e-form support to a task, see Adding E-form Support to a Task in webMethods Designer BPM Task Development Help. For more information on using e-forms, see Implementing E-form Support for BPM. E-forms are created from templates; those templates contain information required by the process using the e-form. When an e-form is used in a process, it is an instance of that eform. E-form templates and e-form instances both need to be accessible to the process, and it is important that each has a separate location.
To use an e-form in a receive step In Designer, do one of the following: Drag and drop an existing e-form sourced IS document from the Package Navigator view onto the process editor to create a receive step pre-configured to use an e-form. The E-form (For E-form Triggered Processes) check box is automatically selected, and the E-form Template Name field is automatically populated. You must select the E-form Content Repository location. See To select an E-form Content Repository on page 166. OR Drag and drop an existing e-form sourced IS document from the Package Navigator view onto an existing receive step to configure it to use an e-form. The E-form (For Eform Triggered Processes) check box is automatically selected, and the E-form Template Name field is automatically populated. You must select the E-form Content Repository location. See To select an E-form Content Repository on page 166. OR Manually configure an existing receive step to use an e-form. See To manually configure an existing receive step to use an e-form on page 166. You must select the E-form (For E-form Triggered Processes) check box. The E-form Template Name field is automatically populated when you select an e-form sourced IS document as the steps Receive Document. You must select the E-form Content Repository location. See To select an E-form Content Repository on page 166.
165
To manually configure an existing receive step to use an e-form 1 On the Implementation page in the Properties view of a receive step, click Browse... to select an e-form sourced IS document as the steps Receive Document or New... to create a new e-form sourced IS document and select it as the steps Receive Document.
Important! You must use Browse... or New... to select the e-form sourced IS document as the steps Receive Document. If you type the Receive Document name, the e-form fields are not enabled. Important! Incoming e-forms instances must have the correct file name extension (for example, .xml for InfoPath forms, .xdp for LiveCycle forms). Otherwise, they will not trigger the receive step. 2 3 Select the E-form (For E-form Triggered Processes) check box to enable e-form support in the step. Select the E-form Content Repository location. See To select an E-form Content Repository on page 166.
To select an E-form Content Repository On the Implementation page in the Properties view of a receive step, click Browse... to select a configured content repository as the e-forms E-form Content Repository. Software AG Designers e-form solution works with My webMethods Server as the eform content repository, through the JSR-170 interface. For more information about e-form content repositories, see Implementing E-form Support for BPM. Related Topics Steps on page 121 Configuring Steps on page 129 Configuring Receive Steps on page 157 Receive Step Generation on page 235 Process Simulation on page 257
166
167
Basic Properties Pages Page Name General Description Label: step name. Default is Reply1. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is nonASCII. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Edit Data Mapping: map process step data to implemented service input signature. Step inputs. (Reply steps do not have outputs.) See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Tip! Remember to save services after mapping and before returning to the process editor. Designer will prompt you to save your changes only if you close the flow service editor or quit the program altogether. Transitions Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
168
Advanced Properties Pages Page Name Implementation Description Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Step Retry Interval: Number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads. Reply Document: document to send in the reply. Select from the Choose Document window. Select Browse... to open the Choose Document window and locate a document on an Integration Server or in CentraSite. Select New... to open the Create a New Document Type window and create a new document on a configured Integration Server. Select View... to open the selected document in a document editor. The View... button is available only when a document is specified in the Reply Document field. Note: The Reply Document is not editable in Adapter Notification (AN) steps. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. Reply To: step to which to send the reply. Note: The Reply To is not editable in Adapter Notification (AN) steps.
169
Description Selected input and output document fields to log. See Logging Step Inputs and Outputs on page 192. Inputs are logged before the step executes, and outputs are logged after the step executes. Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition.
Joins
Related Topics Steps on page 121 Configuring Steps on page 129 Reply Step Generation on page 237 Process Simulation on page 257
170
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus.
171
Basic Properties Pages Page Name General Description Label: step name. Default is Publish1. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is non-ASCII. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Edit Data Mapping: map process step data to implemented service input signature. Step inputs. (Publish steps do not have outputs.) See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Tip! Remember to save services after mapping and before returning to the process editor. Designer will prompt you to save your changes only if you close the flow service editor or quit the program altogether. Transitions Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
172
Advanced Properties Pages Page Name Implementation Description Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Step Retry Interval: Number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads. Publish Document: Integration Server document to publish. Select Browse... to open the Choose Document window and locate a service on an Integration Server or in CentraSite. Select New... to open the Create a New Document Type window and create a new document on a configured Integration Server. Select View... to open the selected document in a document editor. The View... button is available only when a document is specified in the Publish Document field. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it.
173
Description Selected input and output document fields to log. See Logging Step Inputs and Outputs on page 192. Inputs are logged before the step executes, and outputs are logged after the step executes. Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition.
Joins
Related Topics Steps on page 121 Configuring Steps on page 129 Publish Step Generation on page 237 Process Simulation on page 257
174
Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus.
175
Basic Properties Pages Page Name General Description Label: step name. Default is Terminate1. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is non-ASCII. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
176
Advanced Properties Pages Page Name Implementation Description Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads. Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Step Retry Interval: number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Terminate Status: status of process termination generated in the Process Engine. Select Canceled, Completed, or Failed. Default is Canceled, which webMethods Monitor shows as stopped. Completed shows as completed, and Failed shows as failed. Joins Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition. Note: Terminate steps cannot have outbound transitions.
177
Related Topics Steps on page 121 Configuring Steps on page 129 Terminate Step Generation on page 240 Process Simulation on page 257
178
Basic Properties Pages Page Name General Description Label: step name. Default is Gateway1. Gateway steps do not have flow services. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. Description: descriptive information about the step, for documentation purposes only. Text in step descriptions is searchable. Inputs / Outputs Gateway steps do not have Edit Data Mapping links because they do not have data to map. Step inputs and outputs. See Step Inputs and Outputs on page 187. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Transitions Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Step-level KPIs. See KPIs on page 244.
KPIs
179
Advanced Properties Pages Page Name Implementation Description Integration Server Name: Integration Server to implement and execute the step. See Integration Servers Preferences in webMethods Designer Service Development Help. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. Logged Fields Selected input and output document fields to log. See Logging Step Inputs and Outputs on page 192. Inputs are logged before the step executes, and outputs are logged after the step executes. Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition. Related Topics Steps on page 121 Configuring Steps on page 129
Joins
Subprocesses
A subprocess is not a self-contained process. It can exist only inside its parent process. A subprocess is a group of steps in a container, and is treated as a step in the process. You can define KPIs for a subprocess, and a subprocess can contain other subprocesses.
180
The subprocess container can be resized, collapsed, and expanded on the process editors canvas. You cannot, however, collapse a subprocess that crosses swimlanes. Subprocesses can also be looped, with a condition attached to them. You can drill into a subprocess and view only the subprocess on the canvas. With a subprocess selected, click the Go Into button on the process editors toolbar. Alternatively, you can perform this same action by right-clicking a collapsed subprocess and selecting Drill into subprocess. If a subprocess contains another subprocess, you can drill into that one and view it full screen as well, and so on. To return to views of previous layers, click Back. To return to the default view of the entire process, click Home. You can select a subprocess color. Set the default color for subprocesses in Window > Preferences > Software AG > Process Development > Appearance > Colors And Fonts, and also select for an individual subprocess: right-click the subprocess and click Choose Color. Click a color in the Color window and click OK. Related Topics Adding Subprocesses on page 181 Adding Steps to Subprocesses on page 182 Configuring Subprocess Steps on page 182 Subprocess Logic on page 206 Subprocess Loop Conditions on page 207 Process Development Editor and Tools on page 16
Adding Subprocesses
To add a subprocess to the Process Development canvas 1 2 or To create a subprocess using existing steps on the process editors canvas 1 2 CTRL+click to select multiple steps on the process editors canvas Right-click any of the selected steps and click Collapse to subprocess. In Designer: click Subprocess.
Related Topics Adding Steps to Subprocesses on page 182 Configuring Subprocess Steps on page 182 Subprocess Logic on page 206
181
182
When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus.
183
Basic Properties Pages Page Name General Description Note: Select or clear the Allow this step to start new process instance check box. Selecting this option makes the step a start step. See Steps on page 121 and Correlation Services on page 217. Label: step name. Default is Subprocess1. By default, the Label is used in generated flow services when the process is built and uploaded. Font Style: format of the Label text in the process editor and in the HTML Documentation Report. You can select the Font Name, Font Size, Bold, Italic, and Font Color. Default settings are Tahoma 8 point black, with no bold or italic. Step ID: automatically generated identifier, unique within the process. Not editable. The Step ID is used in generated flow services when the process is built and uploaded if the step Label is non-ASCII. Description: descriptive information about the subprocess, for documentation purposes only. Text in subprocess descriptions is searchable. Transitions Transition Type: type of condition for the step to transition to a following step. See Step Transitions on page 197. Description: descriptive information about the transition, for documentation purposes only. Create the transition condition using the options presented based on the Transition Type selection. See Step Transitions on page 197. Documentation Local and default documentation fields to document in the process. Documentation fields are searchable. See Documenting Processes on page 85. Process-level KPIs for the subprocess. See KPIs on page 244.
KPIs
184
Advanced Properties Pages Page Name Implementation Description Integration Server Name: Integration Server to implement and execute the subprocess step. See Integration Servers Preferences in webMethods Designer Service Development Help. Step Retry Count: the number of times the Process Engine will retry your service if an Integration Server run-time exception is thrown. Default is 0, or no retries. Note: The retry mechanism is invoked only when a step service generates an ISRuntimeException error. Any other exception (such as an EXIT with FAILURE error) will cause the step to fail. Step Retry Interval: Number of milliseconds (ms) the Process Engine will wait between retry attempts if an Integration Server run-time exception is thrown. Default is 60000 ms, or 60 seconds. Lock Step: Select the check box to specify that the step must be locked by the Process Engine at run time. Locking a step allows it to be executed by multiple threads. Loop Condition: condition to exit the loop and proceed to the next step(s) in the process. See Subprocess Loop Conditions on page 207. Joins Join Type: select OR, AND, COMPLEX, or Unsynchronized OR from the list. See Join Conditions on page 209. Suppress Join Failure: if a join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. Select the Suppress Join Failure check box to enable this behavior. This option is available for AND and COMPLEX joins only. Join Timeout: the type of timeout condition after which this join fails. You can specify a static value or a select a value from a field that is output from an upstream step. The Join Timeout option is available for AND and COMPLEX joins only. See Join Conditions on page 209. Create the transition condition using the options presented based on the Join Type selection. See Join Conditions on page 209. The Joins page displays when a step has more than one input transition. Related Topics Subprocesses on page 180
185
Adding Subprocesses on page 181 Adding Steps to Subprocesses on page 182 Subprocess Step Generation on page 238 Process Simulation on page 257
186
187
(specified in the Service property) inside this mapping service, and adds a flow map step. Designer then opens the Pipeline view to allow you to map the step inputs and outputs to the invoked service inputs and outputs. See What Does the Pipeline View Contain? in webMethods Designer Service Development Help. By default, Designer does not display generated flow services in the Package Navigator view. You can view them by editing the Package Navigator filter. Click Filter contents of Navigator and clear the Hide generated flow services check box in the Choose Elements to Display window. You can also set a preference for this behavior in Window > Preferences > Software AG > Service Development > Package Navigator. See Package Navigator Preferences in webMethods Designer Service Development Help. Once a mapping service has been created, you can right-click its step and select Edit Mapping Service to open it in the flow service editor and update the generated service signature to match the steps current inputs and outputs. Another method is to select Edit Data Mapping on the Inputs/Outputs page of the Properties view of the step whose data you want to map. Note: Mapping services are not intended to contain business logic. The mapping service editor does not prevent you from adding other flows inside a mapping service. However, all reusable business logic should be placed in the invoked service, not in the mapping service. When you build and upload a process, Designer automatically updates the mapping services of all steps to include the current step signatures, and generates mapping services for all steps that do not yet have them defined. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. If the inputs or outputs of a task, service, or rule used to implement that step are changed such that they do not match what is displayed in the process editor, the process will not refresh its inputs and outputs automatically. You must explicitly refresh them by editing the inputs or outputs on the steps Inputs / Outputs page in the Properties view. Remove the old inputs or outputs from the step, and use the Auto-populate based on service signature button to assign the new inputs or outputs. Important! Process steps do not support String Tables, inline documents, or inline document lists as inputs or outputs. If you drag a service that has one of these as part of its signature from the Metadata Library or the Package Navigator view and drop it onto the process editors canvas, the resulting process step will display that input/output type as Unknown. Therefore, the generated wrapper/mapping service for that step will also show the type as Unknown when you view or edit it in the flow service editor. You can change the type there. See Mapping Data in Flow Services and Service Properties in webMethods Designer Service Development Help.
188
Related Topics Showing and Hiding Step Inputs and Outputs on page 189 Creating Step Inputs and Outputs on page 190 Removing Step Inputs and Outputs on page 191 Auto-Populating Step Inputs and Outputs on page 192 Logging Step Inputs and Outputs on page 192 Step Input and Output Types on page 194 Step Inputs and Outputs on page 187 Integration Servers Preferences in webMethods Designer Service Development Help Mapping Data in Flow Services in webMethods Designer Service Development Help
189
Important! Inputs to all steps must exist upstream in the pipeline. If you create a new input that does not yet exist upstream, you must create an output to feed the new input before completing the process. 3 Create a new input or output, or select an input from upstream in the pipeline:
If you create a new input or output, configure the Name, Type, and Description, and select the List check box if the input is an array. If you select a Document Reference, select the document from the Choose Document window. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it.
If you create an input based on an existing output from upstream in the pipeline, you do not need to configure the Name, Type, or Description. Designer populates the values automatically when you select the existing output.
190
Important! Unnamed inputs and outputs are not saved. Note: Text entered in the Description field is included in the HTML Documentation Report. Related Topics Showing and Hiding Step Inputs and Outputs on page 189 Removing Step Inputs and Outputs on page 191 Auto-Populating Step Inputs and Outputs on page 192 Logging Step Inputs and Outputs on page 192 Step Input and Output Types on page 194 Step Inputs and Outputs on page 187
191
192
Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode. When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. Logged fields can be viewed in webMethods Monitor and used as KPIs in webMethods Optimize. To select input and output document fields for logging, you must have defined step inputs and outputs. To select a step input or output document field for logging 1 2 3 4 Select a step in the process editor that has inputs and outputs defined. On the Logged Fields page in the Properties view, click Expand to expand the Inputs and Outputs trees to display the fields available in the documents. Select the check boxes that correspond to the document fields you want to log. If you want to define an alias for a document field, type an Alias name. The alias defaults to the name and path of the selected field, but it can be modified to any alias for viewing in webMethods Monitor. Note: You can create the same alias for more than one field on a step, but this is not recommended, as it will make monitoring the fields at run time difficult. Note: When you associate an output field with a KPI or a dimension, Designer automatically adds the field to the Logged Fields page in the Properties view. Designer does not, however, automatically remove an output field from the Logged Fields page in the Properties view if you remove it from a KPI or dimension.
193
Related Topics Showing and Hiding Step Inputs and Outputs on page 189 Creating Step Inputs and Outputs on page 190 Removing Step Inputs and Outputs on page 191 Auto-Populating Step Inputs and Outputs on page 192 Step Input and Output Types on page 194 Step Inputs and Outputs on page 187 KPIs on page 244
194
Description A one-dimensional long array. Signed integer. The value must be greater than or equal to -32768 but less than or equal to 32767. A one-dimensional short array. A data type that does not fall into any of the data types described in this table, and is not declared to be one of the basic Java classes supported natively by Integration Server. A one-dimensional object array. Select an Integration Server document type in the Choose Document window. The document you select becomes the input or output type. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it.
A string of characters. A one-dimensional string array. An input or output of unknown type. A one-dimensional unknown array.
Showing and Hiding Step Inputs and Outputs on page 189 Creating Step Inputs and Outputs on page 190 Removing Step Inputs and Outputs on page 191 Auto-Populating Step Inputs and Outputs on page 192 Logging Step Inputs and Outputs on page 192 Step Inputs and Outputs on page 187
195
Note: Designer ignores the Express Pipeline setting for dynamic referenced process steps. See Configuring Referenced Process Steps on page 150.
196
Related Topics Step Inputs and Outputs on page 187 Configuring Referenced Process Steps on page 150
Step Transitions
Transitions indicate the flow of control in the process being passed from one step to another. Specialized transition types, as well as splits and branches, are permitted from each step. These transitions each have a label and a description that are distinct from the condition itself. Transition conditions are based on logical data, rather than physical data, and can be specified in the Process Development perspective. Condition editing is done in a spreadsheet-style editor, allowing multiple and complex conditions. Designer allows the following step transition types: Transition Type Split Branch Description Multiple output transitions from a single step with no conditions specified follow all paths. Conditions are based on upstream pipeline data to determine whether control is passed on a transition. The logic is not necessarily mutually exclusive; more than one condition can be satisfied. Transitions from multiple steps to a single step can follow OR, AND, Unsynchronized OR, or COMPLEX conditions. Configured on the Joins page in the Properties view of a step. This page is only available when a step has multiple input transitions. Based on a static value or on a value from a field that is output from an upstream step. Configured on the Joins page in the Properties view of a step. This page is only available when a step has multiple input transitions. For a join timeout to follow a transition, you must set the desired transition to Timeout on the Transitions page in the Properties view of a step, or on the Condition page in the Properties view of a transition. If Condition Requirement condition for process to follow path. Configured on the Transitions page in the Properties view of a step, or on the Condition page in the Properties view of a transition. If no other condition is followed. Configured on the Transitions page in the Properties view of a step, or on the Condition page in the Properties view of a transition.
Join
Join Timeout
Else
197
Description Serves to catch run-time errors a step encounters. Configured on the Transitions page in the Properties view of a step, or on the Condition page in the Properties view of a transition. Based on a static value or on a value from a field that is output from an upstream step. Configured on the Transitions page in the Properties view of a step, or on the Condition page in the Properties view of a transition. If a step has a Timeout, and that steps source has a Join Timeout, the transition that happens first will be taken.
Timeout
If a transition is looped back to more than the indicated limit. Configured on the Transitions page in the Properties view of a step, or on the Condition page in the Properties view of a transition. If the conditions of a join are not satisfied. Configured on the Transitions page in the Properties view of a step, or on the Condition page in the Properties view of a transition.
Unsatisfied Join
You can create step transitions between any two steps in the process editor, including subprocesses. Note: Transitions using fields of type String that contain numerical values at run time are compared numerically. Related Topics Creating Step Transitions on page 201 Configuring Step Transitions on page 203 Step Transition Condition Operators on page 205 Step Transition Sequence on page 199 Join Conditions on page 209 Subprocesses on page 180 Subprocess Logic on page 206
198
While the step is executing If ... The step encounters an error The Process Engine ... Executes Standard Exception Handling See Standard Exception Handling on page 201. The step has a Timeout defined, and that timeout is exceeded before the step completes Takes the steps Timeout transition
199
After the step has executed If ... There are transitions without conditions There are if conditions that are satisfied There are if conditions that are not satisfied AND There is an else transition defined At any point If ... A join has a timeout value specified AND One of the required paths never reaches the step The Process Engine ... Takes the first of the following transition types it encounters: a b c Step timeout transition Process-level timeout Standard Exception Handling The Process Engine ... Takes them Takes them Takes the else transition
See Standard Exception Handling on page 201. A process-level timeout is defined AND It expires at any point during the process No process-level Timeout Handler Step is defined No process-level Error Handler Step is defined Related Topics Standard Exception Handling on page 201 Step Transitions on page 197 Join Conditions on page 209 Subprocess Logic on page 206 Join Conditions on page 209 Correlation Services on page 217 Executes the process-level Error Handler Step Sets the process instance to Failed Executes the process-level Timeout Handler Step
200
201
You can specify a preference as to whether Designer draws curved, straight (orthogonal), or custom (allowing for bendpoints) transition lines by default. Select Curved, Straight, or Custom in the Default Transition Line Shape section in Window > Preferences > Software AG > Process Development > Appearance. You can also change the appearance of an individual transition by selecting a line, right-clicking, and then selecting the line type you want. Tip! If you select Custom lines, you can click and drag a point on the line, called an inflection point, and drop it where you want it to be. Once you drag and drop an inflection point, new ones are created on the line segments surrounding it. You can move as many inflection points, and create as many segments, as you want to. This is useful for routing transition lines around other objects on the process editors canvas.
To create a step transition 1 2 Click the connector icon in the upper right corner of a step in the process editor, and drag to create a line. Drop the end of the line on another step to connect the two.
Related Topics Removing Step Transitions on page 202 Configuring Step Transitions on page 203 Step Transition Condition Operators on page 205 Step Transition Sequence on page 199 Step Transitions on page 197
Related Topics Creating Step Transitions on page 201 Configuring Step Transitions on page 203 Step Transition Condition Operators on page 205 Join Conditions on page 209 Step Transition Sequence on page 199 Step Transitions on page 197
202
Select a step with a transition from it, and then select the Transitions page in the Properties view Select a transition from a step (the line itself), and then select the Conditions page in the Properties view
Select the type of transition condition to configure from the Transition Type list. The following types are available: Transition Type If Condition Else Error Description Requirement condition for logic to follow path If no other condition is followed Serves to catch run-time errors a step encounters If the step is a subprocess, select the compensating check box to create a compensating error transition. The steps in the subprocess are treated as a single entity. The Process Engine stores the pipeline data when it enters the subprocess step; if an error occurs during run time, the Process Engine restores the pipeline that was originally passed into the subprocess step and continues the process. In a non-compensating error transition, the pipeline contains whatever happens to be present at the time and place of the error itself. Timeout Step Iterations Exceeded Unsatisfied Join A static value or a value from a field that is output from an upstream step that specifies the timeout on a step If a transition is looped back to more than the indicated limit If a join transition is not satisfied
Enter descriptive information about the selected condition in the Description field. Designer may display this text in the process editor, depending on the Transition Text setting in Appearance preferences. See Appearance Preferences on page 28.
203
Click Add to add information about an If Condition, or enter configuration information for Timeout or Step Iterations Exceeded conditions. Else and Error conditions do not require additional configuration. The following fields are provided:
If Condition Field Field Name Description Select an upstream document from the list and navigate to a field in that document on which to base the condition. Select an operator to use to compare the Field Name value and the Comparison Value/Field value. See Step Transition Condition Operators on page 205 for more information. Select an upstream document from the list and navigate to a field in that document, or type a value, with which you want to compare with the value selected for Field Name. Use the AND and OR operators when you want to specify multiple parameters for the condition statement.
Operator
Comparison Value/Field
AND/OR
Else There are no fields to specify. An Else condition is the path taken when another condition type is specified and not satisfied. Error There are no fields to specify. An Error condition is the path taken when an error occurs in the step logic. Timeout Field Static Value Description Time to wait from the beginning of the step's execution before following the timeout transition. Specify days, hours, minutes, seconds, and milliseconds (ms) values in integer form. Time to wait from the beginning of the step's execution before following the timeout transition. Select a value from a field that is output from an upstream step to serve as the timeout value in milliseconds (ms). This field may be of type long, int, or String, as long as it contains the number of milliseconds to wait for.
Field Value
204
Step Iterations Exceeded Field Maximum iteration allowed for <Step Label> Related Topics Creating Step Transitions on page 201 Removing Step Transitions on page 202 Subprocess Loop Conditions on page 207 Step Transition Condition Operators on page 205 Join Conditions on page 209 Step Transition Sequence on page 199 Step Transitions on page 197 Description Number of times to repeat the step. Type a value (integer).
205
Related Topics Creating Step Transitions on page 201 Removing Step Transitions on page 202 Configuring Step Transitions on page 203 Configuring Subprocess Steps on page 182 Subprocess Loop Conditions on page 207 Join Conditions on page 209 Step Transition Sequence on page 199 Step Transitions on page 197
Subprocess Logic
Externally, subprocesses behave like other steps in a process in many ways. A subprocess is shown as a step on the canvas, is connected in the process like other steps, and has transition lines to the outside of the subprocess step container. Important! There must be at least one step with no input transition inside a subprocess. Subprocesses can be configured to have compensating error transitions. In a compensating error transition, the steps in the subprocess are treated as a single entity. The Process Engine stores the pipeline data when it enters the subprocess step; if an error occurs during run time, the Process Engine restores the pipeline that was originally passed into the subprocess step and continues the process. In a non-compensating error transition, the pipeline contains whatever happens to be present at the time and place of the error itself. Related Topics Subprocess Loop Conditions on page 207 Creating Step Transitions on page 201 Join Conditions on page 209 Configuring Subprocess Steps on page 182
206
Operator
207
Description Select an upstream document from the list and navigate to a field in that document, or type a value, with which you want to compare with the value selected for Field Name. Use the AND and OR operators when you want to specify multiple parameters for the condition statement. Remove to remove that line from the loop
AND/OR
Related Topics Creating Step Transitions on page 201 Removing Step Transitions on page 202 Configuring Step Transitions on page 203 Configuring Subprocess Steps on page 182 Subprocess Loop Conditions on page 207 Subprocess Loop Condition Operators on page 208 Join Conditions on page 209 Step Transition Sequence on page 199 Step Transitions on page 197
208
Operator <= contains does not contain starts with does not start with ends with does not end with exists does not exist Related Topics
Creating Step Transitions on page 201 Removing Step Transitions on page 202 Configuring Step Transitions on page 203 Configuring Subprocess Steps on page 182 Subprocess Loop Conditions on page 207 Join Conditions on page 209 Step Transition Sequence on page 199 Step Transitions on page 197
Join Conditions
Join conditions occur when a step has multiple input transitions. You specify a join condition to indicate when a step should execute. Join conditions can use AND, OR, or Unsynchronized OR statements in their logic. You can also create complex join conditions by using a combination of NOT/AND/OR/Unsynchronized OR statements, parentheses, and multiple transitions to create a join string, using each transitions source Label (step name) as the identifier. Join conditions are configured on the Joins page in the Properties view of a step. Related Topics Configuring Join Conditions on page 210 Removing Join Conditions on page 212 Step Transition Sequence on page 199
209
If you selected an AND or a COMPLEX join, you may select the Suppress Join Failure check box. If the join is not satisfied, suppressing the join failure prevents the step from following the error transition, thus allowing the process to continue normally. If you selected an AND or a COMPLEX join, you may specify a Join Timeout value. In the Join Timeout section, do one of the following:
Click Static Value and specify a timeout by entering integers in the days, hours, minutes, seconds, and ms (milliseconds) fields. A value of "0" (zero) represents no join timeout. Click Field Value and select a field that is output from an upstream step on which to base the timeout Click Business Calendar Value to select a timeout based on a business calendar in My webMethods Server. The following fields must be completed to use a business calendar timeout: Description
The initial date and time from which the timeout is calculated. Set automatically to Join Start Time.
210
Description Select a business calendar from the list. Important! In order to be available here, the calendar must exist in My webMethods Server, you must have an Integration Server configured with the CentralUsers JDBC pool that points to the My webMethods Server instance where the calendar exists, and you must have defined an Integration Server Name in Designer that points to the configured, and online, Integration Server. You must also have Process Engine installed and running. For more information on configuring the CentralUsers JDBC pool, see Administering webMethods Integration Server. For more information about creating and using business calendars, see Working with BPM Tasks: webMethods Task Engine Users Guide.
Execute event as follows Days After Base Date Select the number of days after the Base Date to set the timeout. Note: If you are using a negative offset, the Days After Base Date value cannot be zero (0). Use the following Offsets Hour(s) Select the number of hours to offset the Days After Base Date value. A negative value represents hours before the end of the business day. Select the number of minutes to offset the Days After Base Date value. A negative value represents minutes before the end of the business day.
Minute(s)
Note: You can use both static and dynamic values as Business Calendar values for the Join Timeout. For example, you might use a static number of Days After Base Date and a dynamic number of Hour(s). Note: Designer supports debugging join step timeouts. When using the Trace view in the Process Debugging perspective, you can manually force a join step timeout to debug the way in which the process handles the timeout. See Trace View on page 63.
211
If you selected a COMPLEX join, use the condition editor to specify your join condition. You can use the following operators, which are provided as buttons: ( ) not and or unsynchronizedor
You can also select transitions from other steps in the process from the Transitions list. The condition editor provides buttons that allow you to copy, cut, paste, delete, undo, and redo. Related Topics Join Conditions on page 209 Removing Join Conditions on page 212 Step Transition Sequence on page 199 Configuring Steps on page 129
Related Topics Join Conditions on page 209 Configuring Join Conditions on page 210 Step Transition Sequence on page 199 Configuring Steps on page 129
Subscription Filters
Subscription filters provide the option to limit which instances of a document are able to trigger or join a process, based on the values of specific fields in the subscription document. By default, the Process Developer capability is disabled. Designer displays only basic properties in the Properties view, basic preferences in the Preferences window, and basic functions on the main toolbar. This is Business Analyst mode. In order to see advanced properties, preferences, and functions, you must enable the Process Developer capability. This enables Process Developer mode.
212
When Process Developer mode is enabled, the Process Developer capability is enabled. When Business Analyst mode is enabled, the Process Developer capability is disabled. See Capabilities Preferences on page 26. Tip! When the process editor has focus, select Business Analyst or Process Developer mode using the buttons on the main toolbar. Only one mode can be enabled at a time. These buttons are not available when the process editor does not have focus. In the Process Development perspective using Process Developer mode, and in the Process Debugging perspective, you can define a subscription filter on a subscription document that comes into a receive step. Related Topics Adding Subscription Filters on page 213 Removing Subscription Filters on page 214 Configuring Subscription Filters on page 214 Configuring Receive Steps on page 157
Related Topics Subscription Filters on page 212 Removing Subscription Filters on page 214 Configuring Subscription Filters on page 214 Configuring Receive Steps on page 157
213
Related Topics Subscription Filters on page 212 Adding Subscription Filters on page 213 Configuring Subscription Filters on page 214 Configuring Receive Steps on page 157
Related Topics Subscription Filters on page 212 Adding Subscription Filters on page 213 Removing Subscription Filters on page 214 Configuring Receive Steps on page 157
214
Process Rules
You can use Blaze Advisor to create rules to use in rule steps in your processes. For more information, see Using Blaze Rules with BPM and CAF. To use a Blaze rule in a process 1 In the process editor, right click a rule step and select Launch Blaze Advisor to launch Blaze Advisor. If the rule step is configured with the Blaze repository, project folder, and project, Blaze will open to the project in where that rule is stored. Note: You can also launch Blaze Advisor from the button. 2 Launch Blaze Advisor toolbar
Create or edit the rule in Blaze Advisor. Designer supports the following types of Blaze rule entities for use in processes: Decision Tables Decision Trees Rulesets Functions You may create as many rule entities per project as you wish. Note: The webMethods Blaze Advisor OEM license has a limit of 250 rules per project. Each rule entity may contain multiple rules, each of which counts toward the project total. If you want to use more than 250 rules per project, you must buy a license from FairIsaac. Important! When you create a Blaze Custom Business Object Model to use in a rule entity, you can use any user-defined webMethods Integration Server document type as inputs and outputs, but fields and records can be used only as internal content, not as inputs and outputs. Fields and records are not top-level classes. Blaze Advisor does not filter these objects, and will not prevent you from selecting them for use as inputs and outputs, but your rule entity will not function if you select them. To help you distinguish the objects that should not be used as inputs and outputs, a zzz_ prefix is appended to them. When you generate a webMethods deployment, inputs and outputs are validated, and rule entities that are not properly formed are not deployed. See Using Blaze Rules with BPM and CAF.
Each Blaze project that is associated with webMethods requires a connection to an Integration Server. This connection is used to deploy Blaze rule entities to webMethods, as well as to provide access to the Integration Server documents used in
215
Custom Business Object Models. The Integration Server configuration, with the exception of the password, is stored in the Blaze project properties. On the Properties tab, enter the following information: Property IS Host IS Port User name Use SSL 4 Description Integration Server name Integration Server port The login name to connect to the Integration Server Select true or false from the list. Default is false.
When you finish creating or editing your Blaze rule entity, and you have configured the project to connect to an Integration Server, you generate a webMethods deployment to that Integration Server. While the project that contains the rule entity is open in Blaze, select Tools > Generate webMethods Deployment. When you generate a webMethods deployment to an Integration Server, you are prompted to connect to that Integration Server if you are not already connected. Enter the password and click OK to connect to the Integration Server. Note: Once you have established a connection in a Blaze session, the connection is maintained until you close Blaze Advisor, even if you work on different projects, Custom Business Object Models, or webMethods deployments. All connection information in the Connect to Integration Server window is populated from the Blaze project properties; you must enter only the password. If you want to connect to a different Integration Server, you must edit the Blaze project properties.
In the Entry Point Configuration window, check the boxes in the Use column that correspond to the Blaze rule entities (entry points) you want to deploy to the Integration Server for use as rule services, and click OK. Note: Rule entities that have been deployed previously are automatically redeployed. The Use boxes corresponding to those services are automatically selected, and cannot be deselected. If you no longer want a rule entity to be available on an Integration Server, you must delete it directly from the Integration Server, rather than from Blaze Advisor.
When the rules have been successfully deployed to the Integration Server, Designer displays the Results window, which lists the Blaze projects and the rule services deployed. Note: The default action of a rule entity that expects input but receives none is to return a null value. webMethods rule services do not throw errors or exceptions or warnings when encountering null values that are passed to Blaze rule entities. If you want to handle null inputs to rule entities, you must handle it inside the rule entity itself.
216
Related Topics Configuring Rule Steps on page 141 Using Blaze Rules with BPM and CAF
Correlation Services
Correlation Services are used to allow external documents to join running process instances. Each receive step that can start a new process instance has a Correlation Service property. At least one receive step in a process must be designated Allow this step to start new process instance (a start step). This is set on the General page in the receive steps Properties view. Correlation services are written in webMethods Developer or in the flow service editor in Designer, and establish or match the correlation ID used by a process instance. You build logic into your custom correlation services to determine correlation IDs based on incoming data, and use WmPRT services to store or match these IDs. You can also select a field from your receive document to use as a correlation key. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. Note: For intermediate receive steps, correlation retry behavior is defined in the subscription trigger. See the Publish-Subscribe Developers Guide. See Administering webMethods Process Engine for information about the pub.prt:CorrelationService and pub.prt.correlate:establishCorrelation services. Related Topics Creating Correlation Services on page 217 Specifying Correlations on page 219 Configuring Receive Steps on page 157
217
Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. Refer to the following tables for input and output variables you can use when creating your correlation services. When your correlation service receives control, it is passes the following inputs: Input variable ProcessModelID ProcessModelVersion Description String ID of the process model with which this invocation of the correlation service is involved. String Version of the process model with which this invocation of the correlation service is involved. Note: Because a single correlation service can be associated with steps from more than one process model version, you can use the ProcessModelID and ProcessModelVersion to identify the process model version using the correlation service at run time. LogicalServer String Name of the logical server that is associated with the step in the process model version with which this invocation of the correlation service is involved. In other words, the name of the logical server on which this correlation service is running. Because a single correlation service can be used with steps that execute on different servers, you can use LogicalServer to identify a specific server at run time. ProcessStepID String ID of the step in the process model version with which this invocation of the correlation service is involved (for example, N3). Because a single correlation service can be associated with multiple steps in a process model version, you can use ProcessStepID to identify the specific step at run time. DocumentName DocumentType Document String Name of this document as used in the process model version (for example, OrderDocument). String Name of this document type (for example, orders.sap:OrderDocument). Document The document.
218
Your correlation service should return the following output: Output variable ProcessCorrelationID Description String Conditional. An abstract ID that correlates to the actual process instance ID of the running process. For example: CUSTOMER-0003456977::ORDER-19477593-AR9-1000. All documents bound for the same instance of the process must return the same correlation ID. Similarly, correlation IDs must be unique across all process instances. String Conditional. Flag that indicates whether the correlation ID in ProcessCorrelationID is a conversation ID. A value of...
true false
CorrelateAsTN
Indicates that... ProcessCorrelationID is a Trading Networks conversation ID. Default. ProcessCorrelationID is not a Trading Networks conversation ID.
For more information about the pub.prt:CorrelationService and pub.prt.correlate:establishCorrelation services, see Administering webMethods Process Engine. Related Topics Correlation Services on page 217 Specifying Correlations on page 219 Configuring Receive Steps on page 157
Specifying Correlations
Receive steps that start a new process instance should initiate a correlation. Receive steps that do not start a new process instance should look up a correlation key or service. In both cases, you specify the correlation on the Correlation page in the Properties view of a receive step. To specify a correlation 1 2 In the process editor, select a receive step. On the Correlation page in the Properties view, do one of the following:
Select Not Used to specify no correlation service. Select Field to specify a field from the subscription document as the correlation key. Expand the list to see available fields from which you can select. Select Browse... to open the Choose Service window and locate a service on an Integration Server or in metadata.
219
Select New... to open the New Flow Service window and create a new service on a configured Integration Server. Select View... to open the selected service in the flow service editor.
Note: The View... button is available only when a service is specified in the Service field. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. Related Topics Correlation Services on page 217 Creating Correlation Services on page 217 Configuring Receive Steps on page 157
220
Each step in a process model is associated with a specific Integration Server Name. Designer places the run-time elements associated with a step on the physical server that is mapped to the Integration Server Name for the step. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. Every step generates a type of flow service called a mapping service on its specified Integration Server, using the signature specified in the inputs and outputs. When you build and upload a process, Designer automatically updates the mapping services of all steps to include the current step signatures, and generates mapping services for all steps that do not yet have them defined. See Step Inputs and Outputs on page 187. By default, Designer does not display generated flow services in the Package Navigator view. You can view them by editing the Package Navigator filter. Click Filter contents of Navigator and clear the Hide generated flow services check box in the Choose Elements to Display window. You can also set a preference for this behavior in Window > Preferences > Software AG > Service Development > Package Navigator. See Package Navigator Preferences in webMethods Designer Service Development Help. Processes that you build and upload for execution are not automatically enabled. You can enable them in My webMethods Server. See Monitoring BPM, Services, and Documents with BAM: webMethods Monitor Users Guide for more information on enabling and disabling processes. Alternatively, you can set a preference in Window > Preferences > Software AG > Process Development > Build and Upload to Automatically enable process for execution after build/upload. You can choose to have Designer Always enable your processes, Never enable them, or Prompt you to choose every time. Another Build and Upload preference allows you to have Designer save your process automatically when you build and upload it. You can choose to have Designer Always save your processes, Never save them, or Prompt you to choose every time. When you build a process, Designer displays the Build Report view. The Build Report view shows you the progress of the build, as well as any errors or warnings that may apply, including stack trace lines if you select that preference. When you build and upload an e-form triggered process, it is important to make sure that the Integration Server you are using is configured to use the referenced e-form content repository. If you have set the Designer preference to Automatically enable process for execution after build/upload (see Build and Upload Preferences on page 33), you will also need to have My webMethods Server running. When you build a process that requires metadata, Designer checks to determine whether metadata extraction is in progress. If the metadata extraction is not complete, the generated process could contain incomplete or incorrect information as a result. It is best to generate the process when metadata is not in the process of being extracted. If metadata extraction is in progress when you build, Designer prompts you to choose whether to continue, with the knowledge that the metadata used by the process might not be accurate, or to cancel the process build.
221
Important! Changing a process-wide property, such as renaming a process or a package, results in Designer prompting you to regenerate the process. You can define some quality of service settings when you design a process. These settings are used to determine how a process should execute at run time, allowing you to select a balance of performance, reliability, and monitorability. The Process Engine has built-in triggers to enable, disable, suspend, and resume processes at run time. See Administering webMethods Process Engine for more information. Note: In a clustered environment, after a process is built and the package is sent to other servers in the cluster, the servers need to be restarted. Alternatively, you can reload the PRT package on the servers or run the scanPackage service. Important! Before using Deployer, be sure to do a full regeneration. Related Topics Processes on page 77 Building and Uploading Processes from the Command Line on page 222 Build and Upload Preferences on page 33 Process Audit Database Preferences on page 39 Build Report View on page 62 Quality of Service Settings on page 108 Process Generation on page 225 Step Generation on page 231 Enabling or Disabling Workspace Indexing in webMethods Designer BPM and CAF Workspace Metadata Help
222
The processConfig.xml file is organized as follows: Section <ProcessConfig> <Processes> <Process> Description beginning of process configuration file beginning of the processes section beginning of a single process Each <Process> section contains the process name, process project name, and process file path. If you have more than one process to build and upload, you will need to have more than one <Process> section inside <Processes>. <Integration Server> </Integration Server> <Integration Server> </Integration Server> Each <Integration Server> section contains the Integration Server name, host, port, user ID, and password. It also contains a flag for using SSL, which defaults to false. If a process requires more than one Integration Server , you will need to have more than one <Integration Server> section inside <Process>. Two (2) <Integration Server> sections are included in the configuration file by default. If you need more than two, you can add more. You can add as many <Integration Server> sections as you need for each process. Important! Be sure to remove the example information and any unnecessary sections before you run the utility. </Process> end of a single process If you have more than one process to build and upload, you will need to have more than one <Process> inside <Processes>. One (1) <Process> section is included in the configuration file by default. If you need more than one, you can add more. You can add as many <Process> sections as you need. Important! Be sure to remove the example information and any unnecessary sections before you run the utility. </Processes> end of the processes section
223
Description log directory file path Generated build reports are placed here. File names are appended with a time stamp in the format yyyyMMddHHmmss (for example, 20090503041804 would be 4:18 AM and 4 seconds on May 3, 2009). end of process configuration file
</ProcessConfig>
To build and upload Designer processes from the command line 1 2 3 4 5 Navigate to <Software AG installation directory>\Designer\util\. Open processConfig.xml in an editor. If you have more than one process to build and upload, copy the <Process> section (from <Process> to </Process>) and paste it after </Process> and before </Processes>. For each process you want to build and upload, populate the ProcessName, ProcessProjectName, and Process file path information in the <Process> section. If any of your processes uses more than or fewer than two (2) Integration Server connections, add and remove <Integration Server> sections (from <Integration Server> to </Integration Server>) within the <Process> sections that contain them. For each process you want to build and upload, populate the Name, Host, Port, UserID, Pwd, and UseSSL information in the <Integration Server> sections. Enter the log directory file path in the <logDir> section. Save the processConfig.xml file. Run <Software AG installation directory>\Designer\util\buildUploadProcess.bat.
6 7 8 9
Important! The command line utility does not deploy webMethods CAF task applications associated with task steps in a process model to My webMethods Server. However, it does create Integration Server (IS) services for task steps. Related Topics Processes on page 77 Building and Uploading Processes on page 220 Build and Upload Preferences on page 33
224
Process Generation
Every step generates a type of flow service called a mapping service on its specified Integration Server, using the signature specified in the inputs and outputs. The details of what Designer generates depends on the type of step it is. For activity steps, this depends further on the Step Type property specified on the Implementation page in the Properties view. Further, some steps have two mapping services (subprocesses and referenced processes), and task steps have three. Important! In order for Designer to update process data mapping during generation, you must be connected to the Process Audit Database. Designer names mapping services using the following convention: Step Type Activity Receive Publish Terminate Task Flow Services <Step Label>_MAPPING
<Subprocess Step Label>_MAPPING_Start <Subprocess Step Label>_MAPPING_End PRESUB_<Referenced Process Step Label>_MAPPING POSTSUB_<Referenced Process Step Label>_MAPPING
By default, Designer does not display generated flow services in the Package Navigator view. You can view them by editing the Package Navigator filter. Click Filter contents of Navigator and clear the Hide generated flow services check box in the Choose Elements to Display window. You can also set a preference for this behavior in Window > Preferences > Software AG > Service Development > Package Navigator. See Package Navigator Preferences in webMethods Designer Service Development Help. Important! Designer does NOT validate the existence of document fields referenced by the process during process generation. If a document is edited to remove a field that is used in a subscription filter or a transition condition, generation will still proceed without error. However, this may cause the process to fail to run (in the case of a subscription filter), or to follow an incorrect path (in the case of a transition condition) at run time. See Process Generation Sample 1 on page 226 and Process Generation Sample 2 on page 229 to see examples of a Designer process and what is generated on Integration Server.
225
Related Topics Building and Uploading Processes on page 220 Step Generation on page 231 IS Service Step and Rule Step Generation on page 231 Receive Step Generation on page 235 Referenced Process Step Generation on page 236 Reply Step Generation on page 237 Publish Step Generation on page 237 Subprocess Step Generation on page 238 Task Step Generation on page 239 Terminate Step Generation on page 240 Web Service Step Generation on page 241 Configuring Processes on page 78
226
a generated flow service for the IS service type activity step: <InvokeService Step Label>_MAPPING = InvokeService_MAPPING a generated flow service for the receive step: <ReceiveDocument Step Label>_MAPPING = ReceiveDocument_MAPPING 3 generated flow services for the task step: <Task Step Label>_MAPPING_InputMapService = Task_MAPPING_InputMapService <Task Step Label>_MAPPING_OutputMapService = Task_MAPPING_OutputMapService <Task Step Label>_MAPPING_QueueTask = Task_MAPPING_QueueTask a transition trigger for version 1 of the process on this Integration Server Name: transitionTrigger The process uses a second Integration Server Name called SecondIntegrationServerName, so Designer also created a folder for it under the ProcessName_1 folder. The publish step (PublishDocument) runs on the second Integration Server Name, and Designer generated the following in the SecondIntegrationServerName folder: a generated flow service for the publish step: <PublishDocument Step Label>_MAPPING = PublishDocument_MAPPING a transition trigger for version 1 of the process on this Integration Server Name: transitionTrigger Generating Version 2 When Designer generated version 2 of the process, the package (ProcessProjectName), containing the Integration Server Name folder (Default) and the subscription trigger (subscriptionTrigger) used for all versions of the process were already there. Designer generated the ProcessName_2 folder for the second version of the process using ProcessName_1 as a template. Designer generated a new folder for the first Integration Server Name for the process version (Default) under the ProcessName_2 folder, and then copied all the transition triggers and generated flow services that version 1 of the process used, making adjustments for any changes that were made in version 2. It follows the same procedure for creating the second Integration Server Name folder, SecondIntegrationServerName, and copies the transition trigger and generated flow service from version one of the process, again making adjustments for any changes that were made in version 2. Designer updates existing mapping services of all steps to include the current step signatures, and generates mapping services for all steps that do not yet have them defined. See Step Inputs and Outputs on page 187.
227
InvokeService
Task
228
PublishDocument_MAPPING transitionTrigger
For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Related Topics Process Generation on page 225 Process Generation Sample 2 on page 229
229
2 generated flow services for the subprocess step: <Subprocess Step Label>_MAPPING_Start = Subprocess_MAPPING_Start <Subprocess Step Label>MAPPING_End = Subprocess_MAPPING_End a transition trigger for version 1 of the process on this Integration Server transitionTrigger Designer Process ParentProcessName
ReceiveDocument Subprocess
ReferencedProcess_ProcessName
InvokeService
For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Related Topics Process Generation on page 225 Process Generation Sample 2 on page 229
230
Step Generation
Designer requires a connection to the Process Audit Database in order to update process data mapping. Each step has its own flow service. Related Topics IS Service Step and Rule Step Generation on page 231 Receive Step Generation on page 235 Referenced Process Step Generation on page 236 Reply Step Generation on page 237 Publish Step Generation on page 237 Subprocess Step Generation on page 238 Task Step Generation on page 239 Terminate Step Generation on page 240 Web Service Step Generation on page 241 Process Generation on page 225
231
The following table lists each run-time element that Designer generates for steps associated with an Integration Server, and describes how process and step properties affect what Designer generates: Generated item package Property Type process Property Package Name How Designer uses the property in generation Designer places all generated run-time elements for the process model in the package that you specify. If you specify a package that does not currently exist, Designer creates it. If you do not specify the Package Name property, Designer uses the Process Name property as the name of the package to hold the generated run-time elements. The Process Name property specifies the name of the process. If the name that Designer is to use (either from the Package Name or Process Name) contains non-ASCII characters (e.g., multibyte characters), Designer cannot use the name you specify for the package. In this situation, Designer uses the value it defines for the Process ID property. Designer creates an Integration Server folder in the package with the Process Name and the string from the process Version property appended at the end with an underscore. If Process Name contains non-ASCII characters (e.g., multibyte characters), Designer cannot use the name for this folder. In this situation, Designer uses a Punycoded version of the Process ID.
process
Process Name
process
Process ID
process
Process Name
process
Process ID
232
How Designer uses the property in generation Designer creates one Integration Server folder named for each Integration Server Name referenced in the process, per process version. Designer places the Integration Server folders for Integration Server Names in the Integration Server folder for the process. Important! The names you define for Integration Server should use ASCII characters. Process generation can fail on the Integration Server when Integration Server names contain multibyte characters. See Integration Servers Preferences in webMethods Designer Service Development Help.
subscription trigger
step
Designer creates one subscription trigger for each Integration Server Name that is referenced in the process and places the trigger in the Integration Server folder for the corresponding Integration Server Name. The subscription trigger applies to all versions of the process. If you change the subscription document and build a new version of the process, all previous versions of the process are invalidated, and cannot be run. The subscription trigger is created using the subscription documents specified on all of the receive steps in the process, along with the specific filters put on those receive steps.
233
How Designer uses the property in generation Designer creates one transition trigger for each Integration Server Name in each version of the process and places the trigger in the Integration Server folder in the process folder for the process version. The transition trigger handles all of the internal process transition documents published by the Process Engine. Each trigger contains filter conditions to only subscribe to documents that apply to the specific steps that run on its Integration Server. Since each version of the process may contain different steps (with steps added or deleted), there must be a different transition trigger for each version to ensure the Process Engine can run multiple versions concurrently.
flow services
step
Label
Designer creates one or more flow services for each activity, receive, publish, and terminate step. Designer names receive step mapping services using the following convention: <Step Label>_MAPPING. Note: The first time you edit a steps data mapping, Designer creates a flow service (mapping service), which you can access from the steps Inputs / Outputs page in the Properties view, or by right-clicking the step and selecting Edit Data Mapping from the context menu.
step
Service
If you specify the Service property, when a mapping service is created for the step, it includes an INVOKE flow operation to invoke the service you specify. If you do not specify the Service property, Designer generates an empty flow service.
234
Generated item
How Designer uses the property in generation By default, Designer places the generated flow service in the Integration Server folder it creates for the Integration Server Name associated with the step. Designer creates one Process Engine script for each Integration Server Name referenced in the process model. It places all process run-time scripts in the config\wmprt directory of the package.
step
For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Related Topics Process Generation on page 225 Step Generation on page 231 Receive Step Generation on page 235 Referenced Process Step Generation on page 236 Reply Step Generation on page 237 Publish Step Generation on page 237 Subprocess Step Generation on page 238 Task Step Generation on page 239 Terminate Step Generation on page 240 Web Service Step Generation on page 241 Configuring IS Service Steps on page 132 Configuring Rule Steps on page 141
235
Related Topics Process Generation on page 225 Step Generation on page 231 IS Service Step and Rule Step Generation on page 231 Referenced Process Step Generation on page 236 Reply Step Generation on page 237 Publish Step Generation on page 237 Subprocess Step Generation on page 238 Task Step Generation on page 239 Terminate Step Generation on page 240 Web Service Step Generation on page 241 Configuring Receive Steps on page 157
236
Publish Step Generation on page 237 Subprocess Step Generation on page 238 Task Step Generation on page 239 Terminate Step Generation on page 240 Web Service Step Generation on page 241 Configuring Referenced Process Steps on page 150 Modeler to Designer Conversions on page 94
237
If the input and the output documents are named identically AND contain the same structure (the same fields), no mapping is required. Otherwise, you must map fields manually. However, field names that match are automatically mapped for you. Note: Publication documents may have required fields. If this is the case, these fields must have values at run time in order for the document to be published successfully. For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Related Topics Process Generation on page 225 Step Generation on page 231 IS Service Step and Rule Step Generation on page 231 Receive Step Generation on page 235 Referenced Process Step Generation on page 236 Reply Step Generation on page 237 Subprocess Step Generation on page 238 Task Step Generation on page 239 Terminate Step Generation on page 240 Web Service Step Generation on page 241 Configuring Publish Steps on page 170
238
Related Topics Process Generation on page 225 Step Generation on page 231 IS Service Step and Rule Step Generation on page 231 Receive Step Generation on page 235 Referenced Process Step Generation on page 236 Reply Step Generation on page 237 Publish Step Generation on page 237 Task Step Generation on page 239 Terminate Step Generation on page 240 Web Service Step Generation on page 241 Subprocesses on page 180 Configuring Subprocess Steps on page 182
239
For each task step, Designer generates 3 flow services: Flow service <Task Step Label>_MAPPING_InputMapService Description Allows you to map process data from the step to the data that the underlying task expects, using Designer or Developer. If the task step inputs match the task inputs, no mapping in this flow is required. Queues the task step in the Task Engine. Allows you to map from the outputs of the task in the Task Engine to the process step outputs. If the task outputs match the task step outputs, no mapping in this flow is required.
For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Related Topics Process Generation on page 225 Step Generation on page 231 IS Service Step and Rule Step Generation on page 231 Receive Step Generation on page 235 Referenced Process Step Generation on page 236 Reply Step Generation on page 237 Publish Step Generation on page 237 Subprocess Step Generation on page 238 Terminate Step Generation on page 240 Web Service Step Generation on page 241 Configuring Task Steps on page 136
240
For more information on data mapping in Developer, see Developing Integration Solutions: webMethods Developer Users Guide. For more information on data mapping in Designer, see Mapping Data in Flow Services in webMethods Designer Service Development Help. Related Topics Process Generation on page 225 Step Generation on page 231 IS Service Step and Rule Step Generation on page 231 Receive Step Generation on page 235 Referenced Process Step Generation on page 236 Reply Step Generation on page 237 Publish Step Generation on page 237 Subprocess Step Generation on page 238 Task Step Generation on page 239 Web Service Step Generation on page 241 Configuring Terminate Steps on page 174
241
Publish Step Generation on page 237 Subprocess Step Generation on page 238 Task Step Generation on page 239 Terminate Step Generation on page 240 Configuring Web Service Steps on page 146
Process Versions
Each Designer process has a Version, displayed in the Properties view of the process. Upon initial creation, the process version is 1. You can create a new process version. Important! Changing a process-wide property, such as renaming a process or a package, results in Designer prompting you to regenerate the process. Important! The Version field must not exceed 50 characters. When you create a new version of a process, you can then upload it to the Process Audit Database for analysis or build it and upload it to Integration Server for execution. Upload for Analysis Only Build and upload for execution Both uploads (for analysis, and for execution) insert information about the process into the Process Audit metadata tables, for viewing in My webMethods Server. Process Audit Table
WMPROCESSDEFINITION
Process Information Uploaded Process name, ID, description, version QOS settings, type (BAM or BPM), and enablement status Step labels, IDs, coordinates The image for display in My webMethods Server Name and coordinates of transitions Custom logged fields
Also, for BPM-executable processes, Designer uploads information about what was last built (generated) to the WMGENERATIONRECEIPT table. This information is used by webMethods Deployer for use in moving a process from one environment to another. Related Topics Creating New Process Versions on page 243
242
Releasing New Process Versions on page 244 Building and Uploading Processes on page 220 Build and Upload Preferences on page 33 Build Report View on page 62 Process Audit Database Preferences on page 39 Modeler to Designer Conversions on page 94
243
KPIs
KPIs (Key Performance Indicators) are quantifiable measurements that reflect critical success factors of a company, department, or project. In webMethods BAM, KPIs are defined by dimensions, facts, and hierarchies. A KPI is related to a hierarchy, which is related to a group of dimensions, which is related to a fact. For example, a KPI might be comprised of: Order Total (fact) per customer (dimension) per region (dimension) Dimensions are string fields used to categorize data in order to enable users to answer business questions. Commonly used dimensions are customer, product, promotion, channel, and time. Hierarchies are groups of dimensions that show relationships among different dimensions. For example, a customer (dimension) is part of a region (dimension). Facts are integer fields or decimal fields that contains data such as sales (units sold) and profits. For example, an Order Total is a fact. KPIs compare facts with dimensions. In Designer, you can: define step-level KPIs define dimensions for step-level and process-level KPIs assign dimensions to process-level and step-level KPIs
244
remove dimensions from KPIs delete dimensions upload KPIs when you build and upload a process for execution upload KPIs explicitly (without building and uploading a process for execution) configure preferences for uploading KPIs configure Optimize Server preferences for uploading KPIs Related Topics Dimensions on page 245 Defining Dimensions on page 246 Process-Level KPIs on page 248 Step-Level KPIs on page 248 Uploading KPIs to Optimize on page 251 Build and Upload Preferences on page 33 Optimize Server Preferences on page 38
Dimensions
A dimension is a string field that is used to categorize data in order to enable users to answer business questions. Commonly used dimensions are customer, product, promotion, channel, and time. For example, each sales channel of a clothing retailer might gather and store data regarding sales and reclamations of their clothing assortment. The retail chain management can analyze the sales of its products across all stores over time and help answer questions such as: What is the effect of promoting one product on the sale of a related product that is not promoted? What are the sales of a product before and after a promotion? How does a promotion affect the various distribution channels? Related Topics KPIs on page 244 Defining Dimensions on page 246 Deleting Dimensions on page 247 Removing Associated Fields from Dimensions on page 247
245
Defining Dimensions
Once you have defined a KPI, you define dimensions to associate with it. In a given process, a dimension can be used only once. Tip! Although you select a KPI when you define a dimension, you can use any dimension with any KPI.
To define a dimension 1 2 3 4 5 Select a step in the process editor. Click the KPIs page in the Properties view. In the KPIs for <Step Label> section, select a KPI. In the Dimensions section, click Add Dimension. In the Add Dimension window, enter a Dimension Label. Note: Dimension labels must be unique on a given Optimize server. Designer cannot, at design time, detect all the KPI names and dimension labels on the target server. However, if you duplicate a KPI name or dimension label in a process, generation of the process produces a warning. 6 7 Click Add Association to browse for an Associated Field for the new dimension.
In the Choose Field window, click the output field with which you want to associate the dimension, and then click OK. Note: When you associate an output field with a KPI or a dimension, Designer automatically adds the field to the Logged Fields page in the Properties view. Designer does not, however, automatically remove an output field from the Logged Fields page in the Properties view if you remove it from a KPI or dimension.
Related Topics Removing Dimensions from Step-Level KPIs on page 251 Removing Associated Fields from Dimensions on page 247 Deleting Dimensions on page 247 Dimensions on page 245 Uploading KPIs to Optimize on page 251 Logging Step Inputs and Outputs on page 192
246
Deleting Dimensions
You can delete dimensions you defined. Deleting a dimension removes it from all KPIs that use it. To delete a dimension 1 2 3 4 5 Select a step in the process editor. Click the KPIs page in the Properties view. In the KPIs for <Step Label> section, select a KPI. In the Dimensions section, select the Description field of a dimension. Click Delete Dimension.
Related Topics Removing Dimensions from Step-Level KPIs on page 251 Removing Associated Fields from Dimensions on page 247 Defining Dimensions on page 246 Dimensions on page 245
Note: When you remove an association of an output field from a dimension or a KPI, Designer does not remove the field from the Logged Fields page in the Properties view. Related Topics Removing Dimensions from Step-Level KPIs on page 251 Defining Dimensions on page 246 Deleting Dimensions on page 247
247
Process-Level KPIs
Process-level KPIs apply to the process as a whole. Designer includes the following predefined process-level KPIs on the Auto Generated tab of the KPIs page in the Properties view of a process: Volume Cycle Time Error Count For each of these, Name is automatically populated and read-only. You can enter a Description for documentation purposes. The other fields displayed are not available for process-level KPIs. Related Topics KPIs on page 244 Dimensions on page 245 Step-Level KPIs on page 248
Step-Level KPIs
Step-level KPIs apply to a step in a process. You can define as many step-level KPIs as you want for a given step. KPIs cannot be reused in multiple steps; each step has its own KPIs. You can view the KPIs included in an open process by using the Outline view. Click a KPI nested under a step and click it. The step that contains the KPI is highlighted in the process editor. Related Topics Defining Step-Level KPIs on page 249 Modifying Step-Level KPIs on page 250 Deleting Step-Level KPIs on page 250 Modifying Step-Level KPIs on page 250 Removing Associated Fields from Dimensions on page 247 Removing Dimensions from Step-Level KPIs on page 251 Outline View on page 43
248
Add dimensions for the KPI (see Defining Dimensions on page 246) or select the check boxes corresponding to existing dimensions. A dimension must have an associated field to be used in a KPI. Important! For any one step, all the associated fields for all facts and dimensions must be fields that are contained in the same document. Different steps in a process can use different documents, so long as any one step uses fields from only a single document.
249
Related Topics Step-Level KPIs on page 248 Modifying Step-Level KPIs on page 250 Deleting Step-Level KPIs on page 250 Defining Dimensions on page 246 Removing Associated Fields from Dimensions on page 247 Removing Dimensions from Step-Level KPIs on page 251 Uploading KPIs to Optimize on page 251 Logging Step Inputs and Outputs on page 192
Related Topics Defining Dimensions on page 246 Deleting Dimensions on page 247 Defining Step-Level KPIs on page 249
250
Removing Associated Fields from Dimensions on page 247 Removing Dimensions from Step-Level KPIs on page 251
251
Important! KPI names and dimension labels must be unique on a given Optimize server. Designer cannot, at design time, detect all the KPI names and dimension labels on the target server. However, if you duplicate a KPI name or dimension label in a process, Designer warns you of this when you upload KPIs, whether when building and uploading a process for execution, or when uploading KPIs explicitly (without building and uploading a process for execution).
To upload KPIs to Optimize when building and uploading a process for execution 1 2 Configure an Optimize server in Optimize Server preferences. Configure the Automatically Upload KPIs on Build option in Build and Upload preferences to either Always (if you dont want a prompt) or Prompt (if you do). The default setting is Prompt. Open a process that contains KPIs. File > or click Build and upload for execution on the main toolbar. Build and upload for execution
3 4
To upload KPIs to Optimize explicitly (without building and uploading a process for execution) 1 2 3 4 Configure an Optimize server in Optimize Server preferences. Configure the Prompt to Upload KPIs option in Build and Upload preferences to either Never (if you dont want a prompt) or Always (if you do). The default setting is Always. Open a process that contains KPIs. File > or click Upload KPIs on the main toolbar. Upload KPIs
Related Topics KPIs on page 244 Building and Uploading Processes on page 220 Build and Upload Preferences on page 33 Optimize Server Preferences on page 38
252
Process Debugging
Debugging a process involves running it with tools that allow you to inspect the way it behaves with real data, and to see how that data behaves as it travels through the pipeline. The Process Debugging perspective includes three views that provide this functionality: Process Debugging View Trace view Description The Trace view allows you to control your navigation through steps, and to see the progress of those steps, including errors, during a process debugging session. You can select a line that corresponds to a step in the Trace view to inspect the corresponding step pipeline data output in the Step Data view. You can also view and capture exception data. See Trace View on page 63. The Breakpoints view allows you to set stopping points, or breakpoints, in the process when you perform a run or step trace debugging session. See Breakpoints View on page 68. The Step Data view displays the pipeline data associated with the output of the step selected in the Trace view. You can expand the information displayed to see more details of the data from the pipeline into the selected step, providing an opportunity to troubleshoot the behavior of the overall process at the step level. You can also copy the pipeline of one or more steps. See Step Data View on page 67.
Breakpoints view
When you debug a process, you have two primary options. You can run the process, optionally stopping at breakpoints, which is called run tracing. You can also choose to manually control the process execution, step by step, which is called step tracing. Both run tracing and step tracing use the Trace view to display the progress of the process by step, and both allow you to see more details of a steps execution in the Step Data view. A debugging session requires that your process starts with a receive step with an IS document input. Process Debugging supports subscription, simple service (Web service), and JMS receive protocols. When you start debugging a process, Designer prompts you to enter data for the receive step in a form. You can save the entered data in XML form for reuse, and load the XML from a file in subsequent sessions. When you debug a process that uses a JMS receive step, the Process Debugging session checks to ensure the JMS connection alias exists and is enabled before attempting to debug the process. For more information about configuring receive steps, see Configuring Receive Steps on page 157.
253
Process Debugging also requires that you save, build, and upload your process to the Process Audit Database for execution before debugging it. When Designer uploads a built process, it does not automatically enable it. You can set a preference to have a process in a debugging session automatically enabled, and another preference to automatically disable it again when you have finished the debugging session. Process Debugging supports the tracing of subprocesses and referenced processes that are contained in the process being debugged. You can also choose to step over them, running all the steps in the collapsed container, during the debugging session. Debugging task steps in your process will automatically prompt you to enter task input in an HTML form. When you submit the required information (for example, mark a task as Completed), Designer resumes debugging the process. The debugging session will wait a specified number of seconds before concluding that the task will not be marked as Completed. If the specified number of seconds expires, the debugging session will time out, and end. You can set a preference for the number of seconds Designer should wait before it times out. The Process Debugging session makes annotations to the process in the process editor to provide visual indicators of its progress. Step transition lines are colored, and steps are highlighted as follows: Annotation light blue transition line light grey transition line green transition line yellow transition line red transition line green step outline light green step outline Description Potential next transition Next transition to be taken Successfully completed transition Dead path Unsuccessful (error) transition Most recent step completed Potential next step(s) to be taken
Note: If there are multiple potential next transitions or next steps, they are all colored or outlined accordingly. You cannot select which transition will be taken next; the Process Debugging session determines the next transition taken. Related Topics Debugging Processes on page 255 Trace View on page 63 Step Data View on page 67 Breakpoints View on page 68 Process Debugging Preferences on page 40 Process Development Perspectives on page 69
254
Debugging Processes
When you debug a process, you can choose to manually step through it, or to run through it. You control the type of debugging session with the buttons on the Trace view toolbar. To debug a process 1 2 Switch to the Process Debugging perspective if it is not showing: Window > Open Perspective > Process Debugging. Open a Designer project for debugging. The process must be saved, built, uploaded, and enabled. Tip! You can automatically enable processes for debugging in Process Debugging preferences. See Process Debugging Preferences on page 40 for instructions. 3 4 Select the Breakpoints view, and set breakpoints corresponding to the steps in the process at which you want to stop, or break. Click Debug Selected Process to start the debugging session.
Tip! You can also use the Alt+F11 key combination to start a debugging session. For more key combinations, see Using Keyboard Shortcuts on page 23. Tip! When an Integration Server connection is required but not available, Designer prompts you to connect. If no Integration Server is configured, Designer prompts you to configure one so you can connect to it. 5 A debugging session begins with a receive step and an Integration Server document. Provide data for the Integration Server document in the Enter Input for <fully qualified trigger document name> window, or click Load Inputs to load the data from an XML file, and click OK. Continue run tracing to breakpoints or stepping through the process. Note: After input data is provided, the debugging session automatically proceeds to the next step in the process. A breakpoint set at that step is not respected when you run trace from that point, since the debugging session has already stopped there. If there are two or more process branches, and breakpoints at two or more possible second steps in the process, the breakpoints other than the one at the step where the debugging session stops automatically after its initial start are respected during a run trace when the session returns to take one or more of the alternate paths.
255
When the debugging session has finished, Designer displays a message on the last line of the table in the Trace view: Status Indicator (green square) (yellow triangle) (red circle) Message Process <process name> is done. Process <process name> is done with warnings. Process <process name> is done with errors.
To cancel the debugging session and clear the process editor of transition and step highlighting and transition line color alterations made by the debugging session, click the red square button above the table in the Trace view. Note: During a debugging session, a timeout might occur simply due to the longrunning nature of a typical debugging session as the user steps through the process and examines data. Such a timeout would probably be meaningless, and would essentially mark the process as done, rendering the debugging session useless. You should avoid setting any join or process timeouts when using Process Debugging.
The Process Debugging session can monitor Designers memory usage while you are debugging, and prompt you to end the debugging session if the memory use exceeds a set limit. See Process Debugging Preferences on page 40. If a process contains a task step that has not been implemented with a task, such that there is no Task ID available at run time, the Process Engine does not attempt to enqueue the step; instead, the empty task step is marked as complete, just as empty steps of other types, and the process continues. This allows for greater iterative testing and debugging, since the task can be added and re-generated at any time during the process development. The Process Debugging session steps over the empty task step during a run trace. Note: During a debugging session, all receive steps are treated as if they are part of the same process instance. As a result, in some cases, an unsynchronized OR join step may fail. Specifically, a process instance with an unsynchronized OR join step will fail if an additional debugging track into the join step starts from a different receive step. Related Topics Process Debugging on page 253 Trace View on page 63 Step Data View on page 67 Breakpoints View on page 68 Process Debugging Preferences on page 40 Process Development Perspectives on page 69
256
Process Simulation
The Process Simulation feature for webMethods Designer provides a mechanism to simulate processes and see details about how they run. By simulating a process, or multiple processes, you can save time, energy, and resources that might otherwise be misspent on deploying solutions that do not fit your business needs. Simulation provides the opportunity for testing and tweaking processes in the design phase, before they ever reach production, or even a test environment. Process simulation enables you to: Discover process bottlenecks Predict process behavior in multiple scenarios Learn about total process cost Understand process resource utilization, including consumables and nonconsumables Compare the behavior (performance, utilization, cost, etc.) of two or more different processes, or of two or more versions of the same process Optimize processes Visualize how processes actually work With a greater depth of process knowledge and behavior, you can make informed iterative changes until you reach the desired simulated result, and ultimately deploy the final version of the process to a production environment. Scenarios Transforming your business process to a simulation requires defining scenarios of attributes for the process. Setting up your scenario for the process model allows you to create a test case for how a process or set of processes will function with particular constraints. Scenarios are defined by: the frequency and the interval of business process instances the length of time each step may be actively processing any resources that your process may use to accomplish its steps Resources Resources can be consumable or non-consumable. Examples of consumable resources are equipment or supplies such as trucks and gasoline. Examples of non-comsumable resources would be a salaried employee or a hired consultant. Resources are defined on a per simulation basis and are available for all processes within a simulation -- meaning that a single pool of a resource is shared. This allows a more sophisticated comprehension of resource contention across a set of processes in an enterprise. Resources are defined by the units allocated for the resource and the units acquired at a
257
particular process step. A consumable resource acquired at a step is used and removed from the set of allocated resources. A non-consumable resource, such as an office clerk, when acquired is not available by other steps until the processing of that step is completed. This means that if you have only one office clerk and the step that requires the clerk is started, the next process instance that arrives at that step will be queued for processing until the first instance requiring the clerk is completed. Costs Resources can also have cost attributes: a flat usage cost for any access which is not based on time OR a fixed cost per time period OR a variable cost per time period which is associated with non-consumable resources or a variable cost without a time period which is associated with consumable resources. Some examples of cost types: Consumable resource with variable cost Fuel is an example of a consumable resource with a variable cost. If fuel costs $3 a gallon, $3 is its variable cost. Every time a unit (gallon) of fuel is used, a cost of $3 is applied. Non-consumable resource with variable cost per period An employee paid hourly is an example of a non-consumable resource with a variable cost per period. The employee's hourly pay may be defined as a variable cost of $30 per hour. Non-consumable resource with fixed cost A salaried employee is an example of a non-consumable resource with a fixed cost. The employee's annual salary may be defined as fixed cost of $30,000 yearly. By creating scenarios from criteria within your business, you can closely model the behavior, efficiency and results of your process models. Analyzing output from simulations can allow you to: Increase service level Reduce total process cycle time Increase throughput Reduce waiting time Reduce process cost Reduce inventory costs In support of process simulation, Designer provides the Process Simulation perspective, which includes several views that allow you to configure your simulations and interpret their behavior: the Resources view, the Run Settings view, and the Advanced Run
258
Settings view. The Resources view contains Resource and Cost information; these are displayed in the Properties view for a selected resource. The Run Settings view contains Run Settings and Statistics information. The Advanced Run Settings view contains information about Variables, Historical Data, and Optimization. The Optimization page contains additional pages to configure Objective, Decision Variable Limits, Constraints, and Run Options. Additional step configuration is supported in the Properties view for various step types. The Schedule, Scenario, Metrics, and Transition Distribution pages allow you the opportunity to finely tune your simulations. You can create a process simulation directly from an open process, or you can create a new simulation file and then add one or more processes to it. You can create a simulation from an imported XPDL process, and you can create a simulation while importing if the XPDL contains simulation information. See Importing Designer Processes on page 91. In Designers Process Simulation preferences, you can set options for recording animation, automatic switching to the Process Simulation perspective, and the types of gauges displayed during an animated process simulation. The Process Simulation control panel provides additional options for viewing a running simulation, in real time or playback mode. Once you have run a process simulation, you can generate a Process Simulation report that captures detailed information about the scenario simulated, and whose data allows you to create charts, graphs, and other materials based on the results of the simulation. Note: Designer does not extract metadata for process simulations. They do not have references or dependencies. You cannot publish or retract process simulation metadata. Related Topics Process Simulation Help in webMethods Designer BPM Process Simulation Help
259
260