Professional Documents
Culture Documents
ORG
Joget Workflow
Getting Started Guide
CONTENTS
1. Getting Started ...................................................................................................................................... 3 1.1. Introduction................................................................................................................................... 3 Overview................................................................................................................................ 3
1.1.1. 1.2.
Installation ...................................................................................................................................10 Installation using the Windows Setup Wizard ....................................................................10 Installation using the Demo Zip Bundle ..............................................................................11 Advanced Installation for Apache Tomcat and MySQL .......................................................12 Advanced Installation For Other Java EE Application Servers.............................................12
Implementing Your First Process.................................................................................................13 Designing a process .............................................................................................................13 Deploying the process .........................................................................................................21 Mapping participants to users.............................................................................................23 Building and mapping forms to activities ............................................................................26 Running and participating in the process............................................................................31 Modifying the process .........................................................................................................32 Using plugins .......................................................................................................................37
1. GETTING STARTED
1.1. INTRODUCTION
1.1.1. OVERVIEW
Joget Workflow is a workflow management system that serves as a platform for users to design, deploy and run workflows for their organization's business processes. The system provides the following features: simple and rapid deployment - design, deploy, run process engine supporting XPDL standard graphical workflow designer graphical form builder process monitoring people-driven, long running processes plugin architecture integration via JSON or Java API
The system consists of the following components as shown in the diagram below:
W ORKFLOW D ESIGNER
Workflow Designer is a graphical tool which allows Process Designers or Business Analysts to create visual process flows based on their business processes. The Workflow Designer can be launched directly from the web browser using Java Web Start technology. After being launched for the first time, it can also run offline.
Once the process is designed, the design can be automatically deployed to the Workflow Engine directly from within the Workflow Designer, or saved as an XPDL file before uploading it. If there is an existing XPDL file, the user can upload it without using the designer.
W ORKFLOW E NGINE
The Workflow Engine is the heart of the system which executes processes deployed from the Workflow Designer. Supporting the XPDL 1.0 standard, the Workflow Engine allows for easy integration to external systems by providing a simple HTTP-based API along with Java and JavaScript libraries. Once the process has been designed, processes are deployed and configured by mapping the activities with participants, forms and tools using the Workflow Management Console. Once the mapping is completed, the users can start and run the process to perform the tasks. The Process cycles can be repeated and each process is versioned using the version control feature.
I NBOX
The Inbox or Task Manager enables users to view the relevant tasks that are assigned to him/her once processes are running. When new task assignments are received, they are listed as bold items in the Inbox.
FIGURE 4: INBOX
The Run a Process feature enables the users to begin a process that is currently available in the system. Processes are versioned whereby when a process is updated the process becomes a newer version. The older version of the process will still be available until it is permanently removed.
F ORM B UILDER
The Form Builder facilitates the designers to create and manage forms to be used by end users to perform their task. Form categories can be created to group related forms together. Forms can be designed and edited using the Form Builder tool. The forms that are completed can be mapped to activities defined in the workflow.
W ORKFLOW M ONITOR
The Workflow Monitor feature enables the system administrator to monitor the workflows running in the system. The system admin can monitor the running processes and update the activities if required. Completed processes or aborted processes and activities can also be monitored. An Audit Trail enables the system administrator to view and monitor the users' activities in the system.
U SER M ANAGER
The Manage Users feature enables the system admin to create and manage organizations, groups and individual users in the system. The users will be used to map to the activities of the workflows. Note: Other user directory implementation (e.g. connection to an LDAP server) can be performed using Directory Manager plug-ins.
M ANAGE M ESSAGES
The Manage Messages feature facilitates users to dynamically create and modify messages and labels within the system.
1.2. INSTALLATION
1.2.1. INSTALLATION USING THE WINDOWS SETUP WIZARD
This tutorial will explain the installation based on the Windows Setup Wizard that contains everything you need to get started. The steps to install are: 1. Run the setup file joget-setup-1.0.0.exe to launch the Setup Wizard.
2. 3. 4. 5. 6. 7.
Click Next on the Introduction page. Click I Agree on the License page. Click Next on the Components page. Change the Destination folder if required (default is C:\Joget), and click Install. Once the installation is complete, click on Finish. To start the Joget Server, go to the Start Menu > Programs > Joget Workflow and click on the green Start Joget Server icon under Joget Workflow. The startup might take some time, so please wait until the message "INFO: Server startup in XXXX ms" appears (XXXX represents the time taken for the startup). Do not close the command window. 10
8.
Go to the Start Menu > Programs > Joget Workflow and click on the Workflow Management Console. The web browser will launch and you should see the Workflow Management Console login.
FIGURE 9: LOGIN
9.
To stop the Joget Server, go to the Start Menu > Programs > Joget Workflow and click on the red Stop Joget Server icon under Joget Workflow.
4. 5.
8.
2. Obtain the bundle joget-windows-1.0.0.zip 3. Create a new directory e.g. D:\joget. Extract the file into that newly created directory. 4. Use the appropriate SQL script in the "data" directory to create the necessary database tables in the
"wflowdb" database
5. Deploy the WAR files under apache-tomcat-6.0.18\webapps to the desired application server. For instructions
on deploying the WAR files, please refer to the documentation for the respective application server.
12
13
Click on the Launch Workflow Designer button. Depending on the browser that you are using, you might be prompted to Open or Save, in which case you can just select Open. If launched for the first time, the Workflow Designer will be downloaded to your computer. A dialog box will appear asking for permission to run the application, so click on Run and the Workflow Designer window will appear. (NOTE: You will need to have a Java runtime installed on your computer)
14
Key in an appropriate ID (no space allowed) and Name for the Package, and click on the Apply button (green tick icon on the top left hand corner) or press Enter
15
Open the Process Properties dialog (Double-click the Workflow Process item in the Navigator pane on the left, or right-click and select Properties) Key in an appropriate ID (no space allowed) and Name for the Process, and click on the Apply button
A DDING P ARTICIPANTS
Click on the Add Participant icon on the toolbar. You are now ready to add participants to the process.
Add participants to the process by clicking inside the diagram. Each click will add a new participant. A participant is represented as a horizontal bar called a swimlane. To stop adding participants, either press Esc, right-click, or click on the Arrow selection icon on the toolbar. For each participant, open the Process Properties dialog (Double-click the Participant name on the left of the swimlane, or right-click the name and select Properties) Key in an appropriate ID (no space allowed) and Name for the participant. You can also set the participant type. For human participants, leave it as Participant. To represent a system, choose System. Click on the Apply button. You can move swimlanes up or down by first clicking on the Participant name and then clicking on the green up or down icons on the toolbar. You can also right-click on the Participant name and select either "Move participant up" or "Move participant down"
16
A DDING A CTIVITIES
Click on the Add Activity icon on the toolbar. You are now ready to add activities to the process. Each activity represents a Form that the participant will interact with. Add activities to the process by clicking inside the desired swimlane, which represents the participant that will perform the activity. Each click will add a new activity.
To stop adding activities, either press Esc, right-click, or click on the Arrow selection icon on the toolbar. For each activity, open the Activity Properties dialog (Double-click the activity, or right-click the activity and select Properties) Key in an appropriate ID (no space allowed) and Name for the activity. Click on the Apply button. 17
You can place the activities in the process by dragging them. Note: Do not add an activity into the System swimlane. Only System Tools are allowed to be placed in the System swimlane.
A DDING T OOLS Click on the Add Tool icon on the toolbar. You are now ready to add tools to the process. Each tool represents a system-related process that performs a specific task e.g. sending an email or updating a database.
Add tools to the process by clicking inside the desired swimlane. Each click will add a new tool. To stop adding tools, either press Esc, right-click, or click on the Arrow selection icon on the toolbar. For each tool, open the Tool Properties dialog (Double-click the tool, or right-click the tool and select Properties) Key in an appropriate ID (no space allowed) and Name for the tool. Click on the Apply button. Note: Tools can be placed in any swimlane, but is recommended to be in the System swimlane for clarity.
C ONNECTING A CTIVITIES AND T OOLS WITH T RANSITIONS Click on the Add Transition icon on the toolbar. You are now ready to connect activities and tools within the process.
18
To connect two activities, click on the first activity and then click on the second activity. Another way to do it is to drag from the first to the second activity.
To complete the sample process, add a Start (green circle on the toolbar) and End (red circle on toolbar) and connect them as appropriate. Alternatively, you can use the "Insert missing start and end bubbles" 19
Once the process design has been completed, you can check on the validity by selecting the "Check validity" option under the Process menu. This will list down errors within the process if there are any.
20
If the upload is successful and the process is valid, you will be brought to the "Update Existing Process" page, showing the package and processes that were deployed.
21
22
If the process is valid and the deployment is successful, a confirmation dialog will be shown and the Workflow Designer will close. To confirm that the package has been deployed, login to the Workflow Management Console. Select the "Design Processes" tab and click on the "Update Existing Process" menu item. The processes should be listed in the list of processes. You can filter according to the package by selecting the "Filter by Package" drop-down.
23
Next, create the relevant group of users. In the Workflow Management Console, select the "Setup Users" tab and click on the "Manage Groups" menu item. Click on the "Create New Group" button at the bottom of the page.
Enter a Group Code, Group Name, and optionally a description for the group. Click on Save to create the group. Repeat for each of the groups you would like to create. To set the users for a group, click on the Group in the list. Click on the "Assign Users" button at the bottom of the page. Click on desired users (you can select multiple rows) and click on the Assign button.
24
In the "Participant Mapping" popup dialog, there are several tabs representing the mapping options. In the first "Map to User or Group" tab, you can either "Map to Group" or "Map to User". Click on "Map to Group". In the listing of groups, click on the group that you would like to map this participant to.
25
Click on the Submit button. Based on this mapping, any of the activities for the participant will be assigned to the selected Group of users. Perform the mapping for each of the participants as desired.
26
A fieldset is a grouping of related fields. Click on the fieldset legend to edit it. The Elements palette on the right contains a list of available field types that can be inserted into the form. Clicking on a desired field type will insert it into the fieldset. 27
Click on the Name and Description of each field to change the labels. Clicking on the Red minus icon on the left will remove the field, while the Yellow star icon indicates a mandatory field. The green Up and Down arrows can be used to move the field up and down within the fieldset. Click on the Advanced Properties icon on the left to open the Advanced Properties dialog. The Name of field is the name of the database column that will be used to store the field data. Click on Save to update the field properties.
28
Once the form has been designed, click on the Save button at the top of the page to save the form.
Click on the Preview button to display a preview of the form in a separate window. When you are done, close the Form Builder window. Click OK when prompted to confirm.
29
In the "Activity Mapping" popup dialog, there is a list of current available forms. Click on the form that you would like to map this activity to.
30
If the first activity in the process is assigned to you, then the Task details will be displayed for your action. Otherwise, the popup window will close and a task will be assigned to the appropriate user.
31
You have an option to save it as draft by clicking on the Save As Draft button. In this case, the task will still be in your Accepted Tasks list for future action. Clicking on the Withdraw Task button will withdraw your acceptance of the task and mark it as pending (bold). Click on the Complete Task button to submit the form and proceed with the next steps in the process where tasks will be assigned to the relevant users.
A DDING A R OUTE
Click on the Add Route icon on the toolbar. You are now ready to add routes to the process. Each Route represents a decision node that can decide on the activity flow of the process.
32
Add routes to the process by clicking within a swimlane. Each click will add a new route. Using transitions (described earlier), connect the route to the desired activities. You can move other transitions by dragging either end of the transitions.
By default, each route's behaviour is exclusive-OR (XOR), which means that only 1 of the transitions will be followed. If you would like to set the route to support multiple parallel transitions, you need to set the Transition Restriction to AND. In this case, open the Route Properties dialog (Double-click the route, or right-click on the route and select Properties). Select the Transition Restriction tab, and select the Split
33
Type drop-down to AND. Click on the Green apply button, and the Route symbol will change to one with a cross.
34
Double-click on the variable row, and in the ensuing popup enter an appropriate ID and Name for the variable.
Click on the green Apply icon to save the variable. Set the activity that will be allowed to update the variable. Open the Activity Properties dialog for the desired activity and select the "Activity form editor" tab. Click on the checkbox for the variable to change it to "Edit".
35
Click on the green Apply icon to save the transition. The expression will show up beside the transition. To set another transition as a default transition that is followed if no other condition is met, set the Condition type to "Otherwise". In this case, the color of the transition will be changed to orange.
36
37
In the ensuing popup dialog, you are presented with a list of plugins that are available in the system. Click on the desired plugin e.g. EmailPlugin The Plugin Configuration dialog will be displayed. Each plugin will have its own configuration page, key in the appropriate settings for the plugin.
Click on the Submit button at the bottom of the dialog to save the configuration settings.
38