Chapter 9. Case roles

Procedure

1. To define the roles involved in the case, click to open the Properties menu on the right side of the designer and open the Editor for Case Roles.

2. Click Add Case Role to add a case roles.

   The case role requires a name for the role and a case cardinality. Case cardinality is the number of actors that can be assigned to the role in any case instance. For example, the IT Orders sample case management project includes the following roles:

   Figure 9.1. ITOrders Case Roles

   

   In this example, there can only be one actor (a user or a group) assigned as the case owner and only one actor assigned to the manager role. The supplier role can have two actors assigned. Depending on the case, there can be any number of actors assigned a particular role based on the configured case cardinality of the role.

Procedure

1. Create a POST REST API call with the following endpoint:

   http://host:port/kie-server/services/rest/server/containers/itorders/cases/itorders.orderhardware/instances

   • itorders: The container alias that has been deployed to the Process Server.
   • itorders.orderhardware: The name of the case definition.

2. Provide the following role configuration in the request body:

   {
     "case-data" : {  },
     "case-user-assignments" : {
       "owner" : "cami",
       "manager" : "cami"
     },
     "case-group-assignments" : {
       "supplier" : "IT"
    }
   }

Procedure

1. Click to open the Object Library on the left side of the process designer.
2. Open the Tasks list and drag the user or service task you want to add to your case definition on to the process design palette.
3. With the task node selected, click to open the Properties panel on the right side of the designer.

4. Click the field next to the Actors property and type the name of the role to which the task will be assigned. You can use the Groups property in the same way to for group assignments.

   For example, in the IT Orders sample project, the Manager approval user task is assigned to the manager role:

   

   In this example, after the Prepare hardware spec user task has been completed the user assigned to the manager role will receive the Manager approval task in their Task Inbox in Business Central.

Procedure

1. In the Showcase application, click the case you want to work on in the Case list to open the case overview.

2. Locate the role assignment that you want to change in the Roles box in the lower-right corner of the page.

   
3. To remove a single user or group from the role assignment, click the next to the assignment. In the confirmation window, click Remove to remove the user or group from the role.
4. To remove all role assignments from a role, click the next to the role and select the Remove all assignments option. In the confirmation window, click Remove to remove all user and group assignments from the role.
5. To change the role assignment from one user or group to another, click the next to the role and select the Edit option.

6. In the Edit role assignment window, delete the name of the assignee that you want to remove from the role assignment. Type the name of the user you want to assign to the role into the User field or the group you want to assign in the Group field.

   At least one user or group must be assigned when editing a role assignment.

7. Click Assign to complete the role assignment.

Procedure

1. Retrieve the list of current role assignments using a GET request on the following endpoint:

   http://localhost:8080/kie-server/services/rest/server/containers/{id}/cases/instances/{caseId}/roles

   Table 9.1. Parameters

   Name	Description
   id	itorders
   caseId	IT-0000000001

   This returns the following response:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <case-role-assignment-list>
         <role-assignments>
               <name>owner</name>
               <users>Aimee</users>
         </role-assignments>
         <role-assignments>
               <name>manager</name>
               <users>Katy</users>
         </role-assignments>
         <role-assignments>
               <name>supplier</name>
               <groups>Lenovo</groups>
         </role-assignments>
   </case-role-assignment-list>

2. To change the user assigned to the manager role, you must first remove the role assignment from the user Katy using DELETE.

   /server/containers/{id}/cases/instances/{caseId}/roles/{caseRoleName}

   Include the following information in the Swagger client request:

   Table 9.2. Parameters

   Name	Description
   id	itorders
   caseId	IT-0000000001
   caseRoleName	manager
   user	Katy

   Click Execute.

3. Execute the GET request from the first step again to check that the manager role no longer has a user assigned:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <case-role-assignment-list>
         <role-assignments>
               <name>owner</name>
               <users>Aimee</users>
         </role-assignments>
         <role-assignments>
               <name>manager</name>
         </role-assignments>
         <role-assignments>
               <name>supplier</name>
               <groups>Lenovo</groups>
         </role-assignments>
   </case-role-assignment-list>

4. Assign the user Cami to the manager role using a PUT request on the following endpoint:

   /server/containers/{id}/cases/instances/{caseId}/roles/{caseRoleName}

   Include the following information in the Swagger client request:

   Table 9.3. Parameters

   Name	Description
   id	itorders
   caseId	IT-0000000001
   caseRoleName	manager
   user	Cami

   Click Execute.

5. Execute the GET request from the first step again to check that the manager role is now assigned to Cami:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <case-role-assignment-list>
         <role-assignments>
               <name>owner</name>
               <users>Aimee</users>
         </role-assignments>
         <role-assignments>
               <name>manager</name>
               <users>Cami</users>
         </role-assignments>
         <role-assignments>
               <name>supplier</name>
               <groups>Lenovo</groups>
         </role-assignments>
   </case-role-assignment-list>