Joget Workflow v2 Getting Started

  • View
    6.061

  • Download
    3

Embed Size (px)

Text of Joget Workflow v2 Getting Started

  • 1. WWW.JOGET.ORG Joget WorkflowGetting Started Guide

2. Getting Started 1.0 Joget Workflow Getting Started Guide CONTENTS 1. Getting Started ...................................................................................................................................... 31.1. Introduction................................................................................................................................... 31.1.1. Overview................................................................................................................................ 31.2. Installation ...................................................................................................................................101.2.1. Installation using the Windows Setup Wizard ....................................................................101.2.2. Installation using the Demo Zip Bundle ..............................................................................111.2.3. Advanced Installation for Apache Tomcat and MySQL .......................................................121.2.4. Advanced Installation For Other Java EE Application Servers.............................................121.3. Implementing Your First Process.................................................................................................131.3.1. Designing a process .............................................................................................................131.3.2. Deploying the process .........................................................................................................211.3.3. Mapping participants to users.............................................................................................231.3.4. Building and mapping forms to activities ............................................................................261.3.5. Running and participating in the process............................................................................311.3.6. Modifying the process .........................................................................................................321.3.7. Using plugins .......................................................................................................................37 2 3. Getting Started 1.0 1. GETTING STARTED1.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 APIThe system consists of the following components as shown in the diagram below:FIGURE 1: SYSTEM COMPONENTS 3 4. Getting Started 1.0W 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.FIGURE 2: WORKFLOW DESIGNER 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. 4 5. Getting Started 1.0W ORKFLOW M ANAGEMENT C ONSOLE The Workflow Management Console is a web based application that allows users and administrators to use the system through a web browser. FIGURE 3: WORKLOW MANAGEMENT CONSOLE MENU 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: INBOX5 6. Getting Started 1.0 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.FIGURE 5: FORM BUILDER 6 7. Getting Started 1.0 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. FIGURE 6: WORKFLOW MONITOR 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.7 8. Getting Started 1.0FIGURE 7: MANAGE USERS S YSTEM S ETTINGSS YSTEM S ETUP The System Setup feature facilitates the system admin to set CSS, system paths, locale and intervals for the system. Multiple profiles of data sources can be created and modified to enable dynamic switching of profiles when required.For other user directory implementations such as connecting to an LDAP server, the system admin can a select and configure the Directory Manager plug-ins in the system. Therefore, the use of the internal users' management may not be required.M ANAGE P LUG - INS The Manage Plug-ins feature enables users to add and update plug-ins dynamically to extend the functionality of the system. Users can upload and update plug-ins on the fly without restarting the system.As the system is using a plug-in architecture, different types of plug-ins namely form variable plug-ins, application plug-ins, participant plug-ins, audit trail plug-ins and Directory Manager plug-ins can be uploaded into the system. 8 9. Getting Started 1.0 M ANAGE F ORM V ARIABLES The Manage Form Variables feature enables the users to create form variables by uploading Form Variable plug-ins. This enables the users to extend the options of form fields in the system.M ANAGE M ESSAGES The Manage Messages feature facilitates users to dynamically create and modify messages and labels within the system.9 10. Getting Started 1.01.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.FIGURE 8: SETUP WIZARD2. Click Next on the Introduction page. 3. Click I Agree on the License page. 4. Click Next on the Components page. 5. Change the Destination folder if required (default is C:Joget), and click Install. 6. Once the installation is complete, click on Finish. 7. To start the Joget Server, go to the Start Menu > Programs > Joget Workflow and click on the green Start JogetServer 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 thecommand window. 10 11. Getting Started 1.0 8. Go to the Start Menu > Programs > Joget Workflow and click on the Workflow Management Console. Theweb browser will launch and you should see the Workflow Management Console login.FIGURE 9: LOGIN9. To stop the Joget Server, go to the Start Menu > Programs > Joget Workflow and click on the red Stop JogetServer icon under Joget Workflow. 1.2.2. INSTALLATION USING THE DEMO ZIP BUNDLE This tutorial will explain the installation based on the pre-packaged demo zip bundle for Windows that contains everything you need to get started. The steps to install the demo bundle are:1. Obtain the demo bundle joget-demo-windows-1.0.0.zip 2. Create a new directory e.g. C:joget. Extract the file into that newly created directory. 3. To start the Joget Server, execute joget-start.bat. This will start the MySQL database server and ApacheTomcat application server. The startup might take some time, so please wait until the message "INFO: Serverstartup in XXXX ms" appears (XXXX represents the time taken for the startup). Do not close the commandwindow. 4. Open the browser to access http://hostname:8080/wflow-wfweb (hostname is the name of the server, e.g.http://localhost:8080/wflow-wfweb) and you should see the Workflow Management Console login. 5. To stop the Joget Server, execute joget-stop.bat and close the previous command window if it is still open.11 12. Getting Started 1.0 1.2.3. ADVANC