Page Comparison

...

Business processes cannot always proceed in a fully automated manner. They need human interaction as a means of decision making, error handling and exception cases. For example, canceling a flight due to a strike or bankruptcy, deciding whether to accept the claim based on the requested amount etc. Human tasks provide the specification to define tasks performed by human beings.

Sample

...

scenario

When a user requests a claim to be approved by the system, the system automatically approves claims under an amount of 1000 .This is a simple BPEL process. If the claim exceeds 1000, it will be handed over to the regional clerk who checks the claim amount along with the user information, decides whether or not to approve it, and the final decision is sent to the user. So when the claim is higher than 1000, it will be processed as a human task. The sample process is shown below.

...

The basic process is designed as a normal BPEL process with an IF component. For human tasks, we use the BPEL4PEOPLE activity remote task. It will get the input from the claim approval request such as the name and amount, and the output is sent via a claim approval callback service as true or false. The user can then see the final decision. This process needs some presentation elements. Human tasks are implemented as jsp JSP pages.

The BPEL process is implemented using the BPEL4PEOPLE activities and deployed into the server. Human tasks have to be deployed as a separate process. Since there is no tool to create a human task workflow, all the steps have to be done manually. However, there is a predefined package structure which makes the work easier. As an initial step, you should create a package structure in your local directory.

Package structure of an HT artifact

There are four components in the HT package.

...

Info
This topic explains how to write the human tasks yourself and describes the various configurations you can use. You can view a completed version of the human tasks configuration in the `<BPS_home>/repository/samples/humantask` directory and unzipping the .zip file. See here for information on how to set up and run this sample.

Package structure of an HT artifact

There are four components in the HT package.

Table of Contents

maxLevel	5
minLevel	5

.ht file

The .ht file contains the information about the human task of the BPEL process. It is an xml XML-based file consisting of a predefined set of human task description elements. The table below shows the basic elements and their descriptions with some examples from the ClaimsApprovalTask sample.

Element Description

<htd:humanInteractions>

Contains declarations of elements from the WS- HumanTask namespace, that is <htd<htd:logicalPeopleGroups>logicalPeopleGroups>, <htd<htd:tasks>tasks> and <htd<htd:notifications>notifications>.

<htd:import>

Used This is used to import the appropriate wsdl WSDL files. You should correctly specify the name spaces.

Example:

Code Block

language	java

<htd:importnamespaceimport namespace="http://reminder.sample.humantask.wso2.org" location="OrderProcessReminder.wsdl" importType="http://schemas.xmlsoap.org/wsdl/">

<htd:logicalPeopleGroups>

Used This is used to specify logical people groups used in an inline human task or a people activity. The name attribute contains the name of the logical people group. The name must be unique among the names of all logical people groups defined within the <htd:human Interactions> element. For example:

Code Block

language	java

<htd:logicalPeopleGroups>

        <htd:logicalPeopleGroupnamelogicalPeopleGroup name="regionalClerks">
            <htd:documentationxmldocumentation xml:lang="en-US">
   The group of clerks responsible for the region specified.   </htd:documentation>fd  The group of clerks responsible for the region specified.
            </htd:documentation>
            <htd:parameternameparameter name="role" type="xsd:string"/>
        </htd:logicalPeopleGroup>

<htd:tasks>

Specifies the human tasks used in the business process.

Code Block

language	java

<htd:tasks>

        <htd:task1>logicalPeopleGroup name="regionalManager">
            <htd:task2>documentation xml:lang="en-US">
          <htd:task3>
<htd:tasks>

<htd:task>

Used to provide the definition of an inline human task. The name attribute specifies the name of the task. The name must be unique among the names of all tasks defined within the <htd:tasks> element.

It also consists of the <htd:interface>, <htd:peopleAssignments> and <htd:presentationElements> elements which are used to described the task.

Code Block

language	java

<htd:task name="OrderProcess">  
<htd:interface/>
<htd:peopleAssignments/>
<htd:presentationElements/>
</htd:task>

<htd:interface>

Specifies the port types and operations of the human task.

Code Block

language	java

<htd:interface 
 portType="cl:ClaimsHandlingPT"  
  operation="approve"   
 responsePortType="cl:ClaimsHandlingCallbackPT"   
  responseOperation="approvalResponse"/>

<htd:peopleAssignments>

Used to assign people to process-related generic human roles.

Code Block

language	java

<<htd:peopleAssignments>      The manager responsible for the region specified.
            </htd:documentation>
            <htd:parameter name="role" type="xsd:string"/>
        </htd:logicalPeopleGroup>

        <htd:logicalPeopleGroup name="clerksManager">
            <htd:documentation xml:lang="en-US">
                The manager of <htd:potentialOwners>the clerk whose user ID is passed as parameter.
            <htd:from logicalPeopleGroup="regionalClerks"></htd:documentation>
            <htd:parameter name="role" type="xsd:string"/>
        </htd:logicalPeopleGroup>

        <htd:argumentlogicalPeopleGroup name="roledirectorClaims">
            <htd:documentation xml:lang="en-US">
              regionalClerksRole  The functional director responsible for claims    processing.
             </htd:argument>documentation>
        </htd:logicalPeopleGroup>

</htd:logicalPeopleGroups>
 
<htd:logicalPeopleGroups>
       </htd<htd:from>
logicalPeopleGroup name="regionalClerks">
           <htd:documentation xml:lang="en-US">
  </htd:potentialOwners>             The group of  <htd:businessAdministrators>clerks responsible for the region specified.
           </htd:documentation>
           <htd:from logicalPeopleGroup="regionalManager"parameter name="role" type="xsd:string"/>
       </htd:logicalPeopleGroup>


	   <htd:logicalPeopleGroup>
    	.....
	     <htd:argument name="role"></htd:logicalPeopleGroup>
</htd:logicalPeopleGroups>

<htd:tasks>

Specifies the human tasks used in the business process.

Code Block

language	java

<htd:tasks>
        <htd:task1>
        <htd:task2>
           regionalManagerRole
                        </htd:argument>
                    </htd:from>
                </htd:businessAdministrators>
            </htd:peopleAssignments>

<htd:documentation>

Provides annotations for users.

<htd:documentation>

Example for WS-HumanTask 1.1 - WS-HumanTask Task Definition

</htd:documentation>

<htd:from>
<htd:argument>

From element used to assign people for roles which have been specified in the business process. Argument element will pass values used in the people query.

Code Block

language	java

 <htd:task3>
<htd:tasks>

<htd:task>

This is used to provide the definition of an inline human task. The name attribute specifies the name of the task. The name must be unique among the names of all tasks defined within the <htd:tasks> element.

It also consists of the <htd:interface>, <htd:peopleAssignments> and <htd:presentationElements> elements which are used to described the task.

Code Block

language	java

<htd:task name="OrderProcess">  
	<htd:interface />
	<htd:peopleAssignments />
	<htd:presentationElements />
</htd:task>

<htd:interface>

Specifies the port types and operations of the human task.

Code Block

language	java

<htd:interface 
 portType="cl:ClaimsHandlingPT"  
  operation="approve"   
 responsePortType="cl:ClaimsHandlingCallbackPT"   
  responseOperation="approvalResponse"/>

<htd:peopleAssignments>

Used to assign people to process-related generic human roles.

Code Block

language	java

<htd:peopleAssignments>
	<htd:potentialOwners>
		<htd:from logicalPeopleGroup="regionalClerks">
			<htd:argument name="role">
				regionalClerksRole
			</htd:argument>
		</htd:from>
	</htd:potentialOwners>
	<htd:businessAdministrators>
		<htd:from logicalPeopleGroup="regionalClerksregionalManager">
                        			<htd:argument name="role">
                     				regionalManagerRole
			</htd:argument>
		</htd:from>
	</htd:businessAdministrators>
</htd:peopleAssignments>

<htd:documentation>

Provides annotations for users.

Code Block

language	html/xml

<htd:documentation>   
	Example for  regionalClerksRole
                        WS-HumanTask 1.1 - WS-HumanTask Task Definition  
</htd:documentation>

<htd:from>
<htd:argument>

From element used to assign people for roles which have been specified in the business process. Argument element will pass values used in the people query.

Code Block

language	java

<htd:from logicalPeopleGroup="regionalClerks">
 	<htd:argument name="role">
		regionalClerksRole
	</htd:argument>
                    </htd:from>

<htd:presentationElements>

Specifies the user interface for human tasks or how the user interacts with the human task.

Code Block

language	java

<htd:presentationElements>   
<htd:name xml:lang="en-US">Approve Claim
</htd:name>  
<htd:name xml:lang="de-DE">Genehmigungder Schadensforderung  
</htd:name>   
<htd:presentationParameters>   
<htd:presentationParametername="firstname"  
  type="xsd:string">   
 htd:getInput("ClaimApprovalRequest")/test10:cust/test10:firstname   
</htd:presentationParameter>   
</htd:presentationParameters>

<htd:notifications>

Used to provide the definition of an inline notification.The name attribute specifies the name of the notification. The name must be unique among the names of all notifications defined within the <htd:notifications> element.

Code Block

language	java

<htd:notifications>   
  <htd:notificationname="ClaimApprovalReminder">  
  	<htd:documentationxml:lang="en-US">

...

You can have one or more WSDL files which have been used in the BPEL process. You can have a composite WSDL addressing many web services. Claim Approval task has one composite WSDL.

Web folder

There are four .jsp files inside the web folder. Three .jsp files end with:

<TaskName>-input.jsp
<TaskName>-output.jsp
<TaskName>-response.jsp

<TaskName>-input.jsp

The input.jsp file uses the (OMElement) request.getAttribute("taskInput") attribute to obtain the task Details details of the OMElement. This is inserted into the JSP context from BPS. The input.jsp file is used to show the task information to the task user.

...

Code Block

language	javascript

createTaskOutput = function() {  
};

This should provide the corresponding XML string expected by the task operation.

...

Versions Compared

Old Version 2

New Version Current

Key

Sample

scenario

.ht file

Web folder

<TaskName>-input.jsp