WASP User Guide

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/

For users Tasks you can also assign a Task form, this is a customised form that can be created using the Forms Editor(explained later)

For Inputs and Outputs, you can use typed values or also values from previous tasks.

Example of the variable selector screen for Inputs and Outputs:

img

Forms Editor

The forms editor is where users can create custom forms for completing at run time. These forms can have many different elements and create variables which can be used within the process. Here is an example of a Radio List with a drop down of different characters, when the user makes their selection; the selected value will go into the variable “personId”

img

The forms can be made private, so only your user can see them in the designer, or public so anyone could use your form within their process’s.

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

How to use the Marketplace

You can move categories my clicking on the blue nodes or return by clicking the grey Return node.

Click on the orange plus to add a new service or to edit a service, click on it, and then in the panel on the right click edit.

The edit service page:

img

In the first section of the form you can give it a group name, also services are part of a group, it currently doesn’t matter about this group but they belong to one so give it a name.

The privacy level is public,organization or private, this relates to who can see the service in the Marketplace and who can view and use it in the designer.

  • If a service is private then only your user can see and use it.
  • If a service is organization, then you and other users in your organization can see edit it in the marketplace, and use it in the designer.
  • If public then any user can see edit or use it.

Also enter details such as the URL, give the service a name and also a description.

img

In this second section of the form you can enter more details about the service such as any body that is sent to the service. Whether the service is a service task or a send and receive task (service is an immediate response where as send and receive is in two parts with the receive happening later) At the bottom any headers which are required for the service can also be added. Also inputs are added, this means that you can use a variable at run time to change the URL, Body or Header of the request. In the example we have a variable called movieId, based on the value of this variable depends which film is retrieved from the API.

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.

Here are the available actions:

img

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 Process Instance, View Process Instance Activity, View Process Instance Variables, suspend and delete the instance(if running). If I were to view the instance it would look like:

img

Here is a completed process.

If the process were running the;

  • Light green colour are the completed tasks
  • Dark green is the current active task
  • Red are deleted/cancelled tasks
  • White tasks are tasks which have not been activated at all

Going to the previous screen, View Process Instance Activity has this screen:

img

This screen lists the elements of the process and in which order they were completed in.

The final screen is the View Process Instance Variables.

img

This screen shows the variables within the process and how those variables were created and if they changed during 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 we are using our user task with the form we created earlier, as you can see the drop down of various options to select. The value from this option 1-5 will go into a process variable which can be used later in the service call.

Getting Started Example

Sign into WASP

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.
  • Within the user task you can also see the variables, if you click on the View Character task, you can add additional parameters from the “People” API call to display.

Running The Process

  • Assign the User tasks to yourself if you haven’t already done that.
    • you can do this by clicking on the user tasks (person in top left) and Assignee drop down, click on your name.
  • Click on Publish in the top bar.

How To View/Manage Your Process

  • Go to Control Panel page.
  • Find your Process and Click Actions and then Start Process Instance
  • 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

Completing The User Task

  • Click on the Green user task called Select Person, you will see a pop up with information
  • Hover on Actions or Click to make the options stay
  • Select View Task Alternatively: Go to the My Tasks page from the top navigation menu.
  • You will see information about the task and if you have assigned the task to yourself, a drop down of the character to select.
  • Select a character from the drop down.
  • Click Finish
  • You will now be in the My Tasks portlet, you can also manage your tasks from here.
  • A new task called View Character will appear here
  • Click Start Task
  • You will see the task with the details of the character that you selected.

img

Additional steps to try

Try adding more variables to the View Character task

  • Edit the process in the Designer tab
  • Add more or less inputs to the View Character User Task

Try Creating your own form to have more characters

  • You can view the characters at: https://swapi.dev/api/people
  • Make sure you match the characters name and the url so that the url is the correct number, and add this number at the value for the drop down
  • For example Luke Skywalker has a url of: https://swapi.dev/api/people/1/ so his value is 1
  • Edit the process in the designer and assign your form to the user task

Try registering your own service in the marketplace

  • Use this service as part of a process
  • If the service has an input of x make sure a previous task has an output of x so it has the value
  • If the service has outputs, display them in user tasks so you can see the value

Any questions contact Mitchell Hancock (ICE)

Previous