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 wi...@apache.org on 2011/07/29 13:36:17 UTC
svn commit: r1152216 [2/2] - in /incubator/hise/site/publish: articles.html
contributing.html contributors.html developer-guide.xhtml download.html
index.html linkmap.html road-map.html skin/basic.css skin/screen.css
status.html user-guide.xhtml
Modified: incubator/hise/site/publish/user-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/user-guide.xhtml?rev=1152216&r1=1152215&r2=1152216&view=diff
==============================================================================
--- incubator/hise/site/publish/user-guide.xhtml (original)
+++ incubator/hise/site/publish/user-guide.xhtml Fri Jul 29 13:36:15 2011
@@ -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="id3790367"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">0.3.0</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3790419">Index</a></span></dt><dt><span class="chapter"><a href="#id3790455">1. Quick Introduction into WAR distibution</a></span></dt><dt><span class="chapter"><a href="#id3790617">2. Intoduction into OSGi distribution</a></span></dt><dt><span class="chapter"><a href="#id3790639">3. Claims Handling Example</a></span></dt><dt><span class="chapter"><a href="#id3790706">4. Concepts</a></span></dt><dd><dl><dt><span class="sect1"><a href="#taskInstan
ceData">Task instance data</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3790762">Presentation parameters</a></span></dt><dt><span class="sect2"><a href="#id3790775">Context Data</a></span></dt><dt><span class="sect2"><a href="#id3790809">Operational data</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3790818">Generic Human Role</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3790871">Task initiator</a></span></dt><dt><span class="sect2"><a href="#id3790883">Task stakeholders</a></span></dt><dt><span class="sect2"><a href="#id3790901">Potential owners</a></span></dt><dt><span class="sect2"><a href="#id3790918">Actual owner</a></span></dt><dt><span class="sect2"><a href="#id3790931">Buisness administrators</a></span></dt><dt><span class="sect2"><a href="#id3790947">Excluded owners</a></span></dt><dt><span class="sect2"><a href="#id3790960">Recipients</a></span></dt><dt><span class="sect2"><a href="#id3790976">Potential delegatees</a></spa
n></dt></dl></dd><dt><span class="sect1"><a href="#id3790990">Logical People Group</a></span></dt></dl></dd><dt><span class="chapter"><a href="#task_properties">5. Task properties</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id3791019">Task Properties</a></span></dt></dl></dd><dt><span class="chapter"><a href="#task_features">6. Task features</a></span></dt><dd><dl><dt><span class="sect1"><a href="#states">Task finite state machine</a></span></dt><dt><span class="sect1"><a href="#id3791142">Deadline</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3791211">Escalations</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3791357">Delegation</a></span></dt><dt><span class="sect1"><a href="#comments">Comments</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3791415">Comments added by user</a></span></dt><dt><span class="sect2"><a href="#id3791448">Task history in comments</a></span></dt></dl></dd><dt><span class="sect1"><a href="#renderin
g">Rendering</a></span></dt><dt><span class="sect1"><a href="#attachments">Attachments</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3791642">addAttachment</a></span></dt><dt><span class="sect2"><a href="#id3791668">deleteAttachment</a></span></dt><dt><span class="sect2"><a href="#id3791676">getAttachmentInfos</a></span></dt><dt><span class="sect2"><a href="#id3791698">getAttachments</a></span></dt></dl></dd><dt><span class="sect1"><a href="#filtering">Task filtering</a></span></dt><dt><span class="sect1"><a href="#presentationElements">Presentation elements</a></span></dt><dt><span class="sect1"><a href="#presentationElements">Presentation elements</a></span></dt></dl></dd><dt><span class="chapter"><a href="#taskOperations">7. Task operations</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id3792011">Participant operations</a></span></dt><dt><span class="sect1"><a href="#id3792881">Administrative Operations</a></span></dt><dt><span class="sect1"><a hre
f="#simpleQuery">Simple Query operations</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3793103">8. Notifications</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id3793108"></a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3793141">Notification properties</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#examples">9. Examples</a></span></dt><dd><dl><dt><span class="sect1"><a href="#taskInfoExample">Task info example</a></span></dt></dl></dd></dl></div><div class="list-of-figures"><p><b>List of Figures</b></p><dl><dt>6.1. <a href="#id3791134">State transitions</a></dt></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>7.1. <a href="#id3792043">Participant operations</a></dt><dt>7.2. <a href="#id3792888">Administrative Operations</a></dt><dt>7.3. <a href="#id3793013">Simple Query operations</a></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id=
"id3790419"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction into WAR distibution"><div class="titlepage"><div><div><h2 class="title"><a id="id3790455"></a>Chapter 1. Quick Introduction into WAR distibution</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="id2966791"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">1.0.0-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3839133">Index</a></span></dt><dt><span class="chapter"><a href="#id3839196">1. Quick Introduction into WAR distibution</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id3839091">Detail tutorial for Apache Tomcat</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3839445">2. Intoduction into OSGi distribution</a></span></dt><dt><span class="chapter"><a href="#id3839468">3. Claims Handling Example</a></span></dt><dt><
span class="chapter"><a href="#id3839537">4. Concepts</a></span></dt><dd><dl><dt><span class="sect1"><a href="#taskInstanceData">Task instance data</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3839593">Presentation parameters</a></span></dt><dt><span class="sect2"><a href="#id3839606">Context Data</a></span></dt><dt><span class="sect2"><a href="#id3839640">Operational data</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3839650">Generic Human Role</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3839702">Task initiator</a></span></dt><dt><span class="sect2"><a href="#id3839714">Task stakeholders</a></span></dt><dt><span class="sect2"><a href="#id3839732">Potential owners</a></span></dt><dt><span class="sect2"><a href="#id3839749">Actual owner</a></span></dt><dt><span class="sect2"><a href="#id3839763">Buisness administrators</a></span></dt><dt><span class="sect2"><a href="#id3839779">Excluded owners</a></span></dt><dt><span class="sect2">
<a href="#id3839794">Recipients</a></span></dt><dt><span class="sect2"><a href="#id3839810">Potential delegatees</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3839825">Logical People Group</a></span></dt></dl></dd><dt><span class="chapter"><a href="#task_properties">5. Task properties</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id3839854">Task Properties</a></span></dt></dl></dd><dt><span class="chapter"><a href="#task_features">6. Task features</a></span></dt><dd><dl><dt><span class="sect1"><a href="#states">Task finite state machine</a></span></dt><dt><span class="sect1"><a href="#id3839968">Deadline</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3840037">Escalations</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3840182">Delegation</a></span></dt><dt><span class="sect1"><a href="#comments">Comments</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3840240">Comments added by user</a></span></dt><dt><span class=
"sect2"><a href="#id3840273">Task history in comments</a></span></dt></dl></dd><dt><span class="sect1"><a href="#rendering">Rendering</a></span></dt><dt><span class="sect1"><a href="#attachments">Attachments</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3840467">addAttachment</a></span></dt><dt><span class="sect2"><a href="#id3840493">deleteAttachment</a></span></dt><dt><span class="sect2"><a href="#id3840501">getAttachmentInfos</a></span></dt><dt><span class="sect2"><a href="#id3840523">getAttachments</a></span></dt></dl></dd><dt><span class="sect1"><a href="#filtering">Task filtering</a></span></dt><dt><span class="sect1"><a href="#presentationElements">Presentation elements</a></span></dt><dt><span class="sect1"><a href="#presentationElements">Presentation elements</a></span></dt></dl></dd><dt><span class="chapter"><a href="#taskOperations">7. Task operations</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id3840836">Participant operations</a></span>
</dt><dt><span class="sect1"><a href="#id3841706">Administrative Operations</a></span></dt><dt><span class="sect1"><a href="#simpleQuery">Simple Query operations</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3841928">8. Notifications</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id3841933"></a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3841966">Notification properties</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#examples">9. Examples</a></span></dt><dd><dl><dt><span class="sect1"><a href="#taskInfoExample">Task info example</a></span></dt></dl></dd></dl></div><div class="list-of-figures"><p><b>List of Figures</b></p><dl><dt>6.1. <a href="#id3839960">State transitions</a></dt></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>7.1. <a href="#id3840868">Participant operations</a></dt><dt>7.2. <a href="#id3841713">Administrative Operations</a></dt><dt>7.3. <a href="#id3841838">Simple Query
operations</a></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3839133"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction into WAR distibution"><div class="titlepage"><div><div><h2 class="title"><a id="id3839196"></a>Chapter 1. Quick Introduction into WAR distibution</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id3839091">Detail tutorial for Apache Tomcat</a></span></dt></dl></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,7 +38,15 @@
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. Intoduction into OSGi distribution"><div class="titlepage"><div><div><h2 class="title"><a id="id3790617"></a>Chapter 2. Intoduction into OSGi distribution</h2></div></div></div><p>
+ </p><div class="sect1" title="Detail tutorial for Apache Tomcat"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3839091"></a>Detail tutorial for Apache Tomcat</h2></div></div></div><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Download HISE distribution and Apache Tomcat. This distribution was tested under Tomcat 5.5 and 7.0</p></li><li class="listitem"><p>Extract HISE and install Tomcat.
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem"><p>The catalog where HISE was extracted in futher part of the tutorial will be called HISE_DIR</p></li><li class="listitem"><p>The catalog of Tomcat instalation in futher part of the tutorial will be called TOMCAT_DIR</p></li></ul></div><p>
+ </p></li><li class="listitem"><p>Copy war file from HISE_DIR to TOMCAT_DIR/webapps. Change name of the file to hise.war </p></li><li class="listitem"><p>Start Tomcat. Then on the basis of hise.war will be created directory TOMCAT_DIR/webapps/hise, and in TOMCAT_DIR/bin will be created files hise-h2-db.*.db for H2 database. After that shutdown Tomcat</p></li><li class="listitem"><p>You need to import some user and group definitions.By default, HISE uses H2 file database named hise-h2-db.So you can run addUsers.sql script from HISE distribution, by following command:
+ </p><pre class="programlisting">
+ java -cp TOMCAT_DIR/webapps/hise/WEB-INF/lib/h2-1.1.108.jar org.h2.tools.RunScript -url 'jdbc:h2:file:TOMCAT_DIR/bin/hise-h2-db;DB_CLOSE_ON_EXIT=false' -user sa -showResults -script HISE_DIR/examples/addUsers.sql
+ </pre><p>
+ </p></li><li class="listitem"><p>Copy files from HISE_DIR/examples/war/claimsHandling/ to TOMCAT_DIR/webapps/hise/WEB-INF/classes </p></li><li class="listitem"><p>Copy files from HISE_DIR/examples/war/claimsHandling/ to TOMCAT_DIR/webapps/hise/WEB-INF/classes.</p></li><li class="listitem"><p>Now you can start Tomcat. If everything is fine at http://localhost:8080/hise you will see HISE services.</p></li><li class="listitem"><p>You can import WSDL http://localhost:8080/hise/ClaimsHandlingService/?wsdl into SoapUI to start interacting with Human Task. There is also a prepared project in HISE_DIR/examples/war/claimsHandling/claimsHandling-soapui-project.xml. At the first try run prepared test to make certain HISE is working properly.</p></li></ul></div><p>
+ </p></div></div><div class="chapter" title="Chapter 2. Intoduction into OSGi distribution"><div class="titlepage"><div><div><h2 class="title"><a id="id3839445"></a>Chapter 2. Intoduction into OSGi distribution</h2></div></div></div><p>
HISE OSGi distribution works out of box under Apache ServiceMix 4.
It contains bundles directory with required dependencies.
In order to run it, you need to type in ServiceMix console: <code class="code">features:install hise-h2-test-example-osgi</code>
@@ -46,7 +54,7 @@
and see deployed Web Services.
</p><p>
This distribution was tested under apache-servicemix-4.2.0-fuse-01-00.
- </p></div><div class="chapter" title="Chapter 3. Claims Handling Example"><div class="titlepage"><div><div><h2 class="title"><a id="id3790639"></a>Chapter 3. Claims Handling Example</h2></div></div></div><p>
+ </p></div><div class="chapter" title="Chapter 3. Claims Handling Example"><div class="titlepage"><div><div><h2 class="title"><a id="id3839468"></a>Chapter 3. 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>
@@ -97,7 +105,7 @@
</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 class="chapter" title="Chapter 4. Concepts"><div class="titlepage"><div><div><h2 class="title"><a id="id3790706"></a>Chapter 4. Concepts</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#taskInstanceData">Task instance data</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3790762">Presentation parameters</a></span></dt><dt><span class="sect2"><a href="#id3790775">Context Data</a></span></dt><dt><span class="sect2"><a href="#id3790809">Operational data</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3790818">Generic Human Role</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3790871">Task initiator</a></span></dt><dt><span class="sect2"><a href="#id3790883">Task stakeholders</a></span></dt><dt><span class="sect2"><a href="#id3790901">Potential owners</a></span></dt><dt><span class="sect2"><a href="#id3790918">Actual owner</a></span></dt><dt><span class="se
ct2"><a href="#id3790931">Buisness administrators</a></span></dt><dt><span class="sect2"><a href="#id3790947">Excluded owners</a></span></dt><dt><span class="sect2"><a href="#id3790960">Recipients</a></span></dt><dt><span class="sect2"><a href="#id3790976">Potential delegatees</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3790990">Logical People Group</a></span></dt></dl></div><p>
+ </p></div><div class="chapter" title="Chapter 4. Concepts"><div class="titlepage"><div><div><h2 class="title"><a id="id3839537"></a>Chapter 4. Concepts</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#taskInstanceData">Task instance data</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3839593">Presentation parameters</a></span></dt><dt><span class="sect2"><a href="#id3839606">Context Data</a></span></dt><dt><span class="sect2"><a href="#id3839640">Operational data</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3839650">Generic Human Role</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3839702">Task initiator</a></span></dt><dt><span class="sect2"><a href="#id3839714">Task stakeholders</a></span></dt><dt><span class="sect2"><a href="#id3839732">Potential owners</a></span></dt><dt><span class="sect2"><a href="#id3839749">Actual owner</a></span></dt><dt><span class="se
ct2"><a href="#id3839763">Buisness administrators</a></span></dt><dt><span class="sect2"><a href="#id3839779">Excluded owners</a></span></dt><dt><span class="sect2"><a href="#id3839794">Recipients</a></span></dt><dt><span class="sect2"><a href="#id3839810">Potential delegatees</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3839825">Logical People Group</a></span></dt></dl></div><p>
Human tasks, or briefly tasks enable the integration of human beings in service-
oriented applications.
Human tasks are services âimplementedâ by people. They allow the integration of
@@ -123,27 +131,27 @@ acknowledge their receipt.
or description.</p></li><li class="listitem"><p> Context data - A set of dynamic properties, such as priority,
task state, time stamps and values for all generic human roles.
</p></li><li class="listitem"><p> Operational data â The data includes the input message, output
- message, attachments and comments.</p></li></ul></div><div class="sect2" title="Presentation parameters"><div class="titlepage"><div><div><h3 class="title"><a id="id3790762"></a>Presentation parameters</h3></div></div></div>
+ message, attachments and comments.</p></li></ul></div><div class="sect2" title="Presentation parameters"><div class="titlepage"><div><div><h3 class="title"><a id="id3839593"></a>Presentation parameters</h3></div></div></div>
The presentation data is used, for example, when displaying a task or
a notification in the task list client. The presentation data has been
prepared for display such as by substituting variables. See
<a class="link" href="#presentationElements" title="Presentation elements">Presentation Elements</a>
for more details.
- </div><div class="sect2" title="Context Data"><div class="titlepage"><div><div><h3 class="title"><a id="id3790775"></a>Context Data</h3></div></div></div>
+ </div><div class="sect2" title="Context Data"><div class="titlepage"><div><div><h3 class="title"><a id="id3839606"></a>Context Data</h3></div></div></div>
The task context includes a lot of things, for example:
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>task state</p></li><li class="listitem"><p>priority</p></li><li class="listitem"><p> Values for all generic human roles, i.e. potential owners,
actual owner and business administrators</p></li><li class="listitem"><p>Time stamps such as start time, completion time</p></li><li class="listitem"><p>Skipable indicator</p></li><li class="listitem"><p>task history language and indicator</p></li></ul></div>
For whole list of information go to
- <a class="link" href="#taskInfoExample" title="Task info example">task info example</a></div><div class="sect2" title="Operational data"><div class="titlepage"><div><div><h3 class="title"><a id="id3790809"></a>Operational data</h3></div></div></div><p>The operational data of a task consists of its input data and
+ <a class="link" href="#taskInfoExample" title="Task info example">task info example</a></div><div class="sect2" title="Operational data"><div class="titlepage"><div><div><h3 class="title"><a id="id3839640"></a>Operational data</h3></div></div></div><p>The operational data of a task consists of its input data and
output data or fault data. Operational data is accessed using the
- XQuery extension functions and programming interface.</p></div></div><div class="sect1" title="Generic Human Role"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3790818"></a>Generic Human Role</h2></div></div></div><p>Generic human roles define what a person or group of people
+ XQuery extension functions and programming interface.</p></div></div><div class="sect1" title="Generic Human Role"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3839650"></a>Generic Human Role</h2></div></div></div><p>Generic human roles define what a person or group of people
resulting from a people query can do with tasks and notifications. The
aplication distinguish fallowing generic human roles:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><a class="link" href="#taskInitiator">Task initiator</a></li><li class="listitem"><a class="link" href="#taskStakeholders">Task stakeholders</a></li><li class="listitem"><a class="link" href="#potentialOwners">Potential owners</a></li><li class="listitem"><a class="link" href="#actualOner">Actual owner</a></li><li class="listitem"><a class="link" href="#businessAdministrators">Business
- administrators</a></li><li class="listitem"><a class="link" href="#excludedOwners">Excluded owners </a></li><li class="listitem"><a class="link" href="#recipients">Recipients</a></li><li class="listitem"><a class="link" href="#potentialDelegatees">Potential delegatees</a></li></ul></div><p> </p><div class="sect2" title="Task initiator"><div class="titlepage"><div><div><h3 class="title"><a id="id3790871"></a><p><a id="taskInitiator"></a>Task initiator</p></h3></div></div></div><p>Task initiator is the
+ administrators</a></li><li class="listitem"><a class="link" href="#excludedOwners">Excluded owners </a></li><li class="listitem"><a class="link" href="#recipients">Recipients</a></li><li class="listitem"><a class="link" href="#potentialDelegatees">Potential delegatees</a></li></ul></div><p> </p><div class="sect2" title="Task initiator"><div class="titlepage"><div><div><h3 class="title"><a id="id3839702"></a><p><a id="taskInitiator"></a>Task initiator</p></h3></div></div></div><p>Task initiator is the
person who creates the task instance. Depending on how the task has been
instantiated the task initiator may or may not be defined. If task
- initiator is defined it is exactly one person.</p></div><div class="sect2" title="Task stakeholders"><div class="titlepage"><div><div><h3 class="title"><a id="id3790883"></a><p><a id="taskStakeholders"></a>Task stakeholders</p></h3></div></div></div><p>Task stakeholders are
+ initiator is defined it is exactly one person.</p></div><div class="sect2" title="Task stakeholders"><div class="titlepage"><div><div><h3 class="title"><a id="id3839714"></a><p><a id="taskStakeholders"></a>Task stakeholders</p></h3></div></div></div><p>Task stakeholders are
the people ultimately responsible for the oversight and outcome of the
task instance. A task stakeholder can influence the progress of a task,
for example, by adding ad-hoc attachments, forwarding the task, or
@@ -151,35 +159,35 @@ acknowledge their receipt.
perform administrative actions on the task instance and associated
notifications, such as resolving missed deadlines. Compliant
implementations MUST ensure that at least one person is associated with
- this role at runtime.</p></div><div class="sect2" title="Potential owners"><div class="titlepage"><div><div><h3 class="title"><a id="id3790901"></a><p><a id="potentialOwners"></a>Potential owners</p></h3></div></div></div><p>Potential owners of a
+ this role at runtime.</p></div><div class="sect2" title="Potential owners"><div class="titlepage"><div><div><h3 class="title"><a id="id3839732"></a><p><a id="potentialOwners"></a>Potential owners</p></h3></div></div></div><p>Potential owners of a
task are persons who receive the task so that they can claim and
complete it. A potential owner becomes the actual owner of a task by
explicitly claiming it. Before the task has been claimed, potential
owners can influence the progress of the task, for example by changing
the priority of the task, adding ad-hoc attachments or comments. All
excluded owners are implicitly removed from the set of potential
- owners.</p></div><div class="sect2" title="Actual owner"><div class="titlepage"><div><div><h3 class="title"><a id="id3790918"></a><p><a id="actualOner"></a>Actual owner</p></h3></div></div></div><p>Actual owneris the person
+ owners.</p></div><div class="sect2" title="Actual owner"><div class="titlepage"><div><div><h3 class="title"><a id="id3839749"></a><p><a id="actualOner"></a>Actual owner</p></h3></div></div></div><p>Actual owneris the person
actually performing the task. A task has exactly one actual owner. When
task is performed, the actual owner can execute actions, such as
revoking the claim, forwarding the task, suspending and resuming the
- task execution or changing the priority of the task.</p></div><div class="sect2" title="Buisness administrators"><div class="titlepage"><div><div><h3 class="title"><a id="id3790931"></a><p><a id="businessAdministrators"></a>Buisness administrators</p></h3></div></div></div><p>Buisness administrators are the people
+ task execution or changing the priority of the task.</p></div><div class="sect2" title="Buisness administrators"><div class="titlepage"><div><div><h3 class="title"><a id="id3839763"></a><p><a id="businessAdministrators"></a>Buisness administrators</p></h3></div></div></div><p>Buisness administrators are the people
who can play the same role as task stakeholders but at task type level.
Therefore, business administrators can perform the exact same operations
as task stakeholders. Business administrators may also observe the
progress of notifications. Compliant implementations MUST ensure that at
- runtime at least one person is associated with this role.</p></div><div class="sect2" title="Excluded owners"><div class="titlepage"><div><div><h3 class="title"><a id="id3790947"></a><p><a id="excludedOwners"></a>Excluded owners</p></h3></div></div></div><p><a id="excludedOwners"></a>Excluded owners may not
+ runtime at least one person is associated with this role.</p></div><div class="sect2" title="Excluded owners"><div class="titlepage"><div><div><h3 class="title"><a id="id3839779"></a><p><a id="excludedOwners"></a>Excluded owners</p></h3></div></div></div><p><a id="excludedOwners"></a>Excluded owners may not
become an actual or potential owner and thus they may not reserve or
start the task. They can only doing statistic or information
- operations.</p></div><div class="sect2" title="Recipients"><div class="titlepage"><div><div><h3 class="title"><a id="id3790960"></a><p><a id="recipients"></a>Recipients</p></h3></div></div></div><p>Recipients are persons who
+ operations.</p></div><div class="sect2" title="Recipients"><div class="titlepage"><div><div><h3 class="title"><a id="id3839794"></a><p><a id="recipients"></a>Recipients</p></h3></div></div></div><p>Recipients are persons who
receive the notification, such as happens when a deadline is missed or
when a milestone is reached. This role is similar to the roles potential
owners and actual owner but has different repercussions because a
notification recipient does not have to perform any action and hence it
is more of informational nature than participation. A notification has
- one or more recipients.</p></div><div class="sect2" title="Potential delegatees"><div class="titlepage"><div><div><h3 class="title"><a id="id3790976"></a><p><a id="potentialDelegatees"></a>Potential delegatees</p></h3></div></div></div><p>Potential delegatees
+ one or more recipients.</p></div><div class="sect2" title="Potential delegatees"><div class="titlepage"><div><div><h3 class="title"><a id="id3839810"></a><p><a id="potentialDelegatees"></a>Potential delegatees</p></h3></div></div></div><p>Potential delegatees
are persons or group peopels who can be delegate to perform the task.
Potential delegatees are indication durning creation task by the task
- initiator. </p></div></div><div class="sect1" title="Logical People Group"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3790990"></a>Logical People Group</h2></div></div></div><p>A logical people groups is an element that could represents one person, a set of people, or one or many unresolved group of people. It is global element enclosed in a human interactions definition document. Multiple human tasks in the same document can utilize the same logical people group definition.
+ initiator. </p></div></div><div class="sect1" title="Logical People Group"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3839825"></a>Logical People Group</h2></div></div></div><p>A logical people groups is an element that could represents one person, a set of people, or one or many unresolved group of people. It is global element enclosed in a human interactions definition document. Multiple human tasks in the same document can utilize the same logical people group definition.
</p><pre class="programlisting">
<htd:logicalPeopleGroups>
@@ -191,21 +199,18 @@ acknowledge their receipt.
</htd:logicalPeopleGroups>
- </pre></div></div><div class="chapter" title="Chapter 5. Task properties"><div class="titlepage"><div><div><h2 class="title"><a id="task_properties"></a>Chapter 5. Task properties</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id3791019">Task Properties</a></span></dt></dl></div><div class="sect1" title="Task Properties"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3791019"></a>Task Properties</h2></div></div></div><p>The fallowing basic attributs are defined for tasks:
+ </pre></div></div><div class="chapter" title="Chapter 5. Task properties"><div class="titlepage"><div><div><h2 class="title"><a id="task_properties"></a>Chapter 5. Task properties</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id3839854">Task Properties</a></span></dt></dl></div><div class="sect1" title="Task Properties"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3839854"></a>Task Properties</h2></div></div></div><p>The fallowing basic attributs are defined for tasks:
- </p><div class="sect2" title="name"><div class="titlepage"><div><div><h3 class="title"><a id="id3791027"></a><p><a id="task_name"></a>name</p></h3></div></div></div><p>This attribute is mandatory. It is used to specity the name of the task.
+ </p><div class="sect2" title="name"><div class="titlepage"><div><div><h3 class="title"><a id="id3839860"></a><p><a id="task_name"></a>name</p></h3></div></div></div><p>This attribute is mandatory. It is used to specity the name of the task.
The name, combined with namespace create a unique identifier the task definition.
</p></div><p>
- </p><div class="sect2" title="priority"><div class="titlepage"><div><div><h3 class="title"><a id="id3791041"></a><p><a id="task_priority"></a>priority</p></h3></div></div></div><p>This element is used to specify the priority of the task. It is an
+ </p><div class="sect2" title="priority"><div class="titlepage"><div><div><h3 class="title"><a id="id3839875"></a><p><a id="task_priority"></a>priority</p></h3></div></div></div><p>This element is used to specify the priority of the task. It is an
optional element which value is an integer expression. If not present, the priority of the task is set to 0 what is the highest priority. Larger numbers identify lower priorites.
</p></div><p>
- </p><div class="sect2" title="autoActivate"><div class="titlepage"><div><div><h3 class="title"><a id="id3791056"></a>autoActivate</h3></div></div></div><p>This element allows enable automatic activation task (if it is possible) immediately after
+ </p><div class="sect2" title="autoActivate"><div class="titlepage"><div><div><h3 class="title"><a id="id3839890"></a>autoActivate</h3></div></div></div><p>This element allows enable automatic activation task (if it is possible) immediately after
it is creation. It is binary type and optional. If not present the default value is false
</p></div><p>
- </p><div class="sect2" title="isSkipable"><div class="titlepage"><div><div><h3 class="title"><a id="id3791066"></a>isSkipable</h3></div></div></div><p>This element is used to determines whether a task can actuall be skipped at runtime.
- It is binary type and optional. If not present the default value is true.
- </p></div><p>
- </p><div class="sect2" title="peopleAssignments"><div class="titlepage"><div><div><h3 class="title"><a id="id3791076"></a><p><a id="task_peopleAssignments"></a>peopleAssignments</p></h3></div></div></div><p> It is used to assign people and group of people to different generic human role.
+ </p><div class="sect2" title="peopleAssignments"><div class="titlepage"><div><div><h3 class="title"><a id="id3839900"></a><p><a id="task_peopleAssignments"></a>peopleAssignments</p></h3></div></div></div><p> It is used to assign people and group of people to different generic human role.
This element is mandatory and is defined by "Using Literals"
or "Logical people groups".
</p><pre class="programlisting">
@@ -239,12 +244,12 @@ acknowledge their receipt.
</htd:potentialOwners>
</pre></div><p>
- </p></div></div><div class="chapter" title="Chapter 6. Task features"><div class="titlepage"><div><div><h2 class="title"><a id="task_features"></a>Chapter 6. Task features</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#states">Task finite state machine</a></span></dt><dt><span class="sect1"><a href="#id3791142">Deadline</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3791211">Escalations</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3791357">Delegation</a></span></dt><dt><span class="sect1"><a href="#comments">Comments</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3791415">Comments added by user</a></span></dt><dt><span class="sect2"><a href="#id3791448">Task history in comments</a></span></dt></dl></dd><dt><span class="sect1"><a href="#rendering">Rendering</a></span></dt><dt><span class="sect1"><a href="#attachments">Attachments</a></span></dt><dd><dl><dt><span c
lass="sect2"><a href="#id3791642">addAttachment</a></span></dt><dt><span class="sect2"><a href="#id3791668">deleteAttachment</a></span></dt><dt><span class="sect2"><a href="#id3791676">getAttachmentInfos</a></span></dt><dt><span class="sect2"><a href="#id3791698">getAttachments</a></span></dt></dl></dd><dt><span class="sect1"><a href="#filtering">Task filtering</a></span></dt><dt><span class="sect1"><a href="#presentationElements">Presentation elements</a></span></dt><dt><span class="sect1"><a href="#presentationElements">Presentation elements</a></span></dt></dl></div><div class="sect1" title="Task finite state machine"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="states"></a>Task finite state machine</h2></div></div></div>
+ </p></div></div><div class="chapter" title="Chapter 6. Task features"><div class="titlepage"><div><div><h2 class="title"><a id="task_features"></a>Chapter 6. Task features</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#states">Task finite state machine</a></span></dt><dt><span class="sect1"><a href="#id3839968">Deadline</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3840037">Escalations</a></span></dt></dl></dd><dt><span class="sect1"><a href="#id3840182">Delegation</a></span></dt><dt><span class="sect1"><a href="#comments">Comments</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3840240">Comments added by user</a></span></dt><dt><span class="sect2"><a href="#id3840273">Task history in comments</a></span></dt></dl></dd><dt><span class="sect1"><a href="#rendering">Rendering</a></span></dt><dt><span class="sect1"><a href="#attachments">Attachments</a></span></dt><dd><dl><dt><span c
lass="sect2"><a href="#id3840467">addAttachment</a></span></dt><dt><span class="sect2"><a href="#id3840493">deleteAttachment</a></span></dt><dt><span class="sect2"><a href="#id3840501">getAttachmentInfos</a></span></dt><dt><span class="sect2"><a href="#id3840523">getAttachments</a></span></dt></dl></dd><dt><span class="sect1"><a href="#filtering">Task filtering</a></span></dt><dt><span class="sect1"><a href="#presentationElements">Presentation elements</a></span></dt><dt><span class="sect1"><a href="#presentationElements">Presentation elements</a></span></dt></dl></div><div class="sect1" title="Task finite state machine"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="states"></a>Task finite state machine</h2></div></div></div>
Human tasks can have a number of different states and substates. The state diagram
for human tasks below shows the different states and the transitions between them.
Go to <a class="link" href="#taskOperations" title="Chapter 7. Task operations">task Operations</a> to see more details about functions from the graph.
- <div class="figure"><a id="id3791134"></a><p class="title"><b>Figure 6.1. State transitions</b></p><div class="figure-contents"><div><img src="states.png" alt="State transitions" /></div></div></div><br class="figure-break" /></div><div class="sect1" title="Deadline"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3791142"></a>Deadline</h2></div></div></div><p>Hise implements a deadline mechanism. Deadlines are defined inside task definitions and contains some <a class="link" href="#escalations">escalation</a> action. There are two types of deadlines:
+ <div class="figure"><a id="id3839960"></a><p class="title"><b>Figure 6.1. State transitions</b></p><div class="figure-contents"><div><img src="states.png" alt="State transitions" /></div></div></div><br class="figure-break" /></div><div class="sect1" title="Deadline"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3839968"></a>Deadline</h2></div></div></div><p>Hise implements a deadline mechanism. Deadlines are defined inside task definitions and contains some <a class="link" href="#escalations">escalation</a> action. There are two types of deadlines:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>Start deadline</em></span> : Specifies the time until the task must start. It is defined as either the period of time or the point in time until the task must reach state inProgress. The time starts to be measured
from the time at which the task enters the state Created. If the task does not
@@ -286,7 +291,7 @@ obsolete and are removed.</p></li><li cl
</htd:deadlines>
</pre><p>
- </p><div class="sect2" title="Escalations"><div class="titlepage"><div><div><h3 class="title"><a id="id3791211"></a>Escalations</h3></div></div></div><p>Escalations is a definition of actions to be executed if a task's status is not reached within a certain time. An escalation must specify exactly one escalation action ( notification or reassignment). In one deadline could be defined many escalations.
+ </p><div class="sect2" title="Escalations"><div class="titlepage"><div><div><h3 class="title"><a id="id3840037"></a>Escalations</h3></div></div></div><p>Escalations is a definition of actions to be executed if a task's status is not reached within a certain time. An escalation must specify exactly one escalation action ( notification or reassignment). In one deadline could be defined many escalations.
</p><pre class="programlisting">
<htd:escalation name="NCName">
@@ -296,7 +301,7 @@ obsolete and are removed.</p></li><li cl
</pre><p>
The escalatino definition may contain:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><a class="link" href="#condition">condition</a></li><li class="listitem"><a class="link" href="#notification">notification</a></li><li class="listitem"><a class="link" href="#notification">localNotification</a></li><li class="listitem"><a class="link" href="#reassignment">reassignment</a></li><li class="listitem"><a class="link" href="#toParts">toParts element</a></li></ul></div><p>
- </p><div class="sect3" title="Condition"><div class="titlepage"><div><div><h4 class="title"><a id="id3791262"></a><p><a id="condition"></a>Condition</p></h4></div></div></div><p>Condition is a element that allows (if evaluates to true) perform escalation. If the condition is not fulfilled during the cause deadline, the escalation is removed along with the deadline. Condition is an optional element.
+ </p><div class="sect3" title="Condition"><div class="titlepage"><div><div><h4 class="title"><a id="id3840087"></a><p><a id="condition"></a>Condition</p></h4></div></div></div><p>Condition is a element that allows (if evaluates to true) perform escalation. If the condition is not fulfilled during the cause deadline, the escalation is removed along with the deadline. Condition is an optional element.
</p><pre class="programlisting">
@@ -305,7 +310,7 @@ The escalatino definition may contain:
</htd:condition>
</pre><p>
- </p></div><div class="sect3" title="Notifications"><div class="titlepage"><div><div><h4 class="title"><a id="id3791280"></a><p><a id="notification"></a>Notifications</p></h4></div></div></div><p>Notifications are used to inform people about the status of the task. Notifications are explained in more detail in section âNotificationsâ. Notification can be either referred to, or defined inline. A notifications imported from a different namespace can be added by a localNotification element. A inlined notification is defined by a notification element. Notifications used in escalations may use the same type of input data as the surrounding task, or different type of data. If the same type of data is used then the input message of the task is passed to the notification implicitly.
+ </p></div><div class="sect3" title="Notifications"><div class="titlepage"><div><div><h4 class="title"><a id="id3840105"></a><p><a id="notification"></a>Notifications</p></h4></div></div></div><p>Notifications are used to inform people about the status of the task. Notifications are explained in more detail in section âNotificationsâ. Notification can be either referred to, or defined inline. A notifications imported from a different namespace can be added by a localNotification element. A inlined notification is defined by a notification element. Notifications used in escalations may use the same type of input data as the surrounding task, or different type of data. If the same type of data is used then the input message of the task is passed to the notification implicitly.
If not, then the toPart elements are used to assign appropriate data to the notification.
</p><pre class="programlisting">
@@ -331,7 +336,7 @@ If not, then the toPart elements are use
</htd:notification>
</pre><p>
- </p></div><div class="sect3" title="ToParts"><div class="titlepage"><div><div><h4 class="title"><a id="id3791314"></a><p><a id="toParts"></a>ToParts</p></h4></div></div></div><p>ToParts is a element used when notifications in escalations use different type of data then input date. Then the toPart elements are used to assign appropriate data to the notification. If any of the toParts fails, the escalation action will not be performed and the execution of the task is not affected.
+ </p></div><div class="sect3" title="ToParts"><div class="titlepage"><div><div><h4 class="title"><a id="id3840139"></a><p><a id="toParts"></a>ToParts</p></h4></div></div></div><p>ToParts is a element used when notifications in escalations use different type of data then input date. Then the toPart elements are used to assign appropriate data to the notification. If any of the toParts fails, the escalation action will not be performed and the execution of the task is not affected.
</p><pre class="programlisting">
@@ -343,7 +348,7 @@ If not, then the toPart elements are use
</htd:toParts>
</pre><p>
- </p></div><div class="sect3" title="Reassignments"><div class="titlepage"><div><div><h4 class="title"><a id="id3791334"></a><p><a id="reassignment"></a>Reassignments</p></h4></div></div></div><p>Reassignments are used to replace the potential owners of a task when an escalation is triggered. The reassignment element is used to specify reassignment. If present, the element must specify potential owners. In the case where several reassignment escalations are triggered, the first
+ </p></div><div class="sect3" title="Reassignments"><div class="titlepage"><div><div><h4 class="title"><a id="id3840158"></a><p><a id="reassignment"></a>Reassignments</p></h4></div></div></div><p>Reassignments are used to replace the potential owners of a task when an escalation is triggered. The reassignment element is used to specify reassignment. If present, the element must specify potential owners. In the case where several reassignment escalations are triggered, the first
reassignment (lexical order) will be considered for execution. The task is set to state
Ready after reassignment.
@@ -356,7 +361,7 @@ Ready after reassignment.
</htd:reassignment>
</pre><p>
- </p></div></div></div><div class="sect1" title="Delegation"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3791357"></a>Delegation</h2></div></div></div><p>Delegation element is used to specify constraints concerning delegation of the task. Attribute potentialDelegatees defines to whom the task may be delegated. The fallowing values are allowded:
+ </p></div></div></div><div class="sect1" title="Delegation"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3840182"></a>Delegation</h2></div></div></div><p>Delegation element is used to specify constraints concerning delegation of the task. Attribute potentialDelegatees defines to whom the task may be delegated. The fallowing values are allowded:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
anybody - It is allowed to delegate the task to anybody
@@ -392,7 +397,7 @@ Ready after reassignment.
</pre></div><div class="sect1" title="Comments"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="comments"></a>Comments</h2></div></div></div><p> There are two features connecting with comments. Users can add
comments to task and also view all task comments. The second feature
is additional, it is not in specyfication - history of the task could
- be write as comments. This section describes this two features</p><div class="sect2" title="Comments added by user"><div class="titlepage"><div><div><h3 class="title"><a id="id3791415"></a>Comments added by user</h3></div></div></div><p>User can add and view added comments. There is not oporunity to
+ be write as comments. This section describes this two features</p><div class="sect2" title="Comments added by user"><div class="titlepage"><div><div><h3 class="title"><a id="id3840240"></a>Comments added by user</h3></div></div></div><p>User can add and view added comments. There is not oporunity to
delete comment, thus comments are persistent. Comment consist:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>date and time</p></li><li class="listitem"><p>user name</p></li><li class="listitem"><p> comment</p></li></ul></div><p>
The
<code class="code">comment</code>
@@ -401,7 +406,7 @@ Ready after reassignment.
The
<code class="code"> user name</code>
is set on value using during authorization.
- </p></div><div class="sect2" title="Task history in comments"><div class="titlepage"><div><div><h3 class="title"><a id="id3791448"></a>Task history in comments</h3></div></div></div><p>It is a lile bit more complex. History of task consist
+ </p></div><div class="sect2" title="Task history in comments"><div class="titlepage"><div><div><h3 class="title"><a id="id3840273"></a>Task history in comments</h3></div></div></div><p>It is a lile bit more complex. History of task consist
information about state change and actual owner change. For every
event comment is created. It consists every information like ordinary
comment. Content of the comment describe situation that caused the
@@ -472,9 +477,9 @@ one homogenous list and can handle the t
..........
</htd:task>
- </pre><p>There are two functions connected with rendering:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>get rendering type</p></li><li class="listitem"><p>get rendering</p></li></ul></div><div class="sect3" title="Get rendering type"><div class="titlepage"><div><div><h4 class="title"><a id="id3791560"></a>Get rendering type</h4></div></div></div>
+ </pre><p>There are two functions connected with rendering:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>get rendering type</p></li><li class="listitem"><p>get rendering</p></li></ul></div><div class="sect3" title="Get rendering type"><div class="titlepage"><div><div><h4 class="title"><a id="id3840385"></a>Get rendering type</h4></div></div></div>
Returns list every types of rendering associated with task.
-</div><div class="sect3" title="Get Rendering"><div class="titlepage"><div><div><h4 class="title"><a id="id3791566"></a>Get Rendering</h4></div></div></div>
+</div><div class="sect3" title="Get Rendering"><div class="titlepage"><div><div><h4 class="title"><a id="id3840391"></a>Get Rendering</h4></div></div></div>
Return information abuut rendering with given type. If rendering definition consist XQuery, evaluation is returned.
</div></div><div class="sect1" title="Attachments"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="attachments"></a>Attachments</h2></div></div></div><p>
Arbitrary additional data may be attached to a task. This additional
@@ -501,7 +506,7 @@ Return information abuut rendering with
<code class="code">attachedBy</code>
element indicates who added the attachment. It will be name of user
that invoke the opeartion.
- </p><p> There are four operations to manage attachments:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>addAttachment</p></li><li class="listitem"><p>deleteAttachments</p></li><li class="listitem"><p>getAttachemntInfos</p></li><li class="listitem"><p>getAttchments</p></li></ul></div><div class="sect2" title="addAttachment"><div class="titlepage"><div><div><h3 class="title"><a id="id3791642"></a>addAttachment</h3></div></div></div><p>Example of appriopriate message to create attachment</p><pre class="programlisting">
+ </p><p> There are four operations to manage attachments:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>addAttachment</p></li><li class="listitem"><p>deleteAttachments</p></li><li class="listitem"><p>getAttachemntInfos</p></li><li class="listitem"><p>getAttchments</p></li></ul></div><div class="sect2" title="addAttachment"><div class="titlepage"><div><div><h3 class="title"><a id="id3840467"></a>addAttachment</h3></div></div></div><p>Example of appriopriate message to create attachment</p><pre class="programlisting">
<soapenv:Header />
<soapenv:Body>
@@ -519,9 +524,9 @@ Return information abuut rendering with
and
<code class="code">attachedAt</code>
are set by system.
- </p></div><div class="sect2" title="deleteAttachment"><div class="titlepage"><div><div><h3 class="title"><a id="id3791668"></a>deleteAttachment</h3></div></div></div><p> This operation delete all task attachments that has the same
- name as specified in request.</p></div><div class="sect2" title="getAttachmentInfos"><div class="titlepage"><div><div><h3 class="title"><a id="id3791676"></a>getAttachmentInfos</h3></div></div></div><p> Returns attachment information for all attachments associated
- with the task:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>attached name</p></li><li class="listitem"><p>attached by</p></li><li class="listitem"><p>attached at</p></li><li class="listitem"><p>access type</p></li></ul></div></div><div class="sect2" title="getAttachments"><div class="titlepage"><div><div><h3 class="title"><a id="id3791698"></a>getAttachments</h3></div></div></div><p>Get all attachments of the task with given name. For every
+ </p></div><div class="sect2" title="deleteAttachment"><div class="titlepage"><div><div><h3 class="title"><a id="id3840493"></a>deleteAttachment</h3></div></div></div><p> This operation delete all task attachments that has the same
+ name as specified in request.</p></div><div class="sect2" title="getAttachmentInfos"><div class="titlepage"><div><div><h3 class="title"><a id="id3840501"></a>getAttachmentInfos</h3></div></div></div><p> Returns attachment information for all attachments associated
+ with the task:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>attached name</p></li><li class="listitem"><p>attached by</p></li><li class="listitem"><p>attached at</p></li><li class="listitem"><p>access type</p></li></ul></div></div><div class="sect2" title="getAttachments"><div class="titlepage"><div><div><h3 class="title"><a id="id3840523"></a>getAttachments</h3></div></div></div><p>Get all attachments of the task with given name. For every
attachment is returned attachmentInfo and value of attachement</p></div></div><div class="sect1" title="Task filtering"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="filtering"></a>Task filtering</h2></div></div></div><p>Simple query operations allow to retrieve task data.
There are two similary operations and diffirence beetwen then is only in returned data.
User can specify a few features that describe Task he is finding:
@@ -638,19 +643,19 @@ xs:double(htd:getInput("ClaimApprovalReq
</htd:presentationElements>
-</pre></div></div><div class="chapter" title="Chapter 7. Task operations"><div class="titlepage"><div><div><h2 class="title"><a id="taskOperations"></a>Chapter 7. Task operations</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id3792011">Participant operations</a></span></dt><dt><span class="sect1"><a href="#id3792881">Administrative Operations</a></span></dt><dt><span class="sect1"><a href="#simpleQuery">Simple Query operations</a></span></dt></dl></div><p>A number of applications are involved in the life cycle of a task. These comprise:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>The task list client, i.e. a client capable of displaying information about the task under consideration</p></li><li class="listitem"><p>The requesting application, i.e. any partner that has initiated the task</p></li><li class="listitem"><p>The supporting application, i.e. an appl
ication launched by the task list client
+</pre></div></div><div class="chapter" title="Chapter 7. Task operations"><div class="titlepage"><div><div><h2 class="title"><a id="taskOperations"></a>Chapter 7. Task operations</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id3840836">Participant operations</a></span></dt><dt><span class="sect1"><a href="#id3841706">Administrative Operations</a></span></dt><dt><span class="sect1"><a href="#simpleQuery">Simple Query operations</a></span></dt></dl></div><p>A number of applications are involved in the life cycle of a task. These comprise:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>The task list client, i.e. a client capable of displaying information about the task under consideration</p></li><li class="listitem"><p>The requesting application, i.e. any partner that has initiated the task</p></li><li class="listitem"><p>The supporting application, i.e. an appl
ication launched by the task list client
to support processing of the task. </p></li></ul></div><p>The task infrastructure provides access to a given task. It is important to
understand that what is meant by task list client is the software that presents a UI
to one authenticated user, irrespective of whether this UI is rendered by software
running on server hardware (such as in a portals environment) or client software
(such as a client program running on a users workstation or PC).</p><p>This chapter describe all operations that can be use to interaction with task or to manipulate task.
- If it wass possible, operations related to the same subject were collected in one sections </p><div class="sect1" title="Participant operations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3792011"></a>Participant operations</h2></div></div></div><p>Operations are executed by end users, i.e. actual or potential owners. The identity of
+ If it wass possible, operations related to the same subject were collected in one sections </p><div class="sect1" title="Participant operations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3840836"></a>Participant operations</h2></div></div></div><p>Operations are executed by end users, i.e. actual or potential owners. The identity of
the user is implicitly passed when invoking any of the operations listed in the table
below. The participant operations listed below only apply to tasks unless explicitly
noted otherwise. The authorization entity indicates people of which roles are
authorized to perform the operation. Stakeholders of the task are not mentioned
explicitly. They have the same authorization rights as business administrators.
- </p><div class="sect1" title="Operations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3792039"></a>Operations</h2></div></div></div><div class="table"><a id="id3792043"></a><p class="title"><b>Table 7.1. Participant operations</b></p><div class="table-contents"><table summary="Participant operations" border="1"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Operation name</th><th>Desription</th><th>Parameters</th><th>Authorization</th></tr></thead><tbody><tr><td>
+ </p><div class="sect1" title="Operations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3840864"></a>Operations</h2></div></div></div><div class="table"><a id="id3840868"></a><p class="title"><b>Table 7.1. Participant operations</b></p><div class="table-contents"><table summary="Participant operations" border="1"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Operation name</th><th>Desription</th><th>Parameters</th><th>Authorization</th></tr></thead><tbody><tr><td>
<div class="literallayout"><p><br />
addAttachment<br />
<a class="link" href="#attachments" title="Attachments">details</a><br />
@@ -869,8 +874,8 @@ explicitly. They have the same authoriza
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">task identifier</li></ul></div>
Out
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">fault name</li><li class="listitem">fault data</li></ul></div>
- </td><td>sd</td></tr></tbody></table></div></div><br class="table-break" /></div></div><div class="sect1" title="Administrative Operations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3792881"></a>Administrative Operations</h2></div></div></div><p>Collection of operations that can be performed only by business
- administrators. These operations support task management.</p><div class="table"><a id="id3792888"></a><p class="title"><b>Table 7.2. Administrative Operations</b></p><div class="table-contents"><table summary="Administrative Operations" border="1"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Operation name</th><th>Desription</th><th>Parameters</th><th>Authorization</th></tr></thead><tbody><tr><td><div class="literallayout"><p>activate</p></div></td><td>Activates the task. Lets move from state CREATE to READY
+ </td><td>sd</td></tr></tbody></table></div></div><br class="table-break" /></div></div><div class="sect1" title="Administrative Operations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id3841706"></a>Administrative Operations</h2></div></div></div><p>Collection of operations that can be performed only by business
+ administrators. These operations support task management.</p><div class="table"><a id="id3841713"></a><p class="title"><b>Table 7.2. Administrative Operations</b></p><div class="table-contents"><table summary="Administrative Operations" border="1"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Operation name</th><th>Desription</th><th>Parameters</th><th>Authorization</th></tr></thead><tbody><tr><td><div class="literallayout"><p>activate</p></div></td><td>Activates the task. Lets move from state CREATE to READY
or RESERVED. Type of transition depends on the number of Potential owners.
If there is only one then is set state RESERVED and the Potential owners
becomes Actual owner.
@@ -900,7 +905,7 @@ explicitly. They have the same authoriza
Simple query operations allow to retrieve task data. To see deatails
go to
<a class="link" href="#filtering" title="Task filtering">filtering</a>
- </p><div class="table"><a id="id3793013"></a><p class="title"><b>Table 7.3. Simple Query operations</b></p><div class="table-contents"><table summary="Simple Query operations" border="1"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Operation name</th><th>Desription</th><th>Parameters</th><th>Authorization</th></tr></thead><tbody><tr><td>getMyTaskAbtracts</td><td>Retrieve the task abstracts. This operation is used to
+ </p><div class="table"><a id="id3841838"></a><p class="title"><b>Table 7.3. Simple Query operations</b></p><div class="table-contents"><table summary="Simple Query operations" border="1"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th>Operation name</th><th>Desription</th><th>Parameters</th><th>Authorization</th></tr></thead><tbody><tr><td>getMyTaskAbtracts</td><td>Retrieve the task abstracts. This operation is used to
obtain the data required to display a task list.</td><td>
In
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">generic human rule</li><li class="listitem">status list</li><li class="listitem">where clause</li><li class="listitem">createdOn clause</li><li class="listitem">maxTasks</li></ul></div>
@@ -912,7 +917,7 @@ explicitly. They have the same authoriza
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">generic human rule</li><li class="listitem">status list</li><li class="listitem">where clause</li><li class="listitem">createdOn clause</li><li class="listitem">maxTasks</li></ul></div>
Out
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">list of tasks</li></ul></div>
- </td><td>any</td></tr></tbody></table></div></div><br class="table-break" /></div></div><div class="chapter" title="Chapter 8. Notifications"><div class="titlepage"><div><div><h2 class="title"><a id="id3793103"></a>Chapter 8. Notifications</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id3793108"></a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3793141">Notification properties</a></span></dt></dl></dd></dl></div><div class="sect1"><div class="titlepage"></div><p>Notification are used to notify a person or a group of people of diffrent business event or actions on the tasks. Inter alia are used in escalation action to notify a user that a task is overdue or a task has not been started yet.
+ </td><td>any</td></tr></tbody></table></div></div><br class="table-break" /></div></div><div class="chapter" title="Chapter 8. Notifications"><div class="titlepage"><div><div><h2 class="title"><a id="id3841928"></a>Chapter 8. Notifications</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id3841933"></a></span></dt><dd><dl><dt><span class="sect2"><a href="#id3841966">Notification properties</a></span></dt></dl></dd></dl></div><div class="sect1"><div class="titlepage"></div><p>Notification are used to notify a person or a group of people of diffrent business event or actions on the tasks. Inter alia are used in escalation action to notify a user that a task is overdue or a task has not been started yet.
</p><p>Notifications are simple human interactions that do not block the progress of the
caller, that is the caller does not wait for the notification to be completed. The notification appears on the task list of all notification recipients. Notifications may have multiple recipients and business administators. The generic human roles task initiator, task stakeholders, potential
owners, actual owner and excluded owners play no role. Notifications do not have ad-hoc attachments, comments or deadlines.
@@ -943,7 +948,7 @@ owners, actual owner and excluded owners
</htd:renderings>
</htd:notification>
- </pre><div class="sect2" title="Notification properties"><div class="titlepage"><div><div><h3 class="title"><a id="id3793141"></a>Notification properties</h3></div></div></div><p>Notification properties are a subset of task properties and task features. Functionality of these elements is identical to their counterparts defined for the task. If you want to know their definitions read in chapter Task properties and Task features. </p><p>The following attributes and elements are defined for notifications:
+ </pre><div class="sect2" title="Notification properties"><div class="titlepage"><div><div><h3 class="title"><a id="id3841966"></a>Notification properties</h3></div></div></div><p>Notification properties are a subset of task properties and task features. Functionality of these elements is identical to their counterparts defined for the task. If you want to know their definitions read in chapter Task properties and Task features. </p><p>The following attributes and elements are defined for notifications:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><a class="link" href="#task_name">name</a></li><li class="listitem"><a class="link" href="#task_priority">priority</a></li><li class="listitem"><a class="link" href="#task_peopleAssignments">peopleAssignments</a></li><li class="listitem"><a class="link" href="#presentationElements" title="Presentation elements">presentationElements</a></li><li class="listitem"><a class="link" href="#rendering" title="Rendering">rendering</a></li></ul></div><p>
</p></div></div></div><div class="chapter" title="Chapter 9. Examples"><div class="titlepage"><div><div><h2 class="title"><a id="examples"></a>Chapter 9. Examples</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#taskInfoExample">Task info example</a></span></dt></dl></div><div class="sect1" title="Task info example"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="taskInfoExample"></a>Task info example</h2></div></div></div><p> This is response for request getTaskInfo</p><pre class="programlisting">
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">