Workflow Web-based Modeler

Workflow tool for creating custom workflow processes by using the UI editor.

Workflow Web-based Modeler enables creating a custom workflow process by using the UI editor to create and saving a Business Process Modeling Notation (BPMN) diagram without having to manually edit the XML file.

Workflow Modeler Options

For Reltio customers who use the Console, the Workflow Modeler includes these options to rapidly design, manage, and deploy workflows using a light-weight business user-friendly tool within the Console:
  • Create a new BPMN process.
  • Business-friendly graphical tools for designing BPMN processes.
  • Import from and export to a local drive for easy reuse.
  • Deploy the BPMN process to a tenant.
  • Export a *.bpmn file as a *.png file for collaboration with other business users.

Before You Begin

The Workflow Modeler has no prerequisites; however, it’s helpful if you’re familiar with the following technologies:
  • Business Process Model and Notation (BPMN), which is the standard language for process applications.
  • http://www.bpmn.org/.

Log in to the BPMN Modeler

  1. Enter the Tenant name.

  2. Enter either your user name or email address and your password.

    The Console Modeler main page appears.

  3. Click the Workflow Modeler option to open the Workflow Modeler Console.

Open an Existing BPMN File

To open an existing file, do the following:

  1. You can either open an existing BPMN diagram *.bpmn20.xml file into the Modeler Console or you can import the existing Out-of-the-box (OOTB) workflows from Bitbucket and enhance the workflow according to your business needs. Out-of-the-box process definitions are available at Workflow - Default Process Definitions Bit Bucket Repo.

  2. The Workflow Modeler displays the imported BPMN diagram.

  3. Click the PUBLISH button.
    Note: Make sure to select a tenant before publishing the workflow. Else, the PUBLISH button is disabled as shown below:

Create a New BPMN Diagram

To create a new diagram, either click the icon on the Workflow Modeler main page or click +CREATE on the Workflow Modeler Console page.

The Console main screen appears.

Quick Tour of Top-level Tool Bar Functions, Work Area Icons, and Shortcut Keys

These are the toolbar primary functions:

  • OPEN
  • +CREATE
  • EXPORT
  • SAVE
  • PUBLISH

The work area provides the component palette, the area in which to create the BPMN diagram, options to center the diagram in the work area and to zoom in and zoom out, and the option to access additional Web-based tooling for BPMN diagrams.

Click the center icon to automatically center the diagram in the work area.

On the zoom icon, click '+' to zoom in, or click '-' to zoom out.

Click the Web-based tooling icon to access additional Web-based tooling for BPMN diagrams.

When you click the icon you are redirected to the bpmn.io.

Table 1. Shortcut Keys
Keys Use
Delete Remove the selected element.
Ctrl +z Undo.
Ctrl +shift +z Redo.
Ctrl +a Select all elements.
Ctrl +f Search labels.
s Activate the space tool.
l Activate the lasso tool.
c Activate the global connect tool.
e Activate direct editing.

Select a Tenant

Click a tenant from the list of tenants, and then click DONE. The tenant is placed in the Workflow Modeler.

Sample BPMN Workflow Diagram

This is the pictorial representation of your process. You can reorganize the process steps and click on any component to edit the properties.

Component Palette

This is the standard BPMN component palette. You can drag and drop any component, set its properties, and design workflows using this simple intuitive tool.

When you click an icon in the component palette, tools you can use for this icon are provided, as shown in this example:

Click the 'caret' at the bottom to minimize the component palette.

Properties Panel

Use the properties panel to set properties for the entire workflow or for the specific task/step on which you have selected to work. The properties available depend on the type of BPMN workflow diagram on which you are working.

Click 'x' (default setting) to minimize the properties panel, and click the 'caret' to show the properties panel.

Work With BPMN Constructs

The Workflow Adapter supports these BPMN constructs:

  • User Task
  • Service Task
  • Script Task
  • Manual Task
  • Sequence Flow
  • Conditional Sequence flow
  • Exclusive Gateway
  • Parallel Gateway
  • Inclusive Gateway
  • Sub-process
  • None Start Event
  • None End Event
  • Terminate End Event

User Task

A User Task is used to model work that needs to be done by a human actor.

Service Task

A Service Task is used to invoke services. This is done by calling Java code or providing a work item for an external worker to complete asynchronously. Use the Modeler to add a service task after the user task.

Script Task

A Script Task is an automated activity. When a process execution arrives at the Script Task, the corresponding script is executed. A Script Task is defined by specifying the script and the scriptFormat.

Manual Task

A Manual Task defines a task that is external to the BPM engine. It is used to model work that is done by somebody who the engine does not need to know of and is there no known system or UI interface. For the engine, a manual task is handled as a pass-through activity, automatically continuing the process at the moment the process execution arrives at it.

Sequence Flow

A BPMN sequence flow is used to connect flow objects in a process or a choreography to show the flow.

Conditional Sequence Flow

A sequence flow can have a condition defined on it. When a BPMN 2.0 activity is left, the default behavior is to evaluate the conditions on the outgoing sequence flow. When a condition evaluates to ‘true’, that outgoing sequence flow is selected. When multiple sequence flow are selected that way, multiple executions will be generated and the process will be continued in a parallel way.

Note: This is different for gateways. Gateways will handle sequence flow with conditions in specific ways, depending on the gateway type.

Exclusive Gateway

You can define conditions on the outgoing sequence flows and the exclusive gateway will evaluate them. The exclusive gateway can receive only one sequence flow.

Parallel Gateway

The parallel gateway can receive more than one sequence flow.

Inclusive Gateway

The Inclusive Gateway can be seen as a combination of an exclusive and a parallel gateway. Like an exclusive gateway, you can define conditions on outgoing sequence flows and the inclusive gateway will evaluate them. However, the main difference is that the inclusive gateway can receive more than one sequence flow, like a parallel gateway.

Sub-process

A sub-process flowchart as the representation of an activity that contains a series of small parts, that is: this activity can be represented by a process flowchart (in this case, a sub-process flow) since it is inserted into a Process flow chart.

None Start Event

A start event indicates the place where and possibly why a process started. Since a start event is used for initiating a process, it does not have any incoming sequence flow. You can define a trigger for start event, to show the condition(s) that will cause a process to initiate. The none start event does not have a defined trigger.

None End Event

As an opposite of the start event, end event indicates where a process will end. Since the end event is used for terminating a process, it does not have any outgoing sequence flow. You can define a result for the end event, to show what will happen when reaching the end. The none end event does not have a defined result.

Terminate End Event

The process is terminated when it reaches the terminate-end event. A terminate end event means that if one of the paths reaches an end, all other process paths (currently performing activities and activities which are waiting to be performed) are ended immediately.

Modeling BPMN Diagrams

To build a valid business process definition, refer to Business Process Definition Overview. Additionally, you can refer to https://docs.camunda.org/manual/7.7/modeler/camunda-modeler/bpmn/ for procedures to create new diagrams or to model files located on your file system.

Deploy the Process From the Modeler to Reltio Tenants

If you can validate that you have the correct login credentials, then you can open the deployment dialog for an existing BPMN diagram to publish the workflow in real time to any tenant from the Workflow Modeler Console. A dialog appears in which you can provide details such as the Reltio environment name and tenant ID for deployment.

Note: You cannot deploy a process without the ROLE_WORKFLOW permission and without specifying the tenant ID.

When the process is successfully deployed to the server, a confirmation message is shown. However, an error message appears if you are unable to deploy the process.