You are viewing a plain text version of this content. The canonical link for it is here.
Posted to hise-commits@incubator.apache.org by rr...@apache.org on 2010/01/29 14:31:10 UTC
svn commit: r904507 - in /incubator/hise/site:
author/src/documentation/content/xdocs/developer-guide.xhtml
author/src/documentation/content/xdocs/user-guide.xhtml
publish/claimsHandling.png publish/developer-guide.xhtml
publish/user-guide.xhtml
Author: rr
Date: Fri Jan 29 14:31:09 2010
New Revision: 904507
URL: http://svn.apache.org/viewvc?rev=904507&view=rev
Log:
Guides update
Added:
incubator/hise/site/publish/claimsHandling.png (with props)
Modified:
incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml
incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml
incubator/hise/site/publish/developer-guide.xhtml
incubator/hise/site/publish/user-guide.xhtml
Modified: incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml?rev=904507&r1=904506&r2=904507&view=diff
==============================================================================
--- incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml (original)
+++ incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml Fri Jan 29 14:31:09 2010
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3790226"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3790274">Index</a></span></dt><dt><span class="chapter"><a href="#id3790308">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3790274"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class=
"title"><a id="id3790308"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3880133"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3880181">Index</a></span></dt><dt><span class="chapter"><a href="#id3880215">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3880181"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class=
"title"><a id="id3880215"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
A quick introduction to compiling and running:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
Execute mvn install in hise directory
Modified: incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml?rev=904507&r1=904506&r2=904507&view=diff
==============================================================================
--- incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml (original)
+++ incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml Fri Jan 29 14:31:09 2010
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3538923"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3538971">Index</a></span></dt><dt><span class="chapter"><a href="#id3539004">1. Quick Introduction</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3538971"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction"><div class="titlepage"><div><div><h2 class="title"><a id="id3539004"></a>Chapter 1.
 Quick Introduction</h2></div></div></div><p>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3382196"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3382243">Index</a></span></dt><dt><span class="chapter"><a href="#id3382277">1. Quick Introduction</a></span></dt><dt><span class="chapter"><a href="#id3382424">2. Claims Handling Example</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3382243"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introductio
n"><div class="titlepage"><div><div><h2 class="title"><a id="id3382277"></a>Chapter 1. Quick Introduction</h2></div></div></div><p>
In order to have something running, you need to do following steps:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Download HISE distribution</p></li><li class="listitem"><p>Then you need to unzip HISE WAR contents into your application server directory (like Apache Tomcat). Name it hise.</p></li><li class="listitem"><p>
Copy example files from examples/claims-approval/* into WEB-INF/classes directory.
@@ -38,4 +38,55 @@
Additionally, when WS Addressing reply-to field is specified in approve request,
HISE will send reply on task completion to a specified address.
</p></li></ul></div><p>
+ </p></div><div class="chapter" title="Chapter 2. Claims Handling Example"><div class="titlepage"><div><div><h2 class="title"><a id="id3382424"></a>Chapter 2. Claims Handling Example</h2></div></div></div><p>
+ HISE distribution contains claimsHandling example, which defines a single
+ Human Interaction with one potential owner (Task Operator).
+ </p><p>
+ Task definition from claimsHandling.xml file contains following entries:
+ </p><pre class="programlisting">
+
+ <htd:tasks>
+ <htd:task name="ClaimsHandlingTask">
+ <htd:interface portType="tns:ClaimsHandlingPT" operation="approve" responsePortType="tns:ClaimsHandlingPT" responseOperation="resolve"/>
+
+ ...
+
+ <htd:peopleAssignments>
+ <htd:potentialOwners>
+ <htd:from>
+ <htd:literal>
+ <htd:organizationalEntity>
+ <htd:users>
+ <htd:user>user1</htd:user>
+ </htd:users>
+ </htd:organizationalEntity>
+ </htd:literal>
+ </htd:from>
+ </htd:potentialOwners>
+ </htd:peopleAssignments>
+
+ ...
+
+ <htd:outcome>
+ <![CDATA[
+ <cla:resolve xmlns:cla="http://www.insurance.example.com/claims" xmlns:htd="http://www.example.org/WS-HT">
+ <claimId>{htd:getInput("request")/ClaimApprovalRequest/cla:cust/cla:id/text()}</claimId>
+ <ok>{$outcome}</ok>
+ </cla:resolve>
+ ]]>
+ </htd:outcome>
+ </htd:task>
+ </htd:tasks>
+
+ </pre><p>
+
+ htd:interface specifies Web Service via portType and operation attributes, which is exposed for listening for claims from external system.
+ When such request arrives, it is assigned to potential owner user1, as specified in peopleAssignments: <htd:user>user1</htd:user>.
+ Next, after Task Operator completes the claim, response is sent back to external system, specified by responsePortType and responseOperation.
+
+ Following picture shows basic interation between parties involved.
+
+ </p><div class="mediaobject" align="center"><img src="claimsHandling.png" align="middle" /></div><p>
+
+ Detailed information on endpoint addresses is defined in claimsHandling-hise-dd.xml file.
</p></div></div></body></html>
Added: incubator/hise/site/publish/claimsHandling.png
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/claimsHandling.png?rev=904507&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/hise/site/publish/claimsHandling.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: incubator/hise/site/publish/developer-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/developer-guide.xhtml?rev=904507&r1=904506&r2=904507&view=diff
==============================================================================
--- incubator/hise/site/publish/developer-guide.xhtml (original)
+++ incubator/hise/site/publish/developer-guide.xhtml Fri Jan 29 14:31:09 2010
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3790226"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3790274">Index</a></span></dt><dt><span class="chapter"><a href="#id3790308">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3790274"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class=
"title"><a id="id3790308"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3880133"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3880181">Index</a></span></dt><dt><span class="chapter"><a href="#id3880215">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3880181"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class=
"title"><a id="id3880215"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
A quick introduction to compiling and running:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
Execute mvn install in hise directory
Modified: incubator/hise/site/publish/user-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/user-guide.xhtml?rev=904507&r1=904506&r2=904507&view=diff
==============================================================================
--- incubator/hise/site/publish/user-guide.xhtml (original)
+++ incubator/hise/site/publish/user-guide.xhtml Fri Jan 29 14:31:09 2010
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3538923"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3538971">Index</a></span></dt><dt><span class="chapter"><a href="#id3539004">1. Quick Introduction</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3538971"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction"><div class="titlepage"><div><div><h2 class="title"><a id="id3539004"></a>Chapter 1.
 Quick Introduction</h2></div></div></div><p>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3382196"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">0.1.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3382243">Index</a></span></dt><dt><span class="chapter"><a href="#id3382277">1. Quick Introduction</a></span></dt><dt><span class="chapter"><a href="#id3382424">2. Claims Handling Example</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3382243"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introductio
n"><div class="titlepage"><div><div><h2 class="title"><a id="id3382277"></a>Chapter 1. Quick Introduction</h2></div></div></div><p>
In order to have something running, you need to do following steps:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Download HISE distribution</p></li><li class="listitem"><p>Then you need to unzip HISE WAR contents into your application server directory (like Apache Tomcat). Name it hise.</p></li><li class="listitem"><p>
Copy example files from examples/claims-approval/* into WEB-INF/classes directory.
@@ -38,4 +38,55 @@
Additionally, when WS Addressing reply-to field is specified in approve request,
HISE will send reply on task completion to a specified address.
</p></li></ul></div><p>
+ </p></div><div class="chapter" title="Chapter 2. Claims Handling Example"><div class="titlepage"><div><div><h2 class="title"><a id="id3382424"></a>Chapter 2. Claims Handling Example</h2></div></div></div><p>
+ HISE distribution contains claimsHandling example, which defines a single
+ Human Interaction with one potential owner (Task Operator).
+ </p><p>
+ Task definition from claimsHandling.xml file contains following entries:
+ </p><pre class="programlisting">
+
+ <htd:tasks>
+ <htd:task name="ClaimsHandlingTask">
+ <htd:interface portType="tns:ClaimsHandlingPT" operation="approve" responsePortType="tns:ClaimsHandlingPT" responseOperation="resolve"/>
+
+ ...
+
+ <htd:peopleAssignments>
+ <htd:potentialOwners>
+ <htd:from>
+ <htd:literal>
+ <htd:organizationalEntity>
+ <htd:users>
+ <htd:user>user1</htd:user>
+ </htd:users>
+ </htd:organizationalEntity>
+ </htd:literal>
+ </htd:from>
+ </htd:potentialOwners>
+ </htd:peopleAssignments>
+
+ ...
+
+ <htd:outcome>
+ <![CDATA[
+ <cla:resolve xmlns:cla="http://www.insurance.example.com/claims" xmlns:htd="http://www.example.org/WS-HT">
+ <claimId>{htd:getInput("request")/ClaimApprovalRequest/cla:cust/cla:id/text()}</claimId>
+ <ok>{$outcome}</ok>
+ </cla:resolve>
+ ]]>
+ </htd:outcome>
+ </htd:task>
+ </htd:tasks>
+
+ </pre><p>
+
+ htd:interface specifies Web Service via portType and operation attributes, which is exposed for listening for claims from external system.
+ When such request arrives, it is assigned to potential owner user1, as specified in peopleAssignments: <htd:user>user1</htd:user>.
+ Next, after Task Operator completes the claim, response is sent back to external system, specified by responsePortType and responseOperation.
+
+ Following picture shows basic interation between parties involved.
+
+ </p><div class="mediaobject" align="center"><img src="claimsHandling.png" align="middle" /></div><p>
+
+ Detailed information on endpoint addresses is defined in claimsHandling-hise-dd.xml file.
</p></div></div></body></html>