This documentation is for a version that is out of support.

You may want to view the same page for the latest version, or for any of the versions available in the drop-down menu in the top-right corner.

Custom User Information in Bonita Studio

Learn how you can add custom (business) information on users, that will then be available for filtering.

For instance:

Custom User Information are (key, value) pairs that can be added on users.
You define the attributes that you want to store, and then add the values for the users.
You can use custom user information to assign tasks to users based on information that is specific to your organization and not included in the standard Bonita organization definition.

Purpose

For example, you may want to create a security badge with an individual value (number) for each user, or an office skill for a user, a special professional activity, or geographical details. All these types of information are not displayed in standard information tabs but you may want to filter candidates to a human task thanks to those attributes.

Define custom user information

  1. In Bonita Studio project explorer, double click on the organization you want to edit

  2. Click on the User tab

  3. Expand the Manage custom information pane, click on Add

  4. This will put a default name Information1 in the Name column

  5. Add a description (if needed). This will only appear in Bonita Studio.

  6. Click on the default name Information1, to modify it to your needs

  7. Save and deploy your organization

  8. The custom information is applied to all users.

Add custom user information values for each user

  1. In Bonita Studio project explorer, double click on the organization you want to edit

  2. Click on the User tab

  3. Click on the user for which you want to define the custom user information value

  4. In the Information table, select the Custom tab

  5. Select the custom user information to define and click on its Value column

  6. Enter the custom user information value

After completing the changes for all the desired users, remember to save and deploy the organization

Note: this value can be changed by a user in the Bonita Administrator Application. See How to edit Custom information for a single user

Set an actor filter on custom user information

A task or a lane is linked to an actor. An actor is mapped to a list of users. An actor filter applies to the set of users mapped to the actor. The actor filter configuration can be added to an actor at lane or human task level.

When all relevant users have their Custom User Information set, you can add an actor filter:

  1. In a process diagram, select a lane or a task

  2. In the Details panel, Go to General > Actors and select an actor to apply the filter (actors are defined at pool level)

  3. At Actor filter level, click Set

  4. In the Actor filters window > Categories, click on Organization and choose *Users with Custom information*

  5. Click on Next

  6. Enter a name and a description for the filter configuration

  7. Click on Next

  8. Enter a custom user information Name or click on the drop down list to select the one you need

  9. Enter a value for the information

  10. To filter on several values using the same string, click Partial match

  11. If you expect the filter to return only one user, then it’s good that the task is assigned to her automatically. In this case, click the Assign tasks automatically checkbox.

  12. Click on Finish

The filter is set for the actor and is displayed in the actor filter field. Users from the actor and with the relevant value for the custom information chosen will become candidates to perform the task, or all the tasks in the lane if you set it at lane level.

Note that the filter will not work if you change values in the organization but do not re-publish the organization. This will throw a synchronization error.