cdevworkflow Version 8.8 Configuration Manager User Manual

Transcription

1 cdevworkflow Configuration Manager User Manual

2 Contents 1. Login Dashboard My Profile Workflow Definitions Creating a New Workflow Definition Define Master Variables Manage Master Variables Design the Workflow Definition Rename the Name of a Workflow Definition Remove a Workflow Definition Remove All Instances for a Workflow Definition Copy Workflow Definition Create / Manage Workflow Definition Version Snapshots Get XML Definition Set XML Definition Render Workflow Definition Create a Workflow Definition Report Archiving Workflow Definition Instances Get Workflow Definition as BPMN Add Definitions to Favorites Remove Definitions from Favorites Workflow Definition History Update Waiting Instances Report Archive Instances Usage Table Workflow Instances Page 1 of 162

3 Create New Workflow Instance Generate Instance Run Engine Manually Refresh Page Reset Workflow Instance Reset to Step Remove Workflow Instance Abort Workflow Instance Execute Workflow Instance Execute Workflow Instance with Input Parameters Get Workflow Instance with XML Render Workflow Instance Execution View Render Workflow Instance Create a Workflow Instance Report View Sub-workflows View Instance Archiving Workflow Instances Add to Favorites Remove from Favorites Workflow Instance History Update Waiting Instances Tasks Re-Assign Tasks Form Definitions Create Form Definition Design Form Definition Using the Form designer to build a form Embedding A Form Within Another Form Embedding a form as a sub-form Embedding a form as a grid view Page 2 of 162

4 Using the File attachment control within the form Using the Image control to display images on Forms Using lookups from external sources within a form Rename Form Definition Remove Form Definition Remove Form Instances Copy Form Definition Render Form Definition Get Form Definition XML Get/Set Form Definition HTML Form Definition Favorites Form Definition Instance Archival Form Definition History Form Instances Create Form Instance Rename Form Instance Edit Form Instance Remove Form Instance Render Form Instance Get/Set Form Instance XML Get Form Instance HTML Archive Form Instance Form Instance History Using Forms within Workflow Processes Using the Instantiate Form step within a Workflow process Routing a Form within the process Getting Form field values and saving in variables within the process Setting Form field values using a Workflow step Moving data between forms within a process Generating PDF output documents from a process Page 3 of 162

5 Data Table Business Intelligence Reports BI Data Types Create Data Type Import Data Type Validate Data Type Render Data Type Remove Data Type Update Data Type Export Data Type Table View Auto Detect Data Type Usage Step/Action Categories Creating a Category Remove Category Categorizing Steps Business Objects Import Business Object Remove Business Object Update Business Object Export Business Object Table View Auto Detect Business Object Business Object Properties Business Object Inputs Business Object Usage Steps Creating a New Step Import Step Page 4 of 162

6 Edit Step Update Step Meta data Update Step Icon Edit Step Inputs Add New Step Input Edit Step Returns Copy Step Remove Step Export Step Table view of Steps Suggestive Steps Auto Detect Step Usage Suggestive Steps only Enterprise Service Bus ESB View Events Event Source Event Name Priority Status ReProcess Remove Subscriber Usage Managing Event Definitions Table view Managing Event Handlers Edit Remove Export Table view Page 5 of 162

7 16. Archiving Workflow Instances Settings Users Create New User Update User Assigning / Managing User Roles Remove History Usage Roles Update Remove Manage Users System Roles Application Roles cdevworkflow Status cdevworkflow Status - Expression Evaluator Tool cdevworkflow Status Tool cdevworkflow Status Log Log Download log file in XML,XLS and PDF format Log Clear Today or All Log cdevworkflow Status Connections cdevworkflow Status Web-Services cdevworkflow Status SharePoint-Sites Help Request Enhancement Page 6 of 162

8 1. Login User login screen lets you login and open the cdevworkflow Configuration Manager. Enter the following to login: Username: admin Password: admin Page 7 of 162

9 2. Dashboard After logging into cdevworkflow, the UI will direct to the dashboard screen by default. The dashboard UI provides high level view of many areas of cdevworkflow, such as # of open tasks, # of workflow definitions, # of workflow instances, # of form definitions, # of form instances and # of users. UI also displays many graphs showing the statistics of the week. Page 8 of 162

10 3. My Profile My profile lets you manage your profile properties such as username, full name and . Use the following screen to change the account password. Page 9 of 162

11 4. Workflow Definitions Workflow definitions contain the design for each workflow. Definitions can be managed using the Workflow definitions screen. Definitions UI looks as follows: With this workflow definitions screen the following operations can be performed: Create a new workflow definition Define master variables Design / Open the definition in the workflow designer Update the name of the workflow definition Remove a workflow definition Remove all instances for a given workflow definition Make a copy of the definition Manage snapshots of a workflow definition Get the definition as an xml file Set the xml for the definition file Graphically render the workflow definition Generate a report for the workflow definition Archive selected workflow definition instances Page 10 of 162

12 Manage workflow definition favorites by user Creating a New Workflow Definition A new workflow definition can be create by clicking the Create Definition button. The UI for create new definition looks as follows: Define Master Variables Master variables are variables that can be defined once and applied to each new definition that is created. For example, if customerid is used on every definition, instead of defining the variable each and every definition, customerid can be defined using the master variable screen. Once the variable is defined using the master variables, each new definition will automatically have the customerid variable. Page 11 of 162

13 Manage Master Variables Master variable UI for defining variables looks as follows: Add variables by entering a name of the variable and by selecting a data type for the variable. Remove any variables by selecting them from the list. Design the Workflow Definition Workflow definition can designed graphically using the workflow designer. Select a workflow definition from the list and click the Design button to design the definition. Once the workflow definition is open within the workflow designer, the definition s design can be changed using the functions of the designer. Refer to the Workflow designer on how to use the functionality of the workflow designer. Workflow designer looks as follows with the Page 12 of 162

14 definition open: Rename the Name of a Workflow Definition A definition can be renamed by selecting a definition from the definition list table and by clicking the Rename button. Page 13 of 162

15 Remove a Workflow Definition In order to remove a workflow definition, first select the definition from the list and click the Remove button to remove the definition. Remove All Instances for a Workflow Definition All instances for a workflow definition can be removed by selecting a workflow definition and clicking the Remove Instances button. Page 14 of 162

16 Copy Workflow Definition A selected definition can be copied by selecting an existing definition from the list and by clicking on the Copy button. Create / Manage Workflow Definition Version Snapshots A selected definition can have several different versions over time. This snapshot tool helps you manage those versions by selecting an existing definition from the list and by clicking on the Snapshots button. Page 15 of 162

17 The user can render, get the XML, restore, remove and compare workflow definition snapshots. The Compare function creates this graphical report: Get XML Definition Workflow definitions are stored as xml documents. They can be imported/exported from one environment to another. In order to export the definition, select a definition and click the Get XML button. After clicking the button, UI will let you download and save an xml file containing the workflow definition. Page 16 of 162

18 Set XML Definition An export workflow definition can be imported into the application by using the set button. Select an existing workflow definition and click the Set XML button. Using the set dialog, select the file and import the xml. UI for the dialog looks as follows: Render Workflow Definition A selected workflow instance can be rendered using the Render button. Select a workflow definition from the list and click the Render button. Page 17 of 162

19 A rendered workflow definition will look as follows: Create a Workflow Definition Report A selected definition can have a PDF report generated by selecting an existing definition from the list and by clicking on the Report button. Page 18 of 162

20 Archiving Workflow Definition Instances A selected definition s Instances can be archived by selecting an existing definition from the list and by clicking on the Archive Instances button. Get Workflow Definition as BPMN By using the toolbar icon, the definition can be downloaded as a BPMN diagram file. Page 19 of 162

21 Add Definitions to Favorites Definitions that are being used most often can be added to the Favorites section. Select a Definition and click the Add button to add the Definition to the Favorites section. The added Definition looks as follows: Page 20 of 162

22 Remove Definitions from Favorites A selected Definition can be removed from Favorites section. Selected Definition will be removed from the Favorites section. Workflow Definition History Using the toolbar button History, a full history for the definition can be rendered. History displays who did what for the selected definition in chronological order. Page 21 of 162

23 Rendered Timeline history page looks as follows: Rendered Table history page looks as follows: Update Waiting Instances Update waiting instances functionality allows the user to update/modify the executing definition instance and continue execution with the updated definition. This functionality will be enabled only when the definition instance is in Sleeping status. Page 22 of 162

24 When the definition instance is in Sleeping status and on click on the Update waiting instances icon, the following message should be displayed: On click on OK button, the instance should be should be executed successfully with the updated definition. If there are no Sleeping instances, then the message will be displayed as: Page 23 of 162

25 Report The Report Tab generates a complete.pdf Report of the selected Definition along with the Definition name, steps name, step details and the definition image Archive Instances Archive Instances functionality allows the user to archive the executed instances for the selected definition and they are displayed under the Archive-Instances section. The archived instances are removed from the Definition table list. Page 24 of 162

26 Usage The Usage functionality displays the Usage graph of all the created definitions as shown below: Page 25 of 162

27 Table The Table icon renders the definition in Table view when the definitions are displayed in Usage graph view. 5. Workflow Instances The Workflow Instances tab lets the user manage workflow instances. Instances are created from Workflow Definitions. UI for this screen looks as follows: Following operations can be performed using the Workflow Instance UI: Create a Workflow Instance Run the engine manually Refresh the page Reset a Workflow Instance to the beginning Page 26 of 162

28 Reset a Workflow Instance to a selected step Remove a Workflow Instance Abort the execution of a Workflow Instance Execute the Workflow Instance Execute the Workflow Instance by providing values for input parameters Get the XML for the Workflow Instance Graphically render the execution of the Workflow Instance Graphically render the Workflow Instance Create a report for the workflow instance View sub-workflows for each Workflow Instances View each Workflow Instance Archive selected workflow definition instances Manage workflow definition favorites by user Create New Workflow Instance A new Workflow Instance can be created from a Workflow Definition by clicking the Create Instance button. The following Create Instance dialog is displayed: Page 27 of 162

29 Generate Instance The Generate functionality generates number of Instance name(s) for the selected definition from the pull down menu as shown below: Select a Workflow Definition from the pull down menu list, and Click on the Generate button to create the new Instance. On click on the Create button, the newly generated instance is created. On check of the Execute checkbox, the instance starts executing when clicked on the the Create button as shown below: Page 28 of 162

30 Run Engine Manually By clicking the Run Engine button, the Workflow engine can be executed manually. This will execute the next item to be processed from the request queue. Refresh Page By clicking the Refresh Page button, the information displayed on the page is refreshed to current workflow instance status. Reset Workflow Instance A started workflow can be reset back to its original design by selecting a Workflow Instance from the list and by clicking the Reset button. This is really useful, after executing an Instance, if the design of the workflow changes. A new Instance based on the definition does not have to Page 29 of 162

31 be created in order to re-test the definition. Reset to Step A Workflow Instance can be reset back to any given point of execution, executed step within the Instance. This is really useful, when debugging an Instance. By selecting an Instance and clicking the Reset To Step button, a list of executed steps are displayed for selection. UI will look as follows: Page 30 of 162

32 The drop down selection will display, each executed step and its step execution iteration. After selecting an item from the drop down, click the Reset To Step button to reset the Instance to that point. Remove Workflow Instance A Workflow Instance can be removed by selecting an Instance from the list and by clicking the Remove button. When an Instance is removed, all data associated with the Instance will be also removed. Items such as sub-workflows, tasks and any other associated data. Abort Workflow Instance A Workflow Instance that is in process or running can be aborted by selecting an Instance from the list and by clicking the Abort button. When an Instance is removed, all data associated with that instance is also removed. Page 31 of 162

33 Execute Workflow Instance Execute button will start the execution of a selected Workflow Instance. Select an Instance from the list and click the Execute button. Page 32 of 162

34 Execute Workflow Instance with Input Parameters If a Workflow Instance requires input parameters to be passed in at execution time, by selecting an Instance and clicking on the Execute Params will render the input parameter UI. Based on the variables defined for the Instance, an input parameter UI will be generated. UI may look as follows: Page 33 of 162

35 Using the above UI, the execution priority and date/time to execute the Instance can be also set. Get Workflow Instance with XML By selecting an Instance and clicking on the Get XML button will let you download an XML file containing the design and the execution details of the Instance. Render Workflow Instance Execution View The execution view of an Instance is the serialized execution of the Instance rendered as a sequential execution diagram. By selecting an Instance from the list, and clicking the Execution View button will render its execution view. Page 34 of 162

36 Execution view may look as follows: Render Workflow Instance A Workflow Instance can be rendered graphically by selecting an Instance from the list and clicking the Render button. A rendered Instance will display its execution path relative to the design of the Instance. A rendered execution may look as follows: Page 35 of 162

37 Create a Workflow Instance Report A selected definition can have a PDF report generated by selecting an existing workflow instance from the list and by clicking on the Report button. View Sub-workflows By default only parent Workflow Instances are listed and rendered on the page. By clicking the View Sub-workflow button, the Sub-Workflow Instance list table is updated to display what Instances contain sub-workflows. Page 36 of 162

38 View Instance View Instance will render a hieratical view of the Workflow Instance showing any Sub-workflow processes. Page 37 of 162

39 Archiving Workflow Instances A selected Instance can be archived by selecting an existing instances from the list and by clicking the Archive button. Add to Favorites Add to Favorites will add the selected Workflow Instance to the Favorites section. Page 38 of 162

40 Remove from Favorites Removes the selected Workflow Instance from the Favorites section. Page 39 of 162

41 Workflow Instance History Workflow Instance history can be rendered using the history button on the toolbar. Rendered Timeline history page looks as follows: Page 40 of 162

42 Rendered Table history page looks as follows: Update Waiting Instances Update waiting instances functionality allows the user to update/modify the executing definition instance and continue execution with the updated definition. This functionality will be enabled only when the definition instance is in Sleeping status. Page 41 of 162

43 On click on Update Waiting Instances icon, the following Alert message should be displayed. On successful updation, the following Alert message should be displayed: 6. Tasks When task steps get executed within a Workflow Instance, tasks are created and assigned to users. These tasks can be acted on using the tasks UI. Tasks can be selected by User or Instance (this option is only available if the current user has Administrator privileges, otherwise, tasks for the currently logged in user will be displayed). If User is selected, then all open tasks assigned to that user will be rendered. If Instance is selected, then all open tasks for that Instance is rendered. Click on a selected task to render its contents. Once rendered task can be completed or rejected with a comment. UI for the task may look as follows: Page 42 of 162

44 Re-Assign Tasks Re-assign is an Admin only function, where you can assign tasks from one user to another. 7. Form Definitions cdevworkflow lets users define and manage Form Definitions and Form Instances. These Form Instances can be utilized within Workflow Instances for data gathering, routing, computing etc. Using the Forms menu option within the Configuration Manager, navigate to the Form Definitions tab. Page 43 of 162

45 Create Form Definition A new Form Definition can be created using the Create button on the toolbar. The following dialog will be rendered: Enter a name for the new Form and click the Create Definition button. With this workflow form definitions screen the following operations can be performed: Create a new workflow form definition Design / Open the definition in the workflow form designer Update the name of the workflow form definition Remove a workflow form definition Remove all instances for a given workflow form definition Rename a selected form definition Make a copy of the form definition Manage data tables used within a workflow form definition Page 44 of 162

46 Get the form definition as an xml file Set the xml for the form definition file Graphically render the workflow definition Generate a report for the workflow definition Archive selected workflow form definition View the History of the Form Definition Design Form Definition A Form definition can be designed by selecting Form definition form the table and clicking the Design button on the toolbar. Using the Form designer to build a form Forms designer has 4 main parts, toolbox at left, toolbar on the top, design canvas in the middle and properties windows for each control. Page 45 of 162

47 Form Toolbox contains the following controls: Text label control Text field control Text area control for handling paragraph style text Drop down list control Check box list control Radio button group control Date selection control File upload control Table control Horizontal line control Image control Embed form control Lookup control File Attachment Page 46 of 162

48 In order to add controls to the design canvas, drag a control from the toolbox and drop it on the design canvas. Let s drag a text box to the canvas. Double click on the text box to view the properties for the text box. The text box has the following properties: Select the size of the text box, id or name for the text box, place holder text and whether the field is required or not. After entering the text box properties, click the Save button on the dialog to save the changes. Click the Close button to close the dialog without saving the changes. Click the delete button to remove the control from the design canvas. Next, drag 2 text fields to the form and call them txtfirstname and txtlastname. Also drag a text area control for comments as show below: Page 47 of 162

49 Click the Save button on the toolbar to save the form definition. Embedding A Form Within Another Form Form can be embedded within other forms using 2 methods, as sub-forms or grid views. Both of these provide different functionality, these will be discussed in more detail within the next two examples. Embedding a form as a sub-form Create a second form called TestMainSubForm. Add a bunch of form fields to the new form. TestMainSubForm may look as follows: Let s add couple of text fields and called them Score 1, 2, 3. Next step is to embed this form within the main form we designed earlier. Page 48 of 162

50 Open the TestMainForm within the form designer: Drag and drop the Embed Form icon from the toolbox to the designer. Double click on the subform1 control to view its properties window: Enter the shown values for the Section Name text box and the selection for the Select Form Definitions. Using the drop down list, select the sub-form that was created in the previous steps. Click the Save button on the dialog to save the changes. Page 49 of 162

51 After closing the dialog box, the form will look as follows: Sub-Form is now embedded within the main form. Let s save the changes to the current form using the Save button on the toolbar. Let s test the form by creating a new form instance based on the form definition. Navigate to the form instances tab and click the Create button on the toolbar. Enter the following information on the create dialog: Page 50 of 162

52 Click the Create button on the dialog box to create the form instance. Once created, select the new form instance from the list and click the edit button. Form containing the sub-form will render as follows: Embedding a form as a grid view Create a new form definition called TestMainGrid. Open the newly created form definition within the form designer. Add the following fields to the form: Page 51 of 162

53 Use a table and 2 text fields to build the above form. Click the Save button on the toolbar to save the form. Now let s embed this form within the main form as a Grid View. Open the main form within the form designer and drag a sub-form control to the designer. Navigate to the properties of the sub-form control by double clicking on the control. The following properties dialog will be displayed: Configure the shown values for the dialog, make sure to check the Show as Grid view check box. Click the Save button on the dialog to save the properties. Page 52 of 162

54 The Grid view within the form should render as follows: As you can see, the sub-form is embedded as a Grid view. The Grid view also shows 2 extra buttons, Add and Remove row button icons. When a form instance is being edited, the plus icon add extra rows to the table. Using the icon, rows from the Grid view can be removed. Save the form by clicking the Save button on the toolbar. Let s test the form by creating a new form instance based on the form definition. Navigate to the form instances tab and click the Create button on the toolbar. Enter the following information on the create dialog: Page 53 of 162

55 Click the Create button on the dialog to create the form instance. Once created, select the new form instance from the list and click the edit button. Form containing the Grid view will render as follows: Click the icon to add rows on the Grid View. Click the to delete rows from the Grid view. Page 54 of 162

56 Using the File attachment control within the form Users are able to attach one or more file attachments to a given form by using the file attachment control within the form. Let s create a new form called TestFormFile, the form will look as follows: Drag the file attachment control from the toolbox and drag it to the form. Page 55 of 162

57 Now the form is able to accept file attachments from the user while the form is rendered. Click the Save button on the toolbar to save the form. Let s go to Form Instances and create a new Form Instance called TestFormFile based on the Form definition TestFormFile. Once the Form Instance is created, select the Form Instance from the table and click the Edit button on the toolbar. Page 56 of 162

58 Form Instance should render as follows for editing: Using the Choose File control, select files from the local file system for attaching to the form. Fill the rest of the form fields, form should look as follows: Click the Submit button to save the changes to the form. If the attached file is a large file, then a file upload status bar will be displayed at the top of the form. After submitting the form, the form is rendered for editing again. Notice that along the bottom of the form displays the file attachments for the form. Page 57 of 162

59 Using the Image control to display images on Forms Let s open the form definition created in the previous steps TestFormFile within the form designer. Drag the Image control to the designer from the toolbox. Page 58 of 162

60 Once on the designer, double click on the control to configure its properties: Let s select an image to display within the image control, click the Select Image button to select an existing image or to upload an image. Images can be uploaded and stored within the form itself or in a common area. If the image such a logo will be used within multiple forms, then upload the logo image to the Common storage area. If the image is specific to this form ONLY, then upload to the Form storage area. Page 59 of 162

61 Click the Choose Files button to select an image or images. Now click the image thumbnail and click the Select button to select that image for display. Image control properties dialog will now reflect where the image is coming from. The image properties dialog will render as follows: In order to render the image at a large size, provide the width and height of the image. Page 60 of 162

62 Click the Save button to save the changes. Form definition will display the image as follows: Page 61 of 162

63 Using lookups from external sources within a form Data can be looked up in real-time from other systems using database connections or webservice connections. In order to configure lookups, you must first define your connections. Let s navigate to the cdevworkflow Configuration Manager Status Connections page: Database connections page will render as follows: Page 62 of 162

64 Click the Create button to create a new database connection. Create dialog renders as follows: Enter a name of the connection, type and a connection string. You can also test the connection string right from the dialog before creating the connection. Click the Create Connection button to create the connection. Once the connection is created, it will render as follows: Page 63 of 162

65 Let s navigate to the Form definitions and open the TestFormFile within the form designer. Drag the lookup control to the designer: Double click on the Lookup button to configure its properties: Select the connection type as Database,Select query on the Select Query box. Scroll down on the dialog and map the database fields to the form fields. Let s save the form and navigate to the Form Instances tab. Page 64 of 162

66 Select the Form Instance created from before and click the Edit button to edit the form. Form Instance should render as follows: Click the Name Lookup button for the lookup dialog: Select a row from the lookup dialog box and click the OK button. Based on the selected row, the value mark is entered within the First Name field. Use the same concept to perform a lookup based on a web-service connection Page 65 of 162

67 Rename Form Definition A Form Definition can be renamed by selecting the Form Definition from the list and by clicking on the toolbar button Rename. The following UI dialog will be displayed: Enter the new name for the Form Definition and click the button Rename Definition to change the name. Remove Form Definition In order to remove a Form Definition, select a Form Definition from the list and click the toolbar button Remove. Remove Form Instances All Form Instances for the selected Form Definition can be removed by selecting a Form Definition from the list and by clicking the toolbar button Remove Instances. Page 66 of 162

68 Copy Form Definition A selected Form Definition can be copied by clicking on the toolbar button Copy. Render Form Definition A Form Definition can be rendered by selecting one from the list and clicking the toolbar button Render. Page 67 of 162

69 A rendered Form Definition looks as follows: Get Form Definition XML A Form Definition can be retrieved in XML format by using the toolbar button Get XML. Get/Set Form Definition HTML Form Definition s design can be manipulated externally by getting and setting the XML for the Form Definition. These actions can be performed using the Get/Set HTML buttons on the toolbar. Page 68 of 162

70 Form Definition Favorites Form Definition can be added to, or removed from the Favorites by using the toolbar buttons. Form Definition Instance Archival All Form Instances of a selected Form Definition can be archived using the toolbar Archive button. Page 69 of 162

71 Form Definition History Form Definition history can be viewed using the history toolbar button. History will render as follows: Table view for the history looks as follows: Page 70 of 162

72 8. Form Instances Form instances are created from Form Definitions, these Form instances are either created manually or instantiated automatically through a Workflow process. The following UI shows the Form Instances UI: Create Form Instance A Form Instance can be created using the Create button on the toolbar. The following dialog is displayed for creating the Form instance. Select a Form Definition from the list, provide a name for the Form Instance and click the Create Instance button to create the new Form instance. Page 71 of 162

73 Rename Form Instance A form instance can be renamed by selecting an existing Form Instance form the table and by clicking the toolbar button Rename. The following UI will be rendered: Enter the new name for the Form Instance and click the button Rename Instance. Edit Form Instance Using the Edit function a Form Instance s field values can be edited. Select an existing Form Instance and click the toolbar button Edit. The following Form UI will be rendered: After updating the field values, click the Submit button to save the changes. Page 72 of 162

74 Remove Form Instance A Form Instance can be removed by selecting the Form Instance from the table and clicking the toolbar button Remove Render Form Instance A Form Instance with its Form Fields and values can be rendered by selecting an existing Form Instance from the list and clicking on the toolbar button Render. A Rendered Form Instance looks as follows: Page 73 of 162

75 Get/Set Form Instance XML A Form Instance can be exported out as XML and imported back as XML. Select an existing Form Instance from the table and click the toolbar button Export to get a file containing XML for the Form Instance. In order to Set the XML for the Form, select the Form Instance from the list and click the toolbar button Set, the following dialog will be displayed: Select the XML file from the file system and click the Update Instance XML button to update the Form Instance. Get Form Instance HTML A Form Instance can be retrieved as a HTML document. Select the Form Instance from the list and click the toolbar button Get HTML. Favorites Form Instances Page 74 of 162

76 A Form Instances can be marked or cleared as favorites using the toolbar buttons Favorite Add / Remove. Archive Form Instance Form Instances can be archived by selecting an existing Form Instance from the list and by clicking the toolbar button Archive. Form Instance History Form Instance history can be viewed using the history toolbar button. Page 75 of 162

77 9. Using Forms within Workflow Processes cdevworkflow offers several workflow steps for handling forms related operations within a workflow process. The following steps are provided: Instantiates a new Form Instance from a Form Definition Renames the newly created Form Instance Route the Form Instance to a user for editing and submitting the Form Instance Set Form Instance field values using Workflow variables as mappings Get Form Instance field values and store them in Workflow variables Move data between Form Instance fields Generate an PDF output document using Workflow variable values as place holders Remove Form Instance and its data which is created during the form execution Get File attachments for a Form Instance id that is created during the form execution Using the Instantiate Form step within a Workflow process Let s use the Form Definition TestFormFile that we created within the last couple of steps within the next couple of workflow processes examples. Form Definition looks as follows: Page 76 of 162

78 Page 77 of 162

79 Let s navigate to the Workflow Definitions tab and create a new Workflow Definition called TestFormDef. After the Workflow Definition is created, the definition is open within the Workflow Designer. Drag a Instantiate Form step from the designer toolbox to the designer canvas. Connect the Start step to the Instantiate Form step. Since newly Instantiated form instances are tracked using variable within the Workflow Instance, let s define a string variable called formid1. Page 78 of 162

80 Select Save Click on the Instantiate form step to configure the properties of the step, properties window renders as follows: Page 79 of 162

81 There are 2 main required properties that need to be filled in, first the Form Definition to use, select TestFormFile definition from the drop down list. Next is what variable to hold the id of the new Form Instance. Let s use the variable that was defined in the previous step variable.formid1. Instance Name property is optional, if an Instance name is provided, that name will be used for naming the newly created Form Instance. If an Instance name is not provided, then a GUID is used for naming the Form Instance. Click the Save button to save the values of the properties. Click the Save button on the designer toolbar to save the changes to the Workflow Definition. Let s create a Workflow Instance based on this Workflow Definition and execute the Instance. Navigate to the Workflow Instances tab on the Configuration Manager. Create a new Workflow Instance using the toolbar button Create. Page 80 of 162

82 Select the Definition TestFormDef, provide the name TestFormInst for the name of the new Form Instance and select the Execute radio button for immediate execution of the new Instance. Click the Create Instance button to create the new Instance. Newly created Instance is executed and has a status of finish. Let s render the Instance to view the execution. Page 81 of 162

83 Based on the execution of the process, a new Form Instance should be created. Click on the Form toolbar button on the rendered view to view the list of Forms created by the process. Click on the Form Name to launch and render the Form Instance. Form will render as follows: Routing a Form within the process Let s expand the process that was built by using some of the other Form related steps. Open the TestFormDef Workflow Definition using the designer. Page 82 of 162

84 Let s make the process route the newly created Form Document to user for entering data into the form. Drag and drop a routeform step to the designer and connect the step to the instantiateform step. Now the process should look as follows: Click on the routeform step to configure the step properties. Page 83 of 162

85 The routeform step properties dialog box looks like this.enter the task name property Next enter the variable that holds the id of the form, enter variable.formid2. Click on Select users to route to button to select individual or groups. Select Save to save the selected routed users.save the Workflow definition using the Save button on the toolbar. Page 84 of 162

86 Let s re-execute the Workflow Instance created in the previous steps. Select the Workflow Instance from the list and click the Execute button on the toolbar. The status of the Workflow Instance should change to sleeping, let s render the Instance to view its execution: Page 85 of 162

87 As the rendered Workflow shows, the route form step has route the form as a task to the user. Let s open the task list and complete the form and task. Rendered task with the form displays as follows: Enter values for the first and last name fields and click the Complete Task button to submit the form and the data. Once the task is completed, now the Workflow Instance has a status of finish. Let s expand the process to include some other steps that will demonstrate the capabilities of the form steps. Open the Workflow Definition with the Workflow designer. Page 86 of 162

88 Getting Form field values and saving in variables within the process Next, let s drag the getformfieldvalues step to the designer and connect to the last step on the process. Let s define another variable called lastname with string data type. Page 87 of 162

89 Click on the new step and configure the following properties: and the variables. Next, let s define the mappings between the Form fields Page 88 of 162

90 When the Workflow Instance executes, value of the txtlastname field will be placed in the variable lastname. Let s save the Definition and re-execute the Workflow Instance. Above shows the rendered view of the task containing the form, the following values were entered to the form and the task was completed. Let s render the executed process: Page 89 of 162

91 Click on the last step on the process to view the properties: As highlighted here, the variable lastname contains the value entered into the txtlastname field within the form. Page 90 of 162

92 Renaming the Form Instance within the Process Using the value stored within the variable lastname, let s rename the Form Instance using this value. Open the Workflow Definition within the designer and drag the renameforminstance step from the toolbox to the designer and connect as show in the below graphic. Click on the step to configure the properties and enter the following values: Save the changes to the step and the Workflow Definition. Page 91 of 162

93 Let s re-execute the Workflow Instance to view the change to the Form Instance name. When filling the form, give the value of Simpson for the last name field. Following is the executed path for the Workflow Instance. Navigate to the Form Instance tab to view the list of Form Instances. The list should contain a Form Instance called Simpson, since that was the value give on the form for the txtlastname field. Page 92 of 162

94 Setting Form field values using a Workflow step Open the Workflow Definition within the designer and drag the setformfieldvalues step from the toolbox to the designer. Connect the new step to the last step on the process. Click on the step and configure the following values for the properties: Let s click on the mappings button and set the first name field to a value of Joel. Page 93 of 162

95 Save the step properties and Workflow Definition and let s re-execute the Workflow Instance. Once the Instance executes, open the task and enter a value of Bill for the first name. Submit the task and navigate to the Form Instances page within the Configuration Manager. Select the Form Instance Simpson and render the form, you should see the value Joel within the first name field. Page 94 of 162

96 Moving data between forms within a process Using the moveformdata step, mappings can be configured to move data between 2 Form Instances. Open the Workflow Definition within the designer and add another instantiateform step to the process. Let s define another variable called formid2 with the data type string. following values for the properties: Click on the instantiateform step and configure the Page 95 of 162

97 Let s drag the moveformdata step and connect to the end of the process. Click on the step properties and configure the following values: Page 96 of 162

98 Click the field mappings button and configure following mappings: These mappings will simply move data from form1 to fom2, so the value of field last name will get set in the last name field of form2 and the same for the first name field. Save the Workflow Definition and re-execute the Workflow Instance. Page 97 of 162

99 When the form task is routed, enter the following values to the form: After the task is completed, render the Workflow Instance: Click the Form button on the toolbar to view the forms created by the process. Form with the name Manning got created first, click on the form to view its content. Page 98 of 162

100 Let s render the next Form that was created at the end of the process. As you can see, field data from the first form was populated to the second form by the process. Generating PDF output documents from a process. A process may use many forms to collect data from users and to perform approvals, at the end of the process, an output document maybe created from the data collected by the process. cdevworkflow has a form step called generateoutputdoc. Using this step, a template can be built within the step with variables as value place holders. At runtime the step will perform the variable value substitutions and generate a PDF document. Open the Workflow Definition within the process designer and connect a generateoutputdoc step to the end of the process. Page 99 of 162

101 Let s define a variable called outputfilepath with a string data type. properties: Click on the step and configure the following values for the Click the Document Content button to build the template with variable place holders. Configure the following template: Page 100 of 162

102 Click the Save button to save the template. Save the Workflow Definition and re-execute the Workflow Instance.Render the executed Workflow Instance. Page 101 of 162

103 Click the generateoutputdoc step to view the execution details for the step. Variable outputfilepath shows the path to the generated PDF file. Page 102 of 162

104 Data Table Data tables capture data from forms automatically for reporting and other purposes. Page 103 of 162

105 10. Business Intelligence Reports BI While all workflow performance data is exportable to the reporting software of your choice. Business intelligence reporting is a built-in feature of cdevworkflow. The Business intelligence reporting tab lets the user view runtime and historical workflow performance data. The following operations can be performed using the business intelligence reporting UI: Default BI Dashboard View View BI Step Execution by Instance View Step Execution by Definition View Least/Most Common Executions View Workflow Variable States View Instance Audit Report View Instances by Status View Instances by Date View Engine Alerts by Status View Engine Alerts by Date View Events by Status View Events by Date UI for this screen looks as follows: Page 104 of 162

106 These business intelligence reports can be configured to report data within a specified date range. The selections of today, this week, last week, this month, last month and custom date range are available using the pull down menu. 11. Data Types Data types contain system level and custom data types. System level data types are provided with the product. Custom data types can be built and configure for use within the product. Data types are used to define the type for a step/action property. For example, the decision step has a property called condition that is defined using the data type string. When the decision step is renders on the workflow designer, the condition step property is rendered as a text box. Create Data Type In order to create a new data type, click the Create Data Type button. Page 105 of 162

107 An exported data type can be also imported using the Import Data Type button. Create new dialog looks as follows: For a new data type, provide the data type s name, namespace for the class and the path for the dll file. Note: Make sure the dll file is placed in the following directory: C:\inetpub\wwwroot\cDevWorkflow\bin Import Data Type A given data type can be moved from one machine/environment to another by exporting and importing the data type. Exporting the data type creates a file called datattype.xml. Using the Page 106 of 162

108 Import data type button, import the exported data type: Import dialog looks as follows: Select the datatype.xml file using the Browse button and import the data type Validate Data Type Data Types are validated automatically. Validation status will display in the right hand column. Page 107 of 162

109 Render Data Type A data type can be rendered by selecting the data type and by clicking the Render data type button. The checkbox data type will render as follows: Remove Data Type In order to remove a data type, select the data type from the data type list table. After selecting the row, click the Remove Data Type button to remove the selected item. Page 108 of 162

110 Update Data Type To update a selected data type, select the data type from the data type list table and click the Update data type button. Using the update dialog, update the information for the data type. Export Data Type Export a data type by selecting the data type from the data type list table, click the Export data type button to export. Browser will prompt you to download an.xml file for the exported data type. Page 109 of 162

111 Table View Allows the user to display the steps in the table view as shown below: Auto Detect Auto Detect functionality allows the user to detect and re-configure/restore the deleted Data Types along with their Namespace and DLL values.for example, the Clscheckbox Data type is removed from the Data Types page.the Clscheckbox data type gets restored when the user goes to the Auto Detect page, selects the Clscheckbox data type and clicks on the Configure icon as shown below: The Data types which is used in the configuration cannot be removed and Auto detected. Page 110 of 162

112 Data Type Usage Displays the horizontal bar graph showing how many times each Data Type is being used within Workflow Definitions Page 111 of 162

113 12. Step/Action Categories Categories provides categorization of steps/actions into different buckets. Steps are categorized and displayed within the cdevworkflow designer toolbox as shown below: By default, all steps are shown on the toolbox. As the # of steps grow, it makes easier to find them when the steps are grouped. cdevworkflow groups some of the steps into Database, Engine and Fie System steps. Each category is configurable. Creating a Category A new category can be created by providing a name for the new category and by clicking the Create Category button. Remove Category A category can be removed by selecting it from the list and by clicking the Remove Category button. Categorizing Steps Steps can be categorized by selecting a category from the list. Selected and unselected steps are rendered on the right side. By selecting unchecked steps, they will be automatically Page 112 of 162

114 assigned to the selected category. 13. Business Objects Business Objects are the custom entity objects which can be passed within the workflow process. Import Business Object Allows the user to Import the Business Object XML within the application. Page 113 of 162

115 Remove Business Object Allows the user to remove the selected Business Object from the application. If the Business Object is used with a definition, then the application does not allow the user to delete the selected Business object and a message is displayed to alert the user. Page 114 of 162

116 Update Business Object Updates the existing Business Object name, Namespace and DLL path as shown below: Export Business Object Allows the user to export the selected Business Object XML file. Table View Displays the table view of the Business Objects within the application Page 115 of 162

117 Auto Detect Business Object Auto detects the deleted Business objects and helps the user in restoring the objects along with their properties and inputs. The deleted Business object is displayed in the Auto detect page as shown below. Page 116 of 162

118 On selecting the Business Object and clicking the Configure icon, the deleted BO is restored back to the Business Object page as shown below: Business Object Properties Displays the Properties defined for the selected Business Object Page 117 of 162

119 Business Object Inputs Displays the Inputs defined for the selected Business Object Page 118 of 162

120 Business Object Usage Displays the graphical statistics of the Business Objects Usage within the cdevworkflow application. Page 119 of 162

121 14. Steps Steps are used in workflow definitions to automate the process. Steps perform specific functionality based on the parameters configured on the step. Steps can be linked to each other using connections. Workflow definition with steps and connections will look as follows: cdevworkflow provides many standard workflow/bpm steps such as task, synchronize, decision, loop and etc. Users are able to create their own steps and configure them using the steps page. Newly configured custom steps can be used within workflow definitions. A step contains 3 parts, Meta data for the step, inputs for the step and the returns for the step. Page 120 of 162

122 Creating a New Step Once a new step is developed and compiled using Microsoft Visual Studio, the DLL can be configured using the Create step definition button. The following dialog is displayed: Enter the following Meta data for the step: Name name of the step. Use lower case for the step name Description description for the step Index position for the step to appear on the toolbox Page 121 of 162

123 Category category for the step Namespace namespace for the step Dll path path for the dll file Click the Create Step Definition button to create the step. Once the step is created, edit the step to define its step inputs and returns. Import Step A given workflow step can be moved from one machine/environment to another by exporting and importing the step. Exporting the step creates a file called stepname.xml. Using the Import Step button, import the exported Step: Import dialog looks as follows: Select the stepname.xml file using the Browse button and import the step Page 122 of 162

124 Edit Step Select a step to edit from the step listing table. Once selected, click the Edit Step button. Update Step Meta data Using the step edit screen, Meta data for the step can be updated. Step s Meta data includes, its name, description, index, category, namespace and path to the dll. Update Step Icon Steps icon can be updated using the step edit screen. UI looks as follows: Page 123 of 162

125 Using the Browse button, select an icon file and click the Upload Icon button to upload the new icon file. Note: icon file name should be named same as the name of the step. Icon file should be saved in the PNG format. Icon file should have height and width of 40 pixels by 40 pixels. Edit Step Inputs Using the step edit screen, step s inputs can be updated. New step inputs can be added, existing steps inputs can be removed. Existing step inputs can be updated. User interface looks as follows: Add New Step Input Click the Add new input button to create a new input. UI for adding a new input looks as follows: Edit Step Returns Steps return values can be managed using the step edit screen. UI for looks as follows: Page 124 of 162

126 Add New Step Return Click the Add new return button to add a new step return. UI looks as follows: Copy Step Copy step makes and identical copy of the step, name of the step is appended with -copy. Page 125 of 162

127 Remove Step Removes the selected step from the step configuration. Export Step Exports the selected step as an XML configuration file. Page 126 of 162

128 Table view of Steps Displays the list of steps in a table format. Page 127 of 162

129 Suggestive Steps The Suggestive Steps functionality enables the user to select and display the configurable steps for the selected Step. The configured steps will be displayed in the Designer page Select and check the desired suggestive steps as shown below: Page 128 of 162

130 Now goto the Definition Designer page, select the abortinstance step and right click on the step, the suggestive steps added in the above screenshot will be displayed as shown below: Auto Detect Auto Detect functionality allows the user to detect and re-configure/restore the deleted steps along with their Step Input properties and Return values.for example, the Copyfile step is removed from the Steps page.the Copyfile steps gets restored when the user goes to the Auto Detect page, selects the Copyfile step and clicks on the Configure icon as shown below: Page 129 of 162

131 Page 130 of 162

132 Step Usage Displays the horizontal bar graph showing how many times each step is being used within Workflow Definitions. Page 131 of 162

133 Suggestive Steps only Displays all the Steps which contain suggestive steps as shown below: Page 132 of 162

134 15. Enterprise Service Bus ESB Enterprise Service Bus uses the publisher-subscriber model to process events. Events can be generated by internal/external systems, ESB service will perform actions on these events based on the Event handlers configured for the event. ESB UI looks as follows: View Events View Events page displays all the events that were created, executed and processed by the user.the details of the Events are displayed as below: Page 133 of 162

135 Event Source Event Source allows the user to select and view the Engine events based on the Event source available in the Select Event source drop down. The user can view all the events related to the selected Event source. Page 134 of 162

136 Event Name This functionality displays the Events based on the Engine Event name selected from the drop down. Priority This functionality allows the user to view the Engine events based on the Event priority selected from the available drop downs. Page 135 of 162

137 Status This page displays the Engine events based on their status such as Event Executed, Published or error occurred. ReProcess ReProcess functionality allows the user to re-execute the failed Engine events by selecting the error Engine events from the Select event status drop down and click on ReProcess icon. Page 136 of 162

138 After the failed event is reprocessed, the event will be removed from the error status list and be displayed under Executed event list Remove Subscriber Allow the user to removes the selected Subscriber from the list as shown below: Page 137 of 162

139 Usage Shows Engine Events activity processed by user within the cdevworkflow sytem Page 138 of 162

140 Managing Event Definitions Events can be managed by clicking on the Event Definitions menu item. The New Even Definition can be created as shown below : Table view The Table icon displays the Table view icon of the Event Definitions which are displayed in Card view by default Page 139 of 162

141 Managing Event Handlers Events can be managed by clicking on the Event Handlers menu item. The New Event Handlers are created by clicking on the Create icon as shown below : Page 140 of 162

142 Edit Allows the user to edit the Event Handler properties as shown below: On click on the Edit icon a pop up window with the Event Handler properties are display as shown below: Remove Removes the selected Event Handler from the list as shown below: Page 141 of 162

143 Export Exports the selected Event Handler XML as shown below : Auto Detect functionality allows the user to detect and re-configure/restore the deleted Event Handler along with their Namespace and DLL values.for example, the ClsCreateInstance Event Handler is removed from the Handler page.the ClsCreateInstance Handler gets restored when the user goes to the Auto Detect page, selects the ClsCreateInstance Handler and clicks on the Configure icon as shown below: Page 142 of 162

144 Table view The Table icon displays the Table view icon of the Event Handlers which are displayed in Card view by default The Table view is as follows: Page 143 of 162

145 16. Archiving Workflow Instances A selected definition can be archived by selecting an existing instances from the list and by clicking on the Archive button. Archive UI looks as follows: Archived Form Instances looks as follows: Settings Archival interval configuration for Workflow Instance and Forms. Page 144 of 162

146 17. Users Users screen lets you manager workflow users. Each virtual workflow user is mapped to a real user from the source application. Create New User To create a new user, click the Create User button to create the new user. Page 145 of 162

147 Enter the information for the new user and click the Create User button. Once, the new user is created, a new row will appear on the user table. Update User To update a selected user, select the user on the user table and click the Update button. Enter the new or edited information for the user and click the Update User button. Page 146 of 162

148 Assigning / Managing User Roles To update a selected user, select the user on the user table and click the Roles button. Enter the new or edited information for the user and click the Apply button. Page 147 of 162

149 Remove Removes the selected User from the list. History This functionality displays the complete User History of the selected User as shown below: Page 148 of 162

150 Usage Shows activity by user within the cdevworkflow system. Page 149 of 162

151 18. Roles The Roles page displays all the Application Roles and System Roles used within the application as shown below: Update Allows the user to update the Application Role name as shown below: Page 150 of 162

152 Remove Allows the user to remove the selected Application Role as shown below: Manage Users Allows the logged in user to add and remove Users to the selected Application role. System Roles Displays the Graphical Usage of the System Roles within the application: Page 151 of 162

153 Application Roles Displays the Graphical Usage of the Application Roles within the application: Page 152 of 162

154 19. cdevworkflow Status The Status UI display configuration information for cdevworkflow such as version information, database information, configuration and database changes. Each of the toolbar buttons will render status information for the cdevworkflow product: Page 153 of 162

155 Version cdevworkflow version number Licensing License information and the status of the license Culture displays the application culture being used for rendering culture based data such as date/time formats, currency format, etc. Database displays the database connection string information Fail-Over displays the fail-over configuration information Service displays the services and their statuses Cache displays the file system based caching file used by cdevworkflow to improve performance Request Queue displays the status of the requests, view requests waiting to be processed by the engine and completed requests Settings-allows the user to configure the SMTP details which are used while sending s from the system Application Settings-allows the user to configure global application level settings Version Changes Version changes shows what database and configuration changes that are required to be made when upgrading cdevworkflow to a newer version cdevworkflow Status - Expression Evaluator Tool There are two workflow tools incorporated with the cdevworkflow product. The first is the expression evaluator. The expression evaluator UI looks like this: Page 154 of 162

156 The expression evaluator tool lets you evaluate any expression outside of a Workflow Instance. It becomes cumbersome to test out or evaluate expressions within Workflow Instance execution, for that reason, we have provided a full fledge expression evaluation tool within the Configuration Manager. This tool accepts any C# format expression including variables. Page 155 of 162

157 cdevworkflow Status Tool There are two workflow tools incorporated with the cdevworkflow product. The first is the expression evaluator. The expression evaluator UI looks like this: The second is the Tool. The Tool UI looks like this: cdevworkflow Status Log The cdevworkflow product includes an application log that manages errors and information messages logged by the application. The log is configurable to review information by occurrence date or source. The Log UI looks as follows: Page 156 of 162

158 By clicking on any of the log messages, a detail stack trace of the message will be displayed. Log Download log file in XML,XLS and PDF format Allows the user to download all the Error log files in XML,XLS and PDF format by selecting any of the icons as displayed below: The downloaded XML format is as follows: Page 157 of 162

159 Log Clear Today or All Log Allows the user to clear/delete Today or All Error log files. cdevworkflow Status Connections cdevworkflow manages connections to other databases through the connections UI: Page 158 of 162

160 Connections can be defined and maintained within this UI. These connections are utilized by the form lookup function to lookup data in real-time. cdevworkflow Status Web-Services cdevworkflow also manages connections through the use of Web-services. Web-services can be defined and maintained within this UI: cdevworkflow Status SharePoint-Sites Manages the configuration of SharePoint sites within cdevworkflow. Page 159 of 162

161 Create SharePoint Site dialog looks as follows: Page 160 of 162

162 Help Contains various help resources including how to get in touch with cdevworkflow customer support. The various Help categories available in cdevworkflow application are: Documents-provide documents for the usage and application guide Samples-Sample examples for the usage of the application modules and steps Blog-Application related blogs will be displayed for the user guidance Templates-Workflow example Templates for the better understanding of the application Help-Code Snippets and Support forum VS Projects-Templates for step project,data Type project,event Handler project and Business Object projects. Request Enhancement Allows the users to request for new Enhancement for the application by providing the following details Page 161 of 162

163 Page 162 of 162