Procedure

1. With your case process open in the process designer, click to open the Object Library on the left side of the design palette.
2. Click Cases to open the object menu and drag the Sub Case data object on to the design palette and add it to the case definition.

3. Click to open the Properties panel and click Assignments to open the data assignment editor. Alternatively, click on the Sub Case node in the design palette. The Sub Case Data I/O window supports the following set of input parameters to properly configure and start the subcase:

   

   Independent

   Optional indicator that tells the process engine if the case instance is independent. If it is independent, the main case instance will not wait for its completion. This property is false by default.

   GroupRole_XXX

   Optional group to case role mapping. The role names belonging to this case instance can be referenced here, meaning that participants of the main case can be mapped to participants of the subcase. This means that whatever group was assigned to the main case will be automatically assigned to subcase, where XXX is the role name and the value is the group role assignment.

   DataAccess_XXX

   Optional data access restrictions where XXX is the name of data item and the value is the access restrictions.

   DestroyOnAbort

   Optional indicator that tells the process engine what to do when the subcase activity is aborted: cancel or destroy the subcase. This defaults to true, which destroys the subcase and removes the case file.

   UserRole_XXX

   Optional user to case role mapping. You can reference the case instance role names here, meaning that an owner of the main case can be mapped to an owner of the subcase. Whoever was assigned to main case will be automatically assigned to the subcase, where XXX is the role name and value is the user role assignment.

   Data_XXX

   Optional data mapping from this case instance or business process to a subcase, where XXX is the name of the data in subcase being targeted. This can be given as many times as needed.

   DeploymentId

   Optional deployment ID (or container ID in context of Process Server) that indicates where the targeted case definition is located.

   CaseDefinitionId

   The mandatory case definition ID to be started.

4. Regardless of the settings of the Independent flag, there will always be output variable available named:

   CaseId

   This is the case instance ID of the subcases after it is started.

Procedure

1. In Business Central, go to Menu → Design → Projects and IT_Orders_New.
2. Click the IT_Orders_New case project Business Process (legacy) asset.
3. In the process designer, click to open the Object Library on the left of the design palette.

4. From the list, select a task that you want to add to the case definition as an ad hoc task.

   For example, you might want to add a user task to fill out a warranty claim if goods that are received are faulty. A warranty claim may or may not need to be completed during the course of the case, but it is available to be performed in an ad hoc way if required.

5. Configure the ad hoc task properties in the Properties panel on the right.
6. Trigger the task during run time using a Java API call. For example, the Order rejected ad hoc task is triggered by the following API call: CaseService.triggerAdHocFragment

Procedure

1. In a web browser, open the following URL:

   http://localhost:8080/kie-server/docs.

2. Open the list of available endpoints under Case instances :: Case Management.

3. Click click the following POST method endpoint to open the details:

   /server/containers/{id}/cases/instances/{caseId}/tasks

4. Click Try it out to complete the following parameters:

   Table 9.1. Parameters

   Name	Description
   id	itorders
   caseId	IT-0000000001

   body

   {
    "name" : "RequestManagerApproval",
    "data" : {
      "reason" : "Fixed hardware spec",
      "caseFile_hwSpec" : "#{caseFile_hwSpec}"
     },
    "description" : "Ask for manager approval again",
    "actors" : "manager",
    "groups" : ""
   }

5. In the Swagger application, click Execute to create the dynamic task.

Procedure

1. In a web browser, open the following URL:

   http://localhost:8080/kie-server/docs

2. Open the list of available endpoints under Case instances :: Case Management.

3. Click click the following POST method endpoint to open the details:

   /server/containers/{id}/cases/instances/{caseId}/stages/{caseStageId}/tasks

4. Click Try it out and complete the following parameters:

   Table 9.2. Parameters

   Name	Description
   id	itorders
   caseId	IT-0000000001

   body

   {
    "name" : "InvokeService",
    "data" : {
      "Parameter" : "Fixed hardware spec",
      "Interface" : "org.jbpm.demo.itorders.services.ITOrderService",
      "Operation" : "printMessage",
      "ParameterType" : "java.lang.String"
     },
    "nodeType" : "Service Task"
   }

5. In the Swagger application, click Execute to create the dynamic task.

Procedure

1. In a web browser, open the following URL:

   http://localhost:8080/kie-server/docs.

2. Open the list of available endpoints under Case instances :: Case Management.

3. Click click the following POST method endpoint to open the details:

   /server/containers/{id}/cases/instances/{caseId}/processes/{pId}

4. Click Try it out and complete the following parameters:

   Table 9.3. Parameters

   Name	Description
   id	itorders
   caseId	IT-0000000001
   pId	itorders-data.place-order

   The pId is the process ID of the subprocess to be created.

   body

   {
    "placedOrder" : "Manually"
   }

5. In the Swagger application, click Execute to start the dynamic subprocess.

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 10.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 10.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 10.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 10.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>

Procedure

1. From the process designer, click on the left of the palette to open the Object Library. Open the Subprocesses object list, drag and drop an Ad-Hoc node onto the design canvas and provide a name for the stage node.

2. Define how the stage is activated:

   • If the stage is being activated by an incoming node, connect the stage with a sequence flow line from the incoming node.
   • If the stage is instead being activated by a signal event, configure the SignalRef on the signal node with the name of the stage that you configured in the first step.
   • Alternatively, configure the AdHocActivationCondition property to activate the stage when the condition has been met.
3. Re-size the node as required to provide room to add the task nodes for the stage.
4. Add the relevant tasks to the stage and configure them as required.

5. (Optional) Configure a completion condition for the stage. As an ad hoc subprocess, stages are configured as autocomplete by default, which means that the stage will automatically complete and trigger the next activity in the case definition once all instances in the stage are no longer active.

   To change the completion condition, select the stage node and open the Properties panel on the right. Modify the AdhocCompletionCondition property field in the with a free-form Drools expression for the completion condition you require. For more information about stage completion conditions, see Section 11.2, “Configuring stage activation and completion conditions”.

6. Once the stage has been configured, connect it to the next activity in the case definition using a sequence flow line.

Procedure

1. With the stage selected on the case design canvas, click to open the Properties panel on the right.
2. Open the AdHocActivationCondition property editor to define an activation condition for the start node. For example, set autostart: true to make the stage automatically activated when a new case instance is started.
3. The AdHocCompletionCondition is set to autocomplete by default. To change this, open the property editor to define a completion condition using a free-form Drools expression. For example, set org.kie.api.runtime.process.CaseData(data.get("ordered") == true) to activate the second stage in the example shown previously.

Procedure

1. Start a new case using the Showcase application. For more information about using Showcase, see Using the Showcase application for case management.

   Because this case is designed using stages, the case details page shows stage tracking:

   

   The first stage starts automatically when the case instance is created.

2. As a manager user, approve the hardware specification in Business Central under Menu → Track → Task Inbox, then check the progress of the case.

   1. In Business Central, click Menu → Manage → Process Instances and open the active case instance IT-0000000001.

   2. Click Diagram to see the case progress diagram:

      

3. In a web browser, open the following URL:

   http://localhost:8080/kie-server/docs.

4. Open the list of available endpoints under Case instances :: Case Management.

5. Click click the following POST method endpoint to open the details:

   /server/containers/{id}/cases/instances/{caseId}/stages/{caseStageId}/tasks

6. Click Try it out to complete the following parameters:

   Table 11.1. Parameters

   Name	Description
   id	itorders
   caseId	IT-0000000001
   caseStageId	Order delivery

   The caseStageId is the name of the stage in the case definition where the dynamic task is to be created. This can be any dynamic or service task payload. See Creating a dynamic subprocess using the REST API or Creating a dynamic service task using the REST API for examples.

Procedure

1. In the process designer, click to open the Object Library on the left of the design palette.

2. From the list, open Milestone and drag the Milestone object onto the palette.

   
3. With the milestone node selected, click to open the Properties panel on the right.
4. Open Assignments to add a completion condition. Milestones include a condition parameter by default.
5. To define the completion condition to for the milestone, select Constant from the list. The condition must be provided using the Drools syntax.

6. Configure the Adhoc autostart property.

   • Set this property to true for milestones that are required to start automatically when a case instance starts.
   • Set this property to false for milestones that are to be triggered by a signal event.

7. (Optional) Configure a signal event to trigger a milestone once a case goal has been reached.

   1. With the signal event selected in the case design palette, open the Properties panel on the right.
   2. Set the Signal Scope property to Process Instance.

   3. Open the SignalRef expression editor and type the name of the milestone to be triggered.

      

      Click Ok to finish.

Procedure

1. Create the following business rule file called validate-document.drl:

   package defaultPackage;
   
   import java.util.Map;
   import java.util.HashMap;
   import org.jbpm.casemgmt.api.CaseService;
   import org.jbpm.casemgmt.api.model.instance.CaseFileInstance;
   import org.jbpm.document.Document;
   import org.jbpm.services.api.service.ServiceRegistry;
   
   rule "Invalid document name - reupload"
   when
       $caseData : CaseFileInstance()
       Document(name == "invalid.pdf") from $caseData.getData("hwSpec")
   
   then
   
       System.out.println("Hardware specification is invalid");
       $caseData.remove("hwSpec");
       update($caseData);
       CaseService caseService = (CaseService) ServiceRegistry.get().service(ServiceRegistry.CASE_SERVICE);
       caseService.triggerAdHocFragment($caseData.getCaseId(), "Prepare hardware spec", null);
   end

   This business rule detects when a file named invalid.pdf is uploaded to the case file. It then removes the invalid.pdf document and creates a new instance of the Prepare hardware spec user task.

2. Click Build, then click Deploy to deploy the IT_Orders project.
3. Create a file called invalid.pdf and save it locally.
4. Create a file called `valid-spec.pdf`and save it locally.
5. In Business Central, go to Menu → Projects → IT_Orders to open the IT_Orders project.
6. Click Import Asset in the upper-right corner of the page.

7. Upload the validate-document.drl file to the default package (src/main/resources).

   

   The validate-document.drl rule is shown in the rule editor. Click Save or close to exit the rule editor.

8. Open the Showcase application by either clicking the Apps launcher (if it is installed), or go to http://localhost:8080/rhpam-case-mgmt-showcase/jbpm-cm.html.

9. Start a new case for the IT_Orders project.

   In this example, Aimee is the case owner, Katy is the manager, and the supplier group is supplier.

   
10. Log out of Business Central, and log back in as a user that belongs to the supplier group.
11. Go to Menu → Track → Task Inbox.
12. Open the Prepare hardware spec task and click Claim. This assigns the task to the logged in user.

13. Click Start and click to locate the invalid.pdf hardware specification file. Click to upload the file.

    

14. Click Complete.

    The value in the Task Inbox for the Prepare hardware spec is Ready.

15. In Showcase, click Refresh in the upper-right corner. Notice that a Prepare hardware task message appears in the Completed column and another appears in the In Progress column.

    

    This is because the first Prepare hardware spec task has been completed with the specification file invalid.pdf. As a result, the business rule causes the task and file to be discarded, and a new user task created.

16. In the Business Central Task Inbox, repeat steps 12 and 13, but upload the valid-spec.pdf file instead of invalid.pdf.
17. Log out of Business Central and log back in again as Katy.
18. Go to Menu → Track → Task Inbox. There are two Manager approval tasks for Katy, one with the invalid.pdf hardware specification file, the other with the valid-spec.pdf file.

19. Open, claim, and complete each task:

    1. Check the approve box for the task that includes the valid-spec.pdf file, then click Complete.
    2. Do not check the approve box on the task with the invalid.pdf file, then click Complete.
20. Go to Menu → Manage → Process Instances and open the Order for IT hardware process instance.

21. Open the Diagram tab. The Order rejected and Place order processes are now marked as Completed.

    

    Similarly, the case details page in Showcase lists two Manager approval tasks in the Completed column.

Procedure

1. Open JBOSS_HOME/standalone/deployments/kie-server.war/WEB-INF/classes/case-authorization.properties file in your preferred editor.

   By default, the file contains the following operation restrictions:

   CLOSE_CASE=owner,admin
   CANCEL_CASE=owner,admin
   DESTROY_CASE=owner,admin
   REOPEN_CASE=owner,admin

2. You can add or remove role permissions for these operations.

   1. To remove permission for a role to perform an operation, remove it from the list of authorized roles for that operation in the case-authorization.properties file. For example, removing the admin role from the CLOSE_CASE operation restricts permission to close a case to the case owner for all cases.

   2. To give a role permission to perform a case operation, add it to the list of authorized roles for that operation in the case-authorization.properties file. For example, to allow anyone with the manager role to perform a CLOSE_CASE operation, add it to the list of roles, separated by a comma:

      CLOSE_CASE=owner,admin,manager

3. To add role restrictions to other case operations listed in the file, remove the # from the line and list the role names in the following format:

   OPERATION=role1,role2,roleN

   Operations in the file that begin with # have restrictions ignored and can be performed by anyone involved in the case.

4. When you have finished assigning role permissions, save and close the case-authorization.properties file.

5. Start the execution server.

   The case authorization settings apply to all cases on the execution server.

Procedure

1. Open the Swagger REST API client in a web browser:

   localhost:8080/kie-server/docs

2. Under Case Instances :: Case Management, open the POST request with the following endpoint:

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

3. Click Try it out and fill in the required parameters:

   Table 15.1. Parameters

   Name	Description
   id	itorders
   caseId	IT-0000000001

4. Optionally, you can include a comment to be included in the case file. To leave a comment, type it into the body text field as a String.
5. Click Execute to close the case.
6. To confirm the case is closed, open the Showcase application and change the case list status to Closed.

Procedure

1. In the Showcase application, locate the case instance you want to close from the list of case instances.
2. To close the case without viewing the details first, click Close.

3. To close the case from the case details page, click the case in the list to open it.

   From the case overview page you can add comments to the case and verify that you are closing the correct case based on the case information.

4. Click Close to close the case.
5. Click Back to Case List in the upper-left corner of the page to return to the Showcase case list view.
6. Click the drop-down list next to Status and select Canceled to view the list of closed and canceled cases.