WASP User Guide

WASP User Guide

Pages

Welcome

The welcome portlet to WASP has no functionality it’s just some information about WASP and what can be done using the software.

Process Designer

The tool allows users to create processes to automate actions for them. The processes can make REST calls to any end point which opens a list of endless possibilities that a process could execute. The call could retrieve data which based on the value might do x,y or z.

The frond end has an easy to use BPMN graphical user interface with drag and drop functionality.

Initial Screen

img

Main Screen

img

Top Left Menu

New Process : Create a new empty process

Open: Load another process you’ve previously worked on inside the tool

Save as: Saves the process for you to work on again in the future

Marketplace: Add services from the Marketplace into your process to make REST calls to anywhere

Publish: Sends the process to the Camunda Engine ready to be executed from the control panel

Export: Download the process to your machine

Canvas

Drag tools from the left on to the canvas (events/activities/pools/gateways)

Click on the element on the canvas for various options such as changing the gateway type or assigning conditions

You can also click on an existing element on the canvas and append a new element to that and a flow will also be added for you to link them

Tutorial for the elements and a more in-depth guide with examples: https://camunda.com/bpmn/

Marketplace

The marketplace is where users can browse available services and add their own services too. Currently all of the services are free and available to use. It is possible to mark a service as private and then only your user will be able to see this service on the page or also in the list of services from the process designer.

img

Control Panel

The control panel allows you to manage your processes. Available actions are to start a new instance of a process, delete a process and all instances or suspend a process so that no new instances can be started.

img

This is the first screen of all of your processes with the actions on the right.

If I were to start an instance of the first process and then select manage process instances this is the next screen we will see:

img

In this screen I can then manage the individual instance of a process. Actions are view, suspend and delete the instance. If I were to view the instance it would look like:

img

Here the element with the green background is the current step of the process.

Tasks

The my tasks portlet allows user to complete user tasks which have been assigned to them.

img

The actions are to start the task and fill in the form in the next screen or to close the task.

These tasks can be used as part of a process where manual user input is required.

img

In the example there was no fields to fill in as the process used the user task as a wait for when the user is ready to move on to the next stage of the process.

Getting Started Example

Sign into WASP

• https://efpf.icelab.cloud/ • Login/Register

WASP Open Process

• Open Designer (from the tabs at the top) • Create a new Process; Import this file Download

Explanation of Process

img

• Click on the user tasks (ones with person in top left) and edit the Assign to User to your username in the list, so that you receive the user task. • Click on the gateway in the middle to see how it decides which direction to go.

img

• The variable randomPerson is generated in the Generate Random Name service task. You can see the variable in the Task Outputs if you click the Generate Random Name service task.

Running The Process

• Assign the User tasks to yourself if you haven’t already done that. o you can do this by clicking on the user tasks (person in top left) and Assign to User drop down, click on your name. o Remember to click Save on Each user task. • Click on Save Process In Engine and give it a name. • Click on Start Process In Engine (if you make any changes to the process you will have to click Save Process In Engine button again). •

How To View/Manage Your Process

• Go to Control Panel page. • Find your Process and Click Actions and then Manage Process Instances • Then Click Actions and then View Process Instance • You can see where in the Process you are currently at from here.

img

• There are also other commands such as: o Running another instance o Suspending the instance o Deleting the instance o Same for the actual Process Definition.

Completing The User Task

• Go to the My Tasks page from the top navigation menu. • You will see a task called Show Name / Show Name with e, depending on the randomly generated name. • Click Actions and then Start Task • IF Show Name With E o You will see the name and also have a question asking you if you wish to run the process again. o Enter yes to run again. o Enter no to end the process. • IF Show Name o You will see the name generated and click Save & Finish to try and generate another name with an e.

Any questions contact Mitchell Hancock (ICE)

Previous