Skip to end of metadata
Go to start of metadata

Enabling human task coordination

For the human task coordination to function properly, you need to enable task coordination at both the Task Parent and Task Processor. In WSO2 BPS, you can enable this feature in both Task Parent (B4P module) and Task Processor using the following configuration options. The following steps address human task processor configuration.

  1. Navigate to the <PRODUCT_HOME>/repository/conf/ directory in your local machine and open the humantask.xml configuration file.
  2. Set the TaskCoordinationEnabled entry to true.


Use the following steps to enable HumanTask Coordination in the B4P module (Task Parent).

  1. Navigate to the <PRODUCT_HOME>/repository/conf/ directory in your local machine and open the b4p-coordination-config.xml file. 
  2. Set the TaskCoordinationEnabled entry to true.


Coordination Protocol Services and Registration service are implemented as WSO2 Carbon admin services. In order to access these services, a user needs to be authenticated to the system. In WSO2 BPS task coordination, these services are authenticated using a user created in BPS and configured within the config files. You can either create an individual user for authentication, or create an entire tenant where all users within it can authenticate task coordination. See the sections below:

Creating a predefined user for authentication

Use the following instructions to create a role and a user.

Step 1: Create a role
  1. Start the BPS server If it is not started already.
  2. Go to the Configure menu in the management console and navigate to Users and Roles > Role.
  3. Click "Add New Role".
  4. Enter a name for the role (e.g.: htcoordinatorRole) and click Next.
  5. Select the following permissions for the newly created role.

    These are minimum permission requirements.

    • All Permissions \ Admin Permissions \ Login
    • All Permissions \ Admin Permissions \ Manage \ HumanTask \ View Task List
  6. Click Finish.
Step 2: Create a user for the above created role
  1. Go to the Configure menu in the management console and navigate to Users and Roles > Users.
  2. Click "Add New User".
  3. Enter relevant values in the username and password fields.
  4. Click Next.
  5. Select the rolename defined above for the role
  6. Click Finish.
Step 3: Configure the above created user in b4p-coordination-config.xml
  1. Navigate to the <PRODUCT_HOME>/repository/conf/ directory in your local machine and open the b4p-coordination-config.xml file.
  2. Set the username and password in the TaskProtocolHandlerAuthentication entry as follows.

Step 4: Configure the above created user in humantask.xml
  1. Navigate to the <PRODUCT_HOME>/repository/conf/ directory and open the humantask.xml configuration file
  2. Set the username and password in the RegistrationServiceAuthentication entry as follows. 

  • You can configure two users for Humantask engine and B4P module.
  • You can secure (encrypt) the plain text entries for the username and password in the configuration files using the WSO2 Secure vault tool. See advanced configuration section for this configuration. 

Creating a tenant for authentication

Step 1: Create a registry resource in the tenant's configuration registry
  1. Start the BPS server If it is not started already.
  2. Navigate to Registry>Browse in the Main menu of the management console and click on /_system/config.
  3. Click on Entries>Add Resource and fill the form using the values listed below for guidance. See Adding a Resource for more information. 

    • Method: Create Text Content
    • Name: TaskCoordination
    • Media type: text/plain
  4. Click Add to finish adding the resource.
Step 2: Create username and password registry properties and define credentials
  1.  Click on the registry resource you created (Task Coordination) found under the Entries section. 

  2. Add two new registry properties for the resource called "Username" and "Password", and define the tenant coordination user credentials. To do this, click Properties>Add New Property and enter the following values. See Managing Properties for more information. 

    • Username Property
      Value: (username value)

    • Password Property
      Value: (password value)
  3. Click Add to finish adding the property.

  • No labels