Workflow: Configuration and Customization
Workflow: Configuration and Customization
This section covers various configuration aspects for Reltio Workflow, from enabling the feature in Reltio UI to configuring specific settings. Information for Workflow administrators and developers includes:
- Workflow configuration
- Workflow customization
- Workflow deployment
Starting with Reltio Cloud 2017.2, there is an important change to the
changeRequestTypes
in the tenant-level configuration (sometimes
called the L3). The lifecycleActions
section of this configuration
must be removed.
For example:
"changeRequestTypes": [
{
"uri": "configuration/changeRequestTypes/default",
"lifecycleActions": {
"afterDCRSave": [
"Reltio/WorkflowDCRService"
]
}
}
],
should be changed to just:
"changeRequestTypes": [
{
"uri": "configuration/changeRequestTypes/default",
}
],
Prerequisites
In order to create custom workflow processes, there are some software requirements. Reltio uses the Activiti Designer workflow engine. In order to create workflow processes, one needs to use the Activiti Designer plugin in the Java IDE Eclipse. If you do not have Eclipse, you can download from eclipse.org website. Once Eclipse has been installed, you need to add the Activiti Designer Plugin for Eclipse. This will allow you to use the drag-and-drop design tools to create a new process.
Configuration environment
Before you start configuring workflows, you need to set up Acitviti-based workflow configuration environment. Make sure you have completed the following steps:
- Download and install Activiti Designer plugin for your Eclipse IDE.
- Create an Activiti diagram file (*.bpmn) using Eclipse.
Enable Workflow
To enable Workflow functionality in a tenant:
- Register the tenant to Workflow. Note: For details refer to the Register tenants operation of the Workflow API.
- Enable Workflow for the tenant in UI configuration.
- Configure users and permissions. The tenant ID must be assigned to every user account that should be able to see Workflow. This can be done in the settings screen of the tenant. Once these steps are completed, the user should login to the tenant again.
ROLE_INITIATE_CHANGE_REQUEST
ROLE_WORKFLOW
ROLE_API
ROLE_WORKFLOW
ROLE_API
ROLE_REVIEWER
(for OOTB DCR review process) or the role from candidateGroups in BPMN role withCRUD+MERGE+ACCEPT_CHANGE_REQUEST
permissions
ROLE_REVIEWER
and be more flexible if you need to split your Data Stewards by some rules. For example, Data Stewards from Italy should get to review only DCR review tasks with country code Italy and use data permissions for another role with CRUD+MERGE+ACCEPT_CHANGE_REQUEST
permissions.The following specific roles and permissions need to be applied:
[{
"role":"ROLE_INITIATE_CHANGE_REQUEST",
"access":[
"READ",
"INITIATE_CHANGE_REQUEST"
]
},
{
"role":"ROLE_READ",
"access":[
"READ"
]
},
{
"role":"ROLE_REVIEWER",
"access":[
"CREATE",
"READ",
"UPDATE",
"DELETE",
"MERGE",
"ACCEPT_CHANGE_REQUEST"
]
},
{
"role":"ROLE_UI_ALL",
"access":[
"CREATE",
"READ",
"UPDATE",
"DELETE",
"MERGE"
]
}]