Home

Process Orchestrator for .NET Designer`s Guide

1. 26 6 5 Using a Metastorm BPM Process Code Behind Project 33 0 9 4 JPEOCOSSEVEHISSCIOSSJOIQOF Genie a tecta osaccs hoste udis estt deestccesinsitek do vedio tess 34 Oy RP FOC COUT A SNR TERN ENERO 35 DECLC C SR DNE aE ee eT eer TR NEED PNE EP ee eta 36 02 4 SONS emet et aah i aac rM Ls UK MD aM CE 38 055 Admi OV INS senten M 39 SRM C51 0 RTT 40 ou BO CV CHAI CICS A S 40 ODO TC UITCHLYV CV SION eate a ee due ct de A EE 41 6 5 9 Private member declarations amp Event Handler Initializations 4 6 5 10 Public Accessor Methods Properties essent nennen 43 OSAL CIU SONS NERA TON Cc ms 44 6 6 Metastorm BPM Process Code Behind Example Leere ee eee e eere ee eeeeeene 45 6 7 Configuring Process Metadata Web Service Connection Details 45 OL ed JO COU dtt eam dit teo E TEE E E nexa ens eap diete dea dto tre 46 6 7 2 Process Engine Database Connection Settings esses 46 OF den CHO ec as oct tUe E CX a CAU MELLE sts D e 47 6 7 4 Process Metadata Web Service Configuration Details Dialog sss 47 Un EP VLLL PR M 50 OSA GME OO ct A te he ee 2d 6 8 2 Metastorm Web Service Configuration Details eese 32 0 0 3 JDEDIOV T TOCS e
2. sss 11 dud FTO SEVIS usqve ta cinta as a lI IIS dC OMIC IDE es eee S E ae ee re oe 12 4 1 6 Engine support for Process Orchestrators esses tette 12 Bd AS NEI omo P Game em edema cate mancances 2 4 2 TS IO coo Dein E UR RSC Set 12 42 wWroubieshootmnp Installation m E 17 5 Calling Imported Methods via the Integration Wizard 18 5 1 Publishimp the Library io bei eE ENS NERO ETR NE PER URNRUS 18 5 2 Associating the Library with a Procedure csccssscsssssssssssssscsssscsssscsssscsssscsssscsssscsssscssesees 20 5 3 Calling Imported Methods via the Integration Wizard scccssscssssssssssssscsssssssessssessons 20 5 4 Publishing th Procedir E seis ie Ed 21 5 5 Full built 21 6 Creating Process Events in Visual Studio NET sss 22 V NES Vacilireuillgoeee ec H 23 6 2 Publishing the Process Events Library 44 Leere Leere eere eere seen estne ee eeeeeeaseens 23 6 3 Creating and Publishing Procedures using the Designer e eeeeeeere 24 Oded Cranio QUPPOCQUDIKB ed ote Dl RES 24 03 2 SHXDOSIHS FTOCOSS Events in Desioner jis cities aD eR NOU DNE 24 Metastorm BPM Release 7 6 May 2008 iii Metastorm BPM Release 7 6 6 4 Creating a Metastorm BPM Process Code Behind Project
3. ME TAS TORM Metastorm BPM Release 7 6 Process Orchestrator for NE T Designer s Guide May 2008 Metastorm BPM Release 7 6 Copyrights and Trademarks 1996 2008 Metastorm Inc All Rights Reserved Copyright Notice m Metastorm Metastorm BPM e Work Process Pod Enterprise Process Advantage ProVision The Best Process Wins Proforma Metastorm Knowledge Exchange Metastorm DNA Metastorm Discovery M STAR Insight Envision and Metastorm Enterprise are either registered trademarks or trademarks of Metastorm in the United States and or other countries m Microsoft Outlook SQL Server Windows Vista Active Directory Visual Basic JScript SharePoint BizTalk and IntelliSense are either registered trademarks or trademarks of Microsoft Corporation in the United States and or other countries Adobe is a registered trademark of Adobe Systems Inc Netscape is a registered trademark of Netscape Communications Corporation Other trademarks are the property of their respective owners Disclaimer Every effort has been made to ensure the accuracy of the features and techniques presented in this publication However Metastorm accepts no responsibility and offers no warranty whether expressed or implied for the accuracy of this publication No part of this publication may be reproduced stored in a retrieval system or transmitted in any form or by
4. Options Metastorm BPM Release 7 6 May 2008 51 Metastorm BPM Release 7 6 6 8 2 Metastorm Web Service Configuration Details Each of the features requires a connection to the process metadata service The solution Add in attempts to auto connect to a process metadata xml file which is loaded on first attempt If none of the features work you can reconfigure the web service to a valid connection To view the Web Service Configuration details 1 From the View menu select Metastorm Process Events Web Service Details 2 The Web Service Configuration Details dialog is displayed Web Service Configuration Details Default Service Proxy Details Use Proxy URL http localhost Metastorm Common Processl Type ntegrated Windows Authentication wv Ec E Doo Default Configuration Figure 26 Web Service Configuration Details Dialog This screen displays a list of available Metastorm Process Metadata Services It is assumed that the web service is installed on the same machine as the engine 6 8 3 Deploy Process The Deploy option requires the project to be built The assembly files are then copied from the project s bin build folder to the Deployment Target Path The default paths are C Program Files Metastorm BPM Engine donetbin or C Program Files Metastorm BPM Engine donetlib The assembly cache uses the engine defined in the Metadata Service Configuration file The Deploy option stops and restarts the engine if it r
5. StageFirst chr32 stage new Stage this m StageFirst chr32 stage Name First stage this m ActionFirst chr32 actionFromStageBlankForms new ACLtIOID 3 this m ActionFirst chr32 actionFromStageBlankForms UEqIrSpSOnr3o2 9 Lom When Action Completed this m ActiohnErrst chr52 actrlonBbromsStageBlankBPorms whenAction Completed new BaseObject FinishEventHandler this ActionFirst chr32 actionFr omStageBlankFormsWhenActionCompleted When Action Started this m ActionFirst chr32 actionFromStageBlankForms WhenAction Started new BaseObject StartEventHandler this ActionFirst chr32 actionFro mStageBlankFormsWhenActionStarted When Stage Completed this m StageFirst chr32 stage WhenStageCompleted new BaseObject FinishEventHandler this StageFirst chr32 stageWhen otageCompleted When Stage Started this m StageFirst chr32 stage WhenStageStarted new BaseObject StartEventHandler this StageFirst chr32 stageWhensS tageStarted When Form Loaded this m FormForml WhenFormLoaded new BaseObject StartEventHandler this FormFormlWhenFormLoaded When Form Saved this m FormForml WhenFormSaved new BaseObject FinishEventHandler this FormFormlWhenFormSaved 42 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide 6 5 10 Public Accessor Methods Properties public bool StageFirst chr32 stageWhenStageStarted return true public bool StageFirst_chr32_stageWhenStageC
6. any means electronic mechanical recording or otherwise without the express written permission of Metastorm Inc The information in this document is subject to change without notice Metastorm Inc email inquiries 9 metastorm com http www metastorm com ii May 2008 Metastorm Inc 2006 Contents Metastorm BPM Release 7 6 Process Orchestrator for NET Designer s Guide Table of Contents 1 UNTO GUGUOM tT R 5 LI PACH OMY IMS sectes E cateea i RARE MN RO EM A DEM ara ts 5 L2 Ternimoloby aote eei i o e ta e re teet pei Ds Inde 6 1 3 Getting Furmher Pri C eri SEU e 6 What is the Metastorm Process Orchestrator for NET 8 Using the Process Orchestrator for NET ecce 9 3 1 Importing Methods via the Integration Wizard 4 eee eee eerte rete ee eese eene eesase 9 3 2 Visual Studio NET Integration 1 oec iceseci ses esos cesis epe ert ob ro simis 10 4 Setting Up the Process Orchestrator for NET cessas 11 4 1 Supported Environments and Installation Prerequisites 11 dao ANE TACUO eset testo tbt Du vase asa aaa eit Dae I eis lI 4 1 2 Enterprise Component Library for NET Server Components sss lI 4 1 3 Enterprise Component Library for NET Sample Client
7. construct a variable name and property name both of which must exist in the corresponding class Af At invocation time if the Visual Studio 2005 developer has set to WarnMode StopOnError and there is a procedure that has not been resynchronized the procedure will fail to execute Steps to Resynchronize a Project To resynchronize a project 1 Open Solution Explorer 2 Right click the Project Name 3 Select Resynchronize Project 4 The Resynchronize Project dialog is displayed Metastorm BPM Release 7 6 May 2008 55 Metastorm BPM Release 7 6 Resynchronize Project icd Flight Airports C Mark redundant event handler methods as Obsolete Figure 28 Resynchronize Project dialog 5 Check Mark redundant event handler methods as Obsolete as required 6 Click the Resynch button 7 Rebuild the project 8 Redeploy the project L If the Procedure no longer exists the NET Developer will be warned that a project in a solution is no longer valid If a Procedure is already in use it may be necessary to stop the process engine before redeploying the process d By default clicking the Resynch button automatically saves the solution The Start Page recent projects are not currently supported with resynchronization The VS2005 developer will need to refresh their events after loading a project using the Start Page Renaming a Map If the map has been renamed a new code behind unit is created 56 Ma
8. is defined as http lt Web Server Name gt lt Metastorm Virtual Folder Name gt A gt This option is only available is the user selected ASP NET Web Parts in the Installation Screen 13 Click on the Next button The Database Setup screen is displayed Database Server Select DEMS and authentication method For Ehe ASP MET Web Parks sample Select the database server to install the 45F NET Web Parts Beer House sample database ka From Ehe list below or click Browse bo see a list of all database servers Database Server Connect using 5 Windows authentication credentials of current user CO Server authentication using Ehe Login ID and password below Attach Beer House sample to local DEMS Figure 6 Metastorm Process Orchestrator Database Server Screen 14 Click on the Next button 16 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide The Ready to Install screen of the Process Orchestrator for NET installation is displayed ig Metastorm Process Orchestrator for NET Installation Wizard E METASTORM Ready to Install the Program ME The wizard is ready to begin installation Click Install to begin the installation IF vau want to review or change any of your installation settings click Back Click Cancel to exit the wizard ENTM Figure 7 Metastorm Process Orchestrator Ready to Install Screen 15 Click the Install button The Process Orchestrator
9. library containing a script with these functions The NET Activator saves the library in XEL format amp For information on using the Metastorm NET Activator to import methods from NET assemblies into the Metastorm Designer refer to the NET Activator Help This can be accessed from the NET Activator 3 A Process Designer publishes the library 4 A Process Designer can use functions exposed by NET Assembly components from within Metastorm procedures by including the created library within their procedures If the NET Assemblies are Metastorm BPM Release 7 6 May 2008 9 Metastorm BPM Release 7 6 Stateless the Integration Wizard can be used Stateful Process Designers can use these assemblies directly from the Metastorm Designer Script Editor A skeleton script including class declaration and instantiation is available but scripting of the method calls may need to be modified manually Lf Stateless assemblies are those in which a single method can be called without requiring any previous methods to be called Ld Stateful assemblies are those which require a number of method calls An example would be if you were to receive a result back from a rules engine pass the value into the assembly and then perform other actions using different functions in the assembly 3 2 Visual Studio NET Integration A Visual Studio NET developer writes process events which are triggered by events exposed in the Designer
10. must attach to process using the standard Visual Studio Attach to Process option 6 8 5 Resynchronizing a Project When a process designer changes a procedure and republishes the procedure the Visual Studio 2005 developer should resynchronize a project to include or exclude any methods that may have changed The Solution Add in Resynchronization obtains a data set from the database and uses it to amend an existing Visual Studio solution which was previously generated by the Process Events Wizard The resynchronization process displays the following information e An updated version of the project against the latest published data e New forms actions or stages events from local or global e Any stages actions forms or maps that have been removed or renamed in the published procedure are marked as obsolete Obsolete stages are not removed from the Metastorm database as stages folders may be on Users To Do Watch list A Metastorm Services Administrator can purge stages that are no longer being used using the purge stages option on a map using the Metastorm Services Manager tool Es For further information on purging stages refer to the Administration Guide There are three conditions that must be met to assume that a code element represents a data set for Stage Form or Action entities past or present e The code element must be a function whose name can be deconstructed into components e These components can be used to
11. public bool lt ObjectType Form gt lt formName gt WhenFormSaved return true Ld Non alphanumeric characters that are accepted by Designer in Form names are replaced with the corresponding character code For example a Form named Process amp Review in Designer will be amended to Process chr32 chr38 chr32 Review in Visual Studio where chr32 space and chr38 ampersand 6 5 5 Admin Forms e Admin Forms are created with their own partial classes with isAdmin set to True e Each form will have Private variable and public accessor methods Private form names are prefixed with m e Variable Names are prefixed with the object type so that the variable is not overloaded Form names private Form m ObjectType Form FormName public Form lt ObjectType Form gt lt FormName gt get return m_ lt ObjectType Form gt lt FormName gt m_ lt ObjectType Form gt lt FormName gt value Events related to forms will be in the format Start Event public bool lt ObjectType Form gt lt FormName gt WhenFormLoaded return true Finish Event public bool lt ObjectType Form gt lt formName gt WhenFormSaved return true Metastorm BPM Release 7 6 May 2008 39 Metastorm BPM Release 7 6 6 5 6 Actions e Each action has private variable and public accessor methods Private form names are prefixed with m_ e Variable Names are prefixed with the object type e Creation actions do not have preceding sta
12. server is bypassed If checked requests to local Internet resources local address when calling local resources do not use the proxy server Local requests boolean are identified by the lack of a period in the URI as in http webserver or access the local server including http localhost http loopback or http 127 0 0 1 If not checked all Internet requests are made through the proxy server Buttons E SEEN NMEMNMNEANM Connect This button checks if the defined web service exists and uses this connection An error message is displayed if the web service fails to connect Af The Connect button is only available when using the Process Events Solution Support Add in In the wizard the web service connection is tested when the user clicks Next Update This button updates the displayed web service configuration details Delete This button deletes the displayed web service configuration details 6 8 Add in Process Events is distributed with a Process Events Solution Support Add in The Add in provides Visual Studio 2005 support for Metastorm BPM Code Behind Process Events Solutions and contains the following menu options e Metastorm Web Service Configuration Details e Deploy Process e Debug With Process 50 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide e Resynchronizing a Project e Solution Browser When Process Events is installed the Add in is stored i
13. 5 1 Publishing the Library The NET Activator produces a Metastorm library containing an Integration Wizard collection To publish the library 1 Access the Metastorm Designer 2 Open the library by selecting the File menu then the Open menu item 3 View the Integration Wizard collection if required as follows 18 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide i Select the File menu then the Library Properties menu item Es TestClass3 Properties I lal x General LDAF Aliases Integration Wizard Collection Owrer Password Pau Pascal Company M etastorm Inc Description Last saved 31 07 2006 15 23 55 Cancel Help E Figure 8 Library Properties ii Click on the Integration Wizard Collection tab d TestClass3 Properties ilBl xl General LDAP Aliases Integration Wizard Collection H TestAssembly TestinStringia Test amp ssembly T estlnBaol a Test ssembly T estinDauble a E est amp ssembly T estlnLonag a Cancel Help E Figure 9 Integration Wizard Collection lii Click on the OK button 4 View or edit the scripts containing the imported functions if required as follows i Inthe main Designer window select the View menu then the Scripts menu option ii Click on the Server tab ui Edit a script if required by selecting the script then clicking on the Edit button iv Click on the Close button 5 Publish the li
14. ActionMyCommonActionFromStageMyFirstStage m_ActionMyCommonActionFromStageMyFirstStage value public Dool ActionMyCommonActionFromStageMyFirstStageWhenActionStarted Bpecturm ACTUE public boot ActionMyCommonActionFromStageMyFirstStageWhenActionCompleted fetu rn Cr UE public Action ActionMyCommonActionFromStageMySecondStage get return m_ActionMyCommonActionFromStageMySecondStage Metastorm BPM Release 7 6 May 2008 37 Metastorm BPM Release 7 6 set m_ActionMyCommonActionFromStageMySecondStage value DUES DOG ActionMyCommonActionFromStageMySecondStageWhenActionStarted etur true public Dee ActionMyCommonActionFromStageMySecondStageWhenActionCompleted return true 6 5 4 Forms e Each form will have Private variable and public accessor methods Private form names are prefixed with m e Variable Names are prefixed with the object type so that the variable is not overloaded Form names private Form m_ lt ObjectType Form gt lt FormName gt public Form lt ObjectType Form gt lt FormName gt I get return m_ lt ObjectType Form gt lt FormName gt m_ lt ObjectType Form gt lt FormName gt value Events related to forms will be in the format Start Event public bool ObjectType Form FormName WhenFormLoaded return true 38 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide Finish Event
15. Component Library for NET Usage Guide Component Library for NET Integration Wizard Designer User Manual Process Events This document and the Metastorm Process Events Help accessible from the Process Events wizard Server side scripting with Scripting Developer Guide Jscript NET Table 3 Getting further information Metastorm BPM Release 7 6 May 2008 Metastorm BPM Release 7 6 2 WHAT IS THE METASTORM PROCESS ORCHESTRATOR FOR NET 2 The Metastorm Process Orchestrator for NET provides interoperability between Metastorm processes and services implemented as NET components The Process Orchestrator for NET can be used by a Visual Studio NET developer to e Develop application components as NET Assemblies The Metastorm NET Activator enables methods from NET Assemblies to be stored in an Integration Wizard collection library which when the library is attached to a procedure updates the Integration Wizard in the Metastorm Designer with the methods These methods can then be invoked by Metastorm procedures e Delegate certain process events from within the Designer Then create assemblies using the Metastorm BPM Process Code Behind Project template in Visual Studio to handle the delegated process events In addition NET developers can use the Metastorm Enterprise Component Library for NET to access Metastorm functionality via a component based interface amp For further information on the Metastorm Enterpris
16. D Public Now the function must be to the following format resGet FolderID ScriptEval JScript NET Procedure Name M apName eWork Activator TestClass Invoker Activate TestClas S WVerIsTtOl2 0 0 0 Culture neutral PublickeyToken 0fa3cco4eebf4c8b TestClass eWorkObject get JF Older LD Pub re Metastorm BPM Release 7 6 May 2008 21 Metastorm BPM Release 7 6 6 CREATING PROCESS EVENTS IN VISUAL STUDIO NET Process Events Integration is a method of separating Process Design from event implementation Process events are external events that are created via a wizard that connects Metastorm BPM processes to Visual Studio NET This separates the design and coding processes Processes are setup in Designer and the process event handlers are created using the Designer via the Integration Wizard and Visual Studio 2005 NET Process events setup using Visual Studio 2005 enable a NET developer to develop customized events that respond to Metastorm BPM process events The customized events can be written using C or Metastorm BPM language The people involved in process events are Process Designer the participant who uses the Metastorm BPM Designer to create process maps and delegates NET event handler assembly functionality from a Metastorm BPM process NET Developer the participant who imports a Metastorm BPM process and uses the extended Visual Studio functionality to create NET assemblies containing code to b
17. Events 1 1 Acronyms The following table lists the acronyms used in this guide Dynamic Link Library Metastorm Enterprise Component Library Global Assembly Cache Metastorm BPM Release 7 6 May 2008 Metastorm BPM Release 7 6 Integrated Development Environment Internet Information Services Metastorm XML Library file extension eXtensible Markup Language Table 1 Acronyms 1 2 Terminology The following table lists terms that have specific meanings for this guide NET Activator A tool that allows a System Integrator to create a Metastorm XML Library XEL file which contains an Integration Wizard Collection and a script to expose the functions contained within the Integration Wizard Collection to the Process Designer Metastorm Enterprise Class library that exposes a NET component based interface to Metastorm Component Library for NET functionality Metastorm Code Behind A Visual Studio NET 2005 project that integrates code behind to a Project Metastorm Designer procedure The project is created using Process Events Refer to section 6 Creating Process Events in Visual Studio NET Metastorm Client Application used to access Metastorm processes Metastorm Designer Application used by a Process Designer to design Metastorm processes Metastorm Engine A single Metastorm server process Integration Wizard collection A library that contains an Integration Wizard collection The Integration library Wizard collection c
18. Extensionkval JScript NET Procedure Name MapName Metastorm ProcessEvents HandleExternalEvents DelegateEvents r 9 The process can then be published A This script will run the relevant NET code This function call should not be modified Globally All Process Events can be exposed using the Map property tab of the map This tab contains two options which globally expose process events e Delegate all external events for map e Perform delegated events before local event Metastorm BPM Release 7 6 May 2008 25 Metastorm BPM Release 7 6 Properties Flight Frefix of folder name everbody we Figure 12 Map Properties highlighting Process Events options Delegate all external events for map This is a check box property which defines whether all the events of a process will be delegated to an external NET assembly Local events can still be defined if required When checked this option implies that each event has the External Event Handler script applied to it Perform delegated events before local event This defines when the process engine will invoke the delegated events when all processed events are delegated The default value unchecked performs delegated events after the local event The property is only active if the Delegate all external events for map is checked ff The Process Events Libra ry xel needs to be associated with the procedure for these options to have an effect If the user has also delegat
19. For further information on Process Orchestrator for NET component information refer to the NET Activator Help accessible from NET Activator and Enterprise Component Library for NET Usage Guide and Web Client ASP NET Web Parts Developer Guide Details on Complex Types support can be found in the Designer User Manual 7 Select the components of the Process Orchestrator for NET that you want to install 8 Click on the Next button The Destination Folder screen of the Process Orchestrator for NET installation is displayed 14 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide T3 Metastorm Process Orchestrator for NET Installation Wizard Eg Destination Folder v us METAS En Click Next to install to this folder or dick Change to install to a di t i folder Install Metastorm Process Orchestrator for NET to C Program Files Metastorm BPMI Cancel Figure 4 Metastorm Process Orchestrator Destination Folder Screen 9 If you want to install the Process Orchestrator for NET to a location other than the default location click on the Change button and browse to a new location The Destination Folder screen is only displayed if Metastorm BPM has not been installed 10 Click on the Next button The Connection Setup screen of the Process Orchestrator for NET installation is displayed ig Metastorm Process Orchestrator for NET Release 7 6 Installat
20. able Figure 21 IntelliSense example A All Integration Wizard functions are available in C except functions which run VBScript or JScript NET These functions can be used in Designer in conjuction with SeExecuteExtensionEval 44 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide 6 6 Metastorm BPM Process Code Behind Example The following worked example shows how to populate a dropdown is created in the Designer which contains a list of names 1 Associate Process Events Library xel with procedure 2 Set up text custom variables xtNames xtListOptions 3 Adda dropdown to a form and set the following properties Drop down List options VotxtListOptions Form1 Do This When user loads In the Integration Wizard select Event Handlers and form External Event Handler Table 4 Component Property Settings 4 Publish the procedure 5 In Visual Studio 2005 create a Metastorm BPM Process Code Behind Project using the published procedure 6 Find public bool FormFormlWhenFormLoaded 7 Amend as follows public bool FormFormlWhenFormLoaded metastormFolderInstance CustomVariable txtListOptions Richard Katherine Pedro Bama gt return true j 8 Build the project 9 Deploy the project 10 In Internet Explorer view the form and the dropdown is populated with the list defined in Visual Studio NET 6 7 Configuring Process Metadata Web Service Connection D
21. amp Refer to section 6 Creating Process Events in Visual Studio NET 10 May 2008 Metastorm Inc 2006 4 4 1 4 1 1 Process Orchestrator for NET Designer s Guide SETTING UP THE PROCESS ORCHESTRATOR FOR NET Supported Environments and Installation Prerequisites NET Activator Microsoft NET framework version 2 0 Microsoft NET 2 0 Software Development Kit Enterprise Component Library for NET Server Components Metastorm Engine 7 5 or later DCOM Access permissions granted to the installing user Microsoft Internet Information Services when HTTP hosting is configured Microsoft NET framework version 2 0 Enterprise Component Library for NET Sample Client Microsoft Internet Information Services ASP NET 2 0 Microsoft NET framework version 2 0 Process Events Microsoft NET framework version 2 0 Metastorm Process Metadata Service The Process Metadata Service is a web service which queries the Metastorm repository and provides calling applications with specific information about published processes For example it provides a list of the available process maps For a particular map it can provide a list of all the available actions within the map together with form field definitions etc The Metastorm Process Metastorm BPM Release 7 6 May 2008 11 Metastorm BPM Release 7 6 Metadata Service can be installed from the Metastorm BPM CD It can be found under the Metastorm Process Engine com
22. ation and startup information 5 Select the I accept the terms in the license agreement radio button Metastorm BPM Release 7 6 May 2008 13 Metastorm BPM Release 7 6 6 Click on the Next button The Custom Setup screen of the Process Orchestrator for NET installation is displayed T Metastorm Process Orchestrator for MET Release 7 6 Installation Wi Custom Setup Select the program features vau want installed Click an an icon in the list below to change how a Feature is installed Feature Description BEB MET Activator NET ECL client Integration This Feature will install common NET Activator Files Metastorm BPM Visual Studio 2005 Integratic Metastorm Process Events Library El Metastorm Complex Types Support E Metastorm Process Engine support Far POs This Feature requires Z0 36KB on ES el ASP NET Web Parts your hard drive E Install En C Program Files Metastorm BAMI Figure 3 Metastorm Process Orchestrator Custom Setup Screen 4f The options that appear on this screen depend on the versions of the NET framework that are installed 4f The feature Metastorm Process Engine support for POs can only be installed if the Metastorm BPM Process Engine is installed Selecting NET Activator requires the installation of Metastorm Process Engine support for POs If Complex Types is selected this feature is only required if the Engine is installed on the same machine
23. brary by selecting the File menu then the Publish menu option Metastorm BPM Release 7 6 May 2008 19 Metastorm BPM Release 7 6 5 2 Associating the Library with a Procedure To access the new Integration Wizard items that correspond to the imported NET methods you must associate the new library with a procedure via Procedure Properties amp For further information on associating a library with a procedure refer to the Designer User Manual To associate the library with a procedure 1 Create a new procedure by selecting the File menu then the New menu option or open an existing procedure by selecting the File menu then the Open menu option 2 Add the library to the procedure by selecting the File menu then the Procedure Properties menu option 3 Click on the Used Libraries tab Be Procedure1 Properties l JO x General Used Libraries LDAP Aliases Work Offline Library Mame Version oF Published Description L pae Update DK Cancel Help E Figure 10 Used Libraries Tab 4 Click on the Add button and browse for the required library 5 Click on the OK button 5 3 Calling Imported Methods via the Integration Wizard Once the library has been published and associated with a procedure the imported methods are available for selection in the Integration Wizard when that procedure is open in the Designer To incorporate NET Assembly functions into a procedure 1 For any event w
24. ccess to the Metastorm database is configured as SQL Authentication 2 When accessing a SQL Server database using trusted connections Integrated Authentication the following apply 1 Integrated Windows Authentication all users accessing the service must be authenticated by SQL Server li Anonymous You will need to make sure the I USR machinename user can be authenticated by SQL Server iii Basic Authentication prompts the user for their credentials Basic Authentication credentials are sent via clear text 3 SQL Authentication nominating a user id and password to connect to the database is the only mode supported when accessing Oracle databases from the Metastorm Process Metadata Service Af The Metastorm Process Metadata Service is required during development and is not used in production It is recommended that customers test their development on non production machines 6 7 4 Process Metadata Web Service Configuration Details Dialog The Metastorm Process Metadata Service can be accessed from the Metastorm Process Events Code Behind Wizard or through the Process Events add in in Visual Studio Metastorm BPM Release 7 6 May 2008 47 Metastorm BPM Release 7 6 Metastorm Process Events Code Behind Process Metadata Web Service Connection Details Provide valid credentials to the metadata service in order bo retreive event enabled processes Alias Default Service Proxy Details C Use Proxy URL htt
25. defined Deployment Target Path The default paths are C Program Files Metastorm BPM Engine donetbin or C Program Files Metastorm BPMNEngineNdonetlib Overwrite existing files Overwrites existing files in the Deployment Target Path folder Files to deploy The files needed to deploy Process Events are the d11 and pdb file for the appropriate project Buttons All This button selects all files in Files to deploy None This button unchecks all selected files in Files to deploy Deploy This button deploys the selected files to the defined Deployment Target Path Close This button closes the dialog 6 8 4 Debug With Process Engine The Debug With Process Engine option enables a NET developer to debug a process events project If the engine is running the Debug With Process Engine menu option will attempt to attach the code behind the dll to the engine process Users can then detach from the process using the Detach All menu option To debug the Process Engine 1 Deploy the Project 2 Inthe Solution Browser right click and select Debug With Process Engine When the NET developer has finished debugging they should select from the menu Debug Detach All 54 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide Ld Debug With Process Engine is not supported with Split deployment 4f The Debug With Process Engine option is not accessible using Vista In order to attach to an engine in Vista you
26. e invoked in response to Metastorm BPM process events This section goes through the steps required to create external process events in NET 22 l 2 The Process Designer publishes the Process Events Library using the Designer The Process Designer creates and publishes procedures setting event handler options which call NET events The NET Developer creates a Metastorm BPM Process Code Behind Project which contains the skeleton code for creating process events May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide 4 The NET Developer creates C source code inside the process events skeleton using Visual Studio 5 The NET Developer builds and deploys the assemblies in the engine dotnetbin or engine dotnetlib folder 6 The Process Participant is now able to fill in the relevant forms using a browser In addition to the above steps this section also explains what to do when stages maps or events that may have been renamed deleted or added 6 1 Architecture The exposure of the Process Events has been designed as shown in the following diagram DESIGN DEPLOY IMPLEMENT Process Process Participant Designer Process Operation Request Metastorm Client Script Invokes Metastorm External events Response Database N DLL N NET Developer Figure 11 Process Events Architecture 6 2 Publishing the Process Events Library The Process Events Library contains a scr
27. e Component Library for NET refer to the Metastorm Enterprise Component Library for NET Usage Guide Web developers can also use the Web Client ASP NET web parts to build websites using Visual Studio that contain Metastorm functionality amp For further information refer to the Web Client ASP NET Web Parts Developer Guide 8 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide 3 USING THE PROCESS ORCHESTRATOR FOR NET 3 1 Importing Methods via the Integration Wizard The Process Orchestrator for NET is used in the following way 1 A Visual Studio NET Developer develops application components as NET Assemblies 2 A System Integrator uses the Metastorm NET Activator to make selected NET classes available as functions within the Metastorm Designer s Integration Wizard as follows 1 il iil VI The System Integrator runs the Metastorm NET Activator The System Integrator uses the NET Activator to specify a NET Assembly Cache GAC Zap Cache or downloaded Cache browsing to another PC if necessary The NET Activator uses Reflection to interrogate the list of NET components hosted in the Cache and provides the System Integrator with a list of the classes and methods exposed by each assembly The System Integrator selects which methods they want to be available as Integration Wizard functions in the Metastorm Designer The NET Activator then creates a Metastorm
28. e Names private Stage m ObjectType Stage StageName public Stage lt ObjectType Stage gt lt StageName gt get return m_ lt ObjectType Stage gt lt StageName gt m_ lt ObjectType Stage gt lt StageName gt value Events related to stages are in the format Start Event public bool lt ObjectType Stage gt lt stageName gt WhenStageStarted return true Finish Event 36 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide public bool lt ObjectType Stage gt lt stageName gt WhenStageCompleted return true Z Non alphanumeric characters that are accepted by Designer in Stage names that are accepted in Designer are replaced with the corresponding character code For example a Stage named Process amp Review in Designer will be amended to Process_chr32_chr38_chr32_Review in Visual Studio where chr32 space and chr38 ampersand A Rule stages OnInvokeRule is executed via the preceding When Action Completed Common Stages Common stages are not included by name in a Code Behind Project Instead all actions from a common stage are assigned to the corresponding stage For example there is a common stage called MyCommonStage which has a common action MyCommondAction The MyCommonStage is applied to MyFirstStage and MySecondStage resulting in the following code public Action ActionMyCommonActionFromStageMyFirstStage get return m_
29. ed external events in a local reference the external event will be fired twice Af Admin Forms are not included by the Delegate all external events for map option To include Admin Form for each Admin Form apply local events to the forms When Form Loaded and When Form Saved for them to be included 6 4 Creating a Metastorm BPM Process Code Behind Project Metastorm BPM provides a Process Events Wizard which is a custom Visual Studio project wizard It allows the developer to create a new solution based on data retrieved from a Metastorm database via a user selected Web Service The solution will contain one or more projects with 26 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide each project corresponding to each procedure retrieved from the database and selected by the user For each project a class library is automatically generated by the wizard gt VS 2 005 Project types Templates Visual Basic isual Studio installed templates s suai ce re Invoke a gt E Visual Ji gpl Metastorm BPM Process Code Behi visual C Class Library W 1Z ard 4 Other Project Types re Console Application Start New Metastorm Process Events Wizard Metastorm Process Events Coda Behind Wweelonmie En The Mitata Pracess Events var Solution Explorer Metastorm ProcessEvent X a This wizard vell enable voc to create an assembly to handle external E E 2 Eel events from Meteston
30. etails Internet Information Services IIS is configured to include the Process Metadata Web Service called Metastorm Common ProcessMetadataService which sets its default authentication method as Integrated Windows Authentication The URL is defined in a Visual Studio Metastorm BPM Release 7 6 May 2008 45 Metastorm BPM Release 7 6 Integration configuration files The Visual Studio Integration requires the Metastorm Process Metadata Service Before the Process Metadata Web Service can be configured the following need to be set e Security e Process Engine Database connection settings 6 7 1 Security The Visual Studio 2005 NET Developer requires access to the Metastorm Database SQL or Oracle using normal authentication methods The web service that is invoked has to have the necessary Internet Information Services IIS security set by an IIS administrator IIS Database Authentication Authentication required Required Authentication required for Metastorm Process Registry Metadata Service Access VS 2005 Developer Metastorm Database Figure 22 Metastorm Process Metadata Service Security When the Visual Studio 2005 NET developer deploys the d11 to the engine machine the developer will need to have the necessary NTFS permissions to deploy an assembly in relevant folder 6 7 2 Process Engine Database Connection Settings The Metastorm Process Metadata Service uses the Process Engine s database connection
31. for NET is installed 16 Click the Finish button 17 Start the Engine service 18 Start the ECL service 4 2 1 Troubleshooting Installation Unable to access the BPMEngine Net URL When a client using the Engine s NET interface attempts to connect to an engine on another machine the following error may be reported Access denied 401 error To resolve this problem open the Internet Information Services administration tool and change the BPMEngine Net virtual folder to turn on Integrated Windows Authentication IW A Connect to the service using the machine with the web service installed via the ECL test client Metastorm BPM Release 7 6 May 2008 17 Metastorm BPM Release 7 6 5 CALLING IMPORTED METHODS VIA THE INTEGRATION WIZARD You can use the NET Activator to import functions exposed by NET Assemblies into a Metastorm Integration Wizard collection library amp For details of how to import functions exposed by NET refer to the NET Activator Help accessible from the NET Activator To use functions exposed by NET Assemblies in a Metastorm procedure you must 1 Deploy the assemblies in both the designer dotnetbin and the engine dotnetbin directories using Visual Studio 2 Publish the library 3 Associate the library with a procedure 4 Call imported methods via the Metastorm Designer Integration Wizard 5 Publish the procedure The following subsections describe these steps in more detail
32. ge names and are differentiated from blank or admin forms Start Events public vord lt ObjectType Action gt lt actionName gt FromStage lt StageName BlankForms AdminForm gt WhenActionStarted return true public voad lt ObjectType Action gt lt actionName gt FromStage lt StageName BlankForms AdminForm gt OnlyStartActionlf return true Finish Event pub le voad lt ObjectType Action gt lt actionName gt FromStage lt StageName BlankForms AdminForm gt WhenActionCompleted return true Af Action names will be a combination of the StartsWithStageName and the action name Af Non alphanumeric characters that are accepted by Designer in Actions names are replaced with the corresponding character code For example a Stage named Processing amp Reviewing in Designer will be amended to Processing_chr32_chr38_chr32_Reviewing in Visual Studio where chr32 space and chr38 ampersand 6 5 7 Dependencies The code skeleton is dependent on e Metastorm Engine Interface75 which gives access to the IFolder Interface e Metastorm ProcessEvents CodeBehindSupport which provides support for the auto generated code in the skeleton The IFolder Interface provides access to functions exposed by the Metastorm BPM language 40 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide 6 5 8 CurrentVersion The CurrentVersion is updated when no changes have been made to the
33. gner Figure 29 Tree hierarchy in Visual Studio NET and Designer A On resynchronizing a project the Solution Browser will refresh its window with the new populated 56 Maps Actions Stages Forms and Events added by the resynchronization May 2008 O Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide Appendix A Simple Type Mapping The following table summarizes the simple type mapping that 1s applied when NET functions are imported d At present the Metastorm Process Orchestrator for NET supports only simple types NET Type Metastorm Type System nt32 Integer System Int16 System Double System Char Text Figure 30 Simple Type Mapping Metastorm BPM Release 7 6 May 2008 59 Metastorm BPM Release 7 6 Appendix B Examples of Scripts Generated by NET Activator The NET Activator creates 2 scripts containing the functions to access the assembly which are stored in a Metastorm library The scripts are called e Activator Assembly Name a class to invoke an assembly using data from a Metastorm process e AvailableFunctions Assembly Name a proxy class containing all available functions but commented out Activator Assembly Name C 2005 Metastorm Inc JSCriptsNET Activa icon SOPIDti a import System import eWork Engine ScriptObject import eWork Engine Activator import System Reflection package eWork Activator TestClass public class Invoker
34. he service impersonates the credentials of the user accessing the service Refer to 6 7 Configuring Process Metadata Web Service Connection Details for more details Username ISets the user name used for basic authentication string Password Sets the password used for basic authentication string Domain Sets the domain used for basic authentication Remember that password information is sent string in plain text over the network when using basic authentication Default Sets the displayed Web Service as the default Configuration Process Metadata Web Service The alias name boolean of the default configuration is moved to the top of he Alias dropdown Metastorm BPM Release 7 6 May 2008 49 Metastorm BPM Release 7 6 Proxy Details onion say ome NN Use Proxy Sets the information for the proxy server used for boolean all web services calls Sets the proxy type The proxy server can be configured into two ways CURRENT USER the current user s IE settings are used to determine the proxy host port the proxy at host port is used for example http 93 13 17 2 8080 These settings override the IE settings Host The host port of the proxy For example Http must be used in front of definition http 93 13 17 2 8080 User name Sets the username used when accessing the string proxy server Password Sets the password used when accessing the string proxy server Bypass if Determines whether the proxy
35. here you want to incorporate any of the required functions use the Integration Wizard to access the functions under the specified category 20 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide 2 Enter any values required by the function as parameters 3 Click on the Next button amp For further information on using the Integration Wizard refer to the Designer User Manual 5 4 Publishing the Procedure To publish the procedure 1 Ifthe NET assembly with the imported functions is in a DLL ensure the DLL is in the following location lt Metastorm Installation Directory gt Engine Dotnetbin 2 Select the View menu then the Options menu option 3 On the Publisher tab ensure the Enable versioning option is checked 4 Click on the OK button 5 Publish the procedure by selecting the File menu then the Publish menu option The procedure can now be accessed from a Metastorm Client 5 5 Full Name Binding If a file is referenced from the GAC it requires a full name binding including a version and a public key token as well as the assembly name where as before only the assembly name was required For example in an earlier Version of Metastorm BPM the following call to an assembly method in the GAC would be valid sresGet_FolderID ScriptEval JScript NET sProcedure Name 3M apName eWork Activator TestClass Invoker Activate TestClas s TestClass eWorkObject get FolderI
36. ion Wi E Connection Setup Specify Process Engine Service List location Please specify the location of the Process Engine Service List EngineServiceconfig xml below Engine Service List location URL path CO Physical UNC path Browse Path http ii zservername gt ewirtualfolder gt Engineservice Contig xml Metastorm Web Client Base URL Ihttp servername siMetastorm Figure 5 Metastorm Process Orchestrator Connection Setup Screen Metastorm BPM Release 7 6 May 2008 15 Metastorm BPM Release 7 6 11 Set the radio buttons to select the link to the location of the Process Engine Service List to either a Physical UNC path or a URL If the Engine is to be installed on the same machine the path defaults to the local Engine location Ifthe Engine is installed on another machine then enter the path or browse to the location if the Engine is already installed Expose the folder containing EngineServiceConfig xml on that machine as a network share with the appropriate permissions to access via UNC path If the connection is over HTTP enter the URL in the format http lt enginecomputer gt escripts EngineServiceconfig xml 4f The engine service file EngineServiceConfig xml can be configured to contain multiple services Es For further information on customizing EngineServiceConfig xml refer to the Metastorm Administration Guide 12 Set the Web Client Base URL The Metastorm Web Client Base URL
37. ipt which is required for calling an external event handler defined in Visual Studio 2005 To use the Process Events Library the Process Designer Metastorm BPM Release 7 6 May 2008 23 Metastorm BPM Release 7 6 1 Opens the Process Events Library 2 Publishes the Process Events Library 3 Associates the Process Events Library with a new or existing process 4 The Event Handler category is now available in the Integration Wizard amp For further information refer to 6 3 2 Exposing Process Events in Designer 6 3 Creating and Publishing Procedures using the Designer 6 3 1 Creating a Procedure A Metastorm procedure is created using the Designer to automate business processes using maps folders stages and actions The Metastorm process is represented by maps stages forms and actions in the Designer The Process Designer can insert formula and script code in the Designer to execute events The events can be created in Designer or the events can be exposed using the Integration Wizard The exposed events call external event handlers created in NET Events are found in the Do This properties tab and typically are e When Action Started e When Action Completed e When Stage Started e When Stage Completed e When Form Loaded e When Form Completed Af Form control events for example buttons and text fields are not supported amp For further information on creating procedures refer to the Designer User Manual 6 3 2 Ex
38. lease 7 6 Mew Project Project types Templates Visual Basic Visual Studio installed templates Visual CA Visual JF E a a Misual C 2 l ET zc Other Project Types Metastorm Windows Class Library Windows Console Test Projects Hts Application Control Library Application Code Behind Crystal Device Excel Outlook Add in Reports Application Workbook comes E El E E My Templates i 4 project Far creating Metastorm BPM Process Events code behind assemblies Mame MetastormBRMevents1 Location CMBPIM Browse Solution Marie MetastormBPMeEyvents 1 Create directory For solution Add to Source Control Cancel Figure 14 Metastorm BPM Process Code Behind Wizard New Project 5 Enter the location and solution name Ld Any project name entered will be overwritten by the wizard Af The location name of the project plus the file name should not exceed 248 characters It is recommended that the NET Developer does not use the default Visual Studio path as the dynamically created map classes may exceed this limit 6 Click OK 7 An introductory window is displayed to the user explaining the wizard functionality 26 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide Metastorm Process Events Code Behind Welcome to The Metastorm Process Events Wizard This wizard will enable you to create an assembly to handle external events From Metastorm BPM a
39. n GPM and reg te then inb amp process od Solution MetastormBPMEvents1 1 project c ena eee d amp in the Folloesng step vou vil be able to m G Resynchronize Project B uil Deploy z E d 4 L Connezt ko s peocers metadata web Pere Deploy Process 4397 to Engine a Debug With Process Engine EX Build Machine 3 View avanti bo b rgarted Rebuild 2 Sb ered part rcc 3 Create code behind event ceppe lor selected proceppes To cordiram del Net Ll Aud coral lo del md prce cel mlal a reels cer va dir ra Sher Page H SE Mei iors Fr ial corti Pega Phi o pd Mmi i Cancel Heat Wizard Opens a VS imt CurceaiYecai IENE 2005 Metastorm gn BPM Process Events Solution Figure 13 Process Events Workflow The Process Events Wizard takes the user through a set of serial steps via a standard wizard interface a sequence of dialog windows where information will be entered and or approved by the user before proceeding to the next step Help is provided from the Wizard Af Please be aware that the Process Events Help may be displayed behind Visual Studio when the Help button is clicked in the Wizard The steps for creating a Process Events project are 1 Open Visual Studio NET 2 Select File New Project from the menu 3 Select Project Type Visual C 4 Select Metastorm BPM Process Code Behind Project template Metastorm BPM Release 7 6 May 2008 27 Metastorm BPM Re
40. n the current user s My Documents Visual Studio 2005 AddIns folder If a different user uses Process Events the file Metastorm ProcessEvents SolutionSupportAddin AddIn will need to be copied to the current user s My Documents Visual Studio 2005 AddIns folder 6 8 1 Using the Add in 1 Select Tools Add in Manager 2 Select Process Events Solution Support 3 Click OK 4 The View menu contains two new options i Browse Process Events this option displays the Solution Browser depicting Designer s Procedure Explorer in graphical format ii Metastorm Process Events Web Service Details this option displays the Metastorm Web Service Configuration Details which set the location of the Web Service 5 Solution Explorer contains two new options in the project context menu i Deploy Process this option copies a built project s assemblies DLL s to a location by default engineNdotnetbin for use with the published procedure ii Resynchronizing a Project this option resynchronizes the NET process events code with the published procedure iii Debug With Process this option enables a NET developer to debug a process events project Solution Explorer Metastorm ProcessEvent XI A El od Solution MetastormBPMEvents1 1 project El Pella IF ET Zr DenroccEuaonte Els ah EF Ee Resynchronize Project E Deploy Process Debug With Process Engine Rebuild Figure 25 Process Events Menu
41. nd integrate them into a process In the Following steps vou will be able to 1 Connect to a process metadata web service 2 Select and import procedures 3 View events to be imported 4 Create code behind event classes Far selected processes To continue click Next Auto connect to default process metadata web service Figure 15 Metastorm Process Events Code Behind Wizard Welcome 8 Check Auto connect to default process metadata web service if you have already have a default process metadata web service The default configuration is set in the Metadata Web Service Connection Details The default configuration is automatically moved to the top of the service list Ld Checking this option skips steps 10 and 11 9 Click the Next button 10 Choose the desired Metadata service to connect to by using the drop down filling in the URL and authentication type if required Metastorm BPM Release 7 6 May 2008 29 Metastorm BPM Release 7 6 Metastorm Process Events Code Behind Process Metadata Web Service Connection Details Provide valid credentials to the metadata service in order bo retreive event enabled processes Alias Default Service Proxy Details C Use Proxy URL http flocalhost Metastorm Common Prac Tvpe Integrated Windows Authentication EE Lo LL fo Default Configuration Figure 16 Metastorm Process Events Code Behind Wizard Web Service Connection Details The Meta
42. nts Code Behind Wizard Review External Events 15 Click Next 16 The wizard generates a new Visual Studio solution based on the procedures selected by the user 32 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide Metastorm Process Events Code Behind Congratulations Congratulations You have successfully selected the external events khat you mant En access using Visual Studio 2005 vou are about to import your selected processies Click Finish Ea create the Visual Studio solution containing Ehe Events vau specified Figure 19 Metastorm Process Events Code Behind Wizard End 17 Click Finish The default project created has the name Metastorm ProcessEvents lt ProcedureName gt The solution name is defined by the user in the first screen of the wizard Each project consists of C files relating to each Map and each Admin Form group containing External Events Af Non alphanumeric characters except _ that are accepted by Designer in Stage Form Actions or Event names are replaced with the corresponding character code For example a Stage named Process amp Review in Designer will be amended to Process_chr32_chr38_chr32_Review in Visual Studio where chr32 space and chr38 ampersand 6 5 Using a Metastorm BPM Process Code Behind Project A project created using the Metastorm BPM Process Code Behind Project template consists of e The solution name defined in the P
43. ompleted return true public DOOI ActionFirst_chr32_actionFromStageBlankFormsWhenActionStarted i return true public bool ActionFirst chr32 actionFromStageBlankFormsWhenActionComplete d return true public Stage StageFirst_chr32_stage get return m_StageFirst_chr32_stage m StageFirst chr32 stage value public bool StageFirst chr32 stageWhenStageStarted return true public bool StageFirst_chr32_stageWhenStageCompleted return true public Form FormForml Metastorm BPM Release 7 6 May 2008 43 Metastorm BPM Release 7 6 return m FormForml m FormForml value public bool FormFormlWhenFormLoaded get set return true public bool FormFormlWhenFormSaved return true 6 5 11 IntelliSense To assist the NET Developer Metastorm BPM Code Behind Project has IntelliSense for its properties and methods For example metastormFolderInstancs hg aetFolder GetHashCode GetObjectData amp GetRecordset GetText Q GetType E IsSvnchronaus LDAPSearch 5 Length t Linefeed string IFalder etFolder string table string where string column Sync Supported async Unsupported returns the value of the custom variable Far the specified Folder held in the specified map table in the Metastorm database For example Se aetFolderiFiight eFolder eFolderID Parent Class It Parent Falder s Class vari
44. ontains additional Integration Wizard function definitions and can be viewed via Library Properties For further information refer to the Designer User Manual Integration Wizard Collection A Set of Integration Wizard functions that are defined in a library for use in a Metastorm procedure NET Developer The person who imports a Metastorm BPM process and uses the extended Visual Studio functionality to create NET assemblies containing code to be invoked in response to Metastorm BPM Process Events Process Designer The person who uses the Metastorm Designer to create a process The Process Designer can use functions provided by the System Integrator and delegate process events System Integrator The person who uses the Activator to create a set of Integration Wizard Collection functions that will be available to a Process Designer Table 2 Terminology 1 3 Getting Further Information This manual does not cover in detail the Metastorm NET Activator the Metastorm Enterprise Component Library ECL for NET the ASP NET Web Parts the Integration Wizard component 6 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide of the Metastorm Designer or server side scripting with Jscript NET The following table lists where to find detailed information on these topics Metastorm NET Activator Metastorm NET Activator Help accessible from the NET Activator Metastorm Enterprise Metastorm Enterprise
45. orresponding NET code The Delegate all external events for map property has been checked in Designer 34 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide sal Procedure Explorer x NameOfMap Class my B A Blank Farms El Fields Tu First action aP currentVersion jy First stage af isAdmin El F a m ActienFirst chr3z actioanFramSEageBlankFarms anms E m FormFormi E Formi as m StageFirst chr32 stage 88 Roles a metastormFolderInstance d Flags a warnMode i BE Custom variables mate a r SS ActionFirst_cors2_actionFromStageBlankForms i al common ie x SR Currentversian SA FormFormi ran IsAdmin Procedure Explorer in Designer SR MetastormFolderinstance A StageFirst chr32 stage SR warnMode i Methods w ActionFirst_chr32_actionFromStageBlankForms Whend ctioncompleted Shy ActionFirst chr32 actionFromStageBlankFormsWwhenaActionStarkted Sty FormFarm1 wWwhenFarmLoaded dg FarmFormiwWhenFormSaved aY InitializeCompaonent t MameofManp Sig SkhageFirst_chr3e _stageWhenStageCompleted Sig ShageFirst_chr32_sbageWhenStage Started i Nested Types Tn First action WarningStatus Enum WarnQnError StopOnError E Class Diagram in Visual Studio First stage Main Pane in Designer Figure 20 Procedure in Designer and Visual Studio 2005 Z Non alphanumeric characters accepted by Designer in names are replaced with the corresponding charac
46. p flocalhost Metastorm Common Prac Tvpe Integrated Windows Authentication EE Lo LL fo Default Configuration Figure 23 Metastorm Process Metadata Service Configuration Dialog in the Wizard In Visual Studio 1 Tools Add in Manager 2 Select Process Events Solution Support 3 Click OK 4 View Metastorm Process Events Web Service Details 48 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide Web Service Configuration Details Proxy Details Use Proxy URL Atte localhostMetastorm Cormmon Processh Type Integrated Windows Authentication w Default Configuration Figure 24 Web Service Configuration Details accessed from the menu Connection Parameters Cmm o mm o Ro Alias string This is a user defined name for the Web Service MEE URL string The location of the Process Metadata Service The The Metastorm Process Metadata Service can default service name is displayed It is obtained run on a separate engine machine If this is rom the Process Activators and VS Integration the case the URL will reference the engine configuration files machine The authentication used by the Metastorm The following authentication methods are Process Metadata Service supported Anonymous a dedicated local account is used to server the request Basic Authentication requires User name Password and Domain Integrated Windows Authentication the default T
47. ponent The Process Metadata Service is not installed by default 4 1 5 Complex Types Metastorm BPM Designer Engine support for Process Orchestrators if Metastorm Process Engine is installed 4 1 6 Engine support for Process Orchestrators e Metastorm Engine 7 5 or later 4 1 7 ASP NET Web Parts e Visual Studio 2005 e SQL Server 2005 Express Edition Af In order to install the NET framework version 2 0 Windows Installer version 3 0 must be installed This is installed as part of Windows Server 2003 or can be installed separately v For further details of supported environments and installation prerequisites for Metastorm BPM refer to the Supported Environments guide and Installation Prerequisites guide provided with the main product 4 2 Installation To install the Process Orchestrator for NET 1 Insert the Process Orchestrator for NET CD into your CD drive If the drive 1s Configured to autorun the installation procedure starts automatically Not configured to autorun i Access Windows Explorer and browse to the files on the CD u Double click the file Autorun exe to start the installation The autorun screen is displayed 2 To proceed with the installation click on the Process Orchestrator for NET link You see the initial screen of the Process Orchestrator for NET installation 12 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide ig Metastorm Process O
48. posing Process Events in Designer Each process in a procedure can have its event exposed to Visual Studio NET solutions Process events can be exposed e Locally e Globally In order to use exposed process events and customized extensions Process Events Library xel should be published and associated with the procedure This library contains the External Event Handler Integration Wizard function which contains a generic event for for local and global exposed processes 24 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide Locally The events can be exposed process by process by placing a call to a formula which inserted manually or using the Integration Wizard The Integration Wizards Collections Library contains a ExecuteExtensionEval call to invoke a JScript NET to handle process events The External Event Handlers item identifies the Procedure Name and invokes the correct action form or stage event Each action form and stage can have process events exposed as required These are exposed as follows 1 Associate Process Events Library xel with the procedure 2 Select the action form or stage 3 Select the Do This tab in the Properties window 4 Select the event for example When Action Started 5 Click the Integration Wizard button 6 Select the Event Handlers category and the External Event Handler item 7 Click Finish 8 The following syntax is automatically created SExecute
49. procedure and the procedure is re published in the Designer and resynchronized in Visual Studio 2005 For example A procedure is published with Delegate all external events for map checked The Process Events Integration Wizard is run in Visual Studio 2005 to create code behind A constructor is automatically created public lt MapName gt InitializeComponent currentVversriorn 1 Set warn mode for version conflicts Ja NarnOnError IgnoreOnError 72 StopOnError warnMode WarningStatus WarnOnError The procedure is published with no changes and in Visual Studio the code is resynchronized The code is updated public lt MapName gt InitializeComponent CULLEN Version sx dP Set warn mode for version conflicts El NarnOnError Ll rgnoreOnEr ror Ta SCODOnError warnMode WarningStatus WarnOnError j The current version is checked by the invoker at runtime The warn mode control the behavior For example this may be a warning in the Designer log or StopOnError may throw an actual exception or add an error 6 5 9 Private member declarations amp Event Handler Initializations This section shows examples of C code lt MapName gt Fields cs automatically generated through the Process Events wizard Forms stages and action methods this m_FormForml new Form this m FormForml Name Formi Metastorm BPM Release 7 6 May 2008 4 Metastorm BPM Release 7 6 this m
50. public Savile function Activate ework SyncProcessData args Object Object var retval Object null retval ClassActivator Activate ework args return rertvagis AvailableFunctions Assembly Name The commented code 1s intended to be a template for developers containing the available functions of the class in JScript NET It 1s not intended to be used directly Due to JScript NET limitations it may have to be altered to compile correctly The following are supported e Public Methods e Property accessor amp mutator methods e Indexed properties 60 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide e Hidden constructors e Multiple constructors e Multiple Namespaces e Delegates e Static and non static functions and properties e Depreciation e Nested classes The Activator makes use of the Metastorm synchronous process data object to activate NET classes Using the commented code it is possible to use asynchronous scripts if necessary This example of a generated script uses a complex type The script is based on the following object El 23 TestClass A Mi Pea H Dependencies El TestClass El vs ComplexObject dl Base Types 4 Sub Types i chore y GebAnaddressi Userdddress El f Userstddress UserAddress ts get _UsersAddress UserAddress iw seb UsersAddress User4ddress Void aM m Llsers ddress UserAddress vs ewWorkoObject El d LIserAdd
51. rchestrator for NET Installation Wizard E Welcome to the Wizard for letastorm Process Orchestrator for NET The Wizard will install Metastorm Process Orchestrator Far NET on vaur computer To continue click Mext WARNING This program is protected by copyright law and international treaties Figure 1 Metastorm Process Orchestrator Installation Welcome Screen 3 Click on the Next button The License Agreement screen of the Process Orchestrator for NET installation is displayed is Metastorm Process Orchestrator for NET Installation Wizard E License Agreement b ds c Please read the Following license agreement carefully Metastorm BPM formerly known as e Work Version 7 Software License License If vau have nat signed a software license agreement with Metastarm the following terms and conditions will apply This License applies ta Metastorm BPM software Software By downloading or installing the Software vau agree to be bound by the terms ofthis License which will govern your use ofthe Sofware Ifyou do not acceptthese terms you must discontinue downloading ar installing the Software keeping no copy and within fourteen 14 days of purchase return the Software with its original packaging and G1 accept the terms in the license agreement I do not accept the terms in the license agreement Figure 2 Metastorm Process Orchestrator License Agreement Screen 4 Click Print to print the install
52. re added to the project 6 8 6 Solution Browser The solution browser provides an option to view a tree view displaying a Metastorm BPM view of Procedures Maps Stages Forms and Actions and events A Visual Studio 2005 developer can navigate to a function by double clicking on an event The tree view also displays the available custom variables for each map project which the developer can access via the metastormFolderInstance member variable for example metastormFolderlInstance CustomVariable txtCustomVariableName Text Eo set the variable Metastorm BPM Release 7 6 May 2008 34 Metastorm BPM Release 7 6 To view the Solution Browser Solution Browser 1 From the View menu select Browse Process Events 2 The Solution Browser is displayed Procedure Explorer 9 Flight d Ed Flight Ell Blank Farms f Blank Forms fy Flight request Sy Actions fy vP Flight request El s Flight request de Manager Sq Events Es Traveler us When Action Started L Check Class a When Action Completed LE withdrawn s VP flight request El 38 Travel Department EE El ds VP Elda Awaiting Flight ds Awaiting Flight Ed Check Class El Flight taken LA Flight taken mE Farms jy Manager Ed Roles 2 Travel Department Bal Custom Variables E des Traveler de Flags Ay VP EE Flight Airports El A Withdrawn iw Common Forms Wal Custom variables ia Flight Airports Solution Browser in Visual Studio NET Procedure Explorer in Desi
53. ress Base Types H Sub Types w Age Inks w Mame String Postcode String if Street String Figure 31 TestClass Object used in the Example Script C 2005 Metastorm Inc JoOOTIDL NEI AGUCIVALLI10n SOTXIDE import System import TestClass import System Reflection package Activator TestClass public class TestClassComplexObjectProxy Metastorm BPM Release 7 6 May 2008 61 Metastorm BPM Release 7 6 private var m_AssemblyComplexObject TestClass ComplexObject public function TestClassComplexObjectProxy m_AssemblyComplexObject new TestClass ComplexObject j public function GetHashCode Int32 return m AssemblyComplexObject GetHashCode public function Equals obj Object Boolean return m AssemblyComplexObject Equals obj public I UNCC LO TOSCI Strang return m AssemblyComplexObject ToString public function get UsersAddress TestClass UserAddress return m_AssemblyComplexObject UsersAddress public function set UsersAddress value TestClass UserAddress m_AssemblyComplexObject UsersAddress value public function GetAnAddress TestClass UserAddress return m AssemblyComplexObject GetAnAddress public function GetType Type return m AssemblyComplexObject GetType 62 May 2008 Metastorm Inc 2006
54. rocess Events Wizard e The project name which is Metastorm ProcessEvents lt ProcedureName gt e The files within the project A single component is created for each Map and each Admin Form which contains two partial classes for each process The files are named lt MapName gt cs and lt MapName gt Fields cs Metastorm BPM Release 7 6 May 2008 33 Metastorm BPM Release 7 6 e A tree view of the processes including action stages forms custom variables and events The tree view is for informational usage only so that the developer can determine the process context of the events e Events skeletons which are created using the procedure map form action and stage names defined in Designer e Resynchronization option The code skeleton has two dependencies e Metastorm Engine Interface75 e Metastorm ProcessEvents CodeBehindSupport The first dependency gives access to the Folder Interface The second provides support for the auto generated code in the skeleton The IFolder Interface provides access to functions exposed by the Metastorm BPM language Metastorm BPM Code Behind Project comes with IntelliSense to assist the NET developer amp Heferalso to When Formulas are evaluated in the Designer User Manual for a description of the order in which process events are fired 6 5 1 Process Events Class Diagram The Process Events Wizard generates a skeleton for the code The diagrams below show a published procedure with the c
55. settings For the service to have access to the configuration information certain user accounts need to have read permission to the following registry keys e HKLM Software Metastorm Engine e HKLM Software Metastorm Engine Database e HKLMNSoftwareMMetastormNEngineNDatabase Connectors amp sub keys By default the service uses Integrated Windows Authentication This means that the service impersonates the currently logged on user so all Visual Studio users must have read access to these keys 46 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide 6 7 3 Authentication When installing the service the currently logged on user is added by default In development environments where there is more than one person accessing the service each developer will need to have read permissions for the registry The best practice would be to create a user group such as Metastorm Developers and grant permissions to this group Further users can be added to this group as required Alternatively the service can be accessed using Anonymous authentication This can be changed in the HS administration console In this case permissions are given to the Anonymous user only This typically is the USR lt machinename user gt There are some issues to be aware with regard to service and database configurations 1 The service authentication type Integrated Windows Authentication Basic and Anonymous is not important when a
56. sta ot UE Se 52 6 0 4 Debue With Process EHeIng ud o ee e i iet EAE REER 54 0 600 URESVHCHFOHIZINO GF EOIGOE onire ea tuo et ed ses cde inb Eod a orae tus einen aii 25 OAO sSOMMION BOWS T oea boot ei eetipaoieisstedl asinos ie bres S ceno 0s 57 Appendix A Simple Type Mapping 1 esee e erre cesse eene nennen nnn 59 Appendix B Examples of Scripts Generated by NET Activator 60 Xung c subiyaludeecec tcI aa EiS 60 AvailableFunctions Assembly Name 4 ee eee eee eere e eee ee eee seen ee eene tense tense ense easeee 60 May 2008 O Metastorm Inc 2008 Metastorm BPM Release 7 6 Process Orchestrator for NET Designer s Guide 1 INTRODUCTION The Metastorm Process Orchestrator for NET is a bridging technology that connects Metastorm processes and NET assemblies This document is intended to e Explain what the Metastorm Process Orchestrator for NET 1s e Provide an overview of how to use the Metastorm Process Orchestrator for NET e Summarize set up information for the Metastorm Process Orchestrator for NET e Describe how NET assembly methods imported into an Integration Wizard collection library by the NET Activator can be accessed e Describe how custom extensions can be developed and executed in response to Metastorm BPM process events e Explain Metastorm BPM Visual Studio 2005 NET Integration Process
57. storm Process Metadata Service should be installed on the same machine as the engine and it is only used in a development environment amp c For configuration details refer to section 6 7 Configuring Process Metadata Web Service Connection Details 11 Click Next 12 Select and import procedures from the displayed list All procedures in the list contain exposed events 30 May 2008 Metastorm Inc 2008 Process Orchestrator for NET Designer s Guide Metastorm Process Events Code Behind Import Metastorm BPM processes Select the procedures to be imported into Y52005 This step will select processes which contain externally delegated events Procedures Cl A Flight Figure 17 Metastorm BPM Process Events Code Behind Wizard Import Procedures 13 Click Next 14 A hierarchical tree view of the selected procedures is displayed Metastorm BPM Release 7 6 May 2008 31 Metastorm BPM Release 7 6 Metastorm Process Events Code Behind Review external events Review the externally delegated events that will be created in Y52005 4 Process Designer may H have exposed single events or entire processes 8 Flight El 4 Flight El Blank Farms El Sy Actions El ty Flight request El g Events When Action Stal When Action Con ts VP Flight request 3 Stages Awaiting flight TT dg a When Stage Started d When Stage Complet Ts Actions M Figure 16 Metastorm BPM Process Eve
58. ter code For example a Stage named First Stage in Designer will be amended to First_chr32_Stage in Visual Studio where chr32 space 6 5 2 Procedure Each map and each Admin Form in a procedure is split into two partial classes e lt MapName gt Fields cs which contains Private members of the map class The initialization of the map owned objects Actions Metastorm BPM Release 7 6 May 2008 35 Metastorm BPM Release 7 6 Forms Stages CurrentVersion metastormFolderInstance WarnMode IsAdmin e lt MapName gt cs Which contains Properties CurrentVersion metastormFolderInstance WarnMode IsAdmin Methods Events Initialize Component MapName Nested Types Warning Status Public properties of the map class Initialization of user configurable values The structure is created mirroring the Designer naming conventions and structure Map Segments are integrated into the parent map so that the segment belongs to the parent s map s class file when added to a Code Behind project Ld Stages Forms and Action do not provide access to the Metastorm Object Model via metastormFolderInstance this means that the developer is able to use metastormFolderInstance Action StartsStage but unable to use ActionName StartsStage 6 5 3 Stages Each stage has private variable and public accessor methods Private stage names are prefixed with m Variable Names are prefixed with the object type Stag
59. unning An Engine Status label indicating progress is displayed in the Deploy Project Files dialog The engine is restarted if a procedure has been run before and the assembly is loaded in the script hosts appdomain assembly cache The cache is flushed by stopping the engine deploying the new assembly and restarting the engine 32 May 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide The Deploy option is recommended for use on a developers machine and not in a production environment To deploy a project 1 Load the Process Events Add in 2 Open Solution Explorer 3 Right click the Project Name 4 Select Build 5 Right click the Project Name 6 Select Deploy Process 7 The Deploy Process dialog is displayed 8 Check the Files to Deploy and the Deployment Target Path 9 Click Deploy Deploy Project Files Deployment T arget Path C Program Filessdetastorm BPM SEnainesdatnetbin i Overwrite existing files Files To Deploy SMBPHMSFlightsherastorm PracessE vents FliahtsbinsD ebug M etastorm ProcessE vents Flight all CNMBPMAFlight Metastorm ProcessE vents Flight bnt Debug M erastarm ProcessE vents Flight pdb Figure 27 Deploy Project Files dialog Metastorm BPM Release 7 6 May 2008 53 Metastorm BPM Release 7 6 Deploy Project Files Deployment Target Paths The target path of the assembly files which are copied from the project s bin build folder to the
60. y 2008 Metastorm Inc 2006 Process Orchestrator for NET Designer s Guide Renaming a Stage or Action When a project is resynchronized the option Mark redundant event handler methods as Obsolete in the Resynchronize Project dialog can be used to mark any stages or actions that have been renamed As the stage or action is no longer available to a process any related events are marked as obsolete in the code left behind and new stages and actions are added to the project The code behind class creates new events for the renamed form and places Obsolete around the existing code Obsolete Event Handler is obsolete event no longer valid publrec bool ActionActionlFromStageFirst chr32 stageWhenActionStarted return true The old stage form or action events are not deleted for backwards compatibility because a procedure may already be in use and therefore data may be held in the database against a specific stage or action Deleting a Stage If a stage has been deleted from the procedure the stage will remain in the Metastorm database if a User s To Do or Watch Lists is populated with the deleted stage unless the folder is purged using the Metastorm System Administrator Deleting an Action If an action has been deleted from the procedure the action will be marked as obsolete Creating a new Stage Action or Form When a project is resynchronized any new stages actions forms and their associated events a

Process Orchestrator for .NET Designer`s Guide

Contents

Download Pdf Manuals

Related Search

Related Contents