Home

Designer User Manual

image

Contents

1. Option Access key Function Contents and Index lt Alt gt lt H gt lt C gt Displays the Designer Help Metastorm Web Site lt Alt gt lt H gt lt M gt Opens a browser window that takes you to the Metastorm website http Awww metastorm com About lt Alt gt lt H gt lt A gt Displays the Designer About box with release details Table 6 Help Menu Options The Tools Menu If any Process Designer add ins has been specified a Tools menu becomes available containing a menu option for each available add in Metastorm BPM Release 7 6 May 2008 31 Metastorm BPM Release 7 6 You can access the Tools menu using the shortcut lt Alt gt lt T gt Pop up Menus The following table shows the pop up menus that are displayed when the right mouse button is clicked If the mouse is right clicked The following Pop up Menu is displayed This Pop up Menu contains items from the following menus Anywhere in the Main Pane Th Bring to Front Ta Send To Back je Cut Ctrl x B Copy Ctrl C Of Delete Del Select All Ctrl 4 Properties Procedure Explorer The Edit Menu The View Menu The Edit menu The View menu Anywhere in the Procedure Explorer Expand All Collapse All New b The Edit Menu The Component Menu Table 7 Pop up Menus The active items displayed on the pop up menus will vary based on the procedure compone
2. Figure 118 Delimiter Formula Editor c The third way to enter a delimiter is to select the Formula editor icon 3 above the Delimiter field The Formula Editor is displayed Enter the required delimiter and Click the Save and Close icon r If the first entry of the delimiter is a drop down list is presented Defining a Drop down Field s Do This Properties Properties Dropdown1 Properties Dropdown1 Calculation formula C Field is dependent on another Client extensions Figure 119 Drop down Do this Tab Metastorm BPM Release 7 6 May 2008 177 Metastorm BPM Release 7 6 Use the Do this tab to specify the calculation formula dependencies and processing to be carried out when items are selected from the drop down list 1 If the drop down field may be updated as a result of a change to another data field or grid that has dependants or as a result of a button being pressed click on the Field is dependent on another check box a If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab 2 This field is visible only if you selected calculated as the field s variable You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula edi
3. C Address Cover mount DateofBirth eMailAddress Forename Postcode PremiumOffered Risk Smoker C Sumame Telephone SHOOOOE Title C Unused Figure 210 Custom Variables Dialog 2 Check the checkboxes for each custom variable you want to pass to the rule If you don t select any custom variables all custom variables are passed to the rule All system variables are always available to the rule 3 Click on the OK button The custom variables are entered into the Rule to Execute field on the Integration Wizard 4 Click on the Finish button to pass the rule connection information and custom variables back from the Integration Wizard 10 2 Scripting Scripting allows process designers to implement new functionality into Metastorm BPM Using scripting process designers can add or extend Metastorm BPM functionality as follows e Access and modify folder and other variables on the Process Engine machine e Make calls to functions on the Process Engine machine e Access and modify field values on the Metastorm Client machine Metastorm BPM Release 7 6 May 2008 287 Metastorm BPM Release 7 6 e Integrate with third party applications on the Process Engine or Client machine e Write their own functions Within the Designer the Script Editor the Integration wizard and the Formula editor may be used for scripting These features allow you to e W
4. 204 May 2008 Metastorm Inc 2008 Designer User Manual e Text e Options e Do this e Extra e Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Defining a Text Field s Text Properties read only v Figure 139 Text Tab 1 The Dataset field defines a dataset for the system to use with the text field The default option is folder which indicates that you will not be using a dataset with this field Using a dataset means that any required information necessary for calculating the information displayed in this field will be read directly from the dataset rather than require an additional call to the database Any datasets previously defined for use with this form will be displayed in the drop down list For more information on creating datasets see the Defining a Dataset Field topic in this section 2 Ifyou wish to change the caption enter the new caption in the Caption field If you omit this or have selected calculated as your variable the text field will be displayed with a default caption of Text plus an auto incremented number 3 Text within the text box will be displayed according to the alignment option selected in Alignment field 4 You can include a text string to give users a brief help message when the cursor rests over the field Type the message you want displayed in the Hint field
5. E i M call ha d oe call To Claims Processing Claims Processing Closed calls SLA a a gt comment All stages Figure 239 One Call Sample Procedure Preparation The following steps are necessary to prepare this procedure for use 1 Register the users who will participate in the procedure You may use the Set Up procedure to add sample users to your Metastorm system 2 Allocate some users to teams Do this by inserting records in the Metastorm Attributes table If you have used the Set Up procedure to set up sample users you may use the One Call and Case Management action to populate the attribute table from where the team roles are evaluated You may populate the table yourself either through the Users and Roles tool or from a directory using the Directory Extraction Service Points to Note e This procedure uses the following dynamic roles that are evaluated at run time based on data collected by the procedure Metastorm BPM Release 7 6 May 2008 335 Metastorm BPM Release 7 6 Accounts Administration Archives Claims Processing Marketing AssignedTo Team e There are no actions leaving the Marketing Accounts Administration and Claims Handling stages The actions to move folders out of these stages can be found in the Common stage Specialists e Note how the call history in this procedure is displayed on th
6. For Release 7 6 SharePoint is the only DMS Provider supported To create your own DMS Provider refer to the DMS Provider Framework documentation 7 2 Setup Before using the DMS attachment clip functionality the following need to be set up and configured e Installation Prerequisites refer to the Installation Prerequisites Guide e Document Management Support system installed from the core Metastorm BPM install e web config needs to be configured for DMS The Metastorm BPM installer should automatically configure the web config file e Publish DMS libraries e Designer Procedure Properties 7 2 1 Procedure Properties The Procedure Properties dialog has a Document Management tab which must contain the DMS Provider name A If the DMS Provider name is not entered in the Procedure Properties dialog error messages for DMS may not be displayed correctly 1 From the File menu select Procedure Properties 2 Click the Document Management tab 3 Enter the DMS Provider name and as required the Default Location Be Procedure Properties i Ioj x General Used Libraries LDAP Aliases Document Management DMS Provider SharePoint Default Location http vm2003moss 83 metastorm Cancel Hel A Figure 161 Procedure Properties Document Management tab DMS Provider the name of the DMS Provider This field is mandatory Metastorm BPM Release 7 6 May 2008 233 Metastorm BPM
7. 140 May 2008 Metastorm Inc 2008 Designer User Manual A check box The current form element will be displayed only if the check box identified here has been checked A currency field The current form element will be displayed only if the currency field selected here contains a non zero value A number field The current form element will be displayed only if the number field selected here contains a non zero value A radio group There is no entry for the radio group as a whole each option is listed individually by field name and line number from 1 upward The current form element will be displayed only if the radio group item identified here has been selected A drop down field There are two entries for each drop down field The first comprised of the field name followed by a period and the number 1 indicates that the form element is to become visible if the first entry in the field s drop down list is selected The second entry comprised of the field name followed by a period and the word other indicates that the foreground form element is to become visible if any item other than the first in the field s drop down list is selected A date time list text or memo field The form element will be displayed only if the field contains information For example the form element will be visible only if a date time has been selected an item selected from a list or data entered into a memo field A status field The
8. E txtce lo txtFin i AGB txtla _ Fd txtag EER txtac txtar EGS txtPc E eal S EH txtPH amp EA txtEm EB txtCountry E intip Expand All Collapse All Return Value Serialize to XML Serialize to SOAP Serialize to Binary Cancel Help Figure 77 Serialize Complex Types Menu 118 May 2008 Metastorm Inc 2008 Designer User Manual 5 3 ComplexTypesUtils Support Library The complex types support library provides a set of Integration Wizard functions that assist with the formatting and manipulation of complex types data The Process Orchestrator activators can use the ComplexTypesUtils support library which contains six functions These are supported as follows Process Orchestrator for Functions NET Web Services Java FormatComplexType v v x FormatComplexTypeDirect v v x GetList v v x GetListDirect v v x GetNameValueList v x x GetNameValueListDirect v x x Table 17 Supported Complex Types Functions Activated Java Beans do not have access to serialized objects by a NET serializer XML SOAP or Binary as Java supports its own serialization format As a result none of these six functions apply There is a workaround for GetList which is documented below 5 3 1 FormatComplexType FormatComplexType returns a formatted string using a specified complex type value Parameters e variableName specify a Metastorm Memo variable containing the serial
9. The final command is displayed in the When action started field of the action s Do this tab Place your cursor over the value to expand the display Properties Only start action if When action completed Deadline MakeDate 1 hour Figure 186 Formula displayed in When Action Started field The use of multiple instances of the Integration wizard can be very useful in constructing complicated formulas 268 May 2008 Metastorm Inc 2008 Designer User Manual Integration Wizard Example Conditional Operation In this example we will select the item Conditional operation and will use the Condition Builder to define the operation 1 Select Action on the procedure map 2 In the Properties editor select the Integration wizard 3 Select the Conditional Operation and select the Next button 4 Inthe Condition Builder field click on the icon next to the Formula Editor to open the Condition Builder or the Formula Editor The Condition Builder or The Formula Editor is displayed Integration Wizard When stage started The condition determining which command to run Condition Condition Builder Left formula Comparison Case L 8 J D amp Condition Formula Editor i File Edit Search View Help EO bed FD fn gt SB Figure 188 Formula Editor Metastorm BPM Release 7 6 May 2008 269 Metas
10. everybody v Figure 44 The Properties editor The Properties editor may be floating or docked to the top or sides of the main pane To dock the Properties editor position your cursor anywhere in the title bar and drag it to the far right far left or top of the main pane Once the Properties editor has been docked it can be set to appear and collapse by selecting the auto hide feature using Push Pin on the Properties title bar The Properties editor is initially a floating dialog which you may move or toggle on or off To e Dock the Properties editor click on the Properties editor title bar and drag it to the far right side of the Main Pane e Open Close the Properties editor select the Properties button from the General toolbar Alternatively you may toggle it on off by using the menu option View Properties or by selecting Properties option from the popup menu that appears when you place your cursor in the Main Pane and right click When you start the Designer the Properties editor will automatically be displayed Each map element has a Properties editor tab specific to that type of element Other tabs of the Properties editor are common to several different map elements but may display different property fields or require instructions based on the type of map element you are working with This section is organized by map elements and includes instructions for working with all Properties editor tabs for each type of map e
11. A number of explicit type conversion operators are provided which are useful for forcing type conversions when Metastorm BPM might otherwise suppose a type conversion is not required These follow the same rules as for implicit conversions e boolean attempts to convert its succeeding formula to a condition e integer attempts to convert its succeeding formula to a number rounding any digits after a decimal point real attempts to convert its succeeding formula to a number maintaining any digits after a decimal point e date attempts to convert its succeeding formula to a date time Strings and Quotes Strings do not generally need to be quoted as any string that is not recognized as any of the above will be treated as a text literal However there are certain circumstances where quotes are needed such as when a string containing commas needs to be passed as a single argument to a function call For instance a typical SQL SELECT statement will itself include commas and Metastorm BPM Release 7 6 May 2008 351 Metastorm BPM Release 7 6 quoted literal text values In order to pass such a statement as an argument to a Metastorm function the whole string should be quoted to prevent Metastorm BPM from trying to interpret the commas in the SQL statement itself Any quotation marks needed within the SELECT statement itself should be written as single quotes which Metastorm BPM treats as literal characters Not
12. Run a submit Runs a client side script when the form is submitted allowing script custom validation and custom error messages before any data is submitted The script must return true for the submit to take place Run a cancel Runs a client side script when the form is cancelled The script form will always cancel Button Functions you can use in a button s client extensions extensions Run a button Runs a client side script when the button is pressed script Data field Functions you can use in a non memo data field s client extensions extensions Run a field entry script Runs a client side script whenever the field receives the focus Run a field exit script Runs a client side script whenever the field loses the focus Grid extensions Functions you can use in a grid field s client extensions Run a cell exit script Runs a client side script whenever the cell of a grid loses the focus Run a field entry script Runs a client side script whenever the field receives the focus Run a field exit script Runs a client side script whenever the field loses the focus ComplexTypes Functions you can use with complex types SupportLibrary FormatComplex Returns a formatted string using a complex type TypeDirect FormatComplex Returns a formatted string using a complex type Type GetListDirect Returns a string using a complex type array or
13. Syntax String needed 302 May 2008 Metastorm Inc 2008 Designer User Manual Client Event Syntax String needed To run a script when a form is loaded OnLoad lt script function call gt amp language lt VBScript Jscript gt To run a script when a form is submitted OnSubmit lt script function call gt amp language lt VBScript JScript gt To run a script when a form is cancelled OnCancel lt script function call gt amp language lt VBScript JScript gt To run a script when a button is pressed OnClick lt script function call gt amp language lt VBScript JScript gt To run a script when the user enters a field OnFocus lt script function call gt amp language lt VBScript JScript gt To run a script when the user leaves a field OnBlur lt script function call gt amp language lt VBScript JScript gt To run a script when the user leaves any cell of a grid OnCellBlur lt script function call gt amp language JScript Table 39 Client Events and Required Syntax String amp For details of fields on which the field exit and field entry events are available refer to Table 40 Availability of field exit and entry events 4 When finished click Save amp Close s The Client extensions field of the Properties editor will now contain the completed script Properties Client extensions
14. Table 30 Attributes and Values Let s assume there s an employee named Kim who has the attributes shown in the following table Kim Title Director Title Manager department Sales department Marketing Table 31 Employee Attributes We know from these attributes that Kim has a double role as a manager and director but is she the manager of Marketing or of Sales Her attributes as listed here don t give us that information However if we create a relationship called position that ties together the Title attribute with her corresponding Department attributes we will understand what her functions are Metastorm BPM Release 7 6 May 2008 247 Metastorm BPM Release 7 6 and how the attributes assigned to her relate to one another The following table shows the structure of the relationship Position as it relates to Kim Name Title Department Kim Director Marketing Kim Manager Sales Table 32 Sample Attribute Structure Note that the same user Kim can have more than one value Sales Marketing assigned to the same attribute Department See Attributes above Once this information is stored in a database the data can be used by in a procedure 8 1 3 Defining Roles Using Metastorm Data Extraction Utilities The Metastorm Directory Integration Suite data extraction utilities are provided with Metastorm BPM and offer u
15. Work Offline 7 Library Name Version x Description R2 i 2 03 PM o Sample Library 5 3 23 2005 12 31 26 PM cot uee Figure 26 Procedure Properties Used Libraries tab 2 Click on the Add button A database connection dialog appears 3 Enter the database connection details and click OK The Add Library dialog is displayed ox Drag a column header here to group by that column Library wl Version ish Ti Description BRI Library M Figure 27 Add Library dialog 4 Inthe Add Library dialog select the version of the library you wish to associate with the procedure and click OK The library s details appear in the library list on the Used Libraries tab The library is bound to a procedure when the procedure is published Parts stored in a library become available for use in any procedure with which the library is associated Set out below are points that should be noted about accessing particular library parts from a procedure Metastorm BPM Release 7 6 May 2008 55 Metastorm BPM Release 7 6 2 2 2 Accessing a library s forms form segments map segments and scripts Forms form segments map segments and scripts from the associated library are available in the same way as those created within the procedure For example to associate a form with an action select the Form tab on the Property Editor and choose from the list of f
16. 304 May 2008 Metastorm Inc 2008 Designer User Manual Client Side Script Functions amp Information about client side script functions is provided in the Software Developer s Kit SDK 10 3 Glossary of Integration Wizard Items The Integration wizard is divided into a number of categories each of which has several predefined items that may be used when creating formulas in that category Some items are specific to a category while others may be used across multiple categories The following tables briefly describe the purpose of the different items available through the Integration wizard grouped by category individual categories are indicated by shaded bars The first table lists Server Categories while the second contains categories for use with Client Extensions Suggestions for completing the arguments for each item are contained in the hints displayed when you use the Integration wizard A Trailing ellipses in an item name indicate that the item requires arguments to be filled in by the user in a later Integration wizard screen SERVER ACTION RESULT DESCRIPTION CATEGORY ate Most recently Lists the most recently used items from all categories as used these are the ones you re most likely to want to use again All functions Provides an alphabetized list of all items in case you re not sure what category the item you want is listed under Action and form Lists items that are only relevant for an a
17. 4 You can include a text string to give users a brief help message when the cursor rests over the field Type the message you want displayed in the Hint field 5 The Default Action Usage field allows you to specify a default such as read only optional hidden or required for the Radio Group field Use the down arrow associated with this field to select the desired default 192 May 2008 Metastorm Inc 2008 Designer User Manual Properties Radiogroup1 Properties Radiogroup1 Figure 129 Radio group Options Tab Defining a Radio Group Field s Options Properties Use the Options tab to identify the text and layout options for the radio group The default layout displays three option buttons 1 Double click a default option to edit its caption or delete it from the list using your delete key To add radio buttons type them directly into the Radio button captions field pressing Enter after each new option Designer will create a new radio button for each item in the list For a non calculated field the text of the selected option will be stored in the database 2 Checking the Horizontal option instructs Designer to align the radio group buttons horizontally across the form If you leave this box unchecked the radio group buttons will be aligned vertically 3 The field type is displayed in the Type drop down list If you wish to change the type of field you are working with select the new type from the l
18. B A g F http vm2003mo0ss 83 ExecuteExtension ExecuteRule field DMSLocatia Find FindEntry FolderID FolderName Form Name FormatCurrency z 4 23 Modified Insert CAPS INUM SCRL INS Figure 167 Dynamic Default Location 3 Select the Text or Memo field name in the context menu to create the dynamic location at runtime 7 4 Integration Wizard Each supported DMS provider is shipped with its own Metastorm Designer library containing Integration Wizard functions These enable Process Designers to execute DMS commands in server side scripts Metastorm BPM Release 7 6 May 2008 237 Metastorm BPM Release 7 6 These files can be found in the default location lt Metastorm BPM Install gt Administrative Tools Administrative Procedures e DMS Common Library xel common DMS library e SharePoint DMS Library xel library for specific DMS provider 7 4 1 Common DMS Integration Wizard Commands Get Document Id From Clip This function retrieves the document Id from a DMS clip This function only works with the DMS Single Attachment Clip only Parameter e Variable select the custom variable which is mapped to the DMS single attachment clip Returns e Text data type Get Selected Document Id This function retrieves the document Id of the currently selected document in a DMS single attachment clip or a DMS multiple attachment clip field Parameter e Field
19. Defining Simulation Data The Properties editor displayed for actions on a Metastorm map includes a Simulation tab This tab allows you to define the settings required to run a simulation of the procedure and process the results through a simulation tool These settings include e The frequency rate for new folder creation e The probability that a given action will progress the folder at a specified rate amp Detailed instructions for defining simulation data can be found in the Working with Actions discussion in Section 3 Maps Maintain the Procedure The Find and Replace feature allows the process designer to locate and update all the places that a given element is used in a procedure This is particularly useful in a large procedure It is possible to find and replace the following element types e Custom variable e Flag e Role e Form e Field e Form segment Metastorm BPM Release 7 6 May 2008 25 Metastorm BPM Release 7 6 e Client side script function e Server side script function e Database DSN e Text Sub Strings and e Test Whole words To access the Find and Replace feature 1 Select Find and Replace on the Edit menu or click on the Find and Replace icon on the General Toolbar S i The Find and Replace dialog is displayed Find and Replace Element to find ge Add or Remove Buttons 7 Figure 6 Find and Replace dialog 2 Select an element type from the Element typ
20. Figure 120 List Tab 1 The Dataset field asks you to define a dataset for the system to use with this field The default option is folder which indicates that you will not be using a dataset with this field Using a dataset means that any required information necessary for calculating the information displayed in this field will be read directly from the dataset rather than require an additional call to the database Any datasets previously defined for use with this form will be displayed in the drop down list For more information on creating datasets see the Defining a Dataset Field topic in this section 2 If you wish to change the caption enter the new caption in the Caption field If you omit this or have selected calculated as your variable the list field will be displayed with a default caption of List plus an auto incremented number 3 Identify the variable you wish this field to use in the Variable field There are a number of options If items in the list are to be selected at run time select calculated You will be able to specify how it is calculated on the Do this tab If the list field will use any system or previously defined custom memo variables you can select a variable from the drop down list Only memo variables will appear in the list You can create anew memo custom variable by clicking on the New custom variable button and specifying the details of the variable You cannot create a new cust
21. If the content of the drop down list is to be calculated at run time select calculated from the list You can specify how it is calculated on the Do this tab If the content of the drop down list is to be stored in the database you can select a variable from the drop down list Only text or integer variables will appear in the list You can create a new custom variable by clicking on the New custom variable button iin and specifying the details of the variable The size of the variable must be large enough to hold the largest item that will appear in the drop down list You cannot create a new custom variable if you are using a dataset for this drop down field If you are using a dataset select the column name from the column names shown in the drop down list The variable you select on this tab of the Properties editor will determine the fields that appear on the drop down field s Do this tab If you are using a variable other than calculated Designer uses the variable name as the default caption for the drop down field 3 To change the caption enter the new caption in the Caption field If you omit the caption or have selected calculated as your variable the drop down field will be displayed with a default caption of Dropdown plus an auto incremented number 4 You can include a text string to give users a brief help message when the cursor rests over the field Type the message you want displayed in the Hi
22. When an action is submitted 1 Ifthe folder has a form a All fields that have a custom variable are updated in tab order b The form s When user saves form property is evaluated 2 Ifitis not an Admin form c The action s When action completed property is evaluated d The Action to Stage is evaluated e The action s Chained action property is evaluated f The action s Alert message property is updated g If the action is leaving a stage the stage s When stage completed property is evaluated The new stage s When stage started property is evaluated h For each timed action the action s Timed Event property is evaluated i Any flag actions leaving that stage have their flag name evaluated j If the action is not a loopback action or not a remove from To Do list action the To Do list and Watch list are evaluated k The action s Raise flag property is evaluated a If you are using Process Events Integration the Delegate all external events for map checkbox defines whether all the events of a process will be delegated to an external NET assembly The events will be evaluated before or after the actions in the Do this tab depending on whether or not the Perform external events before local events is checked A To use the Delegate all external events for map check box the Process Events Library needs to be associated with the current procedure Evaluation of When Formulas Metastorm Designer makes availa
23. refer to http bobby watchfire com No errors are highlighted when the Metastorm Web client is run through Bobby s Section 508 compliancy check Bobby highlights 11 user checks In order to pass Bobby s Section 508 compliancy test Metastorm BPM addresses these user checks The process designer should take Section 508 into account when designing forms Keyboard Navigation It is possible to navigate through most of the Web client using only the keyboard The following are exceptions where a mouse must be used e Date picker e Time picker The date and time pickers are visual controls which can be used to select a date or time Date and time fields can be completed using the keyboard We recommend that for multiple selections from a list you use two listboxes with an Add button and a Remove button as the use of one listbox requires a mouse Using a keyboard to move through the items of a dropdown which has dependants causes each dependant field to be updated We therefore recommend using a button to update the required field 410 May 2008 Metastorm Inc 2008 Designer User Manual Internet Explorer Text Size Setting the text size in Internet Explorer affects the text in the Web client s list filter and To Do Watch Blank Forms or Admin Forms list but does not affect form content This is under the control of the process developer The process developer may set the font size of text in a Metastorm form using
24. Metastorm BPM Release 7 6 May 2008 205 Metastorm BPM Release 7 6 5 The Caption alignment field contains a radio group listing the following alignment position options Left Places the caption to the left of the text field Right Places the caption to the right of the text field Top Places the caption above the text field Bottom Places the caption below the text field Select the caption alignment desired 6 Identify the variable to be used for this field in the Variable field There are a number of options If the text is to be calculated at run time select calculated from the list You will be able to specify how it is calculated on the Do this tab If the text is to be stored in the database you can select a variable from the drop down list Only text or integer variables will appear in the list You can create a new custom variable by clicking on the New custom variable button and specifying the details of the variable You cannot create a new custom variable if you are using a dataset for this text field If you are using a dataset select the column name the system should use to calculate the information for this field from the column names shown in the drop down list The variable you select on this tab of the Properties editor will determine the fields that appear on the text field s Do this tab If you are using a variable other than calculated Designer uses the variable name as the defaul
25. O Host Port http 128 1 20 20 8080 Additional parameters Enter as name value pairs eg name value namel valuel Figure 209 Advanced dialog 4 Enter the following Advanced details Proxy server details any Additional Parameters as name value pairs separated by semicolons amp For details of these parameters refer to Appendix D Web Service Configuration Parameters 5 Click on the OK button on the Advanced dialog 6 Click on the OK button on the Connection Details dialog The Alias is now available in the drop down list in the Rule Engine Options dialog 286 May 2008 Metastorm Inc 2008 Designer User Manual Selecting the Rule 1 Inthe Rules Engine Options dialog see Figure 207 above click on the Get Rules button to connect to the business rules engine using the connection information you have specified and retrieve a list of available rules 2 Select from the list the rule you want to associate with the selected Alias 3 Check the Use latest version of selected rule checkbox if you want the procedure always to use the latest available version of the rule even without republishing the procedure 4 Click on the OK button The rule details are entered into the Rule to Execute field on the Integration Wizard Specifying Custom Variables to Pass to the Rule 1 Click on the ellipsis LJ next to the Custom variables field The Custom Variables dialog is displayed Custom Variables
26. Subject Category abc 123 Subject Category xyz 789 abc 123 xyz 789 Subject Category xyz 789 UNRECOGNIZED FUNCTION Metastorm BPM Release 7 6 May 2008 407 Metastorm BPM Release 7 6 SelectSQL SELECT FROM eUser valid query SelectSQL SELECT FROM eUser UNRECOGNIZED VARIABLE SelectSQL SELECT eUserName ePassword FROM eUser 2 ARGUMENTS BOTH INVALID SelectSQL SELECT eUserName ePassword FROM eUser 2 ARGUMENTS BOTH INVALID SelectSQL SELECT eUserName ePassword FROM eUser valid query SelectSQL SELECT eUserName ePassword FROM eUser WHERE eReportsTo User Name INVALID SQL TEXT VALUE SelectSQL SELECT eUserName ePassword FROM eUser WHERE eReportsTo User Name valid query 408 May 2008 Metastorm Inc 2008 Designer User Manual Escape operator The escape operator is used to force Metastorm BPM to treat the following character as itself For instance VBScript functions require string arguments to be quoted Unless escaped as in the string Metastorm BPM will strip out the quotes before passing them to the function which will then incorrectly assume the argument is numeric For example Subject abe 123 abc 123 using operator Subject Category abc 123 Subject Category Category Subject Category Category Line separator T
27. Subject Flight request Map name icon Prefix of folder name everybody v 72 May 2008 Metastorm Inc 2008 Designer User Manual Figure 45 Map Tab 1 Click on the icon representing the Start Box on the map or any place in the Main Pane when the map is displayed 2 Enter the name for the map in the Map name field This name must be different from the name of any other map to be published to the same database and must begin with a letter A map name may not exceed 20 characters nor contain extended characters or any characters other than letters digits underscores or spaces A A number of words have special meanings in the databases that Metastorm BPM supports You should not use any of these reserved words when naming a map See the Reserved Words txt file for a list of reserved words This file is located in the Metastorm BPM Designer folder A You should not use system variable names when naming a map A list of system variables is contained within the oemdesigner xml file under the lt Variables gt lt Variables gt node This file is located in the Metastorm BPM Designer folder A Oracle object names should not be used for map names A When designing a map to expose as a web service the Map name should only contain alphanumeric characters and spaces 3 Metastorm BPM automatically generates a name and number for each folder created by a procedure e g Training Request 0057 To specify the
28. Text Return the left hand part of a text string Read Text You use this item to specify that Metastorm BPM should read Metastorm a text value from the database text Read external Text You use this item to specify that Metastorm BPM should read text a text value from a database Read folder Text You use this option to specify that Metastorm BPM is to return text a text value from a folder in another map in this procedure Metastorm BPM Release 7 6 May 2008 317 Metastorm BPM Release 7 6 SERVER ACTION RESULT DESCRIPTION CATEGORY ae Replace Text You use this option to specify that Metastorm BPM is to substrings replace some or all occurrences of one string of characters within another Right Text Return the right hand part of a text string SPACE Text You use this option to specify that Metastorm BPM is to compare or insert a single space into text Users and roles Lists Metastorm variables and functions used to return user names and other related information Distinguished Text Return a user s fully distinguished name their unique ID within name a directory E mail list Memo Return an email address list corresponding to a list of Metastorm users Folder Text You use this option to specify that Metastorm BPM is to return originator the name logon ID of the user if any who originally created this folder Get email Text Return th
29. e Roles Formula since it may have a different value every time the formula is evaluated Action StartsStage string read only name of the stage that the current action will move the selected folder to This is normally the target stage of the action as drawn in the procedure map If the action is a loop back then this variable will hold an empty string If the target is a system stage with its Auto forward folder to property set then this variable will hold the name of the stage to which the folder will be auto forwarded This variable should be used only in the following properties e Stage When stage started e Stage When stage completed e Action Alert message e Timed action Start this action and Timed event Form Name The function Form Name returns the form name when viewed in an action refill or submit request This function returns a value in a folder For example the form name is returned where a user has started an action and the action form is displayed string read only name of the current form Metastorm BPM Release 7 6 May 2008 357 Metastorm BPM Release 7 6 This variable should be used only in the following properties e Form When user loads form e Field Calculation formula e Field List options e Field When button pressed When field changed and When user selects row e Form When user saves form e Roles when a role is used in the Restrict Viewing to roles property of a form A The
30. row_delimiter an optional string delimiter to be placed between each row in the result set If omitted or empty a new line carriage return line feed pair is used as the delimiter headers an optional Boolean If this is set to TRUE the first row of the result set will be the column headers If omitted this defaults to FALSE a If you request headers and the SELECT produces no output the headers will still appear Returns string the requested result set with the relevant column and row delimiters obtained from the specified or Metastorm data_source For example SelectSQL SELECT FROM eUser WHERE eUserName User Name Return user details SelectSQL Read external data SELECT FROM CustomerTable WHERE CustomerName myCustomerName DSN CustomerData UID sa PWD SelectSQL Format folder history SELECT eEventTime eUserName eAlertMessage JNEWLINEO eNotes FROM ecEvent WHERE eFolderID FolderID AND eNotes IS NOT NULL ORDER BY eEventID hae From Metastorm database ae No column separators NEWLINEQ NEWLINEOQ Two new lines between rows P Using the DISTINCT or UNIQUE SQL keywords in Metastorm formulas running against some Oracle servers may cause an error in the formula evaluation For example the following valid queries may fail SELECT COUNT DISTINCT eUserName FROM eUser SELECT COUNT UNIQUE eUserName FROM eUser To ensure these queries run with Metas
31. to be called whether or not the original set up succeeded 324 May 2008 Metastorm Inc 2008 Designer User Manual Case Management This process demonstrates how Metastorm BPM can be used for a case management solution It is impossible to define in advance the route the folder will take so it is left to the user to direct the folder to the next person When a task is defined the person defining the task indicates both the team whose responsibility it is and the person in the team who will initially review the task w Assign ote New task Sy Update document k e Restart Task completed Warning Ta Completed tasks ao closed Closed tasks Figure 232 Case Management Sample Procedure Each person in the team assigned to the task undertakes their work When they are finished they either refer it to another person in the team or declare the task complete Any member of the team can add a note to the task Preparation There are two steps necessary for preparing this procedure for use 1 Register the users who will participate in the procedure You may use the Set Up procedure to add sample users to your Metastorm BPM system A There is no need to set up roles as the roles in this procedure For Action and Teanv are both populated by the process 2 Add values to the Attributes table to define which users are members of which teams The attribute name is OU The Set Up procedure can
32. 5 This procedure illustrates the use of the Manager function System lieeenlerre a stages Timed actions and the Visibility depends on facility An external Asef ene table is used to store airport information used in the Request form to populate drop down lists Before this procedure can be used two essential steps must be taken X Last saved 10 10 2007 10 31 20 AM Cancel Help Figure 1 Procedure Properties Dialog The General tab shown in Figure I above allows input of The name of the Owner of the procedure The Company that owns the procedure A Description of the procedure An optional Password to protect the opening of the procedure file The Default database connection details used to load libraries for use by the current procedure a If the password is lost then the file cannot be opened However the file could be recreated by retrieving the procedure from the server Metastorm BPM Release 7 6 May 2008 21 Metastorm BPM Release 7 6 In addition the Properties dialogue also displays the dates and times the procedure was last published and saved The Used Libraries tab displays a list of the components contained within each library associated with the procedure and their last updated dates see Figure 2 below When a library on the list is selected it may be deleted or updated using the Delete or Update button The Add button allows you to retrieve a library and associate it with
33. A JScript NET is not supported for client side scripts 5 If you are creating a client side script choose a Form or Form Segment from the dropdown Select all forms to create a common client side script If you are creating a server side script choose a Map or Map Segment from the dropdown Select all maps to create a common server side script 6 Click OK 290 May 2008 Metastorm Inc 2008 Designer User Manual The new script is added to the Scripts dialog Script Name VBScript Figure 213 New Script Added And the Script Editor dialog appears Script Editor External evaluation Figure 214 Script Editor A The Script Editor can be docked on the Scripts dialog A tabbing facility is created to allow the use to toggle from one to the other 7 You may now type a new script As you type in the script the code will be highlighted in different colors to differentiate between functions values and so forth The syntax highlighting is dependent on the scripting language selected in Step 4 above To change the font or color scheme of the text in the Script Editor select Options from the View menu On the Editor tab choose the required font name and size Note that not all fonts are supported 8 When you have completed the script go to the Scripts toolbar and click Save The Scripts dialog reappears The script you just created has been added to the list Metastorm BPM Release
34. Attempting to submit the following editable grid will cause a primary key violation FieldOne FieldTwo A Hello B Metastorm B World Table 26 Editable Grid The user must re edit the grid so that the values for the primary key field are unique Avoid Concurrency Violations Concurrency errors occur if the data in the database is altered while the grid is being edited When an editable grid is generated a snapshot of the values in the database is made While working any insertions deletions or updates are made to the snapshot When an editable grid is submitted the values in the snapshot are compared with the current values in the database for every delete or update If they differ the update will fail with a concurrency error This can be avoided in the following ways Do not include two or more editable grids that refer to the same data on the same form Ensure that data displayed in an editable grid is not highly volatile Ensure the editable grid data is displayed based on the folder s folder id Avoid the Cursor Error Too many rows affected This error may occur when an editable grid is based on a table that has no primary key defined For example a table TableTwo has two fields FieldOne and FieldTwo A primary key has not been defined The user opens a form and is presented with the following grid FieldOne FieldTwo A Hello A World A World Table 27
35. Defining a Form s Format Properties s sesesseesssesssessssesseeesreesstesserosesesserseeesscesreesseesserosereseeersese 135 Defining a Form s Do This Properties issit tescie esi isser 137 Defining a Form s Notes Properties sssssecssssssssseseesesssssesseseeessssecusneeseecsesecucneeesscsssnencacenees 138 6 4 Form Element Properties sscssscsssssessscssssscsscessssossssssscessssssesessscessesssesessscessesscssecsscesssessacs 138 OAM Depend enres sirane iN ees cL eo EEN AE NE a eR BN eR hd 138 O42 Chem EEXCCNSIONS iire voted hi as E AA I Wott Uaioe thd aH asda onde ed av ates hades 139 6 4 3 Defining Element independent Properties c scscesssesscsesssseseseceeeeseseseseeeeseneeeaeseeeeeeaes 139 Defining a Form Element s Extra Properties ssesssssssssseceesesesecesseessessesecussncucnceeeecsesencaserees 140 Defining a Form Element s Notes Properties csscsssssesecesesssesssseseseseeceesseneseneneecececeeeeseeseeees 142 6 4 4 Defining Element specific PrOPerti s c cccsccccscssesesssscssessssessesessessesessessssesseseeseeeeseeseeees 142 Defining a Frame or a RULE ecceeeeeeesesesesesesesscseseseneccccesesesesesesesescececeseseseseseseseaesesnenenssenenenenenees 142 Defining a Frame Rule s Rule Properties 20 00 00 ce cesesesscesseecesecseeecneeeeceaeeecsaeeaeeseenees 143 Defining an MAE os eee ss scat aea sav esas o EAE OEE EE ENE EEEN E EEE KE TEE EEEE O E ER 143 Defining an Image s Imag
36. Designer User Manual Integration Wizard Example Assign Value In this example we selected the variable Deadline and will use multiple instances of the Integration wizard to define the deadline 1 Select an action from your procedure map 2 Go to the Do this tab of the Properties editor Properties Only start action if When action completed Procedure Explorer 3 Properties _ Figure 179 Properties editor Do this tab 3 From the When action started field click on the Integration wizard button The Integration wizard will open Integration Wizard When action completed Assign a value to a variable Category o Most recently used g All functions Action and form information Commands Custom variables g Dates and times e Directory integration Microsoft Exchange adaptor g Metastorm BPM database g Extemal database adaptor g File adaptor g Folder information g Form fields g Lists and memos g Microsoft Office adaptor aP Numbers Text functions 1 Comment g Conditional operation g Delete attachment g Delete file gF Print merge document o Raise flag g Run asynch script Run inline script g Run server application g Save attachment g Save folder to file g Send email g Write file Figure 180 Integration 4 wizard Assign Value In the Integration wizard from the Categ
37. ESP for Castilian Spanish FRA for French FRC for Canadian French If the following arguments are not included this argument is optional If it is not provided the LOCALE_SYSTEM_DEFAULT is used Metastorm BPM Release 7 6 May 2008 369 Metastorm BPM Release 7 6 digits leading group decimal separator thousand separator negative order positive order currency symbol Returns string an optional integer that indicates the number of digits to pad after the decimal point an optional Boolean If TRUE a leading digit will be included an optional integer that indicates the size of each group of digits to the left of the decimal The valid range is 0 9 an optional string that will be used as the decimal separator an optional string that will be used as the thousand separator an optional integer that indicates the format for a negative currency value The following values are supported 0 1 1 1 1 1 2 1 1 3 1 1 4 1 1 2 5 1 1 6 1 1 7 1 1 8 1 1 9 1 1 10 1 1 11 1 1 12 1 1 13 heh 14 1 1 15 1 1 an optional integer that indicates the position of the monetary symbol in a positive currency value The following values are supported 0 Prefix no separation e g 1 1 Suffix no separation e g 1 1 2 Prefix 1 character separation e g 1 1 E3 Suffix 1 character separation e g 1 1 an optional string that will b
38. Metastorm Process Engine For all applications providing Metastorm Client functionality the Metastorm Engine is the connection point to the Metastorm database It performs the processing It is also the integration point for external applications such as email systems and other applications Metastorm BPM Designer The Designer is used to create a Metastorm procedure Through the Designer you create the maps and forms and build the business rules that are used to automate your business processes Administrative Tools The Administrative tools set included with Metastorm which includes Users and Roles System Administrator and Services Manager lets you define your users and their roles in your organization migrate your Metastorm database to a new schema and perform other administrative functions Directory Integration Suite Metastorm BPM includes a Directory Integration Suite The tools in this suite allow you to extract user related attribute data out of data stores such as LDAP directories Novell Directory Services NDS Directories stored in an RDBMS This data is cached in the Metastorm database and becomes available to Metastorm processes Metastorm Client Facilities Metastorm Client facilities can be provided through multiple options including Web Extensions This is an application which runs on a web server The web extensions allow users to access the Metastorm processes from any machine that has a web browser and
39. a Any changes to the browser proxy settings while the Designer is open require the Designer to be restarted custom Variables Optional list of String values specifying custom variables to pass to the rule If none are specified all custom variables are passed to the rule Note that all system variables are always available to the rule Returns string Result returned by the business rule For example ExecuteRule Alias MyRule ruleSetName Rulel URL http RuleEngine WebService AuthDomain AuthMethod 1 BypassProxyOnLocal True Var2 Var3 A If the Metastorm Rules web service is on an IIS machine set up to use SSL the machine calling the web service must have the certificate for the web service machine s web server in its trusted root certification authorities It also needs a certificate from the certification authority Metastorm BPM Release 7 6 May 2008 393 Metastorm BPM Release 7 6 GetAttachment folderID filename path Arguments folderID a string identifying the folder whose attachment is to be saved to a file filename a string containing the file name and extension without path of an attachment to be saved to file path a string identifying the server directory path to which filename should be saved Returns command extracts the specified filename attachment from the specified folderID in the Metastorm database and saves it to the specified path in the server file system For example GetAt
40. an array or a collection object e item manually enter the name of public field or public property name If a field name is not specified the result of calling the ToString method to an array or collection element will be used e delimiter specify a string delimiter to separate the array or collection items Default to a comma character 124 May 2008 Metastorm Inc 2008 Designer User Manual e start index position in the array or collection to start creating the delimited string Default is 0 e end index position in the array or collection to stop creating the delimited string Default is 1 which selects all items Returns GetListDirect returns a delimited string 5 3 5 GetNameValueList GetNameValueList returns a name and value delimited string using a specified complex type collection Parameters e variableName specify a Metastorm Memo variable containing the serialized complex type collection e item manually enter the name of public field or public property name If a field name is not specified the result of calling the ToString method to an array or collection element will be used The Metastorm Process Designer is required to specify the key and value type names of the collection items e nameValueDelimiter specify a string delimiter to separate the name and value pair Default is a tab character e itemDelimiter specify a string delimiter to separate individual items D
41. and the current page number of that list For example if the list is the first page of a Blank Forms list JAWS reads out Metastorm Blank Forms page one Determining the current list If you are logged in to a service a list is available in the eListsView frame When you navigate to the lists frame JAWS reads out the list type The list type is To Do Watch Blank Forms or Administration Forms To determine the filter that is currently applied to the list navigate to the Metastorm filter in the eFilterView frame and traverse the filter tree items JAWS reads out the following information for each filter item e Level in the filter tree Level One represents a service Level Two if the list is of Blank Forms or Admin Forms this represents the group that a form belongs to If the list is of To Do or Watch items this represents the map a folder belongs to Level Three represents the stage a folder is at This is only available for a To Do or Watch list e Filter item text e Selected only included if item is currently selected e Open closed e Number of siblings or children The following are examples of the text read out by JAWS as the filter tree is traversed e Link Level One My Metastorm BPM Service Closed One of One This is read out for the service item My Metastorm Service It is the only service available and the filter item is not open e Link Level One My Metastorm Servi
42. e Field List options e Field When button pressed When field changed and When user selects row e Form When user saves form e Roles when a role is used in the Restrict Viewing to roles property of a form A This function returns an empty value in a folder The function Form Name also returns the form name however unlike User Form it does so in all situations including in a folder User Input string read only value just entered by the user into a data field and not yet validated This variable should be used only in the When field changed property User Input column_number string read only contents of the specified column of the row just selected by the user from a grid The first column in the row is column 0 This variable should be used only in the following property e Grid field When user selects row At this time User Input will contain all the columns of the selected row as a tab separated array 360 May 2008 Metastorm Inc 2008 Designer User Manual User Name string read only registered user ID of the current user This variable should not be used in the following properties e Field Variable since the variable is read only e Stage Auto forward folders to Folder Variables Metastorm folder variables are used to hold data specific to the folder on which the Process Engine is performing a transaction Folder variables may be either predefined or custom variables defined for each map u
43. eFolder The Row s field if you wish to specify which row s are to be included from the table you would enter the appropriate SQL statement here For example as shown in Figure the New Hire sample procedure the formula is eFolder eParent FolderID Metastorm BPM Release 7 6 May 2008 221 Metastorm BPM Release 7 6 This formula instructs the form to search the table eFolder for the rows whose parent eParent is the current folder FolderID 5 Select the Properties editor Columns tab 6 Complete the fields on this tab For Column 1 the following fields require special handling Properties Grid1 Properties Grid1 eFolder eFolderlD eFolder eFolderN ame eFolder eSubject eFolder eMapN ame eFolder eStageN ame eFolder eFolderN ame eFolder eSubject eFolder eMapN ame eFolder eS tagel ame Column name eFolder eFolderlD Column caption Column 6 eFolder e4ctionCount eFolder eActionN ame eFolder eActionT ime eFolder eActionUser eFolder eArchived eFolder eCategory eFolder eCreationT ime eFolder eDeadline read only E v Column Name Column Caption Field Figure 153 New Hire Sample Procedure Children form Grid Properties editor Column Tab The Column name drop down list select Column 1 from the columns list Scroll through the available Column names until you find the desired column name The Column 1 designation will be replaced with the column
44. 10 CREATING FORMULAS Much of the functionality of Metastorm BPM is provided by the formulas that direct the action of procedure components These formulas may be simple or complex and may be created using tools provided within the Designer In this section we will introduce the following formula building tools e Integration wizard e Condition Builder e Formula editor This section also discusses the following topics which are useful in formula creation e Accessing Databases e Accessing Directories e Accessing Business Rules Engines e Custom Variables e Table Editor Finally the section contains a glossary of Integration wizard items grouped by category to assist process designers to make the most effective use of this tool 10 1 Integration Wizard When you are defining an element on a form or a map you use the Properties editor to specify the properties of the element For some of these properties you may wish to use the Integration wizard to enter the formulas that the Process Engine evaluates at run time The Integration wizard was created to provide easy integration to external systems such as email and databases and easy access to Metastorm functions and variables It has built in intelligence so that it prompts only with information that is appropriate for the context The main functions of the Integration wizard are to provide e Easy integration to systems that are external to Metastorm BPM Metastorm BPM Rel
45. 2008 57 Metastorm BPM Release 7 6 Confirm p Role Testlib Supervisor 2 is used in procedures Procedure TestLib continue anyway Yes Yes to All Figure 29 Warning of duplicate roles in another procedure Variables Roles defined in libraries can use either system or map variables When using a library role in a procedure the corresponding variables must be present Variables defined within a map segment are transferred to the parent map when the map segment is assigned Removing Libraries When a library is removed from a procedure all the Roles defined within the library are removed from the procedure Similarly when a map segment is removed from a procedure map the associated roles are removed from the procedure map If changes are made to libraries that remove roles then the roles will not be visible or accessible in the parent procedure Role Maintenance Roles that are made accessible to a procedure by the application of a library cannot be edited from the procedure Changes to roles must be made by editing the library 2 2 4 Editing a Library Libraries can be edited using the Procedure Properties dialog to add and remove items Within the dialog a Refresh button is available to implement the changes and reload the procedure 2 2 5 Accessing a library s LDAP Alias When a library is associated with a procedure any LDAP aliases that are set in the library are brought in to the procedure These are displayed in
46. 3 Receiving Flag Data For the receiving procedure to use flag data it must be able to capture it To do this you must define the flag data as a custom variable in the Flagged Action stage that is to receive the data 1 Select the appropriate Flagged Action and open the Properties editor 2 Select the Do this tab 3 Click on the Integration wizard button adjacent to the When action completed field to open the Integration wizard 4 From the category Commands select the item Assign value 5 Select the Variable from the drop down list If the variable has not yet been created for this map click on the Custom Variable button to create it The variable will be added to the drop down list and you may then select it 6 In the Value field type Session FlagData x where x is the position of the flag data for each flag data item you wish this flagged action to receive Metastorm BPM Release 7 6 May 2008 259 Metastorm BPM Release 7 6 Click on the Integration wizard button to open the Integration wizard From the category Action and Form Information select the item Flag data You will be prompted for the position of the flag data Select the appropriate position from the drop down list and press finish twice to return to the Property editor The formula now in the When action completed field will allow the receiving map to capture the flag data 260 May 2008 Metastorm Inc 2008 Designer User Manual
47. 31 Referenced library loaded If another version of the same library is also found you are prompted to choose which version to use Warning Library TestLib Database ework70 There is a later version of the library available than is currently used in the procedure Do you want to update to this later database version Figure 32 Later version available Ifyou click on the No button the version that is referenced in the procedure is loaded and used Library Loading Status Library Sample Library Database Metastorm The library is available in the database but has not been loaded or updated Version used in procedure 1 Version in database 2 Figure 33 Referenced version loaded If you click on the Yes button the latest version is loaded and assigned to the procedure Next time the procedure is opened the Designer will attempt to open this version of the library 60 May 2008 Metastorm Inc 2008 Designer User Manual Library Loading Status Library Sample Library Database Metastorm The library is available in the database but has not been loaded or updated Version used in procedure 1 Version in database 2 Library Sample Library Database Metastorm The library has been updated to the latest version in the database and will be stored when the procedure is next saved Version used in procedure 2 Version in database 2 Figure 34 Latest library loaded Tf another ve
48. 380 CaptureAttachment folderID filename attaChMentDAta cccccccccccccccsecscsecscssssssessssesesssees 380 Din path Alt Delimiter cccccccccccccccssccscscssssscssssssscssssssscssssessesssessseseseessseeseeseseeseeeaeeeseeeasees 380 JoEmailAddress user Alt Delimiter c ccccccccccccccccscccsevessscsscsseescssessceseessesscsessscsseeecesessseasessens 381 GetData data_source table rows column col_delimiter row_delimiter 381 GetFolder table folder variable Alt Delimiter ccccccccccccsscssssssesssssssssssssssssssesessssssasees 382 WGE E fUCNGIME esssesssitsacietees it iisca tales dade Wd deci adele dad ha 382 Manager userID role fallback ole ceececccsccccscsssssssssessssssesssssssssssssssessseseseesssesasessaseasees 383 JReadAttachment folderID filCnQMe ccccccccscscssescssssscscesscscsesssessssssesesessseecseseceeseessssesseeeasees 383 ScriptEval language file procedure map expression args vcscccccseccscsscscsseseesseees 384 SelectSQL statement data source col_delimiter row_delimiter headers 385 Staff userID role fallback role Alt Delimiter ecccccccccecssscsecsssssssssssscssssssssssssseeeesssesees 387 ToDoList folderID Alt Delimiter c ccccecccssecesessesescsseseseesseseeeeeseseeeaeseeeeeeseeeaeeeeeeeneeeeas 387 oWatchList folderID Alt Delimiter ccccccccccccccsscsssssssssssssssssssssssssscssssssseseseessesceeesseseseeseeees 387 Met
49. 4 7 Validating a Procedure After you have created a procedure you should validate it to make sure there are no errors Validation reviews the procedure to verify that no syntactical or design errors exist The Validation function can be implemented when it is available on the Component Status toolbar To place the Validation function on the Component Status toolbar either click on the Validate button or select File Validate from the menu To validate a procedure 1 Open the Validation window by clicking on the Validate button The Validation dialog opens 2 Click the Validate button at the top of the Validation dialog The procedure is validated and a report is recorded in the dialog pane 1 4 8 Publishing a Procedure Once all the components of a procedure have been defined you must publish it to the database in order to make it available to authorized users of Metastorm BPM Publishing a procedure creates the database entries necessary for the procedure to run in the Process Engine a Using reserved words for the naming of process elements may prevent the published procedure from operating correctly Metastorm BPM reserved words should not be used to name elements in a procedure To publish a procedure 1 Click on the Publish button on the General toolbar or 2 From the menu select File Publish A Confirm dialog states that the procedure will be saved if the Publish action is continued 46 May 2008 M
50. 7 6 May 2008 181 Metastorm BPM Release 7 6 e Ifthe first item in the list contains one or more parentheses the item should be enclosed in quotation marks For example London Heathrow will be displayed as London Heathrow If this item should be displayed with quotes use to represent a displayed quote For example London Heathrow will be displayed as London Heathrow Subsequent items containing parentheses should not be enclosed in quotation marks e If an item in a list contains a percentage character another percentage character must be added in order for the first to be displayed For example the item 100 will be displayed as 100 2 Delimiters that separate items in the drop down list are entered into the Delimiters field a If a comma is defined as the delimiter between items in a drop down list and the value read from a database is London England then this value will appear as two separate items on two separate lines in the list If the delimiter is then the entry London England will appear as one item London England on one line of the list Delimiters can be entered in one of three ways refer to Delimiters in Defining a Drop down List s Properties page 173 for details of how to enter delimiters Defining a List Field s Do This Properties Calculation formula C Field is dependent on another Client extensions Figure 122 List
51. 7 6 May 2008 291 Metastorm BPM Release 7 6 The script is also added to the appropriate position on the Procedure Explorer Common scripts are added to the Common item and scripts associated with maps or forms are added as sub items of the relevant maps or forms 10 2 2 Calling Server side Scripts Server side scripts are scripts executed on the machine running the Process Engine These scripts may be attached to a map or map segment or they may be common to the procedure You can attach server side script calls to actions and stages You can attach these scripts to form and field events such as when an action or stage completes when a form is loaded or when a field value changes Calling a Server side Script through the Integration wizard You can use the Integration wizard to call server scripts with the following functions e Run inline script Synchronous returns no value The Process Engine waits until the script completely executes before it continues that process e Return script value Synchronous returning a value e Run async script Asynchronous returns no value To access these commands via the Integration wizard do the following 1 Open the Properties editor for a selected item on either a map or a form In this example we will be defining properties for a Button so the Button Action option Server operation has been selected on the Button tab of the Properties editor Properties Properties P
52. Actions to a Map Adding Comments toa Mapirani rari area EE OE EE EAEN Moving Map Blements i Seir oreroraa s n EE EATE E E EA EEE ENGT Moving Map Elements sssseseseseseeeeeeeeeeteseseseeeees Copying and Pasting Map Elements May 2008 Metastorm Inc 2008 Contents Determining Map Element Alignment Determining Map Element Layering Removing Elements from a Map csssesssescsesesessesesesesesceceseesesesesesesesesesnsucncecsescaeaesnsseseenssenenenees 3 2 PrOPerties CCItOM cadsssscsssensecesuescecestensecucvovnsus cnonsucedseousseston ssesGvonsevsseonseueteonsnceseesdcedcsoncecsdeeseonauseseses 32A Ahe St rt BOK chic svete eB aod HOR OR i Rabe Creation ACHOS n nn Saati aie a ate a SR SS EEN 3 2 2 Defining Map Properties maroro airen R E E E a e as Defining a Map s Map Properties s cssesesecessssssesesesesceesesessesesesesesesesesecececsssescseneneeeecececenenenenees Defining a Map s Stages Order Properties sssecscsssesssseseeeesesecessecesseeseecseseencaeesescassnensaneneneeees 74 Defining a Map s Notes Properties sssssessecsssscssessesecscseesssssesnesenceesessecucneessscsesecucaeeseusarseneneeses 75 RASE I 11 POE EE E E AE A E E E E E 3 3 1 Stage independent TADS eccscccccccsssssssssecscseseecscsesescesesecesseseueeseseseeeeaeseeaeseeceeaeseeeeeeaeneaes Defining Stage PIOpertles narr reynosa eaea ia E REEE RRE dpe enna Defining Roles Properties Defining Do
53. Cae plas lodk taba ha dbo te Beso idles cate Manta E AT AA esha 361 To CVEGHON Timne aeea a e ake aves Lan arsed ten ss anoukoid neste a e a iet eala 361 TODO AMINE ni eenaa i E E A EA eee ies da ten ON Rites 362 TOE UY FUNC cst tases toe ec ea beth aac aged a MESA aga es eae ne A as 362 TOR Od eVID rir S EAA EEEE aida une ica EET 362 To HOLME NGINE sera n a ESAs Raho k ea RSS nha oe ade 362 ToMGDNGING oniinn eese ee ea eiere dnt etans tad buss aere TOSE pE CEE E Lear re eRe i Ea 362 ToMessagel Event _Number J cccccccccscsscccsscssssscscsssssessssesscssssessessesessessssessescsesseseseseseeseesaseeseeeasees 362 ToNotes CVent NUINDEP I eunea e EEA ole daca aed gb ted btn Waele Tse 363 COEM inad ari aT a T TA N S i aatathave Gish dialoa Wine TA 363 PRarent Senner e e COP BR OE Or EE 363 TOP TUOVUEY reani ei E A E EE R E EEA SASE 363 TOS CVVEVN GING sz a a A a AEG NR E ah 363 PStageENaMmE inen na N aa aia ia a aa dea N a ii ah 364 0112112 i RENEE NE E NENEN E N EN ENE NEE NE EN ENEN E AA 364 PUpd ted in anoen ee ea eier e e ee aao ae eE ESE i dae senasshevtesdsttes 364 E E E AEE EA E EE N A A TAA 364 EDET nE C AE AE E E E SEE EE E EEE 364 xii May 2008 Metastorm Inc 2008 Contents oF ield fieldname i icsc vcsccseststiassavevietatertinin saad orena eTa ie aE SA kE 364 Pure Functions essscscssccccseseoe cise consssscessvsssctcedesseseensdiesassscecsoroessesendcasecssscscecondesesscessscessvcsssadesovcondesosevses 365 ToADS value Janne
54. Caption DMs Single Clip Hint Default action usage optional v I Multiple attachments V Document managment support Edit only Default Location o s http vm2003moss 83 Figure 164 DMS Single Attachment Clip Options 7 3 2 DMS Multiple Attachment Clip This clip enables users to assign multiple attachments to a folder The attachments are uploaded individually To create a DMS Multiple Attachment Clip 1 Open or create a form 2 Click the Attachment Clip button E 3 In Attachment Clip Properties select Multiple attachments 4 In Attachment Clip Properties select Document management support 5 The Clip changes to a DMS Multiple Attachment Clip icon Metastorm BPM Release 7 6 May 2008 235 Metastorm BPM Release 7 6 GP ass File Name Size Figure 165 DMS Multiple Attachment Clip 6 Set the DMS Multiple Attachment Clip Properties Properties DMSMultiClip p Do this Extra Notes Penssessseed Hint Default action usage optional v J Multiple attachments J Document managment support T Edit only Default Location http vm2003moss 83 Figure 166 DMS Multiple Attachment Clip Options 7 3 3 DMS Properties The Properties Editor has the following options in the Clip tab which are relevant to DMS Option Description Multiple attachments The multiple attachments option is used to create a multi clip To create a DMS multi cl
55. Click Finish 18 Publish the procedure 5 1 4 Populating a List box A list box is populated using two memo custom variables and the ComplexTypesUtils library function GetList If the ComplexTypesUtils function GetListDirect is used only one memo custom variable is required 5 1 5 Populating a Dropdown A drop down can only contain one field from a complex type A Currently only a single field property is supported A drop down is populated by using two memo custom variables and the ComplexTypesUtils library function GetList The first custom variable retrieves the data and the second specifies the exact field The drop down is then mapped to the second memo custom variable in List Options properties 114 May 2008 Metastorm Inc 2008 Designer User Manual If the ComplexTypesUtils function GetListDirect is used only one memo custom variable is required 5 2 Map Complex Type Dialog The Map Complex Type dialog is used for mapping complex data type members and complex types to custom variables Map Complex Type amp Complex type Member type Variable Returned Format CompanyName property EGS txtCompanyName ContactFirstName property EGS txtFirstName ContactLastName property EGS txtLastName Address1 property EGS txtAddress1 Address2 property EGS txtAddress2 Area property EGS txtArea PostCodeOrzip property EES txtPostcodeorZip city property EGS extcity Phone property EB txtPhone eMail property EGS txtEmail Country
56. DOMAIN string eeren raae a n ea aS aa Seca TEE ER SE aSins 416 AUthPASSWOP SEVIS incinn ia i a da iare aia aia Sannea 416 PTOXVSCIVEF SUING S rE E EEE ATE EAN 416 PHOXVU SOP SUPUIG iue cde cdeuGaaneees bate be casa inasnbanteck ca susncais inde Loahaascagetsebn tech bute eie dade baat atdeseiebetins 416 PrOXYPOSSWOTE SUTIN dhere riain E NEI EEEE RANEA E A AN E EN ARRANA 417 BypassProxyOnLocal gt b olen esednramenukennnioreini ai a i ara a aa 417 Advanced Properties ssesessocosoocococcosocossososcocosoccosososoocosoceococosoocosoceosocosoososcesosososoososeseosososoososessosee 417 AllowAutoRedirect boolean ccccccesccssescssecssesesssessessesscasesscusesssssesseessessessesscssesscaseecsaeesseasensenses 417 KREEDALIVE Poole eia i to kick ri e EE SEE AEE E NAASE Sade vee bk AE SERTE 417 UserA BENE SITING eei neesii ERE E n EENE ESEE saben da TOSE TA ENESE SSE RES 418 PreAutthenticate boplean insis iS SNA S a ESEESE EEES EEAS AA 418 Re guestEncoding lont sones eneen eie eE tease EREE EE eE tabs 418 APPENDIX E MASKS FORMAT c ssccssssesseeeeseceessesesnseeesneesesseessseceesseesnsneesneesesseeess 419 Metastorm BPM Release 7 6 May 2008 xv Metastorm BPM Release 7 6 Designer User Manual 1 GETTING STARTED In a traditional business environment information may be passed between individuals in the form of memos files notes and voice mail messages Ideally team members receive all the information t
57. Defining a Dataset Field s Do This Properties Properties Dataset1 C Field is dependent on another Figure 108 Dataset Do this Tab A dataset field s Do this tab contains only one property the Field is dependent on another checkbox Select this option if the information in this dataset may be updated based on changes to another field Metastorm BPM Release 7 6 May 2008 165 Metastorm BPM Release 7 6 Defining a Date Time Field To add a date time field click on the Date Time button on the form toolbar and then click on the location on the form where you want the field to be displayed Designer places a date time field on the form and displays the corresponding Properties editor The Properties editor displays five tabs for defining Date Time field properties Date Time Options Do this Extra Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Defining a Date Time Field s Date Time Properties Properties DateTimel read only v Figure 109 Date Time Tab 166 May 2008 Metastorm Inc 2008 Designer User Manual 1 The Dataset field defines a dataset for the system to use with the time and date field The default option is folder which indicates that you will not be using a dataset with this field Using a dataset means that any information necessary to calculate the information displayed in this fi
58. Dialog click the Miscellaneous tab The Options display dialog is displayed a Options Publisher Editor Miscellaneous File Locations External Forms Confirm cancellation of Integration Wizard dialogs Number of files displayed in the Most Recently Used Files list 9 View Type Component Bar Style Component Bar mi Procedure Explorer Figure 16 Options selection 40 May 2008 Metastorm Inc 2008 Designer User Manual 3 Ensure the View Type is set to Component Bar There are three formats for displaying the Component Bar Figure 17 below shows the Component Bar in Classic format Component Bar Administration Forms1 Common Figure 17 Component Bar Classic style When the Component Bar has been selected the Procedure Explorer icon operates on the Component Bar to hide or open the display When the Designer is first opened the View Type is set to the Procedure Explorer If the View Type is updated this setting becomes the default setting The Component Bar can be used to add and delete procedure components as well as to select the component you want displayed in the Main Pane It has three types of display panes e Map Group given the same name as the map Each map in the procedure is identified by a tile in the Component Bar that bears the name of the map or map segment Each map and map segment in the procedure is given an auto generated name i e Map1 Map2 M
59. Do this tab will display a When Changed option instead of a calculation formula In the When changed field enter any command the system is to perform when the contents of this list field are changed For the commands in the When changed field to be performed when the field is updated the Field has dependants of its own checkbox must be checked 4 If you selected a system variable or created a new custom variable for this text field the Field has dependants of its own check box will be displayed on this tab of the Properties editor This field instructs the system to notify immediately the Process Engine of any change to this text field This is necessary if any other fields on the form are dependent upon the content of the text field A This box must be checked if any other fields are dependent upon values in this field 5 Enter any commands to be performed by the system when the text field is entered or exited in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Using a Text field to add a link to the form There are two ways in which you can add a URL link to a form using a text field 210 May 2008 Metastorm Inc 2008 Designer User Manual Properties Calculation formula http aewmetastonmcom C Field is dependent on
60. E pra Flight Blank Forms a Manager H A Traveler E Check class IR withdrawn amp Travel Department vP a Awaiting Flight IR Flight taken H E Forms amp amp Roles J B Custom Variables dje Flags Common E Forms H 8 Roles d Flags E E E tt E H Figure 13 Procedure Explorer for the Flight procedure The following table illustrates the items that are represented in the Procedure Explorer Parent Items Possible Child ltems Procedure the whole tree Maps Map segments Administration forms Common elements Map and Map segment Scripts server side and associated with a form Blank Forms 38 May 2008 Metastorm Inc 2008 Designer User Manual Parent Items Possible Child ltems Stages Custom variables Forms Roles Flags Comments Administration forms Forms Custom variables Scripts Server side and associated with a form Common elements Forms Roles Flags Scripts client and server side and common Blank Forms Creation Actions Stage Actions Form and Form segment Form segments sub element of form only Controls Scripts client side and associated with a form Comments Comments Table 10 Procedure Explorer elements Procedure Explorer allows you to e View the details of an item When you double click on the item it is displayed or sel
61. FORMULA COMPONENT scccsccsssesssesseessseesseesscenscenscenseaesecensoessoeens 348 Type face Conventions isc2escsesscsncsccccessseascostsosscessosncsenssecstessoensacesessdsccouncsesssesstestsevsdscesesseasaseeecsessess 348 Ge eral Synta K ws sccvscscscsasscacsecesonscentoossecseconsvenceesstedetonssectenssshavasosvasssuascssenssesesneuusecensouatesnseasesseoventbeds 348 Formella Vy 0S aannna n inan EAA EA A AA AAA A 350 Type COMVErSIONS sy isccsscssccdsisascessctsteossstssacasssssvecsesssocesssessussecesntessessteacescests cncetechsesseesaswiseussscsssecacwesees 350 Metastorm BPM Release 7 6 May 2008 xi Metastorm BPM Release 7 6 SUPINGS ANG QUOTES osiers dccsctsecececesesedaceovdnssCeut acseoswosgovesasetucesvacseesecevensdececessscsevesetuds Congaewavesnonce ses 351 Where Formulas May Be Used ssscssscsscsssccsssecersccorecessecersecesesersecesececseserscsesecesseserseeesesecsers 352 When Formulas Are Evaluated sscssssssssscscssssesesssssssssscscsssecesesesesesecesessssssssssssscesesesesesesesecs 353 Evaluation of When FOrmulas cccscscscscssssscscsesesesesececsssssssssssssscesesesesesesecesesssnssssesesesesers 355 POTCUIG PIU L AAEE OE EE EEN ees seb et ese cae cotn aay escuela A 356 Common SIGGOS iid erie cis cas lends este LA hea had Esse aC ao ulead eae 356 System Variables wissccsessesesssscessceseconse stsbesesacactvevonnsevocesaseccoedsevdecensstsvoreoveveseuscoadocsvdenes E S E aS
62. Grid on a Form Metastorm BPM Release 7 6 May 2008 223 Metastorm BPM Release 7 6 The user modifies the grid to FieldOne FieldTwo A Hello A Metastorm A World Table 28 Modified Grid The system has no way of determining which row has been modified and a Too many rows affected error occurs To avoid this error ensure that the tables referred to in an editable grid have primary keys defined If inserts are not required the primary key need not be displayed e Avoid errors when loading forms containing grids If the Rows property of a grid uses a variable and this variable has no value when the form is loading an error occurs Avoid this error by ensuring that the Rows property has a valid default value when the grid is initially loaded on the form 6 5 External Forms You may design forms using the Designer or you may import them from any HTM HTML or PDF form designer External forms are supported only in the web client 6 5 1 Defining External Forms Options In order to use an external form Designer requests the following information about the external form and its associated interface e The external form file type extension e A one line description of the file type optional e The path and filename of the external forms designer application optional e The path and filename of the external forms interface DLL The file type description and DLL information for HTM HT
63. If you want to use a row other than the first row of the table you need to specify the criteria the row should meet in the Row s field Clicking the Pick Row s button attached to the Row s field opens the SQL Builder which allows you to specify the criteria the desired row must meet 164 May 2008 Metastorm Inc 2008 Designer User Manual E SOL Builder Left formula Comparison Right formula l eFolder eParent a equals v FolderlD a e r Figure 107 The SQL Builder When selecting the row you should be aware of the data types the row contains If you select a row containing a memo field you may experience errors as Designer will interpret any line breaks hard returns as new rows and any tab characters as new columns If these are present incomplete data will be returned This dataset will appear in the Datasets drop down list that is displayed on other data field Properties editor tabs and may be used to provide data required by those fields A Ifa dataset is associated with a table and columns are added or removed from the table fields that reference the dataset may show the wrong values This is because Designer relies on the order and position of the database columns when associating them with form fields If a table referenced by a dataset does change in this way you should select the dataset open the Pick Tables dialog unselect the table and click OK and then re select the table
64. Integration wizard or the Formula Editor 220 May 2008 Metastorm Inc 2008 Designer User Manual Using a Grid to set up Folder on Folder Folder on folder is a feature that allows you to open any existing folder from within an already open folder It is most commonly used to allow you to view the status of child folders folders generated by sub procedures of the current procedure You may implement folder on folder by placing a grid on a form in your procedure and setting its properties to values Designer recognizes as specific to a folder on folder implementation The New Hire sample procedure Designer Sample Procedures New Hire xep provides an illustration of this technique on the form Sub process data that may be found under the New Hire Forms item in the Procedure Explorer Properties Default action usage read only Database Username Password Row mis eFolder eParent FolderlD Figure 152 New Hire Sample Procedure Children form Grid Properties editor Grid Tab To establish folder on folder 1 Place a Grid on your form 2 Open the Properties editor 3 On the Do this tab select the Folder Grid Type 4 Complete the fields on the Grid tab The following fields require special handling The Table s field you may select any table that contains an eFolderID field containing folder information In the New Hire example the Table name is
65. Name the DMS clip field name Returns e Text data type Get Folder Document Ids This function returns a delimited list of document Ids attached to the current folder Parameter e List Delimiter a delimiter to separate the document Id list items Returns e Memo data type A This function could be returned into a list field with the list delimiter set to the same delimiter type defined in the function 7 4 2 SharePoint Integration Wizard Commands Upload Document This function uploads a document to the Document Management System 238 May 2008 Metastorm Inc 2008 Designer User Manual Parameters e Server File Name the file name as it will be saved on the server e Local File the full path and file name of the file to be uploaded e Server Location the location of the DMS Provider Returns e Text data type Browse SharePoint This function can browse a specific DMS location Parameter e SharePoint Location the URL of a SharePoint Library Folder or Site Returns e Returns the Document Management System location in an XML fragment as a memo data type Check In Document This function checks a document into the Document Management System Parameters e File Name the URL of the file to check in e Comments comments to include with the checked in version of the document Returns e Integer data type Check Out Document This function checks a document out of the Document Ma
66. Number results in a Currency Quotation marks Although these are not generally required as any string that is not recognized as a function variable or operator will be treated as a text literal there are certain circumstances where they are needed such as when a string containing commas needs to be passed as a single argument to a function call A When you are assigning a date time value to a variable it must be enclosed in quotation marks E g DateTime 1 2001 11 23T00 00 00 Quotes must be used in matching pairs For instance a typical SQL SELECT statement will itself include commas and single quoted literal text values Metastorm BPM treats single quotes as literal values In order to pass such a statement as an argument to a Metastorm function the whole string should be quoted to prevent Metastorm BPM from trying to interpret the commas in the SQL statement itself as Metastorm function argument delimiters Note that putting any text in quotes does not prevent Metastorm from evaluating any Metastorm variables functions or other operators within the quoted text For example Category abc 123 abc 123 Category abc 123 abe 123 Category abc 123 abe 123 Category abc 123 abc 123 loses leading spaces Category abc 123 abc 123 keeps them Category abc 123 abc 123 loses them Subject Category abe 123 Subject Category abe 123
67. ODBC Data source in the Database field This name must have been set up on any server to which the procedure will be published using the ODBC Data Source Administrator If you want to be able to browse this database for tables and fields from within Designer then the Data Source Name DSN must also have been set up on the computer on which Designer is running If you wish to retrieve data from the local Metastorm database you should not specify a DSN If this database needs a User name and Password to enable connection enter these in the appropriate fields Enter the name of the database table or tables from the data source identified in step 1 containing the data to be displayed in the Table s field To see the Pick tables dialog with a list of the available tables click on the Pick table s button Database table names that include spaces are not supported The Pick Table s dialog box identifies the database you are looking at and displays a list of the available tables in the scrolling box on the left Select the tables you wish to draw information from and move them into the selected field in the center You may do this in a number of ways Selecting Tables Select a table by clicking on the individual table name Select multiple tables by clicking on the first desired table and then Shift Click to select additional tables in sequence or Ctrl Click to select additional tables out of sequence Moving Selected T
68. Properties editor position your mouse cursor anywhere in the title bar and drag it to the far right far left or top or bottom of the main pane Once the Properties editor has been docked it can be set to show and hide by selecting the auto hide feature using Push Pin on the Properties title bar Push Pin amp Froperties Figure 20 Push Pin to hide Properties Editor When the auto hide feature is selected the Properties editor will hide automatically when the cursor is moved out of focus To make it show again place the mouse cursor over the Properties tab that has appeared Metastorm BPM Release 7 6 May 2008 43 Metastorm BPM Release 7 6 To undock the Properties editor when docked position your mouse cursor over the Properties Editor s title bar and drag it to a new location within the main window 1 4 Saving Publishing and Retrieving Procedures The Designer provides methods for you to save your work in progress as well as options for returning to previous versions of a procedure as you refine your automated business process Most of these options are available through the File menu and some may be accessed through General toolbar buttons 1 4 1 File Locations When you save or open a procedure or library a standard Save Save As or Open dialog is displayed This allows you to locate the correct path or file It may be convenient to set the default file locations to the directories in which you store your procedure
69. Release 7 6 A In Release 7 6 SharePoint is the only DMS supported Default Location this is the location of the DMS Provider Once a default location is defined Process Users will only be able to access locations under the default location and will not be able to browse to a different location A DMS Clips created after the default location has been set will automatically have the default location set in the Properties Editor tab 7 3 DMS Attachment Clips The Attachment Clip is used to activate DMS clips There are two types of DMS clips e Single DMS Clip e Multiple DMS Clip 7 3 1 DMS Single Attachment Clip To create a DMS Single Attachment Clip 1 Open or create a form 2 Add an Attachment Clip to the form 3 Inthe Attachment Clip Properties check Document management support Properties Clip1 xj Do this Extra Notes Soecceneeeed Variable in calculated v Caption Clip1 Hint Default action usage read only v I Multiple attachments P Document managment support Figure 162 Attachment Clip Properties The clip changes to a DMS Single Attachment Clip icon EA DMS Single Clip 234 May 2008 Metastorm Inc 2008 Designer User Manual Figure 163 DMS Single Attachment Clip 4 Create a memo custom variable 5 Assign the clip to the memo variable 6 Set the DMS Single Attachment Clip Properties xf Clip Do this Extra Notes Variable memSingleClip
70. Resources the folder will re open The outcome could be different every time Therefore it is recommended that you avoid this scenario 3 4 2 Action independent Tabs The following action related tabs are common to all actions e Action e Do this e Notes Defining Action Properties To define an Action s properties 1 Select the action in the Procedure Map 2 Select the Actions tab in the Properties editor Metastorm BPM Release 7 6 May 2008 87 Metastorm BPM Release 7 6 Properties Approve Action name Approve Icon sAdction Name Figure 54 Action Tab 3 Enter the name for the action in the Action name field The following characters are not supported in the Action name property Pipe I Period Dollar Sign Equal Sign Back Slash Quotation Mark Forward Slash Percent Comma Plus Colon Semi colon Open bracket lt Close bracket gt For User actions this name is displayed on the button used to invoke the action in the Metastorm client It is also shown in the audit trail of a folder on which this action has been performed The maximum character length for this field is 31 If you do not specify a name Designer uses the default value of Action plus an auto incremented number 88 May 2008 Metastorm Inc 2008 Designer User Manual You cannot draw two actions wit
71. TO E NS 327 POIitS to Nole nenrarerrei reiri rse tr r E a Ei EE ER EET E EREA E E T Na 327 Lead THACKING iniinis a Nai AE ra ABES ESEE ENE ER TENT 329 Preparation sennu nni iri N EE E EEE E E AEE ANTEE 329 TROTILO ETO SEE EE E E aU eS 329 NOW ELIT oa E E E A R A Aa gata shes E tetas a 331 Preparations ses TE ENOT ESE AE AE AA EEA AAEN E TEE EEEE EEE 333 BOs toi Note eeh eee Nt oie tad TR E EA ORA EEOAE ARIE TATR 333 One Colau e Aniki dain Ga aed Mid naan aia 335 Preparat Oi eneren ee a pouty pA E aaa NE i PEENE E N SE N 335 Points tO NOE renees a aE ae E E a r AE er A a erea 335 Purchase Order arenero a EEEE EE E N EE ea aA AOTRE 337 Preparations swere taenn EEE ca a E EE T AO E hee E a 337 POMS tO NOt eri erre EENE ERNE AA ERAU EE EEE 337 1 AORE A E E E T E E E E A 339 Preparahon issih eibaetaheanedaka ieitone adhd a a a E ieee ce hae 340 Points 10 Notemea eii rr wedge OO ees abe dees tea ee edad n TEE TT seve pean SNS 340 WIZOIG P AE ENO a Ne a ah he ela te ion vol Le ta eet 342 Preparation eiiis A sods cysesposd Sass EE esses A EEE E eiS REST 342 Points toUN GLE a a a AR R N NA EA 342 BRI 343 Preparation sgg ieod saena enee eer aea ERa SE E Aea aE aA E I Ea e E AA E E EE NS 344 Points tO NOt ASEEN AENEA ENTIE E EETAS 344 Lema PO eane e E ar a e ea an at 345 Points to N tese nteress e aia E iaa EENE SEEE EAE EEEE EEEE N a 345 Send Maile Enon E EE ANR E NES O EE A EE ARN be 346 Points to Note reneo A E E E Ee a e 346 News 347 APPENDIX B
72. The default option is folder which indicates that you will be using the current folder as the source of data for this field and not a dataset If you associate this field with a variable Designer uses the variable name as the default caption for the currency field If you wish to change the caption enter the new caption in the Caption field If you do not provide a caption or have selected calculated as your variable the currency field will be displayed with a default caption of Currency plus an auto incremented number Identify the variable you wish this field to use in the Variable field If the currency field is to be calculated at run time select calculated from the list You will be able to specify how it is calculated on the Do this tab You can create a new custom currency variable by clicking on the New custom variable button and specifying the details of the variable You cannot create a new custom variable if you are using a dataset for this currency field Metastorm BPM Release 7 6 May 2008 159 Metastorm BPM Release 7 6 If you are using a dataset select the column name the system should use to retrieve the information for this field from the column names shown in the drop down list The variable you select on this tab of the Properties editor will determine the fields that appear on the currency field s Do this tab 4 The Caption alignment field contains a radio group listing the following alignm
73. Use the BizTalk Rule Deployment Wizard to deploy the BRI Insurance Policy xml file 2 After publishing the procedure ensure that a user has the Insurer role 3 On the rules stage you may need to edit the Rule Connection string to specify a different machine on which the Metastorm Rules Service is installed 4 Ifthe rule execution fails or times out the administrator stage allows an administrator to resubmit a quote The event log or designer log may explain why the rule failed 344 May 2008 Metastorm Inc 2008 Designer User Manual External PO This procedure demonstrates the integration with BizTalk Servers offered by the Metastorm Accelerator for BizTalk It is based on a tutorial provided by Microsoft at http msdn microsoft com library en us dnbiz html learnbtsanchor as First action a First stage Figure 246 External PO Procedure Points to Note After installing the BizTalk sample 1 Set up a partnership agreement using the Metastorm B2Bi admin procedure 2 From the BizTalk Document Editor open the ReceivedPOSchema xmil file and publish it the BizTalk server s WebDav repository 3 From the BizTalk mapping tool open the E POMap xmil file and save it to the BizTalk server s WebDav repository 4 From the BizTalk Messaging Manager modify the Channel To Contoso so that the outbound document points to Metastorm PO xml and the mapping points to E POMap xml 5 From the same tool modify the Co
74. User Manual 5 If you choose to enter values as percentages you must specify the target value in the 100 property The threshold values will be treated as percentages of this target value and can be greater than or less than this value The target value can be calculated using a formula A These values may be entered as formulas Remember that scripts can be called via a formula in order to retrieve data from other systems Properties Status1 Drill down to Action form Action Figure 137 Status Options Tab Defining a Status Field s Options Properties Use the Options tab to specify drill down options and custom graphics 1 To allow the user to Drill down to a form select the Action form radio button and enter the name of a blank form or admin form and the map or admin form group in which it occurs 2 To allow the user to Drill down to further information via a URL select the URL radio button and enter the URL in the text box 3 Designer provides default Safety Warning and Danger pictures for the status field To replace these pictures click on the More pictures button associated with each picture To reset a picture to the default right click on the picture and select Reset Image A The default pictures are in GIF format If an alternative format is used the field may not appear as expected when viewed in the Web Client Metastorm BPM Release 7 6 May 2008 203 Metastorm BPM Releas
75. Value gt Return string format variableN ame memo memGetC lientRecord format memo on Please call lt ContactFirstName gt lt ContactLastName gt at lt CompanyName gt ol Figure 79 FormatComplexType Example A Text can be formatted for example Please call lt ContactFirstName gt lt ContactLastName gt at lt CompanyName gt on lt Phone gt LineFeed LineFeed lt ContactFirstName gt lt ContactLastName gt LineFeed lt CompanyName gt LineFeed lt Addressi gt LineFeed lt Address2 gt LineFeed lt Area gt LineFeed lt City gt LineFeed lt PostCodeOrZip gt LineFeed lt Country gt 14 Click Finish 5 3 2 FormatComplexTypeDirect FormatComplexTypeDirect returns a formatted string using a specified complex type value Parameters e variableValue specify a value of a memo variable or a value which is obtained by calling another activated method and not stored in a memo variable field The value must Metastorm BPM Release 7 6 May 2008 121 Metastorm BPM Release 7 6 contain a serialized complex type value The serialized complex type value must be either an array or a collection object e format manually define the return string format Returns FormatComplexType returns a formatted string FormatComplexType Example In the example below the function GetClientRecord is used to obtain the client record which is equal to the ID entered in the intInputID field m
76. a description for the form This description will be displayed in the Blank Forms list of the Metastorm clients Using the Clone new folder option The Clone new folder option creates a copy of the selected folder and automatically sets its parent Z parent variable as the original folder When a folder is cloned the original folder remains at the same stage and the cloned folder moves to the next stage The parent folder is not updated or changed when it is cloned except its folder lock is removed All of the folder s custom variables and the following system variables are copied e Category e Deadline e MapName e Priority ServerName e Subject a If a conditional action is marked Clone new folder and the expression is evaluated to true a cloned folder will be created In this case any subsequent conditional actions will be evaluated against the parent folder in priority order A The audit trail the list of actions performed on the original folder stored in the eEvent table is not copied to the cloned folder Defining Do This Properties The Do this tab lets you specify one or more commands to be run when the action is invoked or submitted 90 May 2008 Metastorm Inc 2008 Designer User Manual Properties P flight request When action started CostCenter 11PH Priority 6 Class Business Traveler User Name When action completed sSubject Flight requested Deadl
77. a map segment Flags associated with common are not supported When a library containing a map segment is associated with a process and that map segment is associated with a map flags associated with that map segment become available to the map The flags will not appear in the flag dock window but will appear in the relevant properties of the property editor 2 1 3 Saving and publishing a new library When you have added the required parts to the library save and publish it in the same way as you would save and publish a procedure A library must be published before it can be used within a procedure By default a library is saved with a xel file extension The number of characters in the filename cannot exceed 31 2 2 Associating a Library with a Procedure This section describes how to associate a library with an existing procedure and how to reference library parts from the procedure AAA library can be updated only when the xel file is open in the Process Designer It cannot be updated when a procedure with which it is associated is open in Designer 2 2 1 Using a library To associate a library with a new or existing procedure 1 Open the Procedure Properties dialog and select the Used Libraries tab 54 May 2008 Metastorm Inc 2008 Designer User Manual E BRI Properties wi General Used Libraries LDAP Aliases Document Management Drag a column header here to group by that column
78. a previous action on this folder Earlier note memo You use this option to specify that Metastorm BPM is to return the note associated with a previous action on this folder Folder action integer You use this option to specify that Metastorm BPM is to return count the number of actions including creation that have been performed on this folder Folder text You use this option to specify that Metastorm BPM is to return category the text value stored in the predefined Metastorm variable category Folder Date time You use this option to specify that Metastorm BPM is to return deadline the deadline set for this folder Folder ID text You use this option to specify that Metastorm BPM is to return the internal identifier for this folder Folder map text You use this option to specify that Metastorm BPM is to return the name of the map to which this folder belongs Folder name text You use this option to specify that Metastorm BPM is to return the name shown on Watch and To Do lists for this folder It will display the name of the folder which is also what appears on the Watch and To Do lists but not only that because it can return the name even if the folder doesn t appear on anyone s list at its current stage Folder text You use this option to specify that Metastorm BPM is to return originator the name logon ID of the user who originally created this folder Folder parent text You use this option to specify that Metastorm BPM
79. a specific map and are available to folders associated with that map however it is possible to use functions such as flags and SQL queries to make custom data from folders in one map available to folders in another map 10 1 9 Defining External Tables The External Tables feature lets you create supplementary tables from within the Designer This eliminates the need to use database administration tools to create these tables externally on each machine running a specific procedure External tables created using the Table Editor are stored as part of the database External tables may be used to simplify procedure creation For example if you want to populate a drop down list with pick items you can create the item list in a table rather than typing a list of items into the form element s property field Creating External Tables To create an external table 1 From the Menu Bar click View External Tables Designer opens the External Tables dialog If no tables have been defined the dialog will display a message to that effect similar to the following 280 May 2008 Metastorm Inc 2008 Designer User Manual BB External Tables No external tables currently defined Cancel f Help Figure 201 External Tables Dialog No Tables Defined 2 From the Table options on the right select the Add button Designer opens the Add Table dialog box Add Table Table name Figure 202 Add Extern
80. a string identifying the server directory path name and extension of a script file to be loaded If empty no script will be loaded from file If the specified language is JScript NET this is a list of files to be added to the script host when the assembly is compiled These files will only be looked at when the script is compiled This occurs the first time it is used on Engine start up and for every new version published thereafter if the specified language is VBScript or JScript this is a string identifying a procedure holding a script attachment to be loaded If empty no procedure script will be loaded If the specified language is JScript NET this is the name of the procedure script to be pulled in when the assembly is compiled This can be left blank to indicate no procedure script if the specified language is VBScript or JScript this is a string identifying a map holding a script attachment to be loaded If empty no map script will be loaded If the specified language is JScript NET this is the name of the map script to be pulled in when this assembly is compiled This can be left blank to indicate no map script if the specified language is VBScript or JScript this is a string containing a statement in the specified language to be executed This will typically be a call to a function within one or other of the scripts loaded from the specified file procedure and or map If any arguments need to be quoted as
81. all users However if this cannot be avoided the following workaround can be applied Workaround Continue to use the everybody role to add a folder to all To Do or Watch lists To allow all users access to an action we suggest you create and use a new role called anybody Assign the following formula to the role SUser Name When this formula is evaluated it will return the username of the current user and consequently avoid the need to search a long list of usernames Metastorm BPM Release 7 6 May 2008 253 Metastorm BPM Release 7 6 9 DEFINING FLAGS Flags are a trigger mechanism used by procedures to allow communication e From one map to one or more other maps within the same procedure e From a map in one procedure to one or more other maps in a different procedure e Via ActiveX controls or the command line from an external application to one or more maps in one or more procedures Flags may be used in conjunction with Flagged Actions to trigger updates to one or more existing folders or to create new folders as in the case of sub procedures When a flag is raised one or more data items may also be passed to each folder that is waiting for that flag This data is known as Flag Data Flags and the flag data they pass are defined through the Flags dialog This section explains how to create flags and define flag data 9 1 Flags Flags may be raised within a procedure internal flags or by the us
82. allows you to specify a default such as read only optional hidden or required for the Memo field Use the down arrow associated with this field to select the desired default Defining a Memo Field s Do This Properties Properties Memol Calculation formula C Field is dependent on another Client extensions Figure 124 Memo Do this Tab Use the Do this tab to specify the calculation formula dependencies and processing to be carried out if the contents of the memo field change Metastorm BPM Release 7 6 May 2008 185 Metastorm BPM Release 7 6 1 Ifthe memo field may be updated as a result of a change to another data field or grid that has dependants or as a result of a button being pressed click on the Field is dependent on another check box ra If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab 2 The Calculation formula field allows you to specify how the contents of the memo field are calculated This field is visible only if you selected calculated as the field s variable You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 3 Ifacustom variable has been assigned to the memo field the Do this tab will display a When Chang
83. also be used here to populate the Attributes table In a real world implementation this would typically be populated from and managed in a directory Points to Note e This can be built into the middle of a more structured process if required Metastorm BPM Release 7 6 May 2008 325 Metastorm BPM Release 7 6 e The Forward action makes use of the Rebuild To Do list feature If this were not used then even though the user has selected a person for the folder to go to next it would not move from their To Do list onto the list of the person they selected e In this example there is no option to change the team that the item has been allocated to This example could be amended so that either any team member or a team leader could refer the item to another team 326 May 2008 Metastorm Inc 2008 Designer User Manual Flight This procedure illustrates an approval and booking process for travel requisitions t Justify t e Flight request gt Question Pa Traveler on a j withdraw aa v J class s kovrave f Automatic withdrawal ppr Coach Change flight YP flight request n Warning Travel Department Booked Y 4 i gt Flight taken Cancel Flight Flight taken Awaiting Flight Withdrawn Figure 233 Flight Sample Procedure Preparation The following are steps necessary for preparing this procedure for use 1 Register the users who will participate in the procedure You may use t
84. an external form 2 In the File name field enter the path and filename of the form you wish to use Selecting the Browse button on this line will open a standard File Open dialog allowing you to browse for the file When you publish your procedure Designer will store the file information in the database and make the form available to Metastorm users A Any time you make changes or edit the form file you will have to use the Refresh button on this tab of the Properties editor to update the file information stored on the database the next time the procedure is published 3 To create variables for fields in your external form click on the Fields button amp Edernal Form Fields Available fields Selected fields Figure 158 External Form Fields Designer will display an External Forms Fields dialog box as shown in Figure 158 This dialog provides a list of available fields from the external form and allows you to select the fields for which you would like to create custom variables 228 May 2008 Metastorm Inc 2008 Designer User Manual 4 To make changes to your external form click on the Edit button Designer opens the external forms designer application defined for this file type refer to the instructions for Defining External Forms Options on the previous pages You may edit your external form and save the file according to the conventions of the application 5 When you have finished making chang
85. an a ona 127 OLAI The Form Toolbar srecne e e n E a T E T 128 6 1 2 Working with Form Elements ccccecsssssesessssssesesecscseseeecsesesceaeseseeecaeseeaeseeeeeaeneeaeaeeeeeeaes 128 Adding Elements toa POM e eare aea a era E eoe eE e e E E a E EESE AEAEE EEES 129 Selects Form mI LEa DTE MA AA eOe EAEE EE E E E 129 Moving Form Bement sisese ere a e AEE asecinteoivnbcened ec AEE RE E E IE EES 130 Copying and Pasting Form Element cssssscssssssscseseesssssesesseseesssesecessceseececsecucseeucacessscasanenees 130 Aligning Form Elements arster ner Ea e eaaeo REA Raa AES EE EO EEEE N EEE 130 Determining Form Element Layering ee seeeeeseeseresesrsesssesssesstestesstessttessteerreesstessrenressrresereeee 130 Deleting Elements from a FOr vsere eee e eeaeee o aaa aa RAES A eae E aNG 131 vi May 2008 Metastorm Inc 2008 Contents Placing Form Segments on a Form esssssssssecsssssseeseseesssesesucsesucseaceecscsesucneeeeecseseeusueeesssseaenees 131 6 2 Properties editoi sississccssiesicscsececsesssenstsotscssensscenssonseesstessoonsbesssacsecesbevssestcosstes sesesessescsuesssessc enstess 131 6 3 Creating a New FOrin sssesicscssccscesssenscsococsscesstsnssanssesstesscencesinsasessevbcecsecssessssesscescecssecsesesbsecseenssess 132 6 3 1 Defining Form Properties oosa a E E E EEA ESSA 133 Defining a Form s Form Properties ss seesssseseseesssceseseesscesreesscessseoseseeseesseeerreesscesntesseceeserorseseee 133
86. and teams for both the Case Management and the One Call procedure Builds a staff hierarchy for use by the Metastorm Manager functions in the Flight procedure Inserts initial data into the Flight_Airport table that is used to populate the Airport drop down fields in the Flight procedure The publication of this procedure creates the Flight_Airport table in the Metastorm database Inserts initial data into the Purchase_Order_Item_Code table that is used to populate the Item drop down column in the Purchase Order procedure The publication of this procedure creates the Purchase_Order_Item_Code table in the Metastorm database Preparation No preparation is required other than publishing the procedure Only a user with the Administrator role may run the procedure Points to Note The conditional Set up action from the Set up requested stage causes the possibly lengthy database operations to be performed by the Process Engine as a background activity without forcing the user who submitted the original request to wait for these operations to complete The ExecSQL on the initial request action removes the entry for this procedure from users Blank Forms to prevent any attempt to run the set up procedure multiple times The Setup completed or failed common stage allows the Delete action which removes the users attributes and additional table entries created by the original request
87. and Folder information is selected followed by Get Child Text the custom variables displayed are those of the parent map not the Child map as expected 8 1 5 Deleting Roles from the Roles List To delete roles from the roles list first open the procedure whose roles you wish to modify 1 From the General toolbar click on the Roles button Alternatively select View Roles from the menu The Roles dialog appears 2 Select the Role in the Roles list and then click the Delete button press the Delete key on your keyboard or right click in the Role dialog and select the Delete icon The Role is deleted from the list A No warning is given that the role is about to be deleted A You cannot delete the default roles Access Everybody Metastorm Administrator Metastorm Guest Originator To Do list Watch list When these are selected the delete button is disabled 8 1 6 Editing Roles To edit roles first open the procedure whose roles you wish to modify You cannot edit the default roles created by Designer 1 Select the role to be modified in the list 2 Double click the selected role A Role dialog box is displayed Role Security Manage Description Issues security passes Map Common bi Formula JB lsGetData eattribute OU O0U eattribute OU AND OU ev 250 May 2008 Metastorm Inc 2008 Designer User Manual Figure 170 Role modification dialog 3 Modify the
88. and the actual number of sales falls below 10 of 120 i e 12 the status field will be in the Danger state If the actual number of sales is greater than 50 of 120 i e 60 the status field will be in the Safety state Otherwise the status field will be in the Warning state Metastorm BPM Release 7 6 May 2008 201 Metastorm BPM Release 7 6 To add a status field click on the Status button on the form toolbar and then click on the location on the form where you want the field to be displayed Designer places a status field on the form and displays its properties in the Properties editor A status field is always read only The Properties editor displays five tabs for defining status field properties Status Options Do this Extra Notes amp For details of the Extra tab refer to section 6 4 3 Defining Element independent Properties on page 139 Defining a Status Field s Status Properties Properties Status1 Safety threshold Danger threshold Figure 136 Status Tab 1 Enter the Value of the field as a formula 2 Enter a value for the Safety threshold as a formula 3 Enter a value for the Danger threshold as a formula The Danger threshold can be greater or less than the Safety threshold 4 You can enter the value and thresholds as real values or percentages If you choose to enter percentages check the Values as percentages check box 202 May 2008 Metastorm Inc 2008 Designer
89. another Client extensions al URL Figure 145 URL in Do this tab 1 Using the calculation formula a Add a text field to the form b Set the Caption field on the Text tab The link that appears on the form will have this caption c Ensure the Variable field on the Text tab is set to Calculated d On the Do This tab set the Client Extensions to URL Enter the URL in the Calculation Formula field Using the calculation formula is only available in the Web Client and the Windows Client using web amp forms 2 Assigning the URL to the field s custom variable c Add a text field to the form d Set the Caption field on the Text tab The link that appears on the form will have this caption e Associate a custom variable with the field using the Variable field on the Text tab f On the Do This tab set the Client Extensions to URL g Atan appropriate point in the map assign the custom variable with a URL For example add the following formula to an action s When action started field SURLTextVariable http www metastorm co uk Metastorm BPM Release 7 6 May 2008 211 Metastorm BPM Release 7 6 These two methods will produce a link on the form when the client accesses it A Open Web Links Sales PortaloMetastorm BPM DER URL in Claculation Formula URL assigned to variable Figure 146 Text field links on a Metastorm form A It is not possible to change
90. be in the form of a set of single values or label value pairs When label value pairs are used the labels are shown in the drop down and the values are passed to the database You cannot specify a static list containing a label Wvalue pair 7 Selecting the relevant column type allows the grid cells to be formatted according to their type To set the formatting options for the column click on the Column Type Properties button The formatting options shown in the following table are available Column Type Column Type Properties dialog Column Type properties note Date Time Date Time column eFolder eFolderiID Format O Date O Time Both C Disable time zone adjustment SJL Latest gg Earliest f you select the Date or Both format the Earliest and Latest options become available If you select the Time or Both format the Disable time zone adjustment checkbox is available If you leave this unchecked the values in this column will be displayed in the client s local time Dropdown Dropdown column eFolder eFolderID List Options Red Yellow B luel To populate the cells in a dropdown column enter the values into the List Options box or use the Integration wizard or Formula Editor to populate the list at runtime For further information refer to the information on defining drop down fields 218 May 2008 Metastorm Inc 2008 Des
91. calculated values With any other input field the value is sent back only when the user submits an action form These fields appear on the Do this tabs for the following data fields Properties editors 138 May 2008 Metastorm Inc 2008 Designer User Manual Check Text List Currency Number Dropdown Memo Date Time Radio group Signature ra Unmapped data fields status fields grids or datasets have only the Field is dependent on another check box 6 4 2 Client Extensions Client Extensions are used to specify client specific behavior The Client Extensions field of the Properties editor Do this tab allows a process designer to specify client side script functions called when a field is entered or left when a form is loaded submitted or cancelled when a button is pressed or when a grid cell is left You may create or edit the formula using either of the following tools e Integration wizard opened by clicking on the Integration wizard button e Formula editor dialog opened by clicking on the Formula editor button A White spaces should not be included in formulas entered into the Client Extensions field 6 4 3 Defining Element independent Properties The following form properties tabs are element independent and are common to all form elements e Extra e Notes Metastorm BPM Release 7 6 May 2008 139 Metastorm BPM Release 7 6 Defining a Form Element s Extra Properties Properties Rule1 Prop
92. collection GetList Returns a string using a complex type array or collection GetNameValue Returns a name and value string using a complex type ListDirect GetNameValue Returns a name and value string using a complex type List Table 42 Glossary of Integration wizard Client Categories 320 May 2008 Metastorm Inc 2008 Designer User Manual Appendix A Sample Procedures A set of sample procedures is supplied with Metastorm BPM They are intended to help you to understand some of the features available in the product Each of the procedures illustrates a business process that may be built with Metastorm BPM You can use these procedures as a starting point for your own process development or modify them for your own use Table 43 below lists the sample procedures that are shipped with Metastorm BPM A sample library used by these procedures is also provided In addition the Send Mail procedure requires the Mail library Name Description Uses Sample Library BRI Demonstrates the use of Metastorm BPM with a business rules engine In Yes addition to the Sample Library this requires the BRI library which is located in lt installfolder gt Metastorm BPM Designer Sample Procedures BRI 2006 Case A procedure with no predefined route Each time a user takes an action they Yes Management decide who needs to act on the folder next External PO Demonstrates the
93. color palette from which you may select a background color 4 To select the default font for the shadow form scroll through the available drop down list or Click on the Fonts button Metastorm BPM Release 7 6 May 2008 229 Metastorm BPM Release 7 6 5 You cannot change the name or the caption of a field on a shadow form as these are used to map to the fields in the external form a Formatting defined for a shadow form will not be used when the form is displayed in its original state This also applies to any repositioning of fields on the form that you may do through the Form Editor 6 In the Restrict viewing to roles field select those roles that should be allowed access to the form This property definition applies to both the external form and the shadow form Defining an External Form s Do This Properties Properties When user loads form When user saves form all j Figure 160 External Form s Do This Tab Actions that should be performed when the form is opened or closed are defined on the Do this tab of the Properties editor 1 Inthe When user loads form field enter any commands the system should perform when the form is opened whether as a tab in a folder or as an action form You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor
94. condition treat the following character as a literal rather than an operator boolean convert following formula component to a different type integer real date e Binary infix operators which perform some operation on the formula components to either side arithmetic and Boolean logic gt lt gt lt lt gt amp and assignment command command separator e A tertiary infix operator which Tests the first condition formula component before If true evaluates the second formula component after but before Otherwise evaluates the third and final formula component after e Grouping outfix operators parentheses used to control the order of evaluation of arithmetic logical and conditional operators with nested terms being evaluated before outer terms wu matched pairs of quotation marks Metastorm BPM Release 7 6 May 2008 349 Metastorm BPM Release 7 6 Operators are covered in greater depth in the final section of this document Formula Types Any formula and any term or argument within a formula has a type This may be any of e number a numeric value This may be a literal e g 77 a real or integer or currency variable Priority a function result sLength a string or the value of an arithmetic expression itself composed of numeric values Priority 1 ora conditional expression which returns numeric values Priority gt
95. containing the priority of the message an integer containing the length of time the message will remain in the queue 1 indicates infinite time a string containing a set of custom parameters MSMQ queues support the following additional parameters in the params string PRIVATE FALSE default TRUE TRANSACTIONAL FALSE default TRUE The private parameter indicates that the queue is private Unlike public queues the system cannot determine automatically whether the target queue is transactional The transactional parameter is ignored for public queues but for a private queue it defines whether the message is sent within a transaction AA private queue will not return an error when sending messages to an invalid queue path This is by design TRUE on success otherwise an Metastorm formula exception Metastorm BPM Release 7 6 May 2008 399 Metastorm BPM Release 7 6 Script language file procedure map statement args Arguments language a string identifying the scripting language processor to be loaded VBScript JScript and JScript NET are supported by the Designer file if the specified language is VBScript or JScript this is a string identifying the server directory path name and extension of a script file to be loaded If empty no script will be loaded from file If the specified language is JScript NET this is a list of files to be adde
96. database A In order for a signature field to incorporate the current user s ID or user name a text field called UserID must exist on the form but this can be assigned to any variable or be calculated When the signature script runs the value of the UserID field is included in the signature otherwise the text Metastorm user is added In addition the procedure designer must assign the logged on user s name to the UserID field To add a signature field click on the Signature button on the form toolbar and then click on the location on the form where you want the field to be displayed Designer places a signature field on the form and displays the corresponding Properties editor The Properties editor displays four tabs for defining signature field properties e Signature e Dothis e Extra e Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Metastorm BPM Release 7 6 May 2008 195 Metastorm BPM Release 7 6 Defining a Signature Field s Signature Properties Properties Signaturel J Signature Dataset folder Variable calculated Caption Signaturel Caption alignment ret OO Right Bottom Hint read only v Figure 131 Signature Tab 1 The Dataset field defines a dataset for the system to use with the signature field The default option is folder which indicates that yo
97. decimal places Text functions Lists Metastorm functions used to return short text values text text Allows you to type in a literal text string Character text You use this option to return the character value of an ASCII code Character integer You use this option to return the ASCII code of a character code Comment Adds comments to your code Concatenate text You use this option to specify that Metastorm BPM is to substrings concatenate two substrings If you were to concatenate a variable containing the string FirstName with a variable containing the string LastName the result would be FirstName LastName Conditional Text You use this option to specify that Metastorm BPM is to return text one text value if a condition is TRUE and another if it is FALSE Count Integer You use this option to return the number of characters in a characters piece of text EMPTY Text You use this option to specify that Metastorm BPM is to compare or reset a text list or memo value to empty Evaluate Text You use this option to evaluate a formula Extract Text You use this option to specify that Metastorm BPM is to substring extract a substring from a text or memo Find Integer You use this option to specify that Metastorm BPM is to find substring where one string starts within another Get entry Text Return a specified entry or line number from a list or memo Get email Text Get the email address of a specified user address Left
98. e a as 356 ToA CHOMNGINE ien aeaaea e a sede aea E babe atk eiai as 356 WACON NOTES siriasi EAA AA AEEA ERNA E EEA E 357 TA CHON SUATISSIGGE irisi N a EE ETENEE N NET E T antes 357 TOF ONNE 33 iie e E A A AAAA A A A A 357 P rocedur e NONE Zisainy a ta aE EA E A TA S T A a A 358 AK A E a TAO IE A OEE E EE E EE O E b Dae 358 TOSES F IAEN GING 5 i E EE cas betas ab Seba EENE EEES ENEE S ERNER EEE 358 Session FlagData column_number Juececccccccscccccscscsssecssssssscsssssescssssssscsesssesesessseseseeeseeeeeeseeees 358 Session FAQ RAISED irs E A EE EE E REA KAE E REAA 359 PSystem NAME cv cen Sieh aere eepe a ae e E EEE REEE a ESE Eao reee IER OSES aeaieie eek esin tes 359 EN a A OEE EEO ES EA 359 System TNE e a Er E EEE NE EEEN N OE O a 359 OSVETI SETS orir a a E E S T A A O R 359 PUSE ErrO auraa aa a a e e e e iee burda ave heal a iaaea 360 TOU SON SE ONIN narea a a a baa e ates ak tas e e a A E E S 360 E EE DUE E EAI EE IIE AE TAE EIE E S EAI A A TA 360 JoUser Inputl COLUMN _NUMDEL J vecccccccccccccscscssssssssssssssssssscssssssesessessssessescsessesesessesaseesseseeeesaeees 360 ISEEN ONEA EEEE AEE AEE ETEA E E ASE 361 Foldet Variables ois iciscscccesscess cucucassascscocsociavessscsacess ovasnansnsocechededvecssceescvevescdasetesvontevectensstescouseseosensiees 361 ToA CHONCOUNE siz seicadeen tangas keier ENEE EAE N east EP EEEE eta tikes hie EE EE eos 361 TOATCHIVE Ds co resets elec a else cain ONE ERA ORT RAISON 361 To CALC ROMY iiss Aa T dave
99. file Cancel Help Figure 216 Integration wizard Main Menu 5 From the Item menu select one of the functions shown in the following table depending on how you wish to call the script Item To Select Function Run inline script Script Return script value ScriptEval Run async script ScriptAsync Table 36 Functions and Corresponding Integration wizard Items For this example we selected Run inline script from the Item menu 6 Click Next Metastorm BPM Release 7 6 May 2008 293 Metastorm BPM Release 7 6 The following screen displays Integration Wizard When button pressed The script call to be made use in place of any characters Language VBScript Script call systime Script file f lt Back II Next gt I Einish Jl Cancel Figure 217 Integration wizard Script Call Dialog 7 From the Language drop down menu select the scripting language you are using VBScript JScript or JScript NET 8 Inthe Script Call field type in the script call which must be included in one of the scripts that has been previously added to the Scripts dialog or the statement which should include the function plus any needed parameters If any parameters require the use of quotation marks as do string values in VBScript use a percent sign in place of each quotation mark In the example illustrated above the script language sele
100. function User Form contains similar functionality except it returns an empty value in a folder Procedure Name string read only name of the current procedure Procedure Version string read only version number of the current procedure Session FlagName string read only name of the flag that triggered a flagged action This will be empty for any other kind only of action This variable should be used in the following properties e Map Subject but only if the map is initiated by a flagged action e Flagged action Only start action if Note that using this property is considerably less efficient at run time than specifying a Folder which must raise the flag if the intention is to check the value of sSession FlagRaiser e Flagged action When completed e Flagged action Alert message Session FlagData column_number string read only contents of the specified column of flag data in a flagged action The first column which contains sSession FlagName is column 0 This will be empty for any other kind of action This variable should be used only in the following properties e Map Subject but only if the map is initiated by a flagged action e Flagged action Only start action if Note that using this property is considerably less efficient at run time than specifying a Folder which must raise the flag if the intention is to check the value of Session FlagRaiser e Flagged action When completed e Flagged action A
101. gt lt V gt lt B gt Toggles the Procedure Explorer on off Custom Variables lt Alt gt lt V gt lt V gt Displays a dialog that lists the custom variables defined for each map in the procedure and lets you add or delete them External Tables lt Alt gt lt V gt lt T gt Displays a dialog that lists the database tables defined in the procedure and lets you add delete or rename them Also allows you to add or edit columns for tables you have defined or delete column definitions within the Designer for previously defined columns Roles lt Alt gt lt V gt lt R gt Displays the Roles dialog Allows you to add edit or delete roles for the current procedure Flags lt Alt gt lt V gt lt F gt Displays the Flags dialog Allows you to add edit or delete flags for the current procedure Scripts lt Alt gt lt V gt lt S gt Displays the Scripts dialog Allows you to add edit rename or delete scripts for the components of the current procedure Customize lt Alt gt lt V gt lt C gt Displays a dialog containing a variety of options for customizing menus and toolbars 30 May 2008 Metastorm Inc 2008 Designer User Manual Option Access key Function Options Opens the following tabs Publisher Allows for selection of publishing options Editor Font selection in the Script or Formula editor Miscellaneous confirmation on cancellation of Integration wizard dialogs an
102. how it is calculated on the Do this tab If the memo is to be stored in the database you can select a variable from the drop down list Only memo variables will appear in the list You can create a new memo custom variable by clicking on the New custom variable button and specifying the details of the variable You cannot create a new custom variable if you are using a dataset for this memo field If you are using a dataset select the column name the system should use to calculate the information for this field from the column names shown in the drop down list 184 May 2008 Metastorm Inc 2008 Designer User Manual The variable you select on this tab of the Properties editor will determine the fields that appear on the memo field s Do this tab If you are using a variable other than calculated Designer uses the variable name as the default caption for the memo field 4 The Caption alignment field contains a radio group listing following alignment position options Left Places the caption to the left of the memo field Right Places the caption to the right of the memo field Top Places the caption above the memo field Bottom Places the caption below the memo field Select the caption alignment desired 5 You can include a text string to give users a brief help message when the cursor rests over the field Type the message you want displayed in the Hint field 6 The Default Action Usage field
103. if a variable was assigned on the Currency tab In this field enter any command the system is to perform when the value of this currency field is changed For the commands in the When changed field to be performed when the field is updated the Field has dependants of its own checkbox must be checked 3 Inthe Client extensions field enter any commands to be performed by the system when the focus is given to the currency field and when focus is removed You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Dataset Field Datasets are used when there are several fields on a form that are to be populated from the same record in a database table Using a dataset is more efficient than reading the data for each field individually as the database has only to be read once rather than once for each field The Engine will make only one connection to the database for every dataset field Each dataset is defined for a specific row of a specific database table To add a dataset to a form click on the Dataset button on the Form toolbar and then click on the location on the form where you want to place the dataset icon Dataset icons are not displayed on the form when displayed through a Metastorm client application they appear in the Designer window only However it may be m
104. image s actual size It does not resize an image Metastorm BPM Release 7 6 May 2008 141 Metastorm BPM Release 7 6 You can also adjust the position of a form element by clicking and dragging it to the desired location on the form You can resize the background form element or crop it from the right or bottom if it is an image by clicking and dragging on the handles surrounding the background form element until it reaches the desired size or is cropped as required You can Resize a command button date time drop down list memo number radio group currency signature text or grid field from the right side or from the bottom by clicking and dragging on the handles surrounding the form element until it reaches the desired size A Note you cannot adjust the height of date time drop down number currency and text fields Adjusting the width and height for a label of a label drop down list memo number radio group signature or text field does not take into account the field s caption area or list items You should check your form to ensure captions are positioned as required A command button s caption is automatically centered on the button As you resize the button check your form to verify that the caption displays properly You cannot adjust the height or width of a status field If a grid width is too small to display all columns Designer creates a horizontal scroll bar at the bottom of the field Y
105. in a drop down list containing negative numbers or parentheses without evaluation expressions can be written as they are displayed For example 1 displays as 1 London Heathrow displays as London Heathrow Any item in a drop down list containing negative numbers or parentheses with quotation marks in the dropdown list are written as they are displayed For example 1 is displayed as 1 London Heathrow is displayed as London Heathrow Tf any item in a drop down list contains negative numbers or parentheses with expressions the item must contain the character codes for hyphens and parenthesis For example Book a flight to London CHR 41 Heathrow CHR 41 by deadline displays Book a flight to London Heathrow by 28 09 2007 where deadline 28th September 2007 Priority CHR 45 1 displays 9 1 where priority 9 If an item in a dropdown list contains a percentage character another percentage character must be added in order for the first to be displayed For example the item 100 will be displayed as 100 2 Delimiters that separate items in the drop down list are entered into the Delimiters field A If a comma is defined as the delimiter between items in a drop down list and the value read from a database is London England then this value will appear as two separate items on two separate lines in the dropdown list If the delimiter is then the entry London England will appear as
106. in the following properties e Field Variable since the variable is read only e Stage Auto forward folders to System Users list read only list of all users registered in the database This variable is evaluated via a database lookup and thus may have an effect on performance It should not be used in the following properties e Field Variable since the variable is read only Metastorm BPM Release 7 6 May 2008 359 Metastorm BPM Release 7 6 e Stage Auto forward folders to User Error string read write custom error message Until and unless assigned to it will be empty Setting this variable causes the commit to fail and the error message to be given to the user This variable should be used only in the following properties e Field Variable allowed since the variable is read write but of dubious value e Field Calculation formula this is typically how validation error messages are displayed on screen e Field When button pressed When field changed and When user selects row these are typically where validation error messages are generated User Form The expression User Form returns the form name when viewed in an action refill or submit request For example where a user has started an action and the action form is displayed string read only name of the current form This variable should be used only in the following properties e Form When user loads form e Field Calculation formula
107. in two ways Type them in or Select them from a menu To see a menu of functions and variables click on the Start Formula button it has the percent sign on it in the toolbar or just type a character and wait for a few seconds When the menu appears click on the function or variable you need and it will automatically be placed onto the screen Script VBScript MapName systime Figure 220 Formula Editor 296 May 2008 Metastorm Inc 2008 Designer User Manual 4 Type in the string needed to call the desired script In the example shown above the following script has been entered SScript VBScript MapName systime The syntax contains the elements listed in the following table Syntax Element What It Contains Script Function call which determines whether a file is synchronous or ScriptEval asynchronous and whether it returns a value ScriptAsync Language VBScript JScript or JScript NET Script File Empty unless using a script stored in a file Name of the file containing the script function you are calling on the server Procedure Name Empty Map Name Empty if it was a script in a file Usually is MapName Must refer to the map containing the script function you are calling Script Statement Usually a function call and any desired parameters in a language Arguments JScript NET only Any number of additional arguments to be pac
108. integration with BizTalk Servers offered by the Metastorm No BPM Accelerator for BizTalk Flight Used to illustrate a travel authorization and booking process Yes Lead Used to collect sales leads and track their progress through the sales cycle Yes Tracking New Hire Used to ensure that the necessary administrative processes are carried out No when a new employee joins the organization News A map for maintaining a discussion database comprising a list of topics and associated note threads along with an Administrative Form for browsing available topics by category One Call Used by a call center to process and track customers calls Yes Purchase Demonstrates the use of an editable grid to capture line detail information in a Yes Order purchase order Send Mail Demonstrates the sending of mail to an SMTP server or a folder Uses the Mail xel library Set Up Used to add sample users and set up external tables Helpful in setting up No other sample procedures Training Used to establish new training classes and book students in to the classes Yes Wizard Demonstrates the use of chained actions to provide a wizard style interface No Table 43 Sample Procedures List Publishing a Sample Procedure Locating the sample procedures By default the files needed to publish the sample procedures are installed in Metastorm BPM Release 7 6 May 2008 321 Metastorm BPM Release 7 6 C Program Files Metastorm BPM Designer Sample Procedures Using the sa
109. internet functionality a Supported servers and browsers are listed in the Metastorm BPM Installation Prerequisites Guide and Supported Environments document No Metastorm software needs to be installed on the machines where a browser is to be used to provide Metastorm Client facilities Metastorm Web Parts for SharePoint Server Metastorm provides a Metastorm web part for Microsoft SharePoint Server This web part acts as an interface for users to access Metastorm processes email Clients These are applications that allow users to access the Metastorm database information through Microsoft Outlook Metastorm BPM Release 7 6 May 2008 17 Metastorm BPM Release 7 6 3 Party Client Applications It is possible to provide Metastorm Client facilities through custom client applications developed by Metastorm business partners and other third party developers using the Metastorm Software Development Kit SDK e Database third party product The information collected through a Metastorm process is stored in a database that is not a part of the Metastorm software Metastorm BPM supports the use of Oracle or Microsoft SQL Server for production systems and Microsoft Data Engine MSDE for testing and development All of these elements may be installed on the same computer or on separate computers depending on available resources and your specific system configuration as long as the elements have access to the informat
110. into a Microsoft Word document you must set up a Word document with merge fields The names of the merge fields in the Word document must be exactly the same as the names of the variables in the folder If there are merge fields in the Word document that do not exist in the folder the print will fail If there are fields in the folder that do not exist as merge fields in the Word document the print will succeed Data to be merged with a Word document must not contain non standard ASCII characters The Replace function can be used to ensure that non standard ASCII characters such as ASCII 147 and ASCII 148 are not included in merge data Note In Word 2003 when you create a document for mail merging you have to tell the document that this is what it s being used for 1 From the menu select Tools Letters and Mailings Mail Merge 2 Do the first 2 of the 6 steps indicated by the mail merge window typically using Letters and Use the current document 3 Atstep 3 close the mail merge window 4 Save your mail merge template document Raise flag You use this option to specify that a flag is to be raised The use of this function allows one action to raise multiple flags Read file memo You use this option to specify that Metastorm BPM is to read the contents of a text file on the server and place the contents in a text or memo field This may be used to display the files contents
111. is a comma character start index position in the array or collection to start creating the delimited string Default is 0 end index position in the array or collection to stop creating the delimited string Default is 1 which selects all items Returns A name and value delimited string A This option is only available using an assembly activated using Process Orchestrator for NET Activator 126 May 2008 Metastorm Inc 2008 Designer User Manual 6 FORMS The Designer allows you to create custom forms to meet your organization s requirements for collecting and distributing information A form may include combinations of the following e A pre defined form created through an external application e Formulas defining actions the system is to perform when the form is opened or closed e Background elements used to establish the layout and design of the form e Interactive foreground elements used to collect and display information Forms may be used to collect data add it to the Metastorm database and pass it to other users as part of a process Form elements are the visual interface used to both gather and display this data Although any number of elements can be placed on a single form too many cause clutter or crowding and become cumbersome for end users As a general rule large forms with a lot of fields should be avoided as they may be slow to publish and slow to display in the Designer and Clients
112. is applied in map segment A In this relationship map segment A can access Map section B s roles and map section B can access map section A s roles Duplicate Names When developing a procedure process designers are not restricted in the use of role names It is possible to duplicate role names within a library with those defined within the parent procedure If duplicate role names exist those defined in the parent procedure take precedence Roles with duplicate names in the library are not accessible If duplicate roles exist and the role is removed from the parent procedure the role becomes inaccessible even though it remains in a library In such a case the role can be activated in the parent procedure by deleting and reinserting the library When a procedure is validated warnings are given whenever a duplicate role name is encountered Validation occurs and warnings are displayed when the user assigns a library or when a procedure that contains libraries is loaded Figure 28 below shows an example of a warning of duplicate role names alidation Warning Role Executive pa from Library TestLib has not been loaded as a role with the same name already exists 4 Script Editor v Validation S Find and Replace Figure 28 Warning of Duplicate Roles In addition when a procedure is published Designer will warn of any roles with the same name in other procedures in the database Metastorm BPM Release 7 6 May
113. is calculated on the Do this tab You can create a new custom check variable by clicking on the New custom variable button and specifying the details of the variable You cannot create a new custom variable if you are using a dataset for this check field If you are using a dataset select the column name the system should use to retrieve the information for this field from the column names shown in the drop down list The variable you select on this tab of the Properties editor will determine the fields that appear on the check field s Do this tab If you are using a variable other than calculated Designer uses the variable name as the default caption for the check field If you wish to change the caption enter the new caption in the Caption field If you do not provide a caption or have selected calculated as your variable the check field will be displayed with a default caption of Check plus an auto incremented number The Dataset field allows you to select a dataset for the system to use with this field The default option is folder which indicates that you will be using the current folder as the source of data for this field and not a dataset 156 May 2008 Metastorm Inc 2008 Designer User Manual Using a dataset means that the source of data for this field is defined in the dataset you selected Any datasets previously defined for use with this form will be displayed in the drop down list amp Fo
114. may leave the field blank and still have the field pass validation If the values set in the Properties editor are required minimum maximum values the field must be made a required field on the form a Presetting Date Time Fields Designer stores a null date time as 1 1 1753 00 01 Process designers should be aware that it is not possible for a user to enter 1 1 1753 00 01 as a valid date time unless the field has been preset to an alternative date time For example if the user enters 00 01 into a time field and submits the form the next time this form is displayed the time field will be blank However if the field were preset to a date other than 1 1 1753 the field would hold onto the 00 01 time In addition if the field were preset to a date other than 1 1 1753 the value in the time field displayed when the form was first opened would be 00 00 Note that if this field were set to be Required it would be possible for a user to submit the form without updating the time field Defining a Date Time Field s Do This Properties Use the Do this tab to specify the calculation formula dependencies and processing to be carried out if the contents of the date time field change Properties DateTimel Properties DateTimel Calculation formula C Field is dependent on another Client extensions Figure 111 Date Time Do this Tab 1 Ifthe date time field may be updated as a result of a change to another data
115. memFormatComplexT ype Please call Brian Smith at ABC Corporation on 44 0 20 1234 5678 Brian Smith ABC Corporation ABC House 27 High Street ABC Town London AB12 3CD United Kingdom Figure 78 FormatComplexType Example Create custom variables a Create a memo custom variable to store complex data for example memGetClientRecord b Create a memo custom variable for the formatted complex data for example memFormatComplexType Assign complex data to the memo custom variable for example the return value from GetClientRecord A Refer to section 5 1 3 Retrieving data into fields 3 Create a memo field to display the return value 4 Create an input field and a button to allow the user to input the Client ID 5 Select the button and the Do this property tab 6 Launch the Integration Wizard 7 Select the Action and form information category and select Assign value 8 Click Next 120 May 2008 Metastorm Inc 2008 Designer User Manual 9 Select the VariableName field and select a memo custom variable for example memFormatComplexType 10 Launch the Integration Wizard from the Value field 11 Select the ComplexTypesSupportLibrary category and select FormatComplexType 12 Enter the Variable name which stores the complex data for example memGetClientRecord 13 Enter the Formatted text in the Format field using lt gt for each simple data type Integration Wizard Assign value lt
116. method Anonymous User name O Integrated Windows authentication Password Basic authentication l Figure 208 Connection Details 3 Enter the following details for the rule and its connection Metastorm BPM Release 7 6 May 2008 285 Metastorm BPM Release 7 6 Alias an informative name for the rule The Alias drop down on the Rule Engine Options dialog contains all the aliases used on the machine Rule Engine Web Service URL e g for BizTalk 2006 http lt Machine Name gt 8 1 BPMRulesService2006 BRIWebService asmx Note for BizTalk 2006 the port number for the URL depends on what port numbers are available when the installation is performed Connection Method as defined by an Administrator We do not recommend using Anonymous If you select Basic Authentication we recommend using a secure HTTPS environment as the authentication information is transmitted as clear text A If the Metastorm Rules web service is on an IIS machine set up to use SSL the machine calling the web service must have the certificate for the web service machine s web server in its trusted root certification authorities It also needs a certificate from the certification authority Authentication Credentials if you selected Basic authentication as the Connection Method Click on the Advanced button The Advanced dialog is displayed Advanced Proxy server No Proxy User name Use browser settings Password
117. methods add and remove return values and set the type of serialization to use PRAIA Figure 76 Map Complex Type Toolbar Button Description Expand all members of the current tree list node Expand All Collapse all members of the current tree list node Collapse All Apply return value to the selected complex type or simple data type When this option is selected the Returned Format column displays Default Default represents the Default Serialization type When a return value is applied the Serialization buttons become available vt ee Return Value This button resets the serialization format of the tree list underneath the cursor back to default By default the serialization is Binary Q Default Serialization 116 May 2008 Metastorm Inc 2008 Designer User Manual Serialize to XML When the Return Value is selected XML ali this button becomes available When this option is enn et selected the Returned Format column displays XML Serialize to SOAP When the Return Value is selected this button becomes available When this option is selected the Returned Format column displays SOAP SOAP Serialize to SOAP O Serialize to Binary When the Return Value is 3 selected this button becomes available When this Serialize to Binary option is selected the Returned Format column displays Binary Use one of the ser
118. more detail in section 2 20 May 2008 Metastorm Inc 2008 1 2 2 Designer User Manual Designing a Procedure As you design a Metastorm procedure you may ask the following questions What action initiates the process What tasks must be performed to complete the process In what order must these tasks be performed Which individuals within the organization will be involved What roles will they be taking in the process What information needs to be gathered during the course of the process What information should be shared among participants What are the possible outcomes Does the procedure flow in a step by step manner from start to finish or are there alternative paths to be taken into consideration Are actions taken sequentially or in parallel The answers to these questions will help you to develop your procedure Define the Procedure Properties Metastorm BPM allows you to identify certain properties for each procedure you design The Properties dialog is available from the File menu There are four tabs on the Procedure Properties dialog General Used Libraries LDAP Aliases and Document Management ioi General Used Libraries LDAP Aliases Document Management Owner Password Metastorm Administrator Company 2 5 i m Default Library Connection Details 7 Metastorm Inc f J7 Use Stored Connection Description DSN 0 1S Flight Procedure 7 5 Metastorm 1999 2007
119. move forms into the Selected field Only common forms and forms associated with the current map are listed The system updates this list as new forms are created within the procedure Forms will be visible to a user only if they hold the appropriate roles To change the order in which the folder pages are displayed change their order in the Selected list using the arrow buttons A common stage has no Folder pages property A Because folders at the Archive stage do not appear on any user s To Do or Watch list the folder pages you select here for an Archive stage will be visible only through the folder on folder feature This feature allows you to open a folder at its current stage from another procedure even if that folder has already been archived The New Hire sample procedure Designer Sample Procedures New Hire xep illustrates this feature 78 May 2008 Metastorm Inc 2008 Designer User Manual Defining Roles Properties Properties Travel Department access Administrator Any YP everybody eWork Administrator eWork Guest Guest Manager Metastorm Administrator Metastorm Guest originator Travel Department Traveler VP atch list access Administrator Any VP everybody eWork Administrator eWork Guest Guest Manager Metastorm Administrator Metastorm Guest v originator Travel Department v Traveler VP Properties Travel Department adata Figure 48 Roles Tab amp Commo
120. name you selected For Column 1 any column name may be selected from the column name drop down list as long as the column contains valid folder IDs This is most easily identified in columns named tablename eFolderID as illustrated in the New Hire sample shown above A thorough knowledge of your table structure is recommended before selecting a column name that does not identify itself as containing valid folder IDs The Column Caption field when it is the first column in a grid Designer does not display the eFolderID column by default However the Column Caption for Column 1 must read eFolderID for Folder on Folder to work 7 Select any additional columns you wish to have displayed No special handling is required for defining the additional columns In the New Hire sample the columns eFolderName name of the folder eSubject eMapName name of the submap and eStageName name of the stage the folder is currently at were selected 222 May 2008 Metastorm Inc 2008 Designer User Manual Avoiding Common Editable Grid Errors This section outlines issues that process designers should be aware of when working with grids Avoid Primary Key Violations A primary key violation will occur if a user tries to submit a form whose editable grid has two rows with the same value for the table s primary key For example a table TableOne has two columns FieldOne and FieldTwo FieldOne is the primary key of the table
121. o Commands g Custom variables Dates and times g Directory integration g Microsoft Exchange adaptor gf Metastorm BPM database g External database adaptor File adaptor g Folder information o Form fields Lists and memos g Microsoft Office adaptor oe Numbers oP Text functions g Users and roles Business rules Figure 205 Business Rules Selection 2 Click the Next button The Rules Entry fields are displayed Integration Wizard Rules Rule to be executed and the location of the rule engine Rule to execute Custom variables DateolBirth Risk Smoker Figure 206 Business Rules Entry 284 May 2008 Metastorm Inc 2008 Designer User Manual A The Business Rules category and functions are stored in a collection in the BRI library which must be used in the procedure Specifying Rule Connection Information 1 Click on the ellipsis Lad next to the Rule to execute field The Rule Engine Options dialog is displayed Rule Engine Options Alias E New Edt Delete Rules Use latest version of selected rule Insurance Polic Figure 207 Rule Engine Options Dialog 2 Click on the New button The Connection Details dialog is displayed Connection Details Connection Alias Rule engine web service URL http KRulesE ngineMachine gt eworkR ulesService BRIWebService asmx Authentication method Connection
122. of field you are working in The following table lists the field types and corresponding color coding Field Color Background Color IDENTIFIER Default Black Default White STRING Magenta Default White NUMBER Red Default White SYMBOL Green Default White LITERAL Default Black Default White OPERATOR Green Default White LOGIC_OPERATOR Green Default White DELIMITER Green Default White FUNCTION Blue Default White KEYWORD Default Black Bold Default White COMMENT Dark Blue Italic Light Blue Table 34 Formula Editor Color Codes ya While you are editing a formula clicking on the Start Formula button 2 or typing a percent sign A scrolling list of valid entries is displayed Selecting an entry and pressing Enter will insert that entry at the current cursor position 2 When you are finished entering or editing the formula select Close from the File menu or toolbar If the formula has changed you will be asked if you want to save your changes You may also select Save amp Close from the File menu or toolbar which saves the formula and if the formula passes evaluation closes the Formula editor The Formula editor will check your formula and notify you in a lower pane if there are any errors If it finds errors the Formula editor will ask if you want to continue In this case select No to return to the Formula editor Double clicking on the formula will select
123. on the map click on the Image button Or double click on the displayed icon Designer displays the standard File Open dialog and you can select a file containing an alternate icon Metastorm BPM Release 7 6 May 2008 73 Metastorm BPM Release 7 6 6 Type a Subject line for the map Whatever you type here becomes the default subject for each folder created within this map A Since no map variables exist for a folder until the first form is committed if you wish to include a Metastorm variable in the Subject you must assign the subject value in the When action completed property of the first action in the procedure 7 To restrict the users who may locate and access a folder to those with a particular role select the role from the Limit access to drop down list In order to prevent unauthorized access identify the roles that may have access to the forms and folders belonging to this procedure 8 To be able to create global custom extensions you can use Delegate all external events for map which defines whether all the events of a process will be delegated to an external NET assembly Perform external events before local events defines when the external events are run To use the Delegate all external events for map check box the Process Events Library needs to be associated with the current procedure amp For further information on creating local custom extensions refer to Appendix B page 392 or Process Orchestrator for NET
124. option to return the date and time provided by the time server on which the Process Engine is running Folder Date time You use this option to specify that Metastorm BPM is to return deadline the deadline set for this folder Format date text You use this option to format a date time value for display time Read Date time You use this option to specify that Metastorm BPM is to read a Metastorm date and or time value from the database date time Read external Date time You use this option to specify that Metastorm BPM is to read a date time date and or time value from a database Read folder Date time You use this option to specify that Metastorm BPM is to return date time a date and or time value from a folder in another map in this procedure UNSPECIFIED Date time You use this option to specify that Metastorm BPM is to DATE TIME compare or reset time values to never Note The unspecified date used by Metastorm BPM is 1 1 1753 00 01 This will appear as a blank date in Metastorm BPM however reporting packages will report it as 1 1 1753 When folder Date time You use this option to specify that Metastorm BPM is to return created the date and time that this folder was created When folder Date time You use this option to specify that Metastorm BPM is to return last updated the date and time that this folder was last updated either when it entered the stage or was processed by a loop back action When stage Date tim
125. parameter of type CLOB the value of this parameter must not be an empty string ExecuteExtensionEval JScript NET Procedure Name MapName Metastorm ProcessEvents HandleExternalEvents DelegateEvents The above script is created when using the Integration Wizard and selecting the category Event Handlers and item External Event Handler To use this function you must publish the Process Events Library and associate the library with the current procedure 392 May 2008 Metastorm Inc 2008 Designer User Manual The function identifies the procedure and map names and calls the relevant stage action or form event from Visual Studio NET assemblies A boolean ExecuteExtensionEval JScript NET Procedure Name MapName Metastorm ProcessEvents HandleExternalEvents DelegateEvents is used when External Event Handler Boolean is selected from the Integration Wizard This script is used for a conditional action which returns true or false amp Y For further information on creating custom extensions refer to Process Orchestrator for NET Designer s Guide pdf ExecuteRule ruleConnection customVariables To use this function you must publish the BRI library You can use the ExecuteRule function in a standard When event or the Rules property of a Rules stage Arguments ruleConnection A String specifying the rule to execute and the connection information required by the business rules engine
126. procedure you can define your own custom variables and assign values to them Examples of variables that are defined and updated by Designer include e The name of a folder e The name of the user that originated the folder e The date and time at which a folder was created e The date and time at which a folder was last updated Custom variables are used either to store data that has been input by a user or extracted from an external system Custom variables are associated with a particular map and the data from the custom variable is stored in the map s database table The custom variables form the columns of the table while the folders make up the rows When you select this category Designer will display existing custom variables 1 To create a new custom variable click on the F button Designer displays the Custom Variables dialog 278 May 2008 Metastorm Inc 2008 Designer User Manual 2 Click on Add Designer displays the Custom Variable dialog Custom Variables Policy Quote Premium Payment Type Add CoverAmount en DateofBirth Custom Variable eMailAddress Forename Postcode Datatype E Text Variable name PremiumOffered Maximum size 250 SE Risk Figure 199 Custom Variables and Custom Variable dialog boxes 3 Enter a name for the variable in the Variable name field This field may not be left blank and must be unique for each new custom
127. property is evaluated 2 For each form marked as available at the stage the Available to roles property is evaluated 3 For the form that will be displayed the When user loads form property is evaluated 4 For all the fields on the form in tab order a The field s data value calculation formula or custom variable is evaluated Metastorm BPM Release 7 6 May 2008 353 Metastorm BPM Release 7 6 b If the field is a grid the grid layout is evaluated nota grid if the field has an options list for example Earliest Latest or a Dropdown s list the options list is evaluated When an action is performed 1 If the action is an action that starts a map the map s Subject is evaluated 2 The action s Available to roles property is evaluated 3 The action s When action started property is evaluated 4 If the action has a form a The form s Available to roles property is evaluated b The form s When user loads form property is evaluated 5 Ifthe action request indicates that it should be committed immediately a All fields on the form in tab order are updated based on request data For all the fields on the form in tab order b The field s data value calculation formula or custom variable is evaluated to generate field output 6 If the field is a grid the column list is evaluated not a grid if the field has an options list for example Earliest Latest or a Dropdown s list the o
128. return the staff who have a specified role of the user you specify Watch list list You use this option to specify that Metastorm BPM is to return the list of users who have the specified folder on their Watch lists MQ Messaging Lists Metastorm functions used with message queuing software 318 May 2008 Metastorm Inc 2008 Designer User Manual SERVER ACTION RESULT DESCRIPTION CATEGORY oe Senda You use this function to send a message without having to use message to a a pre defined queue message queue Send message to registered messaging queue You use this function to send a message to a registered message queue Add an attachment to existing Metastorm Folder You can use this function to add a new attachment to an existing Metastorm folder You can also use it to assign that folder to a clip field in which case you must assign the return value of the function to the clip field Read an attachment from an Metastorm Folder You can use this function to retrieve the Base64 encoded value of the requested attachment Register an incoming queue definition You can use this function to register a new in queue definition Remove an incoming queue definition You can use this function to remove an in queue definition Register a new outgoing queue definition You can use this function to register a new out queue definition Remove an outgo
129. role name and a description in the Role and Description fields 4 From the Map drop down you have these choices To reassign the role to the common roles list select Common Select a map to reassign the role to a specific map 5 Ifyou need to edit the Formula you can do so by Typing in the formula or Clicking on the Formula editor button or Clicking on the Integration wizard button amp Detailed instructions on how to use the Formula editor and the Integration wizard may be found in Section 10 Creating Formulas page 261 6 Click OK to confirm the changes and close the dialog A Editing a role name to is the same as deleting the old role name and adding a new role If you edit a role name you should confirm that your role assignments are still in force 8 1 7 Defining Dynamic Role Formulas Dynamic roles are defined by a formula The formula entered should resolve to a list of user names when evaluated at run time For further information on creating formulas refer to Section 10 Creating Formulas and the Appendix on Formula Components Using operators within dynamic role formulas Formulas created for dynamic roles are treated as literal strings In general functions and variables that begin with will be evaluated as expected However if the formula contains operators and these are not intended to be treated as literal strings the formula should be wrapped in a Evaluate function The
130. section 6 4 3 Defining Element independent Properties on page 139 Metastorm BPM Release 7 6 May 2008 183 Metastorm BPM Release 7 6 Defining a Memo Field s Memo Properties 1 Properties Memol folder Variable calculated Caption Memol Caption alignment T Olet OT Onion Bottom read only v Figure 123 Memo Tab The Dataset field asks you to define a dataset for the system to use with this field The default option is folder which indicates that you will not be using a dataset with this field Using a dataset means that any required information necessary for calculating the information displayed in this field will be read directly from the dataset rather than require an additional call to the database Any datasets previously defined for use with this form will be displayed in the drop down list For more information on creating datasets see the Defining a Dataset field topic in this section If you wish to change the caption enter the new caption in the Caption field If you choose not to define a caption and selected calculated as your variable the memo field will be displayed with a default caption of Memo plus an auto incremented number Identify the variable you wish this field to use in the Variable field There are a number of options If the memo is to be calculated at run time select calculated from the list You will be able to specify
131. select them at that time Defining a Common Stage s Applied to Properties Properties Stages Mi Check Authorization Level v Rejected v Manager v Payment Due vI VP Figure 51 Applied to Tab A Common stage is used to define actions or formulas that should be available from multiple stages in a map An example of the use of a Common stage might be the requirement for a warning to be issued an hour after a deadline has passed or to allow users to add comments to folders Use the Applied to tab to specify a list of stages selected from the map s User Group System and Sub procedure stages where any actions or formulas from this Common stage will be available Select the stages to apply the Common Stage to from the list in the Stages property 3 3 3 Renaming and Deleting Stages When a stage is renamed or deleted in a procedure the old names are preserved in the database if the procedure has previously been published The new names are added to the database This is expected behavior as Users may have old stage names on their To Do or Watch lists Stages can be removed from the database by purging stages using the Service Manager amp Y Refer to the Administration Guide for more information on Purging Stages 3 4 Actions In addition to the stages described above your map needs to include actions Metastorm BPM defines an action as the necessary step to move a folder from one stage to the next Act
132. set up an LDAP alias to the directory The following steps are required to do this 274 May 2008 Metastorm Inc 2008 Designer User Manual 1 Create a new library In the Library Properties dialog select the LDAP aliases tab amp Library1 Properties General LDAP aliases Integration Wizard collection Alias name LDAP connection Figure 193 Library Properties LDAP aliases tab 2 Click on the Add button to add a new alias The LDAP dialog is displayed LDAP Alias Alias User ID Directory on Admin o Metastorm Server ID Port number Password LDAP infowise Search base Distinguished name OK Cancel Help Figure 194 LDAP alias dialog 3 Enter the name of the alias and the LDAP connection details The alias name may not be longer than 20 characters Click on the OK button amp The Server ID is restricted to the following characters A Z a z 0 9 The Search base is populated in reverse order as shown in Figure 194 where the container ou Development is listed before the root o Metastorm 4 Save publish and close the library 5 Open the procedure from which you want to access the directory data 6 Inthe Procedure Properties dialog select the Used Libraries tab 7 Click on the Add button to add the library you have just published The library appears in the Used Libraries tab Metastorm BPM Release 7 6 May 2008 275 Metastorm BP
133. string arguments do for Metastorm BPM Release 7 6 May 2008 401 Metastorm BPM Release 7 6 VBScript then each quotation mark must be preceded by a character to prevent Metastorm stealing it before it is passed to the script function If the specified language is JScript NET this is a string identifying the name of a valid entry point in the map or procedure assembly that has been compiled args JScript NET only any number of additional arguments to be packaged up and passed into the point s args argument Returns command if the specified language is VBScript or JScript this loads the specified language followed by any script in file from the server file system any specified procedure and or map scripts from the Metastorm database and then executes the specified Statement If the specified language is JScript NET the return value is True if the system is able to queue this for asynchronous execution Else the return value is False The function executes asynchronously the evaluation suite returns control to the Engine as soon as the request has been queued not after it has been serviced For example ScriptAsync VBScript C Scripts Common Scripts vbs myFunc Priority UnregisterInQueue symbolicName Arguments symbolicName a string specifying the in queue to unregister Returns boolean 1 on success otherwise an Metastorm formula exception UnregisterOutQueue symbolicN
134. that extends the list of functions available in the Integration Wizard 2 1 2 Adding library parts This section gives an overview of the procedure components that can be stored in a library and describes how to add each to a library Forms In an organization a particular form may be used in more than one process For example the same audit trail form may be used in several procedures The Metastorm sample library Sample Library xel includes an example of an audit trail form that is used in many of the Metastorm sample procedures To add a new form to the library select Component New Form A new form is displayed and added to the Procedure Explorer In a library forms may be added to map segments or the Common item A form added to the Common item does not have access to custom variables The form may be completed in the usual way amp Refer to section 6 for information on building forms Form Segments Form segments are re usable collections of form fields that can be used as part of a form Many forms created for Metastorm processes contain name and address fields A form segment containing these fields would make forms requiring this feature quicker and easier to build The Metastorm sample library Standard Library xel contains a form segment that provides a standard banner that can be used with any form A Form segments cannot be nested i e they cannot contain other form segments To add a new form segment
135. the ExecProc function 390 May 2008 Metastorm Inc 2008 Designer User Manual Arguments procedure is a string identifying a database stored procedure arguments is one or more arguments of any data type to be supplied to the stored procedure The values are passed to the stored procedure in their current type So ExecProc procedure1 Currency Variable RealVariable TextVariable DateVariable will pass 4 arguments of types currency real text and date Returns command executes the specified stored procedure with any specified arguments against the Metastorm database ra ExecProc does not support output parameters A If you pass in a parameter of type CLOB the value of this parameter must not be an empty string ExecSQL statement data_source Arguments statement a string containing the SQL statement to be executed The statement should not return a result set use Select SQL instead if you need to return a result set data_source an optional connection string for the database against which the SQL statement is to be executed If omitted the SQL will be executed against the Metastorm database You should not use a DSN string when mapping to the Metastorm database as it could cause database locks Returns command executes the specified SQL statement against either the Metastorm database or the specified data_source For example ExecSQL UPDATE CustomerTable SET Custom
136. the ComplexTypesUtils xel support library This section discusses e Generating a Complex Types Library e Retrieving Data from Complex Types e Retrieving data into fields e Populating a List box e Populating a Dropdown Map Complex Type Dialog e ComplexTypesUtils Support Library 5 1 1 Generating a Complex Types Library Before Complex Types can be mapped a Complex Types library is generated using a Process Orchestrator Activator amp Refer to the Process Orchestrator documentation for details on using the Activators 110 May 2008 Metastorm Inc 2008 Designer User Manual 1 Run an activator and activate an assembly web service or Enterprise JavaBeans as applicable 2 A Metastorm Integration Wizard Collection library is generated containing the activated methods 3 Inthe Designer publish the generated Metastorm library 4 Associate the published library with a procedure Use the Integration Wizard to invoke the activated methods 5 1 2 Retrieving Data from Complex Types To retrieve data from a complex type a memo custom variable is setup to store the data retrieved The data retrieved can be output to fields on a form for example text and numeric fields or serialized as XML Binary or SOAP Binary is the default serialization The example below retrieves complex data in text and integer fields which is displayed in the browser 5 1 3 Retrieving data into fields This example invokes a method which ret
137. the file out Returns Metastorm BPM Release 7 6 May 2008 241 Metastorm BPM Release 7 6 e Text data type Get Document Creation Date This function returns the date when the specified document was created Parameter e File Name the URL of the file to retrieve the creation date Returns e Date Time data type Get Document Editor This function returns the name of the user who modified the specified document Parameter e File Name the URL of the file which has been modified Returns e Text data type Get Document Last Modified This function returns the last modified date of the specified document Parameter e File Name the URL of the file to return the last modified date Returns e Date Time data type Get Document Title This function returns the document title of the specified document Parameter e File Name the URL to the file which the title is to be returned Returns e Text data type Verify Folder This function verifies if a specified folder exists 242 May 2008 Metastorm Inc 2008 Designer User Manual Parameter e Folder Name the URL of the folder to verify Returns e Check data type Metastorm BPM Release 7 6 May 2008 243 Metastorm BPM Release 7 6 8 DEFINING ROLES Roles are a way of grouping users Individuals may be grouped by function by geographical location by skill set or by any other criteria relevant to your organization Users
138. the line in the formula editor where the error was found 3 You may also save the formula as you have typed it by selecting Yes The error will be reported again if you run the verification function on the procedure or try to publish it You cannot successfully publish a procedure containing errors of this kind A If the content of the Formula Editor is part of a larger formula but is not a formula itself it will fail the evaluation For example when using the Integration Wizard item User Attribute you enter the Where clause of an SQL query into the Selection criteria field It is possible to edit the contents of this field using the Formula Editor but the evaluation will always highlight errors because the Where clause is not a valid formula In this case click Yes to save the contents and continue a Samples of formula syntax may be found in the Formula Components Appendix B 10 1 6 Accessing Databases Designer uses ADO an industry standard database interface to access data in database management systems that use Structured Query Language SQL as a data access standard Each 272 May 2008 Metastorm Inc 2008 Designer User Manual data provider has a data source name that stores information about how to connect to it This section explains the arguments displayed by the Integration wizard when you are specifying access to a database Table Name s Argument When specifying processing to be performed in a M
139. the necessary administrative processes are undertaken both before and immediately after a new employee joins an organization It illustrates the use of Sub procedures and Rendezvous actions A a gt A e g ne ed Withdrawn 4 R Allocate A number y A d amp Ready gt ars Day Wl First day y Wait For other tasks Wait For first day HR a vant completed Supervisor Acknowledged A Employee started Figure 235 New Hire Sample Procedure Main Map When a folder reaches the Wait for other tasks Sub procedure stage child folders are spawned in three sub maps When all three have completed their sub maps the Rendezvous action releases the folder where it sits in the Wait for first day stage Metastorm BPM Release 7 6 May 2008 331 Metastorm BPM Release 7 6 Allocate desk Facilities The deadline and the subject are set up in the When action t completes property of Completed this creation Flag action Facilities Check To Do list P A Facilities completed Issue security pass In the Issue Security Pass action the Roles tab only permits those with the role Security Manager to use this action Note on the Roles tab the use of the Remove from To Do list option This will remove the item off the To Do list of the Security Manager as soon as she has undertaken this action Figure 236 New Hire Sample Procedure Facilities Submap The deadline and the subject ar
140. the print will succeed The Word merge document must have no source file specified if it is to be used as a merge document Data to be merged with a Word document must not contain non standard ASCII characters The Replace function can be used to ensure that non standard ASCII characters such as ASCII 147 and ASCII 148 are not included in merge data Note In Word 2003 when you create a document for mail merging you have to tell the document that this is what it s being used for 1 From the menu select Tools Letters and Mailings Mail Merge 2 Do the first 2 of the 6 steps indicated by the mail merge window typically using Letters and Use the current document 3 Atstep 3 close the mail merge window 4 Save your mail merge template document Numbers Lists all non custom Metastorm number variables and functions used to return numbers Metastorm BPM Release 7 6 May 2008 315 Metastorm BPM Release 7 6 SERVER ACTION RESULT DESCRIPTION CATEGORY KES currency Currency Allows you to type in a currency value number Integer Allows you to type in a literal number Absolute Integer You use this option to return the absolute value of a number number This can be used to convert a negative number to a positive number It has no effect on a positive number Calculate Integer You use this option to specify
141. the procedure All libraries must be published before they can be used within a procedure LI tox General Used Libraries LDAP Aliases Document Management Add Work Offline Library Name v Version v Published v Description E Delete o BRI Library 1 7 28 2004 9 22 11 PM u pdate o Sample Library 1 3 23 2005 12 31 26 PM Figure 2 Used Libraries Tab The LDAP Aliases tab displays a list of the LDAP Aliases associated with each library currently used by the procedure see Figure 3 below The LDAP Aliases are created within each library and are available to the procedure when the published library is in use Procedure1 Properties Eg Oo x General Used Libraries LDAP Aliases Document Management Alias name y LDAP Connection E3 Figure 3 LDAP Aliases Tab The Document Management tab displays the name of the DMS Provider and the default location of the DMS Provider 22 May 2008 Metastorm Inc 2008 Designer User Manual Procedure Properties a E 5 x General Used Libraries LDAP Aliases Document Management DMS Provider SharePoint Default Location http vm2003moss 83 metastarm Cancel Help A Figure 4 Document Management tab 6 amp Y For further information refer to section 7 Document Management Support Define the Initial Action When you define a new procedure Metastorm BPM automatically creates a Start Box on the procedure re
142. then select the library you wish to retrieve from the list displayed Each published version of the library is listed along with any descriptive information provided by the designer A Click any column header to sort the list in ascending or descending order To sort by multiple columns hold down the Shift key when clicking the columns To remove sorting hold down the Control key and click the columns 7 When you have made your selection click on OK to continue The Designer will request a password for this procedure 8 Enter the password and click OK to continue The Designer displays the Retrieve Procedure to dialog which is the standard Save dialog 9 Enter a filename and location for where the procedure will be retrieved The existing filename and last used directory are supplied by default 10 To save this procedure file under a different name or to a different location enter this information Click on Save to continue The Designer will save the retrieved procedure to the location you specified and open the procedure in the Designer 11 Review or modify it as necessary Metastorm BPM Release 7 6 May 2008 49 Metastorm BPM Release 7 6 2 LIBRARIES A library can be used to store sub sections of procedures that can be used in other procedures Forms form segments map segments scripts and LDAP aliases can be created once stored in a library and reused many times in procedures When a library is
143. time in the date time field Both Displays the selected date and time together in the date time field Select the date time format desired 2 Ifyou select Time or Both the Disable time zone adjustment checkbox is available If you leave this unchecked the value in the field will be displayed in the client s local time 3 The Earliest field allows you to enter a formula which will define the earliest valid date or time that may be entered into the date time field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 4 The Latest field allows you to enter a formula which will define the latest valid date or time that may be entered into the date time field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog ra If the date time field is a required field on the form you cannot set the Latest property to be less than or equal to the Earliest property or the user will receive an error when using the form 168 May 2008 Metastorm Inc 2008 Designer User Manual In addition even though valid maximum and minimum values have been set if the date time field is an optional field on the form the user
144. to assign values to variables perform conditional evaluation and alter the default order of evaluation for a formula The following table lists the general operators Operator Name Operator Type Function variable formula command Evaluates the formula and assigns its value to the variable condition Eval i vni he first f i 9 formul any val uates t e condition if TRUE evaluates the first formula otherwise evaluates the second formula Evaluates the parenthesized formula first This may be used to formula any alter the default order of evaluation in any conditional logical or arithmetic formula For example Table 44 General Operators Category abe 123 Category FolderName FolderName abc 123 Category xyz 789 Category WEMPTY Typecast Operators These are used to convert data from one type to another If the conversion cannot be performed then evaluation of the property will resume on the next line or if there are no further lines fail The following table lists the typecast operators Operator Name Operator Type Function boolean formula Condition E to convert formula to a condition TRUE or FALSE integer formula Number Attempts to convert formula to a whole number real formula Number Attempts to convert formula to a real floating point number date formula Date time Attempts to convert formula to a date time te
145. type from the Type drop down menu The choices are Check Currency Integer whole number Real number Date Time and or date Text single line up to a maximum of 250 characters Memo multiple lines no effective size limit 7 Ifyou select Text as the column type the property to the right becomes active From this menu select the column width in number of characters 8 If this column is to be an index column for the database check the Index checkbox 9 Click OK 10 Press Enter to create another column Alternatively select the Add button from the Column options on the right You may edit column information by selecting the column and pressing the Edit button After the procedure has been published the columns can be edited in Metastorm BPM but will not be updated in the database until the procedure has been re published 11 When you have finished entering column details press OK When you save and publish the procedure the table is created in the Metastorm database It can then be used in the Integration wizard or Formula editor just like any other table stored in the Metastorm database 10 1 10 Accessing Business Rules Engines A procedure can invoke a rule from a Business Rules Engine optionally passing system variables or custom variables to the rule When the rule executes it can return data to the procedure The general process for using Metastorm BPM with Business Rules Engines is 1 A Busine
146. type of actiontoa Stage be placed on any users To Do list system stage Roles aod Folders in this type of stage are You can draw any type of action Do this handled automatically except a rendezvous action from a Notes system stage Sub Allows you to divide a large map You can draw any type of action to Stage Procedure into a number of sub maps that can and from a sub procedure stage Roles be processed in parallel The Maa folder that reaches the sub Maps mma dure stage will give rise toa Do this procedure stag g number of sub folders child Notes folders each of which will follow the flow of its own map Rules Allows you to execute a rule using You can draw any type of actiontoa Stage a Business Rules Engine rules stage Roles oe Although you can also use the You can draw any type of action Do this aaa ExecuteRule function in a except a rendezvous action from a Notes standard When event the rules stage advantage of executing a rule from the Rules property is that the rule is executed after the form is submitted rather than as part of Submit processing so that control is returned to the client sooner Common A common stage represents a list You cannot draw an action toa Stage of other stages You use this stage common stage from another stage Do This ey type to define common actions that although loopback actions are Applied to should be available from each allowed Notes listed stage You can draw any
147. user actions Only invoke action if accepts a condition e Action When action completed accepts one or more commands entered on successive lines e Form When user loads form and When user saves form both accept one or more commands entered on successive lines e Button server operations only When button pressed accepts one or more commands entered on successive lines e Button new folder only New folder accepts a string that should at run time resolve to the name of a published map e Button open folder only Open folder accepts a string that should at run time resolve to the ID of an Metastorm folder e Clip calculated only Calculation formula accepts a string that should at run time resolve to the name of an existing folder attachment e Check calculated only Calculation formula accepts a condition 352 May 2008 Metastorm Inc 2008 Designer User Manual e Currency calculated only Calculation formula accepts a currency e Number calculated only Calculation formula accepts a number e Date Time calculated only Calculation formula accepts a date time e Text Drop down Radio group Memo and Signature calculated only Calculation formula all accept a string e List calculated only Calculation formula accepts a list e Clip Check Currency Number Date Time Text Drop down Radio group List Memo and Signature but not calculated When changed accepts one or more commands entered on succe
148. variable associated with this map Variable names must be made of alphanumeric characters without spaces No extended ASCII characters or non US English characters are allowed If you are using SQL Server the variable name may not be longer than 31 characters If you are using Oracle the variable name may not be longer than 30 characters 4 Select the Data type Designer automatically sets the default data type to match the field type you are defining Check Currency Date time Integer Memo Real Text 5 If you are defining a text variable you also need to enter a value in the Maximum size field which is the size used to hold the name of any Metastorm object such as a folder server or user The default size for text fields radio group and drop down fields is 250 characters If you need to provide more room or allow for multiple lines of text you should use a memo field and memo variable 6 Click on OK The variable is added to the Custom Variables list Metastorm BPM Release 7 6 May 2008 279 Metastorm BPM Release 7 6 E Custom Variables Policy Quote Premium Payment Variable Type A eMailAddress text 100 Forename text 50 Holdername text 250 Postcode text 10 PremiumOffered currency Risk text Smoker text 4 Surname text 100 Telephone text 30 all El El ll Gl lt Figure 200 Sample Populated Custom Variables dialog Custom variables must be associated with
149. whose To Do lists a folder currently sits Watch list is used to indicate all users on whose Watch lists a folder currently sits Dynamic roles are specific to the procedure they were created for and cannot be managed through the Users and Roles tool Metastorm BPM Release 7 6 May 2008 245 Metastorm BPM Release 7 6 8 1 1 Identifying the Roles in Your Organization Because role based work management is based on the concept that responsibilities are assigned based on an individual s job function or role within the organization the simplest way to begin identifying those roles is to study your company s organizational chart While you will seldom use all available roles in any single procedure developing a master list of the static roles within your organization will minimize redundancy within your Metastorm database It will also save you the effort of having to define a new set of role assignments through the Users and Roles tool each time you create a new procedure Your initial role list may primarily consist of job titles or job functions Notice that when you have more than one individual with the same job title e g Customer Service Representative that a single role definition will apply to each Next study your organizational chart to see what group roles should also be defined For example the Sales Manager is also a member of the Sales group as well as a member of the generic group Managers A
150. with Library Server Common Any map in the library or the procedure in which the library is used Library Server A Map Segment The map segment and any map the map segment is associated with Table 35 Script Availability You can call either type of script via the Integration wizard or the Formula editor A The use of non US English characters in scripting is not supported 3 Scripts with duplicate FUNCTION names are not supported at publication as JScript and VBScript does not support overloading This section introduces the Metastorm Scripts dialog and illustrates methods of calling scripts however detailed information about script creation can be found in the Metastorm Software Developer s Kit SDK 10 2 1 Working with the Scripts dialog The Scripts dialog allows you to identify scripts that will be associated with the current procedure Scripts included in the Scripts dialog may be called by their script name To open the Scripts dialog In the Designer click on the Scripts button J or select View Scripts The Scripts dialog appears Figure 211 Scripts Dialog Metastorm BPM Release 7 6 May 2008 289 Metastorm BPM Release 7 6 A The Scripts dialog can be docked on the top or bottom of the main pane or with Properties Editor Any scripts you have previously created are listed e To Add a script click on the Add button SB or press the Insert key e To Edit a previously cre
151. your users may be viewing your form through the Windows clients we recommend that you design your form layout using the large fonts setting on your Windows system If you anticipate that your users may be viewing your form through a Web browser keep in mind that the underline and strikeout options are not supported in Web browsers 22 To select a background color for the form click on the More Colors buttonl S The Designer will display a color palette from which you may select a background color 23 In the Restrict viewing to roles field select those roles that should be allowed access to the form All of the roles available for this procedure are included in this list In addition the following default roles are included in this list and have special functions Access represents the role chosen for the map s Limit access to roles property Only users with the chosen role will have access to this form Everybody grants access to this form to any user registered on the Metastorm system 6 amp Y For further information on using the everybody role refer to section 8 1 8 Using the everybody role Metastorm Administrator grants access to this form to individuals holding the Administrator role on the Metastorm BPM system Metastorm Guest grants access to this form to anyone registered as guests on the Metastorm system Originator grants access to this form to the individual who ori
152. 0 Priority 10 e string a text string This may be a literal quoted or not a text or memo variable a function result a conditional expression or any combination of these e g This folder is called FolderName A maximum length which may be up to 250 may be specified for any string property or variable no maximum length is specified for a function argument or result Any number may also be used as a string it will be implicitly converted by Metastorm BPM e list a text string comprising any number of comma separated string values These may be entered as successive lines rather than comma separated in properties Where a list is passed as an argument it must be quoted to avoid the function treating it as a sequence of arguments e date time a date and time value This may be a time variable a function result a conditional expression or any combination of these The Designer does not provide a way to enter a literal date time nor does Metastorm BPM perform any implicit conversion of other values to date time values e condition a logical condition This may be a literal TRUE or FALSE value a check variable a function result a logical or conditional expression or any combination of these Any number may be used as a condition 0 will be treated as FALSE and any other value as TRUE Some properties expect one or more commands This is notionally a valueless property used for its side effects This may be a
153. 000000000000000000000000034 This will raise the flag firstname1 and affect only the folder with the folder ID of 0000000000000000000000000000034 258 May 2008 Metastorm Inc 2008 Designer User Manual a If the folder ID exceeds 31 characters errors will be displayed and the folder will not be moved FlagData You may define any flag data to be passed along with the flag If more than one piece of flag data is to be passed they are delimited with tabs If you are passing multiple amounts of flag data the entire switch must be encapsulated in double quotes For example eRaiseFlag exe FlagName firstnamel FlagData datal data2 data3 This will raise the flag firstname1 with three flag data items data1 data2 and data3 ServerName If you are running eRaiseFlag exe on a machine other than that of the Process Engine you must specify the computer name of the system running the Process Engine In order to raise a flag from one machine to another you must have appropriate DCOM rights to the server running the Engine amp For information about DCOM rights to the Process Engine server refer to the Administration Guide For example eRaiseFlag exe FlagName firstnamel ServerName metastormbpm This would raise the flag firstname1 on the server named metastormbpm n The syntax of the command may be displayed using the option For example eRaiseFlag exe 9 3
154. 008 147 Metastorm BPM Release 7 6 1 Add a label field to the form 2 Set the Caption field on the Text tab The link that appears on the form will have this caption 3 On the Do This tab set the Client Extensions to URL lt your chosen URL gt For example URL http www Metastorm com A This works only for the Web Client or Windows Clients using web forms Using a Label field to add HTML elements to the form You can embed small fragments of HTML into a form using the caption of a label field To do this 1 Add a label field to the form 2 Enter HTML commands in the Caption field on the Text tab For example lt a href http www metastorm com target _blank gt Go to Metastorm s web site lt a gt This HTML adds a link to the Metastorm website to the form The caption will read Go to Metastorm s web site lt iframe src http www metastorm com gt lt iframe gt This HTML embeds a view of the Metastorm web site within the form A Any HTML embedded in a form in this way becomes part of the larger HTML document that is used to generate the form Therefore there are limits to the HTML that can be embedded using the Label field For example the HTML that makes up the form contains a lt BASE gt element This contains a base HREF An lt A gt element cannot be used with this lt BASE gt element unless it references an external file as in the following example lt a href http www me
155. 1 9 Defining External Tables criniera naai errre e esanian 280 Creatine External Tables naonao tvs Activin TE EEEE ES EE EE n 280 10 1 10 Accessing Business Rules ENngin s ccccccccscesccccssesscsesssseescsseseesesseseesesseseescseeseesessesees 282 Selecting the Execute a Rule or Get Rule Result Integration Wizard Item eee 284 Specifying Rule Connection Information cesesssessssssececseceeesseseeecscessnceescseseensaeeeesesesneneneeees 285 Selecting the RULE z esenee a a e inl E E E sana drag EREA V 287 Specifying Custom Variables to Pass to the Rue eessecesesssseeecsceseeeseseencaceseseeteesseaneneneeees 287 10 2 SCIP oT SPEARE EA EESE EE EA EE AEE A ES 287 10 2 1 Working with the Scripts Cidlog ccccccsccccssssssscssssecsessesesscsseseesesssseseeseescssesenscseesenscseeseasens 289 Addins a Siptane ees ost T a sonteecde edie ETEA eaa E A ARE NAOS 290 10 2 2 Calling Server side Scripts raris n a E E EEEa EEEE EE an ENES 292 Calling a Server side Script through the Integration wizard seessesesssesessessersrsresrressresrersseee 292 Calling a Server side Script through the Formula Editor eeesesssecssesseseeecseeseeeseeesseseenees 295 10 2 3 Calling Client side SCrigts oinnes einna a Eaa E EE e S 297 Calling a Client side Script through the Integration wizard sesssessesesesesesesssesrrrsrresrresrersssee 298 Calling a Client side Script through the Formula Editor Chent Event Limitations senioare n e aE ET EERE R O
156. 3 Metastorm BPM Release 7 6 W Pick Table s Metastorm Available Selected Application eAction eActiveEngine eAlert eAssignment eAttachment eAttribute eDatasetDefinition eEvent eField eFolder eFolderlD eForm eLog _eMap Figure 106 Pick Tables Dialog Box The Pick Tables dialog box identifies the database you are looking at and displays a list of the available tables in the box on the left Select the table s you wish to draw information from and move them into the selected list You may do this by Selecting a Table Select a table by double clicking on the individual table name Moving the Selected Table Click and drag the selected table into the selected field Use the gt button to move the selected table into the selected field A Designer will automatically search through all tables you select but will return information only from the first row it encounters that meets the row criteria you specify While you may select multiple tables for best results it is recommended that you select only one table per dataset 4 Only the first row in the table is loaded If you want to use multiple rows from the same table you must specify additional datasets A You should be very explicit in the criteria you select Metastorm BPM will load data from the first row that meets your criteria If your criteria are not specified accurately you may not call the right row
157. 7 6 Chr code Arguments code Returns string For example Chr 9 Chr 32 Chr 44 Chr 48 Concatenate string lt Arguments string Returns string For example Concatenate Bob Chr 32 Smith Concatenate Chr 13 Chr 10 a number in the range 0 to 255 whose ASCII character value is required the single character represented by code Horizontal tab wow ae o String two or more strings to be concatenated together the concatenation of all specified strings with no intervening spaces Bob Smith II SNEWLINE 366 May 2008 Metastorm Inc 2008 Designer User Manual Count list delimiter Arguments list delimiter Returns number For example a list or if delimiter specified a string whose entries are to be counted an optional string delimiter between successive entries in list If omitted or empty a comma is used the number of elements in list where each element is separated by delimiter Empty elements are counted An empty list will return a count of zero An empty list containing only delimiters will return one more than the number of delimiters Count Alpha Beta Gamma 13 Count Concatenate Line 1 NEWLINE Line 2 NEWLINE Count C 2 3 Duration from to units Arguments from to units Returns number For example a d
158. Date time field s Do this tab If you are using a variable other than calculated Metastorm BPM uses the variable name as the default caption for the date time field 4 The Caption alignment field contains a radio group listing following alignment position options Left Places the caption to the left of the date time field Right Places the caption to the right of the date time field Top Places the caption above the date time field Bottom Places the caption below the date time field Select the caption alignment desired 5 You can include a text string to give users a brief help message when the cursor rests over the field Type the message you want displayed in the Hint field 6 The Default Action Usage field allows you to specify a default such as read only optional hidden or required for the Date Time field Use the down arrow associated with this field to select the desired default Metastorm BPM Release 7 6 May 2008 167 Metastorm BPM Release 7 6 Defining a Date Time Field s Options Properties Properties DateTimel Properties DateTimel Date O Both lala oA Figure 110 Date Time Options Tab Use the Options tab to specify formatting and other options for the date time field 1 The Format property contains a radio group allowing you to select from the following options Date Displays the selected date in the date time field Time Displays the selected
159. Designer s Guide pdf Defining a Map s Stages Order Properties Properties Flight waldagal Stages Order lees amp Manager Traveler Check class IR withdrawn amp Travel Department ave amp Awaiting flight BH Flight taken Figure 46 Stages Order Tab The Stages Order property enables you to establish the stage priority for each stage on the map The stages pass their priority to the actions originating from them The Stages Order property is especially important when a common stage with user actions or conditional actions originating from it is applied to another stage on the map with user or conditional actions originating from it For a set of user actions originating from a single stage the Priority property for each action determines the left to right display order of the actions in the user interface The action with the 74 May 2008 Metastorm Inc 2008 Designer User Manual lowest priority 1 is displayed in the left most position Applying this to the Stages Order property if a user stage has a higher place in the Stages Order property than a common stage its actions will take precedence over those of the common stage and will be displayed farthest to the left in the Metastorm client For a set of conditional actions originating from a single stage the sequence in which the actions are assessed is determined by the action s Priority property On more advanced maps you may encount
160. Do this Tab Use the Do this tab to specify the calculation formula dependencies and processing to be carried out when an item is selected from a list field 1 If the list field may be updated as a result of a change to another data field or grid that has dependants or as a result of a button being pressed click on the Field is dependent on another check box a If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab 182 May 2008 Metastorm Inc 2008 Designer User Manual 2 The Calculation formula field is visible only if you selected calculated as the field s variable You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 3 Ifacustom variable has been assigned to the list field the Do this tab will display a When Changed option instead of a calculation formula In the When changed field enter any command the system is to perform when the contents of this list field are changed For the commands in the When changed field to be performed when the field is updated the Field has dependants of its own checkbox must be checked 4 If you selected a system variable or created a new custom variable for this list field the Field has dependants of its own check box will be d
161. EE E destvezeceveiees Field exit and ntry ernir siori EE ces E ER E Chent Side Script FUNCHOnS 3 0 2 beeen donde i EE E E A ENE E Ea e 10 3 Glossary of Integration Wizard ItemS essessosescscseoscococcscecoecscososcococcecscososcososeseseoe May 2008 Metastorm Inc 2008 Contents APPENDIX A SAMPLE PROCEDURES csscsssesssessseessenseenseenscenscenscenseaesscenseessonens 321 Publishing a Sample Procedure sscccscsssssssssssscsssssesceseseresesecsssssssesesesesessnsnseseseseseseseesseneeees 321 Locating the sample ProC Aur es cccccscsssssssssssssesssssssessssssessessessssessescssssaesessesaesasaeseesassesaesasesasees 321 Using the sample LDP Gry aneen enesenn iieri ooa r ne RENSE raS ERETO R EN Pessin 322 Setting roles for the sample procedures o ccscesccccssssssessssecesessescssessesseseesesseseesesseseesesseeeaeeseeeenees 322 Using the Set Up sample procedure arisen niran hane Enae Er RAER SNA KAEN RAKE ENA KEA RESA a 322 Sample LIDIATY anrcsin an T A A alee A A alia ete AA 322 THOTA EAN TON EAEE A R E E ART ERE TEOR ae 322 Set Up 323 Preparation seccsscccrssencesecevatin r E e rE E ENEE SEE 324 Points tO NOE i seks sess e EEE A te eed aie A EAE E S E 324 Cae Manraceme ranean a a a a RO Rae tes 325 PLP Arathor eisein esie nore i EEEa EE VE EE ie EA AEE E AAR 325 Points tO NOt veie ae tenes EEEO E EEOAE OEA EE OE 325 Flight 327 Preparation taiete oen eaer e Err AE ERE wane EE EEE TEE iE PERAE
162. Facilities Payroll IT Variable Type Add text 31 Address2 text 31 CCby text 31 CorporateCulture check Department text 31 DOB date time EmployeeN ame text 31 EmpNumber text 12 Grade integer Aa Hm amp amp amp lil v 104 May 2008 Metastorm Inc 2008 Designer User Manual Figure 66 Custom Variables Dialog 2 Click on the Add button to display the Custom Variable dialog Custom Variable Variable name Datatype Eig Text Maximum size 250 Figure 67 Custom Variable dialog box 3 Enter a name for the variable in the Variable name field The variable name Must be unique for each new custom variable associated with this map Must be no longer than 31 characters if you are using SQL Server 30 characters if you are using Oracle Must be comprised of only alphanumeric characters without spaces Must not begin with a number Should not begin with the letter e This will help avoid scripting errors Must not include underscores if the variable is to be exposed as a web service Must not include reserved words A A number of words have special meanings in the databases that Metastorm BPM supports You should not use any of these reserved words when naming a variable Refer to the Reserved Words txt file for a list of reserved words This file is located in the Metastorm BPM Designer folder Must not include system variables A list of system variables is contained wi
163. FolderName Originator etc or may be calculated If your procedure contains several components and you wish to view more icons on the Component Bar place your cursor at any point in the Component Bar click on the right mouse button and select Small Icons 1 3 6 Main Pane This is where you define the elements to be used in the selected component of the current procedure When you select a e Map or map segment on the Procedure Explorer Designer displays the selected map in the Main Pane e Form or form segment on the Procedure Explorer Designer displays the selected form in the Main Pane 1 3 7 Status Bar The Status Bar displays e The progress of any File Open or File Save operation e The number of components in the current procedure e Whether the procedure has been modified e The status of the NUM lock and CAPS lock keys and e The status of the SCRL lock and INS lock keys Modified CAPS NUM SCRL OVR 5 Figure 18 Status Bar 1 3 8 Properties editor Maps and forms and each of their elements have certain default properties however you may find it necessary to modify some or all of these properties This is done using the Properties editor Options available within the Properties editor vary based on the type of element selected 42 May 2008 Metastorm Inc 2008 Designer User Manual Properties P Properties VP Stage name YP Type kon r ia Available pages Selected
164. Form1 Form name External form File name Figure 157 External Form Form Tab Forms have several predefined properties which may be reviewed and changed through the Properties editor some of these properties also apply to external forms General properties for a form are defined on the Form tab of the Properties editor On the Form tab of the Properties editor enter a short meaningful name for the form in the Form name field This name is displayed when the user opens a folder that includes this form This field may not be left blank and the form name must be unique for each form in a single procedure The following characters are not supported in the Form Name property e Pipe I e Period e Dollar Sign e Equal Sign Metastorm BPM Release 7 6 May 2008 227 Metastorm BPM Release 7 6 e Back Slash e Quotation Mark e Forward Slash e Percent e Comma e Plus e Colon e Semi colon e Open bracket lt e Close bracket gt A A number of words have special meanings in the databases that Metastorm BPM supports You should not use any of these reserved words when naming an external form See the Reserved Words txt file for a list of reserved words This file is located in the Metastorm Designer folder 1 To use an external form check the External form check box The Properties editor will change to display the property fields exclusive to
165. List To add roles to the roles list first open the procedure whose roles you wish to modify 1 From the General toolbar click on the Roles punon Alternatively select View Roles from the menu The Roles dialog is displayed 248 May 2008 Metastorm Inc 2008 Designer User Manual Figure 168 Roles dialog as an independent display Dynamic roles are identified by a formula defined in the Formula column A The default roles created by Designer are not assigned to any particular map and appear on the Common Roles tab Roles created for and assigned to specific maps will be placed on tabs corresponding to the map to which they are assigned 2 The Role dialog can also be called from the Common tab of the procedure map by clicking on the Roles icon 3 Roles can be added and removed To add a Role click on the Add icon on the dialog toolbar or right click in the Role dialog and select the Add icon A new line is added to the bottom of the list of current Roles Manager Networks Payroll Clerk Security Manager Telecomms Lv Description Manager of employee The networks team Adds people to payroll system Issues security passes The telecomms team v Formula GetFold sGetData GetData sGetData GetData To Do list Users with the folder on their To Do list ToDoLis Watch list Users with the folder on their Watch list sWatchLi access User with the role defined in L
166. M Release 7 6 amp BRI Properties General Used Libraries LDAP Aliases Document Management Drag a column header here to group by that column Work Offline Library Name BRI Library Sample Library v Version Published Description i 3 25 2008 4 45 03 PM 2005 12 31 26 PM By 4 Figure 195 Procedure Properties Used Libraries tab Searching the Directory In the following example we use the LDAP alias to retrieve details from the directory when a server operation button is clicked 1 Inthe button s When Button Pressed property select the Integration wizard icon 2 From the Action and Form Information category choose to Assign Value Click on the Next button 3 Select the Variable to assign the results to In this case the custom variable Subject 4 Click on the Integration wizard icon for the Value property The Retrieve Information from LDAP directory search setup screen is displayed Integration Wizard Assign yalue lt Value gt Retrieve information from a LDAP directory search Category Item Hide invalid g Action and form information gP Commands g Custom variables g Dates and times g Directory integration g Microsoft Exchange adaptor gP Metastorm BPM database g Extemal database adaptor g File adaptor Folder information g Form fields g Lists and memos g Microsoft Office adaptor oe Numbers Text fun
167. ML and PDF form types is contained in a predefined list However you may wish to include information about your external forms designer application for convenience in editing your form while creating your procedure Information about external forms may be reviewed and modified through the Designer External Forms dialog a External forms definitions are maintained in a master list used for all procedures created by the Designer If you add delete or modify the external forms definitions in the External Forms Options list this list will affect other procedures developed or modified under the same installation of Metastorm BPM To Add Modify or Review External Forms Options 1 Click on View Options from the menu The Options dialog appears 224 May 2008 Metastorm Inc 2008 Designer User Manual Options Publisher Editor Miscellaneous File Locations External Forms Ask for confirmation when the procedure already exists Ask for confirmation if a role is used by another procedure Use transactions recommended Show validation warnings Enable versioning Enable procedure protection Figure 154 Options Dialog 2 Select the External Forms tab from the Options Dialog Designer displays the Options dialog showing the forms types Options Publisher Editor Miscellaneous File Locations Extemal Forms Extension Description html html forms pdf pdf forms Figure 155 External For
168. Next button An entry box is displayed The available items for that are displayed in the right column Integration Wizard When stage started Select the variable to which a value should be assigned Variable n S Figure 69 Assigning a value 5 Enter details of the variable using the sequences dictated by the wizard Alternatively the Formula editor button next to the Wizard icon in the Properties display will call the formula editor to enable you to write an expression independently When the Value expression has been entered click the Finish button Metastorm BPM Release 7 6 May 2008 109 Metastorm BPM Release 7 6 5 COMPLEX TYPES Complex Types are data types which can contain simple data types and or one or more nested complex data types The Designer has been extended to provide support for Complex Data Types To use Complex Types the Metastorm Process Activators which ship with the Process Orchestrators interrogate INET Assemblies Web Services Enterprise JavaBeans and create Integration Wizard Collection Libraries which contain exposed methods as Integration Wizard functions Associating a library with a procedure makes the exposed methods available as functions via the Integration Wizard When these functions use complex type parameters the Process Designer maps complex types to custom variables using a graphical interface In addition to the generated library Metastorm BPM provides
169. On the Do This tab specify the formula for the flag in the When action started property by directly entering the formula or by using the property s Integration wizard or Formula editor Metastorm BPM Release 7 6 May 2008 257 Metastorm BPM Release 7 6 Properties Action1 Properties Action1 Action name Action Icon Type When action completed JP Flagged Only start action if Priority 3 A T Alert message BeA jsact ion Name Figure 174 Do This Tab Figure 175 Action Tab 9 3 2 Using eraiseflag exe to raise a flag from an external application The program eRaiseFlag exe can be used by any external application or any user to raise a flag outside of Metastorm BPM If you need to raise more than one flag at a time you can create a bat file to automate this command line tool The syntax for eRaiseFlag exe is as follows eRaiseFlag exe FlagName lt name gt FlagFolder lt folder id gt FlagData lt flag data gt ServerName lt server name gt Switches in eRaiseFlag exe are defined as follows FlagName This switch is required to select eRaiseFlag exe This is where you define the name of the flag you want to raise For example eRaiseFlag exe FlagName firstnamel This will raise the flag named firstname1 FlagFolder You may specify a folder in order to move only that folder For example eRaiseFlag exe FlagName firstnamel FlagFolder 0000
170. OnC lick we lcomemessage lt La S Properties S Find and Replace 4 gt Figure 229 Properties editor Client extensions field completed When the procedure is run the script will be called In this example when the button Show Alert is pressed a dialog will be displayed showing a welcome message Metastorm BPM Release 7 6 May 2008 303 Metastorm BPM Release 7 6 Microsoft Internet Explorer X This is a welcome message Show Alert Figure 230 Show Alert button script displaying welcome message Client Event Limitations Field exit and entry a Scripts that cause message dialogs to be displayed or the focus to change are not supported when called by field exit or field entry events The field exit OnBlur and field entry OnFocus events are not supported on all fields The following table illustrates the availability of these events Field Name Field Exit Event Field Entry Event Note Supported Supported Button x x There is an OnClick event available Check v v Clip x x Currency v y Date Time v v Dropdown v v Grid x x There are field exit events OnCellBlur on each cell of an editable grid Image x x Label x x List v v Memo v v Multiple Attachment Clip x x Number v v Radio v v Rule x x Signature v v Status v v Text v v Table 40 Availability of field exit and entry events
171. PM Release 7 6 May 2008 151 Metastorm BPM Release 7 6 You cannot associate a Calculation formula with a multiple attachment grid If a custom variable has been assigned to the attachment clip the Do this tab will display a When Changed option instead of a calculation formula In the When changed field enter any command the system is to perform when the contents of this clip field are changed A The clip field s When changed event can fire only when the form is submitted When changed events will fire only when the form is submitted if the Engine is set up to Fire When Changed On Submit For information refer to the Administration Guide AAA multiple attachment grid does not have a When Changed option 2 Enter any commands to be performed by the system when this clip field is entered or exited in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Client Extensions on attachment clips and multiple attachment grids are not supported when using Web forms Defining a Command Button You can place any number of command buttons on the foreground of a form so that the user can invoke actions on the client or the server To add a command button click on the Command button icon on the Form toolbar and then click on the location on the
172. REN Removing Libraries Role Maimten antes enir re ar eT EEEE ETE OE EEEE EEEE ARG La A Editing a LADIATY Aeaee iepen E E HAK ARAT EENAA EEA EAR ERSEN 2 2 5 Accessing a library s LDAP Alids ccccccsesssssesssessssescsesesseseseeecseneeceseseeeeeeaeeeaeseeeteeaeneeaes 2 2 6 Accessing a library s Integration Wizard collection c e 58 2 3 Working with a Procedure that uses a Library ssessoccscscscoscococcccscseoscocosoccseseoscocosescsessosooso 59 D3 LADENY N ET NONS i EEEE baa REEE REES bade nev decd RE EER SEEE ES EAE 59 2 3 2 Loading the required version of the library ssesssesesesesessesssssssessssessssessrsesessssesesees 59 Summary esete rea eare eao aa E EEE E titi iis ed aaah n e 62 2 3 3 Reverting to an Earlier Library Version cscccccccsssessssessssessssesesecsceeseseaeseeeceesenseaeseeeeeenes 63 23 4 Working ONE niie nane E e E inn E EE Ra ioie 63 To tak a library offline seroren ea EE EAEE EE ETETE ORERE ETEEN 64 To take a library online Updating the library offlite voivan e EEE TEE RKENEN 65 E a ea EE tas auatn weseityeaauvasSyestuatsnanexsustctivesvcehaueuetescttayuagavasuaxsargbensneedescsescesssatee 66 3 1 Creating a New Map siscecsssccsessssoscssvasaciesassonssesscessesosnssssasssdssesensesesentcessesensustessovesteosnsesseontsnsseesse 67 3 1 1 Working with Map Elements c cccccccccccsssssssesssscsesessseseseescseseuceaeseeeseaeseeaeseeceeaeeeeaeaeeeeeaes 67 Addins Stages toa Mapsen riar aee TEE REE ETENE Adding
173. Release 7 6 May 2008 215 Metastorm BPM Release 7 6 Properties Delimiter CHR 44 Figure 149 Grid delimiter selection To define the delimiter used in a Grid 1 Select the Options tab The Options property editor is displayed 2 Enter the delimiter by one of three methods Type directly into the Delimiter field Use the Integration Wizard or Use the Formula Editor For further details on how to enter a delimiter see page 174 Defining a Grid s Columns Properties A grid is set up initially with one column with the default name Column 1 To specify the columns to be displayed select the Columns tab 216 May 2008 Metastorm Inc 2008 Designer User Manual Properties Grid1 eFolder eFolderlD eFolder eFolderName eFolder eSubject eFolder eMapN ame eFolder eStageN ame 3 Column name eFolder eFolderlD v Column caption eFolderlD Column width P x Figure 150 Grid Columns Tab 1 Add further columns by clicking on the Add button If you want to remove a column select it and click on the Drop button 2 When you select a column from the list Designer places its properties into the remaining boxes on this tab The Column name drop down list contains the name of the column currently selected Do not accept the default column name created when a new column is added The column name must match a valid column in the selected table or the form with th
174. SAVEASUNICOE o ccesesesecseeseesesesetenseseteeeteeneeeess 403 SEN AN emal MESSAGE vesceccsesccscssesecsescesecsescesessesceseesesesseesessesesssseeecseeseescseeseeseseeseeeeseeseeeeseeseaees 404 CDOT ALON Ir A EEA LOE NEA OERA AE EEA OEEO 405 General OPer ators cessed cascen hea dicen hited Aisin Aenea ata ele ain Asa aca ANEA 405 Typecast Oper ahr s iis savievat eects dh iai E Dae tani RAEE ar 405 Topical OPer QtOTS wise eraan EE R EAN sadesan lead AEE AE E aS E AAAS 406 Arithmetic OPerdtO Suaress eaaa NN AARRE E EREA 406 Quotation Marks nenin e R E E A a AN RAR ae ES 407 Escape per t T s neie an Ves e a ea a Vea a e shay aae a A Hester eos 409 Line Sepira ei e eE E E E E E E O 409 APPENDIX C DESIGNING AN ACCESSIBLE PROCESS s sssesssesssssseenseesseesseees 410 Section 50S COMPMANCE ssssisccsiasececscescscdevavncecstencsecavesoogstecsdececensdecscesbencsvesvendaesecessvoondasev eusvnoncecsecs 410 Keyboard Na vigationisisisccscsscscscsssesscccsncsssessveseecesacssossecussncosncsasessnescecstecsessestesencsesesecsssneneutsscossuesees 410 Internet Explorer Text Size ccssseccssosesesscsistecssssesesesceseeasenvecesesbsceassensosevcsoessarsesbucescovesdessancesescteasevses 411 Color BIITGIESS 5 sscsesasccissesensecessnscessnseesensssseveecesenseseasesetsnstenssadecesyaseencesssontsssasnasuccseiiesesteasbessoossssenenses 411 JAWS for Windows Suppor t scecsecsssacnossscsesersssocvossssseesaceceassssesnsnsevensssasnonssseessesacssnose
175. Set the number of decimal places for the field using the arrows provided in the Decimal places field 4 Inthe Currency symbol field enter the currency symbol for the currency desired 5 Inthe Currency symbol position field use the drop down list to select whether the currency symbol will appear before or after the currency number 6 Use the drop down list associated with the Negative number style to select one of the following options Placing a minus sign before the negative currency number default Placing a minus sign after the negative currency number Placing parenthesis around the negative currency number Defining a Currency Field s Do this Properties Properties Currency1 Properties Currenc Calculation formula C Field is dependent on another Client extensions Figure 104 Currency Do this Tab Use the Do this tab to specify the calculation formula dependencies and processing to be carried out if the user changes the value in the currency field 1 The Calculation formula field is available only if the variable was set to Calculated on the Currency tab You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Metastorm BPM Release 7 6 May 2008 161 Metastorm BPM Release 7 6 Click on the Formula editor button to open the Formula editor dialog 2 The When changed field appears only
176. T Flight reservation Flight request YP approval Flight request progre Sample Library Make Sample Library Note lt Sample Library Audit rt Figure 19 The Properties editor The Properties editor can be considered as a master notebook of the modifiable properties of every component of your procedure maps and forms and the individual elements used to create them Tabs within the Properties editor correspond to individual maps and forms as well as each map and form element The tabs of the Properties editor that you will see while creating your map depends on the type of map element selected and to the properties defined A Each map or form element has a Properties editor tab specific to that type of element Other tabs of the Properties editor are common to several different map and form elements but may display different property fields or require instructions based on the type of map or form element you are working with Throughout this User Manual the individual tabs of the Properties editor will be described with the corresponding map or form element Many of the properties you can modify through the Properties editor require you to enter a formula In most cases the formula entry fields will include options for calling on the Integration wizard or Formula editor both of which are described later in this section The Properties editor may be floating or docked to the top bottom or sides of the main pane To dock the
177. This Properties Defining Notes Properties serere a T E E ea dae ec entire BBD St ge spe ifie TADS inserire ie ne ainia cea shh bade tbedecs bdebis Wactaen aseadesascbeen Defining a Sub procedure Stage s Maps Properties sssssecssssseceseeeeesseseesssececncetessesneneaeeees 82 Defining a Common Stage s Applied to Properties sesesesesssssscesseeceessesecesscencnceseessesneneneeees 83 3 3 3 Renaming and Deleting Stages cccccccccccsssesssscsssessssesesecseseseecescseaeceaeseeeceeseseeaeseeeeeeaeneeaes 83 JA At ONS reenirinte i 83 3 4 1 Working with Action cccccccccccsssssssssssssssssssssessssessescsssssesessessessssessesssseseesesaeseesaseesaeeaseeseeees 85 Adding Actions 10 8 Map sconce csceih nine irine iiiar inae E NE 85 Deleting Actions froma Map nv ies cs cepeepvsesseenss evereeestestabaneeceveneshpoebaeesser viens peepee eben iei 86 Moving Actions Conditional Action Issues i 6 00 ceases avin aes eth EE TE E E E a a ei 86 3 4 2 Action independent TADS sccccccccsssecsssesseseseseescsesesceseseceeseseseeaeseseeseaeseeaeaeeceeaeneeaeaeeeeeeaes 87 Define Action Properties sonecie iiaa e EEEE A i AE E E E AE 87 Using the Clone new folder option eseseeesesseeiesesssrsesrereeressrserrtrrereessrsrereersrserseseeet 90 Defining Do This Properties ren arin rar ia EE EEEE EA EESE Defining Notes Properties seeeee Defining Simulation Properties Defining a Creation Action s Simulation Prope
178. Time date time The date and time when the formula is evaluated by the Engine System Users memo The list of currently registered users on this Engine s database User Error text 31 A custom error message specified by the process developer This variable is only available in an action and will be reset after committing or canceling that action Setting this variable causes the commit to fail and the error message to be given to the user User Form text 31 The name of the current form This variable is available only in a form User Input memo The value just entered by the user into a data field and not yet validated This variable is available only during the evaluation of a field s When pressed When changed or When user selects row property User Input column number memo The value of the specified column of the currently selected grid row This will be empty except during the evaluation of the grid s When user selects row property User Name text 31 The user s registered Metastorm user name This will be empty during a non user action Table 15 System Variables Folder variables are used to hold data specific to the currently selected folder Unless indicated otherwise they are read write within an action or action form and read only elsewhere The following table lists available folder variables Variable Name Variable Parameters Type size ActionCount number The number of actions comm
179. To avoid this split the fields across a number of forms linked together by chained actions amp Y For further information on chained actions refer to section 3 4 3Action specific Properties Before adding elements to a form it can be helpful to create a list or worksheet summarizing the information the form is to collect and display This may help you to determine logical divisions of information that might be more usefully gathered or displayed on separate forms This section explains how to create a form define its properties and add background and foreground elements to it In addition instructions are provided for using external forms 6 1 The Form Editor Forms are created and modified in the Form Editor in the Designer Main Pane As you add elements to a form you may find it necessary to manipulate the size and placement of them in relation to other elements Metastorm Designer provides a basic set of tools to assist you in form layout and design Metastorm BPM Release 7 6 May 2008 127 Metastorm BPM Release 7 6 6 1 1 The Form Toolbar When the Form Editor is active the Form toolbar is displayed Figure 82 The Form toolbar The Pointer arrow button is used to select a particular form element The remaining buttons on the Form toolbar are used to add form elements to the form The following table lists the buttons on the Form toolbar Button Button Name Bu
180. Window The Designer main window has the following components e Title Bar e Menu Bar e General toolbar Metastorm BPM Release 7 6 May 2008 27 Metastorm BPM Release 7 6 e Map or Form toolbar e Procedure Explorer e Main Pane e Properties Editor e Status Bar A The display will vary according to the status of the Designer when it was last closed When Designer is opened for the first time it will display only the initial process map 1 3 1 Title Bar The title bar displays the name of the current procedure 1 3 2 Menus You can gain access to most of the Process Designer s features by selecting items from either the menu bar or the buttons on the toolbar There are five menus that you can access from the menu bar e File e Edit e View e Component e Help The File Menu You can access the File menu using the shortcut lt Alt gt lt F gt Shortcut and Access keys for accessing individual File menu options are given in Table 2 below Option Access Key and Function Shortcut New lt Alt gt lt F gt lt N gt Starts a new procedure or library If there is another or procedure open Designer gives you the option of saving lt Ctrls lt N gt changes to the current procedure Open lt Alt gt lt F gt lt O gt Displays the standard File Open dialog allowing you to or select and open a previously saved procedure with the lt Cirs lt O gt option of first saving changes to the current proced
181. You use this option to return the folder ID of the folder if any that raised the flag that triggered this action If a folder did not raise the flag or an external application did not specify a folder when raising the flag then the value will be blank Flag name text You use this option to return the name of the flag if any that triggered this action Form name text You use this option to specify that Metastorm BPM is to return the name of the form being used If no form is being used then no value is returned Grid selection text You use this option to specify that Metastorm BPM is to return the value from the specified column when any row of a grid is selected New note memo You use this option to specify the text to be saved as the note for an action Next stage text You use this option to specify that Metastorm BPM is to return the name of the stage to which an action will move a folder Server name Text You use this option to specify that Metastorm BPM is to return the name of the server interpreting the property formula TRUE check You use this option to place a TRUE value in a check formula User name text You use this option to specify that Metastorm BPM is to return the login ID of the active user You might use this to define an alert message or to populate a text field with the name of the current user 306 May 2008 Me
182. a creation action This variable is always read only Table 16 Folder Variables A The Metastorm BPM Notify Gadget only displays folders with priorities between I and 9 4 4 Assigning a Value The Assign Value function is the most commonly used expression in the Integration wizard It is used to assign a value to either a system or custom variable To assign a value to a variable 1 Select the variable in Procedure Explorer 2 Inthe Properties display click the Integration Wizard icon The Integration Wizard Subject list is displayed 108 May 2008 Metastorm Inc 2008 Integration Wizard Subject Freely typed text input Category Designer User Manual Item Hide invalid g Most recently used gP All functions g Commands g Custom variables g Dates and times Directory integration g Microsoft Exchange adaptor g Metastorm database g Extemal database adaptor File adaptor g Folder information g Form fields g Lists and memos Microsoft Office adaptor e Numbers g Text functions A abe text E5 Action name F Rule builder o Current date time 8 Current input 08 Error message M FALSE E3 Flag data E3 Flag folder E3 Flag name E Form name E3 Grid selection EGS Next stage EB Server name oj TRUE E3 User name v Figure 68 Integration Wizard Subject list 3 Select a Category in the left column 4 Click the
183. a dataset means that any required information necessary for calculating the information displayed in this field will be read directly from the dataset rather than require an additional call to the database Any datasets previously defined for use with this form will be displayed in the drop down list For more information on creating datasets see the Defining a Dataset Field topic in this section 2 Enter the variable you wish this field to use in the Variable field There are a number of options Metastorm BPM Release 7 6 May 2008 187 Metastorm BPM Release 7 6 Ifthe number is to be calculated at run time select calculated from the list You will be able to specify how it is calculated on the Do this tab If the number is to be stored in the database you can select a variable from the drop down list Only numeric variables will appear in the list You can create a new custom integer or real variable by clicking on the New custom variable button and specifying the details of the variable When you add a custom variable you must select whether the field will hold integer data or decimal numbers real You cannot create a new custom variable if you are using a dataset for this number field If you are using a dataset select the column name the system should use to calculate the information for this field from the column names shown in the drop down list The variable you select on this tab of the Properties editor will det
184. ab and the Notes tab refer to section 6 4 3 Defining Element independent Properties on page 139 Defining a Frame Rule s Rule Properties Properties Rule4 Horizontal rule Vertical rule Frame Color HB Transparent Figure 89 Rule Tab The Rule tab contains a Type radio group allowing you to select from the following options e Horizontal rule e Vertical rule e Frame Metastorm BPM displays the type of rule you select Use the drop down list in the Color field to change the default color value or click the More Colors button for additional color options Set the style of the frame or rule by selecting the desired option from the Style radio group Defining an Image You can place any number of images on the background of a form Metastorm BPM Release 7 6 May 2008 143 Metastorm BPM Release 7 6 Click on the Image button on the form toolbar and then click on the location on the form where you want the image to be displayed Metastorm Designer will display a blank image field and the corresponding Properties editor The Properties editor displays four tabs for defining Image properties Image Do this Extra Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Defining an Image s Image Properties Properties Imagel Imagel lt None gt Figure 90 Image Tab The Image tab contains
185. ables Click and drag the selected tables into the selected field Use the gt button to move the selected tables into the selected field Use the gt gt button to select all tables in the list and move them into the selected field In the Row s field enter the body of an SQL WHERE clause to specify which row s are to be included from the table For example you might enter eUsername Suser name to pick only rows relevant to the user of a form Click on the Pick Rows button to open the Condition builder dialog to help you build the SQL statement If you do not specify the row s Metastorm BPM displays all rows from the selected table 5 You may use the Order field to determine the order of the grid columns Clicking on the Pick fields button attached to this field will open the Pick fields dialog box 214 May 2008 Metastorm Inc 2008 Designer User Manual amp Pick Field s Table eFolder E g Available Selected eActionT ime a eFolder e4ctionCount eActionLser SS BEE eArchived Fy eCategory eCreationTime eDeadline eEntryTime eFoldelD Figure 148 Pick Fields Dialog Box The Pick Fields dialog box identifies the table specified above and displays a list of the available fields in the scrolling box on the left Select the fields you wish to use to sort the rows in the grid and move them into the selected field on the right To specify the order in which fields should be used to ord
186. ach location on the form where you want the elements placed Click on the Pointer arrow or select another form element to disable the multiple placement function Selecting Form Elements To move or resize a form element or to display the corresponding Properties editor you must select it You can select individual form elements by clicking on the Pointer arrow button on the Form toolbar and then clicking on the form element The selected element will have handles at each corner and on all sides which may be used for moving or resizing it Multiple elements may be selected using any of the following methods e From the Form toolbar choose the Pointer arrow button Place your cursor over a point on the form click on the left mouse button to change the cursor to a crosshair and holding the left mouse button down drag your cursor to encompass all of the desired form elements Designer will display a dashed line indicating the outer edges of your selection All items within the dashed line will be selected when you release the mouse button e From the Form toolbar choose the Pointer arrow button and click on a form element Then holding either the Shift or the Ctrl keys click on any additional elements desired to select them e From the Edit menu choose Select All Designer will select all elements currently on the form Metastorm BPM Release 7 6 May 2008 129 Metastorm BPM Release 7 6 If you have selected multiple form el
187. al Tables dialog 3 Type the name of the table you are creating and press OK The External Tables dialog is displayed with data entry facilities see Figure 201 above External Table names cannot include extended ASCH Characters non US English characters or spaces and must not be Metastorm reserved words words that have special meanings in the databases that Metastorm BPM support Refer to the Reserved Words txt file for a list of reserved words This file is located in the Metastorm BPM Designer folder In addition they must not be system variable names A list of system variables is contained within the oemdesigner xm1 file under the lt Variables gt lt Variables gt node This file is located in the Metastorm BPM Designer folder 4 To enter the information for the first column click Add in the Column area of the screen The Define Column dialog box appears Define Column Name I Cl Index Type Eig Text v 50 Figure 203 Define Column Dialog Metastorm BPM Release 7 6 May 2008 281 Metastorm BPM Release 7 6 5 Inthe Column Name field enter the name of the column External Table column names cannot include non US English characters and must not be Metastorm reserved words words that have special meanings in the databases that Metastorm BPM support Refer to the Reserved Words txt file for a list of reserved words This file is located in the Metastorm BPM Designer folder 6 Select a column
188. al system or transmitted in any form or by 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 metastorm com http www metastorm com ii May 2008 Metastorm Inc 2008 Contents Metastorm BPM Release 7 6 Designer User Manual Table of Contents T GETTING STAR DED iascesasaticcensiesnnasscacasncnsies unaceanacesattensacacerncsueaaiasaramncesnanaann ercnamncenanieastees 16 1 1 Metastorm BPM Components ssccscssssscsssossssssscsssssesessscessssssesessssessssssescsssscesessasecessaseses 17 PAE DEST a T BASICS A EE EE E EEA EA E EEA E skesosescocessbessounvenvens 18 1 2 1 1 2 2 Concepts ANd Vocabula y o cescccecssesssecsesesseseseseeeeecneseaesesecseaeacsaesesececaeseeaeseeeeeaeaeeataeeeeeeaes 18 Desie ing a PTOCCAULE seriinin n n a a a 21 Define the Procedure Propertics c s sscscssesessssescsesescsescecsesessesesesesesesesessesecscseneacseseneececeeeneneaeeees 21 Define the Initial ACO Oirr rreren apr enee e rr reS oee EE n enpor lavevcucestavsascieistavcdeevevtionevdecuise Define and Prioritize Tasks Id ntify Participants ssvci cis ssecccsesrcecess ssvevsctuess secesdvsaveensshaycuaunsebcusash aves sE E E oaee Pee SE EERE E E REESE e E S Determine Necessary Information ccccccccsesssssssseseseseeceeesesesesesesesesesesececec
189. ame Arguments symbolicName a string specifying the out queue to unregister Returns boolean 1 on success otherwise an Metastorm formula exception 402 May 2008 Metastorm Inc 2008 Designer User Manual WriteText string filename new file saveasUnicode Arguments string filename new file saveAs Unicode Returns command For example a string to be written to filename a string identifying the server directory path name and extension of the file to be written an optional number indicating whether any existing file should be replaced 1 or have string appended to it after a new line 0 If omitted string will be appended to filename if it already exists an optional number indicating whether the string data is stored as Unicode characters 1 or as ANSI 0 characters 0 The default is zero saves string followed by a SNEWLINE to the specified filename in the server file system Metastorm BPM Release 7 6 May 2008 403 Metastorm BPM Release 7 6 WriteText ipsem dolorem C My Documents Memo txt Append to Memo txt using WriteText Action Notes C My Documents Log txt 1 ANSI chars Replace any current Log txt WriteText StoryInRussianMemo Send an e mail message C My Documents The Nose txt 1 1 Writes out rather fine short story by Gogol in Unicode replacing anything currently in this file This function is provided by the Ma
190. an empty Picture field where a copy of the image you select will be displayed To specify the image to be added to the form click on the More Pictures button or double click in the picture viewing area Designer displays the standard File Open dialog box Browse for the file you want When an image is selected it will display in the Picture field To preview the picture on the form click the Preview button above the viewing area To remove an image from the form click on the Clear button above the viewing area The image will be erased from the Properties editor and will also be removed from the form when the form is returned to focus When you publish the procedure Designer stores the image file in the database as an application attachment places a copy of the image in the image field of the Properties editor and updates the form to display the image 144 May 2008 Metastorm Inc 2008 Designer User Manual Defining an Image s Do This Properties Properties Imagel Client extensions Figure 91 Image Do This Tab An image has only one item on the Do This tab of the Properties editor In the Client extensions field enter any commands the system must perform when the form is entered or exited whether as a tab in a folder or as an action form You may create and edit the formula using either of the following tools e Integration wizard opened by clicking on the Integration wizard button e Formula edito
191. anager Shipping Clerk and Operations Controller are all roles which may have responsibility for particular stages and actions in the procedure Using roles rather than assigning particular individuals to the task makes it much easier to maintain a 244 May 2008 Metastorm Inc 2008 Designer User Manual procedure As individuals join and leave the organization or change duties within the organization the administrator has only to reassign the role to another user rather than ask the procedure designer to change the procedure Roles are defined through the Roles dialog which may be accessed by clicking on the Roles button on the General toolbar or by selecting the menu option View Roles There are two types of role e Static A role to which users are assigned through the Users and Roles tool for example area managers The same user holds the role for every Metastorm procedure A static role defined through the Roles dialog is added to the database when the procedure containing it is published Once the procedure is published this static role may be managed through the Users and Roles tool As new static roles are added to the database their role assignments become available to Metastorm procedures In order to utilize a static role assignment the role must be defined in the procedure that uses it Z Iltisa good idea to make a master list of the static roles in your organization and post it where yo
192. and linking them with the actions necessary to move the folder to the next stage The Properties editor is used to e Name the stages and actions and e Assign folders to To Do and Watch lists Map segments are sections of maps that can be re used in other maps Map segments are designed in the same way as maps but with the following restrictions e There is one entry point and there may be multiple exit points and e The first action in a map segment has no properties and is not removable 66 May 2008 Metastorm Inc 2008 Designer User Manual Apart from these issues designers can create map segments in the same manner that they create maps Map segments can be saved independently from the procedure file and added to other procedures 3 1 Creating a New Map Before using the Designer for the first time you should be familiar with the terminology used and have a basic understanding of automated business process design Whenever you start Designer or create a new map a default map is displayed in the Main Pane This map consists of a Start Box and a User stage connected by a User action First action he First stage Figure 43 Default Map As you add elements to a map you may find it necessary reorganize the elements to optimize the space Designer provides a set of tools to assist you in map layout and design 3 1 1 Working with Map Elements Adding Stages to a Map To add a stage click on the desired s
193. any processing to be carried out at this stage To specify processing to be carried out when a folder reaches this stage from another 1 Enter one or more commands into the When stage started field Commands are evaluated when the folder arrives at this stage A When stage started and When stage completed commands added to a Common stage are applied to all stages to which the common stage is applied 80 May 2008 Metastorm Inc 2008 Designer User Manual If a common stage with a When stage started formula is applied to another stage containing a When stage started formula the order that the formulas will be evaluated in is determined by the Stages Order map property 2 Click on the Formula editor button to open the Formula editor or click on the Integration wizard button to use the Integration wizard to create the command amp For more details on using the Integration wizard refer to Section 10 Creating Formulas a If commands fail to complete successfully whether on entering or exiting the stage the action is aborted and subsequent commands will be skipped Metastorm BPM will log an exception in the Designer Log which may be viewed through the Services Manager and the action moving the folder will be aborted leaving the folder at its original stage in its original state Any Metastorm database commands that have already been executed will be rolled back However any other commands that have already been executed inc
194. ap3 etc Map and map segment names may be customized through the Properties editor or by right clicking on the Component Bar and selecting the Rename Group option Selecting a map group will open a display pane containing icons representing the map and each form associated with it The list order can be modified by selecting an icon and dragging it to a new position in the list Forms on one display pane can be relocated to another pane by dragging the corresponding icon up or down on the Component Bar onto the tile representing the desired new location The pane will open allowing you to place the form in the new pane Maps may not be relocated Custom variables used when defining a form are associated with a single map If you relocate a form that uses one or more custom variables it will not function properly until custom variables associated with that form are defined for the new map Administration Form Group Each Administration form in the procedure is identified by a tile in the Component Bar that bears the name of the Administration Form Metastorm BPM Release 7 6 May 2008 41 Metastorm BPM Release 7 6 e Common Group The Common display pane displays a separate icon for any forms not associated with a specific map These forms may not access any custom variables but are available for use with any map in the procedure Fields on forms under the common tile may be associated with Metastorm system variables such as Priority
195. apply to check box the selected procedure component Category list This displays a list of the categories available for the selected property When you select a different category Designer updates the items displayed in the Item list Item list This displays in the selected category a list of the items that are compatible with the type of property being set This list will vary depending on the type of property being defined Hint This describes the usage of the selected item Back button Click on this to return to the previous step Next button Click on this when you have made your selection to move to the next step Finish button Click on this when you have finished using the Integration wizard to change the property s formula Cancel button Click on this to leave the Integration wizard and leave the property s formula unchanged Metastorm BPM Release 7 6 May 2008 263 Metastorm BPM Release 7 6 Component Purpose Help button This provides help for the Integration wizard Table 33 Integration wizard Component Functionality 10 1 2 Using the Integration Wizard to Create a New Formula 1 From within your Metastorm procedure select the component you wish to work with 2 From the Property editor for the selected component select the Integration wizard button The Integration wizard will open Integration Wizard When action completed Delete matching rows from the specified external d
196. are defined as anyone within an organization who will be using the Metastorm BPM system In most cases this will include everyone on the staff roster and may be expanded to include contract or temporary workers suppliers customers etc Metastorm BPM uses the concepts of users and roles to control access to the various parts of the application and to determine what information users receive from the system A user can have any number of roles and a role can be assigned to just one user or many users Roles are automatically added to the database when a procedure is published The Metastorm Directory Integration Suite provides users in a directory services environment a method of gathering user information from an existing directory while the Metastorm Users and Roles tool provides a Metastorm Administrator a simple way to add users maintain user information and assign role information to users Instructions for using these tools may be found in the Metastorm Administration Guide and the Directory Integration Suite guide This section explains how to define roles within a procedure 8 1 Defining a Role When designing a procedure roles are used to decide whether e Specific folders should appear on a user s To Do list Watch list or neither e A user is permitted to undertake a particular action e A user is permitted to view a form in a folder e A specific form will appear on a user s Blank Forms list For example Credit M
197. associated with a procedure its contents become available to that procedure The benefits of using libraries include e New procedures may be created more quickly existing libraries may be associated with new procedures e Maintenance of procedures is simpler if a form that is used in several procedures needs to be updated it need only be updated in the library Once the procedure is republished with the latest version of the library the updated form becomes available to users of that procedure e Increased accuracy by maintaining one copy of a commonly used part the likelihood of introducing an error is minimized e More than one process designer may build procedures simultaneously each process designer works on a library Libraries are then brought together in one procedure file In addition libraries may be taken offline An offline library is one that is accessed from a file rather than from the database This facility allows process designers without access to the Metastorm database to work on procedures 2 1 Creating a Library A library is a special type of file created in the Designer The following may be included in a library e Forms e Form segments e Map segments e Scripts 50 May 2008 Metastorm Inc 2008 Designer User Manual e LDAP Aliases e Integration Wizard collection This section describes how to create a new library add to the library and save and publish the library 2 1 1 C
198. astorm BPM Release 7 6 May 2008 xiii Metastorm BPM Release 7 6 LDAPSearch directory_alias filter_expression attribute_name search_scope Alt Delimiter rnorti vac tate ere obese oe vs eee es bs hehe es Bahia i ea Pleo 388 Him pure HUNCH ONS sisson a sovasscasvasevencetebesssuseeusbuaseodsasaseseoesbenstessens 388 Delete flename wciteciiacsdkaiwdeaakedwded ANEA SANESA A dia dieawishuideawuadvaceas 389 DeleteAttachment folderID filename ccccccceccccsccecscssscecscsssscessesesssssesesessseseseessseeseseseeeseeseeees 389 EMail toList ccList subject message attachment reply Address ccscccseseecees 390 JoEXCCPYOC procedure arguments eccecscccccesssssessssessscssssscsssssessssesescssessescsesseasesaeeaseseaseasees 390 JEXeECSOL statement data_source cccsccccesccsscssesssescesessssseessesscssesscssececsseessessessesscsseseseaeees 391 PEx c te procedure arguments scscssesescscsseeseesesesenseseseeeceeneuseaeseceesesenceaeseaeeceaeseesceeaeeneaeaeees 392 FExecuteExtensionEval JScript NET Procedure Name MapName Metastorm ProcessEvents HandleExternalEvents DelegateEvents wc 392 ExecuteRule ruleConnection customVariables cecccccccssccscvecescssececesecssesscsseescssesessscssesecsseees 393 GetAttachment folderID filename path ccecccccccscsccccsecscssessssssssssssesesesssesssessseeesessseseseeseeees 394 NewAttachment folderID filename path ccccccccscscccsscscsssssesessssssssss
199. at Metastorm BPM is to delete rows rows from a database table Insert external You use this option to specify that Metastorm BPM is to insert row rows into a database table List external text You use this option to specify that Metastorm BPM is to read a data list of values from one column of a database table and return them as a comma separated list This is typically used to populate a drop down field or other list in a form Read external Date time You use this option to specify that Metastorm BPM is to read a date time date and or time value from a database Read external integer You use this item to specify that Metastorm BPM should read number a number from a database Read external text You use this item to specify that Metastorm BPM should read text a text value from a database Select external text You use this option to specify that Metastorm BPM is to select data one or more rows from a database Timestamp text You use this option to specify an explicit text representation for format a date time in SQL Update You use this item to specify that Metastorm BPM is to update external a table in a database database File adaptor Lists functions used to read and write files List files memo You use this option to specify that Metastorm BPM is to list the contents of a file directory on the server and place the list in an memo variable This may be used to display the directory listing in a
200. at this stage For example you may wish to put a drop down list of possible stages on a form and use that form in the action leading up to the system stage You would then have the option to use the variable mapped by the drop down as the target stage a Auto forward is implemented by a hidden conditional action named gt targeted at the relevant stage If this hidden action resolves to a loopback action that is the target is the same system stage the Engine will detect this and prevent the auto forward taking place A message to this effect will be written to the Application event log Custom extensions can be used if the Process Events Library is associated with the procedure For further information refer to page 392 Metastorm BPM Release 7 6 May 2008 8l Metastorm BPM Release 7 6 A If custom extensions are used the Delegate all external events for map check box in the Map Properties tab will determine the order of the Do This processes amp Y For further information on creating custom extensions refer to Process Orchestrator for NET Designer s Guide pdf Defining Notes Properties This tab of the Properties editor displays a memo field which the process designer may use to make design notes These notes will not be seen by end users 3 3 2 Stage specific Tabs Defining a Sub procedure Stage s Maps Properties Properties Submaps v Facilities v Payroll v IT Figure 50 Maps Tab Sub procedu
201. atabase Category Item Hide invalid g Most recently used Delete external rows g All functions Insert extemal row Action and form information o Update extemal database oP Commands g Custom variables Dates and times Directory integration gP Microsoft Exchange adaptor gf Metastorm BPM database g File adaptor gP Folder information g Form fields gf Lists and memos gP Microsoft Office adaptor oP Numbers e Text functions Figure 178 Integration wizard 3 Select a category from the available categories listed in the left column 4 Select an item from the available items listed in the right column A If the Hide Invalid box is checked only valid categories and items for the selected component will be displayed Otherwise all options will be displayed but unavailable options will be grayed out amp A Glossary of Integration wizard Categories and Items together with brief descriptions of their functionality may be found at the end of this section 5 Click on the Next button or double click on the item Designer opens the relevant Integration wizard dialog The dialog displayed will vary depending on the type of item you have selected For example using the options illustrated above you may select either of two items Assign value Conditional operation Each of these selections will be briefly illustrated on the following pages 264 May 2008 Metastorm Inc 2008
202. ate months Arguments start date the date from which to calculate months an integer representing the number of months to add Returns date the resulting date after the number of months specified by months has been added to the start date For example Months 2 9 2004 1 Returns 3 9 2004 NEVER Returns date time a null unspecified date and time 376 May 2008 Metastorm Inc 2008 Designer User Manual For example Deadline NEVER Clear the folder deadline NEWLINE Returns string a carriage return line feed pair ASCII lt CR gt lt LF gt decimal lt 13 gt lt 10 gt This is used as a line delimiter in strings and between successive rows of a database table For example Concatenate myMemol HNEWLINE myMemo2 amp Y For further information refer to the description of the LineFeed function Rem dividend divisor Arguments dividend a number to be divided divisor a number to divide by Returns number the integer remainder from the division of dividend by divisor For example Rem 50 7 1 RemoveEntry list index delimiter Arguments list a list or if delimiter specified string from which an entry is to be removed index a whole integer number index zero based of the entry to be removed delimiter an optional string delimiter between successive entries in list If omitted a comma is assumed to be the delimiter Returns li
203. ate time field This is necessary if any other fields on the form are dependent on this date time field This box must be checked if any other fields are dependent upon values in this field 5 Enter any commands to be performed by the system when this date time field gains focus or loses focus in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Drop down Field This field is displayed as a drop down list box Use a drop down field to display and select one entry from a list of text or integer values Alternatively the list may be generated by a formula that is entered into the Options list using the Integration wizard At run time the Process Engine will use the formula to determine the contents of the list When a formula is used the items in a drop down list can be a set of single values or label value pairs When label value pairs are used the labels are shown in the drop down and the values are passed to the database A Static list can be used to create a drop down list of label value pairs for example the syntax Label SCHR 9 Value could be used to define London Gatwick CHR 9 LGW Los Angeles CHR 9 LAX 170 May 2008 Metastorm Inc 2008 Designer User Manual ra If you need to select multiple entries
204. ate time from which a duration should start a date time at which the duration should end an optional string specifying the units of duration as follows minutes or mi hours or h days or d weekdays or wys weeks or wks months or mo years or y If this is omitted or empty it will default to days a real number The number of units between from and to If the end time precedes the start time then this will be a negative value Duration Deadline System Time weekdays Weekdays since deadline Duration CreationTime system Time hours Age of folder in hours Metastorm BPM Release 7 6 May 2008 367 Metastorm BPM Release 7 6 EMPTY Returns string For example Subject EMPTY an empty string This may be used to clear string and list variables Clear Subject Find substring instring case start_position Arguments substring instring case start_position Returns number For example a string to be searched for a string to search through a number indicating whether the search should case 1 or should not case 0 be case sensitive an optional number indicating the position within instring after which the search should start The first character position within any string is 1 so to search from the start of the string this value should be set to 1 If omitted or empty it defaults to 1 The starting position from 1 of sub
205. ated script click on the Edit button A e To Delete a previously created script click on the Delete button se a If you delete or make changes to a previously created script be sure you are aware how those changes will affect the Metastorm procedures that use the script Adding a Script 1 Inthe Procedure Explorer select the map or form you wish to attach the script to 2 Open the Scripts dialog and click Add The Script dialog appears Script name Type VBScript O JScript Farm ja Figure 212 Script Dialog 3 Inthe Script Name field enter the name of the new script a Script names cannot duplicate other script names in maps or forms though script names can be duplicated under Common provided that one is a procedure client script and one is a procedure server script or that a script with that name already exists in a used library ra Script names can use characters which are configured with a default locale of North American Western European or Central European character sets However script names cannot include any of the following characters Pipe Period Dollar Sign Equal Sign Back Slash Quotation Mark Forward Slash Percent Comma Plus Colon Semi colon and Angle brackets lt gt 4 Inthe Type list select the scripting language type you are using VBScript JScript or JScript NET This will determine how the script text is syntax highlighted
206. ation of timestamp formatted as specified FormatTime System Time yyyymmddhhnn 200011281830 372 May 2008 Metastorm Inc 2008 Designer User Manual GetEntry list index delimiter Arguments list index delimiter Returns string For example GetEntry a b c 0 a list or if delimiter specified a string from which an entry is to be returned a zero based number index of the entry to be returned an optional string delimiter between successive entries in list If omitted a comma is assumed to be the delimiter a copy of entry number index from list a GetEntry ToDoList FolderID my Index GetEntry Session FlagData 1 Chr 9 Length string Arguments string Returns number For example Length abcdef LINEFEED Returns string For example a string whose length total character count is required the number of characters in string 16 a line feed character ASCII lt LF gt decimal lt 10 gt This is used as a line delimiter in strings Concatenate myMemol LINEFEED myMemo2 4 In Version 6 anew XML based Transaction Protocol TP was introduced The XML Parser which is used by the Process Engine ensures that the TP XML is normalized Part of the XML normalization process results in all line breaks being represented by a Line Feed character Until the XML is normalized a combination of Carriage Return and Line Fee
207. aved references to the library will be lost Referenced map segments form segments folder pages and forms will need to be re associated with stages folder page lists and actions e Jf you enter database connection details into the Connection dialog and press the OK button Designer loads the correct version of the library from the database 2 3 2 Loading the required version of the library It is not possible to e Store more than one library with the same name on the same database It is possible to e Store more than one version of a library with the same name on the same database e Store more than one library with the same name on different databases Therefore Designer distinguishes between different versions of different libraries by checking the library name the version number and a library identifier When you open a procedure Metastorm Designer searches the selected database for the libraries that have previously been associated with the procedure via the Procedure Properties For each associated library Metastorm BPM Release 7 6 May 2008 59 Metastorm BPM Release 7 6 e Ifa version of the library with a matching version number is found the Designer checks for additional versions of the same library Ifno other version is found the library is loaded and you are notified by the following Library Loading Status dialog Library Loading Status Version used n poce se 2 Version in databore 2 Figure
208. behalf of the target Process Engine These parameters are a set of name value pairs required to call the Metastorm Listener web service amp For details of these parameters refer to Appendix D Web Service Configuration Parameters queueSource a string specifying the queue located on the MQ host credentials a string containing the Metastorm user credentials to use when sending the TP eLoginRequest request This is inserted as an XML field input list in the Login request process a string containing the authentication process used when authenticating the user clientType a string containing the client type passed to the Process Engine when authenticating the user 396 May 2008 Metastorm Inc 2008 map stage action params Returns boolean Designer User Manual a string containing the map used when performing the TP action request a string containing the name of the stage from which the action is performed For a creation action this is an empty string a string containing the action name used when performing the TP action request a string containing a set of custom parameters This takes the form of name value pairs separated by semicolons Parameters for JMS and Websphere MQ include e retryNumber which determines the number of times a message is resent to the MQ Listener s processMessage interface if the MQ Listener is down or the host machine is not available e _retryInterval which is t
209. ble several When event formulas for example When User Loads Form When Action Started Metastorm BPM Release 7 6 May 2008 355 Metastorm BPM Release 7 6 Forcing Failure To force any of these formulas when evaluated to fail ensure that the final line of the formula evaluates to False No error will be reported in the Designer log A Note that this is different to User Error which forces a formula to fail at any point in the evaluation The following formulas would fail Formula 1 False Formula 2 True False Formula 3 A 32 A 31 Common Stages When a common stage is applied to any stage the common stage s formulas are applied at the end of that stage s existing formulas For example if Formula 3 above is in the When Stage Started event of a user stage and a common stage with the When Stage Started formula A 32 is applied to it the evaluation no longer fails because the formula evaluated for the user stage is A 32 A 31 A 32 So the final line evaluates to True System Variables Metastorm system variables are used to hold data specific to e the Metastorm Process Engine e the Metastorm user on whose behalf the Process Engine is performing a transaction e a Metastorm user or system action which the Process Engine is performing All Metastorm system variables are predefined new system variables cannot be defined from within Designer Action Name string read only na
210. button above the Fields list 5 Click on the OK button when you have finished making your selection Column Name s Argument When reading values from a database or folder you need to specify the columns from which to read data Enter the names of the columns in the Column name s argument You must specify the names of valid database columns Alternatively click on the drop down list attached to the field so that you can select columns from the list provided Metastorm BPM Release 7 6 May 2008 273 Metastorm BPM Release 7 6 Column Values Argument When specifying processing that will update a database using the Insert row item you enter values for each column of a new row using the Column values argument You can use the Integration wizard to assist you with this by clicking on the Integration wizard button or double clicking in the argument When inserting rows into a database in this way you need to know for each field whether it holds text or numeric values Text values should always be enclosed in single quotes numeric values should not Data Source Argument When you use any of the functions that access an external database you need to specify the name of the data source in this argument This is the name that identifies the data source For example the default Metastorm database has the Data Source Name DSN Metastorm You can select a DSN by clicking on the drop down DSN argument and selecting a defined DSN
211. calculated memo field Read file memo You use this option to specify that Metastorm BPM is to read the contents of a text file on the server and place the contents in a text or memo field This may be used to display the files contents in a calculated memo field Save Copy an attachment from a folder to a file attachment Save folder to Writes the values of all of the folder variables Custom file variables and Metastorm variables to a comma separated values file The first line of the file will consist of field names and the second will consist of values Write file You use this option to specify that Metastorm BPM is to write text to a file on the server The text can be the contents of Metastorm variables or the results of a formula This can either be a new file or you can append to an existing file Folder Lists non custom information held in the currently selected information folder Metastorm BPM Release 7 6 May 2008 311 Metastorm BPM Release 7 6 SERVER ACTION RESULT DESCRIPTION CATEGORY oe All notes memo Returns a formatted log of all the notes added to this folder via the Action Notes variable Rule builder check You use this option to open the Metastorm condition builder to compare two values Earlier text You use this option to specify that Metastorm BPM is to return message the alert message associated with
212. ce Selected Open One item This is read out for the service item My Metastorm Service It is the currently selected filter item is open and contains one sub item JAWS reads out Selected for the currently selected filter item If the current list is a To Do list and the selected tree item is a map item the current list includes all folders for that map Metastorm BPM Release 7 6 May 2008 413 Metastorm BPM Release 7 6 Logging in to a service To log in to a service navigate to the Metastorm filter and to the service you wish to log in to The Level One filter items represent services Press the Enter key when you reach the service you wish to log in to The resulting dialog allows you to submit your user name and password Navigating to the submit and cancel buttons on a form To submit or cancel a form you may need to use CTRL TAB to navigate to the button frame and then the TAB key to navigate to the buttons Alternatively you can press G to access the buttons 6 amp Y For further information on keyboard navigation of the Web Client refer to the Using Metastorm BPM with Internet Explorer document 414 May 2008 Metastorm Inc 2008 Designer User Manual Appendix D Business Rules Web Service Configuration Parameters The Business Rules web service requires a configuration string in the form of a set of name value pairs The following named items are supported Connection Paramete
213. cess Definition Schema Developer Guide available with the Metastorm Software Developer s Kit amp For information on the transformation that takes place when exporting to BPEL refer to the BPEL Process Import and Export Guide available with the Metastorm Software Developer s Kit 1 4 5 Opening a Procedure To open an existing procedure file in Metastorm Designer for review or editing 1 Click on the Open button MM or 2 Select File Open from the main menu You can open procedures stored as XEP files Select the file type using the Files of Type dropdown amp For information on file types refer to section 1 4 2 File Types F A procedure that has been saved but which has not yet been published is not available for use by other users It can be opened only in the Designer Metastorm BPM Release 7 6 May 2008 45 Metastorm BPM Release 7 6 1 4 6 Importing a Procedure or Map You can import procedure data stored in an alternative format if the relevant transformation instructions are available in the Metastorm BPM Designer folder The available formats are listed in the Files of type dropdown on the Open dialog You can also import a map using the Component Add option To import a BPEL procedure or map into Designer 1 Select BPEL files BPEL in the Files of type dropdown 2 Select the file to import Metastorm BPM Designer can import BPELAWS 1 1 The later WS BPEL 2 0 standard is not supported 1
214. ciedscedscnescerexeessccsscorssorssecasuesszecerers seesates stersncciecexcceesnenscteeetears 8 1 Defining a ROME isssscssscsssssscessacsssesscsdsncneseocseisocesncsascsetuseecosnosesecnsescececscsecsconesentscseseceesnoneucsssccentesers 244 8 1 1 Identifying the Roles in Your Organization ssessseseseesesesssssssersesessssesrssesrsessssesrse 246 8 1 2 User Attributes and Relationships c cccccccscsssssscsssesesesscseessesesececeeseseaeaeeeeeeaeneeaeseeeeeeaes 246 ANCOR DUES SOERA AEEA EAEN EEANN AE EE EAE EEEE EENS 246 ELEITOR Ti o EEE ER E E T E T 247 8 1 3 Defining Roles Using Metastorm Data Extraction Utilities 000000000000000000000000000000 248 8 1 4 Adding Roles to the Roles List c ceccccecssssssssssssesssssseseeescsesesceseseeeseseseeecseaeaeeaeseeeeeeaeneeaes 248 8 1 5 Deleting Roles from the Roles List c cccccsssssssscssssesssessesesesseseseeeceeaeeeseseneeeaeeeeeeeneneeaes 250 SRO Eding ROLES sc cvcselcsctsdeh whet ele can lohan busses tet anc O deb nen Caudle ec dae saute tia vasa casas Chad basteds 250 8 1 7 Defining Dynamic Role FOrMUlds c cccccccssssesssessesesessesesecscscnesecececaenseaeseeeeeseneeaeaeeeneeaes 251 Using operators within dynamic role formulas 0 00 0 ssecsesssesesseceeessesececsceeeecseseeucnccucaceeesseesenees 251 Example One x2 e ed auset sas adese ve atedssepusete ce attean besttedy copes E a a i a 252 Example Twos sscesssidecyesssscssscesistussassesyebtststyessecsenioesepebssssesvsestids
215. completion of Any one submap is adequate to initiate the rendezvous action OR e That the folder must reach an archive stage in All the selected submaps before the rendezvous action is initiated a Although the rendezvous action in the parent map will not be initiated until the submaps criteria is satisfied other actions in the parent map can act on the folder including moving it from the sub procedure stage 102 May 2008 Metastorm Inc 2008 Designer User Manual 4 CUSTOM AND SYSTEM VARIABLES A variable is a container of information When defined in the Metastorm database a variable can be called upon when you customize your Metastorm processes There are two types of variables custom and system Custom variables are user defined and are the fields of the custom variable table created in the database when a procedure is published One custom variable table is created for each map in the procedure The table has the same name as the map with any spaces replaced by underscores Any limitations that apply to the database platform on which the Metastorm database is running apply to custom variable tables This includes constraints such as field name length i e custom variable name length number of fields per table and therefore the number of custom variables per map and data format When procedures are published memo and text field content are stored as Unicode and the format of the Unicode is defined by the database Som
216. condition condition Returns TRUE if either condition is TRUE Table 46 Logical Operators For example myCheck Priority gt 4 TRUE if priority less than 3 myCheck YmyCheck amp Priority lt gt 0 but not if zero Arithmetic Operators These may be used to construct complex arithmetic formulas Arithmetic formulas are evaluated in the order listed in the following table with the most tightly binding shown first Operator Name Operator Type Function number number Changes a positive number to a negative and vice versa number number number Returns the result product of multiplying the two numbers number number number Returns the result quotient of dividing the first number by the second number number number Returns the result sum of adding the two numbers humber2 mber numb r Returns the result difference of subtracting the second number from the first Table 47 Arithmetic Operators 406 May 2008 Metastorm Inc 2008 Designer User Manual For example myNumber integer myNumber 10 0 5 divide by 10 and round up myNumber Abs Y myNumber force negative value A The arithmetic operators are also supported for Currencies Adding subtracting multiplying or dividing two Currency values results in a Currency Adding subtracting or dividing a Currency and a Number results in a Real number Multiplying a Currency and a
217. contract employee is a member of the generic group Contractors as well as a member of a particular team Work through your list to determine what group role definitions are most commonly used within your organization and add these to your list Finally consider your company s unwritten organization Is Susan from Customer Service on indefinite loan to the Sales Department Does John from Production happen to have a cousin in the retail industry and therefore act as the unofficial Purchasing Agent for your regional office Is your Office Manager also cross training as a Technical Writer Does your company have job sharing policies in effect that should be considered As you evaluate these unwritten roles you will continue to refine your list Keep in mind that the list you develop may not reflect all possible roles in your company However you may define new roles as you design procedures that require them A Assigning users to Static roles is done through the Users and Roles tool Instructions for using this utility may be found in the Metastorm Administration Guide 8 1 2 User Attributes and Relationships Dynamic roles are assigned through a procedure by using Metastorm functions to identify a set of attributes that the holders of the role must have These attributes are often more easily specified by the relationship certain attribute sets have with each other Attributes Attributes allow administrators to categorize users base
218. create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Check Field This field is displayed as a check box Use a check field to display a check value TRUE when checked or FALSE when unchecked To add a check box click on the Check button on the Form toolbar and then click on the location on the form where you want the field to be displayed Designer places a check box on the form and displays the corresponding Properties editor The Properties editor displays four tabs for defining check field properties Check Do this Extra Notes amp For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Metastorm BPM Release 7 6 May 2008 155 Metastorm BPM Release 7 6 Properties Check1 folder Variable calculated Figure 100 Check Tab Defining a Check Field s Check Properties 1 You can include a text string that will display a brief help message to the user when the cursor hovers over the check box in the client Type the message you want displayed in the Hint field Identify the variable you wish this field to use in the Variable field If the check box is to be calculated at run time select calculated from the list You will be able to specify how it
219. cript NET this is a string identifying the name of a valid entry point in the map or procedure assembly that has been compiled arg JScript NET only any number of additional arguments to be packaged up and passed into the entry point s args argument Returns command If the specified language is VBScript or JScript this loads the specified language followed by any script in file from the server file system any specified procedure and or map scripts from the Metastorm database and then executes the specified Statement 400 May 2008 Metastorm Inc 2008 For example Designer User Manual If the specified language is JScript NET the return value is True if the call is successful Else the return value is False The evaluation suite returns control to the engine once the statement has been executed Script VBScript MapName myFunc Priority Script VBScript MapName myFunc2 a string Subject If you are using BizTalk s Send a Document Integration Wizard item Script VBScript Procedure Name MapName SendDocument PartnerName FormToSend ScriptAsync language file procedure map statement args Arguments language file procedure map Statement a string identifying the scripting language processor to be loaded VBScript JScript and JScript NET are supported by the Designer if the specified language is VBScript or JScript this is
220. ct on performance It should not be used in the following properties e Map Subject since on creation there can be no earlier messages e Field Variable since the variable is read only Notes event_number string read only value of Action Notes saved for the specified event_number for this folder The folder s creation is event number 0 This is evaluated via a database lookup and thus may have an effect on performance It should not be used in the following properties e Map Subject since on creation there can be no earlier notes e Field Variable since the variable is read only Originator string read only registered user who created this folder This will be empty for a folder created by means of a flagged action This variable should not be used in the following property e Field Variable since the variable is read only Parent string writeable internal identifier of the folder s parent This is preset automatically for folders created by means of a subprocedure and for folders cloned from another folder but may be changed during an action This variable is available in all properties Priority number writeable current priority from zero to nine of the folder This variable is available in all properties ServerName string read only When a folder is created a new row is inserted into eFolder The value used for the eServerName column is the cached server name and this is the folder value ref
221. cted was VBScript and the Script call systime will be made to the script System_Time which was previously added to the Scripts dialog 9 The Script File field contains the name of the original file containing global scripts This file must be accessible from the server A This step is optional and will rarely be used You enter data into this field only if you don t produce the script in the Metastorm Script Editor but store it on the server as a separate file You can fill in the Script File field in two ways Type in the name of the original file containing global scripts This file must be accessible from the server Click on the Browse button located just above the Script File field It opens a File Open dialog which if used will fill in both the Script File field and Path field values 10 In the Path field type in the path to the specified file on the server Note that this step too is optional and that you enter data into this field only if you don t produce the script in the Metastorm Script Editor but store it on the server as a separate file 11 If you are using JScript NET an Arguments field is also available Use this to enter any number of required additional arguments 294 May 2008 Metastorm Inc 2008 Designer User Manual amp Y For further details refer to the Scripting Developer Guide 12 Click Finish When the procedure is run the script will be called In this example whe
222. ction or form These information are the ones you use most often in an action s When action completed properties and in form and field properties text text Allows you to type in a literal text string You can use this item to enter literal text when the Integration wizard expects a particular type of formula or to by pass the Integration wizard s type checking which is what makes items disappear or appear grayed if Hide invalid is unchecked by converting a non text variable to its text representation Note By using literal text you force Metastorm BPM to ignore the formula type checking and it is possible to enter an incompatible formula type For example you can put a memo variable into a text field however the memo variable may be truncated at run time Action name text This returns the name of the current action A value will only be available if an action has been invoked You can use it when you want to display the current action name in a text field on a form or to include the current action name in an alert message Assign value You use this option to assign a new value to a variable Rule builder check You use this option to open the Condition Builder to compare two values Metastorm BPM Release 7 6 May 2008 305 Metastorm BPM Release 7 6 SERVER CATEGORY ACTION RESULT TYPE DESCRIPTION Conditional operation You use this option to
223. ctions Users and roles g Business rules Vv E3 Distinguished name M Emaillist EGS Folder originator ES Get email address E List published roles A List registered users E List selected users HB To Do list ser attribute EB User name E08 User s manager H User s staff E Watch list Finish Figure 196 Integration wizard Users and Roles category 276 May 2008 Metastorm Inc 2008 Designer User Manual 5 From the Users and Roles category choose the Search Directory item Click on the Next button The attributes to be returned dialog is displayed Integration Wizard Assign value lt Value gt The attribute name to be returned Alias Directory Filter Expression objectClass inetOrgPerson Attribute Name cri Delimiter CHR 44 SCHR 44 lt Back Il Next gt I Finish ia Cancel I Help Figure 197 Search Directory parameters 6 Enter the following parameters Alias Enter the name of the LDAP alias that is mapped to the required directory Filter Expression Enter a filter expression to limit the results that are returned The following are examples of valid filter expressions objectClass inetOrgPerson returns all results where the object class is the inetOrgPerson amp objectClass User OU development returns all results where the object class is User and the OU is development objectCla
224. ctively With any other value the conversion will fail e list to string the entire contents of the list including all comma separators are treated as a single string e list to date time proceeds via list to string and then string to date time e list to number proceeds via list to string and then string to number e list to condition proceeds via list to string and then string to condition e number to string the minimal decimal representation of the number with decimal places if required This conversion is locale independent it will always use a period as the decimal separator if required and will never use any thousands separator To specify a different string representation of a number use the FormatNumber function e number to list proceeds via number to string and then string to list e number to condition zero for FALSE any other value TRUE e date time to string uses the short date and time format from the server s locale settings To specify a different string representation of a date time use the Format Time function e date time to number proceeds via date time to string and then string to number e condition to string True or False e condition to list proceeds via condition to string and then string to list e condition to number zero for FALSE 1 for TRUE Attempts to perform the following conversions will always fail e number to date time e date time to condition e condition to date time
225. d an arrow will appear at the end of the visible portion of the toolbar Clicking on the arrow will display the remainder of the toolbar Toolbars can be customized by selecting View Customize or right clicking anywhere on the Menu toolbar area The Customize toolbars dialog is displayed Customize e Toolbars Commands Options Toolbars Aron ven F General F Map I Form Figure 12 Customize Toolbars dialog 34 May 2008 Metastorm Inc 2008 General Toolbar Designer User Manual The General toolbar contains buttons generic to the whole application You can use them to perform operations on the selected procedure component The General toolbar contains the buttons shown in Table 8 below Button Function Properties Displays or hides the Properties editor window Procedure Explorer Displays or hides the Procedure Explorer Starts a new procedure or library a New A m Opens an existing procedure Also provides a list of the most recently opened procedures Open Save Procedure Saves the current procedure Saves and publishes the current procedure to the database 2 Publish me Retrieves files from the database and opens them in Designer The process designer lt may choose the version of the procedure that they wish to retrieve Retrieve Displays or hides the Validation window Validation checks a procedure and presents warnings and errors on t
226. d on the Do this tab Select the type of button action desired 2 You can include a text string to give users a brief help message when the cursor rests on the button Type the message you want displayed in the Hint field 3 Enter the caption to be displayed on the button in the Caption field If you choose not to name the button it will be displayed with a default caption of Button plus an auto incremented number 4 The Default Action Usage field allows you to specify a default such as read only optional hidden or required for the Command button Use the down arrow associated with this field to select the desired default Metastorm BPM Release 7 6 May 2008 153 Metastorm BPM Release 7 6 Defining a Command Button s Do This Properties Properties Button1 Properties Button1 Client extensions Figure 99 Command Button Do this Tab The items displayed on the Do this tab of the Properties editor vary depending upon the type of button action selected on the Button tab The following table lists the possible Do This tab properties Button Action Do this Tab Properties Client operation Client extensions When button pressed Client extensions Server operation Commit action Client extensions Cancel action Client extensions New folder New folder action New folder map Client extensions Open folder Open folder Client extensions Tab
227. d though it may still be saved to a file a string identifying the server directory path name and extension to which the output should be saved If empty then the output will not be saved though it may still be printed uses Microsoft Word to perform a mail merge using the specified document and data from the folderID in the Metastorm database and sends the output to either a printer or a filename in the server file system You may specify the following combinations of printer or filename e neither prints to default printer e printer prints to nominated printer e filename prints to nominated file e both printer and filename prints to both nominated printer and file Microsoft Word must be installed on the same system as the Process Engine evaluating this function The function executes asynchronously the evaluation suite returns control to the Engine as soon as the request has been queued not after it has been serviced Print myDoc Domainl VOL1 APPS Support Printers HP4050 Print C My Documents letter1 doc FolderID C Merge doc A Data to be merged with a Word document must not contain non standard ASCII characters The Replace function can be used to ensure that non standard ASCII characters such as ASCII 147 and ASCII 148 are not included in merge data Metastorm BPM Release 7 6 May 2008 395 Metastorm BPM Release 7 6 RaiseFlag flag folderID lt flag_
228. d characters may represent line breaks Metastorm BPM Release 7 6 May 2008 373 Metastorm BPM Release 7 6 In general all TP requests and responses passing through the Process Engine are normalized However there are some exceptions The following list summarizes normalization of the TP XML in the Engine Any data that comes in as a TP request is normalized as it enters the Engine Any data that is returned from the Engine in a TP response is normalized before it leaves the Engine Assignments to custom variables are not normalized for the duration of the request in which the assignment was made Any processing carried out by the Engine will take place on the current values However a field that displays a custom variable will in effect normalize that custom variable value when it is passed back in the next TP request For example if When Stage Started sets a custom variable to NewLine the value stored for this custom variable in the database is CRLF This remains the case until a form containing a memo field displaying this custom variable is displayed to the user As the custom variable has been sent to the Client via the TP in XML format its value has been normalized and the value displayed on the form is LF When the form is submitted the value sent back to the Engine for this custom variable is LF The value stored in the database is now LF Process designers should be aware of this normalizat
229. d in two ways CURRENT_USER The current users I E settings are used to determine the proxy host port The proxy at host port is used e g http 93 13 17 2 8080 ProxyUser string Summary Sets the username used when accessing the proxy server 416 May 2008 Metastorm Inc 2008 Designer User Manual Remarks ProxyPassword string Summary Sets the password used when accessing the proxy server Remarks BypassProxyOnLocal boolean Summary Determines whether the proxy server is bypassed when calling local resources Remarks If BypassProxyOnLocal is true requests to local Internet resources do not use the proxy server Local requests 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 When BypassProxyOnLocal is false all Internet requests are made through the proxy server Advanced Properties AllowAutoRedirect boolean Summary Determines whether the client will automatically follow server sided redirects Remarks If a client sends authentication information such as a user name and password you do not want to enable the server to redirect because this can compromise security KeepAlive boolean Summary Sets the Connection KeepAlive header in the HTTP requests Remarks If the KeepAlive property is set to true the Connection KeepAlive header will be set This means SOAP cal
230. d in when the assembly is compiled This can be left blank to indicate no map script expression if the specified language is VBScript or JScript this is a string containing an expression in the specified language to be evaluated This will typically be a call to a function within one or other of the scripts loaded from the specified file procedure and or map If any arguments need to be quoted as string arguments do for VBScript then each quotation mark must be preceded by a character to prevent Metastorm BPM stealing it before it is passed to the script function If the specified language is JScript NET this a string indicating the name of a valid entry point in the map or procedure assembly that has been compiled arg JScript NET only any number of additional arguments to be packaged up and passed into the entry point s args argument Returns string if the specified language is VBScript or JScript this returns the result of the evaluation The function loads the specified scripting language followed by any script in file from the server file system any specified procedure and or map scripts 384 May 2008 Metastorm Inc 2008 Designer User Manual from the Metastorm database and then evaluates the specified expression If the specified language is JScript NET this is the value returned by the invoked entry point If the entry point returns nothing this will return True The evaluation suite r
231. d is evaluated and opened automatically If the user cancels at any stage the folder is left on their To Do list for subsequent completion 342 May 2008 Metastorm Inc 2008 Designer User Manual BRI This procedure illustrates the use of Metastorm BPM with a business rule engine User is prompted for details which affect a life insurance premium Administrator Rule Execution Failed Resubmit Request quote High risk Decline gt Biesy Risk Evaluation Follow Up Desk Declined determines high medium or low risk Risk is low or medium Approve Offer Premium i Make offer Withdraw offer withdrawn r Send reminder Aiak Payment Received payment e Paid Figure 244 BRI Procedure Policy Quote Map Premium Paid Paid Figure 245 BRI Procedure Premium Payment Map Metastorm BPM Release 7 6 May 2008 343 Metastorm BPM Release 7 6 Preparation In addition to the Sample Library this procedure requires you to publish the BRI library In order for the procedure to work access is required to e a business rules engine e a Rule Engine Adapter web service such as the BizTalk Rule Engine Adapter provided with Metastorm BPM A set of rules must have been defined using the rule designer for the business rules engine you are using Points to Note A key feature of this procedure is the use of a Rules stage which allows users to execute a rule To use the procedure 1
232. d on one or more categories that help to define that user For example attributes might consist of Department Title Extension Fax Number etc 246 May 2008 Metastorm Inc 2008 Designer User Manual Each attribute can be assigned one or more corresponding values that further define the attribute For example the Department attribute values might be Marketing Sales Development and Personnel as illustrated in the following table User Attribute Value Kim Department Marketing John Department Sales Michael Department Development Susan Department Personnel Table 29 Metastorm Attributes Table Multi level attributes can be assigned to one person for example Kim can be the Director of Sales and the Manager of Marketing Relationships Relationships can be defined through the Metastorm Users and Roles tool and the Metastorm Directory Integration Suite tools Relationships are composed of groupings of attributes and in a sense tie attributes together For example a company administrator may set up an attribute called Title and an attribute called Department These attributes will be used to differentiate employees by title and department For each attribute one or more values may be assigned The following table shows possible values for the Title and Department attributes Title Department Director Marketing Manager Sales Team Lead Public Relations
233. d set up of component bar styles File Location Defines procedure library and add in file locations and External forms Defines the properties of forms to be imported Table 4 View Menu Options The Component Menu You can access this menu using the shortcut lt Alt gt lt C gt Access keys for individual Component menu options are given in Table 5 below Option Access key Function New lt Alt gt lt C gt lt M gt Adds a new map map segment form form segment or administration form to the procedure Add lt Alt gt lt C gt lt A gt Displays the standard File Open dialog allowing you to specify an existing map form map segment or form segment file you wish to add Remove lt Alt gt lt C gt lt V gt Removes the selected component from the procedure You cannot remove the last remaining map from a procedure Save As lt Alt gt lt C gt lt S gt Copies the selected component and saves it under the new filename you select Save as Picture lt Alt gt lt C gt lt P gt Saves the image of the selected item to a BMP or JPG file Print Component lt Alt gt lt C gt lt R gt Displays the standard Print dialog allowing you to print the selected procedure component The Help Menu Table 5 Component Menu Options You can access the Help menu using the shortcut lt Alt gt lt H gt Access keys for individual Help menu options are given in Table 6 below
234. d to the script host when the assembly is compiled These files will be looked at when the script is compiled The script is compiled the first time it is used on Engine start up and for every new version published thereafter procedure if the specified language is VBScript or JScript this is a string identifying a procedure holding a script attachment to be loaded If empty no procedure script will be loaded If the specified language is JScript NET this is the name of the procedure script to be pulled in when compiling the assembly This can be blank to indicate no procedure script map if the specified language is VBScript or JScript this is a string identifying a map holding a script attachment to be loaded If empty no map script will be loaded If the specified language is JScript NET this is the name of the map script to be pulled in when compiling the assembly This can be left blank to indicate no map script statement if the specified language is VBScript or JScript this is a string containing a statement in the specified language to be executed This will typically be a call to a function within one or other of the scripts loaded from the specified file procedure and or map If any arguments need to be quoted as string arguments do for VBScript then each quotation mark must be preceded by a character to prevent Metastorm stealing it before it is passed to the script function If the specified language is JS
235. data gt Arguments flag a string identifying the flag to be raised This should match a flag defined in one or more published procedures folderID a string identifying the folder which should respond to this incidence of the flag If empty all folders waiting on the flag will be affected flag_data any number of strings comprising the individual data items tab delimited to be made available to each resultant action by way of the Session FlagData array variable Returns command uses Metastorm BPM to raise the specified flag for any specified folderID and with any specified flag_data Any resultant actions execute asynchronously the evaluation suite returns control to the engine as soon as the flag has been raised not after any actions have been invoked or committed For example RaiseFlag myFlag FolderID RaiseFlag myFlag FolderName Subject RegisterlnQueue symbolicName system eworkHost queueSource credentials process clientType map stage action params This function registers a new incoming queue definition in the Metastorm Engine Additionally the MQ Integration sub components are informed of the new queue definition Arguments symbolicName a string containing the name used to define this in queue system a string specifying the messaging system used by the queue WebSphere MQ or MSMQ eworkHost a string containing the parameters required to call the Metastorm Listener web service acting on
236. de up of several HTML commands JAWS does not know how to announce these Metastorm BPM specific fields Make use of field captions and labels to help the user complete these fields Metastorm BPM specific fields include e Clips A The buttons on multiple attachment fields that allow you to add open and delete attachments are JAWS links To activate one of these links Press the Insert and F7 keys together to show the links list 7 Scroll to the required link using the arrow keys Metastorm BPM Release 7 6 May 2008 411 Metastorm BPM Release 7 6 n Press the Enter key In order to read through the list of attachments navigate to the field and press T on the keyboard Use the arrow keys to move between the cells of the table e Currencies e Date times e Grids e Rules e Numbers e Signatures e Status Unsupported fields Attachment clips that only allow a single attachment are not supported when using Metastorm BPM with JAWS However attachment clips that allow multiple attachments are supported Invalid Characters If the user attempts to enter a letter into a Number or Currency field JAWS reads out the letter but Metastorm BPM does not display the letter in the field The user must tab out and back into the field to find out which characters have been successfully entered It may be helpful to include a Label next to the field which suggests that the user checks the contents of the field before submittin
237. dependants or as a result of a button being pressed click on the Field is dependent on another check box ra If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab Metastorm BPM Release 7 6 May 2008 197 Metastorm BPM Release 7 6 2 The Calculation formula field allows you to specify how the contents of the signature field are calculated This field is visible only if you selected calculated as the field s variable You may create or edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 3 Ifacustom variable has been assigned to the signature field the Do this tab will display a When changed option instead of a calculation formula In the When changed field enter any command the system is to perform when the contents of this signature field are changed For the commands in the When changed field to be performed when the field is updated the Field has dependants of its own checkbox must be checked 4 If you selected a system variable or created a new custom variable for this signature field the Field has dependants of its own check box will be displayed on this tab of the Properties editor This field instructs the system to notify immediately the Process Engine of any change to this signatu
238. dialog a If the form is being used as part of an action the When user loads form command will be performed after the When action started command A You should not use the When user loads form property to set field defaults for a blank form This should be done using the When action starts property 230 May 2008 Metastorm Inc 2008 Designer User Manual 2 Inthe When user saves form field enter any commands the system should perform when a user commits saves an action that uses this form whether as a tab in a folder or as an action form You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog A If the form is being used as part of an action commands will be performed in the following order 1 When action started 2 When user loads form 3 When user saves form 4 When action completed If the commands fail the form will not be closed and the action will not be saved The user may choose to change the data and try again or cancel the action 3 Inthe Client extensions field enter any commands the system must perform when the form is loaded whether as a tab in a folder or as an action form submitted or cancelled You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard C
239. ditor for the Name field When a value for the parent folder is displayed through a calculated field using this method the value is not stored in the child folder but is refreshed each time from the parent folder This has the advantage of not duplicating the data storage After the folder has been released from the sub procedure stage by the Rendezvous action it is held at the Wait for First Day stage until it is released by the timed action First Day This releases the folder to the HR assistant stage one day before the folder deadline which must be set to the start date in the form that is completed when the folder is created 334 May 2008 Metastorm Inc 2008 Designer User Manual One Call This procedure is for a call center that provides a one stop service for their customers calls A designated member of each team takes incoming calls and closes calls whenever possible If they cannot close the call immediately they take details and place the call on a team queue Team members pick up calls in the queue and process them If they are unable to close the call before they go off shift they release the call back to the team queue 5 t Call taken o open Marketing To Marketi o Marketing K Archive p Check if closed Send A team pi To Admininstration Administration a up ae team vis Specialists E d hinar 3 Call closed Pi ka Accounts TO Accounts Sa To A Team o
240. dvanced in a number of respects The procedure uses two maps Training Course and Student Enrolment A single procedure would use multiple maps when distinct types of data are being collected Training Course The Training Course map allows the Training Administrator to set up a new class starting on a particular date for example an Economics class starting on 1 September This map would create a new folder for each subject date combination Each folder would contain four specific pieces of information the subject the date the class starts the maximum number of students that may be enrolled in the class the actual number of students that have been enrolled in the class The form could be extended to include details about the location the time and the teacher Student Enrolment The Student Enrolment map handles the enrolment of students into the classes This map creates a new folder for each student that attempts to register for a class If a student attempted to register for two classes there would be two folders for that student These folders would store three items of information the name of the student the class they wish to enroll in the date the desired class begins Folders are created and stored for all students attempting to enroll in a class whether they are successful or not The second advanced feature in this procedure is the use of flags to signal actions between the two maps When a student attem
241. e Properties Edot oio res ara Va a stadia nan ag aed ee aE 1 4 Saving Publishing and Retrieving Procedures sssssssssssssssssessssessssssesecsssecsssssesecssseseses 1 4 1 1 4 2 1 4 3 144 1 4 5 File LOCATIONS ikeneen troteto RE eE E EERE nE EEEE EEE tens EEN EA EEE Et File TN DOS pin TERE TE EEEE ENO A RERE EE WAVING a ProcedUur E nreninurrennn n n n Exporting a Procedure OF MAP u s ssssssssssscsssseseseeseseseueesesesecscsesseceseseeeaeaeeaeseseeseaeneeaeaeeees Openin a PrO E core iisa iE wk ETEN IES cbc A ESERE ENE AREA Metastorm BPM Release 7 6 May 2008 iii Metastorm BPM Release 7 6 14 6 Importing a Procedure OF MAp u s esssssscssssssesesevscsesesseseseecscsensceseseescaeseeceseeeseaeaseaeaeeeeeenes 46 LAZ Validating A ProCeCuye aariin A AAE E A AAA ARNE EREA 46 TAS PUDUSHINGG Procedi Emene irena a a aa a a ain 46 Data Formas iscsi rretra o T E actin went einen RA AA 48 1 4 9 Retrieving a Published Procedure or Library sssssesssssesssesssesssssersrsesessssserssess 48 2 LIBRARIES aa aeaa aa aa aa a o aa AN Ena vn deeds ae 50 DQ Usma a UDO Y ara o aa r E T AT N A T O alti eecs 54 2 2 2 Accessing a library s forms form segments map segments and Scripts n s 56 2 2 3 Inheritance of Roles from Libraries Nested Map Segments oror iirinn r i ete Sr EAE ETENEE ETEEN Recursive Map Segments Duplicate Na MeS ierre T ATR EREE NET EE O E NEUE VAAD ES rarr EEEE ORE EEEE ORUTO TE O EA OE
242. e 13 Click the Mapper button Gad to map the complex type returned by the invoked method to custom variables 14 Map the complex type simple data type member to a Metastorm custom variable Map Complex Type lene Zee Complex type Member type Variable Returned Format B ClientData class D memGetClientRecord XML CompanyName property ES txtCompanyName ContactFirstName property EB txtFirstName ContactLastName property EJ txtLastName Address1 property EGS txtAddress1 Address2 property Area property EES Originator PostCodeOrzip property EB Parent City property EJ ServerName Phone property EJ StageName eMail property EJ Subject Country property EJ txtAddress1 ID property abe txtAddress2 v Figure 73 Mapping Complex Types Metastorm BPM Release 7 6 May 2008 113 Metastorm BPM Release 7 6 A In order for the complex type to return XML or SOAP serialization select a memo custom variable click the return value button and assign XML or SOAP serialization The default return serialization is Binary Refer to section 5 2 4 Serialization for more information 15 Click OK Integration Wizard Assign value lt Value gt Number integer Return Value Click on Mapper button to map complex type to variable s i BL ClientData ClientCasesService Version 0 0 0 0 Culture neutral Number integer intInputID Figure 74 Input Field custom variable 16 Assign an input field 17
243. e Call Details form 336 May 2008 Metastorm Inc 2008 Designer User Manual Purchase Order This procedure demonstrates the use of an editable grid to implement a typical master and multiple detail line form ejected Withdraw A Withdrawn Purchase Order Check Authorization Level Reject Manager Manager Y A Reject Authorize 4 Paid ee x r YP ig Payment Due Figure 240 Purchase Order Sample Procedure Preparation Once published this procedure requires a management hierarchy to be set up and populated This may be done using either the Set Up Sample Procedure or the Users and Roles tool The procedure also requires a set of Purchase Order Item Codes to be set up This may be done using the Set Up Sample Procedure or the Purchase Order Admin form provided as part of the procedure Points to Note As well as the Purchase Order map itself this procedure provides a Purchase Order Admin administration form used to maintain the Purchase Order Item Code table The procedure makes use of two external tables set up automatically when you publish the procedure e Purchase Order Item stores individual item lines for each Purchase Order e Purchase Order Item Code stores the available item codes and associated descriptions and unit prices The grid used to enter purchase order item lines makes extensive use of client scripting for validation and the calculation of line and p
244. e date time writeable date and time used to control timed actions that are based on the folder s deadline This variable is available in all properties EntryTime date time read only date and time at which the selected folder entered or re entered its current stage This is not reset on a loopback action This variable should not be used in the following properties e Map Subject since during creation the folder is not at any stage e Field Variable since the variable is read only FolderlID string read only unique system generated folder identifier This variable should not be used in the following property e Field Variable since the variable is read only FolderName string writeable user readable folder name which may or may not be unique This variable is preset when the folder is created from the map s Folder prefix and Length of numeric suffix properties but may be changed during an action This variable is available in all properties MapName string read only name of the map responsible for the folder This variable should not be used in the following property e Field Variable since the variable is read only Message event_number string read only alert message generated for the specified event_number for this folder The folder s creation is event number 0 362 May 2008 Metastorm Inc 2008 Designer User Manual This is evaluated via a database lookup and thus may have an effe
245. e You use this option to specify that Metastorm BPM is to return started the date and time that this folder entered its current stage Directory Lists all functions used with directory integration integration Search text You use this option to access data from a LDAP compliant Directory directory Microsoft Lists all functions used for emailing Exchange adaptor Send email You use this option to specify that Metastorm BPM is to construct and send an email message You may specify email addresses or the names of any intended recipients Note To use this option the name of the recipient s must exist in the address book for the mail system in use If you want the names to be created dynamically you can click on the Integration wizard button or type a formula in the field You can also use the Formula editor to create a formula You can specify that the message be created dynamically by clicking on the Integration wizard button or type a formula in the field You can also use the Formula editor to create a formula You can also specify the address where reply messages will be sent if the mail system in use supports return addresses E mail list memo Return an email address list corresponding to a list of Metastorm users Metastorm BPM Release 7 6 May 2008 309 Metastorm BPM Release 7 6 SERVER ACTION RESULT DESCRIPTION CATEGORY oe Get emai
246. e event text 250 The alert message generated for the specified event number for this folder The number folder s creation is event number zero This variable is always read only Notes event Memo The value of Action Notes stored for the specified event number for this folder number The folder s creation is event number zero This variable is always read only Originator text 31 The registered Metastorm user who created this folder This will be empty for a folder created by means of a flagged action This variable is always read only Parent text 31 The Folder ID of the folder s parent This is preset automatically for folders created by means of a subprocedure and for folders cloned from another folder but may be changed during an action Priority Number The current priority from one to nine of the folder ServerName text 31 The Engine server which currently holds the master copy of the folder This variable is always read only StageName text 31 The folder s current stage This will be empty during a creation action and will identify the source stage of any other action This variable is always read only Subject text 250 The subject for this folder This variable is preset from the map s Subject property when the folder is created but may be changed during an action Updated date time The date and time at which the folder s last action was committed This will be unspecified during
247. e 7 6 Defining a Status Field s Do this Properties Properties Status1 Properties Status1 _ Field is dependent on another Client extensions Figure 138 Status Do this Tab Use the Do this tab to specify dependencies and processing to be carried out if the contents of the status field change 1 If the status field may be updated as a result of a change to another data field or grid that has dependants or as a result of a button being pressed check the Field is dependent on another check box A If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab 2 Enter any commands to be performed by the system when the status field is entered or exited in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Text Field Use a text field to display or edit a text value or to display a URL in a web browser To add a text field click on the Text button on the form toolbar and then click on the location on the form where you want the field to be displayed Designer places a text field on the form and displays the corresponding Properties editor The Properties editor displays five tabs for defining text field properties
248. e Field has dependants of its own checkbox must be checked 4 Enter any commands to be performed by the system when the number field is entered or exited in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 190 May 2008 Metastorm Inc 2008 5 Designer User Manual If you selected a system variable or created a new custom variable for this number field the Field has dependants of its own check box will be displayed on this tab of the Properties editor This field instructs the system to notify immediately the Metastorm Engine of any change to this number field This is necessary if any other fields on the form are dependent upon the content of the number field Defining a Radio Group Field Radio group values must be pre defined as a list They cannot be determined by the Engine when the form is loaded A If you need the contents of the list to vary dynamically you should use a drop down field If you need to be able to select multiple entries you should use a list field To add a radio group click on the Radio group button on the form toolbar and then click on the location on the form where you want the field to be displayed Designer places a radio group on the form and displays the corresponding Properties editor The Prope
249. e Propertices cecceesceeceesceeeceeeceseceseeeeceseceaeenseeneeeneeens 144 Defining an Image s Do This Properties cc ecesesecssecseesecneeeeceseeeesaecaseseeaeeateseeners 145 Definmga Lapel eee accesses a aeaa eds teenies Poea ea eee TEE NOE EEO RESE a S Eana 145 Defining a Label s Label Properties 2 0 0 0 ccesssesscseeeeceseeecesecaeesecneeeceaeeeeeaecateseenees 146 Defining a Label s Do This Properties cceccssceeseeseeesceesceeeceeeceeeceseceaeenseenseeneeeas 147 Using a Label field to add a link to the form 0 eee ee eeeeeecneeeeeseceeeeceeeeeceaeeaeeseenees 147 Using a Label field to add HTML elements to the form eee eeeeseeeeeeeeeereeeeenees 148 Defining an Attachment Cp vedteken eeaeee aaao e a R E N eame e E E aaRS 149 Defining an Attachment Clip s Do This Properties ssesseseeeeeeeeseerereersrsrrreerereersesreee 151 Defining a Command Button niisiis ieissa ireira niei ieaiaia insk 152 Defining a Command Button s Button Properties ssesseesesseeeseeeeeereerrsrsrrrrerereersesreee 153 Defining a Command Button s Do This Properties sseesesesseeereeeeeeesrsrsrrreerereerreerees 154 Defining a Check Fieldin nana aiiai iiai Defining a Check Field s Check Properties s ssessesesseeersresesesreeereressrsrrreerereerseseeee Defining a Check Field s Do This Properties Definmg a Currency Field lt 3 0sssscsisihedissere dis ats iissen aa a a sirai Defining a Currency Field s Curr
250. e drop down list You can create a new text or integer custom variable by clicking on the New custom variable button and specifying the details of the variable The size of the custom variable must be at least as long as the length of the largest caption that the radio group will display You cannot create a new custom variable if you are using a dataset for this radio group field If you are using a dataset select the column name the system should use to calculate the information for this field from the column names shown in the drop down list The variable you select on this tab of the Properties editor will determine the fields that appear on the radio group s Do this tab If you are using a variable other than calculated Designer uses the variable name as the default caption for the radio group a If the radio group selected has a value longer than the size of the variable the radio group is associated with the value will be truncated when it is stored in the database When the radio group is next displayed there will be no match to any button and it will appear that no button has been selected 3 If you wish to change the caption enter the new caption in the Caption field If you omit this or have selected calculated as your variable the radio group will be displayed with a default caption of Radio group plus an auto incremented number Radio group captions are always placed at the top of the radio group field
251. e dropdown The Element to find dropdown is populated with the elements listed above 3 Select or type an element in the Element to find dropdown 4 Click on the ellipse in the top right of the Find and Replace dialog Find and Replace icons are displayed Element ta find Sa g 4dd or Remove Buttons Figure 7 Find and Replace icons 5 Click on the Find button A tree representation of the relevant parts of the procedure is displayed in the Occurrences found box This tree works in the same way as the Procedure Explorer Double click on an item to display it in the Designer s main pane amp Y For a description of the Procedure Explorer refer to Section 1 3 4 26 May 2008 Metastorm Inc 2008 Designer User Manual 6 To replace all occurrences of an element select the element type and element name as described earlier in this subsection 7 Click on the Replace button A Rename dialog appears Rename Custom variable Rename To Figure 8 Rename dialog 8 Enter the new element name and click on the OK button The name of the element is replaced 1 3 The Designer Interface When you first start Metastorm Process Designer a main window similar to the following is displayed Title Bar Menu Bar General Toolbar Map Form Toolbar Procedure Explorer Main Pane Properties Editor Status Bar __ Figure 9 Metastorm Designer Main
252. e email address of a specified user address List published List You use this option to specify that Metastorm BPM is to return roles the list of all roles published on the Metastorm server List registered List You use this option to specify that Metastorm BPM is to return users a comma separated list of all users logon Ids registered to use Metastorm BPM List selected list You use this option to specify that Metastorm BPM is to return users a list of users with one or more specified attributes in common The attributes will be taken from the Metastorm attributes table They can actually be taken from any attributes table that you specify in the next dialog To do list list You use this option to specify that Metastorm BPM is to return the list of users who have the specified folder on their To Do lists Search text You use this option to access data from a LDAP compliant Directory directory User text You use this option to find the value of a user attribute attribute User name text You use this option to specify that Metastorm BPM is to return the name or logon ID of the active user You might use this to define an alert message or to populate a text field with the name of the current user User s text You use this option to specify that Metastorm BPM is to return manager the manager who has a specified role of the user you specify User s staff list You use this option to specify that Metastorm BPM is to
253. e field You can also use the Formula editor to create a formula You can also specify the address where reply messages will be sent if the mail system in use supports return addresses Write file You use this option to specify that Metastorm BPM is to write text to a file on the server The text can be the contents of Metastorm variables or the results of a formula This can be either a new file or you can append to an existing file Custom Lists all custom variables defined for the currently selected variables map Empty if no map is selected Dates and Lists all non custom date time variables and functions that times return or manipulate a date or time Calculate date Date time You use this option to specify that Metastorm BPM is to time calculate a new date time a number of units before or after another date time Calculate Real You use this option to specify that Metastorm BPM is to duration number calculate the interval between two date times in the specified units Convert to Date time You use this option to specify that Metastorm BPM is to date attempt to convert a text value to a date Convert to Date time You use this option to specify that Metastorm BPM is to time attempt to convert a text value to a time 308 May 2008 Metastorm Inc 2008 Designer User Manual SERVER ACTION RESULT DESCRIPTION CATEGORY ae Current date Date time You use this
254. e field When user loads form set the variable name equal to the default value For example using a static value SVariableName Value Default Values can also be setup using a formula 178 May 2008 Metastorm Inc 2008 Defining a List Field Designer User Manual Use a list field to display and select multiple entries from a list of text values The list may be generated by a formula specified via the Integration wizard or Formula editor and calculated by the Engine at run time When a formula is used the items in a list field can be a set of single values or label value pairs When label value pairs are used the labels are shown in the list and the values are passed to the database To add a list field click on the List button on the form toolbar and then click on the location on the form where you want the field to be displayed Designer places a list field on the form and displays the corresponding Properties editor The Properties editor displays five tabs for defining list field properties e List e Options e Do this e Extra e Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Defining a List Field s List Properties a Dataset i folder Variable calculated Caption a T Oret OTP Ong Hin read only v Metastorm BPM Release 7 6 May 2008 179 Metastorm BPM Release 7 6
255. e file in the designated file path If the library file cannot be found either delete the library from the procedure or read the library from the Metastorm database A If the procedure is loaded without the library and then saved references to the library will be lost Referenced map segments form segments folder pages and forms will need to be re associated with stages folder page lists and actions To take a library online 1 Open the procedure The procedure Loading Status dialog will indicate that the library is from the offline source Library Loading Status Library ChainToMapSeg04_lib Location C Documents and Settings aforrest My Documents Loaded offline library ok Figure 41 Library Loaded from offline location 2 Select File Procedure Properties and uncheck the Work Offline checkbox The following dialog is displayed Information Z The process is still using the offline version of the library 1 Either save the procedure file close and re open it or click Update to retrieve the latest version of the library From the repository Figure 42 Taking a library online 64 May 2008 Metastorm Inc 2008 Designer User Manual Designer will continue to read the library from the designated source 3 Click on the Update button on the Procedure Properties Used Library tab to read the library from the Metastorm database 4 Save and close the procedure file with the Work Offline checkb
256. e following tab delimited values for each file File name extension File size in Kbytes Modification date server locale format 380 May 2008 Metastorm Inc 2008 Designer User Manual For example Dir C My Documents EmailAddress user Alt Delimiter Arguments user a string identifying the registered Metastorm user whose email address is required Alt Delimiter an optional string specifying the delimiter to use in place of a comma Returns string the email address of the specified user obtained from the Metastorm database For example EmailAddress User Name Email address of current user EmailAddress Manager Originator VP CEO Of originator s VP or of CEO GetData data_source table rows column col_delimiter j row_delimiter Arguments data_source a connection string for the database containing the information to be listed If empty the Metastorm database will be used A You should not use a DSN string when mapping to the Metastorm database as it could cause database locks table a string identifying the table containing the information to be listed rows a string to be used in a SQL WHERE clause to select the required rows from table If empty all distinct rows will be returned column a string identifying the column whose contents are to be listed col_delimiter an optional string delimiter to be placed between each column in the result set If omitted or empt
257. e grid will not load Selecting the column name from the drop down list ensures that the column name is valid amp The Oracle syntax for concatenating columns using the pipe operator is not supported and will result in an Unable to load xml into DOM error from the Engine The work around is to create a column definition using the CONCAT command For example CONCAT MYTBL COL1 MYTBL COL2 3 By default the caption is the same as the column name You can specify a different caption to be displayed for each column of the grid in the Column caption property The caption is displayed in the top fixed row of the column left justified 4 Use the Column width option to specify the width of the column in pixels A column will not display narrower than its caption 5 Use the Column usage option to specify whether the column will be required optional read only or hidden Metastorm BPM Release 7 6 May 2008 217 Metastorm BPM Release 7 6 6 Use the Column type dropdown to select the data type of the column Column types should be mapped only to the database field types shown in the following table Grid Column Type Database Field Type Date Time Date Time Text Text Memo Date Time Integer Real Currency Number Integer Real Currency Dropdown Text Currency Integer Real Currency Table 24 Grid column type properties A When generated by a formula the items in a grid s drop down column can
258. e items contained in the list field 1 Enter your list items into the List options field You may do this in one of two ways Open the Integration wizard and choose variables to populate the list For example if you select the option List Registered Users from the Integration wizard a list of all users registered with Metastorm BPM will be displayed in the list If you want the list to be built from a column or columns of a database table you would need to select a function such as List Metastorm data for single values or List Metastorm label value pair for label value pairs from the Integration wizard options Type the list items directly into the field This is a simple method to use when you have a relatively short list Either type the items directly into the List Options property one per line or click on the Formula editor button and type the list items into the Formula editor field Press Enter after each option These values will be evaluated when the form is loaded or if the field is specified as dependent whenever any field specified as having dependants is changed To use negative numbers parentheses and percentage signs in a list the following should be taken into account e Ifthe first item in the list is a negative number enclose it in quotation marks For example 1 will be displayed as 1 Subsequent negative numbers in the list should not be enclosed in quotation marks Metastorm BPM Release
259. e of commands external to the procedure external flags When a flag is associated with an action the specified flag is triggered when a folder meets the procedure s criteria It is also possible although much less common to create a formula to raise a flag from a stage Flags may be associated with the appropriate action in the following ways e Raised through an action s Raise Flag property e Raised through formulas in the Do this tab of Properties editor e Raised automatically as part of a sub procedure stage and used to open another map but with no sharing of data e Raised externally by the use of the eraiseflag exe utility e Assigned externally by the use of the eraiseflag ocx component Refer to the SDK for instructions 254 May 2008 Metastorm Inc 2008 Designer User Manual e Raised by a Transaction Protocol request Refer to the SDK for instructions 9 2 Defining a Flag 9 2 1 Flag Data Flag data is the term used to identify the information that a flag passes In order to pass flag data you must do the following e Assign a value to the flag data field The receiving procedure sees this information as Session FlagData 1 Session FlagData 2 Session FlagData 3 etc rather than by the sending procedure s variable name so it s important to keep track of the order in which this data is requested e Assign variables in the same order on the receiving end i e in a submap I
260. e position of an item in a list entry For example if Metastorm BPM were finding C in the list A B C D E it would return 3 Line feed text You use this option to specify that Metastorm BPM is to insert a line feed ASCII lt LF gt decimal lt 1 0 gt into a memos or to search for a line feed in a memo List Metastorm text You use this option to specify that Metastorm BPM is to read a data list of values from one column of the database and return them as a comma separated unique list This is typically used to populate a drop down field or other list in a form List external text You use this option to specify that Metastorm BPM is to read a data list of values from one column of a database table and return them as a comma separated unique list This is typically used to populate a drop down field or other list in a form Metastorm BPM Release 7 6 May 2008 313 Metastorm BPM Release 7 6 SERVER CATEGORY ACTION RESULT TYPE DESCRIPTION List Metastorm label value pair text You use this option to specify that Metastorm BPM is to read a list of values from two columns of the database and return them as a comma separated unique list This is for use in populating a dropdown or grid dropdown column with label value pairs The label is shown in the field and the value is passed to the database List external label value pair text You use this option to specify that Metastor
261. e set up in i the When action completes property of i this creation Flag action Payro d Failed validation Payroll updated Test Passed validation Payroll amended Figure 237 New Hire Sample Procedure Payroll Submap 332 May 2008 Metastorm Inc 2008 Designer User Manual The deadline and the subject are set up in the When action completes property of this creation Flag action P i Hardware PC ordered a Pe tals set up Networks ee Extensions a IT complete Figure 238 New Hire Sample Procedure IT Submap Preparation Register the users who will participate in the procedure You may use the Set Up procedure to add sample users to your Metastorm system Points to Note e This procedure uses the following dynamic roles that are evaluated at run time based on data collected by the procedure Facilities Manager Hardware HR Assistant HR Manager Manager Networks Payroll Clerk Security Manager Telecomms e This procedure demonstrates the use of sub procedures with sub folders relating to a folder being processed in parallel When a folder arrives at the Wait sub procedure stage three child folders are created in each of three sub maps Facilities IT and Payroll See the Maps page of the Properties editor for the Wait stage where all three of the Map check boxes have been c
262. e that Metastorm BPM will still evaluate Metastorm variables functions or other operators within any quoted or any quoted text A When you are assigning a date time value to a variable it must be enclosed in quotation marks E g DateTime 2001 11 23T00 00 00 In general Metastorm BPM will remove leading and trailing spaces from any unquoted or quoted string Where Formulas May Be Used Formulas may be used to set any Metastorm Designer property that has an associated Integration wizard or Formula editor button These properties with their expected types are e Map Subject accepts a string Values longer than 250 characters will be truncated at run time e Stage When stage started accepts one or more commands entered on successive lines e Stage but not archive stages When stage completed accepts one or more commands entered on successive lines e Stage system stages only Auto forward folders to accepts a string that should at run time resolve to the name of another stage in the same map e Rules accepts a string that represents a business rule e Action Alert message accepts a string Values longer than 250 characters will be truncated at run time e Action timed actions only Start this action accepts a number e Action timed actions only Timed event accepts a date time e Action user actions only When action started accepts one or more commands entered on successive lines e Action but not
263. e the folder data as comma delimited quoted values Alt Delimiter an optional string specifying the delimiter to use in place of a comma Returns command saves all folder and custom variables as quoted comma separated values to the specified filename in the server file system 398 May 2008 Metastorm Inc 2008 For example Designer User Manual SaveData FolderID C Windows Temp Folder csv SendMQMessage symbolicName message priority timeToLive folderID Arguments symbolicName message priority timeToLive folderID Returns boolean a string containing the name of the registered out queue to use a string containing the message to send to the queue an integer containing the priority of the message an integer containing the length time the message will remain in the queue 1 indicates infinite time an optional string containing a folder ID for the message TRUE on success otherwise an Metastorm formula exception SendMQMessageEx type queueName message priority timeToLive params This function avoids the need to use a pre defined queue when sending a message Arguments type queueName message priority timeToLive params Returns boolean a string containing the type of messaging system to use WebSphere MQ or MSMQ a string specifying the queue to which to send the message a string containing the message to send to the queue an integer
264. e to which the library is associated Add a new script to the library in the same way as you would add a script to a procedure amp Refer to section 10 for more details on including scripts in Metastorm BPM LDAP Alias If you want to access directory services data within a procedure you must create an alias for the connection to the directory within a library amp Refer to section 10 1 7 for further information on direct directory access and adding LDAP aliases Integration Wizard Collection A library may contain a set of additional Integration Wizard functions This is referred to as an Integration Wizard Collection Associating a library containing an Integration Wizard Collection with your procedure allows you to use these additional functions in your procedure The most common use of this feature is to create a number of scripts in a library and provide custom Integration Wizard functions to access these scripts in a user friendly way To create custom Integration Wizard functions in the Designer you will need to add the relevant scripts to a library and populate the library s Integration Wizard collection To populate the Integration Wizard collection you will need to provide an Integration Wizard extensions file This file is in XML format and contains details of the custom Integration Wizard categories and functions amp For information about the Integration Wizard extension file refer to the Designer Customization Develope
265. e used as the currency symbol a representation of currency formatted as specified by the locale and other parameters 370 May 2008 Metastorm Inc 2008 Designer User Manual For example FormatCurrency 14 50 14 50 FormatCurrency 14 50 ENU 14 50 FormatCurrency 146000 50 ENU 1 TRUE 3 1 0 146 000 5 FormatNumber number decimals width format Arguments number a number to be formatted decimals the number of decimal places required in the result width an optional minimum number of characters required in the result which will be padded as necessary If the formatted number is longer than this then the result will be extended accordingly If omitted or empty a minimum width of 0 will be used format an optional string used to specify the format built from the following elements 0 pad with leading zeros rather than spaces align to left rather than right within width prefix positive numbers with explicit sign p prefix positive numbers with a space character always display decimal portion even if zero b return empty string if value is zero A return as percentage with trailing character Returns string a representation of number formatted as specified by decimals width and format For example FormatNumber 12 34 0 12 FormatNumber 12 34 1 12 3 FormatNumber 12 34 1 5 12 3 FormatNumber 12 34 2 412 34 FormatN
266. e variables will be common to most procedures e g creation time folder creator deadline To prevent duplication Designer has predefined System variables which can be used in any procedure A full list of system variables is provided later in this section The most commonly used expression in Designer is the Assign value function This expression assigns a value to a particular system or custom variable For example the Subject variable could be set to a text value or the Deadline variable could be set to a calculated expression The basic syntax for this function is Variable Value 4 1 Custom Variables Designer automatically establishes a number of variables that can be used in calculations or in reporting In addition when designing a procedure you can define your own custom variables and assign values to them Custom variables are used to store data that has been entered by either a user or extracted from an external system Custom variables are associated with a particular map and the data from the Metastorm BPM Release 7 6 May 2008 103 Metastorm BPM Release 7 6 custom variable is stored in the map s database table The custom variables form the columns of the table while the folders make up the rows 4 1 1 Custom Variables and Forms Typically a form will contain one or more fields that are used to display and capture data These fields may be associated with pre defined system variables or custom variable
267. ease 7 6 May 2008 261 Metastorm BPM Release 7 6 e Easy access to variables and functions that may be used in formulas By allowing you to integrate to systems that are external to Metastorm BPM the Integration wizard enables you to specify that a procedure can for example print a Word document send an email read from a database and run applications The Integration wizard is a tool for building expressions and calculations based on system and custom variables and functions built into the Metastorm BPM system The Integration wizard may be opened at any time to create or edit your formula by clicking on its button Figure 176 Integration wizard Button The Integration wizard provides a step by step interface allowing you to select from a list of formula categories and a subsequent list of items for each category that are valid for the property field you are working with Each property has a related list of valid formula types only items of compatible types will be displayed in the formula list You can also open the Integration wizard to define a formula when defining flag data using the Flags dialog or roles using the Roles dialog When you click on the Integration wizard button Designer displays the Integration Wizard dialog to help you build the formula The resulting formulas are displayed with the following color coding e Plain text which will not be translated by the Process Engine at run time is shown in black o
268. ected in the main pane e Drag and drop items where appropriate For example it is possible to drag a form from one map to another e Select options via a pop up menu Expand All Collapse All Map Map Segment Form Eorm Segment LLIE E Administration Forms Role g5 p Script Custom Variable F Flag Figure 14 Procedure Explorer pop up menu Metastorm BPM Release 7 6 May 2008 39 Metastorm BPM Release 7 6 From the pop up menu it is possible to Add new elements to the Procedure A It is also possible to add new elements by clicking the appropriate button on the general toolbar Rename the selected element Add an existing map form map segment or form segment to the Procedure Delete the selected element Expand all nodes in the Procedure Explorer tree Collapse all nodes in the Procedure Explorer tree 1 3 5 Component Bar The Component Bar provides an alternative to the Procedure Explorer to navigate procedures To access the Component 1 Select View Options The Options Dialog is displayed A Options Publisher Editor Miscellaneous File Locations External Forms Ask for confirmation when the procedure already exists Ask for confirmation if a role is used by another procedure Use transactions recommended Show validation warnings Enable versioning Enable procedure protection Cancel Help Figure 15 Options Dialog 2 In the Options
269. ed option instead of a calculation formula In the When changed field enter any command the system is to perform when the contents of this memo field are changed For the commands in the When changed field to be performed when the field is updated the Field has dependants of its own checkbox must be checked 4 If you selected a system variable or created a new custom variable for this memo field the Field has dependants of its own check box will be displayed on this page of the Properties editor This field instructs the system to notify immediately the Metastorm Engine of any changes to this memo field This is necessary if any other fields on the form are dependent upon the content of the memo field A This box must be checked if any other fields are dependent upon values in this field 5 Enter any commands to be performed by the system when the memo field is entered or exited in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Number Field The number field is displayed as a single line field that accepts only numeric input This input may be supplied by a user or may be supplied by the database based on variables you specify Use a number field to display an integer whole or real decimal value Variables of type Real of
270. efault is a comma character e start index position in the array or collection to start creating the delimited string Default is 0 e end index position in the array or collection to stop creating the delimited string Default is 1 which selects all items Returns A name and value delimited string A This option is only available using an assembly activated using Process Orchestrator for NET Activator 5 3 6 GetNameValueList Direct GetNameValueListDirect returns a name and value delimited string using a specified complex type collection Parameters e variableValue specify a value of a memo variable or a value which is obtained by calling another activated method and not stored in a memo variable field The value must contain a serialized complex type value The serialized complex type value must be either an array or a collection object Metastorm BPM Release 7 6 May 2008 125 Metastorm BPM Release 7 6 item manually enter the name of public field or public property name If a field name is not specified the result of calling the ToString method to an array or collection element will be used The Metastorm Process Designer is required to specify the key and value type names of the collection items nameValueDelimiter specify a string delimiter to separate the name and value pair Default is a tab character itemDelimiter specify a string delimiter to separate individual items Default
271. egration Wizard To enter a delimiter using the Integration Wizard Integration Wizard Delimiter Figure 115 Delimiter defined by Integration Wizard Select the Wizard icon above the Delimiter field The Integration Wizard dialog appears Metastorm BPM Release 7 6 May 2008 175 Metastorm BPM Release 7 6 Integration Wizard Delimiter There are no valid items in this category Category Most recently used gP All functions g Action and form information g Commands g Custom variables g Dates and times Directory integration g Microsoft Exchange adaptor g Metastorm database g Extemal database adaptor g File adaptor g Folder information Form fields gf Lists and memos g Microsoft Office adaptor g Numbers e Text functions Figure 116 Delimiter Options Select Delete to remove any existing delimiters or select Next The Wizard displays the Text option from a list of variable categories t Integration Wizard Delimiter Type in the text required Text Figure 117 Delimiter text entry Select Next The text entry field is displayed Enter the required delimiter and click Finish The delimiter is displayed in the Delimiter field of the Properties editor 176 May 2008 Metastorm Inc 2008 Designer User Manual Delimiter Formula Editor File Edit Search View Help EO beh SD AB hn 8 Save amp Close
272. egration Wizard viscsisenidinssccssesscenscevtscssiescesnssenssegstessoenssesssess sedeenotesssedstestseusvecsssestsnsscensscsevess 237 7 4 1 Common DMS Integration Wizard Command cccccccccccecesecssesssseseteceeseenseseseeeeeeaeseees 238 Get Document Id From Clipiss scisissssssscscsstetsssssanatevecsetesenseactansstelassassgabonsstis EEEE E SEE eaS napi 238 Get Selected Document Id Get Folder Doctiment Ids aene er e EO ENRE EOE 7 4 2 SharePoint Integration Wizard Commands cccccccscsscsesssesssessssssssssssssessecssssseessessasees 238 Upload Document s s cvslesctacaciesesesdsassaessisss sestsacbossdesss svsscuacdbssessedausvasssaesabes Browse SharePoint sats ios ie ET eadadseacech xed TE TET Check In DOCume nt isis fi dessdecsssesesssdacateciecs dis deesaesdseseaas E Ee E EE E Eaa dina ones Check Out Document Delete DOCUMENT raaa desdesescssteseaas a cassosca vowbscaeadinie E EE aE eS iaee Download Document iiinn aia aa saa e ia Get Document Meta Data Set Document Meta Data Undo Check Out Document Verify Document ee Get Document Author Get Document Checked Out By nnrir n e E EEE TEER EEEE ER 241 Get Document Creation Daters iri tiesti iet EERE EE EER E EERE EE R Get Document Editor cecceeeeeeeseeseseseseseeeseneeeees Get Document Last Modified Get Document Title 00 Verify Folder ii icits tei n e E E E EE deena waning dies ees ela ecaeass amp DEFINING ROLES sscecscnceccen
273. elating to a process One of these metrics relates to the number of items with a Priority of 1 A status field is used to determine and display the state of this metric The administrator sets up the thresholds for this using the Set Process Thresholds administration form This example assumes the administrator has set the Safety threshold to 10 and the Danger threshold to 20 Metastorm BPM Release 7 6 May 2008 199 Metastorm BPM Release 7 6 The following table illustrates the state of the Priority 1 items in progress metric depending on the current number of Priority 1 items Current number of State P1 items 10 Safety 20 Danger 11 Warning 21 Danger 9 Safety 19 Warning Table 21 Example values and their states for Priority 1 items in progress The following diagram illustrates in pictorial form into which states these example values fall Warning Danger States 19 21 Exampk Values Thresholds Figure 134 Example values and their states for Priority 1 items in progress Example Two In a Sales Lead process a form may contain a status field used to flag the state of the number of current leads In this case if the number of leads was high the status field should show the Safety state and if the number of leads had dropped too low the field should show the Danger state Therefore the Safety threshold would be higher than the Danger threshold For this example assume the Safe
274. eld will be read directly from the dataset rather than require an additional call to the database Any datasets previously defined for use with this form will be displayed in the drop down list For more information on creating datasets see the Defining a Dataset Field topic in this section 2 If you wish to change the caption enter the new caption in the Caption field If you omit this or have selected calculated as your variable the date time field will be displayed with a default caption of DateTime plus an auto incremented number 3 Identify the variable you wish this field to use in the Variable field There are a number of options Ifthe date is to be calculated at run time select calculated from the list You will be able to specify how it is calculated on the Do this tab If the date is to be stored in the database you can select a variable from the drop down list Only date time variables will appear in the list You can create a new date time custom variable by clicking on the New custom variable button and specifying the details of the variable You cannot create a new custom variable if you are using a dataset for this date time field If you are using a dataset select the column name the system should use to calculate the information for this field from the column names shown in the drop down list The variable you select on this tab of the Properties editor will determine the fields that appear on the
275. emGetClientRecord stores XML The XML is used by the FormatComplexType function to extract the client record details with user defined text into the memFormatComplexType field Using FormatComplexTypeDirect The FormatComplexTypeDirect can be setup using two methods The first method uses the steps explained above substituting in step 11 FormatComplexType with FormatComplexTypeDirect and in step 13 substituting memClientRecord with memClientRecord The second method returns the memo data directly into the function and removes the need for two steps in the Do this property tab Integration Wizard Assign value lt Value gt Return string format variable alue memo ScriptEval JScript NET Procedure Name MapName eWork Activator i gt format memo on Please call lt ContactFirstName gt lt ContactLastName gt at lt CompanyName gt o Figure 80 FormatComplexTypesDirect Example 5 3 3 GetList GetList returns a delimited string using a specified complex type array or collection 122 May 2008 Metastorm Inc 2008 Designer User Manual Parameters e variableName specify a Metastorm Memo variable containing the serialized complex type value The serialized complex type value must be either an array or a collection object e item manually enter the name of public field or public property name If a field name is not specified the result of calling the ToString method to an array o
276. ements the handles surrounding each selected element will be grayed out You may move the elements as a group to another position on the form as well as cut copy or delete the group However you may not resize the elements as a group Moving Form Elements Form elements may be moved by selecting them and dragging them to a new location Copying and Pasting Form Elements Form elements may be copied by selecting the desired element and then selecting the Copy button from the General toolbar or by using the Edit Copy option Form elements may be pasted onto a form by selecting the Paste button from the General toolbar or by using the Edit Paste option Aligning Form Elements Individual and groups of form elements may be centered horizontally or vertically on the form Groups of form elements may be aligned vertically or horizontally relative to each other through the Edit Align option The following table shows the selections available through the Edit Align option Horizontal Vertical No change No change Left sides Tops Centers Centers Right sides Bottoms Space equally Space equally Center in window Center in window Table 19 Form Element Alignment Options A Metastorm Designer does not consider captions when it aligns form elements alignment is based upon the element s data field size and position You should inspect your form layout to verify that the captions for each form elem
277. en changed it represents the value when event processing begins This variable should only be used in the following properties 364 May 2008 Metastorm Inc 2008 Designer User Manual e When changed e When user saves form e When action completed Pure Functions Pure functions are those that return a result but have no other effect on the system and require no access to the file system or database They will always return the same value for any given set of arguments Pure functions may be used in any property whether as part of an assignment command or more frequently as stand alone values used to return a value into a property Pure functions may also be nested as the argument of another function call The following pure Metastorm functions are defined Abs value Arguments value a number or currency value whose absolute positive value is required Returns Number the absolute non negative value of value irrespective of its sign A Ifa currency value is passed in the result is also a currency value For example Abs 999 999 1 999 999 Asc character Arguments character a string whose first character s ASCII code is required Any characters after the first will be ignored Returns number the ASCII code 0 to 255 for character For example Asc 0 1 48 Ase 012345 48 Ignores rest of string Metastorm BPM Release 7 6 May 2008 365 Metastorm BPM Release
278. ency Properties sseeeeeseereseeereerererrersrereerereersrsreee 159 Defining a Currency Field s Options Properties sseseeeeeeeeeeeeeeereeiererrsrsrrrerrereersesreee 160 Defining a Currency Field s Do this Properties seeseeeeeseeeeeeereereesrsrsirreerereersesreee 161 Definmig a Dataset Field inniinn e EE EA ea a N E E 162 Defining a Dataset Field s Dataset Properties ceeeeeseceseeeesecseeeeceeeeceeceeeeeeaees 163 Defining a Dataset Field s Do This Properties cecssesecssecssesecneeeeceseeecsseeateseenees 165 D inme a Date Time Field c 1 c5 satan ante dG A a le 166 Defining a Date Time Field s Date Time Properties 2 00 00 ceeesesecseeeeceeeeeceseeeeeseeeees 166 Defining a Date Time Field s Options Properties ccescseeesecseeeeceseeeeeseeateseenees 168 Defining a Date Time Field s Do This Properties 2 0 0 0 ceeesssesecseeeeceseeeeeseeaeeseenees 169 De inme a Drop down Fieldin ieai iee Gad Ca a ec E a 170 Defining a Drop down Field s Drop down Properties c sccesceeseeececeeeeseeeseeeneees 171 Defining a Drop down Field s Options Properties esssesssseeseseeeeeeieseersrsrrreerereersesreee 173 Defining a Drop down Field s Do This Properties csccesceeseceeeceeceeeeseeneeeneeees 177 Defining a Default Value for a Drop down Field oo eee eeeseeseeeecneeeeceseeeeeseeaeeseenees 178 Definmg a List Fields asc fit ante etna cakes a AGE aa ae eee 179 Defining a L
279. ent position options Left Places the caption to the left of the currency field Right Places the caption to the right of the currency field Top Places the caption to the top of the currency field Bottom Places the caption to the bottom of the currency field Select the caption alignment desired 5 You can include a text string that will display a brief help message to the user when the cursor hovers over the currency field in the client Type the message you want displayed in the Hint field 6 The Default action usage field allows you to specify a default such as read only optional hidden or required for the Currency field Use the down arrow associated with this field to select the desired default C Minimum C Maximum E Decimal places Currency symbol eo Before number v Before number v Figure 103 Currency Options Tab Defining a Currency Field s Options Properties The Options tab allows you to set properties that will determine how the currency value is displayed 160 May 2008 Metastorm Inc 2008 Designer User Manual 1 If there is a minimum value to be associated with the currency field click the Minimum check box and enter the minimum amount in the field below using the arrows provided 2 If there is a maximum value to be associated with the currency field click the Maximum check box and enter the maximum amount in the field below using the arrows provided 3
280. ent and server side scripts stored in a library may be called from any map or form in the procedure to which the library is associated 2 2 3 Inheritance of Roles from Libraries Roles may be defined within a library in either the Common section or in a map segment When a library is included in a procedure the roles defined within the library become accessible to the other components within the procedure The accessibility of roles defined in a library by other components within the procedure is as follows e Roles defined in the library s common section are added to the procedure s common section and are available to all components within the procedure 56 May 2008 Metastorm Inc 2008 Designer User Manual e Roles defined within a library map segment are available only to the components of the procedure maps to which the map segment is applied Nested Map Segments Within a procedure it is possible to have a number of nested map segments e g map segment A applies map segment B which applies map segment C In such cases there is a hierarchy of inheritance Each map segment can access the roles of only those map segments applied within it In the example above A can access the roles of A B and C B can access those of B and C whilst C can access only those of C Recursive Map Segments It is possible to create a recursive relationship between map segments wherein map segment A is applied in map segment B and map segment B
281. ent appear as desired Determining Form Element Layering Form elements are divided into two groups foreground and background elements Foreground elements always overlay background elements However individual elements within each group may be brought to the front or sent behind another element using the Bring To Front and Send To Back options from the Edit menu To place one form element in front of another select the form element and from the Edit menu select Bring To Front To place one form element behind another select the form element you want to send to the back and from the Edit menu select Send To Back 130 May 2008 Metastorm Inc 2008 Designer User Manual A Metastorm Designer does not consider captions when it layers form elements layering is based upon the element s data field position You should inspect your form layout to verify that the captions for each form element appear as desired Windowed controls such as frames always stack on top of non windowed controls labels are the only non windowed controls used in the Designer so you can change a label s stacking order only in relation to other labels Deleting Elements from a Form Form elements may be deleted from a form using any of the following methods Select the desired element and e Press the Delete key on your keyboard e Use the Edit Delete menu option e Use the Edit Cut option e Click on the Cut button Form elements rem
282. er s To Do or Watch list This field must not be left blank and each name in the map must be Metastorm BPM Release 7 6 May 2008 77 Metastorm BPM Release 7 6 unique The field may be no longer than 31 characters in length The following characters are not supported in the Stage Name property e Pipe I e Period e Dollar Sign e Equal Sign e Back Slash e Quotation Mark e Forward Slash e Percent e Comma e Plus e Colon e Semi colon e Open bracket lt e Close bracket gt A When designing a stage to expose as a web service the Stage name should contain only alphanumeric characters and spaces The stage type is displayed in the Type drop down list To change the type of stage you are working with select the new type from the list ra If you change the stage type after you have defined stage properties be sure to review the properties for the new stage type A stage on the map is represented by the Icon shown in the Properties editor You can change this icon to one of your own choice To change the stage icon 1 Double click on the displayed icon or by clicking on the Image button The File Open dialog is displayed 2 Browse to select a graphic file containing an alternate icon Select the forms that will be displayed to the user while the folder is at this stage from those listed in the Available pages field Use the arrow buttons to
283. er Error EMPTY User Error File could not be deleted DeleteAttachment folderID filename Arguments folderID a string identifying the folder whose attachment is to be deleted filename a string containing the file name and extension without path of an attachment to be deleted from the folder Returns string an empty string used to reset the value of any clip variable associated with the attachment after deleting the attachment from the Metastorm database For example myClip DeleteAttachment FolderID myClip Clears myClip A The YoDeleteAttachment function removes the specified attachment file from the database It does not however reset the value of the custom variable that is associated with a clip As a result after invoking DeleteAttachment a clip associated with the deleted attachment will appear as if the attachment still exists The work around for this problem is to reset the custom variable after invoking DeleteAttachment as follows DeleteAttachment folderID txtAttachmentPath txtAttachmentPath Metastorm BPM Release 7 6 May 2008 389 Metastorm BPM Release 7 6 EMail toList ccList subject message attachment reply address 3 This function makes use of Microsoft s cdonts dll which is not officially supported on any version of Windows after Windows 2000 although it appears to work For this reason it is recommended that the Send an e mail m
284. er conditional actions originating from the stage itself and conditional actions applied from a common stage On these more advanced maps the Stages Order property contributes to determining the order of assessment for the conditional actions If the common stage is higher on the Stages Order list the conditional actions from the common stage will be assessed before the conditional actions on the other stage The default order of the stages on the Stages Order tab is defined by the order in which the stages are originally added To change the Stage Order for stages on your map select a stage from the list and use the up and down arrow buttons to move the stage to its new position or drag and drop the items Defining a Map s Notes Properties This tab of the Properties editor displays a memo field that the designer may use to make notes These notes are not available to the end user 3 3 Stages When a folder reaches a user s desktop Metastorm BPM views the folder as having reached a stage in the procedure A map may also contain various system stages that do not require human interaction You can include any number of stages on the map Stages are connected by actions which will be discussed later in this section To add a stage to a map select the desired stage button from the Map toolbar and click on the map to place the stage Designer places the appropriate stage icon on the map and displays the corresponding Properties editor S
285. er the rows in the grid select a field name in the selected list and press the Up or Down button to reposition it For example if you wish to sort name within department place department higher in the list than name 6 The Default Action Usage field allows you to specify a default such as read only optional hidden or required for the Grid field Use the down arrow associated with this field to select the desired default A The Default Action Usage for an editable grid cannot be required A In the Web client a read only grid can be viewed page by page The number of rows on a page depends on the user s Browser Settings Refer to the Using Metastorm BPM with Internet Explorer guide for further details A Please note when using grid specific client side script functions with a paged grid the RowCount refers to the number of rows in the current page not the number of rows in the grid as a whole In the same way the Row index refers to the row s index in the current page not in the grid as a whole 7 You can include a text string to give users a brief help message when the cursor rests on the grid Type the message you want displayed in the Hint property Defining a Grid s Options Properties The Options tab in the Grid s Properties editor provides the facility to define the delimiter to be used in the drop down list of Columns names The selected delimiter is applied to all columns in the grid Metastorm BPM
286. erName myNewCustomerName WHERE CustomerName myOldCustomerName DSN CustomerData UID sa PWD Metastorm BPM Release 7 6 May 2008 391 Metastorm BPM Release 7 6 Execute procedure arguments Arguments procedure is a string identifying a database stored procedure arguments is either a string of arguments or more than one string argument to be supplied to the stored procedure Returns command executes the specified stored procedure with any specified arguments against the Metastorm database a Execute does not support output parameters For example This function can be used with two parameters for backward compatibility or multiple parameters The arguments parameter may be one string containing a list of arguments or a number of strings each of which is an argument If the stored procedure is does not accept any arguments the argument parameter should not be included Two parameters Execute myProc arg1 arg2 arg3 Execute with arguments Multiple parameters Execute myProc arg1 arg2 arg3 Execute with arguments No arguments Execute myProc Execute without arguments The Money data type is not supported with the Execute function To run a stored procedure that uses a Money data type use the ExecProc function A The Execute function no longer supports the following format for the argument parameter argl arg2 arg3 A If you pass in a
287. erence by ServerName This variable should not be used in the following property e Field Variable since the variable is read only Metastorm BPM Release 7 6 May 2008 363 Metastorm BPM Release 7 6 StageName string read only name of the folder s current stage This will be empty during a creation action and will identify the source stage of any other action This variable should not be used in the following property e Field Variable since the variable is read only Subject string writeable folder subject maximum 250 characters This variable is preset from the map s Subject property when the folder is created but may be changed during an action This variable is available in all properties Updated date time read only date and time at which the most recent action on the selected folder was committed This variable should not be used in the following property e Map Subject since during creation the folder has not yet been updated e Field Variable since the variable is read only custom variables number writeable integer real or currency variable string writeable text or memo variable list writeable memo variable date time writeable date time variable condition writeable check variable Custom variables are available in all properties Form Variables Field fieldname string read only giving the value of a field on a form During the processing of a Metastorm event such as Wh
288. ermine the fields that appear on the Number field s Do this tab 3 Ifyou are using a variable other than calculated Designer uses the variable name as the default caption for the number field If you wish to change the caption enter the new caption in the Caption field If you omit this or have selected calculated as your variable the number field will be displayed with a default caption of Number plus an auto incremented number 4 The Caption alignment field contains a radio group listing following alignment positions Left Places the caption to the left of the number field Right Places the caption to the right of the number field Top Places the caption above the number field Bottom Places the caption below the number field Select the caption alignment desired 5 You can include a text string to give users a brief help message when the cursor rests over the field Type the message you want displayed in the Hint field 6 The Default Action Usage field allows you to specify a default such as read only optional hidden or required for the Number field Use the down arrow associated with this field to select the desired default 188 May 2008 Metastorm Inc 2008 Designer User Manual Properties Number1 C Minimum C Maximum Decimal places Figure 126 Number Options Tab Defining a Number Field s Options Properties For a number field you can specify a maxi
289. ernal Form s Notes Properties scsssssssscssssesesssseseseseececeneneneseneecececeeeeeeeseaees 6 3 3 External Forms ISSUES nero rie eaa i E ra E EEA EEE E diene Euro symbols in PDF forms Viewing PDF files s sseeesnssoeseeseesseesees1ese Tnite oration Wizard nnar er ETEA T AET E TOE EE TRER ea 7 DOCUMENT MANAGEMENT SUPPORT ceccsscsssesssseeseeceeeseesseeneesseeseeseneeeeseenees 7 1 What does Metastorm DMS provide ssscscsccssssssssssssscesessssssessssssecessscessssssssesssceseseasecs 232 Teds CUM siidsncacasdasssesscecsscesvassoessdendscecvessbuasteutecssceseesnstonssccstessounsbeussacs ssceeuetecsscdsteesseueceese eduseosCencsssereds 233 72 PLOCEAUIE Properties nininini ieri Maas ea cans bata 233 7 3 DMS Attachment Clips c isvesisscscessscccveccessscesscasecesvessscecosnsevesseesacesocncsvestansecessoeuedendsasecsassevesestonrs 234 7 3 1 DMS Single Attachiment Clip u cccecccccccsscssesssessesesesseseseeecseseseeesesenceaeseceeeeaeaceaeseeeeeeneeeeas 234 viii May 2008 Metastorm Inc 2008 Contents 7 3 2 DMS Multiple Attachment Clip c cccccceccscccssesssseseseescsesesceseseeeesesesceaeseceeeeaeuceaeaeeeeeeaeneeas 235 Zaa DMS PrOper ties ariera aiea A EEEREN EENE E AEEA EREEREER 236 LIE DependantS osiris in En o EE ETENEE NE E guts 237 LAS PA ON ros I I a A N tea ot talon alae Rita O I R A 237 7 3 6 Creating a Dynamic Default Location ssnnsssissinsmicnnnocsnocino nino 237 TA Int
290. erties Rule1 Name Rulet Visibility depends on Don t Show EmployeeN ame Postition Department Grade EmpNumber StartD ate RepattsT 0 1 ReportsT o Other Figure 88 Extra Tab The Extra tab allows you to define the position and usually the size of a form element as well as specify whether it should be displayed at all times or only under certain conditions 1 Each form element is created with a default name based on its type for example Listl You can change this if you wish by entering a new name in the Name field This field may not be left blank and may not include non US English characters A A number of words have special meanings in the databases You should not use any of these reserved words when naming a form element See the Reserved Words txt file for a list of reserved words This file is located in the Metastorm BPM Designer folder A When designing a form that will be exposed as a web service take care not to use VBScript reserved keywords in the fields names 2 If you want the form element to be displayed only under certain conditions select the appropriate options from the Visibility depends on field Dataset and Form Segment fields do not have a Visibility depends on field This property displays a list showing the name of each field on the form The conditions for each type of field are as follows Don t show The current form element will not be displayed on the form
291. es to your external form return to the Form tab of the Properties editor for this form and select the Refresh button To update the file stored in the database republish the procedure Defining an External Form s Format Properties Height 320 A v v Width 512 Restrict viewing to roles v access everybody ework Administrator ework Guest originator To Do list Watch list Figure 159 External Form s Format Tab When you are viewing an external form through the Web Client or Windows Client using web forms it is displayed to the end user through the external form s application software For example the system would open a Web browser to view an HTML form For users who do not have the appropriate software on their system to view the form in its original state Designer creates a shadow form A shadow form retains all of the field definitions of the original form but its layout comes from the properties defined through the Format tab of the Properties editor 1 To define a background image for the shadow form click on the Image button below the Format tab Designer will display a standard File Open dialog allowing you to browse for the image you wish to use 2 To delete a background image from the shadow form click on the Clear button 3 To select a background color for the shadow form scroll through the available drop down list or click on the Colors button Designer will display a
292. esired action and pressing the Delete key or by using the Edit Cut option Actions will be deleted automatically if either of the stages they connect is deleted Moving Actions Actions may be moved to connect a different stage or pair of stages For example stage A gt stage B may be changed to stage B gt stage A To move an action 1 Selecting the desired action and right clicking on the mouse or 2 Select Edit Move from the menu Designer displays a Move Action dialog box amp Move Action Manual Approval From stage To stage Approval Approval Received Loans Rejected Rejected Waiting Approval Withdrawn Withdrawn Cancel Help Figure 52 Move Action dialog 3 Select the star of action in the From stage list and next stage from the To stage list 4 Click OK The action is repositioned Conditional Action Issues Conditional actions are not triggered the instant a folder arrives at a stage This may cause an unexpected outcome 86 May 2008 Metastorm Inc 2008 Designer User Manual For example in the following map the Holiday Request s Form properties are set to Re open folder t Holiday Request Managers Allow Holiday A hiia AOE Human Resources Archive Archive Figure 53 Example of conditional action used with Re open folder option When the folder arrives at the Managers stage which has a conditional action leaving it there is no guarantee at which stage Managers or Human
293. essage function provided by the Mail library is used instead of EMail Arguments tolist a string containing the To list for an email cclist a string containing the CC list for the email subject a string containing the subject for the email message a string containing the body of the email attachment an optional string identifying the server directory path name and extension of a file to be included as an attachment If omitted or empty no attachment will be included reply address an optional string containing the email address of the person who sent the message This will only be valuable if the mail system in use supports return addresses If the reply address argument is missing then the engine s default email address is used This is only true for a mail connector that supports the reply address argument SMTP does MAPI doesn t Returns command Sends an email to the specified users copying the specified cc list with the specified subject message attachment and reply address The function executes asynchronously the Engine continues processing as soon as the request has been queued not after it has been serviced For example EMail helpdesk metastorm com Subject Action Notes ExecProc procedure arguments The ExecProc function is similar to the Execute function The Money data type is not supported with the Execute function To run a stored procedure that uses a Money data type use
294. etastorm BPM Release 7 6 May 2008 383 Metastorm BPM Release 7 6 ScriptEval language file procedure map expression args Arguments language a string identifying the scripting language processor to be loaded VBScript JScript and JScript NET are supported by the Designer file if the specified language is VBScript or JScript this is a string identifying the server directory path name and extension of a script file to be loaded If empty no script will be loaded from file If the specified language is JScript NET this string is a list of files to be added to the script host when the assembly is compiled These files will only be looked at when the script is compiled Compilation occurs the first time it is used on Engine start up and for every new version published thereafter procedure if the specified language is VBScript or JScript this is a string identifying a procedure holding a script attachment to be loaded If empty no procedure script will be loaded If the specified language is JScript NET this string is the name of the procedure to be pulled in when the assembly is compiled This can be left blank to indicate no procedure script map if the specified language is VBScript or JScript this is a string identifying a map holding a script attachment to be loaded If empty no map script will be loaded If the specified language is JScript NET this string is the name of the map script to be pulle
295. etastorm Inc 2008 Designer User Manual 3 Click on Yes to continue or No to cancel Ifthe procedure has not been saved previously Designer displays the standard Save As dialog 4 Specify a location and name for the procedure A It is not possible to publish procedures or libraries with the same name to the same database However if the database is case sensitive the same names in different cases are treated as different names For example in a case sensitive database it is possible to publish the two procedures Flight and FLIGHT Designer displays the Database connection details dialog Flight Metastorm BPM Designer Please enter your database connection details User name isa Password Database Metastorm Figure 21 Database Connection Details Dialog Box 5 Enter the connection details for the database and click OK The Procedure Protection dialog is displayed Procedure Protection Procedure Details Password Leave blank if the procedure is unprotected Description Figure 22 Procedure Protection dialog Enter a password and a brief description of the procedure if desired 6 Click on OK to continue If you are updating or replacing a previous procedure of the same name you will be asked to confirm your action 7 Click on Yes to continue or No to cancel Designer checks the procedure for syntax errors before publishing it If there are no errors t
296. etastorm or external database you may need to specify which table or tables are to be used Enter the names of the database tables in the Table name s argument You must specify the names of valid database tables Alternatively click on the Table browse button to the left of the argument so that you can select tables from the list provided When you click on the Pick Table s button the Pick Tables dialog is displayed W Pick Table s ework70 Available Selected Fields B Access_Violation Alt Alt2 Alt Alt3v AltSv7a Alt3v b AltDelimiterT est AlternativeD elim Analysis_T echnical_Leads Call_Scripts ChainToMapSeg04_Seq1 ChainToMapSeg04_Seq2 Check_availability ClientTests6 Figure 192 The Pick Tables dialog 1 Select the database from the Database drop down The list of available tables for that database in the Available list is updated 2 To select a single table click on it and then click on the gt button To select several tables make the selection by clicking on the table names with the Ctrl button held down and then click on the gt button To select all tables click on the gt gt button The names of the selected tables are moved to the Selected list 3 To remove tables from the Selected list use the lt button to remove one or more tables that you have previously selected or click on the lt lt to remove all 4 To see which fields are included in a table click on the Preview fields
297. etter and preceded by a single percent character as either e A function call if the string is immediately followed by an opening parenthesis Any following strings up to a matching closing parenthesis are interpreted as function arguments Individual arguments are separated by commas Arguments containing empty strings may be specified explicitly using double quotes or simply omitted However the comma separators used between arguments should never be omitted except where those arguments are explicitly shown as optional e An element of a built in array variable if the string is immediately followed by an opening square bracket Any following string up to a matching square bracket is interpreted as an index into an array variable An array variable is any variable that holds a number of tab delimited substrings with the first substring being that with an index value of zero e A system variable if the string contains a period 348 May 2008 Metastorm Inc 2008 Designer User Manual e A folder variable otherwise Variable and function names are not case sensitive FolderName FOLDERNAME and foldername all refer to the same variable Any other string is interpreted as either an operator or a literal value Operators may be any of the following e Unary prefix operators which alter the meaning of any following formula component make following number negative negate following
298. eturns the result to the Engine once the expression has been evaluated Note that if the script executed as a result of this function call has side effects on the system this becomes an impure function which should only be used in the following properties e Stage When stage completed e Stage When stage started e Action When action completed e Form When user saves form e Button field When button pressed e Grid field When user selects row For example FolderName ScriptEval VBScript SelectSQL SELECT eProcedureName FROM eMap WHERE ework eMapName MapName NewFolderName MapName Returns new folder name SelectSQL statement data source col_delimiter row_delimiter headers Arguments statement a string containing the SQL statement to be executed The statement must be a SELECT use ExecSQL instead if you do not need to return a result set data source an optional connection string for the database against which the SQL statement is to be executed If omitted or empty the SQL will be executed against the Metastorm database A You should not use a DSN string when mapping to the Metastorm database as it could cause database locks Metastorm BPM Release 7 6 May 2008 385 Metastorm BPM Release 7 6 col_delimiter an optional string delimiter to be placed between each column in the result set If omitted or empty a horizontal tab character is used as the delimiter
299. fault file locations the DLL is found in C Program Files Metastorm Designer A The DLL for HTM HTML forms is EWHTML DLL A The DLL for PDF forms is EWPDF DLL 8 Before any external forms may be used within a procedure the Extension and Form interface fields must be completed The Form designer field is optional and provided for your convenience in editing your form When you have completed your entries click on the OK button to save your entries or Cancel to clear the form and return to the External Forms Options dialog 9 To remove a file type from the main External Forms options list select the file type and click on the Delete button A There is no Undo option for this action If you inadvertently remove the wrong file type from the list you will have to use the Add process to replace it 6 5 2 Defining External Form Properties In order to use an external form in a procedure you must define the filename and other form properties 226 May 2008 Metastorm Inc 2008 Designer User Manual To create a form click on the New Form button in the General toolbar or from the Component menu select the New Form option Designer adds a form icon to the Procedure Explorer Designer also displays the Properties editor and the Form toolbar The Properties editor displays the following tabs for defining form properties e Form e Format e Do this e Notes Defining an External Form s Form Properties Properties
300. fer limited precision Use a variable of type Currency to guarantee the most precise calculations A Note that due to a JavaScript limitation any number above 29 999 999 999 999 5070 containing decimal places which is entered into a number or currency field in the Web client will be rounded For example 39 999 999 999 999 5070 will become 39 999 999 999 999 5100 This should be taken into consideration when designing forms To add a number field click on the Number button on the form toolbar and then click on the location on the form where you want the field to be displayed 186 May 2008 Metastorm Inc 2008 Designer User Manual Designer places a number field on the form and displays the corresponding Properties editor The Properties editor displays five tabs for defining number field properties e Number e Options e Do this e Extra e Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Defining a Number Field s Number Properties Properties Number1 folder Variable calculated Caption Number1 Caption alignment T OTP enol Bottom C Hint read only v Figure 125 Number Tab 1 The Dataset field asks you to define a dataset for the system to use with this field The default option is folder which indicates that you will not be using a dataset with this field Using
301. field or grid that has dependants or as a result of a button being pressed check the Field is dependent on another check box a If the field is dependent on another field the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab Metastorm BPM Release 7 6 May 2008 169 Metastorm BPM Release 7 6 2 The Calculation formula field allows you to specify how the date time is calculated This field is visible only if you selected calculated as the field s variable You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 3 Ifacustom variable has been assigned to the date time field the Do this tab will display a When Changed option instead of a calculation formula In the When changed field enter any command the system is to perform when the contents of this date time field are changed For the commands in the When changed field to be performed when the field is updated the Field has dependants of its own checkbox must be checked 4 If you selected a system variable or created a new custom variable for this date time field the Field has dependants of its own check box will be displayed on this tab of the Properties editor This field instructs the system to immediately notify the Metastorm engine of any change to this d
302. fining a Grid s Grid Properties seseeseeeseeeseseeesrstsrerteretrsrsestetreretssesrsrerreeersesesee 214 Defining a Grid s Options Properties eseseseeeseeeeesesssrsesrterersrsterreretssesrsrerreeerseseere 215 Defining a Grid s Columns Properties sseseseeesreseseseseeeeeresesrsesterrsretssesrsrerreeerseseeee 216 Defining a Grid s Do This Properties 00 0 0 csesssesscseeseceseeecesecaeesecneeseceaeeeceaeeateseeners 220 Using a Grid to set up Folder on Folder cece eeeseseceseeecsseeeeeseceeeecaeeecsaeeaeeseenees 221 Avoiding Common Editable Grid Errors eseseeeseeeeseeesesresesesrserrerrsrsssesrsrerrereersesreee 223 6 5 External FOrmMS sseeeesseecesseecesseecesseeccsseccosseccossecoossecoossecoossecooseceooseceooseceoeeeceseseceseeeceseeeceseeecessee 224 6 5 1 Defining External Forms Option wi ccccccccscssscccssessssssesscssessescsseseeseseeseesesesseeecseeseeeeseeseeees 224 To Add Modify or Review External Forms Options cccsssssscsssecseeceeessesececsceseesssneeeaeenees 224 6 5 2 Defining External Form Prope rti s ccccccssccscccssssesesesecseseseesesecececsesseaeseeeeeeaeeeaeaeeeneenes Defining an External Form s Form Properties scsssssssssesesesseesesesesececececscseseneeeeeecenenenenenees Defining an External Form s Format Properties scsssssssssssssesseseseseseececeessenenenecceeeceeeeeeesenees Defining an External Form s Do This Properties Defining an Ext
303. form where you want the button displayed Designer places a Command button on the form and displays the corresponding Properties editor The Properties editor displays four tabs for defining Command button properties e Button e Do this e Extra e Notes amp For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 152 May 2008 Metastorm Inc 2008 Designer User Manual Properties Button1 Properties Button1 Caption Button Hint Default action usage Figure 98 Button Tab Defining a Command Button s Button Properties 1 The Button action field contains a radio group listing the different types of button actions available Client operation Uses the Client extension formula which you define on the Do this tab to perform an operation specified by the formula Server operation Uses the When button pressed formula which you define on the Do this tab to perform an operation specified by the formula Commit action Updates the database with any changes made to the form and may move the folder to the next stage Cancel action Allows you to cancel the form without saving any changes New folder Allows you to initiate a new blank form associated with this or another map Open folder Allows you to open a folder created previously by this or another procedure as specified in the Open folder fiel
304. from the list A new DSN can be set up using the ODBC Data Source Administrator User Name Argument Many external databases require users to provide a database login name when making a connection If you are using such a database enter your user name in the user name argument Password Argument If you are using an external database that requires a password enter this in the password argument Row Condition s Argument If you wish Metastorm BPM to select one or more rows in the database table build a condition to specify which rows are to be included in the Row condition s argument For example you might enter eUsername User Name to affect only rows relevant to the user filling in a form The SQL query builder is available to help you construct these clauses If you omit this Metastorm BPM will select all rows in the selected table or tables In the case of a dataset Metastorm BPM ignores all but the first row that satisfies the specified criteria A Be aware that selecting all rows in a database may have a significant adverse effect on performance 10 1 7 Accessing Directories Direct Directory Access Designer allows you to access data from a LDAP3 compliant directory such as Novell eDirectory or Microsoft Active Directory within a procedure This section describes how to add an LDAP alias to a library and use it in a procedure Setting up the LDAP alias In order to access data held in a directory you must first
305. function call an assignment a conditional expression or any sequence of these Commands are actually implemented as conditions which return TRUE on success and FALSE otherwise This means that the operation of a command may be checked in any condition and different paths taken depending on its success or otherwise Type Conversions Metastorm BPM will perform implicit type conversions when property term or argument returns a result of one type but the property term or argument expected is of another type Implicit type conversions are performed as follows e string to list a single element list unless the string contains commas in which case each comma will be treated as a list item separator e string to number leading spaces are ignored Any leading numeric integer or real with the locale independent period as the decimal point part of the string is then converted to a number and any remaining part of the string is ignored If there is no leading numeric part to the string the result will be a zero 350 May 2008 Metastorm Inc 2008 Designer User Manual e string to date time leading spaces are ignored The remainder of the string is then converted to a date time using the server s locale settings If the string does not contain a valid date time according to the server s locale the conversion will fail e string to condition True and False in any combination of case are converted to TRUE and FALSE respe
306. g the form If the user enters an invalid character into a masked Edit field a Number or a Currency field with the Min or Max property set JAWS reads out the character and Metastorm BPM displays it in the field and allows other characters to be entered When the user tabs out of the field a message is displayed that states that the field data is invalid JAWS reads out this message The user will not be able to submit the form until the data in the field is valid Configuring JAWS JAWS users will need to configure their JAWS keyboard options JAWS uses the INSERT key as a modifier key INSERT is pressed in combination with other keys to activate commands Metastorm BPM uses the INSERT key to allow you to insert a row into an editable grid In order to be able to insert a row into an editable grid when running JAWS configure JAWS to use just the numpad INSERT as the JAWS modifier key This leaves the extended INSERT key free for using in an editable grid Accessing Metastorm BPM via JAWS The following guidelines are intended to aid users accessing Metastorm BPM via the JAWS screen reader 412 May 2008 Metastorm Inc 2008 Designer User Manual Determining whether you are logged in to a service If the list frame eLists View frame contains an Metastorm list this indicates that you are logged in to a service As you enter the frame JAWS reads out the type of list To Do Watch Blank Forms or Administration Forms
307. ginated the folder To Do list grants access to this form to any users who have the folder in their To Do list Watch list grants access to this form to any users who have the folder in their Watch list A Ifa user does not hold any of the selected roles the form will not appear in a folder Also a form with no roles selected on its Restrict viewing to roles property is available to everybody A Existing Procedures that have been migrated from Version 6 to Version 7 may use e Work Administrator and e Work Guest as the equivalent of Metastorm Administrator and Metastorm Guest 136 May 2008 Metastorm Inc 2008 Designer User Manual Defining a Form s Do This Properties Properties Employee summary Properties Emplo summary When user loads form When user saves form al Figure 87 Form s Do this Tab Actions that should be performed when the form is opened or closed are defined on the Do this tab of the Properties editor 1 In the When user loads form field enter any commands the system should perform when the form is opened whether as a tab in a folder to be reviewed or as an action form to be initiated or modified You may create the or edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog a If the form is being used as
308. gned vertically or horizontally relative to each other through the Edit Align option The following table shows the selections available through this option HORIZONTAL VERTICAL No change No change Left sides Tops Centers Centers Right sides Bottoms Space equally Space equally Center in window Center in window Table 12 Map Element Alignment Determining Map Element Layering Overlapping map elements should be avoided as it makes the map difficult to read and may make individual elements difficult work with However as you create a map you may find that you need to place one map element in front of or behind another To place one map element in front of another select the map element you want to bring to the front and select Edit Bring To Front Alternatively select the map element right click and a pop up version of the Edit menu will open Metastorm BPM Release 7 6 May 2008 69 Metastorm BPM Release 7 6 To place one map element behind another map element select the map element you want to send to the back and select Edit Send To Back Alternatively select the map element right click and a pop up version of the Edit menu will open A The icons used to create a map consist of an image and a caption on a transparent background Layering map elements too closely together may result in confusion if the captions are not aligned properly You should inspect your map layout to ve
309. h the same name from the same stage A When designing an action to expose as a web service the Action name should contain only alphanumeric characters and spaces 4 Ifyou wish to change the current action to a different type choose the new type of action from the Type drop down ra If you change the action type other properties you have specified may change Be sure to review the properties for the new action type 5 By default Designer will represent the action on the map with the icon displayed in the Properties editor To use an icon of your own choice by double click on the icon displayed in the Properties editor or by click on the Image button The File Open dialog is displayed and you can browse and select an alternate icon 6 Specify the priority of the action from the Priority field For user actions the priority impacts the left to right order in which the action buttons appear in a folder in the Metastorm client Priority 1 appears first priority 2 appears second priority 3 third etc The highest priority is the number of actions that leave the stage If three actions leave a stage you cannot have an action with a priority of 4 For Conditional actions the Priority property determines which of the Only start action if properties is evaluated first The Conditional action with Priority 1 is evaluated first followed by the Conditional action with Priority 2 and so on 7 When this action is completed the Alert mes
310. he line separator is used to force the Metastorm Engine to discard any intermediate result though not any side effects and start evaluating the next line This allows multiple commands to be associated with a single property It also allows commands to be included in any property provided they are followed by a final formula of the appropriate type for that property Metastorm BPM Release 7 6 May 2008 409 Metastorm BPM Release 7 6 Appendix C Designing an Accessible Process The Metastorm Web client is accessible to users with disabilities This appendix describes points to consider when designing accessible procedures The following accessibility criteria are supported and discussed e Section 508 e Keyboard navigation e Internet Explorer text size e Color Blindness e JAWS screen reader Section 508 Compliance In 1998 American Congress updated section 508 of the Rehabilitation Act of 1973 to reflect a focus on technology Section 508 aims to provide employees with disabilities access to the same systems and information as those without disabilities Enforceable standards were put in place that define what makes a product considered accessible to people with disabilities amp Y For further information on Section 508 refer to www section508 gov Watchfire s Bobby software runs a series of checks on software to ensure that it is Section 508 compliant 6 amp Y For further information about Watchfire Bobby
311. he Set Up procedure to add sample users to your Metastorm BPM system 2 Ifyou have used the Set Up Sample Procedure the necessary information for the table Airport will have been populated If you have not used Set Up Procedure you will need to populate this table manually Points to Note e This procedure uses dynamic roles that are evaluated at run time based on data collected by the procedure Traveler Manager VP Travel Department e Use ofthe Manager function in the Manager role e Use of a database table to populate the Airport drop down fields on the request form e Use of the System stage to route the folders according to the class of travel the traveler wishes to take Business Class travel has to have a sign off by the VP Metastorm BPM Release 7 6 May 2008 327 Metastorm BPM Release 7 6 e The definition of the Airport table in the external table editor e The use of visibility on the request form to reveal the details field only when Other has been selected from the Reason drop down e The Progress form that displays the process map and indicates the stage the folder is sitting at whose To Do list it is on and how long it has been at that stage e The separate VP flight request creation action which for VPs bypasses the approval stages 328 May 2008 Metastorm Inc 2008 Designer User Manual Lead Tracking This procedure collect
312. he Validate Validation Procedure dialog i Creates a new map ie New Map ii Creates a new map segment New Map Segment Creates a new form segment Creates a new form New Administration Form Creates a new Administration Form Metastorm BPM Release 7 6 May 2008 35 Metastorm BPM Release 7 6 Button Function r Add Component Adds an existing component from an external file to the procedure through a standard File Open dialog ry Remove Component Removes the selected component from the procedure Removes the selected item from the map or form placing it in the paste buffer Places a copy of the selected item in the paste buffer Inserts an item from the paste buffer into the map or form Reverses your last action Custom Variables Opens a dialog that lists the custom variables for the current map letting you add to or delete from the list a External Tables Displays a dialog that lists the external database tables defined in the procedure and lets you add delete or rename them Also allows you to add or edit columns for tables you have defined or delete column definitions within the Designer for previously defined columns External Table names cannot include extended ASCII characters Note Not all databases support dropping a column Therefore Metastorm BPM does not remove the actual columns from external tables even if
313. he procedure is published Metastorm BPM Release 7 6 May 2008 47 Metastorm BPM Release 7 6 Metastorm BPM end users may now access the published procedure in the system however before they may use the procedure you must first assign roles to those users through the Users and Roles tool Data Formats When a Procedure is published data is stored in the database in Unicode format All procedures and maps and the components that they contain are formulated as XML files XEP or XEL that contain characters defined and stored in Unicode format The particular Unicode format that is employed is determined by the database it is not defined by the Designer Designer determines the type of Unicode supported by the database by examining the data type in the eServerName column in the eServer table The default value is Microsoft standard UTF 16UCS 2 If Designer determines that the database supports Unicode the progress dialog that appears when a procedure is published will announce that publication is in Unicode Figure 23 below shows a publishing dialog Publish Metastorm BPM procedure New Hire on Metasto mk Procedure New Hire published OK Validating procedure New Hire Publishing procedure New Hire with Unicode support Form Employee details Image Image Label Label1 Rule Rule Rule Rule2 Doula Dula Figure 23 Announcement of Unicode support in Publishing 1 4 9 Retrieving a Published Procedure o
314. he timeout value between retries If the message continues to be sent unsuccessfully after this period it is sent to the Retry queue If a message fails because of an invalid Transaction Protocol request it is sent to the Deadletter queue The names of the Retry and Deadletter queues are stored in the eworkqueues xml file These are both Integers If these values are not present in the properties string a default value of 3 is used for retry Number and 60 seconds for retryInterval TRUE on success otherwise a Metastorm formula exception RegisterOutQueue symbolicName system queueName params Arguments symbolicName system queueName params a string containing the name of the out queue a string containing the name of the messaging system used by the queue WebSphere MQ or MSMQ a string containing the name of the queue to which messages are sent a string containing a set of custom parameters MSMQ queues support the following additional parameters within the params string PRIVATE FALSE default TRUE TRANSACTIONAL FALSE default TRUE The private parameter indicates that the queue is private Unlike public queues the system cannot determine automatically whether the target queue is transactional The transactional parameter is ignored for public queues but for a private queue it defines whether the message is sent within a transaction AAA private queue
315. hecked e The parent folder is released from the sub procedure stage by the Ready Rendezvous action All three of the child folders must reach Archive stages in their respective maps for the Rendezvous action to start See the Maps page of the Properties editor for the Metastorm BPM Release 7 6 May 2008 333 Metastorm BPM Release 7 6 Ready action where all three sub maps have been checked and the option to wait for all sub maps to complete has been selected The folders in the three sub maps Facilities IT and Payroll can be processed in parallel A separate child folder will be created for each sub map This procedure illustrates how data from the parent folder can be displayed in a child folder The deadline fields in the child folders are set equal to the deadline of the parent folders through an assignment in the flag creation action in the sub map See the When action completed field of the Do this page of the Properties editor of the creation flag action When an assignment is used the data is stored permanently in the child folder An alternative method of displaying data from the parent folder in a form associated with a child folder is illustrated in the Name field of the Information Technology form The Name field is a calculated field populated from the parent folder each time the form is displayed See the calculation field of the Do this page in the Properties e
316. hey require to complete their portion of a business process in a timely manner This method however often causes problems Pages of a document may be lost when being transferred from one team member to another Important addresses and telephone numbers may be accidentally tossed in the garbage or buried under stacks of paperwork Work grinds to a standstill or escalates to crisis management Metastorm BPM uses the concept of an electronic folder in which all information relevant to a particular task is placed These folders are routed electronically from user to user as team members complete assigned activities All the information necessary is gathered into a single location and made available to the participants as the project reaches their respective desktops The chance of losing important information is minimized and processes move smoothly toward completion In this chapter we will introduce you to Metastorm BPM and discuss the following topics e Components e Design Basics e The Metastorm BPM Designer Interface e Publishing the Procedure e Overview of Metastorm Administrative Tools Users and Roles System Administrator Services Manager Metastorm BPM Release 7 6 May 2008 16 1 1 Designer User Manual Metastorm BPM Components Metastorm BPM is composed of the following components each of which has its own system requirements Specific system requirements are listed in the Metastorm BPM Installation Prerequisites Guide
317. ialize buttons to override default serialization 5 2 3 Return Value The return value of an Integration Wizard function ScriptEval is not necessarily the same as the return value of the external function being called The Integration Wizard add in allows the Integration Wizard function s return value to be a subset of any of the complex types returned by the external function call This is important because it reduces the number of Metastorm custom variables required to manipulate complex data With complex types the return value of the activated function called is normally a complex type object which is assigned to a custom variable After the call is made the variable will contain the value of an object serialized in Binary SOAP or XML Some complex types have inner complex types For example suppose that we have a class Person which has two inner classes PersonalInfo containing information such as name and age and CompanyInfo containing information such as company name and company phone Also suppose that we have an activated method GetPerson which returns an object of type Person Usually the user will map the result from the call to GetPerson to a memo variable and at runtime this memo variable will be filled with the value of the serialized Person object However if the user selects CompanyInfo an inner member of PersonalInfo as a return value then at runtime the memo variable will be filled with the value of the ser
318. ialized CompanyInfo object 5 2 4 Serialization Serialization for Complex Types enables an object to be saved in one of the following output formats e XML e SOAP e Binary The default serialization output format is Binary Metastorm BPM Release 7 6 May 2008 117 Metastorm BPM Release 7 6 When a complex type is serialized it contains additional information to indicate that the class type is in serialized form A Metastorm library which has been generated using the NET Activator may return an error when one of the activated functions returns a hashtable An error only occurs if the default serialization Binary is used when mapping a request for example with functions such as GetNameValueList Serializing To serialize complex types to a custom variable 1 Click Return Value Pei The selected data type is denoted with Default in the Returned Format column 2 Click a Serialization button a XML Serialize to XML b 9AF Serialize to SOAP c Serialize to Binary Right Mouse Menu 1 Right click a data type and select required options Map Complex Type oo XML SOAP TiSi Complex type 5 ClientData CompanyName ContactFirstName ContactLastName Address1 Address2 Area PostCodeOrZip City Phone eMail Country ID Member type class property property property property property property property property property property property property FCliantDacard
319. ield from the column names shown in the drop down list 196 May 2008 Metastorm Inc 2008 Designer User Manual The variable you select on this tab of the Properties editor will determine the fields that appear on the signature field s Do this tab 4 The Caption alignment field contains a radio group listing following alignment position options Left Places the caption to the left of the signature field Right Places the caption to the right of the signature field Top Places the caption above the signature field Bottom Places the caption below the signature field Select the caption alignment desired 5 You can include a text string to give users a brief help message when the cursor rests over the field Type the message you want displayed in the Hint field 6 The Default Action Usage field allows you to specify a default such as read only optional hidden or required for the Signature field Use the down arrow associated with this field to select the desired default Defining a Signature Field s Do this Properties Calculation formula C Field is dependent on another Client extensions Figure 132 Signature Do this Tab Use the Do this tab to specify the calculation formula dependencies and processing to be carried out if the contents of the signature field change 1 If the signature field may be updated as a result of a change to another data field or grid that has
320. ify that Metastorm BPM should read Metastorm a text value from the database text Read folder Date time You use this option to specify that Metastorm BPM is to return date time a date and or time value from a folder in another map in this procedure Read folder number You use this option to specify that Metastorm BPM is to return number a number value from a folder in another map in this procedure Read folder text You use this option to specify that Metastorm BPM is to return text a text value from a folder in another map in this procedure Save Copy an attachment from an attachment clip field in a folder to attachment a file Select text You use this option to specify that Metastorm BPM is to select Metastorm one or more rows from the Metastorm database data Timestamp text You use this option to specify an explicit text representation for format a date time in SQL format 310 May 2008 Metastorm Inc 2008 Designer User Manual SERVER ACTION RESULT DESCRIPTION CATEGORY ES Update You use this item to specify that Metastorm BPM is to update Metastorm a database table in the database database External Lists functions used to read and write information in other than database Metastorm databases adaptor Datestamp text You use this option to format a date time value for display format Delete external You use this option to specify th
321. ifying Folderld as the FlagRaiser The flagged action will only start if the Folder ID in FlagRaiser matches the FolderID of the folder upon which the flag is acting e This folder s parent Use this option in the case of a sub procedure when the action should be invoked only as a result of a flag raised by the parent folder A While you can use the Only start action if property on the Do this tab to check whether a flag was raised by or through the external interface on behalf of a particular folder it is much more efficient to select either the This folder or This folder s parent options If you select Any folder the Metastorm Engine will inspect every folder in the stage from which this flagged action is drawn to determine whether its Only start action if formula evaluates to TRUE By using This folder or This folder s parent the Engine will check only folders awaiting flags from this specific folder 100 May 2008 Metastorm Inc 2008 Designer User Manual Defining a Flagged Action s Roles Properties Properties Enrol Loopback options Remove from To Do lis Rebuild To Do list Leave it Figure 64 Flagged Action Roles Tab The Roles tab is available only when the Flagged action is a loopback action The Roles tab allows you to select one of two options available for a loopback Flagged action e Rebuild To Do list Selecting this option instructs the system to regenerate the list of users
322. igner User Manual Column Type Column Type Properties dialog Column Type properties note Number Number column eFolder eFolderID CI Minimum _ Maximum Decimal places e Check the Minimum or Maximum checkbox to select the minimum or maximum value allowed for the field if required Select the number of Decimal places The values entered into this column will be formatted to the specified number of decimal places Text Text column eFolder eFolderID oO Maximum Mask Alignment Left Center Right Check the Maximum checkbox and enter the maximum number of characters allowed in the cells of this column The maximum value is in the range 1 to 250 Select the mask icon to enter a text Mask amp Y Refer to section on Defining a Text Field s Options Properties for information on Masks Select Left Center or Right to set the alignment of the text in the cells Currency Currency column eFolder eFolderID Decimal places Currency symbol 0 C Minimum Symbol position Before number Negative number style C Maximum Before number Refer to the section on Defining a Currency Field s Currency Properties for information on the currency column property options Table 25 Grid column type properties 8 Repeat these steps for each column in the grid Metastorm BPM Release 7 6 May 2008 219 Metasto
323. igner User Manual The Safety threshold defines the end range of the Safety state while the Danger threshold defines the beginning of the Danger state The following diagram illustrates how the Safety and Danger thresholds are used to determine the state of the field if Safety threshold is less than Danger threshoid 4 range of values a or Safety Warning Danger Value is less than or equal Value is greater than the Value is greater than or to the Safety threshold Safety threshold and less equal to the Danger than the D anger threshold threshold Safety threshold Danger threshold if Safety threshoid is greater than Danger threshold 4 range of values Danger Warning Safety Value is less than or equal Value is greater than the Value is greater than or to the Danger threshold Danger threshold and less equal to the Safety than the Safety threshold threshold I j Danger threshold Safety threshold Figure 133 Status field states 4 If the thresholds are calculated to the same value a Warning state is not possible If in addition the 8 P value is the same as the thresholds values the status field will be in the Danger state The following examples demonstrate how the state of a status field is determined depending on its thresholds and current value Example One The KPI Dashboards sample administrative procedure includes a Process Performance Dashboard administration form This displays metrics r
324. il Library Mail XEL It sends an email to the specified users copying the specified cc and bec lists with the specified subject message attachment and reply address Arguments Recipient list a string containing the To list for an email delimited by semicolons CC list an optional string containing the CC list for the email BCC list an optional string containing the BCC list for the email Sender a string containing the email address of the person who sent the message Subject a string containing the subject for the email Message Body a string containing the body of the email Body is HTML a boolean expression indicating whether the message body is HTML Attachments a string containing a semi colon delimited list of file names Use SMTP Server a boolean expression A value of True indicates that an SMTP server should be used False indicates that a pick up folder should be used SMTP Server Pickup Folder a string containing the name of the SMTP server or the folder from which email messaged are picked up for sending depending on the value of the Use SMTP Server parameter Port Number If this optional string parameter is empty or 0 then the default server port number specified in the machine configuration will be used Returns String A string value indicating whether or not the function call was successful 404 May 2008 Metastorm Inc 2008 Operators General Operators Designer User Manual These are used
325. imit accessto Evaluat everybody All registered e work users ework Administrator The designated e work Administrators ework Guest Non registered e work users __ originator The creator of the e work Folder SSelects Originator Figure 169 Role Entry 4 From the dropdown list of maps see Figure 169 above Assign the role to the common roles list select Common from the drop down list Assign the role to a specific map such as Flight select that map 5 Enter role name and a description in the Role and Description fields A role name cannot be longer than 31 characters and may only include letters A Z or a z numbers 0 9 underscores and spaces Non US English characters and extended characters may not be used in a role name A role name cannot duplicate the name of a user defined in the Users and Roles utility Metastorm BPM Release 7 6 May 2008 249 Metastorm BPM Release 7 6 6 If you need to enter a formula you can do so by Typing in the formula in the space on the line entry Click on the Formula editor button and create the formula through the Formula editor or Click on the Integration wizard button and create the formula through the Integration wizard A When a formula is being defined only custom variables from the selected map or sub map may be used When adding a text field to a form in a sub map care must be taken if the procedure has not been published If the IW is invoked
326. in a calculated memo field Metastorm BPM Release 7 6 May 2008 307 Metastorm BPM Release 7 6 SERVER ACTION RESULT DESCRIPTION CATEGORY oe Return script text Call a script and return a value value Run async Start a script on a separate thread script Run inline Run a script and wait for it to complete script Save Copy an attachment from a folder to a file attachment Run server You use this option to specify that Metastorm BPM is to run an application application on the server where the Process Engine is running Save folder to Writes the values of all of the folder variables Custom file variables and Metastorm variables to a comma separated values file The first line of the file will consist of field names and the second will consist of values Send email You use this option to specify that Metastorm BPM is to construct and send an email message You may specify email addresses or the names of any intended recipients Note To use this option the name of the recipients must exist in the address book for the mail system in use If you want the names to be created dynamically you can click on the Integration wizard button or type a formula in the field You can also use the Formula editor to create a formula You can specify that the message be created dynamically by clicking on the Integration wizard button or type a formula in th
327. in use If you want the names to be created dynamically you can click on the Integration wizard button or type a formula in the field You can also use the Formula editor to create a formula You can specify that the message be created dynamically by clicking on the Integration wizard button or type a formula in the field You can also use the Formula editor to create a formula You can also specify the address where reply messages will be sent if the mail system in use supports return addresses Email list memo Return an email address list corresponding to a list of Metastorm users This will extract the email address from User details or the cached information from a directory if the Directory Integration Suite utilities are in use Get email address text Get the email address of a specified user Print merge document When defining properties for an action you can specify that Metastorm BPM is to print a document containing data from the folder If you wish to merge data from the Metastorm folder into a Microsoft Word document you must set up a Word document with merge fields The names of the merge fields in the Word document must be exactly the same as the names of the variables in the Metastorm folder If there are merge fields in the Word document that do not exist in the Metastorm folder the print will fail If there are fields in the Metastorm folder that do not exist as merge fields in the Word document
328. ine MakeDate 2 week Figure 55 Do this Tab 1 For user actions only to specify a command to be evaluated immediately after the action is started enter it in the When action started property For example you might use this to preset form data before loading a form Do not use the following variables in the When action started property for the creation action Folder originator SOriginator Folder name SFolderName When stage started SEntryTime Action name SAction Name None of these variables have any value until after a folder has been created or in the case of When stage started not until the folder has entered the first stage If used they will either return a blank or the form will not load at runtime 2 For non user actions only to specify whether Metastorm BPM should pursue the action enter a condition in the Only start action if field The action is evaluated immediately before it is invoked and the action start only if it evaluates to TRUE 3 To specify processing after the action is completed such as updating a database printing a document or driving an external application enter a command in the When action completed field Defining Notes Properties The Notes tab of the Properties editor displays a memo field which the process designer may use to make notes These notes will not be seen by end users Metastorm BPM Release 7 6 May 2008 91 Metastorm BPM Release 7 6 Defining Sim
329. ined through the Format tab of the Properties editor The remainder of the form s appearance is determined through the layout placement of form elements 19 To define a background image for the form click on the More Pictures button above the image viewing area Designer will display a standard File Open dialog allowing you to browse for the image you wish to use When the image is selected it will display in the image viewing area and the Clear and Preview buttons will become available If no image is selected the viewing area shows None To see a preview of the selected picture as a background click the Preview button To delete a background image from the form click on the Clear button 20 The Form Size property in pixels includes two fields Height and Width The default height of the form is 320 pixels To change this initial height make your selection from the Height field The default width for the form is 512 pixels To change this initial width select a value from the Width field The form can also be resized by dragging its borders Metastorm BPM Release 7 6 May 2008 135 Metastorm BPM Release 7 6 A The user may also resize the form when they view it although placement of form elements will remain consistent with your design 21 To select the default font for the form scroll through the available drop Select the font format button a to change font color style and size a If you anticipate that
330. ing queue definition You can use this function to remove an out queue definition Business Rules Lists all Metastorm formulas that call Business Rules Execute a Rule You use this option to execute a business rule on a Business Rules Engine using the specified custom variables Get Rule result You use this option to execute a rule on a Business Rules Engine using the specified custom variables and return a result Event Handlers Lists Metastorm External Event options External Event Handler You can use this function to create custom extensions To use this feature the Process Events Library must be associated with a procedure For further information refer to Appendix B page 392 or Process Orchestrator for NET Designer s Guide pdf External Event Handler boolean You can use this function to create custom extensions for conditional actions To use this feature the Process Events Library must be associated with a procedure For further information refer to Appendix B page 392 or Process Orchestrator for NET Designer s Guide pdf Metastorm BPM Release 7 6 May 2008 319 Metastorm BPM Release 7 6 Table 41 Glossary of Integration wizard Server Categories CLIENT ACTION RESULT DESCRIPTION CATEGORY IKRE Form extensions Functions you can use in a form s client extensions Run a form Runs a client side script when the form is loaded script
331. ing Mask Picker If the data is incorrect a rejection message is displayed Information i 4 is not valid text For this mask Figure 143 Data rejection using Mask Picker d When satisfied that the Mask is correct click OK The selected data mask is displayed in the Mask entry box of the Properties editor and Any data entered into the Test field is discarded 208 May 2008 Metastorm Inc 2008 Designer User Manual e If there are no suitable formats in the Mask Name list select Browse using the Browse button to a folder with a suitable mask collection file type of dxm file 6 amp Y For details of the DXM file format refer to Appendix E Masks Format A If the text field is an optional field on the form the user may leave the field blank and still have the field pass validation even though a text mask property has been defined If the mask set in the Properties editor represents required input the field must be made a required field on the form amp For users who want to develop their own Regular Expressions for text masks refer to http www regular expressions info 6 Inthe Properties editor Options tab the field type is displayed in the Type field A drop down list can be used to change the type of field To do so select the Type dropdown List The dropdown list displays options for Drop Down Radio Group Date time and number 7 Select the type required The text box o
332. ining a Currency Field Values are entered in a currency field as numbers and will be displayed in the specified currency format when the user tabs out of the field Values will be rounded according to Bankers Rounding a Using Bankers Rounding values below 0 5 are rounded down and values above 0 5 are rounded up Values of exactly 0 5 are rounded to the nearest even number The following numbers are rounded to two decimal places using Bankers Rounding 10 874 becomes 10 87 10 875 becomes 10 88 10 876 becomes 10 88 10 884 becomes 10 88 10 885 becomes 10 88 10 886 becomes 10 89 To add a currency field click on the Currency button on the form toolbar and then click on the location on the form where you want the field to be displayed Designer places a currency field on the form and displays the corresponding Properties editor The Properties editor displays five tabs for defining currency field properties e Currency 158 May 2008 Metastorm Inc 2008 Designer User Manual Options Do this Extra Notes amp For details of the Extra tab and the Notes tab refer to section 6 4 3 Defining Element independent Properties on page 139 Defining a Currency Field s Currency Properties Properties Currency1 urrency1 Dataset folder Variable calculated Caption Figure 102 Currency Tab The Dataset field allows you to select a dataset for the system to use with this field
333. ion in the database as shown in the following table Option Function Process Engine gt Database Designer gt Database Administrative Tools gt Database email Clients gt Process Engine gt Database Web Client gt Web Server gt Process Engine gt Database Table 1 Metastorm Component Database Access Requirements Applications providing Metastorm client facilities require access to the database through the Metastorm Process Engine These components will not function if you bypass the Process Engine 1 2 Design Basics Before using Metastorm BPM for the first time you should be familiar with the terminology used in this environment and have a basic understanding of the concepts of business process design 1 2 1 Concepts and Vocabulary Familiarize yourself with the following Metastorm terms before proceeding Each of these terms will be discussed in greater detail later in this manual amp Y For further information refer to the Metastorm Concepts guide e Procedure Metastorm BPM views the information activities and instructions required to automate a business process as a procedure In Metastorm BPM the main component of a procedure is one or more maps In addition to the maps a procedure may contain forms roles flags external tables and scripts All of these components are stored in a single procedure file Each of these items is described briefly below 7 Map When you design a Meta
334. ion process and ensure that any calculation formulas that reference a NewLine which returns a Carriage Return and Line Feed pair are updated to reference a LineFeed which just returns a Line Feed character where necessary MakeDate count units direction from Arguments count a number of time units to count units a string specifying the units of duration as follows minutes or mi hours or h days or d weekdays or wys weeks or wks months or mo years or y If omitted or empty it defaults to days direction a string specifying the direction in which to count as follows before or b after or a from a date time from which to count Returns date time the date and time which is the specified count of time units before or after direction the date and time from For example MakeDate 1 days after System Time Same time tomorrow 374 May 2008 Metastorm Inc 2008 Designer User Manual Max value value2 Arguments value one of a list of numbers or currency values whose maximum value is required One or more values may be passed in Returns number or currency the highest numeric or currency value in the list If all the values that are passed in are currencies or cast as currencies the highest currency value is calculated and returned else the highest numeric value is returned For example Max CurrencyValuel CurrencyValue2 highest currency Max NumberValuel Numbe
335. ions Personalized Menus and Toolbars Menus show recently used commands first Show full menus after a short delay Reset my usage data Other Cl Large icons Show ToolTips on toolbars Cl Show shortcut keys in ToolTips Menu animations None Figure 11 Menu Option Dialog 3 Make your selections from this dialog and select Close A You may change your customization choices at any time Metastorm BPM Release 7 6 May 2008 33 Metastorm BPM Release 7 6 The menu items described on the previous pages are presented in their default arrangement If you customize your menus to show recently used commands first the menu options described will not necessarily appear in the same order as described above 1 3 3 Toolbars There are three toolbars in the Designer main window e General toolbar e Map toolbar and e Form toolbar These toolbars provide access to the options you need to define modify and save procedures Each of these toolbars can be displayed anywhere on your screen as a floating palette or docked to the top bottom or side of the main window e To move a toolbar from its docked location position the cursor over the ridge at the left of the toolbar and click and drag it to the new location e To reposition a floating toolbar click anywhere in its title bar and drag it to the desired location If you have resized the Designer to be too narrow for all of the buttons on the toolbars to be displaye
336. ions provide a mechanism by which data can be entered modified or evaluated within the folder Metastorm BPM Release 7 6 May 2008 83 Metastorm BPM Release 7 6 Table 14 below summarizes the types of actions their purpose the rules that govern their use and the Properties editor tabs used to define their properties again whenever the folder is updated by a loopback action on that stage loopback actions Conditional actions may not be drawn from the start box If you draw more than one conditional action from a stage they will be evaluated in the order of priority set on the Action tab of the Properties editor Action Purpose Rules Properties editor Tabs User Invoked by a user and possibly You can draw user actions from Action requiring the user to enter data on any stage except an archive Form ty a form You can draw user actions to any Roles bemm stage except a common stage Do this User actions can be loopback Notes actions Simulation Any number of user actions may be drawn from the start box If you draw more than one user action from a stage they will be shown in the client folder in the order of the priority set on the Action tab of the Properties editor User actions are the only actions that can display a form to the end user Timed Initiated automatically at some You can draw timed actions from Action mm specified interval after a specified any stage exce
337. ip both multiple attachments and Document management support must be checked Document management support This option is checked to enable DMS support Edit only If this option is checked the Remove and Delete menu options are not available to the Process User Once a document has been uploaded or selected in a single clip the option Upload and Select will also be unavailable Default Location This option defines the default location of the DMS Provider 236 May 2008 Metastorm Inc 2008 Designer User Manual 7 3 4 Dependants A DMS multiple attachment clip and a DMS single attachment clip can have dependant fields Field has dependants of its own is available on the Do This tab For further information refer to Dependencies section 7 3 5 Edit Only This option could be used for different actions on a procedure for example create a form with full access to a DMS clip and assign to an action Then create another form with the same variable and DMS clip and assign to an action but check Edit Only Then the review is only able to review and not remove or delete 7 3 6 Creating a Dynamic Default Location 1 Click on the Formula Editor button Mall 2 Use the character to invoke the custom variable context menu to embed dynamic content in the default document location amp Default Location Formula Editor E ioj x File Edit Search View Help Ob S Al DB tal D gt S amp amp i
338. ir To Do or Watch lists is not regenerated Selecting this option instructs the system to update the folder data affected by the action but not to re evaluate the users on the To Do and Watch lists This is the default option A The Remove from To Do list is not a valid option for a loopback Timed action and is inactive Metastorm BPM Release 7 6 May 2008 99 Metastorm BPM Release 7 6 Defining a Flagged Action s Flag Properties Properties Enrol Properties Enrol Flag used to invoke this action This Folder Folder which must raise the flag or on whose behalf the flag must be raised if it is not to be ignored Any folder vi Figure 63 Flagged Action Flag Tab Select the flag that is to initiate the Flagged action from the list in the Flag used to invoke this action field This is a list of all flags defined for the procedure The default value is blank nothing selected You can define the Flagged action so that it only acts on folders with the specified relationship to the folder that raised the flag This relationship is established in the Folder which must raise the flag property The options are e Any folder Use this option when the action should be invoked no matter which folder raises the flag This option should always be used for an action that creates a new folder e This folder Use this option to respond to a flag raised by an external application via the eRaiseFlag interface spec
339. is check field the Field has dependants of its own check box will be displayed on this tab of the Properties editor This field instructs the system immediately to notify the Metastorm Engine of any change to this check field This is necessary if any other fields on the form are dependent upon the content of the check field 3 The Calculation formula field is only available if the variable was set to Calculated on the Check tab This field calculates whether the value of the check field is TRUE checked or FALSE unchecked You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 4 The When changed field appears only if a variable was assigned on the Check tab In this field enter any command the system is to perform when the contents of this check box are changed For the commands in the When changed field to be performed when the field is updated the Field has dependants of its own checkbox must be checked 5 Inthe Client extensions field enter any commands to be performed by the system when the focus is given to the checkbox and when focus is removed You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Def
340. is parameter is not currently used Alt Delimiter an optional string specifying the delimiter to use in place of a comma Returns text information for the specified attribute as a result of the filter expression applied to the specified directory For example LDAP Search Directoryl objectClass inetOrgPerson cn M Return the cn attribute value from every inetOrgPerson entry in the location specified by the Directory1 alias Impure Functions Impure functions are those that have some side effect such as writing to a file or database or sending an email They may or may not return a result throughout this section those that do not return a result are shown as commands and those that do return a result are shown as part of an assignment command Impure functions should only be used in the following properties e Stage When stage completed e Stage When stage started 388 May 2008 Metastorm Inc 2008 Designer User Manual e Action When action completed e Form When user saves form e Button field When button pressed e Grid field When user selects row The following impure Metastorm functions are defined Delete filename Arguments filename a string identifying the server directory path name and extension to be deleted Returns condition TRUE if filename was deleted from the server file system FALSE otherwise For example Delete C Windows Temp Temporary file tmp Us
341. is secctestisinss nite tiie oineatitsn isto sede eaestaben a ei 195 Defining a Signature Field s Signature Properties essecsscsecseeeeceseeecesecseeeenees 196 Defining a Signature Field s Do this Properties eceescsessesecneeeeceseeecesecaeeseenees 197 Defining a Status Fieldin irre ge iet E e EERE tarts ante EEES 198 Example One e a EE EE ne nee aie E A RE 199 Example TVO een neces E A A A cae nies aes 200 Example D oi ne EE EO EEE EA E E Nee Bae Stee 201 Defining a Status Field s Status Properties sesesesseesseseesesesrsesreerersssesrsreerereerseerees 202 Defining a Status Field s Options Properties seseeeseseeeeeseseseseeeerererrsesrsreererrersesreee 203 Defining a Status Field s Do this Properties seseeeeeseeeeeesesesrereersressrserreererrereerees 204 Detinme a TextField nene ances eee ch antes is eels sab go cakes E dese boas 204 Defining a Text Field s Text Properties cceeecssesessecsseeeceseceeseceeeecaeeeesaeeaeeseenees 205 Defining a Text Field s Options Properties ecsecessssceeceseceeesecneteeceseeecsaeeaeeseenees 206 Defining a Text Field s Do this Properties 2 00 0 cseeeecseseceseeeeesecseesecereeceeceeeeeeaees 209 Using a Text field to add a link to the form eee eeeeseceseeeeeseceeesecneeeeesaeeeeeaeeaees 210 Defining a Gido 3 8 Gils Raita tie ae eee neta ee aeons eee ates 212 Grid Types nhir ig eeetihai ead inating E E e a Ea aa E R KE aiae 212 De
342. is to return the folder ID of the folder if any of which this folder is a child folder A folder will have a parent folder if it has been created in a Sub procedure or if it has been cloned from another folder or if it has been created by a flag creation action and the flag has been raised by another Metastorm map Its parent will be the folder that caused it to be created Its parent could also be explicitly set by means of an Assign command Folder priority integer You use this option to return the priority 0 to 9 set for this folder Folder stage text You use this option to specify that Metastorm BPM is to return the name of the stage at which this folder now is Folder subject text You use this option to specify that Metastorm BPM is to return the subject defined for this folder Get child date Date time Returns a date time value from a child folder time Get child integer Returns a number value from a child folder number Get child text text Returns a text value from a child folder 312 May 2008 Metastorm Inc 2008 Designer User Manual SERVER ACTION RESULT DESCRIPTION CATEGORY ae Procedure Integer The version of the current procedure version When folder Date time You use this option to specify that Metastorm BPM is to return created the date and time that this folder was originally created When folder Date time You use this option to
343. isplayed on this tab of the Properties editor This field instructs the system to immediately notify the Metastorm Engine of any change to this list field This is necessary if any other fields on the form are dependent upon the content of the list field A This box must be checked if any other fields are dependent upon values in this field 5 Enter any commands to be performed by the system when this list field gains focus or loses focus in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Memo Field Use a memo field to display or edit a memo value A Process designers should be aware that if memo fields are to be used for holding XML data limitations exist The character sequence gt will result in an error To avoid this error a client side script should be used to convert this sequence to gt To add a memo field click on the Memo button on the form toolbar and then click on the location on the form where you want the field to be displayed Designer places a memo field on the form and displays the corresponding Properties editor The Properties editor displays four tabs for defining memo field properties e Memo e Do this e Extra e Notes amp For details of the Extra and Notes tabs refer to
344. ist A If you change the field type after you have defined the field s properties be sure to review the properties for the new field type Metastorm BPM Release 7 6 May 2008 193 Metastorm BPM Release 7 6 Defining a Radio Group Field s Do This Properties Properties Radiogroup1 Properties Radiogroup1 Calculation formula C Field is dependent on another Client extensions Figure 130 Radio group Options Tab Use the Do this tab to specify the calculation formula dependencies and processing to be carried out if the contents of the radio group change 1 Ifthe radio group may be updated as a result of a change to another data field or grid that has dependants or as a result of a button being pressed click on the Field is dependent on another check box A If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab 2 The Calculation formula field allows you to specify how the contents of the radio group are calculated This field is visible only if you selected calculated as the field s variable You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 3 Ifa custom variable has been assigned to the radio group the Do this tab will display a Whe
345. ist Field s List Properties ccseesecseeecseesecsseeecesecseesecneeeecasereeeeaees 179 Defining a List Field s Options Propertices cc eeceeeceseseceeceeesecnerseceaeeeceaeeneeseenees 181 Defining a List Field s Do This Properties 0 0 0 cecscsescssssecesecreesecnersecaeeecsaeeaseseeners 182 Metastorm BPM Release 7 6 May 2008 vii Metastorm BPM Release 7 6 Define a Memo Field ispao erep an destin TE aE rE eea e aE ERE 183 Defining a Memo Field s Memo Properties sceescssseceseeecesecseeeeceeeeeseeeeeeeeaees 184 Defining a Memo Field s Do This Properties ccescsessecsseeceseceeeecneeeecaesereeeeaees 185 Define a Number Field Srne rietsen e eee ob destin eileen ap Ne a NES TE ea 186 Defining a Number Field s Number Properties ssseeesseeeeseeeseeeererssrsrsreererereseserreerees 187 Defining a Number Field s Options Properties esssesscssssesecseeeeceseeeceaeeneeseenees 189 Defining a Number Field s Do This Properties 20 0 0 ecseesccssescessecseesecnereeceaeeeeeaeeaeee 190 Defining a Radio Group Field assessuri n EE R A 191 Defining a Radio Group Field s Radio Group Properties csseeecseeeceseeeeeseenees 192 Defining a Radio Group Field s Options Properties esscsssecseeeeceeeeeceseeeeeseeeees 193 Defining a Radio Group Field s Do This Properties essecssecseeeeceeeeeceseeeeeseeaees 194 Defining a Signattive Field is c
346. isting topic The originator or an Administrator can close any topic at any time Metastorm BPM Release 7 6 May 2008 347 Metastorm BPM Release 7 6 Appendix B Formula Components Formulas should not be confused with client extensions The Process Engine evaluates formulas whereas the Client evaluates client extensions This appendix does not address client extensions Type face Conventions Throughout this appendix the following type face conventions are used e formula data types are shown in italics e function arguments and element properties are shown in bold italics e optional arguments are shown in brackets e optionally repeated arguments are shown in braces e code examples are shown in bold monotype with comments in regular monotype General Syntax Metastorm formulas are composed of the following types of elements e Variables these may be built in variables or custom folder variables which are defined within Designer for each map e Field data e Function calls e Operators e Literal values e Comments Comments comprise any text preceded by a double slash up to and including either the end of the formula as a whole or a new line Comments are stripped out by the Metastorm Designer s Publish function and are not stored into the Metastorm database or interpreted by the Process Engine Metastorm BPM recognizes any string of letters digits and underscores starting with a l
347. itted on this folder to date This will be zero during a creation action and one when the creation action has been committed This variable is always read only Archived Boolean Indication of whether a folder is archived Returns True if the folder is or has ever been at an Archive stage else returns Fal se This variable is always read only Category text 31 Used to categorize folders under the control of the designer Metastorm BPM Release 7 6 May 2008 107 Metastorm BPM Release 7 6 Variable Name Variable Parameters Type size CreationTime date time The date and time at which the folder s creation action was committed This variable is always read only Deadline date time Used to control timed actions that are based on the folder s deadline EntryTime date time The date and time at which the folder entered its current stage This variable is always read only Folder D text 31 The unique internal identifier for the folder This variable is always read only FolderName text 31 Auser readable identifier for the folder which may or may not be unique This variable is preset when the folder is created from the map s Folder prefix and Length of numeric suffix properties but may be changed during an action MapName text 31 The name of the map within which the folder was created This variable is always read only Messag
348. ized complex type value e format manually define the return string format Returns FormatComplexType returns a formatted string FormatComplexType Example In the example below the function GetClientRecord is used to obtain the client record which is equal to the ID entered in the intInputID field memGetClientRecord stores XML The XML is used by the FormatComplexType function to extract the client record details with user defined text into the memFormatComplexType field Metastorm BPM Release 7 6 May 2008 119 Metastorm BPM Release 7 6 First action FormatComplexlype Metastorm BPM Server Metastorm BPM DER P coal intInputiD 2 Get Client Record memGetClientRecord lt xml version 1 0 encoding utf 16 gt lt ClientData xmins xsi http www w3 org 200 1 XMLSchema instance xmins xsd http www w3 org 200 1 XMLSchema serializedFormat Xml type ClientData ClientCasesService Version 0 0 0 0 Culture neutral PublickeyToken null gt lt CompanyName xmins http tempuri org gt ABC Corporation lt CompanyName gt lt ContactFirstName xmins http tempuri org gt Brian lt ContactFirstName gt lt ContactLastName xmins http tempuri org gt Smith lt ContactLastName gt lt Address 1 xmins http tempuri org gt ABC House lt Address1 gt lt Address2 xmins http tempuri org gt 27 High Street lt Address2 gt lt Area xmins http tempuri org gt ABC Town lt Area gt
349. kaged up and passed into the entry point s args argument Table 37 Syntax Elements A If you need to input a quoted string as a parameter you will need to place a sign in front of the beginning and ending quote See the above example 5 When finished click Save amp Close Mill When the procedure is run the script will be called In this example when the button Get Time is pressed a dialog will be displayed showing the current system time Display System Time 3 28 49 PM3 14 01 Get Time Figure 221 Get Time button script displaying system time 10 2 3 Calling Client side Scripts Client side scripting allows Metastorm clients to interact with other applications Client side scripts may be attached to a form or form segment or they may be common to the procedure Functions called in client side scripts are synchronous and do not return a value The following events are provided to trigger a script e Clicking a button Metastorm BPM Release 7 6 May 2008 Metastorm BPM Release 7 6 Entering a field Exiting a field Loading a form Submitting a form Canceling a form Entering a grid Exiting a grid Exiting the cell of a grid You can use the Integration wizard or the Formula editor to call scripts to trigger these events A Only one script call may be attached to each event Calling a Client side Script through the Integration wizard To attach a client script
350. l request thereby ending the procedure 24 May 2008 Metastorm Inc 2008 Designer User Manual e A request for a business class flight is directed to a VP for second approval while a request for a coach flight goes directly to the travel department after initial approval e Travel plans may be changed or cancelled ending the procedure before the scheduled flight date e A request may be approved travel scheduled and the flight taken ending the procedure Identify Reusable Elements If you identify tasks that will be performed more than once within the process consider creating a library Libraries can be used to store common map segments forms form segments scripts roles LDAP aliases and IW collections When an existing library is associated with a procedure its contents become available to that procedure amp Refer to section 2 for information on using Metastorm libraries Run a Simulation of the Procedure and Analyze the Data Metastorm BPM provides business managers with a modeling tool which they may use to create Metastorm process maps and run a simulation of the automated business process The simulation data can then be analyzed through a separate simulation tool For advice on use of the simulation tool contact Metastorm Inc By providing simulation data in the procedure and then exporting it to a simulation tool business managers or process designers can test and refine the procedure during the design process
351. l text Return the email address of a specified user address Metastorm Lists functions used to read and write information in the database database Datestamp text Format a date for lookup in any database using a SQL format format Delete Delete an attachment from a folder attachment Delete You use this option to specify that Metastorm BPM is to delete Metastorm rows from the database table rows Execute You use this option to specify that Metastorm BPM is to procedure execute a database stored procedure Execute stored You use this option to specify that Metastorm BPM is to procedure execute a database stored procedure Arguments may be of any data type Insert You use this option to specify that Metastorm BPM is to insert Metastorm rows into the database table row List Metastorm text You use this option to specify that Metastorm BPM is to read a data list of values from one column of the database and return them as acomma separated list of unique values This is typically used to populate a drop down field or other list in a form New text Place a file from the server on an attachment clip field in a attachment folder Read Date time You use this option to specify that Metastorm BPM is to read a Metastorm date and or time value from the database date time Read integer You use this item to specify that Metastorm BPM should read Metastorm a number from the database number Read text You use this item to spec
352. le 20 Possible Do This tab properties e When button pressed In this field enter any commands the system must perform when the button is pressed You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog e Open folder 154 May 2008 Metastorm Inc 2008 Designer User Manual In this field you can specify a folder to be opened when the button is pressed This folder must be identified by its folder ID You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog New folder action In this field enter the name of the starting action you wish to use to create a new folder You may enter the name of any starting action that displays a form e g a user action When the Command button is clicked the form associated with the specified action will be displayed and a new folder will be created You must also enter the New folder map or the name of an admin form New folder map In this field enter the name of the map that contains the specified New folder action or the administration form group for admin forms Client extensions In this field enter any commands the system must perform when the button is pressed You may
353. le specified in the sExecuteRule function The Metastorm Rules Service web service uses the Business Rules Engine the NET assembly Metastorm FolderData class and any specified system and custom variables to execute the rule 7 Ifrequired the Business Rules Engine uses the Rules Service web service to return a value to the Metastorm Engine The following diagram illustrates the process Execution business Rules GET RULES Engine Business Rules Composer Create rules based on Metastorm data FUNCTION CALL Figure 204 Use of Business Rules Engine with Metastorm BPM The following subsections describe in more detail the use of the Designer to design a process Metastorm BPM Release 7 6 May 2008 283 Metastorm BPM Release 7 6 Selecting the Execute a Rule or Get Rule Result Integration Wizard Item 1 Access the Execute a Rule or Get Rule Result Integration Wizard item by starting an instance of the Integration Wizard for example from a Rules event selecting the Business rules category then selecting the Execute a rule item assigning a value to a variable by starting an instance of the Integration Wizard and selecting the Business rules category then selecting the Get rules result item or from a calculation formula Integration Wizard Rules Executes a Rule using a Rule Engine Category Hide invalid Action and form information a Execute a Rule i
354. lect a role in one field it will be automatically deselected from the other field A Ifa user holds a role on both the To Do and Watch lists he will only see the folder on the To Do list as its setting will take precedence A When a folder arrives at a stage the Metastorm Engine generates alerts for each user that should see the folder on his To Do or Watch list Since this can be a relatively time consuming process the Engine prepares these alerts on a separate thread thus allowing it to process other tasks simultaneously This approach avoids performance degradation however there are drawbacks For example if immediately after arriving at a stage the ToDoList or WatchList functions are used the functions may reflect out of date information i e the users on the To Do and Watch lists from the previous stage The manual workaround to this is to apply the same roles as are specified in the originating stage However this won t be available from a common stage In the case of a loop back action with the Remove from ToDo list option this could be handled via an additional ExecSQL to delete the entry from the eAlert table Defining Do This Properties Properties Sales Administration EJ When stage started a Subject Enquiry from Org j gt When stage completed all i Scale None Priority Scale under 3 Months 1 Figure 49 Do This Tab This tab is used to specify
355. led using the functions Script ScriptEval and ScriptAsync e Client side scripts are scripts executed on the machine running the client These scripts may be attached to a form or form segment in the Scripts dialog or may be common to all forms in the procedure and are called in association with specific events through Client Extensions Note that client side scripts may only be written in VBScript or JScript Scripts may be common to a procedure or library or specific to a form map form segment or map segment The following table outlines the availability of server and client side scripts Procedure Script Type Associated with Available to call from or Library Procedure Client Common Any form in the procedure Procedure Client A Form The specific form Procedure Client A Form Segment The form segment and any form the form segment is associated with Procedure Server Common Any map in the procedure Procedure Server A Map The specific map Procedure Server A Map Segment The map segment and any map the map segment is associated with 288 May 2008 Metastorm Inc 2008 Designer User Manual Procedure Script Type Associated with Available to call from or Library Library Client Common Any form in the library or the procedure in which the library is used Library Client A Form The specific form Library Client A Form Segment The form segment and any form the form segment is associated
356. lement individually Many of the properties you will modify through the Properties editor require you to enter a formula In most cases these fields will include options for calling on the Integration wizard and the Formula editor amp Instructions for using these tools may be found in Section 10 Creating Formulas Metastorm BPM Release 7 6 May 2008 71 Metastorm BPM Release 7 6 3 2 1 The Start Box The Start Box is represented by the clapper board icon on a map It is a default element placed on the map representing the starting point of the procedure There are several restrictions applied to Start Boxes e You can move the Start Box within the map but you cannot remove it from the map e You cannot draw conditional timed or rendezvous actions from the Start Box e You cannot draw an action to the Start Box Creation Actions Actions that leave the Start Box are called creation actions You can draw any number of user creation actions and any number of flagged creation actions Each creation action may be associated with a different form and may or may not go to the same stage If you want to use different forms to initiate the same map for example for different levels of staff use a separate creation action for each form 3 2 2 Defining Map Properties The Properties editor displays three tabs for defining Map properties e Map e Stages Order e Notes Defining a Map s Map Properties Properties Flight
357. lert message 358 May 2008 Metastorm Inc 2008 Designer User Manual Session FlagRaiser string read only ID of the folder which raised the flag that triggered a flagged action or of the folder specified in the Raise Flag call This will be empty for any other kind of action This variable should be used only in the following properties e Map Subject but only if the map is initiated by a flagged action e Flagged action Only start action if Note that using this property is considerably less efficient at run time than specifying a Folder which must raise the flag if the intention is to check the value of Session FlagRaiser e Flagged action When completed e Flagged action Alert message System Name string read only When the Engine starts a database lookup is performed against the eServer table System Name is the cached value of the eServerName column This variable should not be used in the following property e Field Variable since the variable is read only System Roles list read only list of all roles defined in the Metastorm database This variable is evaluated via a database lookup and thus may have an effect on performance It should not be used in the following properties e Field Variable since the variable is read only e Stage Auto forward folders to System Time date time read only current date and time as the Process Engine evaluates the formula This variable should not be used
358. lick on the Formula editor button to open the Formula editor dialog Defining an External Form s Notes Properties The Notes tab of the Property editor displays a memo field which the process designer may use to make useful notes but which will not be seen by end users To use this field place your cursor in the field and type your comments 6 5 3 External Forms Issues The process designer should be aware of the following issues when designing procedures using external forms Euro symbols in PDF forms Due to differences in the character sets supported by Windows and Adobe Acrobat the use of the Euro symbol in fields on PDF forms is not supported While the symbol can be typed into the field on the form when the folder is submitted and re opened the symbol will not be displayed Viewing PDF files Opening and then closing a PDF file when a PDF action or blank form is displayed causes the form to be blanked out It is recommended PDF files are not viewed while a PDF action or blank form is open If you design a procedure that uses PDF forms ensure that users are aware of this Integration Wizard The three Integration Wizard options in the Form Extensions category Run a form script Run a submit script and Run a Cancel script are not supported for external forms Metastorm BPM Release 7 6 May 2008 231 Metastorm BPM Release 7 6 7 DOCUMENT MANAGEMENT SUPPORT Metastorm BPM provides a Document Management Support DMS
359. lick on the Yes button the latest existing version of the library is loaded and the procedure is opened amp Library Loading Status Library Sample Library Database Metastorm The library is available in the database but has not been loaded or updated Version used in procedure 1 Version in database 2 Library Sample Library Database Metastorm The library has been updated to the latest version in the database and will be stored when the v Figure 38 Latest existing version loaded e If no version of the library is found you may choose another database to search or choose to remove the reference to the library from the procedure amp Library Loading Status The following libraries are not available within this database Metastorm Library Mail Version in procedure 1 Trying to access Mail cannot be found in this database Try another database Figure 39 Library not found Summary The following table summarizes the scenarios described above Scenario Outcome A library with a matching version number is The library is loaded and the process designer is notified found A library with a matching version number is The process designer is prompted to choose whether to found Another version of the library also exists use the current version or the latest one in the database A library with a matching version number is The latest version of the library is automatically loaded found A versi
360. lished before a client can access its blank forms and take part in the process When a procedure is published its components are stored in tables in the database Formula Formulas can be used to direct the action of procedure components They are evaluated by the Process Engine amp Refer to Section 10 and Appendix B for further information on Metastorm formulas Administration Forms Administration forms can be used by the user to carry out administrative processes Administration forms Do not start a process Are not available for use in maps Cannot access custom variables Cannot access system folder variables Are not associated with any folder Cannot be renamed Administration forms are automatically associated with a creation action that leads to an Archive stage amp Refer to the Administration Guide for details of the sample Administration forms External Tables External tables can be used to store configuration data reference table data or any other data related to the procedure Scripts A process can contain VBScript or JScript files that can be run client side and VBScript JScript or JScript NET files that can be run server side Libraries Libraries can be created to store map segments form segments scripts and LDAP aliases ready for re use When a library is associated with a new procedure its contents become available to that procedure amp Form and map segments are described in
361. list of all users registered with Metastorm BPM will be displayed in the drop down list If you want the list to be built from a column or columns of a database table you would need to select a function such as List Metastorm data for single values or List Metastorm label value pair for label value pairs from the Integration wizard options Items in the list are separated by delimiters The default delimiter is a comma an alternative delimiter can be specified as set out in the Delimiters section below amp For more information refer to Section 10 Creating Formulas Type the list items directly into the field This is a simple method to use when you have a relatively short list Either type the items directly or click on the Formula editor button and type the list items into the Formula editor field separating items with a comma or an alternative delimiter see Delimiter field below You may mix typed options with formulas For example you may type the first line as Other and define the second line to be a formula that extracts a list from the database table These values will be evaluated when the form is loaded or if the field is specified as dependent whenever any field specified as having dependants is changed Metastorm BPM Release 7 6 May 2008 173 Metastorm BPM Release 7 6 To use negative numbers parentheses and percentage signs in a dropdown list the following should be taken into account Any item
362. ls will be made through the same HTTP connection when available A The Connection KeepAlive header can be overridden by the IIS server Metastorm BPM Release 7 6 May 2008 417 Metastorm BPM Release 7 6 UserAgent string Summary Sets the user agent string for SOAP calls Remarks The user agent string allows a Web server to identify the client PreAuthenticate boolean Summary Sets the base URL of the XML Web service the client is requesting Remarks When PreAuthenticate is true the WWW authenticate header is sent with the first request if the authentication mechanism supports doing so When PreAuthenticate is false a request is made to the XML Web service method without initially attempting to authenticate the user If the XML Web service allows anonymous access then the XML Web service method is executed If anonymous access is disallowed a 401 HTTP return code is sent back to the client In response authentication credentials are returned to the Web server If the client is authenticated and subsequently authorized to access the XML Web service the XML Web service method is executed otherwise the client is denied access RequestEncoding long Summary Sets the base URL of the XML Web service the client is requesting Remarks The RequestEncoding determines the encoding for the request message The ContentType of the request will be annotated with the encoding value 0 System Text ASCIIEncoding 1 Sy
363. luding commands which update external databases send emails print files write files or raise Metastorm flags will not be undone 3 If you are using a Rules stage use the ExecuteRule function to specify in the Rules field any rules to be executed a Although you can also use the ExecuteRule function in a standard When event the advantage of executing a rule from the Rules property of a Rules stage is that the rule is executed after the form is submitted rather than as part of Submit processing so that control is returned to the client sooner 4 To specify processing to be carried out when the folder leaves the stage for another enter one or more commands in the When stage completed field A An archive stage has no When stage completed property 5 For a system stage the Auto forward folders to field allows you to specify a new stage to which a folder should proceed immediately after entry to this stage regardless of any actions leaving the stage You can use this property to allow end users to specify the next stage for a folder The default is for this property to be empty which causes the folder to remain at the System stage A Do not use Auto forward to move a folder to another map segment This interferes with the Engine s ability to determine where the folder should re enter the current map segment when it is archived in the target map segment The value in this property can be a variable evaluated for each folder
364. m cccsccccccccssecssscecsessssessseeeeseeecesetseseseaeeeeaeteeeeeeneneeas 374 PMax valued VQlUe2 scsccecciassccedisces Bisse bose eles vb E Cees ished ee A Via aC RR Ces 375 TOMGK AIST eccehat hase eA ss ig EG ac apaas dae deat BEAD Dee SE a bag Rasy AE DO 375 JoMin valued valie2 ccccccccccccccccssececessssssssceesscssesccssessesesssesssesscsessscasecesssesasssscseesscaseseenaeees 375 TOMA LSE EESE AEE EEA E Aa Sas eae A ea Sanne 376 JoMonths start date months cccccccccccccsscsscescescsscescssecscesesssssseseesscssesecsseessesscssesscascseesscsaesessacees 376 TONE VERO 2 citestin E leash oe Geo Ooo GO RAE OEE PEERED 376 TONE WINE EEEE A E EE S AEE A EE 377 ToRern dividend divisor Juranin aa E A R E E aE 377 RemoveEntry list index delimiter essesesesrsrsesrsrsrseerorororeroroeseeeoeseoeseoeseseeeseseseseseseseeesesee 377 JReplace source Old NEW COUNT Jiurisisriiisiiseiiisi intari i iiie ES ENEE ESENTE 378 Round number decimals round down cccccccccsseccsssscssessesseescesecscessessesscseeescssesessaeees 378 PSubstring start length string Q ccccsecccccscsceseseccccescecesesecscseeeseseeeseceaeeceaeeeeeeeaeeeeaeeeeeeeeaeeeees 379 o Weekdays start date AAYS ccccccccscsssscssssssssessssessssessessssessessssessessssessesessesaesasesaeeeeseaeesaeeasees 379 ACCESS PUNCHONS siccescesssescnsseascedsesscssnssntsasecesesscecensssedsssess essessssnsasosctecesssassssaecsevesedesostiseuctecoecsconsates
365. m BPM Release 7 6 May 2008 23 Metastorm BPM Release 7 6 Determine Necessary Information The type of task being performed determines the information needed and the routing of that information For example if you are building a map to handle incoming support calls you will need to collect information concerning e The customer name company account number contacts e The product identification item model number purchase date service agreement e The support call details action taken follow up calls support representative handling the call The information you require will determine the forms you will need to create to accompany your procedure Determine Possible Outcomes A procedure may have several possible outcomes that may affect the route a business process follows from start to finish For example in the sample Flight procedure Designer Sample Procedures Flight shown in Figure 5 below Pa Justify Flight request Question e Traveler P i Approve Withdraw Iia 1 9 Check class a Automatic withdrawal ha J Change flight YP flight request a Warning Travel Department Booked Y fl Flight taken Cancel flight ai A Flight taken Awaiting flight Withdrawn Figure 5 Flight Map The map includes routings based on the following possible outcomes e An employee may be asked to justify their travel request e An employee may cancel or withdraw their trave
366. m BPM is to read a list of values from two columns of an external database and return them as a comma separated unique list This is for use in populating a dropdown or grid dropdown column with label value pairs The label is shown in the field and the value is passed to the database List files memo You use this option to specify that Metastorm BPM is to list the contents of a file directory on the server and place the list in an memo variable This may be used to display the directory listing in a calculated memo field List published roles list You use this option to specify that Metastorm BPM is to return the list of all roles published on the Metastorm server List registered users list You use this option to specify that Metastorm BPM is to return a comma separated list of all users login Ids registered to use Metastorm BPM List selected users list You use this option to specify that Metastorm BPM is to return a list of users with one or more specified attributes in common The attributes will be taken from the Metastorm attributes table NEW LINE text You use this option to specify that Metastorm BPM is to insert a new line into a memos or to search for a new line ina memo New note memo You use this option to specify the text to be saved as the note for this action Read file memo You use this option to specify that Metastorm BPM is to read the con
367. m Inc 2008 Designer User Manual The options to chain actions and re open folders are not available on actions that result in a System Sub procedure or Archive stage 3 For security purposes it is advisable to avoid the use of chained actions and the re open folder option in procedures that may involve Public Access A It is not possible to chain between actions associated with PDF forms and actions associated with HTML forms A When chaining to an action associated with an HTML form be aware that if the user cancels the HTML form the original folder will remain on display A The two checkboxes described above are mutually exclusive i e they cannot both be checked If neither box is checked the user will be returned to the desktop when the action is submitted 3 Select the form to be used from the Form drop down This list is generated from the forms associated with this map and any common forms associated with this procedure If you select none the default value you can check the Confirm action checkbox to specify that a dialog is displayed requesting confirmation that the action should be committed If you select a form the Properties editor will display an extra grid listing the fields on the form Specify how each of the fields is to be displayed for the user who undertakes the action To do this click on the usage column for the field and use the dropdown Depending on how the fields properties have been defined yo
368. me of the currently executing action as defined in the procedure map 356 May 2008 Metastorm Inc 2008 Designer User Manual This variable is populated when an action is started on a folder and cleared when the action is completed The field may not be cleared if the action form is closed without the action being submitted or cancelled For example the browser is closed without the action being completed This variable should not be used in the following properties e Stage Auto forward folders to since this is evaluated by a subsequent hidden action which is always named gt e Field Variable since the variable is read only e Roles Formula since it may have a different value every time the formula is evaluated Action Name is not displayed on a folder page However if a folder is locked by another user who is performing an action the Action Name is displayed on a folder form Action Notes string read write memo to be written to the selected folder s audit trail if and when the current action is committed Until and unless assigned to it will be empty The result may subsequently be read back from the audit trail in a folder or action form using the read only Notes array variable When used in a form this variable will always be empty when the form is shown in a folder It should not be used in the following properties e Stage Auto forward folders to since this is evaluated by a subsequent hidden action
369. message cLang Figure 225 Properties editor Client extensions field completed When the procedure is run the script will be called In this example when the button Show Alert is pressed a dialog will be displayed showing a welcome message Microsoft Internet Explorer A This is a welcome message Show Alert Figure 226 Show Alert button script displaying welcome message Calling a Client side Script through the Formula Editor To call client scripts using the Formula editor 1 Open the Properties editor for a selected item on either a map or a form Metastorm BPM Release 7 6 May 2008 301 Metastorm BPM Release 7 6 In this example we will be defining properties for a Button so the Button Action option Client operation was selected on the Button tab of the Properties editor Properties Button1 Properties Button1 Caption Client extensions Select Transmission Hint Default action usage optional Button action Client operation Q Figure 227 Properties editor 2 Click on the Formula editor button Lab The Formula editor opens 3 Type in the string needed to call the desired script Client extensions Formula Editor OnC lick we lcomemessage cLanguage JScript Figure 228 Entering a Client script in the Formula Editor The following table shows the string needed for the five client events Client Event
370. mple library A number of the sample procedures make use of a sample library Sample Library xel Before publishing these procedures the sample library must be published By default the sample library is also installed to C Program Files Metastorm BPM Designer Sample Procedures amp S For further information about libraries refer to Section 2 of this document Setting roles for the sample procedures Use the Users and Roles tool to establish the users for the procedure and associate them with any roles that the procedure may use If you wish you may add yourself as the only user giving yourself the Administrator role and use the Set Up sample procedure to add additional users To evaluate the procedure on a single machine in a testing environment you may find it convenient to temporarily change all of the To Do List roles in the procedure to everybody Alternatively use the Users and Roles tool to temporarily assign all roles to yourself Using the Set Up sample procedure The Set Up procedure can be used to prepare the sample procedures for use It sets up users and role information and external table data See below for further information The remainder of this Appendix contains notes on the sample library and on each of the sample procedures Sample Library This library contains the following sample forms used by other sample procedures e The Notes form displays in a memo field a historical summar
371. ms Dialog A If any External Form file types have been previously defined they will be displayed in the dialog screen 3 To review the properties of one of the predefined file types select the file type from the list and then click on the Edit button To add a new file type to the list click on the Add button m Designer displays the External Form dialog box If you have selected one of the predefined file types most of the fields will already have information displayed If you are adding a new file type all of the fields will be blank Metastorm BPM Release 7 6 May 2008 225 Metastorm BPM Release 7 6 External Form Extension htral Description html forms Form designer Form interface C Program Files Metastorm Designer EW fd Figure 156 External Form Properties Dialog 4 In the Extension field type the file extension for the new file type 5 In the Description field type a brief description of the file type This description will be displayed in the main External Forms Options list 6 Inthe Form designer field enter the path and filename of the application used to create and edit the new file type Selecting the Browse button on this line will open a standard File Open dialog allowing you to browse for the application file 7 Inthe Form interface field enter the path and filename of the external forms interface DLL A If you have installed Metastorm BPM using the standard de
372. mum and minimum value for the field and for a number field associated with a real variable the number of decimal places 1 To set a minimum size for the number field check the box marked Minimum In the Minimum field specify the smallest value that may be entered into the number field 2 To set a maximum size for the number field check the box marked Maximum In the Maximum field specify the largest value that may be entered into the number field You cannot set a Maximum value lower than a Minimum value For example if you set the Minimum option to 10 the lowest possible Maximum value will automatically be set to 10 In addition even though valid maximum and minimum values have been set if the number field is an optional field on the form the user may leave the field blank and still have the field pass validation If the values set in the Properties editor are required minimum and maximum values the field must be made a required field on the form 3 Inthe Decimal places field specify the number of decimal places the field should display This field will be unavailable grayed out if the number field is associated with an integer variable 4 The field type is displayed in the Type drop down list If you wish to change the type of field you are working with select the new type from the list A If you change the field type after you have defined the field s properties be sure to review the properties for the new field ty
373. n Changed option instead of a calculation formula In the When changed field enter any command the system is to perform when the contents of this radio group are changed For the commands in the When changed field to be performed when the field is updated the Field has dependants of its own checkbox must be checked 4 Ifyou selected a system variable or created a new custom variable for this radio group the Field has dependants of its own check box will be displayed on this tab of the Properties editor This field instructs the system immediately to notify the Metastorm Engine when one of this radio group s options is selected This is necessary if any other fields on the form are dependent upon the content of the radio group 194 May 2008 Metastorm Inc 2008 Designer User Manual A This box must be checked if any other fields are dependent upon values in this field 5 Enter any commands to be performed by the system when this radio group gains focus or loses focus in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Signature Field Use a signature field to add a signature to a form Users completing the form may or must if the field is required provide an electronic signature which will be recorded in the Metastorm
374. n Windows Clients or single clicks in the Web Client on a Field has dependants grid e Edit grid 212 May 2008 Metastorm Inc 2008 Designer User Manual The client user may add or remove rows and update the data and in an Edit grid e Folder grid The Folder on Folder feature may be used with a Folder grid amp Y Refer to the section on Using a Grid to set up Folder on Folder for further details None of the above grid This is a basic grid No refills will occur when the user clicks on a None of the above grid If formatting is required the appropriate column type must be selected amp Refer to the section on Defining a Grid s Columns Properties for information on selecting column types To choose the type of grid click on the relevant Grid Type radio button on the Grid s Do this tab Designer places a grid on the form and displays the corresponding Properties editor The Properties editor displays five tabs for defining grid properties e Grid e Columns e Do this e Extra e Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Properties Figure 147 Grid Tab Metastorm BPM Release 7 6 May 2008 213 Metastorm BPM Release 7 6 Defining a Grid s Grid Properties 1 2 4 If you wish to retrieve data from an external database enter the name of the
375. n and archive stages have no Roles tabs The role options displayed on the Roles tab of the Properties editor are determined by the roles listed on the Roles dialog of the current procedure amp For more information on defining roles refer to Section 7 Defining Roles or the Users and Roles chapter in the Metastorm Administration Guide The owners of these roles are determined by the Metastorm Engine when the folder is processed They are based on the role assignments made in Users and Roles or by the formula defined for the role in the Roles dialog The roles selected in the To Do list property and Watch list property on the Roles tab determine on whose To Do and Watch lists the folders will appear For the To Do list the default role for a stage is originator For a Watch list by default no roles are selected Folders at a System stage will not be placed on any users To Do list however they may appear on users Watch lists To set up folders to be available on the To Do and Watch lists 1 Inthe To Do list property select those roles that should have folders appear on their To Do list at this stage in this procedure Metastorm BPM Release 7 6 May 2008 79 Metastorm BPM Release 7 6 2 Select those roles that should have folders at this stage appear on their Watch list from the list in the Watch list property A The same roles may not have a folder appear simultaneously on both its Watch list and To Do list If you se
376. n inr Seek Ne Na SRA 365 ToASClCHAPACICN J oseyen a e soiled edb a a Ban Bae aba A ees 365 PERLO E Voria EE cada esas ask Oa Stats cies Lest Batu Sats da aan Ss Sa Le bua abana an bananas Lead etate a 366 JoConcatenate String string secccccescesesesecceceresseseseceeceneeceseseeecseaeeceseseeeceeaeeeeaeeeseeeaeeeeaeaeees 366 Count list delimiter Jesin a a A tee a Saba Bas dee cas 367 o Duration from to UnnitS V os Eres a ES EE ESKAE ESSES 367 WEMPTY J a o ra Wes aS Gs 368 Find substring instring case start_position ssssssesesssesesesesesesesesesesesessrsrsrsrsrererere 368 FindEntry list item delimiter ceccccccecsscsccscsssscssssscscsssesessssessesesseseeseseseseseseeseeeeseeseseasees 369 FormatCurrency currency value locale digits leading group decimal separator thousand separator negative order positive order currency SyMDo1L cece 369 FormatNumber number decimals width format cccccccsessscscssssesscsssssseesssesssesees 371 FormatTime timestamp format eeesesesesssesesesesesesesesesesesesesesesesesesesesesesesesesesesesesesesesseeeseees 371 JoGetEntry list index Aelimiter ccccccccccccsscsccsscecssssscsssssssesssssssessseessesesessseeeseesseeasesseseaeees 373 TOL CNG SUING Jir sarira a nA dlaeedtectatb ate Besdealeaa tiesesSiidatbavtadhions Mialens ease Ry lathes 373 OLIN EEE ED rennen cao sackets aa en Bs ON AEs eae a bi 373 JoMakeDate count units direction fro
377. n order to eliminate confusion create variables of the SAME name in both maps e g FirstName LastName in the sending procedure and FirstName LastName in the receiving procedure and assign both variables to the flag data to be passed e Inachild parent relationship if you want a child folder to share data with the parent you can pass data in a flag However if there is a large amount of data this is not the most efficient method In these instances it is more common to use a formula placed in a field on the Do This tab of the Properties editor to query the database directly 9 2 2 Flags Dialog When you are designing a procedure you can access the Flags dialog from the menu View Flags or by clicking on the Flags button on the General toolbar Policy Quote Premium Payment Common Figure 171 Flags dialog 1 You can add flags by either of the following methods Click the add icon on the Flags dialog lii or right click the mouse and select the Add icon from the pop up menu Press the Insert button on your keyboard Each of these options adds a new line to the list of flags Metastorm BPM Release 7 6 May 2008 255 Metastorm BPM Release 7 6 2 If the flag is to pass values from custom variables when it is raised specify the map to which the custom variables belong by clicking in the Map field in the Flags dialog and selecting from the drop down list All maps in the current procedure are listed Custom va
378. n the button Get Time is pressed a dialog will be displayed showing the current system time Display System Time 3 28 49 PM3 14 01 Get Time Figure 218 Get Time button script displaying system time Calling a Server side Script through the Formula Editor You use the Formula editor to call server scripts with the following functions e Script Synchronous returns no value The Metastorm program waits until the script completely executes before it continues processing e ScriptEval Synchronous returning a value e ScriptAsyne Asynchronous returns no value To access these commands via the Formula editor do the following 1 Open the Properties editor for a selected item on either a map or a form In this example we will be defining properties for a Button so the Button Action option Server operation was selected on the Button tab of the Properties editor Metastorm BPM Release 7 6 May 2008 295 Metastorm BPM Release 7 6 Properties Button1 Properties Button1 Caption Select validation Hint Eee Default action usage Button action Client operation Figure 219 Properties editor 2 Place your cursor in the field in which you want to call a script In the sample screen above the cursor has been placed in the When Button Pressed field 3 Click on the Formula editor button L The Formula editor opens You can enter functions and variables
379. n the form changes to the selected type and the Options editor displays the input options A If you change the field type after you have defined the field s properties be sure to review the properties for the new field type Defining a Text Field s Do this Properties Properties Calculation formula C Field is dependent on another Client extensions Figure 144 Text Do this Tab Metastorm BPM Release 7 6 May 2008 209 Metastorm BPM Release 7 6 Use the Do this tab to specify the calculation formula dependencies and processing to be carried out if the contents of the text field change 1 Ifthe text field may be updated as a result of a change to another data field or grid that has dependants or as a result of a button being pressed click on the Field is dependent on another check box a If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab 2 The Calculation formula field allows you to specify how the contents of the text field are calculated This field is visible only if you selected calculated as the field s variable You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 3 Ifa custom variable has been assigned to the text field the
380. n the left and right Parenthesis fields 7 Click on OK when you have finished building the condition The Integration Wizard is displayed with the entry in the Condition field Ifthe condition is not valid Designer will display a warning and you will need to correct it 270 May 2008 Metastorm Inc 2008 Designer User Manual 10 1 4 Add ins At certain points within the Integration wizard an ellipsis Mb nay be displayed When you click on the ellipsis an add in dialog box is displayed for the entry of additional information Integration Wizard Wher action completed o o anaoa Rule to be executed and the kbcation of the iule engine Pade lo eode Rule Engine Options O Uns latest vernon of palected ade Figure 190 Add in Dialog 1 Enter or select values for any fields in the add in dialog 2 Click on the OK button 10 1 5 Formula Editor In addition to the Integration wizard you may also use the Formula editor to create or edit formulas of a property Figure 191 Formula Editor Button This tool may be opened at any time by clicking on its button see Figure 188 above Using the Formula Editor To use the Formula editor Metastorm BPM Release 7 6 May 2008 271 Metastorm BPM Release 7 6 1 Once you have opened the Formula editor you may type into or edit the existing content of the field As you type you will notice that the content of the field will be color coded based on the type
381. nagement System Parameter e File Name the URL of the file to check out Returns e Integer data type ra If a document is already checked out a message is displayed to inform the user Delete Document This function deletes a document from the Document Management System Metastorm BPM Release 7 6 May 2008 239 Metastorm BPM Release 7 6 Parameter e File Name the URL of the file to delete Returns e Integer data type Download Document This function downloads a document from the Document Management System to the local file system Parameters e File Name the URL of the file to download e Local File Name the full path and file name where the document is to be saved on the local file system Returns e Integer data type Get Document Meta Data This function retrieves Meta Data for the specified document Parameters e File Name the URL of the document to query for meta data e Meta Data Column a comma separated list of metadata field name s to retrieve Returns e Text data type with a semi colon delimiter A The Meta Data columns that can be used are Metastorm Default Column Names the following column names can be used Title Modified ModifiedBy Created CreatedBy CheckedOutTo CheckInComment Custom Column Names use the display name The custom column name is case sensitive System Column Name for example vti_sourceversioncontrol Refer to the Micros
382. name of the stage that the action will move the folder to This is normally the target stage of the action as drawn in the procedure map If the action is a loop back then this variable will hold an empty string If the target is a system stage with its Auto forward folder to property set then this variable will hold the name of the stage to which the folder will be auto forwarded This variable is available only in an action form Form Name Text 31 Procedure Name text 31 The name of the current procedure Procedure Version text 31 The version number of the current procedure Session FlagName text 31 The name of the flag which triggered the action This variable is available only in a flagged action 106 May 2008 Metastorm Inc 2008 Designer User Manual 4 3 Folder Variables Variable Name Variable Parameters Type size Session FlagData column number memo The contents of the specified column of flag data This variable is available only in a flagged action Session FlagRaiser text 31 The Folder ID of the folder which raised the flag or via the Engine s automation interface for which the flag was raised This variable is available only in a flagged action System Name text 31 The name of the Engine evaluating the expression System Roles memo The list of currently published roles on this Engine s database System
383. nced parameter in a NET methods Metastorm BPM Release 7 6 May 2008 115 Metastorm BPM Release 7 6 the mapped Metastorm custom variables will be updated at the end of the method call using the object mapped fields and properties A The Complex Type Mapper reads custom variables from the database specified by the Engine DB registry key If you wish to read custom variables from a different database you must manually edit this registry key For an SQL database HKEY_LOCAL_MACHINE SOFTWARE Metastorm e work Engine Database Connectors SQL Server DBC Connection For an Oracle database HKEY_LOCAL_MACHINE SOFTWARE Metastorm e work Engine Database Connectors Oracle DBC Connection amp Y Refer to Appendix A of the Metastorm Process Orchestrator for NET Designer s Guide for a definition of simple NET data types 5 2 1 Columns There are four columns in the Map Complex Type e Complex Type the name of the complex type member and properties e Member Type displays whether the member is a class struct property or member e Variable select from a dropdown the Metastorm variable to assign to the member e Returned Format displays the returned serialization format To select a serialization format click on the Return Value button and select the required Serialization type using the serialization toolbar buttons 5 2 2 Toolbar The Map Complex Type dialog toolbar enables the user to expand and collapse complex type
384. ne values used to return a value into a property Access functions may also be nested as the argument of another function call The following access functions are defined CaptureAttachment folderID filename attachmentData This function allows a user to add a new attachment to an existing folder It can also be used to assign that folder to a clip field For this to work the user should assign the return value of this function to the clip field SclipField SCaptureAttachment folderID test txt SAction Notes 1 Remember the value returned may not be the same as the filename requested This is because a given folder can only contain one attachment with a given name Arguments folderID a string containing the Folder ID for the attachment filename a string containing the filename the Metastorm Engine attempts to give the attachment attachmentData a string containing the attachment s contents For binary files this should be Base64 encoded Returns string unique name given to the attachment by Metastorm BPM Dir path Alt Delimiter Arguments path a string identifying the server directory path whose files are to be listed Note that sub directories are not listed Alt Delimiter an optional string specifying the delimiter to use in place of a comma Returns a string containing the directory listing for the specified path obtained from the server file system with one file per line and th
385. nt field 5 The Default action usage field allows you to specify a default status for the Drop down field from read only optional hidden or required Use the down arrow associated with this field to select the desired default A If the Variable field is set to calculated only the read only and hidden options are available 6 The Caption alignment field contains a radio group listing following alignment position options Left Places the caption to the left of the drop down field Right Places the caption to the right of the drop down field Top Places the caption above the drop down field Bottom Places the caption below the drop down field Select the caption alignment desired 172 May 2008 Metastorm Inc 2008 Designer User Manual Properties Dropdown1 Properties Dropdoy List options Type Drop Down Figure 113 Drop down Options Tab Defining a Drop down Field s Options Properties Use the Options tab to specify the items to appear in the drop down list The items in the list are separated by delimiters The default delimiter is a comma but another character can be used as defined in the Delimiter field 1 Enter your list items into the List options field You may do this in one of two ways Open the Integration wizard and choose variables to populate the drop down list For example if you select the option List Registered Users from the Integration wizard a
386. ntoso Port to point to an Accelerator URL e g http localhost scripts eB2B Listener dll ID lt PartnerID gt amp amp Map Received PO To use the procedure copy the RegToApprove xmi file from the documents to pickup folder E For further details refer to Lesson 2 of the LearnBiztalk exe documentation For documents from Metastorm BPM to BizTalk server use on of the three ASP files provided eworkToXLANG asp eworkToFile asp and eworkToMSMQ asp Metastorm BPM Release 7 6 May 2008 345 Metastorm BPM Release 7 6 Send Mail This procedure demonstrates the sending of mail to an SMTP server or a folder It requires the Mail library Multiple Send First stage Archive A Archive Figure 247 Send Mail Procedure Points to Note The following fields are available on the Mail form e To addresses separated by semicolons e CC addresses separated by semicolons e BCC addresses separated by semicolons e Subject e Text or HTML e Sender e Attachments separated by semicolons e Pickup folder to which to send the mail 346 May 2008 Metastorm Inc 2008 Designer User Manual News This procedure provides for all users a process for maintaining a discussion database comprising a list of topics and associated note threads along with an Administration Form for browsing available topics by category Users can create a new topic add a note to an existing topic or simply view all notes for any ex
387. ntry events Metastorm BPM Release 7 6 May 2008 299 Metastorm BPM Release 7 6 4 Select a category and item and press Next to continue For this example the category Button extensions and the item Run a button script are selected The Client extensions screen is displayed Integration Wizard Client extensions The scripting language to be used Script call welcomemessage Language lt Back Next gt Finish Cancel Help Figure 224 Integration wizard Script Call Dialog 5 Inthe Script Call field type in the script call which must be included in one of the scripts that has been previously added to the Scripts dialog or the statement which should include the function plus any required parameters If any parameters require the use of quotation marks e g string values in VBScript use a percent sign in place of each quotation mark 6 From the Language drop down menu select the scripting language you are using VBScript or JScript In the example illustrated above the script language selected was JScript and the Script call welcomemessage will be made to the script Welcome_Message which was previously added to the Scripts dialog 7 Click Finish The Client extensions field of the Properties editor will now contain the completed script 300 May 2008 Metastorm Inc 2008 Designer User Manual Properties Client extensions OnC lick we lcome
388. nts selected or other actions performed in the creation of the procedure Dockable Menus The Menu bar can be displayed anywhere on your desktop as a floating palette or docked to the top bottom or either side of the main pane e To move the menu bar from its docked location position the cursor over the ridge at the left of the toolbar and click and drag it to the new location If you have resized your Designer window to be too narrow for all of the menu items on the Menu bar to be displayed two chevrons will appear at the end of the visible portion of the bar Clicking on the arrow will display the remainder of the menu items e To reposition the menu when it is a floating palette click anywhere in its title bar and drag it to the desired location 32 May 2008 Metastorm Inc 2008 Designer User Manual Personalized Menus As an additional feature Designer menus can be set to self optimize to provide the user with a personalized menu You can customize your menus by 1 Select View Customize or place the cursor anywhere in the Menu Toolbar and right click Select the Customize option to display the following dialog Customize i Commands Options r Toolbars an men F General 7 Map me I Form Close Figure 10 Customize Dialog 2 Check the Main Menu checkbox and select the Options tab The Options menu is displayed Customize Toolbars Commands Opt
389. o gt METASTORMI NMetastorm BPM Release 7 6 Designer User Manual May 2008 Metastorm Inc email inquiries metastorm com http www metastorm com Metastorm BPM Release 7 6 Copyrights and Trademarks 1996 2008 Metastorm Inc All Rights Reserved Copyright Notice n Metastorm Metastorm BPM e Work Process Pod Enterprise Process Advantage ProVision The Best Process Wins Proforma Metastorm Knowledge Exchange Metastorm DNA Metastorm Discovery STAR Insight Envision and Metastorm Enterprise are either registered trademarks or trademarks of Metastorm in the United States and or other countries Microsoft Outlook SQL Server Windows Vista Active Directory Visual Basic JScript SharePoint and BizTalk 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 retriev
390. ociated library is offline An offline library is one that is accessed from a file rather than from the Metastorm database This feature allows process designers to work on procedures without access to the Metastorm database To take a library offline click on its corresponding Work Offline checkbox in the procedure s Used Libraries tab eRT properties orb General Used Libraries LoaP Aliases Document Management Add Work Offline 7 Library Name v Version Published gt Description X Delete BRI Library 2 3 25 2008 4 45 03 PM u pdate J a 5 3 23 2005 12 31 26 PM Cancel Help p Figure 40 Work offline checkbox Metastorm BPM Release 7 6 May 2008 63 Metastorm BPM Release 7 6 To take a library offline 1 Open a procedure file that has a library associated with it Select File Procedure Properties and select the Used Libraries tab The Work Offline checkbox should be unchecked at this stage 2 Select the library file in the libraries list Check the Work Offline checkbox Designer takes a copy of the library file that is loaded and writes it to the designated file path A To set the file path choose View Options and enter the path into the Library Path Location on the File Locations tab 4 Click OK to close the Procedure Properties dialog and close the procedure When the procedure file is reopened with the Work Offline checkbox checked the library file is read from th
391. of the Properties editor for the list of stages where the Contact Report action will be visible The Contact Report is available to the checked stages The use of the Common stage avoids a separate loopback action contact report having to be drawn onto every one of the stages that the Contact Report has been applied to Metastorm BPM Release 7 6 May 2008 329 Metastorm BPM Release 7 6 The benefit of the use of the Common stage is that the map is less cluttered and easier to understand e Other features of note are the use of cascading visibility on the New Lead form The fields for Budget and Sponsor appear only if the user clicks Yes in the Project field The Budget Amount field appears only if the user clicks on Yes in the Budget field The Timescale field appears only if the user clicks Yes in the Sponsor field A See the Visibility field on the Extra page of the Properties editor for each of these fields to see how this was established The Contact Report form is also useful This report displays all of the notes and contact reports that have been added to this folder when each note was added and who added it This form allows the Sales Manager and others to view the progress of the folder and the notes that have been added to it at each stage 330 May 2008 Metastorm Inc 2008 Designer User Manual New Hire This procedure ensures that
392. oft SharePoint SDK help for a list of system column names For example Title vti_sourceversioncontrol ModifiedBy Set Document Meta Data This function sets Meta Data values for the specified document Parameters e File Name the URL of the file to modify e Meta Data Column the meta data column name to modify 240 May 2008 Metastorm Inc 2008 Designer User Manual e Variable select the variable containing the value to be assigned to the meta data column The variable can contain any data type Returns e Integer data type amp Y Refer to Get Document Meta Data for a list of valid column names Undo Check Out Document This function undoes the Document Management System document check out and reverts the document to a pre check out state Parameter e File Name the URL of the file to undo from the check out state Returns e Integer data type Verify Document This function verifies if a specified document exists Parameter e File name the URL of the file to verify Returns e Check data type Get Document Author This function returns the author of the specified document Parameter e File Name the URL of the file to return the document author Returns e Text data type Get Document Checked Out By This function returns the name of the user who has the specified document checked out Parameter e File Name the URL of the file to return name of the user who has checked
393. om variable if you are using a dataset for this list field If you are using a dataset select the column name the system should use to calculate the information for this field from the column names shown in the drop down list The variable you select on this tab of the Properties editor will determine the fields that appear on the list field s Do this tab If you are using a variable other than calculated Designer uses the variable name as the default caption for the list field 4 You can include a text string to give users a brief help message when the cursor rests over the field Type the message you want displayed in the Hint field 5 The Caption alignment field contains a radio group listing following alignment position options Left Places the caption to the left of the list field Right Places the caption to the right of the list field Top Places the caption above the list field Bottom Places the caption below the list field Select the caption alignment desired 6 The Default Action Usage field allows you to specify a default such as read only optional hidden or required for the List field Use the down arrow associated with this field to select the desired default 180 May 2008 Metastorm Inc 2008 Designer User Manual Defining a List Field s Options Properties Properties List1 List options Figure 121 List Options Tab Use the Options tab to define th
394. ommands Custom variables g Dates and times g Directory integration gP Microsoft Exchange adaptor gP Metastorm database g Extemal database adaptor g File adaptor g Folder information oe Form fields Lists and memos Microsoft Office adaptor gP Numbers gP Text functions gP Users and roles ClientCasesService ef ComplexTypeSupportLibrary Figure 71 Web Service Example 12 Click Next rs ional In the Do This for the Output fields set Field is dependent on another Select the event to use for accessing the web service such as the Get Client Record button in the example above Select the generated library and the method you wish to invoke which returns a complex Cancel Help z ClientCasesService addClientR ecord client M ClientCasesS ervice getAllClients ClientCasesS ervice getAllCountries ClientCasesS ervice GetArray fe ClientCasesService getClientR ecord Number Ey ClientCasesS ervice updateClientRecord client 112 May 2008 Metastorm Inc 2008 Designer User Manual Integration Wizard Assign value lt Value gt Select the Metastorm BPM custom variable s to map the complex return value Return Value Click on Mapper button to map complex type to variable s aJ ClientData ClientCasesService Version 0 0 0 0 Culture neutral E Number integer Figure 72 Complex Return Value Exampl
395. on you specify the roles allowed to perform this action An action is available to any user who holds the roles specified in this property no matter whether the folder is on their To Do list or Watch list If they do not hold any of the roles selected then that action button will not appear in the folder when they view it Select the Roles tab to display a list of roles defined for the procedure Select the roles from the Available to roles list You can use the To Do list role to include any users who have the folder on their To Do list This is the default value This role is not available for an action leaving the Start Box for which the default role is everybody You may select more than one role for example To Do List and Vice President Selecting a role in this property does not cause a folder to appear on a user s To Do or Watch list It only provides them with the authority to undertake the action if they can access the folder A Tf all the roles on the Available to roles list are unchecked the action is not available to anyone 6 amp Y For further information on using the everybody role refer to section 8 1 8 Using the everybody role Defining a Loopback Action s Roles Properties A Loopback action is any action that updates a folder but does not move it on to a different stage A loopback action updates the value in the database storing the time the folder was last updated but not the value
396. on of the library with a different version number but identical contents also exists in the database 62 May 2008 Metastorm Inc 2008 Designer User Manual Scenario Outcome A version of the library is found but the version The process designer may choose to use the latest version number does not match that which is stored in that exists in the database If he chooses not to use this the Procedure Properties library he may choose to delete the reference to the library from the procedure Alternatively he may choose another database in which to search for the correct version No version of the library is found in the The process designer may choose another database to database search or choose to remove the reference to the library from the procedure Table 11 Loading a library version A If versioning is switched off in the Library the version number will not be updated when the library is saved However an additional internal library identifier is updated This identifier is taken into account when loading the library with a procedure 2 3 3 Reverting to an Earlier Library Version It is possible to update a procedure so that it uses an earlier version of a library To do this first delete the reference to the library in the Procedure Properties dialog Next re associate the library by adding the required version 2 3 4 Working Offline It is possible to work on a procedure when the ass
397. on or select another map element to disable the multiple placement function Adding Comments to a Map Any number of comments can be placed on the map to provide additional information for designers To add comments 1 Click on the Comments button on the toolbar then click on the Map where the comment is to be placed A shaded box with a shadow outline is placed on the Map The Properties editor is displayed and A comments box is added to the Procedure Explorer 2 Inthe Properties box scroll through the available drop down list and select the font in which the comments are to be displayed 3 Click the font format button fal The standard Font dialog is displayed 4 Select the font text color and size required 5 Type the comments in the Comments field The comments are displayed in the Comments box on the map The Comments box can be repositioned by selecting it and dragging it to the desired location The Comments box may be resized as necessary Moving Map Elements To move a map element e Select the element by clicking on the Pointer button on the Map toolbar and then clicking on the map element Click anywhere on the element and drag it to its new position To move multiple elements select the elements and drag and drop the group selected To select the group of elements to be moved e Select the Pointer button Place your cursor over a point on the map click on the left mouse button to change the cur
398. on wizard 266 May 2008 Metastorm Inc 2008 Designer User Manual 7 From the Category column select Dates and times 8 From the Item column select Calculate date time Click on Next to continue The Assign Value dialog is displayed Integration Wizard Assign value lt Value gt The number of time units below to count Before After From s EntryTime Figure 183 Calculate Deadline 9 Define how the deadline is to be calculated and click Next The expression that has been defined is displayed in the original instance of the wizard You can open the Integration wizard again from this field if necessary Integration Wizard Assign value lt Value gt MakeDate 1 weekdays before sEntryTime Figure 184 Integration Wizard Value 10 Select Finish to close this instance of the Integration wizard The entry details are confirmed Metastorm BPM Release 7 6 May 2008 267 Metastorm BPM Release 7 6 The expression you just built is displayed in the Value field of the original instance of the Integration wizard Integration Wizard When action completed Select the variable to which a value should be assigned Variable Deadline Value MakeDate 1 weekdays before SEntryTime lt Back Next gt Finish Cancel Help Figure 185 Confirm Assigned Value 11 Click on Finish to close the Integration wizard
399. one item London England on one line of the drop down list a If the list contains a Metastorm BPM expression for example Y GetData or SelectSQL which uses a delimiter other than that specified in the Delimiter field the delimiter specified in the expression is used For example the expression GetData DBName DBTable Rows Column specifies that should be used as a row delimiter However if this expression is enclosed by another Metastorm BPM expression the delimiter specified in the expression is not used For example if the list contains the expression Replace GetData DBName DBTable Rows Column blah brahi 5 the delimiter specified in the Delimiter field is used Delimiters can be entered in one of three ways a In the Delimiter field type the delimiter character e g or The default delimiter is a comma which can be deleted Alternatively type the delimiter after the comma in which case the new entry overwrites the comma Delimiters must of a type that have Unicode values in the range 0 127 e g pipe carriage return CR and tab A delimiter can be entered as a character variable e g 7CHR Q Tab When the cursor is held over a character variable entry the character type is displayed 174 May 2008 Metastorm Inc 2008 Designer User Manual Carriage Return Figure 114 Delimiter description b Delimiters can be entered by using the Int
400. operators are 24 Below are two examples of possible dynamic role formulas For this example assume that sexampleVarl Paul Pascal sexampleVar2 Sarah Singalong sexampleVar3 false Metastorm BPM Release 7 6 May 2008 251 Metastorm BPM Release 7 6 Example One In this example the formula contains no operators sGetData exampleVarl sGetData exampleVar2 The data returned from this formula is Paul Pascal Sarah Singalong Example Two In this example the formula contains the operator cexampleVar3 exampleVarl1 sexampleVar2 The data returned from this formula is the string false Paul Pascal Sarah Singalong In order to have the formula evaluated it must be wrapped in a Evaluate function as follows o Evaluate exampleVar3 exampleVar1 exampleVar2 The data returned from this evaluated formula is Sarah Singalong Using LDAPSearch within dynamic role formulas The LDAP Search function returns attribute values of zero or more directory entries that match the specified search filter Each attribute is separated with a new line character which is the format required to fill lists and memo fields on forms Process Engine role lists must be comma separated and the presence of a new line character will invalidate the role evaluation so no users will appear to be on the list If SLDAPSearch results are to be used in a dynamic role form
401. ore convenient to work with other form fields if you place your dataset icons in an out of the way location on your form such as along a border Designer places a dataset icon on the form and displays the corresponding Properties editor The Properties editor displays four tabs for defining dataset properties e Dataset e Do this e Extra e Notes amp For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 162 May 2008 Metastorm Inc 2008 Designer User Manual Defining a Dataset Field s Dataset Properties Properties Dataset1 Properties Datasetl Figure 105 Dataset Tab 1 In the Database field select the database that contains the information you want to use for the dataset A list of available databases is provided in the drop down list The data sources available to you should have been created previously These data sources should be identified in the ODBC Data Source Administrator A If the Database field is left blank the Metastorm database is used 2 Inthe Username and Password fields enter the username and password required to access the database you selected 3 Inthe Table s field you need to specify which table in the database contains the information you want to use for this dataset Clicking the Pick table s button attached to this field will open the Pick Tables dialog box Metastorm BPM Release 7 6 May 2008 16
402. orm and stores the attachment itself in the attachment table You cannot associate a variable with a multiple attachment grid 4 You can include a text string to give users a brief help message when the cursor rests on the attachment clip icon Type the message you want displayed in the Hint field This hint will be displayed when the clip field has no file on it Once a file has been attached to the clip field the hint will display the name of the file 5 The Default Action Usage field allows you to specify a default such as read only optional hidden or required for the Attachment Clip Defining an Attachment Clip s Do This Properties Use the Do this tab to specify the calculation formula dependencies and processing to be carried out if the contents of the attachment clip change Properties Clip1 Pr gt S Clip1 Calculation formula Client extensions Figure 97 Clip Do This Tab 1 The Calculation formula field is displayed only if you have selected a calculated variable Specify the variable or formula to be used to obtain the attachment name in this field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog A In the case of an attachment clip the value is only the attachment name and not the attachment itself Metastorm B
403. orms in the Form dropdown This list includes forms from libraries associated with the procedure Parts that are held in an associated library use the syntax lt LibraryName gt lt PartName gt When using form segments from a library remember that form segments e Can be used only once per form e Cannot be nested i e they cannot contain other form segments e Adopt the same background color or image and font as any forms they are placed on When using map segments from a library remember that e Map segments belong to any maps in which they are used e Map segments can be used multiple times in a map e Custom variables that are defined in a map segment are available to and are part of the parent map that the map segment is used in Custom variables that are declared in a map segment will be added to the map table of the parent map e Custom variables that are defined in the parent map are not available for use in map segments e It is not possible to use custom variables from different libraries that have the same name but different types e Forms roles flags and scripts in the map segment are available to any maps in which they are used e If you attempt to re open folder or use chained actions on an action that leads into a map segment stage ensure that the first stage in the map segment is not a System Sub procedure or Archive stage It is not possible to re open a folder or chain actions at these stages Cli
404. ory column select Commands Metastorm BPM Release 7 6 May 2008 265 Metastorm BPM Release 7 6 5 From the Item column select Assign Value Click on Next to continue A new window will open Select the Variable Deadline from the drop down list available from this field Integration Wizard When action completed Select the variable to which a value should be assigned Variable Deadline Value Figure 181 Select Variable Type 6 To define the value click on the Integration wizard button next to the Value field Designer will open a new nested instance of the Integration wizard LS lotegration Wizard Whee action completed ooo coe oes Select the variable to which a walue should be assigned Variable Destre Vole t Integration Wizard Assign value Value gt The deadine shown om Watch and To De Bats fee ihis bobler hen E Hide imod P Nos secerty used a FIEIS EP Al tunctons oP Get chdd date tere Acton and for inknn op when folder created oP Corvenarsds op When folder leat updated O Cuon warisbier D When age dated O Dales and trees P Deeciupiriegaion gt Micsosott Exchange adaptor GP Neato BPM database GP Enemy database adaptor GP Fie adaptor hgh Foka nforratice op Forn bekit O Leth ond memor Nicsoeolt Oifis adaptor P Minten P Tet turctions Category v ier tee Figure 182 Nested instances of integrati
405. ou may not make a grid so small that the column name row is not visible If a list field is too short to display the entire list a vertical scrolling bar is created Note that e An attachment clip or a dataset field does not have a Width or Height field e You can neither resize nor crop an attachment clip or dataset field Defining a Form Element s Notes Properties The Notes of the Properties editor displays a memo field that the designer may use to make design notes These notes will not be seen by end users 6 4 4 Defining Element specific Properties All form elements have element specific properties as well as the element independent properties discussed in section 6 4 3 This section will address each form element s specific property tabs A general description of the form element is provided followed by a detailed presentation of each of the element s specific property tabs Defining a Frame or a Rule You can place any number of frames and rules on a form to divide it into separate areas Click on the Rule Frame button on the form toolbar and then click on the location on the form where you want the frame to be displayed Designer places a frame on the form and displays the corresponding Properties editor The Properties editor displays four tabs for defining Frame Rule properties 142 May 2008 Metastorm Inc 2008 Designer User Manual e Rule e Do This e Extra e Notes amp For details of the Extra t
406. oved using the Cut methods are saved in the paste buffer and may be pasted back onto the form or onto another form in the same procedure Form elements deleted using the Delete options Edit Delete or the Delete key are not stored However you may use the Edit Undo option to restore deleted items immediately Placing Form Segments on a Form When placing a form segment on a form the elements fields etc will appear on the form offset from the top left hand corner of where the form segment is placed by the same offset from the top left hand corner of where they are on the form segment For example if a date field is located at position 10 10 on a form segment and that form segment is positioned on a form so that it s top left corner is at position 15 20 on the form the date field from the form segment will display at position 25 30 on the form A Form segments cannot be placed in other form segments Bear in mind that the more form segments there are on a form the longer the form will take to display in the Designer and to publish It is recommended that a single form segment contains no more than 10 to 12 fields and that a single form includes no more than 3 or 4 of these segments 6 2 Properties editor Each of the elements of a form has certain default properties however in order for your process to function properly you may find it necessary to modify some or all of these properties This is done through the Proper
407. ox unchecked When the procedure file is opened again the library is read from the Metastorm database Updating the library offline While the library is offline you may open the file in the Designer make updates and save the file in the offline location To make these changes available online you must publish the library to the database before going back online If the library is taken online without publishing the updates the procedure will revert to the original version of the library in the database that was taken offline Metastorm BPM Release 7 6 May 2008 65 Metastorm BPM Release 7 6 3 MAPS The Designer uses one or more maps to represent the steps required to complete a business process A map describes graphically how to process a folder of a particular type A map consists of a number of stages where the folders await some action In addition a procedure may include system stages where folders are acted upon automatically by the system Stages are linked by actions A map contains the following elements e A single Start Box from which new folders are created e One or more stages where folders are held pending one of a number of possible actions typically a stage represents either the system or one or more users who must perform a particular task e One or more actions which update the contents of a folder and move the folder to the next stage e Any number of comments Maps are built by creating stages
408. part of an action the When user loads form command will be performed after the action s When action started command You should not use the When user loads form property to set field defaults for a blank form This should be done using the When action started property 2 Inthe When user saves form field enter any commands the system should perform when a user commits saves an action that uses this form whether as a page in a folder or as an Metastorm BPM Release 7 6 May 2008 137 Metastorm BPM Release 7 6 action form You may create the formula and edit it later as necessary using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog A If the form is being displayed as the result of a user taking an action commands will be performed in the following order 1 When action started 2 When user loads form 3 When user saves form 4 When action completed If the form commands in the When user saves form property fail the form will not be closed and the action will not be committed The user may choose to change the data and try again or cancel the action 3 Inthe Client extensions field enter any commands the system must perform when the form is loaded whether as a page in a folder or as an action form submitted or cancelled You may create the formula and edit it later as necessary using ei
409. pe Metastorm BPM Release 7 6 May 2008 189 Metastorm BPM Release 7 6 Defining a Number Field s Do This Properties Properties Number1 Properties Number 1 Calculation formula C Field is dependent on another Client extensions Figure 127 Number Do this Tab Use the Do this tab to specify the calculation formula dependencies and processing to be carried out if the contents of the number field change 1 Ifthe number field may be updated as a result of a change to another data field or grid that has dependants or as a result of a button being pressed click on the Field is dependent on another check box a If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab 2 The Calculation formula calculates the number that will appear in the number field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog 3 Ifacustom variable has been assigned to the number field the Do this tab will display a When Changed option instead of a calculation formula In the When changed field enter any command the system is to perform when the contents of this list field are changed For the commands in the When changed field to be performed when the field is updated th
410. pecial meanings in the databases that Metastorm BPM supports You should not use any of these reserved words when naming a form See the Reserved Words txt file for a list of reserved words This file is located in the Metastorm BPM Designer folder To use a form leave the External form check box unchecked amp For information about using an external form in place of a Metastorm form refer to page 224 The Tab order field shows a list of all foreground elements in the form button clip data field or grid This list will be updated as new elements are added to the form By default these will be listed in the order in which they are created To specify the order in which foreground fields receive focus when the Tab key is pressed at run time drag and drop the items until they are in the order you require The Tab key will ignore fields defined as read only 134 May 2008 Metastorm Inc 2008 Designer User Manual Defining a Form s Format Properties Properties Employee summary EJ Properties Employee summary lt None gt Font FF Verdana Color C White Restrict viewing to roles access Administrator v everybody ework Administrator ework Guest Facilities Manager Guest Hardware HR Assistant HR Manager Manager Metastorm Administrator Metastorm Guest Networks originator Figure 86 Format Tab The base appearance of a form background images color and fonts is determ
411. prefix the system should use for this procedure s folders enter the value in the Prefix of folder name field There is a 20 character maximum for the Map Prefix You may define several types of prefixes For example A short phrase such as Training Request for a training request procedure A keyword such as Travel for a travel request procedure An alphanumeric code such as MP for a motor pool resource allocation procedure Whatever type of prefix you select it should easily identify the procedure that generated the folder when the folder appears in a user s Watch or To Do list If you do not specify a value Designer uses the map name A If you change the Prefix of a folder name property after the procedure has been published and used the numbering of subsequent folders created using this procedure will be restarted at 1 4 You can specify the size of the auto incrementing numerical suffix used when generating a name for new folders created through this procedure There is a maximum of 9 characters for the map suffix Enter the number in the Length of numeric suffix field Designer will use pad out the field with leading zeroes if fewer digits are entered e g MP0032 To suppress the numeric suffix enter 0 To set the numeric suffix to contain no leading zeros enter 1 If you do not supply a value Designer uses the default of 4 5 If you want to change the icon used to represent the Start Box
412. presented by a clapperboard icon One or more initial user actions may be set to originate from the clapperboard as input into any stage Each action must have a unique name and may be associated with a different form Examples of such initial actions would be an incoming phone call or email message a request for information or services the beginning of multiple new projects etc Define and Prioritize Tasks The tasks required to complete the business process will be represented in your procedure as Stages and actions e Stages act as resting points within a business process At these stages the Process Engine or designated users can act on the folders e Actions represent the tasks to be performed at various stages throughout the procedure Actions may be Complex For example they may require the participant to enter information on a form Simple For example they may require approval before being passed on to the next stage of the procedure Other actions may be performed by the system based on information pulled from the database or provided by a user at an earlier point in the procedure Identify Participants The participants in your procedure are identified by their roles within the procedure a Keep in mind that the system may also be a participant in the procedure handling automated tasks In this case the system will be represented by a system stage rather than by a role assignment Metastor
413. property ES txtCountry ID property EJ intro a Figure 75 Complex Type Dialog When mapping a complex type to a Metastorm custom variable the following rules must be observed e Acomplex type the class or structure can only be mapped to a Metastorm memo variable If the complex type is an input parameter or reference parameter in a NET method the process designer must ensure that the mapped memo variable contains the serialized object at runtime This can be achieved either through JScript NET scripting or as a result of making another activated NET method call On the other hand if the complex type is an output parameter or reference parameter in a NET method the Metastorm engine will serialize the NET object to the specified memo variable using the specified serialization format If no serialization format is specified the default Binary format will be used e A complex type s public fields or public properties can be mapped to Metastorm custom variables Simple NET data types can be mapped to the appropriate Metastorm custom variable For complex data types the previous bullet point applies If the complex type is an input parameter or reference parameter in a NET method the Metastorm engine will create the object at runtime using NET reflection The public fields and public properties will then be updated using their mapped Metastorm custom variables On the other hand if the complex type is an output parameter or refere
414. pt an archive Time i event in the life of a folder You can draw timed actions to any Roles Loopback stage except a common stage Only Timed actions can be loopback Do this actions Notes Timed actions may not be drawn Simulation from the start box Flagged Initiated by the raising of the flag You can draw flagged actions from Action named on the Flag tab of the any stage except an archive Flag P Properties editor The flag may You can draw flagged actions to Roles Loopback be raised by an action on some any stage except a common stage Only other folder not necessarily in the Flagged actions can be loopback Do this same map or even procedure or actions by an external application via the Multiple tagged act b Notes event manager s DCOM or ultiple flagged actions may be Simulation command line interfaces drawn from the start box Conditional Initiated automatically on some You can draw conditional actions Action data condition Metastorm BPM from any stage except archive or Do this amp tests the condition first when the common stages Notes el folder moves into the stage and Conditional actions can be Simulation 84 May 2008 Metastorm Inc 2008 Designer User Manual Action Purpose Rules Properties editor Tabs Rendezvous Initiated automatically when those You can draw rendezvous actions Action folders defined in a subprocedure only from a sub procedure stage Maps hp stage as req
415. ptions list is evaluated 7 Ifthe action request indicates that it should be committed immediately The action s When action completed property is evaluated a b The Action to Stage is evaluated Q The action s Chained action property is evaluated d The action s Alert message property is updated e Ifthe action is leaving a stage the stage s When stage completed property is evaluated The new stage s When stage started property is evaluated f For each timed action the action s Timed Event property is evaluated g Any flag actions leaving that stage have their flag name evaluated If the action is not a loopback action or not a remove from To Do list action the To Do list and Watch list are evaluated i The action s Raise flag property is evaluated When a refill is requested 8 Ifthe refill is for a folder the folder s Available to roles property is evaluated 9 All fields in tab order that have a custom variable are updated 10 For the fields that caused the refill request the When Changed property is evaluated 354 May 2008 Metastorm Inc 2008 Designer User Manual 11 For all dependent fields in tab order a The field s data value calculation formula or custom variable is evaluated b If the field is a grid the column list is evaluated not a grid if the field has an options list for example Earliest Latest or a Dropdown s list the options list is evaluated
416. pts to enroll in a class the Apply for course action raises a flag to notify the Training Course map that it needs to know whether there is space in the class to accept the student That folder then waits in the Confirmation stage for the request action to raise a flag to signify that there is space in the class This signaling between folders also makes use of the Metastorm parent child folder relationship Each student enrolment folder assigns the relevant class folder as its parent See the When action completed command of the Apply for course action This is subsequently used to ensure that the correct class is checked when inquiring whether there are sufficient spaces to enroll the student Note that this procedure uses the following dynamic roles which are evaluated at run time based on data collected by the procedure Training Administrator 340 May 2008 Metastorm Inc 2008 Designer User Manual Training Department Metastorm BPM Release 7 6 May 2008 34 Metastorm BPM Release 7 6 Wizard This procedure demonstrates the use of chained actions to provide a wizard style interface uS Gi A Page Cancelled EE gt Page 1 Nets a r Page2 ea Page 3 W custom ae Finish gt Page 4 Finished Figure 243 Wizard Sample Procedure Preparation No special preparation is required for this procedure Points to Note As each action is completed the next action to be performe
417. r Guide which is provided with the Metastorm BPM Software Developer s Kit The custom Integration Wizard items will be available to any procedure with which the library is associated To associate custom Integration Wizard functions with a library 1 Add any scripts to be called by the custom Integration Wizard items 2 Create an Integration Wizard extensions file Metastorm BPM Release 7 6 May 2008 53 Metastorm BPM Release 7 6 3 Add the Integration Wizard extensions file to the library via the Library Properties dialog s Integration Wizard collection page 4 Click on the Open button and select a file to add Ifthe contents of the selected file are not in the correct format the file will not load successfully If the file loads successfully the custom Integration Wizard categories and items will be displayed in the list If an Integration Wizard extensions file has already been added to the library this will be overwritten when a new one is added It is possible to associate only one Integration Wizard extensions file with a library However the file may contain many Integration Wizard items and more than one library may be associated with a procedure You can export details of existing custom categories and items from a library to a new Integration Wizard extensions file by clicking on the Save As button and choosing a file name Flags Flags are supported in libraries only when they are associated with
418. r Library Each time you publish a procedure Designer records version information in the database This allows you to retrieve the most recent or previous versions of the procedure to refine the procedure or produce a template for a new business process a Keep in mind that the active procedure available to your users is always the most recently published version To retrieve a procedure 1 Click on the Retrieve button on the General toolbar E or 2 Select File Retrieve Metastorm BPM next displays the Database connection details dialog 48 May 2008 Metastorm Inc 2008 Designer User Manual 3 Enter your information and press OK to continue Designer will display the Retrieve dialog Each published version of the procedure is listed along with any descriptive information provided Retrieve Procedure Libraries header here to group by that column Procedure v Version Publish Time v Description BRI 1 07 06 2006 16 51 39 Flight 1 30 05 2006 12 58 03 Flight 2 21 06 2006 13 45 34 Lead Tracking 1 30 05 2006 13 47 57 Lead Tracking 2 07 06 2006 16 17 17 New Hire 1 30 05 2006 13 55 49 New Hire 2 07 06 2006 16 15 30 New Hire 3 08 06 2006 10 48 39 llau hiia A000 10 JMC 10 6 4 26 v Figure 24 Retrieve dialog 4 Select the Procedure tab then select the procedure you wish to retrieve from the list Click on OK to continue 6 To retrieve a library select the Libraries tab
419. r collection element will be used e delimiter specify a string delimiter to separate the array or collection items Default to a comma character e start index position in the array or collection to start creating the delimited string Default is 0 e end index position in the array or collection to stop creating the delimited string Default is 1 When the start index is 0 all items in the array or collection will be selected If the start index is not 0 then only a subset of items will be selected Returns GetList returns a delimited string GetList Example In the example below memReturnClients stores the XML containing all client data The GetList function is used to populate the memListClients field by setting item equal to company name Metastorm BPM Release 7 6 May 2008 123 Metastorm BPM Release 7 6 GetList ComplexTypes_GetAll Metastorm BPM Server SEE lt xml version 1 0 encoding utf 16 gt lt ArrayOfClientData xmins xsi http www w3 org 200 1 XMLSchema instance xmins xsd http www w3 org 200 1 XMLSchema serializedFormat Xml type ClientData ClientCasesService Version 0 0 0 0 Culture neutral PublicKeyToken null gt lt ClientData gt lt CompanyName xmins http tempuri org gt ABC Corporation lt CompanyName gt lt ContactFirstName xmins http tempuri org gt Albert lt ContactFirstName gt lt ContactLastName xmins http tempuri org gt Jones lt ContactLa
420. r dialog opened by clicking on the Formula editor button Defining a Label You can place any number of labels on the background of a form to display titles or fixed captions To create a label click on the Label button on the form toolbar and then click on the location on the form where you want the label to be displayed Designer will display a label field and the corresponding Properties editor The Properties editor displays four tabs for defining Label properties e Label e Do this e Extra e Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Metastorm BPM Release 7 6 May 2008 145 Metastorm BPM Release 7 6 Defining a Label s Label Properties Properties Labeli Sub process details Alignment Left Center O Right Figure 92 Label Tab 1 To select a different font use the drop down arrow to display the available fonts To change the font style click the More Fonts button to view additional options Designer updates the form to display the caption in the font selected for the form 2 The Alignment radio group allows you to select from the following options Left The caption text will be left justified within the caption field Right The caption text will be right justified within the caption field Center The caption text will be centered within the caption field A The caption tex
421. r magenta for quoted strings e Variable and function names are shown in blue e Function argument delimiters parentheses and commas and arithmetic and logical operators are shown in green You can also edit the formula directly without using the Integration wizard You may use the Formula editor to make any further changes required After you have made your selections from the available formula types the Integration wizard builds the expression for you and places it into the property field you selected The Integration wizard provides a list of categories and a list of items for each category Ifa property already contains a formula then the relevant category and item will be selected when the Integration wizard is opened Otherwise each property has its own default category that will be selected Each property also has an expected data type only items of compatible types will be displayed by default to show other items grayed out uncheck the Hide invalid check box above the item list A Variable names and function names are always preceded by a sign When editing a formula outside of the Integration wizard the percent sign must be included 262 May 2008 Metastorm Inc 2008 Designer User Manual When editing formulas you have the following options e To add anew line to the formula add a blank line and then click on Next e To edit an existing line select it and then click Next e To delete an existing val
422. r more information on creating datasets refer to the Defining a Dataset Field topic in this section 5 The Caption alignment field contains a radio group listing the following alignment position options Left Places the caption to the left of the check box Right Places the caption to the right of the check box Select the caption alignment desired Properties Check1 Properties Check1 Calculation formula ie Field is dependent on another Client extensions ols Figure 101 Check Do this Tab 6 The Default Action Usage field allows you to specify a default such as read only optional or hidden for the Check field Use the down arrow associated with this field to select the desired default Defining a Check Field s Do This Properties Use the Do this tab to specify the calculation formula dependencies and processing to be carried out if the user changes the value in the check box 1 Ifthe check field may be updated as a result of a change to another data field or grid that has dependants or as a result of a button being pressed click on the Field is dependent on another check box A If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this page Metastorm BPM Release 7 6 May 2008 157 Metastorm BPM Release 7 6 2 If you selected a system variable or created a new custom variable for th
423. r to provide the probability in percent Metastorm BPM Release 7 6 May 2008 93 Metastorm BPM Release 7 6 3 4 3 Action specific Properties Properties Change flight Properties Change flight C Re open folder C Chained action Form Flight request optional required required read only required read only Figure 58 User Action Form Tab Defining a User Action s Form Properties The Form tab of the Properties editor lets you specify the form to be displayed when the user action is initiated 1 When the Re open folder checkbox is checked the user is returned to the folder when the action is submitted 2 When the Chained action checkbox is checked the user is moved to the next action in the series of chained actions when the action is submitted If you select the Chained action checkbox you must provide the name of the action that should be invoked next You can do this by typing the action name into the Chained action name field or by using the Integration wizard or Formula Editor Chained actions allow you to break large forms into a number of separate smaller forms that are presented to the user in sequence It also allows you to direct the user to different sections according to the values they enter a See the Wizard sample procedure for an example of using chained actions The option to chain actions is not available in actions with no associated form 94 May 2008 Metastor
424. rValue2 highest number Max CurrencyValuel currency NumberValuel highest currency Max CurrencyValuel NumberValuel highest number oMax 9 99 2 50 5 95 9 99 Max list Arguments list a list of numbers whose maximum value is required Returns number the highest numeric value in list For example Max 9 9 9999 99 99 999999 9999 Max myNumber myNumber2 Max my NumberList Min value1 value2 Arguments Value one of a list of numbers or currency values whose minimum value is required One or more values may be passed in Metastorm BPM Release 7 6 May 2008 375 Metastorm BPM Release 7 6 Returns number or currency the lowest numeric or currency value in the list If all the values that are passed in are currencies or cast as currencies the lowest currency value is calculated and returned else the lowest numeric value is returned For example Min Currency Valuel CurrencyValue2 lowest currency Min YNumberValuel NumberValue2 lowest number Min CurrencyValuel currency NumberValuel lowest currency Min CurrencyValuel NumberValuel lowest number Min 9 99 2 50 5 95 2 50 Min list Arguments list a list of numbers whose minimum value is required Returns number the lowest numeric value in list For example Min 9 9 9999 99 99 999999 999999 Min myNumber myNumber2 Min Y my NumberList Months start d
425. re are three entries for each status field They comprise of the field name followed by Safety Warning or Danger If for example Statusl1 Safety is checked the current form element will be visible if the status field Status1 is in the Safety state The three states are not mutually exclusive If the visibility of a field is set to depend on all three states then the field will always be visible A If one or more entries are checked then the form element will be shown only when each checked field contains a value 3 The Size and position in pixels property contains the following options Top Use this field to position the top of the form element within the form in pixels Left Use this field to position the left edge of the form element within the form in pixels Width Use this field to select the width of the form element in pixels A When this option is used to add width to a vertical rule the rule is converted to a frame A This option crops an image check box or radio group caption area from the right side or adds blank space to the right side in excess of the field s actual size It does not resize the image check box or radio group Height Use this field to specify the height of the form element in pixels A When this option is used to add height to a horizontal rule the rule is converted to a frame A This option crops an image from the bottom or adds blank space at the bottom of the image in excess of the
426. re field This is necessary if any other fields on the form are dependent upon the content of the signature field A This box must be checked if any other fields are dependent upon values in this field 5 Enter any commands to be performed by the system when the signature field gains or loses focus in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Status Field You can place a status field on any form A status field defines a value in one of three states Safety Warning or Danger The state depends on the current value and two threshold values that you must set up in the Designer You can associate a form or URL with a status field This allows the user to drill down to a higher level of detail and examine the data represented by the field The following are examples how you might use a status field e To provide a Key Performance Indicator KPI dashboard e To display the importance of a folder when it is opened amp For an example of the status field used in a KPI dashboard refer to the sample administrative procedure KPI Dashboards xep To set up a status field you must specify e A safety threshold e A danger threshold e A value to compare against the thresholds 198 May 2008 Metastorm Inc 2008 Des
427. reating a new library To create a new library 1 Select File New Library A new empty library is displayed Any previously opened procedure or library is closed Procedure Explorer contains one Common item 2 Select File Library Properties The Libraries Properties dialog is displayed amp Sample Library Properties General LDAP aliases Integration Wizard collection Owner Password Metastorm Administrator Company Metastorm Inc Description Library 7 6 This library contains common forms for fragments map fragments and server and client side scripts used by purchasing procedures Last saved 1 10 2005 10 40 44 Cancel J Help Figure 25 Library Properties 3 In the Libraries Properties the General tab allows enter The name of the owner of the library The organization that owns the library A description of the library An optional password to protect the opening of the library file ra If the password were lost then the file could not be opened However the file could be recreated by retrieving the library from the database In addition the Properties dialog displays the dates and times the library was last published and saved The LDAP aliases tab contains a list of the LDAP aliases associated with the library Metastorm BPM Release 7 6 May 2008 51 Metastorm BPM Release 7 6 The Integration Wizard collection tab allows you to add a file
428. references to those columns have been removed from the procedure Displays the Roles dialog Allows you to add edit or delete roles for the current procedure Roles sp a Displays the Flags dialog Allows you to add edit or delete flags for the current procedure Flags a Displays the Scripts dialog Allows you to add edit rename or delete scripts for the components of the current procedure Scripts s Find and Replace Displays the Find and Replace dialog that allows a search for a designated element type Once located the element and all references to it can be renamed we Print Component Prints the currently selected map or form Table 8 Buttons on the General toolbar Map toolbar and Form toolbar The Map toolbar and Form toolbar share the same default location directly beneath the General toolbar however only one of these toolbars is available at a time When a 36 May 2008 Metastorm Inc 2008 Designer User Manual e Map is selected in the Main Pane the Map toolbar is displayed e Form is selected in the Main Pane the Form toolbar is displayed A You may choose move the Designer s toolbars to a more convenient location However regardless of their location each will appear only when you are working with the corresponding procedure component You use the buttons on the Map and Form toolbars to create maps and forms in a procedure The buttons available on
429. res are used to open a number of sub maps each of which will create a child folder that can be processed simultaneously or in parallel with the main procedure Sub procedures should be used only when there is a requirement for the parent folder to wait until the P y q P child folders have finished processing If this requirement does not exist the procedure should raise a flag to start a new folder in another map or procedure In addition to opening parallel procedures that have no direct impact on the parent procedure Sub procedure stages may be used in conjunction with Rendezvous actions to place the parent procedure on hold status until one or more sub procedures are completed Each time a folder arrives at a sub procedure stage a child folder is initiated in each sub procedure map Because of this inherent functionality loop back actions may not be desirable for sub procedure stages Each time a loop back action is triggered a new set of child folders will be created The Maps tab contains a checklist of all maps defined for this procedure The system updates this list as new maps are created within the procedure 82 May 2008 Metastorm Inc 2008 Designer User Manual Select the sub maps you wish to open at this point from the list displayed in the Submaps field You may check all the maps that apply If you have not yet created the desired submaps you may return to this list after the maps have been created and
430. riable data may be passed only from the current map 3 Enter the name for this flag in the Flag field A flag name cannot be longer than 31 characters and may only include letters A Z or a z numbers 0 9 underscores hyphens and spaces Non US English characters cannot be used in flag names A Whenever possible try to use unique flag names This avoids multiple maps with shared flags Remember flags will affect all published procedures so procedures that unintentionally share a flag may cause unexpected results A If you have a flag name and definition in the sending procedure you need a flag of the same name defined in the receiving procedure in order to use the flag to activate a flagged action in the receiving procedure 4 Enter a brief Description of the flag This description is useful when you are using several flags in a procedure or are using the same flag across several procedures 5 If the flag is to be raised using the Raise Flag property rather than sRaiseF lag define the values to be passed by defining a formula in the Data field Click on either the Integration wizard or Formula editor buttons to use one of these tools to define the formula or you may type the formula directly into the field 6 Click on OK to save Each defined flag is available for selection in a Flag action as well as by an action in any map in the procedure 9 2 3 Flags Dialog Buttons Other buttons on the Flags dialog allow you to perfo
431. rify that the captions for each map element appear as desired a Map element layering affects windowed controls such as frames and non windowed controls such as labels separately So you cannot change the layering of labels the only non windowed controls used in the Designer relative to other windowed Designer controls Removing Elements from a Map Map elements may be deleted from a map using one of the following methods e Select the desired element and press the Delete key on your keyboard e Select the desired element and use the Edit Delete menu option e Select the desired element and use the Edit Cut option e Select the desired element and click on the Cut button Deletion of a stage will also delete all of the actions connected to that stage A Map elements removed using either of the Cut methods Edit Cut or the Cut button are saved in the paste buffer and may be pasted back onto another map in the procedure Map elements deleted using the Delete options Edit Delete or the Delete key are not stored However you may use the Edit Undo option to restore deleted items immediately 3 2 Properties editor Each of the elements of a map or map segment has certain default properties usually it will be necessary to modify some or all of these properties This is done through the Properties editor 70 May 2008 Metastorm Inc 2008 Designer User Manual Properties Map1 Prefix of folder name
432. rite scripts The Script Editor provides syntax highlighting for VBScript JScript and JScript NET It also has links to VBScript JScript and JScript NET functionality Alternatively you can use an external text editor To avoid errors occurring when scripts are run it is a good idea to ensure that any variables within a script are declared within the script before they are used and JScript NET variables must be declared e With Jscript NET validate scripts e Attach a script to a form or map with the Scripts dialog e Call scripts from events using the Integration wizard or the Formula Editor a If a script takes longer than 10 seconds to run the Windows client user is given the option to stop it running It is possible to delay or disable this option by setting the following registry key on the client s machine HKEY_CURRENT_USER Software Metastorn Client Components ScriptTimeout ScriptTimeout is a string value To allow each script to run for more than 10 seconds set ScriptTimeout to the required number of milliseconds To disable the option set ScriptTimeout to 1 If the registry setting does not exist the option will be given after 10 seconds There are two types of scripts for Metastorm BPM e Server side scripts are scripts executed on the machine running the Process Engine These scripts may be attached to a map or map segment in the Scripts dialog or may be common to all maps in the procedure and must be cal
433. rm BPM Release 7 6 Defining a Grid s Do This Properties Properties Grid Options Colu Grid Type O Field has dependants O Edit Folder None of the above C Field is dependent on another Client extensions Figure 151 Grid Do this Tab Select the grid type by selecting it from the Grid Type radio group The options that are available on the Do This properties tab depend on the type of grid you are defining 1 Irrespective of the grid type the Client Extensions option is available and allows you to enter any commands to be performed by the system when the grid is entered or exited or when a cell is exited You may create and edit the formula using either the Integration wizard or the Formula Editor 2 Ifyou are defining a Field has dependants Folder or None of the above grid you may specify whether the Field is dependent on another If this checkbox is checked the grid may be updated as a result of a change to another data field or as a result of a button being pressed A If the field is dependent on another the field it is dependent on must have the Field has dependants of its own option selected on its Do this tab 3 If you are defining an Edit grid the options to allow users to Insert and Delete rows in the grid are available 4 If you are defining a Field has dependants grid you can specify the processing in the When user selects row property You may create and edit the formula using either the
434. rm the following tasks Ji Figure 172 Flags Toolbar Boderete button Allows you delete the flag with confirmation Be aware that removing the flag must be reflected in any stages or actions associated with this action in any affected procedures g e Open Opens a standard File Open dialog allowing you to open a previously saved Flags file Ebisave As Opens a standard File Save dialog allowing you to save the current Flags file 256 May 2008 Metastorm Inc 2008 Designer User Manual Eb vest Fit Resizes the columns for optimum display of the contents A The Open and Save As options are particularly useful when you need to create the same flags in multiple procedures To Edit a Flag Select an entry in the Flag dialog box and double click Flag HPremiumPaid Description Map Common Data Ce Cire i Figure 173 Edit Flag details Opens the edit Flags dialog allowing you to edit the flag name flag data map the flag is assigned to etc Be aware that any modifications you make to the flag must be reflected in the procedures that are affected 9 3 Raising Flags from within Procedures 9 3 1 Properties editor You may associate a flag with an action from the action s Properties editor using one of the following methods 1 On the Action tab select the flag from the drop down list of previously defined flags available in the Raise Flag property OR 2
435. roperties i _Button Do this Extra Notes oiana When button pressed Server operation Commit action Cancel action O New folder Open folder Caption Button Hint Get Time Default action usage _ optional Figure 215 Properties editor Tabs 2 Place your cursor in the field in which you are calling a script In this example the cursor has been placed in the When button pressed field on the Do this tab 292 May 2008 Metastorm Inc 2008 Designer User Manual 3 Click on the Integration wizard button The Integration wizard opens 4 From the Category menu select Commands Integration Wizard When button pressed Run a script and wait for it to complete Category Item Hide invalid gP Most recently used g All functions g Action and form information Custom variables of Dates and times g Directory integration g Microsoft Exchange adaptor gP Metastorm BPM database amp External database adaptor g File adaptor Folder information g Form fields g Lists and memos oe Microsoft Office adaptor eP Numbers gP Text functions Assign value gP Comment Conditional operation g Delete attachment oP Delete file g Print merge document o Raise flag g Run asynch script a Run inline script ea Run server application oP Save attachment g Save folder to file Send email oP Write
436. rs URL string Summary Sets the base URL of the XML Web service the client is requesting Remarks Timeout long Summary Indicates the time an XML Web service client waits for a synchronous XML Web service request to complete in milliseconds Remarks Setting the Timeout property to 1 indicates that the request does not time out Even though an XML Web service client can set the Timeout property to not time out the Web server can still cause the request to time out on the server side Authentication Parameters AuthMethod long Summary Sets the base URL of the XML Web service the client is requesting Remarks The following authentication mechanisms are supported 0 Anonymous 1 Basic Authentication requires AuthUser AuthDomain and AuthPassword 2 Integrated Windows Authentication Metastorm BPM Release 7 6 May 2008 415 Metastorm BPM Release 7 6 AuthUser string Summary Sets the username used for basic authentication Remarks AuthDomain string Summary Sets the domain used for basic authentication Remarks AuthPassword string Summary Sets the password used for basic authentication Remarks Remember that password information is sent in clear text over the network when using basic authentication Proxy Properties ProxyServer string Summary Sets the information for the proxy server used for all web services calls Remarks The proxy server can be configure
437. rsion of the same library with identical contents is found the latest version is automatically loaded Library Loading Status Library updated for this database New Version 2 Library Sample Library Version in database 2 Figure 35 Latest library automatically loaded e Ifa different version of the library is found you can Use the latest version that exists in the database Delete the reference to the library from the procedure Search another database for the correct version You are presented with the following Warning dialog Warning Library Sample Library Database Metastorm The library from the database is different from the version previously used in the procedure Do you want to use the latest version available From the database Figure 36 Option to use latest existing version If you click on the No button the library is not loaded and the procedure is not opened Library Loading Status Library Sample Library Database Metastorm The library is available in the database but has not been loaded or updated Version used in procedure 1 Version in database 2 Figure 37 Latest existing version not loaded Metastorm BPM Release 7 6 May 2008 61 Metastorm BPM Release 7 6 You may search another database or remove the reference to this library from the procedure If the reference to the library is removed the procedure can be opened but may not function as intended If you c
438. rties Defining Simulation Properties for Later Actions 0 0 0 0 cceseseessesecseeeeceeeeeceseeaeeseeneeees 3 4 3 Action specific Properties cccccccccsceesesecsesesseseseseeecsesesseseseecscseseceesesesseaeseeeeseseneeaeaeeeeeeaes Defining a User Action s Form Properties c sssscsssssssssseseeesesscecsceseecsesecseseeucaceseuesssneneaseeeseaees Defining a User Action s Roles Properties Defining a Loopback Action s Roles Properties Defining a Timed Action s Time Properties Defining a Timed Action s Roles Propertics ccccccesssesesssseeseesesesesesesesesecsesesesesesneseseenenenenenees Defining a Flagged Action s Flag Properties scscssseseseseesesesesesesesesesececscseneneneececececeeeeeseeees Defining a Flagged Action s Roles Properties Defining a Rendezvous Action s Maps Properties cscscssseseseseseseseseseseeeeseseseseeeeeseeeeseeenenees 4 CUSTOM AND SYSTEM VARIABLEG cccessssesssseseneneseeseenrseesesorseeeeseneeseesnnnsenes 4 1 C st m Vaal seessississcshisuedsedsscseccescisocecaedseceteccacescoessoossscsoassdescsensdcesecsedecssesssecsecnstesdovosseecseces 103 4 1 1 Custom Variables and FOr wicccccccccccccccscccscescssscsssssssessssscesssessssssssessssssesssesscsascsssesseesees 104 4 1 2 Creating a Custom Variable assosiasie ri s EKES E a KEK ASS S RASE 104 4 2 Systemi Variables vivcecctsssscissavececicestiecacesntedsevsiasstesvesceces
439. rties editor displays five tabs for defining radio group properties Radio group Options Do this Extra Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Properties Radiogroup1 folder Variable calculated Caption Radiogroup1 read only v Figure 128 Radio group Tab Metastorm BPM Release 7 6 May 2008 191 Metastorm BPM Release 7 6 Defining a Radio Group Field s Radio Group Properties 1 The Dataset field asks you to define a dataset for the system to use with this field The default option is folder which indicates that you will not be using a dataset with this field Using a dataset means that any required information necessary for calculating the information displayed in this field will be read directly from the dataset rather than require an additional call to the database Any datasets previously defined for use with this form will be displayed in the drop down list For more information on creating datasets see the Defining a Dataset Field topic in this section 2 Identify the variable you wish this field to use in the Variable field There are a number of options Ifthe text is to be calculated at run time select calculated from the list You will be able to specify how it is calculated on the Do this tab If the text is to be stored in the database you can select a variable from th
440. rty on the text field s Do this tab that required the server to compare the field input with a database value 5 The Mask field defines the entry format of the text that can be entered on a client machine Text that does not conform to the Mask will not be accepted The Mask option is not available if the Password field is checked Masks can be typed directly into the Mask field or they can be selected from a list of options e g Time of day To set a predefined map for a text entry a In the Options tab click on the Mask Icon A Mask Picker dialog box is displayed see Figure 141 below Under the Mask Name is a list of preset masks Metastorm BPM Release 7 6 May 2008 207 Metastorm BPM Release 7 6 Mask Picker Mask Name Example Time of day a Time of day with seconds Time of day AM PM Time of day with seconds AM PM Date Telephone number Extension Social security Short zip code Long zip code Mask p B Tes Figure 141 Mask Picker Dialog b Select the required Mask from the list The Example text box displays samples of the selected Mask and The Mask is defined as a regular expression in the Mask text box c Test the selected Mask by entering data into the Test text box and click the Validate button Ifthe data is in the correct format an acceptance message is displayed Information i 345 23 45 is valid text for this mask Figure 142 Data acceptance us
441. s radio group and drop down fields is 250 characters If you need to provide more room or allow for multiple lines of text you should use a memo field and memo variable Metastorm BPM creates the variable as a column in the database table for the map with which this form is associated Custom variables must be associated with a specific Metastorm map and are available to folders associated with that map however it is possible to use Metastorm functions such as flags and SQL queries to make custom data from folders in one map available to folders in another map 4 2 System Variables The following Metastorm system variables are defined e Action and Session variables e Folder variables Action and session variables are used to hold data specific to the Metastorm Process Engine to the currently executing action or to the requesting user Unless indicated otherwise they are read only The following table lists available system variables Variable Name Variable Parameters Type size Action Name text 31 The name of the current action as defined in the procedure map Action Notes memo The memo if any to be written to the folder s audit trail when the action is committed This variable is read write in an action The result may be read in a folder or action form using the read only Notes lt event numbers variable This variable is available only in an action form Action StartsStage text 31 The
442. s To Do WatchList folderID Alt Delimiter Arguments folderID a string identifying the folder which the users to be listed have on their Watch lists Alt Delimiter an optional string specifying the delimiter to use in place of a comma Metastorm BPM Release 7 6 May 2008 387 Metastorm BPM Release 7 6 Returns list the list of all users who have the specified folder on their Watch list obtained from the Metastorm database For example W atchList Parent All users watching parent folder LDAPSearch directory_alias filter_expression attribute_name search_scope Alt Delimiter Arguments directory_alias the name of an LDAP alias that contains connection details for the required directory filter_expression an LDAP filter expression which specifies which directory entries should be returned For more information about filter expressions refer to section 10 1 7 Accessing Directories Direct Directory Access attribute_name the name of the attribute to query from each directory entry matching the search criteria You may retrieve one attribute per LDAPSearch function In addition to attributes defined in the directory schema you may request attributes created using the Metastorm snap ins for Microsoft Active Directory and Novell eDirectory To request a custom attribute use the format ework lt attribute name gt where lt attribute name gt is the name of the custom attribute search_scope th
443. s or libraries To set the file locations 1 Select Options from the View menu 2 In the Options dialog select the File Locations tab 3 Place the cursor in the Procedure Path Location and click on the Browse buttons to set the default file locations for procedure and library files 4 Click OK to save the settings If the File Locations are left blank Process Designer will automatically open either the My Documents folder the first time or the last folder that was accessed from the dialog 1 4 2 File Types Metastorm Designer allows you to open and save procedures as XEP files These files store the procedure in XML format For details of the Metastorm process definition schema used in the XEP file format refer to the Process Definition Schema Developer Guide available with the Metastorm Software Developer s Kit 1 4 3 Saving a Procedure As you develop a procedure it is important to save your work in progress Designer offers two options for saving a procedure Save Procedure and Save As To save a procedure 1 From the General toolbar click on the Save button or 2 Select File Save Procedure from the main menu Procedure names can use characters which are configured with a default locale of North American Western European or Central European character sets However procedure names cannot include any of the following characters Pipe Period Dollar Sign Equal Sign Back Slash Quo
444. s sales leads as they are received by an organization and track their progress through to the receipt of an order or the abandonment of the lead t gt lead f Send iterature Escalate x Sn Sales Administration Sales Management Allocate salesperson VP Sales Reminder Allocate salesperson The Contact Report action No business applies to all stages that have No oe been selected on the Applied to tab of the Most stages Common stage refused E pou M EN report ake X report Proposal rejected Refused demo Ylost stages t Submit eee i t ben report Proposal submitted Demo made First visit made Proposal accepted p t 5 k Receive Purchase Order Pilot in proqress Roll out Figure 234 Lead Tracking Sample Procedure Preparation The following step is necessary for setting up this procedure 1 Register the users who will participate in the procedure You may use the Set Up procedure to add sample users to your Metastorm system Points to Note e This procedure uses the following dynamic roles that are evaluated at run time based on data collected by the procedure Marketing Sales Administration Sales Directors Sales Manager Sales Person Sales VP e Akey feature of this procedure is the use of a Common stage The Common stage is called Contact Report and has one loopback action also called Contact Report See the Applied to page
445. s that you specify or are calculated Custom variables are stored in the Metastorm database Each map in a procedure is associated with a database table Each custom variable has its own column in this table Before associating custom variables with fields on a form the form itself must be linked to the particular map in whose table these custom variables are to be stored The maximum number of variables per map depends on the maximum number of columns allowed in a table in the database being used Forms using custom variables must be associated with a particular map Each map in a procedure is shown in the Procedure Explorer Forms are associated with the map in which they appear in the Procedure Explorer To associate a form with another map in the procedure drag and drop the form icon to the new map A If you move a form to a new map you will need to re create any variables used on the form and associate them with the new map Also keep in mind that you should review any forms associated with a particular map before deleting map variables Forms using only system variables may be used with any map in the procedure and may be placed under the Common item or under any map item within the Procedure Explorer 4 1 2 Creating a Custom Variable To create a new custom variable 1 Click on the custom variable button or select View Custom Variables Designer will display existing custom variables E Custom Variables New Hire
446. sage property determines what will be displayed in the Message column for the folder in the To Do and Watch lists By default this property contains sAction Name which is a system variable representing the name of the action You can modify this default as required The Alert message property can contain a mixture of text and one or more Metastorm functions or variables The value you enter can be typed directly into the field or you can enter it by either Integration wizard displayed by clicking on the Integration wizard button or Formula editor dialog opened by clicking on the Formula editor button This message will also be stored in the audit trail of the folder 8 To specify that the action should create a new copy of the selected folder and act on the copy rather than on the original check the Clone new folder check box The cloned folder will move on to the next stage leaving the original folder behind for further actions to be taken A The Clone new folder option is not available for an initial action 9 Ifyou want this action to raise one of the flags defined for this procedure select the appropriate value from the Raise flag drop down amp Y For more information about Flags refer to Chapter 9 Flags on page 254 Metastorm BPM Release 7 6 May 2008 89 Metastorm BPM Release 7 6 10 When adding Action properties for a creation action a Description text field is provided so that the process designer may specify
447. scocososcseseosoocososcsessoscocosescsssecsosso 119 DIA FormatComplexI ype crire tE E aE ENEE NE EE ibvasiets 119 NENO OANA KAREE su vd adseacadiptoavesasetioeseens sv vdvauaat vista snes 119 ena DTT E R 119 FormatComplexType Example cece ssesssseseseseseseseeseesesesesessscscsesessnsnssescaeseeseseseseeneneaees 119 5 3 2 FormatComplexT ypeDirect v cccccccccccscssssscssssesscsssssssescssesssseesesesseeecsessesecsesseeeesesseeeesesseees 121 Param ters mron a a e e a e a Ea a e a as 121 Returns erena a a a a e r a e e E 122 FormatComplex Type Example neria e ea e eae E eatae se EE IE e eaan 122 Using FormatComplex TypeDitrett sisiane piene ee aa oeiia ea 122 DEBS GAST sss inca aba Cock actus Lave E A AE E E T N R then 122 Paramete S a A EE EE EE AEE AEE N ES TA ETNEN 123 RREEUITIS S55 ABETE AENEA EEEE EE EE EE EENE EE EATE EES EAE 123 Getlast Example OE EE EE OEN EPE OEE ENE EEA AEE EEEREN 123 RoR a E147 ERY DI a os EEEE EE EAA 124 Parameters niee EE OTE EEE R ANETA REENER REENER KOR 124 Reims enan anra ai a a e T OEA OLEANA EENE E EE 125 3 29 GetNameV Glue List sisii ea En N E E OR aah EE E A RA 125 Parameters reee E C ETET O NE EEE A S 125 REUS ra O A O E E O A EO EA 125 5 3 6 GetNameValueList DireCt ceccccscccssecccsersssesesessescsesceseseeecseseaceseseseaseaeseeeeeaeaeeaeseeeeeeaeneeaes 125 TENEI A TA KEENT E T 125 E ASEN T E R 126 GOS e E T E T 127 6 1 The Form Editor sssiseressesisirocnsnsacesiseicsson iinr e ar inn sosro
448. scseseneneseecensnenenenenenees Determine Possible Outcomes Identify Reusable Element cccesesesesesesesesecsesesescensecsescseseneneseececeeeteeeseeees Run a Simulation of the Procedure and Analyze the Data Defining Simulation Data nirre roeiers aa oao Eep E aE EE R ESTEPE Maintain the Procedtire s isccces seccntesccvedassccvesas rerasane ee Pee Se e EVE oaee E EE UE EE EAA ESE NOONE EES eE EEES 1 3 The Designer Interface sicccs scessscecsscsiiesssesucesescieve stents ceceseuevesnensevesesevavessesssventiesevechessoeevesaesvenseonsse 1 3 1 1 3 2 1 3 3 1 3 4 1 3 5 1 3 6 1 3 7 1 3 8 Title BOT 2s hss Shi carssssaecdatecss iaseseesPaaiahe bea aie adits EEN E ek MEUS rises Cee is EV asi a IE AIEEE NEAR TE EEE AMG tle VICTIM eir seen Aad tet a ete creak Leena MA aR een nat A art cer nase Bode The Edit Menu c cece The View Menu cc ccce The Component Menu The Help Menu eceeees The Tools Menu ccccee Pop up Menus rieren eret E REE nw nae dae nano hee Dockable Menus vea E A dase else das ei ae EA aS PersOniala Zed Menus nna eign ta siaciendak caus cveststaeceda san dvev sins Sed Sheena devas avededevveas Toolbars iener sels eee avs ev SE EG AIRE ESSE PAETOS E EVE VE EN TEE ed 0 0 1b pee E E E ET E A A Map toolbar and Form toolbar wescccscscssstssescscesstessetsonsveveatebiva n e E E Procedure Explor etn oss issadeceuaescteabiceas a RE Tae ga A ae E i a as baot
449. sers the ability to extract user and attribute information stored in one of the following directory services environments and cache this information in the database e NDAP for accessing Novell eDirectory data e RDBMS for accessing Relational Database Management System data e LDAP for accessing Lightweight Directory Access Protocol LDAP Microsoft Active Directory data and other generic protocol data In addition the Users and Roles Administration Services Microsoft Active Directory Property Page has been created which allows you to define custom attributes within Novell eDirectory and Microsoft Active Directory These attributes are also exported by the Directory Extraction Service and cached within the database for use by Metastorm BPM amp Instructions for using these utilities are found in the Metastorm Administration Guide The user information extracted through the Directory Extraction Service can be used to define roles in two ways e Dynamic roles user attributes imported through a Directory Integration Suite utility may be used in the formulas used to define dynamic roles This will be discussed in greater detail later in this section e Static roles users imported into the database through a Directory Integration Suite utility may be assigned static roles through the Users and Roles tool Instructions for using this utility may be found in the Metastorm Administration Guide 8 1 4 Adding Roles to the Roles
450. sesssesessessessseseseeeseesesees 394 Print document folderID printer filename cccccccccccscssssssscsssssssssssesssssscsssesssessseseseneeessaeees 395 JoRaiseFlag flag folderID flag_data cecececccssssssssssssssssseseseseseseseseseseseeeeseeesceceeeeseneneaeaeaees 396 RegisterInQueue symbolicName system eworkHost queueSource credentials process ClientType map stage ACTION PATATNS oececccscesecccrsesecscssssecsessescsseseesesseseescseeseesesseseasens 396 RegisterOutQueue symbolicName system queueName params 397 JoRun Application AVQUMENS eccecccccccecsseccscessssesssssssessssssscsssssssesssssssscsesseeesessseseseesaeessseeasees 398 SaveData folderID filename Alt Delimiter c cc cccccceseccsssessseeeesesseeeseteeecseeeeeseseeeeeeaeneees 398 SendMOMessage symbolicName message priority timeToLive folderID 2 2 2 399 SendMOMessageEx type queueName message priority timeToLive params 399 Script language file procedure map statement args ccccccccceccccscsecscsscssssseesesssses 400 ScriptAsync language file procedure map statement args ccccccceccecsecssssesesseees 401 JoUnre gisterINQueue SYMDOLCNAME cscccccsssssssscsssesssssssssscsessescsessecsessecsessseseseseseseseesesees 402 J Unre gisterOutQueue SYMDOLICNAME ou e cscescsccscsssessssscsssesescsssssescsssssesssesasessseseseessesasessaseasees 402 JoWriteText string filename new file
451. sing the Designer Except in the course of an action all folder variables are read only Where specified they are writeable within the context of an action Although folder variables may be used in any Roles Formula they should not be used in any role used to control access to a user creation action since this is evaluated in order to retrieve a Blank Forms list without access to any individual folder ActionCount number read only number of actions committed thus far on the selected folder This will be zero during a creation action and one when the creation action has been committed This variable should not be used in the following properties e Map Subject where it will always return a value of zero e Field Variable since the variable is read only Archived boolean read only indication of whether a folder is archived Returns True if the folder is or has ever been at an Archive stage else returns False Category string writeable name maximum 31 characters used to categorize folders under the control of the designer This variable is available in all properties CreationTime date time read only date and time at which the selected folder s creation action was invoked or if already committed committed Metastorm BPM Release 7 6 May 2008 361 Metastorm BPM Release 7 6 This variable should not be used in the following property e Field Variable since the variable is read only Deadlin
452. sor to a crosshair and still holding the left mouse button down drag your cursor to encompass all of the desired map elements Designer will display a dashed line indicating the outer edges of your selection All items within the dashed line will be selected when you release the mouse button e Select the Pointer button and click on a map element Hold either the Shift or the Ctrl keys select any additional elements desired e From the Edit menu choose Select All Designer will select all elements currently on the map 68 May 2008 Metastorm Inc 2008 Designer User Manual If you have selected multiple map elements the handles surrounding each selected element will be disabled You may also cut copy or delete the elements as a group Moving Map Elements Map elements may be moved around on the map by selecting them and dragging them to a new location A When map elements are repositioned the connecting actions lines will be re routed Copying and Pasting Map Elements Map elements may be copied by e Selecting the desired element and then selecting the Copy button from the General toolbar or e Using the Edit Copy option Map elements may be pasted onto a map by e Selecting the Paste button from the General toolbar or e Using the Edit Paste option Determining Map Element Alignment Individual and groups of map elements may be centered horizontally or vertically on the map and multiple map elements may be ali
453. specify that Metastorm BPM is to perform one command if a condition is TRUE and another if it is FALSE Current date time Date time You use this option to return the date and time provided by the server on which the Process Engine is running Current input text You use this option to specify that Metastorm BPM is to return the text entered by the user into the current field Error message Text This is a local to an action or form variable into which you can set any value but typically a description of why some user input is unacceptable via the normal Assign value item and then show in a dependent field on the form to give the user an explanation of what they should do FALSE check You use this option to place a FALSE value in a check formula Flag data text You use this option to return any data associated with a flag This is defined in the Flag Dialog When you set up a flag in the Flag Dialog you can specify data that will be passed when the flag is raised flag data This will appear in the flag dialog as a list of variables Use the Flag data item to pass the value in one or more of these variables to the folder that is waiting for that flag to be raised Enter the data in the Data line 1 to N argument For example Action flag data 1 is the first variable in the list Action flag data 2 is the second in the list and so on Flag folder text
454. specify that Metastorm BPM is to return last updated the date and time that this folder was last updated A folder is updated when it enters a new stage or as the result of a loopback action When stage Date time You use this option to specify that Metastorm BPM is to return started the date and time that this folder entered its current stage Form fields Lists all data fields defined for the currently selected form Empty if no form is selected or if no fields have yet been defined on the currently selected form Data fields are shown in the format field lt fieldname gt Lists and Lists all non custom Metastorm memo variables and memos functions used to return memos and lists All notes memo Returns a formatted log of all notes added to this folder via the Action Notes field COMMA text You use this option to insert commas into a list or reference a comma in the list Convert list to memo You use this option to specify that Metastorm BPM is to memo convert a comma separated list to a multi line memo Convert memo list You use this option to specify that Metastorm BPM is to to list convert a multi line list to a comma separated list Count list integer You use this option to return the number of entries in a comma entries separated list Earlier note memo You use this option to specify that Metastorm BPM is to return the note associated with a previous action on this folder Find list integer You use this option to return th
455. ss Rules Designer uses a Business Rules Composer tool to create rules The Business Rules Administrator can incorporate system variables and custom variables into the rules via a NET assembly Metastorm FolderData class 282 May 2008 Metastorm Inc 2008 Designer User Manual 2 The Business Rules Administrator uses the Business Rules Engine to deploy the rules so they can be accessed from the Designer and procedures A web service the Metastorm Rules Service is hosted on the same machine as the Business Rules Engine 3 The process designer uses the Designer to design a process Where required the process incorporates the 3ExecuteRule function as follows a The process designer publishes the BRI Library and references it in his procedure b The process designer opens the Integration Wizard c The process designer enters the authentication information for the Business Rules Engine d The Designer makes a call to the Metastorm Rules Service web service e The Metastorm Rules Service web service obtains a list of available rules from the Business Rules Engine and returns the list to Designer f Designer selects the required rule to be executed in the procedure optionally specifying any custom variables to be passed to the Business Rules Engine 4 The process designer publishes the procedure 5 When the procedure is used the Process Engine evaluates the SExecut eRule function 6 The Process Engine invokes the ru
456. ss User OU development returns all results where the object class is User OR the OU is development Attribute Name Enter the name of the directory s attribute that you want to retrieve You may retrieve one attribute per LDAPSearch function Delimiter Set the delimiter for the list to be returned the default is a comma chr44 For further information on the parameters for LDAPSearch refer to the Formula Components Appendix 7 Click on the Finish button The formula is displayed in the Value property Metastorm BPM Release 7 6 May 2008 277 Metastorm BPM Release 7 6 Integration Wizard When button pressed Select the variable to which a value should be assigned Variable Subject Value a LDAPSearch Directory1 objectClass inetOrgPerson cn 0 CHR lt Back Next gt Einish Cancel Help Figure 198 Setting Search Formula 8 Click on the Finish button The formula SSubject sLDAPSearch Directoryl objectClass inetOrgPerson cn SCHR 44 has been built and appears in the Properties Editor of the button When the procedure has been published and the client user clicks on the Search Directory button the information will be gathered from the directory and put into the Subjectvariable 10 1 8 Custom Variables Designer automatically establishes a number of variables that can be used in calculations or in reporting In addition when designing a
457. ssessenssenssessises 411 Placing TEIAS a a Ea a E sca Aa S TY 41l Form elas aa a a A e e E ets r Ara le 41l May 2008 Metastorm Inc 2008 Contents Uns pp rted fields 5 cicsiusc vents csvctessusecvasnsianichsccsch catenin nine aioe sene hia aS ES sk eoa eiia 412 invald CHAT ACTOS ro aeren a EEE EEEE EEEE SEERIA EEEE ANRI 412 Configuring JAWS ccccsccvscsccasscocesstessecessssscoassvesocevesstescesecenssbace E Ao ae S EEE 412 Accessing Metastorm BPM via JAWS ssssscscssssssssssccssessssssessscesessssscesessssesessecesessasasesssceseseases 412 Determining whether you are logged in tO A SCTVICE s ssssesesesseseseseeeeseseseeseseeecseseseeseseeeeeeaeneeas 413 Determining the CUrrent Braies i enii aA EAEN ESE EART ENA EET AS 413 Logging in tod ServiCe siaii Lessee teehee tae aa sade a a exh date EE E ieS i EEE eE Er ESEE eNO nEri 414 Navigating to the submit and cancel buttons ON fOTT cccccsecccccrsesecsecsesesseseescsseseescsseseesessesees 414 APPENDIX D BUSINESS RULES WEB SERVICE CONFIGURATION PARAMETERS 415 Connection Parameter sssini ns oo eos sers trs vois euas or Ers orr SES Sor i e oie 415 UBT SITTING AAEE OE E EENE 415 Timeout S1ONG sir a EE TEE AOE EE AE A EA N FAAEA AN 415 Authentication ParameterS eossessoecoscssossoscoscoscesoesoseosoosessoscoseosossessoscoseosossossosoosessossossossoseosessoss 415 Auth ethod GWG nrn nn e a E E A SAE eS 415 AUU SEE SUTE egee EE i N E ie a ESEN AE E A EN TE tes 416 A Ut
458. ssive lines e List Drop down List options accepts a list e Date Time Earliest and Latest both accept date times e Grid Row s and Dataset Row accept via SQL dialog a condition e Grid When user selects row accepts one or more commands entered on successive lines e Status Value accepts a number e Status Safety threshold accepts a number e Status Danger threshold accepts a number e Status Action accepts a string that represents the name of an action form e Status Map accepts a string that represents the name of a map e Roles via Add and Edit dialogs Formula accepts a list that should at run time resolve to a list of Metastorm roles and or user IDs A Formulas created for dynamic roles are treated as literal strings and may require the use of the Evaluate function Refer to the section on Defining Dynamic Role Formulas for further details e Flags via Add and Edit dialog Data accepts one or more strings entered on successive lines Metastorm formulas may also be used within any map script However these scripts may themselves be called only by a formula specified for one of the above properties When Formulas Are Evaluated This subsection details the order in which formulas are evaluated When a Blank Forms list or Admin Forms list is requested the Available to roles property is evaluated for each action in the list When a folder is requested 1 For each possible action from that stage the Available to roles
459. st a copy of list with entry number index removed For example RemoveEntry a b c 0 b c myList WRemoveEntry myList myIndex Metastorm BPM Release 7 6 May 2008 377 Metastorm BPM Release 7 6 Replace source old new count Arguments source old new count Returns string For example a string in which the replacement is to be made a string to be replaced a string to replace old by an optional number of occurrences of old to be replaced If omitted or 0 all occurrences will be replaced a new version of source with all replacements made Replace abra a A AbrA Replace abra a A 1 Abra Replace myMemo NEWLINE Chr 44 multiple lines gt csv Replace Y myCS V Chr 44 Chr 9 csv gt tab separated Replace myTS V Chr 9 7 NEWLINE Q tsv gt multiple lines Round number decimals round down Arguments number decimals round down Returns number a number or currency value to be rounded an optional number of decimal places to be rounded to If omitted or empty number will be rounded to a whole number an optional number indicating whether a value of 0 5 or greater should be rounded up 0 or down 1 If omitted or empty number will be rounded up the rounded value a If a currency value was passed in the result is a currency value This function supports Bankers For example Ro
460. stName gt lt Address1 xmins http tempuri org gt ABC House lt Address1 gt lt Address2 xmins http tempuri org gt 27 High Street lt Address2 gt lt Area xmins http tempuri org gt ABC Town lt Area gt lt PostCodeOrZip xmins http tempuri org gt AB12 3CD lt PostCodeOrZip gt lt City xmins http tempuri org gt London lt City gt memReturnClients lt Phone xmins http tempuri org gt 44 0 20 1234 5678 lt Phone gt lt eMail xmins http tempuri org gt albert jones abc co uk lt eMail gt Populate Clients memListClients ABC Corporation Widget Co Ltd ABC Corporation BBB Ltd CCC Inc Figure 81 GetList Example amp Java uses its own serialization format which is not compatible with XML SOAP and Binary formats supported by NET Therefore by default this function will not work However there is a work around A helper function EJB_GetListFromld works in a similar manner to GetList with the exception that its first parameter is a Java object ID instead of a NET serialized object 5 3 4 GetListDirect GetListDirect returns a delimited string using a specified complex type array or collection Parameters e variableValue specify a value of a memo variable or a value which is obtained by calling another activated method and not stored in a memo variable field The value must contain a serialized complex type value The serialized complex type value must be either
461. stem Text UnicodeEncoding 2 System Text UTF7Encoding 3 System Text UTF8Encoding 418 May 2008 Metastorm Inc 2008 Designer User Manual Appendix E Masks Format Masks are defined in DXM files The contents of an example DXM file are shown below RegExpr1 ShortDescription Phone Description 4155551212 Mask 999 000 0000 1 _ RegExpr2 ShortDescription Extension Description 15450 Mask 99999 1 _ RegExpr3 tDescription Time of day Short Description 15 25 2 0 3 0 5 d Mask 0 d 1 d RegExpr4 ShortDescription Post Code Description SW19 7AB a z 1 2 d 1 2 a z s d a z 2 Mask RegExpr5 ShortDescription Description support metastorm com a z0 9 a z 2 6 S Email Mask a z0 9_ Table 48 Example DXM File DXM files have the format of INI files Each DXM file defines several masks and is divided into a number of sections one for each mask Each section must e Have a name containing one of the following keywords Standard RegExpr 419 Metastorm BPM Release 7 6 May 2008 Metastorm BPM Release 7 6 e Contain the following keys ShortDescription Description Mask 420 May 2008 Metastorm Inc 2008
462. storing the time the folder entered the stage 96 May 2008 Metastorm Inc 2008 Designer User Manual Properties Inducted Remove from To Do list Rebuild To Do list Leave it 4yvailable to roles access Administrator everybody ework Administrator ework Guest Facilities Manager Guest Hardware HR Assistant HR Manager Manager Metastorm Administrator Metastorm Guest Networks originator Payroll Clerk Security Manager Telecomms Wv To Do list Watch list Figure 60 Loopback User Action Roles Tab If the user action is a loopback action a radio group of loopback options is included on the Roles tab Select one of the following three Loopback options Remove from To Do List Selecting this option instructs the system to remove the folder from the To Do list of the user who invoked the action This is useful in Group stages where the folder may be initially on several users To Do lists As each user performs this action the folder is removed from that user s To Do list and is updated on all the other users lists A In this case you will probably require an action to remove the folder from the stage when there is no one left on the To Do list Otherwise the folder may remain at that stage but with no action to progress it to the next stage Rebuild To Do List Selecting this option instructs the system to regenerate the list of users who have the folder on their To Do or Watch lists j
463. storm process it is represented through one or more maps diagrams or process models each illustrating the various steps required to complete 18 May 2008 Metastorm Inc 2008 Designer User Manual a business process the lifecycle of a folder Each instance of the business process is called a folder and the steps are called stages and actions x Folder A new folder with a unique system generated ID is created each time a new instance of the process is initiated In this way the database can track the information particular to each instance of a business process A folder contains one or more pages forms of information relating to that instance of the process This information may come from a variety of sources such as 7 Input by a user onto a form 7 Data extracted from a database internal or external and 7 A file generated by another application a Stages When a folder reaches a user s desktop Metastorm BPM views the folder as having reached a stage in the procedure A map may also contain various system stages that do not require human interaction to move the folder to the next stage 7 Actions Metastorm BPM defines an action as the step or activity necessary to modify data and move a folder from one stage to the next Actions may include activities such as x Filling out a form a Logging a telephone call x Reviewing an attached file 7 Approving or denying a request It is also possible to have actions
464. string within instring taking case and start_position into account if necessary Returns 0 if the substring cannot be found Find abe ABCabcabc 0 1 Find abe ABCabcabc 1 4 Find abc ABCabcabc 0 4 7 368 May 2008 Metastorm Inc 2008 Designer User Manual FindEntry list item delimiter Arguments list item delimiter Returns number For example FindEntry a b c b FindEntry a b c d a list or if delimiter specified a string whose entries are to be searched a string entry to be found within list an optional string delimiter between successive entries in list If omitted or empty a comma is used as the delimiter the position of item within list using delimiter The list is zero based the first item in the list is item 0 Returns 1 if the item is not in the list 1 I 1 FindEntry Session FlagData myCustomerName Chr 9 FormatCurrency currency value locale digits leading group decimal separator thousand separator negative order positive order currency symbol J Arguments currency value locale a numeric string to be formatted as a currency an integer that determines the format for the entire result and for symbols such as the negative number indicator If the locale number is not known the following strings may be used DEU for German ENG for U K English ENU for U S English ESN for Modern Spanish
465. system to enable DMS Providers to integrate with Metastorm BPM This functionality enables users to interact with Metastorm BPM processes Metastorm BPM provides features for Microsoft Office SharePoint Server 2007 and Windows SharePoint Services 3 0 to enable SharePoint to act as a Metastorm BPM client SharePoint users are able to interact with Metastorm BPM processes The supported Document Management Systems are e Microsoft Office SharePoint Server 2007 7 1 What does Metastorm DMS provide Metastorm DMS provides the following features e DMS Clip Field the standard attachment clip has been extended to support a single DMS document e DMS Multiple Attachment Clip field the multiple attachment clip has been extended to support multiple DMS documents e DMS Common Library a Metastorm library which contains Integration Wizard functions to work with the DMS clip and the DMS multiple attachment clip fields e DMS Provider Designer Library a Metastorm library which contains Integration Wizard functions to enable Process Designers to execute DMS commands in server side scripts A DMS Provider Designer Library accompanies each DMS Provider e DMS Browser Control enables users to browse a DMS repository to select a document or location e Inherited DMS permissions the file permissions already assigned in the DMS provider are used by Metastorm DMS 232 May 2008 Metastorm Inc 2008 Designer User Manual
466. t lt T gt Checks the procedure for warnings or errors and displays them on the Validate Procedure dialog Print Definition lt Alt gt lt F gt lt P gt Prints a full text definition of the current procedure including all its components Print Component lt Alt gt lt F gt lt R gt Prints the component currently displayed in the Main Pane Print Setup lt Alt gt lt F gt lt U gt Reviews and allows changes to the print setup Exit lt Alt gt lt F gt lt X gt Closes Designer with the option of saving changes to the current procedure Table 2 File Menu Options The Edit Menu You can access the Edit menu using the shortcut lt Alt gt lt E gt Shortcut and Access keys to the individual Edit menu options are given in the following table Option Access Key and Function Shortcut Undo lt Alt gt lt E gt lt U gt Reverses the last action or lt Ctrl gt lt Z gt Cut lt Alt gt lt E gt lt T gt Removes the items you have selected from the map or or form Designer places the cut items in your paste buffer lt Ctrl gt lt X gt Cutting a stage from a map removes all actions linked to that stage Copy lt Alt gt lt E gt lt C gt Places a copy of the selected item in your paste buffer or lt Ctrl gt lt C gt Paste lt Alt gt lt E gt lt P gt Inserts an item from the paste buffer into the map or form or lt Ctrl gt lt V gt Delete lt Alt gt lt E gt lt D gt Deletes the currentl
467. t caption for the text field 7 The Default Action Usage field allows you to specify a default such as read only optional hidden or required for the Text field Use the down arrow associated with this field to select the desired default Defining a Text Field s Options Properties The format of data to be entered into a text box at runtime is defined in the Options tab of the text box Properties To specify the data entry format for the text field 206 May 2008 Metastorm Inc 2008 Designer User Manual Properties Maximum length 250 a C Password Type Text x Mask Figure 140 Text Options Tab 1 Select the text box and select the Options tab in the Properties editor The Properties editor displays the format options see Figure 140 2 Set the Type field to the default setting Text 3 To specify the maximum number of characters that can be entered into the text field you must check the Maximum length checkbox In the field below select a value between 1 and 250 4 If you check the Password check box Designer is instructed to store all user input in the database in encrypted form A password will never be provided by the server it must be provided by the user A The Password option does not provide any authentication of user input Password authentication would have to be requested separately from the server such as through a formula in the When changed prope
468. t from minutes hours days weekdays Monday through Friday weeks or months The default setting is hours Specify whether the action is to be invoked Before or After the event by selecting the appropriate radio button Use a variable or formula to specify the event before or after which the action should be initiated in the Timed event property Select from the available options presented through the Integration wizard or enter the variable or expression directly through the Formula editor 98 May 2008 Metastorm Inc 2008 Designer User Manual Defining a Timed Action s Roles Properties The Roles tab is available only when the timed action is a loopback action The Roles tab allows you to select one of two options available for a loopback Timed action Rebuild To Do list or Leave it Properties Warning Loopback options Remove from To Do list Rebuild To Do list Leave it Figure 62 Timed Action Roles Tab e Rebuild To Do list Selecting this option instructs the system to regenerate the list of users who have the folder on their To Do or Watch lists just as though the folder had arrived from another stage This is useful in a stage at when some update occurs that changes the data used in evaluating a dynamic role Unless the Rebuild To Do list option is checked the data change would not affect the To Do list e Leave it Normally when a loopback action is taken list of users who have the folder on the
469. t will wrap within the caption field If the caption field is too small the portions of the text that extend beyond the field boundaries will not be visible You should check your form to verify that the label field is large enough to display all of the text and resize it as necessary 3 A sequentially numbered default caption for the field type is displayed when each new label field is added to the form To change the default caption type the label s caption text that to be displayed on the form Designer updates the form to display the new caption text 146 May 2008 Metastorm Inc 2008 Designer User Manual Defining a Label s Do This Properties Properties Labeli Client extensions Figure 93 Label Do This Tab A label has only one item on the Do This tab of the Properties editor In the Client extensions field enter any commands the system must perform when the form is entered or exited whether as a page in a folder or as an action form You may create or edit the formula using either of the following tools e Click on the Integration wizard button to open the Integration wizard e Click on the Formula editor button to open the Formula editor dialog Using a Label field to add a link to the form Client extensions URL http www metastorm co Figure 94 URL set in Do this tab You can add a URL link to a form using a label field To achieve this Metastorm BPM Release 7 6 May 2
470. tachment FolderID myClip C TEMP A GetAttachment does not accept unicode filenames NewAttachment folderID filename path Arguments folderID a string identifying the folder to which an attachment should be made filename a string containing the file name and extension without path of a file to be attached path a string identifying the server directory path from which filename should be read Returns string the attachment name and extension assigned to a new attachment created in the Metastorm database The return value will differ from filename if an attachment with the specified name and extension already exists in the database for folderID This return value is typically assigned to a clip variable For example myClip NewAttachment FolderID Initial Application Form doc C Temp 394 May 2008 Metastorm Inc 2008 Designer User Manual Print document folderID printer filename Arguments document folderID printer filename Returns command For example a string identifying the server directory path name and extension of the MS Word document to be printed A To perform a mail merge as efficiently as possible ensure the template is read only the string tFolderID If empty error message displays Unable to Commit Action a string specifying the full UNC path of a printer where the output should be printed If empty then the output will not be printe
471. tachment clips contain all attachments for a folder 6 amp Y For further information about the option Document Management Support refer to section 7 Document Management Support To add an attachment clip click on the Attachment clip button on the form toolbar and then click on the location on the form where you want the Attachment clip icon to be displayed Designer places an attachment clip on the form and displays the corresponding Properties editor The Properties editor displays four tabs for defining Attachment clip properties e Clip Metastorm BPM Release 7 6 May 2008 149 Metastorm BPM Release 7 6 e Do this e Extra e Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Properties Clip1 xj iC f Do this Extra Notes Variable in calculated X Caption Cip1 Hint r Default action usage read only X Multiple attachments Document managment support Figure 96 Clip Tab 1 Click on the Multiple attachments check box to allow multiple attachments to be added to the form The clip on the form changes to a grid on which the user may add one or more attachments Only one multiple attachment grid should be placed on a form If you choose the multiple attachments option not all the properties are available in the Properties editor Where this is the case it is noted below 2 The Designer will use the
472. tage button on the Map toolbar and then click on the map to place the stage Stages can be added and then changed using the Properties editor Stages may be moved around on the map by selecting them and dragging them to the desired location A Stage names can use characters which are configured with a default locale of North American Western European or Central European character sets However stage names cannot include any of the following characters Pipe Period Dollar Sign Equal Sign Back Slash Quotation Mark Forward Slash Percent Comma Plus Colon Semi colon and Angle brackets lt gt A When designing a stage to expose as a web service the Stage name should contain only alphanumeric characters and spaces Adding Actions to a Map To add an action click on the desired button on the Map toolbar and then click on the stage that represents the source of the action Hold down the left mouse button and drag the action from the Metastorm BPM Release 7 6 May 2008 67 Metastorm BPM Release 7 6 source stage to the destination stage If the action loops back to the same stage drag the action out from the stage and release the mouse button A To add several copies of a particular map element hold down the Shift key while clicking on the desired element button then click at each location on the map where you want the element to be placed Click on the Pointer butt
473. tage icons may be moved around on the map dragging and dropping them to the desired location A To add several copies of stage hold down the Shift key before clicking on the desired Stage button There are six types of stages available within the Designer The following table summarizes the stages their purpose rules of use and the Properties editor tabs associated with each Stage Purpose Rules Properties editor Tabs User Folders at a user stage will You can draw any type of actiontoa Stage a generally be placed on a single user stage Roles E user s To Do list You can draw any type of action Do this except a rendezvous action from a Notes user stage Metastorm BPM Release 7 6 May 2008 75 Metastorm BPM Release 7 6 enters the specified map segment When it comes to the end of the map segment it re joins the main map A If a formula added to the rendezvous action coming from a map segment stage fails the folder will remain at the map segment stage stage from a Map Segment Stage Purpose Rules Properties editor Tabs Group Folders in a group stage will You can draw any type of action toa Stage generally be placed on several group stage Roles g8 users To Do lists You can draw any type of action Do this except a rendezvous action from a Notes group stage System Folders at a system stage will not You can draw any
474. tastorm Inc 2008 Designer User Manual SERVER CATEGORY ACTION RESULT TYPE DESCRIPTION Commands Most Metastorm formulas are declarative they return a value without producing any side effects This category provides access to non declarative formulas all of which have some side effect like updating the value of a variable or outputting data to a file Most of these items do not return a value You re most likely to use these items in any When lt something happens gt property Assign value You use this option to assign a new value to a Metastorm variable Comment Adds comments to your code Conditional operation You use this option to specify that you want to perform one command if a condition is TRUE and another if it is FALSE Delete attachment Deletes an attachment from an attachment clip field in a folder Delete file You use this option to specify that Metastorm BPM is to delete a file on the server List files memo You use this option to specify that Metastorm BPM is to list the contents of a file directory on the server and place the list ina memo variable This may be used to display the directory listing in a calculated memo field Print merge document When defining properties for an action you can specify that Metastorm BPM is to print a document containing data from the folder If you wish to merge data from the folder
475. tastorm com gt Therefore some lt A gt elements will not work in HTML embedded in a Metastorm form A When embedding HTML in a form be aware that the embedded HTML may behave unpredictably when run as part of the HTML for the form 148 May 2008 Metastorm Inc 2008 Designer User Manual The figure below shows a form containing an embedded view of the Metastorm web site and two links to the same web site The first link is achieved by embedding HTML while the second makes use of the client extensions A Open Web Links URL Labels Metastorm BPM Server Metastorm BPM Microso BAE Partners Customers METASTORM HAS 4 HOME AT DOWNTO BALTIMORE S INNE Our Hottest Download Success Stories View All Manufacturing Retail Distribution Download Advanco 2005 Award Winner y ul gt Go to Metastorm website URL in client extension Figure 95 Form containing embedded HTML and links A It is not possible to change the embedded HTML at runtime Defining an Attachment Clip An attachment clip is an interactive form element used to attach a file to a form You can place any number of attachment clips on the foreground of a form to hold attachment files for each folder However if you are anticipating more than one attachment to be made to the form set the clip to Multiple Attachments There is no advantage to adding a single attachment clip and a multiple attachment clip to the same form as multiple at
476. tation Mark Forward Slash Percent Comma Plus Colon Semi colon and Angle brackets lt gt 44 May 2008 Metastorm Inc 2008 Designer User Manual To save the procedure under a different name to a different location or as a different file type 1 Select File Save As from the main menu A standard Save As dialog will appear The procedure will be saved as an XEP file amp For information on file types refer to section 1 4 2 File Types 2 Select a destination and file type enter the filename and click on Save Procedure and Library filenames may contain a maximum of 31 characters Designer will collect the current procedure elements and save the data 1 4 4 Exporting a Procedure or Map You can export a procedure to an alternative format if the relevant transformation instructions are available in the Metastorm BPM Designer folder The available formats will be listed in the Save as type dropdown on the Save dialog You can also export a map using the Component Save As option Transformation instructions for exporting Metastorm maps to BPEL are provided with the Designer To export a map as BPEL select BPEL files BPEL in the Save as type dropdown when saving A Metastorm BPM Designer can export to BPELAWS 1 1 The later WS BPEL 2 0 standard is not supported amp For information on producing transformations to allow export to alternative formats refer to the Pro
477. tegration wizard and the Formula editor amp Instructions for using these tools may be found in Section 10 Creating Formulas page 261 6 3 Creating a New Form In most procedures you will find it necessary to create one or more forms These forms will be used to collect or distribute information Forms may consist of the following elements e A form background provided by default required e Background elements such as images frames and rules which are used as layout and design elements optional 132 May 2008 Metastorm Inc 2008 Designer User Manual e Foreground elements such as command buttons attachment clips grids and data fields which are used to collect and display information In addition to any form elements you choose to add forms have several predefined properties which may be changed or reviewed as required using the Properties editor Form names can use characters which are configured with a default locale of North American Western European or Central European character sets However form names cannot include any of the following characters Pipe Period Dollar Sign Equal Sign Back Slash Quotation Mark Forward Slash Percent Comma Plus Colon Semi colon and Angle brackets lt gt 6 3 1 Defining Form Properties To create a new form or Administration form e Click on the New Form or New Administration Forms button in the General
478. tents of a text file on the server and place the contents in a text or memo field This may be used to display the files contents in a calculated memo field Remove list entry List You use this option to specify that Metastorm BPM is to remove a specified entry from a list You need to specify the list from which the entry is to be removed and the position of the entry in the list 1 2 3 or whatever the position may be To Do list List You use this option to specify that Metastorm BPM is to return the list of users who have the specified folder on their To Do lists User s staff List You use this option to specify that Metastorm BPM is to return a list of the staff who have a specified role and report to the user you specify Watch list List You use this option to specify that Metastorm BPM is to return the list of users who have the specified folder on their Watch lists Microsoft Office adaptor Lists all Microsoft Office related functions 314 May 2008 Metastorm Inc 2008 Designer User Manual SERVER CATEGORY ACTION RESULT TYPE DESCRIPTION Send email You use this option to specify that Metastorm BPM is to construct and send an email message You may specify email addresses or the names of any intended recipients Note To use this option the name of the recipient s must exist in the address book for the mail system
479. tents of the specified filename obtained from the server file system For example GetText C My Documents Text file txt A This function supports both ANSI and Unicode files The function examines the first two bytes of the file it is reading if it detects byte order mark it treats the file it is reading as Unicode otherwise it assumes that the file is ANSI 382 May 2008 Metastorm Inc 2008 Designer User Manual Manager userID role fallback_role Arguments userID a string identifying the registered Metastorm user whose manager is required role a string identifying a role that the manager must hold fallback_role a string identifying a role to be returned in the event that userID has no manager with the specified role Returns string the ID of the registered Metastorm user to whom userID reports or to whom the person user reports to reports and so on who also holds role If no such user can be found an empty string or the optional fallback_role will be returned This information is obtained from the Metastorm database For example Manager User Name everybody User Name User s direct manager or user Manager Originator VP CEO Originator s VP or CEO ReadAttachment folderID filename Arguments folderID a string value containing the Folder ID for the attachment filename a string value containing the name of the attachment Returns string the Base64 encoded attachment M
480. tessebececesceoensnies 261 10 1 1 The Integration Wizard Interface cccccccccssssessssssesessnseseseescsesesseceseseeecseseeceseseeseseaeeaeaeeees 263 10 1 2 Using the Integration Wizard to Create a New FOrmulld i csccccscescccessesesseseescsseseesesensens 264 Integration Wizard Example Assign Value sccesssssseceseseeseceesesesecesseessesesseensaeeusacesessesaenees 265 Integration Wizard Example Conditional Operation 0 0 0 0 sesesssssceeessssecsseeeeeeseseencnceeesseeseenees 269 10 1 3 Condition B ilder seieren in ei iien cetentes 270 TOTA Add ins necunoasterea iat 271 LOFI Form l FUT n etere sesso e E E E E os leaves EE 271 Usine th Form la Editor eree rae E ENEE EEE EEEE RE EE 271 10 1 6 Accessing Databases eececesesessescsesesseseseeecsesesssesesecscseassceseseseesesesecseaeaseaeaeseeecaeseeaeaeeeeeeaees 272 Fable Name S Areuiment sree iarrar a EE E EEE S 273 Column Name s Areument enerne EE RA 273 Column Values Argument Data Source ArQument s nin inrit i iese E EEEE REE E E EEES UserName ATSUMETE a adel veh E E EE EA E EE EON T AEAEE Password Argument Row Condition s Argument 10 1 7 Accessing Directories Direct Directory ACCESS eeccccscsscsecscssesecscsseseesesseseescssesesseseesens 274 S ttmg up the LDAP abas honi daesseasscbddcesiscodsspe aiara aa iaa Ea i iaaa 274 Searching the Directory oisein ie reniei aani EE es E EAEE a Taa etia EaR EEEE ETAS EEE Eris 276 LOTS Custom Variables sienne s e eeii in 278 10
481. tesszeuveesssevachscssyeetatesues 252 Using LDAPSearch within dynamic role formulas cesseeeesssseceseceeeesesececsceesesesneneacerees 252 8 1 8 Using the everybody role cecccceccsssssccccssssesesecsesesesesesececseseseeaeseeeseaeaseeeeeseaeeaeseeeceeaeeeeaes 252 Workaround morace credi aea a E A UE OAOE EE NLE EE E e 253 9 UDEFINING FL AGS 02 2 020s cence ces cect Cases cena ica saccades cided cee eee es ennnen mnnn nnn nnmnnn nnne 254 DiD PIAS AEE EE EEEE A AAE AS E E E E T ET 254 9 2 Defining a PAG yasssissessscsascessatsswessstssesncssacveisesasocensseosesncesntessbesssdeesacessecteusensudscsdsestesesecesssdseeevocees 255 DDD Tlg Data so nEn EEA RE AEE ENEE AE iS 255 Metastorm BPM Release 7 6 May 2008 ix Metastorm BPM Release 7 6 DDD Flags Dilo beinaran a Na Rea eese eE Ee a eei aoia oiia 255 9 2 3 Flags Dialog BUuONS opein e EREE A EEE ANERER REENEN ERARE E 256 9 3 Raising Flags from within Procedures ssssssccssssssssssssccsessssscessssesessssssessscasscesssceseseasecs 257 DST Properes edilOF rniii a reiia EE E A A a o 257 9 3 2 Using eraiseflag exe to raise a flag from an external application ccscecceeeseeeeees 258 IFT RECEIVING FLAG TOI aae isa Ai E N NG ke uBR HE NE ASR he 259 10 CREATING FORMULAS sive cisssacicescesccsssisccsssnszccedscascnnsesstenccssncsageat gacseeaveanseascesnsdanaacenass 261 10 1 Integration WIZAE scscccssiscc secsessssessscesscdaceosevtssecacesatesesesssasnsutendeseesscndsas
482. that Metastorm BPM is to add number subtract multiply or divide two numbers or expressions Character Integer You use this option to return the ASCII code of a character code Conditional Integer You use this option to specify that Metastorm BPM is to return number one number if a condition is TRUE and another if it is FALSE Count Integer You use this option to return the number of characters in a characters piece of text Find Integer You use this option to specify that Metastorm BPM is to find substring where one string starts within another Folder action Integer You use this option to specify that Metastorm BPM is to return count the number of actions including creation that have been performed on this folder Folder priority Integer You use this option to return the priority 0 to 9 set for this folder Format Text You use this option to specify an explicit text representation for currency a currency Format text You use this option to specify an explicit text representation for number anumber You may specify the number of decimal places that is to be displayed to and the minimum numbers of characters that the text representation should be Additionally a number of formatting codes can be used Valid format codes are 0 pad with leading zeros rather than spaces align to left rather than right within width prefix positive numbers with explicit sign p prefix positive numbers with a space character always displa
483. that do not require human intervention such as Determining the routing for a folder based on information available in a folder or in a database g Raising or responding to a flag 7 Moving a folder after a timed event z Starting an external application You can set properties and formulas in the Process Designer to accommodate a wide variety of possible actions Forms Within Metastorm BPM you may create forms These forms are used to gather and display information necessary to a business process Roles Participants in a process have roles assigned to them based on either their individual or group responsibilities Assignments within a procedure are made based on these role designations Metastorm BPM Release 7 6 May 2008 19 Metastorm BPM Release 7 6 Flags Flags are used to start or continue parts of an automated business process There are two important aspects to the concept of a flag in Metastorm BPM the Flag itself and the Flagged Action invoked by the flag You can consider the Flag to be an announcement and the Flagged Action to represent what should be done following the announcement For example flags may be used with flagged actions to Create a new folder and pass information to another map Release a folder from a stage where it has been held while awaiting the completion of some other action or event Publishing a Procedure When a procedure has been created it must be pub
484. the LDAP aliases tab in the Procedure Properties 2 2 6 Accessing a library s Integration Wizard collection When a library is associated with a procedure any Integration Wizard categories and items in the library s Integration Wizard collection are included in the Integration Wizard for that procedure 58 May 2008 Metastorm Inc 2008 Designer User Manual 2 3 Working with a Procedure that uses a Library 2 3 1 Library Versions When a library is first associated with a procedure the required version of that library is retrieved from the Metastorm database When the procedure is next published the library components are bound into the process definition in the database When you open a procedure that is associated with a library you are prompted with a Connection dialog You must connect to the database in which the library is stored in order to retrieve the library details for use within the procedure e If you cancel the Connection dialog you are given the opportunity to remove the library reference from the procedure If you choose to remove the reference you may load the procedure without the library Without removing the reference it is not possible to open the procedure without the associated library Warning The Library ChainToMapSeg04_lib could not be loaded would you like to remove the reference Figure 30 Option to remove library reference a If the procedure is loaded without the library and then s
485. the URL at runtime Defining a Grid You can place a table referred to as a grid within Designer to differentiate it from a database table on any form A grid maps multiple rows and columns fields from one or more database tables You can place any number of grids on a form Grids will overlay any background image rule or label elements A If a grid is published against a case insensitive SQL Server database or an Oracle database it can be run only against a case insensitive database or an Oracle database For example if the EUSER column is used in a grid and the procedure is published against a case insensitive database the procedure may only be run against a case insensitive database If the procedure is subsequently to be run against a case sensitive SQL Server database the column and any other columns of the grid must be redefined using a case sensitive database i e the EUSER column should be redefined as eUser This applies to anywhere that table names and column names are used A If you load a procedure containing a grid the properties of the grid may be loaded incorrectly if any of the columns contain subqueries in the SQL To place a grid on a form click on the Grid button on the Form toolbar and then click on the location on the form where you want the grid to be placed Grid Types There are four types of grid e Field has dependants grid A refill occurs each time the client user double clicks i
486. the options on the form s Property Editor Format tab Doing this will affect each field s associated label the text within each field and the size of each field The process developer must set the font size of label fields separately using the Font option on the label s Property Editor Label tab ra If you use the View Text Size option to change the font size in the browser the text in filter drop downs remains the same size Color Blindness We recommend that in order to accommodate color blind users you use in the captions of required fields or choose backgrounds which can be distinguished from the red border by color blind users JAWS for Windows Support An unsighted user may use the Web client with the aid of the JAWS screen reader When designing procedures that will be accessed by JAWS users be aware of the following Placing fields When JAWS reads the contents of a form to the user it reads the contents in the order in which the fields appear on the form from the top left to the bottom right You can aid the user by aligning each field caption to the left or top of the field This will ensure that JAWS reads any useful information about the field before reaching the field itself Form fields JAWS announces regular HTML field types to the user It tells the user the field type and in some cases provides instructions on how to populate the field In Metastorm BPM there are some complex field types that are ma
487. the toolbars are identified in Table 9 below The functionality associated with these buttons will be described in greater detail in the sections on Map and Form creation Map Toolbar Form Toolbar Button Button Name Button Button Name Pointer arrow Image User Stage Status Group Stage Label System Stage Rule Sub procedure Stage Command Button Eo E R E V e a i k i RB Rules Stage Attachment Clip o Common Stage Check A Archive Stage Number he Use Map Segment Currency Ju User Action kA Date Time P Flagged Action Text a Timed Action i Drop down Conditional Action Radio Group af Rendezvous Action E List 2 Comments Mie Memo iA Signature fo Grid z Dataset D Form Segment Table 9 Buttons on the Map and Form toolbars Metastorm BPM Release 7 6 May 2008 37 Metastorm BPM Release 7 6 1 3 4 Procedure Explorer When a procedure is open Procedure Explorer displays a tree representation of all its items Procedure Explorer provides quick and easy navigation of the procedure Figure 13 below shows the Procedure Explorer when the Flight sample procedure is open Procedure Explorer Blank Forms a Manager 4 Traveler E Check class IR withdrawn amp Travel Department vp Awaiting Flight IF Flight taken E Forms amp Roles B8 Custom Variables d Flags 5 common E Forms 8 Roles Flags
488. ther of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Form s Notes Properties This tab of the Properties editor displays a memo field that the process designer may use to make designer notes These notes will not be seen by end users 6 4 Form Element Properties Form elements are the background and interactive items you can place on a form These elements are selected using the Form toolbar amp Y For details refer to Table 18 in Section 6 1 1 When Designer places a form element on the form it displays the corresponding Properties editor 6 4 1 Dependencies Dependency properties for form elements are set on the Do This tab of the form element s Properties editor The following options are available to any fields mapped to a folder or custom variable that is any data field that can be used for input when the form is used in an action e Field is dependent on another Checking this box tells the Process Engine that whenever a new value is received from a client the Process Engine must recalculate the value of this particular field e Field has dependants of its own Checking this box tells the Metastorm client or browser that whenever the value in the field is changed by the user the new value needs to be sent immediately back to the Process Engine so that the form can be refilled with new
489. thin the oemdesigner xml file under the lt Variables gt lt Variables gt node This file is located in the Metastorm BPM Designer folder 4 Select the Data type as follows Integer whole numbers no decimal places The maximum number of digits for an integer field is 10 If you want to enable the user to enter a number with more than 10 digits use a Real number Check for the entry of True or False values only Memo for the storage of large amounts of text Text standard alphanumeric text of up to 250 characters Real numbers up to 15 decimal places Date time dates and times Currency for entry of currency formats Metastorm BPM automatically sets the default data type to match the field type you are defining Metastorm BPM Release 7 6 May 2008 105 Metastorm BPM Release 7 6 A You can change the data type but if you do the new variable you are defining cannot be used for the data field you are defining The only exception is for a Number field where you may choose either a Real or an Integer variable Once you have created the variable you cannot change the data type A The Memo data type is used for complex types For further information refer to 5 Complex Types 5 If you are defining a Text variable you also need to enter a value in the Maximum size field This field is the size used to hold the name of any Metastorm object such as a folder server or user The default size for text field
490. ties editor Metastorm BPM Release 7 6 May 2008 131 Metastorm BPM Release 7 6 Properties Employee details Properties Employee details Form name Employee details C Extemal form Tab order Ea EmployeeName E Department Ei Postition fy Grade fg Address1 fg Address2 Eg Town ag PostCode Eig State p DOB V Married E NumberChildren om StartD ate Figure 84 Properties editor Each form element has a Properties editor tab specific to the type of element Other tabs of the Properties editor are common to several different form elements but may display different property fields or require instructions based on the type of form element you are working with This section is organized by form elements and includes instructions for working with all Properties editor tabs for each type of form element individually The Properties editor can be set to a floating dialog or it can be docked to the sides or top or bottom of the main pane When docked to the main pane perimeter a push pin is available that sets the editor to hide when not selected The Properties editor can be toggled on or off using e The buttons on the General toolbar e The View menu or e Right click on the form and select Properties from the popup menu that appears Many of the properties you can modify through the Properties editor require you to enter a formula In most cases these fields will include options for calling on the In
491. to the library select Component New Form Segment A new form segment is displayed and added to the Procedure Explorer In a library form segments may be added to map segments or the Common group A form segment added to the Common group does not have access to custom variables Fields are added to a form segment in the same way as when building a form amp Refer to section 6 for information on building forms Map Segments Map segments can be used for subsections of processes that are repeated This saves the process designer creating the subsections more than once They may also be used to break down a large map into several smaller map sections The main map serves to link all the map segments together Map segments e Can be nested i e they may contain other map segments 52 May 2008 Metastorm Inc 2008 Designer User Manual e Can have multiple end points but only one starting point e Can define roles that are accessible by the parent procedure and other map segments To add a new map segment to the library select Component New Map Segment A new map segment is displayed and added to the Procedure Explorer You add stages actions roles flags scripts and custom variables to a map segment in the same way as you would when creating a map amp Y Refer to section 3 for instructions on creating maps Scripts Client and server side scripts stored in a library may be called from any map or form in the procedur
492. toolbar or e From the Component menu select the New Form or New Administration Forms option Designer places an empty form in the Form Editor and displays the Form toolbar A form item is added to the Procedure Explorer The Properties editor displays the following tabs for defining form properties e Form e Format e Do this e Notes Defining a Form s Form Properties Properties Employee summary Properties Employee summary Form name Employee summary C External form Tab order Fog EmployeeName Fg Postition fag Department fj Grade Fog EmpNumber w9 StartDate Te RepartsTo Metastorm BPM Release 7 6 May 2008 133 Metastorm BPM Release 7 6 Figure 85 Form Tab General properties for a form are defined on the Form tab of the Properties editor On the Form tab of the Properties editor enter a short meaningful name for the form in the Form name field The following characters are not supported in the Form Name field e Pipe I e Period e Dollar Sign e Equal Sign e Back Slash e Quotation Mark e Forward Slash e Percent e Comma e Plus e Colon e Semi colon e Open bracket lt e Close bracket gt The name is displayed when the user opens a folder that includes this form The name field may not be left blank The form name must be unique for each form in a single procedure A A number of words have s
493. tor dialog 3 Ifacustom variable has been assigned to the drop down field the Do this tab will display a When Changed option instead of a calculation formula In the When changed field enter any command the system is to perform when the contents of this drop down field are changed For the commands in the When changed field to be performed when the field is updated the Field has dependants of its own checkbox must be checked 4 If you selected a system variable or created a new custom variable for this drop down field the Field has dependants of its own check box will be displayed on this tab of the Properties editor This field instructs the system to immediately notify the Metastorm engine when any item in this drop down field is selected This is necessary if any other fields on the form are dependent upon the content of the drop down field A This box must be checked if any other fields are dependent upon values in this field 5 Enter any commands to be performed by the system when the drop down field is entered or exited in the Client extensions field You may create and edit the formula using either of the following tools Click on the Integration wizard button to open the Integration wizard Click on the Formula editor button to open the Formula editor dialog Defining a Default Value for a Drop down Field A drop down list can have a default value A default value is setup in the Do This tab of a Form Properties In th
494. torm BPM modify them as follows SELECT COUNT DISTINCT eUserName FROM eUser SELECT COUNT UNIQUE eUserName FROM eUser 386 May 2008 Metastorm Inc 2008 Designer User Manual Staff userID role fallback role Alt Delimiter Arguments userID a string identifying the registered Metastorm user whose staff are required role a string identifying a role that the staff must hold fallback_role a string identifying a role to be returned in the event that userID has no staff with the specified role Alt Delimiter an optional string specifying the delimiter to use in place of a comma Returns list a comma delimited list of staff members who hold role and directly report to the userID If no such staff members can be found an empty string or the staff holding the mandatory fall back role will be returned This information is obtained from the Metastorm database For example Staff User Name everybody All user s immediate reports Staff Originator secretary Originator User s secretary or self ToDoList folderID Alt Delimiter Arguments folderID a string identifying the folder which the users to be listed have on their ToDo lists Alt Delimiter an optional string specifying the delimiter to use in place of a comma Returns list the list of all users who have the specified folder on their ToDo list obtained from the Metastorm database For example ToDoList FolderID All users with thi
495. torm BPM Release 7 6 5 The remaining formulas on this screen f true and Otherwise may also be created using either the Formula editor or the Integration wizard 10 1 3 Condition Builder There are a number of places within the Integration wizard where you can build up a condition When required Designer will display the Condition Builder dialog see Figure 187 above 1 Enter a value manually select a field whose value is to be tested from the list in the Left formula drop down or click on the Integration wizard button to build a formula for the value you require 2 Select the comparison to be made from the Comparison drop down You may select from the following options Comparison v equals greater than less than not equal less than or equal greater than or equal Figure 189 Comparison Options 3 Enter a value manually select a field to be compared against from the Right formula drop down or click on the Integration wizard button to build a formula for the value you require 4 When you have completed the first line of the condition you can add more lines by clicking on the And button if you want all your conditions to apply or by clicking on the Or button if you want any of your conditions to apply 5 To remove a line from the condition click on the Remove button at the start of that line 6 If you want to express an order of precedence by including parenthesis enter them as appropriate i
496. tton Button Name N Pointer arrow Date Time R ea Image abe Text Status Drop down a pal Label Radio group a eC Rule Frame List E Command Button Memo AI pial Q Attachment Clip Ed Signature zl Check Grid Number Dataset fey 3 ame tel 33 Currency Form Segment pane peen Table 18 Form toolbar Buttons The form toolbar is dockable It can be selected and dragged to the main pane where it forms a palette or it can be dragged to either side of the main pane where it docks in a vertical orientation 6 1 2 Working with Form Elements The Edit menu contains a number of options for working with form elements 128 May 2008 Metastorm Inc 2008 Designer User Manual A 4l Cut Ctrl X Bi Copy Ctrl C B E Delete Del S Find and Replace Ctrl F Select All Ctrl 4 Bring to Front Send To Back wa eee Figure 83 The Edit Menu Depending on the form elements you have selected different options may be unavailable in which case they are grayed out Adding Elements to a Form You add a form element by clicking on the desired button on the Form toolbar and then clicking the location on the form where you want the element displayed You may also add an element and then change the type through the Properties editor if necessary A To add several copies of a particular form element hold down the Shift key while clicking on the desired element button then click at e
497. tween 1 and 9 3 4 1 Working with Actions You can draw any number of actions from any stage except an Archive stage With the exception of Conditional Timed and Rendezvous actions you can also draw them from the Start Box You can draw an action back to the same stage creating a loopback action or to any other stage but you cannot draw an action to the Start Box Adding Actions to a Map To add an action to a map click on the appropriate action button on the Map toolbar Place the action on the map by drawing a line with your mouse between the two stages that the action will connect Actions may be repositioned on the map by clicking on their icon and dragging it to a new location As you move an action the connecting lines between stages are redrawn A To add several copies of a particular action hold down the Shift key before clicking on the desired Action button Action names can use characters which are configured with a default locale of North American Western European or Central European character sets However action names cannot include any of the following characters Pipe Period Dollar Sign Equal Sign Back Slash Quotation Mark Forward Slash Percent Comma Plus Colon Semi colon and Angle brackets lt gt Metastorm BPM Release 7 6 May 2008 85 Metastorm BPM Release 7 6 Deleting Actions from a Map Actions may be deleted from a map by selecting the d
498. ty threshold is set to 20 and the Danger threshold is set to 10 The following table illustrates the state dependent on the current value Current Value State 10 Danger 20 Safety 11 Warning 21 Safety 9 Danger 19 Warning Table 22 Example values and their states for a Sales Lead example 200 May 2008 Metastorm Inc 2008 Designer User Manual The following diagram illustrates which states these example values fall into in pictorial form States 21 20 Exapk Vales 20 10 Thresholds Table 23 Example values and their states for a Sales Lead example Example Three In a Sales process it may be useful to show the status of sales of various products on a form such as the following i Open Web Links Sales PortaloMetastorm BPM Server Met EBK Product Product Sales Status Figure 135 Example Metastorm form showing use of status field The user selects a product from the dropdown and the status field indicates the status of the sales for that product To allow the same status field to be used for each product the Safety and Danger thresholds are defined as percentages of the target value The target value and current value are calculated using values from a database depending on the chosen product For this example assume that the Safety threshold is 50 of the target value and the Danger threshold is 10 of the target value If the target value calculates to 120
499. type of action except a rendezvous action from a common stage Archive No further processing is expected You can draw any type of action to Stage Folders at an archive stage will not an archive stage Do this Fz appear on any users To Do or You cannot draw any type of action Notes m Watch lists from an archive stage Map Allows you to reuse common You can draw any type of action toa Stage Segment sections of a map When a folder Map Segment stage Do this reaches a Map segment stage it You can only draw a rendezvous Notes 76 May 2008 Metastorm Inc 2008 Designer User Manual Stage Purpose Rules Properties editor Tabs Comments Enters text boxes onto procedure maps for the addition of comments Table 13 Stages There are two types of property tabs you can define for stages e stage independent tabs and e stage dependent tabs 3 3 1 Stage independent Tabs The following stage related properties tabs are common to all stages e Stage e Roles e Do this e Notes Defining Stage Properties Properties Manager Stage name Manager Type Icon in Available pages Flight reservation Flight request YP approval C Flight request progre Sample Library Make Sample Library Note Sample Library Audit Figure 47 Stage Tab Enter the name of the stage in the Stage name field This will be the name displayed on an end us
500. u can refer to it whenever you are designing or modifying a procedure This list will help prevent you from using different naming conventions for the same role in different procedures which could result in a number of redundant roles e g the names Marketing Director Mktg Director Marketing Dir and Mktg Dir all refer to the same role but each would have to be assigned separately through the Users and Roles tool e Dynamic A role assignment evaluated in the context of a particular folder when the procedure is processed for example the originator of a folder Dynamic roles may be based on formulas database queries content cached from directories etc The following dynamic roles are set up automatically by Designer Everybody is used to specify all users registered in the database amp Y For further information on using the everybody role refer to section 8 1 8 Using the everybody role Metastorm Administrator is used by individuals with authority to administer the Metastorm system and should be assigned to at least one registered user This role may also be used by the process designer when creating and testing a procedure Originator identifies the user who created a folder Access identifies all users who hold the role identified in each map s Limit access to property Metastorm Guest is used to allow access by anonymous users To Do list is used to indicate all users on
501. u may select from any of the following usage options Optional field Required input field the form cannot be submitted until the field has been completed not applicable for a calculated field a checkbox or a button Read only field not applicable for a button Hidden field A field will be hidden when a user is undertaking this action but not when the folder is viewed at a stage The default usage value for each field is defined by the process designer when the fields are added to the form amp For more information refer to Chapter 6 Forms page 125 To change the default value click in the Usage column for each field to see a drop down and make your selection from the available usage options A If the field Usage property is set to hidden for a particular action when a user clicks on the action and the form is loaded the hidden field is not sent to the browser Therefore no other fields on the form can reference i e have visibility dependent on the hidden field Metastorm BPM Release 7 6 May 2008 95 Metastorm BPM Release 7 6 Defining a User Action s Roles Properties Properties Change flight Properties Change flight Administrator Any YP everybody eWork Administrator eWork Guest Guest Manager Metastorm Administrator Metastorm Guest v originator To Do list v Travel Department v Traveler YP Watch list Figure 59 User Action Roles Tab When defining a User acti
502. u will not be using a dataset with this field Using a dataset means that any required information necessary for calculating the information displayed in this field will be read directly from the dataset rather than require an additional call to the database Any datasets previously defined for use with this form will be displayed in the drop down list For more information on creating datasets see the Defining a Dataset Field topic in this section 2 Ifyou wish to change the caption enter the new caption in the Caption field If you omit this or have selected calculated as your variable the signature field will be displayed with a default caption of Signature plus an auto incremented number 3 Identify the variable you wish this field to use in the Variable field There are a number of options If the signature is to be calculated at run time select calculated from the list You will be able to specify how it is calculated on the Do this tab If the signature is to be stored in the database you can select a variable from the drop down list Only memo variables will appear in the list You can create a new custom signature variable by clicking on the New custom variable button and specifying the details of the variable You cannot create a new custom variable if you are using a dataset for this signature field If you are using a dataset select the column name the system should use to calculate the information for this f
503. ubmitted From the Category menu select Form Extensions Next from the Item menu select Run a submit script To run a script when a form is cancelled From the Category menu select Form Extensions Next from the Item menu select Run a cancel script To run a script when a button is pressed From the Category menu select Button extensions Next from the Item menu select Run a button script To run a script when the user enters a field From the Category menu select Data Field extensions Next from the Item menu select Run a field entry script To run a script when the user leaves a field From the Category menu select Data Field extensions Next from the Item menu select Run a field exit script To run a script when the user leaves any cell of a grid From the Category menu select Data Field extensions Next from the Item menu select Run a cell exit script To run a script when the user enters a memo field From the Category menu select Memo extensions Next from the Item menu select Run a field entry script To run a script when the user leaves a memo field From the Category menu select Memo extensions Next from the Item menu select Run a field exit script Table 38 Functions and Corresponding Integration wizard Items amp For details of fields on which the field exit and field entry events are available refer to Table 40 Availability of field exit and e
504. ue select it and then click Delete To reorder the lines of the formula select a line and click the Up or Down buttons in the Integration Wizard dialog 10 1 1 If you start the Integration wizard when your cursor is positioned in a property that contains no The Integration Wizard Interface commands Designer displays the main Integration wizard dialog with a list of all categories The relevant category and available items within that category are displayed The main Integration wizard dialog box contains the following components as illustrated Category GP Most recently ured F Ab turctone oy Comenert P Condbons opersbon P Delete attaches P Oclete fhe P Dates ord teres S P Deectory rieg aon P Pret rege docunent F Mesooett Dechange adaptor 7 Pimce flag UP Metantorm BPM Grtabane item List p Ederma danao adrptor as P Fie sdapior F Fokter riomaon P Fom heidi D Lte and memos P Maroro Olice adaptor D Numbers P Poun aqynch cornet P Ran rire opi P Aun server sppkcaton F Save sttochnent oy Save loide to hie Send emal y P Wite tte O Tet lunctora Cancel Figure 177 Integration Wizard Screen Components The following table lists the Integration Wizard components Component Purpose Title Bar This displays the name of the property for which you are setting the formulas Hide invalid If this box is checked Designer will hide any category or item options that do not
505. uiring completion You can draw rendezvous actions Do this reach an archive stage The to any stage except a common Notes Rendezvous can be set to trigger stage when all or just one of those Simulation If you draw more than one defined reach completion rendezvous action from a stage they will be evaluated in the order of the priority set on the Action tab of the Properties editor Table 14 Action Types F A loopback action is any action that updates a folder but does not move it on to a different stage By default when a loopback action is taken on a folder Metastorm BPM does not regenerate the list of users who have the folder on their To Do or Watch lists It simply updates the details for this folder in each list Using the properties on the Roles tab for a loopback action you can modify this functionality so that the To Do and Watch lists are regenerated A While the Designer allows you easily to make modifications to a procedure at any time you should keep in mind that any changes you make to a live procedure one that is already in use in your organization will not be retroactive For example if you add a Timed or Flagged action to a stage and there are already folders sitting at that stage these new actions will not apply to those folders However new folders arriving at the stage will be affected by these changes A The Metastorm BPM Notify Gadget only displays folders with priorities be
506. ula they must be reformatted using Replace to produce a valid comma separated role list For example Replace SLDAPSearch lt alias gt lt filter gt lt attribute gt 0 newline 0 r r 8 1 8 Using the everybody role If you are designing a procedure for a large number of users we recommend that you do not give all the users access to a stage or an action using the everybody role 252 May 2008 Metastorm Inc 2008 Designer User Manual All roles are published as formulas that return a list of usernames The everybody role is published as the following formula mw SGetData eAssignment eRoleName everybody eUserName This formula returns a list of usernames of users who have the everybody role assigned to them i e all users When a folder is created the role formula is evaluated to determine whose To Do and Watch lists the folder should appear on A new alert is created for each user whose username is returned by the formula If the role is set to everybody an alert is created for each user When a folder is opened the role formula for each action is evaluated to determine whether the action is available to the current user If the current user name exists in the resulting list the user is given access to the action In a setup with a large number of users this is not efficient We recommend that you do not allow stages or actions to be accessible to
507. ulation Properties The Simulation tab allows you to define the settings required to run a simulation of the procedure and process the results through a process analysis tool The Simulation tab is available for each Action in the procedure however the available fields differ for a creation action the first action on the map and subsequent actions Defining a Creation Action s Simulation Properties Properties P flight request Properties VP flight request Folder created every Figure 56 Simulation Tab for Creation Action The Simulation tab for a creation action i e the first action on a map requires you to specify how often a folder will be created for the simulation 1 Inthe Folder created every property enter a number 2 Inthe elapsed property select the appropriate unit of time from the drop down You may select from minutes hours days 1 day 8 hours weekdays 1 weekday 8 hours weeks 1 week 5 days months 1 month 20 days 92 May 2008 Metastorm Inc 2008 Designer User Manual Defining Simulation Properties for Later Actions Properties Business Action progresses the folder with a probability of 10 Figure 57 Simulation Tab for Later Action The Simulation tab for normal actions requires you to specify the probability that the selected action will progress a folder 1 In the Action progresses the folder with a probability of property enter a numbe
508. umber 12 34 2 7 0 012 34 FormatNumber 12 34 0 4 12 FormatTime timestamp format Arguments timestamp a date time service time to be formatted Metastorm BPM Release 7 6 May 2008 371 Metastorm BPM Release 7 6 format Returns string For example a string used to specify the format built from the following elements c dddddd ddddd dddd ddd dd mmmm mmm mm yyyy yy hhh hh h nn n Ss s tttt general date format from server locale long date format from server locale short date format from server locale full name of weekday from server locale first three letters of weekday name two digit day of month 01 to 31 one or two digit day of month 1 to 31 one or two digit week of year 0 to 52 one digit day of week 0 to 6 Sunday as 0 full name of month from server locale first three letters of month name two digit month of year 01 to 12 one or two digit month of year 1 to 12 four digit year 0000 to 9999 two digit year 00 to 99 one to three digit day of year 1 to 366 one or two digit hour o clock 1 to 12 two digit hour of day 00 to 23 one or two digit hour of day 0 to 23 two digit minute of hour 00 to 59 one or two digit minute of hour 0 to 59 two digit second of minute 00 to 59 one or two digit second of minute 0 to 59 long time format from server locale AM PM hh nn ss with AM or PM indicator a represent
509. und 99 995 Round 99 995 2 Round 99 995 2 1 Round 1030 3 Rounding for currencies and Engineers Rounding for Real numbers 100 100 00 1199 99 1000 378 May 2008 Metastorm Inc 2008 Designer User Manual Substring start length string Arguments start a number identifying the first character to be copied where the first character in the string is character 1 length a number of characters to be copied string a string from which a substring is to be copied Returns string the copied substring For example Substring 3 3 abcdef ede Substring 4 3 ABCDEF DEF Weekdays start date days Arguments start date the date from which to calculate days an integer representing the number of days to add Returns date the resulting date after the number of days specified by days has been added to the start date For example W eekdays 2 8 2004 1 Returns 2 9 2004 Metastorm BPM Release 7 6 May 2008 379 Metastorm BPM Release 7 6 Access Functions Access functions return a result obtained via access to the file system or database but have no other effect on the system They will generally return different values for any given set of arguments depending on the state of the file system and database when they are called Access functions may be used in any property whether as part of an assignment command or more frequently as stand alo
510. urchase order totals Metastorm BPM Release 7 6 May 2008 337 Metastorm BPM Release 7 6 A It is not possible to take the Purchase Order procedure offline 338 May 2008 Metastorm Inc 2008 Designer User Manual Training This procedure was written to help the facilitation of training classes Training Course map l Places E again This process deals with courses and whether or not they are full j New course Full F Fully subscribed Course started Course o Ta Started Figure 241 Training Sample Procedure Training Course Map Student Enrolment Map This map deals with student applications to join courses Note that only holders of the role Training Administrator can withdraw people from a course or force their enrollment into a course when the course is full Apply for course No places left Confirmation Oversubscribed a Ec gt E Withdrawn A Enrolled withdrawn Forced enrolment Figure 242 Training Sample Procedure Student Enrolment Map Metastorm BPM Release 7 6 May 2008 339 Metastorm BPM Release 7 6 Preparation To prepare this procedure for use register the users who will participate in the procedure You may use the Set Up procedure to add sample users to your Metastorm system Points to Note Although at first glance this appears to be a simple procedure using maps with only a very few stages and simple forms it is quite a
511. ure This option also provides a list of the most recently opened procedures Save Procedure lt Alt gt lt F gt lt S gt Saves the open procedure or lt Ctr gt lt S gt Save As lt Alt gt lt F gt lt A gt Copies the open procedure and displays the standard File Save dialog allowing you to specify a new file name and location Save Definition lt Alt gt lt F gt lt D gt Saves procedure details to a text file Includes information about components and elements 28 May 2008 Metastorm Inc 2008 Designer User Manual Option Access Key and Function Shortcut Close lt Alt gt lt F gt lt C gt Closes the procedure with the option of first saving changes to the procedure Procedure Properties lt Alt gt lt F gt lt E gt Displays the Procedure Properties dialog which allows you to enter information pertaining to the Owner Company Password and Description associated with the procedure The dialog will also display the date and time the procedure was last saved and published Publish lt Alt gt lt F gt lt L gt Publishes the current procedure to the database Only published procedures are accessible by registered Metastorm users Retrieve lt Alt gt lt F gt lt V gt Displays the Retrieve Procedure dialog which allows you to select a previously published procedure and retrieve it from the database Validation lt Alt gt lt F g
512. urns a complex type Elements of the complex type are mapped to Metastorm custom variables To map complex type simple data type members to Metastorm custom variables A The steps below assume an Activator has already been run and the resulting Integration Wizard Collection library has been associated with the current procedure 1 Create custom variables for the input and output parameters 2 Add fields to a form 3 Assign custom variables to all fields Get Client Record Input ID Get Client Record Company Name Metastorm ID Address 1 Metastorm First Name Metastorm Address 2 Metastorm Last Name Metastorm Area Metastorm Email Metastorm City Metastorm Phone Metastorm Postcode or Zip Metastorm Country Metastorm Figure 70 Complex Types Form Example Metastorm BPM Release 7 6 May 2008 111 Metastorm BPM Release 7 6 4 Add a memo custom variable to the Map This custom variable will be used to store a serialized representation of the Complex Type data amp This memo custom variable can serialize the complex types data as XML SOAP or Binary 10 11 Select Assign a value Select the memo custom variable In the Do This tab click the Integration Wizard button Click on the Integration Wizard button for the Value Integration Wizard Assign value lt Value gt getClientRecord Category C
513. ust as though the folder had arrived from another stage This is useful in a stage at a point when some update occurs that changes the data used in evaluating a dynamic role Unless the Rebuild To Do list option is checked the data change would not affect the To Do list Metastorm BPM Release 7 6 May 2008 97 Metastorm BPM Release 7 6 Leave it Normally when a loopback action is taken Metastorm BPM does not regenerate the list of users who have the folder on their To Do or Watch lists Selecting this option instructs the system to update the folder data affected by the action but not to re evaluate the users on the To Do and Watch lists This is the default option Defining a Timed Action s Time Properties Properties Automatic withdrawal EJ 0 Automatic withdrawal x Start this action p months v After Before jsEntryTime O OOOO O O Figure 61 Timed Action Time Tab If you are defining a Timed action you need to identify the time when the Metastorm Process Engine will start the action You do this by specifying the number of time units that are to elapse before the action begins The default Time tab property settings start the action 1 hour after EntryTime To set a Timed Action s start time 1 Enter the number of time units in the Start this action field This can be a Metastorm expression Select the time units to be used from the drop down in the second field You may selec
514. value in the Variable property for the caption by default You may enter a new caption in the Caption field if desired AA multiple attachment grid does not have a caption 3 Select the name of the variable associated with this attachment clip in the Variable field There are a number of options If the attachment name is to be calculated at run time select calculated from the list The calculation returns the name of a clip which must already exist because the field is read only you can t save a new attachment to the clip You will be able to specify how it is calculated on the Do this tab Ifthe attachment name is to be stored in the database you can select a variable from the drop down list Only text variables will appear in the list You can create a new custom text variable by clicking on the New custom variable button and specifying the details of the variable 150 May 2008 Metastorm Inc 2008 Designer User Manual A The text variable must be large enough to hold the file name of the attachment It is strongly recommended that the text variable be defined with a length of 250 characters as the process designer has no control over the file names that a user will place on a clip The variable you select on this tab of the Properties editor will determine the fields that appear on the attachment clip s Do this tab Designer stores the variable in the database table for the map the associated with the current f
515. via the Integration wizard do the following 1 2 Open the Properties editor for a selected item on either a map or a form In this example we will be defining properties for a Button so the Button Action option Client operation was selected on the Button tab of the Properties editor Properties Button1 Properties Button1 Caption Client extensions Select Transmissior Hint Default action usage optional Button action Client operation Figure 222 Properties editor Click on the Integration wizard button The Integration wizard opens 298 May 2008 Metastorm Inc 2008 Designer User Manual Integration Wizard Client extensions Run a client side script when the button is clicked Category ltem Hide invalid gP Form extensions Button extensions Data field extensions oe Grid extensions Run a button script Figure 223 Integration wizard Main Menu 3 On the Integration wizard Main Menu you will see categories of functions or variables that can be used for calling a client side script To run a script to trigger one of the three client events follow the instructions in the following table Client Event Category and litem to Select To run a script when a form is loaded From the Category menu select Form Extensions Next from the Item menu select Run a form script To run a script when a form is s
516. who have the folder on their To Do or Watch lists just as though the folder had arrived from another stage This is useful in a stage at a point when some update occurs that changes the data used in evaluating a dynamic role Unless the Rebuild To Do list option is checked the data change will not affect the To Do list e Leave it Normally when a loopback action is taken Metastorm BPM does not regenerate the list of users who have the folder on their To Do or Watch lists Selecting this option instructs the system to update the folder data affected by the action but not to re evaluate the users on the To Do and Watch lists This is the default option amp The Remove from To Do list is not a valid option for a loopback Flagged action and is therefore inactive Metastorm BPM Release 7 6 May 2008 101 Metastorm BPM Release 7 6 Defining a Rendezvous Action s Maps Properties Properties Ready v Facilities v Payroll v IT Figure 65 Rendezvous Action Maps Tab Rendezvous actions are used in conjunction with Sub procedure stages to move the parent folder from a sub procedure stage when one or more of its child folders have arrived at archive stages When defining a Rendezvous action you need to specify the submaps associated with this action Select the submaps using the check boxes in the Submaps property In the Wait for submaps to complete property click the appropriate radio button to specify e That the
517. will not return an error when sending messages to an invalid queue path This is by design Metastorm BPM Release 7 6 May 2008 397 Metastorm BPM Release 7 6 To register a WebSphere out queue enter the following URL http lt APPSVR gt 9080 eUMS services Mess agingService wsdl where lt APPSVR gt is the name of the Application Server Returns boolean TRUE on success otherwise an Metastorm formula exception Run application arguments Arguments application a string identifying the server directory path name and extension of the application to be run If the path is omitted the server s Windows path will be used If the extension is omitted an exe will be assumed arguments a list of arguments to pass to the application Returns command loads from the server file system and then runs the specified application with any specified arguments The application in question must be installed on the same system as the Process Engine evaluating this function The function executes asynchronously the evaluation suite returns control to the engine as soon as the request has been queued not after it has been serviced For example Run C Program Files my application App exe EW Run Notepad SaveData folderID filename Alt Delimiter Arguments folderID must be the string FolderID filename a string identifying the server directory path name and extension of a file to receiv
518. wontecencdeececseucsveevendacecksveseendeCosveedevesneecens 106 4S Folder V arahles aoea NE ENAN N 107 Metastorm BPM Release 7 6 May 2008 v Metastorm BPM Release 7 6 AA ASSIOTITIG A Valles ceckcsscscissasvenceceselessveontececesesesseesvosincecnentecencdeieceusencsatececestaciovesnenceCeesiedesesnencenes 108 5 COMPLEX TYPES oivcaeccx si cceasscacesccsctveciratcens cues sevecbesssvuuchscevethsctveksctacsuecesnususesscciersiascersers 110 5 1 1 Generating a Complex Types Library ecccccccccsscsccccssssesesesenseseseeececseseaeseeeeeeaeseaeaeeeeeeaes 110 5 1 2 Retrieving Data from Complex Types eccccccccccccscssesssesscsesessesesecenseaeseeeeeeseneeaeseeeeeeaeneeas Til kd Retrieving data into fields cceccccccccccscsscsccsssesscssssessssessessessecesessesscseeseeseseeseeseseeseeeeseesenees Til 514 Pop lating List DOK sinirinin aa a isa Aa a a 114 SAD Populating a Dropdown ersero a a aN N EEE EAEE ESENE S 114 5 2 Map Complex Type Dial0g sn secccccciaiasssccosscesssasscontoocncesocntececdedecocseacsetececestacsevessenseConv csesoonensens 115 S2 COMMAS ie erii sesh E EREN A RE A E AE E EE EERE EE ENERO a 116 DDL LOODAN a EEEE EE E NOTAN EERE a 116 3 2 3 Return Value mrearama ina ashes Baa lath E E R E ETN 117 9 2 4 Serialization n e E a a E A E Soci 117 Saen aT AE E O E E eee E EE E 118 Right Mouse M t ioen o S e EE e OSE EAEE EN EEE E SAR ane 118 5 3 ComplexTypesUtils Support Library sssescsescssoscososcososcscseo
519. xt formula String Attempts to convert formula to a string currency formula Money Attempts to convert formula to a money data type For example Table 45 Typecast Operators Metastorm BPM Release 7 6 May 2008 405 Metastorm BPM Release 7 6 mylnteger integer myReal truncates real value Logical Operators These may be used to construct complex logical formulas Logical formulas are evaluated in the order listed below with the most tightly binding shown first The following table lists the logical operators Operator Name Operator Type Function condition condition Changes TRUE to FALSE and vice versa formula formula condition Returns TRUE if both formulas evaluate to the same value Panny ee eee Sonata Returns TRUE if the first formula evaluates a value greater than the second i Returns TRUE if the first formula evaluates a value less than the formula lt formula condition second ormus form l condition Returns TRUE if the first formula evaluates a value greater than or equal to but not less than the second sis Returns TRUE if the first formula evaluates a value less than or formula lt formula condition equal to but not greater than the second brmalaezs form la condition Returns TRUE if the first formula evaluates a value not equal to the second condition amp condition condition Returns TRUE only if both conditions are themselves TRUE condition
520. y a comma is used as the delimiter row_delimiter an optional string delimiter to be placed between each row in the result set If omitted or empty a comma is used as the delimiter Returns list an alphabetically sorted list of unique values from the specified rows and column of the specified table in the specified or Metastorm data_source For example Metastorm BPM Release 7 6 May 2008 381 Metastorm BPM Release 7 6 GetData eFolder eParent FolderID eFolderName All child folder names GetData DSN CustData UID sa PWD xyzzy CustomerTable CountryCode USA CustomerName All US customers GetFolder table folder variable Alt Delimiter Arguments table a string identifying the custom table holding the required custom variable folder a string to be used in a SQL WHERE clause to select the required row from table variable a string identifying the custom variable column whose value is required Alt Delimiter an optional string specifying the delimiter to use in place of a comma Returns string the value of the custom variable for the specified folder held in the specified map table in the Metastorm database For example GetFolder Flight eFolder eFolderID Parent Class Parent folder s Class variable GetText filename Arguments filename a string identifying the server directory path name and extension of a text file whose contents are to be read Returns string the con
521. y decimal portion even if zero b return empty string if value is zero AP append trailing character For example Formatting the number 36 2345 to 2 decimal places with a width of 10 characters and the format codes of 0 would display 000036 23 Formatting the number 36 78 to 1 decimal places with a width of 6 characters and the format codes of would display 36 8 Maximum integer You use this option to specify that Metastorm BPM is to return number the largest of a list of numbers Minimum integer You use this option to specify that Metastorm BPM is to return number the smallest of a list of numbers Read integer You use this item to specify that Metastorm BPM should read Metastorm a number from the Metastorm database number 316 May 2008 Metastorm Inc 2008 Designer User Manual SERVER ACTION RESULT DESCRIPTION CATEGORY ae Read external integer You use this item to specify that Metastorm BPM should read number a number from a database Read folder integer You use this option to specify that Metastorm BPM is to return number a number value from a folder in another map in this procedure Remainder integer You use this option to specify that Metastorm BPM is to calculate the remainder from the division of two numbers Round integer You use this option to specify that Metastorm BPM is to round number a number up or down to a specified number of
522. y of all notes entered against a folder e The Make a Note form allows a new note to be entered against a folder e The Audit Trail form displays a grid of all actions taken against a folder in the order in which the actions were taken Points to Note e The Make a Note form uses the standard Act ion Notes variable to capture the user s input e The Notes form uses the standard Integration Wizard All Notes item to present a formatted time ordered list of all notes entered against a folder including but not necessarily limited to notes entered via the Make a Note form 322 May 2008 Metastorm Inc 2008 Designer User Manual Set Up This procedure is provided to ease the process of setting up the users and roles information and external table data for the more complex Metastorm sample procedures w T taa c D Set up requested 8 amp Set up B Setup completed Setup completed or failed Delete f Deleted Figure 231 Set Up Sample Procedure The procedure automatically registers 12 sample users without Metastorm passwords Bertie Blauer Jules Joiner Nick Nurse Cathy Cartright Klaus Krammer Paul Pascal Claudia Clueup Lara Linkup Sam Smith Jon Jackson Lucy Laughalot Sarah Singalong It also Metastorm BPM Release 7 6 May 2008 323 Metastorm BPM Release 7 6 Inserts data into the Metastorm Attributes table This table is used to define the roles
523. y selected item or items from the map or or form lt Del gt Metastorm BPM Release 7 6 May 2008 29 Metastorm BPM Release 7 6 Option Access Key and Function Shortcut Find and Replace Opens the Find and Replace dialog that allows you to search for a designated element type and rename it and all references to it as desired Select All lt Alt gt lt E gt lt L gt Selects all the items in the current map or form or lt Ctrl gt lt A gt Move lt Alt gt lt E gt lt M gt Changes the source and destination stage for an action It is hidden unless a map component is selected and disabled unless an action is selected Align lt Alt gt lt E gt lt A gt Aligns the left horizontal center right top vertical center or bottom of a group of elements Bring to Front lt Alt gt lt E gt lt F gt Used to specify which of a group of overlapping elements should be displayed in the foreground Send to Back lt Alt gt lt E gt lt B gt Used to specify which of a group of overlapping elements should be placed in the background Table 3 Edit Menu Options The View Menu You can access the View menu using the shortcut lt Alt gt lt V gt Access keys for the individual View menu options are given in the following table Option Access key Function Properties lt Alt gt lt V gt lt P gt Toggles the Properties editor on off Procedure Explorer lt Alt
524. you should use a List Field To add a drop down field click on the Drop down button on the form toolbar and then click on the location on the form where you want the field to be displayed Designer places a drop down field on the form and displays the corresponding Properties editor The Properties editor displays five tabs for defining drop down field properties e Drop down e Options e Do this e Extra e Notes amp Y For details of the Extra and Notes tabs refer to section 6 4 3 Defining Element independent Properties on page 139 Defining a Drop down Field s Drop down Properties Properties Dropdown1 read only v Figure 112 Drop down Tab 1 In the Dataset field enter a dataset for the system to use with the Drop down list The default option is folder which indicates that you will not be using a dataset with this field Metastorm BPM Release 7 6 May 2008 171 Metastorm BPM Release 7 6 Using a dataset means that any required information necessary for calculating the information displayed in this field will be read directly from the dataset rather than require an additional call to the database Any datasets previously defined for use with this form will be displayed in the drop down list For more information on creating datasets see the Defining a Dataset Field topic in this section 2 Identify the variable you wish this field to use in the Variable field There are a number of options

Download Pdf Manuals

image

Related Search

Related Contents

Windows Embedded Standard 7  Chem Bio Draw  カタログPDFダウンロード[PDF:1.7MB]  SCS 440 - Wylie Sprayers, Inc.  Wildcat 3 - maxgaming qld  

Copyright © All rights reserved.
Failed to retrieve file