Index

Introduction

Soffid includes in its Smart Engine a layer of BPM (Business Process Management) to provide useful workflows integrated with the processes and policies of the Soffid core.

Until now, the workflows were implemented with an external programming tool, and it required knowledge of the Soffid core and programming languages.

The BPM Editor Addon allow you to create, configure and publish business processes very easily for the Soffid administrators.

This addon is available from Soffid version 2.7.0.

Installation

This addon is located in the Addons section and its name is BPM web editor.

For download and install the addon you could review our generic documentation about this process: Addons installation

After the installation of the addon you could find its web page in the section: Start > Soffid Configuration > BPM editor

Overview

With this addon you can perform the next operations:

Once you have published a workflow with the proper configuration:

Operations

The BPM editor page allow to the user the next operations.

And also, when you select a workflow, more operations are displayed.

These operations are described below.

New business process (button)

The button  allows you to create a new workflow (business process).

First, you have to fulfil the name and select a type.

About the attributes:

To complete the creation, click the Accept button, and the next step will be the configuration of the workflow. For more information, go to the Configuration section.

Import process (button)

The button  allows you to import a workflow previously exported.

This functionality is very useful to next scenarios:

To import a new workflow you only have to select and upload a *.pardef file:

If a workflow already exits with the same name, this will be overwritten.

Edit process (icon)

The icon  open the workflow configuration page.

For more information, go to the Configuration section.

Remove process (icon)

The icon  allows you to remove a workflow.

Notice that the workflow is permanently removed in the BPM editor page, but if it was previously published, it is still available for the final user in the Console and Selfservice. To unpublish the workflow you have to disable it, for more information visit: Disable/enable a workflow

Export process (icon)

The icon  allows you to export a workflow to a *.pardef file.

This file could be imported later in the same Soffid or into another Soffid instance.

Configuration

In this section you could find information about how to configure all the aspects of a business process (workflow).

All the configurations explained are in the edit process page.

Main attributes

In this section you could update the main attributes of the workflow and the authorizations required for the users.

About the attributes:

Operation buttons

To complete the edition of the workflow, in this section you could find three options.

These are the buttons:

Steps section

The Steps tab has several parts.

Workflow diagram steps

This part has the set of the steps of your workflow.

You could select a step to see its configuration on its right side.

Also, you could create a new step with the button .

Finally, you could remove a step, you have to select the step and the button  will appear.

Notice that the list seems sequential, but a workflow diagram is not like a list or a tree, is like a graph, every step could have some incoming transitions and some outgoing transitions.

Step details

This part has the configuration details of the step.

These are the main attributes:

The configuration tabs are described below and some of them depending on the step type selected.

Task details

This tab is for specific information about a step, it could be empty, and his information depends of the step type.

Fields

In this tab you could choose from the all the possible user attributes, which are visible in write-mode or only-mode.

The list of attributes is:

This steps is only available on the steps: Start, Approve and Grant approval.

Actions that you could perform:

In a validation or a visibility script you could access to the fields as the next script.

if (object{"userName"}==null){
	throw new Exception("The userName is mandatory");
}
return true;


Triggers

In this tab you could create custom scripts to be triggered from some actions.

This steps is only available on the steps: Start and Approve.

Actions that you could perform:

In a trigger script you could access to the fileds as the next script:

// Example 1
executionContext.setVariable("profileServer", "null");
executionContext.setVariable("homeServer", "null");
executionContext.setVariable("mailServer", "null");
executionContext.setVariable("userType","A");
un = executionContext.getVariable("userName");
executionContext.setVariable("userName", un+"_INT");

// Example 2
a = executionContext.getVariable("shortName");
u = serviceLocator.getUserService().findUserByUserName(user);
s = serviceLocator.getDispatcherService().findDispatcherByName("OC_DTVEXT");
u.userName = an+"_ATT";
account = serviceLocator.getAccountService().createAccount (u, s, a);
serviceLocator.getUserService().update(u);
serviceLocator.getAccountService().updateAccount2(account);


Incoming transitions

In this tab you could see the previous steps those it has connected.

Actions that you could perform:

Outgoing transitions

In this tab you could see the next steps those it has connected.

Actions that you could perform:

Attributes section

In this tab you could create custom attributes to be used in the workflow.

previously

This configuration is almost the same that you can find in the Agents#Accountmetadata or in the Additional data#Modifyobjects.

The attributes created by default are needed for the workflow, do not remove them.

You can create a new attribute with the button .

For every attribute, you could configure the next points:

If the created metadata attribute should be deleted, click on, located on the right of the attribute.

These attributes will be used in the Steps tab to be mapped with the Soffid data.

About a generated workflow

Once you have a workflow named User.

With this configuration.

After publish it, the final user with the correct permissions will find the workflow here.

When you enter into the workflow the first page is the form generated from the fields and configuration of the step Start.

The header of the page is common for all the workflows.

In the body of the tab Task, all the fields of the step Start are displayed.

And the button  is the Outgoing Transition of the step Start to go to the Approve step.

Now the identities configured in the step Approve as managers should accept or remove this user creation request.

The manager will receive a mail and they could access to the workflow in My tasks page.

Notice that the workflow complete the Start step a workflow identifier is created to be found and observed for the creation user, manager and observers.

Once the manager is into the workflow he could read or update the fields configured in the step Approve.

At this moment the manager has to get the task with the button  and update the editable fields.


And finally decide if  or  the user creation.

Resources

Below you could find a set of workflows that you could import, edit and publish in your Soffid instance:

Documentation

Links to additional information in the documentation: