incubator-hise-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r.@apache.org
Subject svn commit: r982656 - /incubator/hise/trunk/hise-docs/src/main/resources/
Date Thu, 05 Aug 2010 15:16:41 GMT
Author: rr
Date: Thu Aug  5 15:16:39 2010
New Revision: 982656

URL: http://svn.apache.org/viewvc?rev=982656&view=rev
Log:
HISE-65: documentation (thanks to Paweł Byszewski)

Added:
    incubator/hise/trunk/hise-docs/src/main/resources/all_rest_participant_operations.xml
    incubator/hise/trunk/hise-docs/src/main/resources/attachments.xml
    incubator/hise/trunk/hise-docs/src/main/resources/comments.xml
    incubator/hise/trunk/hise-docs/src/main/resources/filtering.xml
    incubator/hise/trunk/hise-docs/src/main/resources/intro.xml
    incubator/hise/trunk/hise-docs/src/main/resources/participant_operations.xml
    incubator/hise/trunk/hise-docs/src/main/resources/rendering.xml
    incubator/hise/trunk/hise-docs/src/main/resources/simpleQuery.xml
    incubator/hise/trunk/hise-docs/src/main/resources/states.png   (with props)
    incubator/hise/trunk/hise-docs/src/main/resources/states.xml
    incubator/hise/trunk/hise-docs/src/main/resources/taskInfoExample.xml
    incubator/hise/trunk/hise-docs/src/main/resources/taskInstanceData.xml
Modified:
    incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml

Added: incubator/hise/trunk/hise-docs/src/main/resources/all_rest_participant_operations.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/all_rest_participant_operations.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/all_rest_participant_operations.xml
(added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/all_rest_participant_operations.xml
Thu Aug  5 15:16:39 2010
@@ -0,0 +1,7 @@
+<sect2>
+<title>All rest operations</title>
+This section describe operations that can not be together to some grups.
+
+
+
+</sect2>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/attachments.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/attachments.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/attachments.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/attachments.xml Thu Aug  5 15:16:39
2010
@@ -0,0 +1,89 @@
+<sect1 id="attachments">
+<title>Attachments</title>
+			<para>
+				Arbitrary additional data may be attached to a task. This additional
+				data is referred to as task ad-hoc attachments. An ad-hoc attachment
+				is specified by its name, its content. The
+				<code>name</code>
+				element is used to specify attachment name. Several attachments may
+				have the same name and can then be retrieved as a collection.
+			</para>
+			<note>
+				The
+				<code>accesType</code>
+				is assumed to be inline. Thus this proprty MUST contains the string
+				constant
+				<code>inline</code>
+				.
+			</note>
+			<para> The attachment can be any valid XML. Moreover the attachment
+				attachment data is assumed to be of that type and if it is not, the
+				attachment is set on empty.</para>
+			<para>
+				The
+				<code>attachedAt</code>
+				element indicates when the attachment is added.
+			</para>
+			<para>
+				The
+				<code>attachedBy</code>
+				element indicates who added the attachment. It will be name of user
+				that invoke the opeartion.
+			</para>
+			<para> There are four operations to manage attachments.</para>
+			<itemizedlist>
+				<listitem><para>addAttachment</para></listitem>
+				<listitem><para>deleteAttachments</para></listitem>
+				<listitem><para>getAttachemntInfos</para></listitem>
+				<listitem><para>getAttchments</para></listitem>
+			</itemizedlist>
+			<sect2>
+				<title>addAttachment</title>
+				<para>Example of appriopriate message to create attachment</para>
+				<programlisting>
+				<![CDATA[
+ 				   	<soapenv:Header />
+   					<soapenv:Body>
+     					 <xsd:addAttachment>
+        				 <xsd:identifier>54</xsd:identifier>
+         				 <xsd:name>attachment1</xsd:name>
+        				 <xsd:accessType>xsd:any</xsd:accessType>
+         				 <xsd:attachment><abc><a>test</a></abc></xsd:attachment>
+      					 </xsd:addAttachment>
+   					</soapenv:Body>
+				]]>
+			</programlisting>
+				<para>
+					Properties
+					<code>attachedBy</code>
+					and
+					<code>attachedAt</code>
+					are set by system.
+				</para>
+			</sect2>
+			<sect2>
+				<title>deleteAttachment</title>
+				<para> This operation delete all task attachments that has the same
+					name as specified in request.</para>
+			</sect2>
+			<sect2>
+				<title>getAttachmentInfos</title>
+				<para> Returns attachment information for all attachments assotiadet
+					with the task:</para>
+				<itemizedlist>
+					<listitem><para>attached name</para></listitem>
+					<listitem><para>attached by</para></listitem>
+					<listitem><para>attached at</para></listitem>
+					<listitem><para>access type</para></listitem>
+				</itemizedlist>
+			</sect2>
+			<sect2>
+				<title>getAttachments</title>
+				<para>Get all attachments of thetask with given name. For every
+					attachment is returned attachmentInfo(see section
+					getAttachmentInfos) and value of attachement</para>
+			</sect2>
+			
+			
+			
+</sect1>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/comments.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/comments.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/comments.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/comments.xml Thu Aug  5 15:16:39 2010
@@ -0,0 +1,72 @@
+<sect1 id="comments">
+<title>Comments</title>
+			<para> 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</para>
+			<sect2>
+				<title>Comments added by user</title>
+				<para>User can add and view added comments. There is not oporunity to delete comment,
thus comments are persistent.
+					Comment consist: </para>
+					<itemizedlist>
+						<listitem><para>date and time</para></listitem>
+						<listitem><para>user name</para></listitem>
+						<listitem><para>comment</para></listitem>
+					</itemizedlist>
+					<para>The <code>comment</code> is assumed to be text.</para>
+					<para>The <code> user name</code> is set on value using during authorization.
</para>
+					
+			</sect2>
+			<sect2>
+			<title>Task history in comments</title>
+			<para>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 has consist every information like ordinary comment.
Content of teh comment
+				describe situation that caused the comment creation. Default this feature is off. </para>
+			<para>Usually <code> user name</code> is set on value using during authorization.
The first exception is request <code>approve</code>, 
+			then users name is set on value of field <code>initiator</code> from request.
The second exception is connected with deadLines.
+			Sometimes as a result of cross deadline may be initialize change actual owner or change
task state. Then the field <code>attachedBy</code>
+			has value <code>Deadline crossed</code>
+			</para>
+			<para>
+			Task history suppor internalization. User can chose language of comments that describe
task history. Default language is english.
+			If you want to change it, have to specified language for every task.	
+			</para>
+			<para>Example of settings active task history comments in polish language....</para>
+			
+			<programlisting>
+			<![CDATA[
+			<htd:task name="exampleName">
+				..........
+				
+			<htd:savingTaskHistory lang="PL">
+          			<htd:active>true</htd:active>
+          		</htd:savingTaskHistory> 
+				
+				..........
+			</htd:task>
+			]]>
+			</programlisting>
+			<para>and in english</para>
+						<programlisting>
+			<![CDATA[
+			<htd:task name="exampleName">
+				..........
+				
+			<htd:savingTaskHistory>
+          			<htd:active>true</htd:active>
+          		</htd:savingTaskHistory> 
+				
+				..........
+			</htd:task>
+			]]>
+			</programlisting>
+
+			
+
+			
+			
+			
+			
+			</sect2>
+		
+</sect1>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/filtering.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/filtering.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/filtering.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/filtering.xml Thu Aug  5 15:16:39 2010
@@ -0,0 +1,50 @@
+<sect1 id="filtering">
+<title>Task filtering</title>
+<para>Simple query operations allow to retrieve task data. 
+There are two similary operations and diffirence beetwen then is only in return data.
+User can specify a few features that describe Task he is finding:
+<itemizedlist>
+	<listitem><para>generic human role</para></listitem>
+	<listitem><para>status list</para></listitem>
+	<listitem><para>createdOn - it specified date of creating task. I must be use
with following operators
+	equals (“=”), not equals
+(“&lt;&gt;”), less than (“&lt;”),
+greater than (“&gt;”), less
+than or equals (“&lt;=”),
+and greater than or
+equals (“&gt;=”) <link linkend="simpleQueryExample">see example</link>
+	
+	
+	
+	</para></listitem>
+	<listitem><para>
+	where clause - is logically ANDed with the rest condition, it 
+may only reference one Task Column.CreatedOn
+with operators as
+described above.<link linkend="simpleQueryExample">see example</link>
+
+	
+	</para></listitem>
+	<listitem><para>maxTask - If maxTasks is specified,
+then the number of task
+abstracts returned for this
+query will not exceed this
+limit.
+	</para></listitem>
+	
+</itemizedlist>
+
+<para id="simpleQueryExample">
+			<programlisting>
+				&lt;xsd:genericHumanRole&gt;ACTUALOWNER&lt;/xsd:genericHumanRole&gt;
+				&lt;xsd:status&gt;READY&lt;/xsd:status&gt;
+				&lt;xsd:status&gt;OBSOLETE&lt;/xsd:status&gt;        
+				&lt;xsd:createdOnClause&gt;&lt;![CDATA[&lt;&gt;02-08-2010 17:16]]&gt;&lt;/xsd:createdOnClause&gt;
+				&lt;xsd:whereClause&gt;&lt;![CDATA[priority&lt;=5]]&gt;&lt;/xsd:whereClause&gt;
+				 &lt;xsd:maxTasks&gt;30&lt;/xsd:maxTasks&gt;
+			
+			</programlisting>
+</para>
+
+</para>
+</sect1>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/intro.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/intro.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/intro.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/intro.xml Thu Aug  5 15:16:39 2010
@@ -0,0 +1,20 @@
+<para>
+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
+humans in service-oriented applications. A human task has two interfaces. One
+interface exposes the service offered by the task, like a translation service or an
+approval service. The second interface allows people to deal with tasks, for example
+to query for human tasks waiting for them, and to work on these tasks.
+A human task has people assigned to it. These assignments define who should be
+allowed to play a certain role on that task. Human tasks may also specify how task
+metadata should be rendered on different devices or applications making them
+portable and interoperable with different types of software. Human tasks can be
+defined to react on timeouts, triggering an apropriate escalation action.
+This also holds true for notifications. Notifications are a special type of human task
+that allows the sending of information about noteworthy business events to people.
+Notifications are always oneway, i.e., they are delivered in a fire-and-forget manner:
+The sender pushes out notifications to people without waiting for these people to
+acknowledge their receipt.
+
+</para>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/participant_operations.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/participant_operations.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/participant_operations.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/participant_operations.xml Thu Aug 
5 15:16:39 2010
@@ -0,0 +1,389 @@
+<sect1>
+	<title>Operations</title>
+	<table
+		frame="all"
+	>
+		<title>Participant operations</title>
+		<tgroup
+			cols="4"
+		>
+			<thead>
+				<row>
+					<entry>Operation name</entry>
+					<entry>Desription</entry>
+					<entry>Parameters</entry>
+					<entry>Authorization</entry>
+				</row>
+			</thead>
+			<tbody>
+				<row>
+					<entry>claim</entry>
+				</row>
+				<row>
+					<entry>
+						<literallayout>
+							addAttachment
+							<link
+								linkend="attachments"
+							>details</link>
+						</literallayout>
+					</entry>
+					<entry>Add attachment to a task.</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+							<listitem>attachment name</listitem>
+							<listitem>access type</listitem>
+							<listitem>attachment</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Actual Owner, Business Administrator</entry>
+				</row>
+				<row>
+					<entry>
+						getAttachmentInfos
+						<link
+							linkend="attachments"
+						>details</link>
+					</entry>
+					<entry>Get attachemnt information for all attachments associated
+						with the task</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>list of attachment data</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Potetnial Owners, Actual Owner, Business Administrator
+					</entry>
+				</row>
+				<row>
+					<entry>
+						getAttachments
+						<link
+							linkend="attachments"
+						>details</link>
+					</entry>
+					<entry>Get all attachments of a task with given name</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+							<listitem>attachment name</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>list of attachments</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Potetnial Owners, Actual Owner, Business Administrator
+					</entry>
+				</row>
+				<row>
+					<entry>
+						deleteAttachments
+						<link
+							linkend="attachments"
+						>details</link>
+					</entry>
+					<entry>Delete attachments with the specified name from the task(if
+						multiple attachemnets with that name exist , all are deleted)
+					</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+							<listitem>attachment name</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Potetnial Owners, Actual Owner, Business Administrator
+					</entry>
+				</row>
+				<row>
+					<entry>
+						addComment
+						<link
+							linkend="comments"
+						>details</link>
+					</entry>
+					<entry>Add comment to a task</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+							<listitem>plain text</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Potetnial Owners, Actual Owner, Business Administrator
+					</entry>
+				</row>
+				<row>
+					<entry>
+						getComments
+						<link
+							linkend="comments"
+						>details</link>
+					</entry>
+					<entry>Get all comments of a task</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task indentifier</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>list of comments</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Potetnial Owners, Actual Owner, Business Administrator
+					</entry>
+				</row>
+				<row>
+					<entry>
+						geRendering
+						<link
+							linkend="rendering"
+						>details</link>
+					</entry>
+					<entry>Returns the rendering specified by the type parameter.
+					</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+							<listitem>rendering type</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>any type</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>any</entry>
+				</row>
+				<row>
+					<entry>
+						getRenderingTypes
+						<link
+							linkend="rendering"
+						>details</link>
+					</entry>
+					<entry>Returns the rendering types available for the task.</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>list of QNames</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>name</entry>
+				</row>
+				<row>
+					<entry>claim</entry>
+					<entry>Claim responsibility for a task, i.e. set the task to status
+						Reserved</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+						</itemizedlist>
+						out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Potetnial Owners, Actual Owner, Business Administrator
+					</entry>
+				</row>
+				<row>
+					<entry>start</entry>
+					<entry>Start the execution of the task, i.e. set the task to status
+						InProgress.</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Actual Owner, Potential Owners(only i state Ready)</entry>
+				</row>
+				<row>
+					<entry>stop</entry>
+					<entry> Cancel/stop the processing of the task. The task returns to
+						the Reserved state.</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+						</itemizedlist>
+						out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Actual Owner, Business Administrators</entry>
+				</row>
+				<row>
+					<entry>release</entry>
+					<entry>Release the task, i.e. set the task back to status Ready.
+					</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Actual Owner, Business Administrators</entry>
+				</row>
+				<row>
+					<entry>suspend</entry>
+					<entry>Suspend the task</entry>
+					<entry>
+						in
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Potential Owners(only in state Ready), Actual Owner,
+						Business Administrator</entry>
+				</row>
+				<row>
+					<entry>suspendUntil</entry>
+					<entry>Suspend the task for a given period of time or until a fixed
+						point in time. The caller has to specify either a period of time
+						or a fixed point in time</entry>
+					<entry>
+						in
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+							<listitem>time period</listitem>
+							<listitem>point of time</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Potential Owners(only in state Ready), Actual Owner,
+						Business Administrator</entry>
+				</row>
+				<row>
+					<entry>resume</entry>
+					<entry>Resume a suspended task.</entry>
+					<entry>
+						in
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Potential Owners(only in state Ready), Actual Owner,
+						Business Administrator</entry>
+				</row>
+				<row>
+					<entry>complete</entry>
+					<entry>Execution of the task finished successfully.</entry>
+					<entry>
+						in
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+							<listitem>output data of task</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Actual Owner</entry>
+				</row>
+				<row>
+					<entry>remove</entry>
+					<entry>Applies to notification only. Used by notification
+						recipients to remove the notification permanently from their task
+						list client. It will not be returned on any subsequent retrieval
+						operation invoked by the same user</entry>
+					<entry>
+						in
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Notification Recipient</entry>
+				</row>
+				<row>
+					<entry>fail</entry>
+					<entry>ActualOwner completes the execution of the task raising a
+						fault.</entry>
+					<entry>
+						in
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+							<listitem>fault name</listitem>
+							<listitem>fault data</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>Actual Owner</entry>
+				</row>
+				<row>
+					<entry>set Priority</entry>
+					<entry>Change the priority of the task. The caller has to specify
+						the integer value of the new priority</entry>
+					<entry>
+						in
+						<itemizedlist>
+							<listitem>task identifier</listitem>
+							<listitem>priority</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>void</listitem>
+						</itemizedlist>
+					</entry>
+					<entry> Actual Owner, Business Administrator</entry>
+				</row>
+			</tbody>
+		</tgroup>
+	</table>
+</sect1>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/rendering.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/rendering.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/rendering.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/rendering.xml Thu Aug  5 15:16:39 2010
@@ -0,0 +1,51 @@
+<sect1 id="rendering">
+<title>Rendering</title>
+<para>It is assumed that a single task instance can be rendered by different task list
clients
+so the task engine does not depend on a single dedicated task list client. Similarly it
+is assumed that one task list client can present tasks from several task engines in
+one homogenous list and can handle the tasks in a consistent manner.
+</para>
+<para>There isn,t oportunity to set one rendering for every task, each of task must
have own definition of rendering </para>
+
+<para>The definition of rendering must contain type(name), and content. Connten is
assumed to be XQuery or string.</para>
+
+<para>Example of definition rendering:</para>
+			
+			<programlisting>
+			<![CDATA[
+			<htd:task name="exampleName">
+				..........
+				
+		                <htd:rendering type="NSW/GWT">
+                <expression>
+                    <![CDATA[
+                   
+                        declare namespace htd="http://www.example.org/WS-HT"; 
+                                      
+                        <example name="anyname" xmlns:cla="http://www.insurance.example.com/claims">
+                            <param name="type" value="{htd:getInput("ClaimApprovalRequest")/cla:cust/cla:firstname/text()}"/>
+                        </example>
+            
+                    
+                    </expression>
+                </htd:rendering>
+				..........
+			</htd:task>
+			]]>
+			</programlisting>
+<para>There are to functions connected with rendering:</para>
+<itemizedlist>
+<listitem><para>get rendering type</para></listitem>
+<listitem><apara>get rendering</apara></listitem>
+</itemizedlist>
+
+<sect3>
+<title>Get rendering type</title>
+Returns list every types of rendering associated with task.
+</sect3>
+<sect3>
+<title>Get Rendering</title>
+Return information abuut rendering with given type. If rendering definition consist XQuery,
evaluation is returned.
+</sect3>
+
+</sect1>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/simpleQuery.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/simpleQuery.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/simpleQuery.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/simpleQuery.xml Thu Aug  5 15:16:39
2010
@@ -0,0 +1,71 @@
+<sect1
+	id="simpleQuery"
+>
+	<title>Simple Query operations</title>
+	<para>
+		Simple query operations allow to retrieve task data. To see deatails
+		go to
+		<link
+			linkend="filtering"
+		>filtering</link>
+	</para>
+	<table
+		frame="all"
+	>
+		<title>Simple Query operations</title>
+		<tgroup
+			cols="4"
+		>
+			<thead>
+				<row>
+					<entry>Operation name</entry>
+					<entry>Desription</entry>
+					<entry>Parameters</entry>
+					<entry>Authorization</entry>
+				</row>
+			</thead>
+			<tbody>
+				<row>
+					<entry>getMyTaskAbtracts</entry>
+					<entry>Retrieve the task abstracts. This operation is used to
+						obtain the data required to display a task list.</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>generic human rule</listitem>
+							<listitem>status list</listitem>
+							<listitem>where clause</listitem>
+							<listitem>createdOn clause</listitem>
+							<listitem>maxTasks</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>list of tasks abstracts</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>any</entry>
+				</row>
+				<row>
+					<entry>getMyTasks</entry>
+					<entry>Retrieve the task abstracts. This operation is used to
+						obtain the data required to display a task list.</entry>
+					<entry>
+						In
+						<itemizedlist>
+							<listitem>generic human rule</listitem>
+							<listitem>status list</listitem>
+							<listitem>where clause</listitem>
+							<listitem>createdOn clause</listitem>
+							<listitem>maxTasks</listitem>
+						</itemizedlist>
+						Out
+						<itemizedlist>
+							<listitem>list of tasks</listitem>
+						</itemizedlist>
+					</entry>
+					<entry>any</entry>
+				</row>
+			</tbody>
+		</tgroup>
+	</table>
+</sect1>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/states.png
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/states.png?rev=982656&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/hise/trunk/hise-docs/src/main/resources/states.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: incubator/hise/trunk/hise-docs/src/main/resources/states.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/states.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/states.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/states.xml Thu Aug  5 15:16:39 2010
@@ -0,0 +1,12 @@
+<sect1 id="states">
+<title>Task finite state machine</title>
+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 <link linkend="taskOperations">task Operations</link> to see more details
about functions from the graph.
+
+    <figure>
+       <title>State transitions</title>
+       <graphic fileref="states.png"></graphic>
+    </figure>
+
+</sect1>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/taskInfoExample.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/taskInfoExample.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/taskInfoExample.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/taskInfoExample.xml Thu Aug  5 15:16:39
2010
@@ -0,0 +1,44 @@
+<sect1 id="taskInfoExample">
+<title>Task info example</title> 
+<para> This is response for request getTaskInfo</para>
+<programlisting>
+&lt;soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"&gt;
+   &lt;soap:Body&gt;
+      &lt;getTaskInfoResponse xmlns="http://www.example.org/WS-HT/api/xsd" xmlns:ns2="http://www.example.org/WS-HT"
xmlns:ns3="http://www.example.org/WS-HT/api"&gt;
+         &lt;task&gt;
+            &lt;ns3:id&gt;3477&lt;/ns3:id&gt;
+            &lt;ns3:taskType&gt;TASK&lt;/ns3:taskType&gt;
+            &lt;ns3:name xmlns:ns4="http://www.insurance.example.com/claims"&gt;ns4:Task1&lt;/ns3:name&gt;
+            &lt;ns3:status&gt;IN_PROGRESS&lt;/ns3:status&gt;
+            &lt;ns3:priority&gt;0&lt;/ns3:priority&gt;
+            &lt;ns3:taskStakeholders&gt;
+               &lt;ns2:users&gt;
+                  &lt;ns2:user&gt;user3&lt;/ns2:user&gt;
+               &lt;/ns2:users&gt;
+            &lt;/ns3:taskStakeholders&gt;
+            &lt;ns3:potentialOwners&gt;
+               &lt;ns2:users&gt;
+                  &lt;ns2:user&gt;user1&lt;/ns2:user&gt;
+               &lt;/ns2:users&gt;
+            &lt;/ns3:potentialOwners&gt;
+            &lt;ns3:businessAdministrators&gt;
+               &lt;ns2:users&gt;
+                  &lt;ns2:user&gt;user1&lt;/ns2:user&gt;
+                  &lt;ns2:user&gt;user2&lt;/ns2:user&gt;
+               &lt;/ns2:users&gt;
+            &lt;/ns3:businessAdministrators&gt;
+            &lt;ns3:actualOwner&gt;user1&lt;/ns3:actualOwner&gt;
+            &lt;ns3:createdOn&gt;2010-08-05T16:15:09.253+02:00&lt;/ns3:createdOn&gt;
+            &lt;ns3:createdBy&gt;soapui&lt;/ns3:createdBy&gt;
+            &lt;ns3:activationTime&gt;2010-08-05T16:15:09.253+02:00&lt;/ns3:activationTime&gt;
+            &lt;ns3:isSkipable&gt;true&lt;/ns3:isSkipable&gt;
+            &lt;ns3:presentationName&gt;Approve Claim&lt;/ns3:presentationName&gt;
+            &lt;ns3:presentationSubject&gt;Approve the insurance claim for PLN 1234
on behalf of EdmundZorn&lt;/ns3:presentationSubject&gt;
+            &lt;ns3:renderingMethodExists&gt;false&lt;/ns3:renderingMethodExists&gt;
+         &lt;/task&gt;
+      &lt;/getTaskInfoResponse&gt;
+   &lt;/soap:Body&gt;
+&lt;/soap:Envelope&gt;
+
+</programlisting>
+</sect1>
\ No newline at end of file

Added: incubator/hise/trunk/hise-docs/src/main/resources/taskInstanceData.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/taskInstanceData.xml?rev=982656&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/taskInstanceData.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/taskInstanceData.xml Thu Aug  5 15:16:39
2010
@@ -0,0 +1,67 @@
+<sect1
+	id="taskInstanceData"
+>
+	<title>Task instance data</title>
+	Task instance data falls into three categories:
+	<itemizedlist>
+		<listitem>
+			<para>Presentation data – The data is derived from the task
+				definition or the notification definition such as the name, subject
+				or description.</para>
+		</listitem>
+		<listitem>
+			<para> Context data - A set of dynamic properties, such as priority,
+				task state, time stamps and values for all generic human roles.
+			</para>
+		</listitem>
+		<listitem>
+			<para> Operational data – The data includes the input message, output
+				message, attachments and comments.</para>
+		</listitem>
+	</itemizedlist>
+	<sect2>
+		<title>Presentation parameters</title>
+		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
+		<link
+			linkend="presentationElements"
+		>Presentation Elements</link>
+		for more details.
+	</sect2>
+	<sect2>
+		<title>Context Data</title>
+		The task context includes a lot of things, for example:
+		<itemizedlist>
+			<listitem>
+				<para>task state</para>
+			</listitem>
+			<listitem>
+				<para>priority</para>
+			</listitem>
+			<listitem>
+				<para> Values for all generic human roles, i.e. potential owners,
+					actual owner and business administrators</para>
+			</listitem>
+			<listitem>
+				<para>Time stamps such as start time, completion time</para>
+			</listitem>
+			<listitem>
+				<para>Skipable indicator</para>
+			</listitem>
+			<listitem>
+				<para>task history language and indicator</para>
+			</listitem>
+		</itemizedlist>
+		For whole list of information go to
+		<link
+			linkend="taskInfoExample"
+		>task info example</link>
+	</sect2>
+	<sect2>
+		<title>Operational data</title>
+		<para>The operational data of a task consists of its input data and
+			output data or fault data. Operational data is accessed using the
+			XPath extension functions and programming interface.</para>
+	</sect2>
+</sect1>
\ No newline at end of file

Modified: incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml?rev=982656&r1=982655&r2=982656&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml Thu Aug  5 15:16:39 2010
@@ -1,5 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<book version="5.0" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg" xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook file:/usr/share/schemas/docbook.xsd">
+
+<!DOCTYPE book [
+
+<!ENTITY attachments SYSTEM "attachments.xml">
+<!ENTITY comments SYSTEM "comments.xml">
+<!ENTITY rendering SYSTEM "rendering.xml">
+<!ENTITY participant_operations SYSTEM "participant_operations.xml">
+<!ENTITY all_rest_participant_operations SYSTEM "all_rest_participant_operations.xml">
+<!ENTITY filtering SYSTEM "filtering.xml">
+<!ENTITY simpleQuery SYSTEM "simpleQuery.xml">
+<!ENTITY taskInstanceData SYSTEM "taskInstanceData.xml">
+<!ENTITY intro SYSTEM "intro.xml">
+<!ENTITY states SYSTEM "states.xml">
+<!ENTITY taskInfoExample SYSTEM "taskInfoExample.xml">
+
+]>
+
+<book version="5.0" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"

+xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:svg="http://www.w3.org/2000/svg" 
+xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:html="http://www.w3.org/1999/xhtml" 
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+xsi:schemaLocation="http://docbook.org/ns/docbook file:/usr/share/schemas/docbook.xsd">
   <info>
     <title>Apache HISE User Guide</title>
     <releaseinfo>${project.version}</releaseinfo>
@@ -148,4 +169,58 @@
       Detailed information on endpoint addresses is defined in claimsHandling-hise-dd.xml
file.
     </para>
   </chapter>
+  <chapter>
+  <title>Concepts</title>
+  &intro;
+  &taskInstanceData;
+  </chapter>
+  <chapter id="task_features">
+  <title>Task features</title>
+    &states;
+    &comments;
+	&rendering;
+	&attachments;
+	&filtering;
+  </chapter>
+  <chapter id="taskOperations">
+  <title>Task operations</title>
+  <para>A number of applications are involved in the life cycle of a task. These comprise:</para>
+  <itemizedlist>
+     <listitem><para>The task list client, i.e. a client capable of displaying
information about the task under consideration</para></listitem>
+     <listitem><para>The requesting application, i.e. any partner that has initiated
the task</para></listitem>
+     <listitem><para>The supporting application, i.e. an application launched
by the task list client
+        to support processing of the task. </para></listitem>
+  </itemizedlist>
+ <para>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).</para>
+ 
+ <para>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
</para>
+  
+  <sect1>
+  <title>Participant operations</title>
+  <para>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.
+  </para>
+	&participant_operations;
+
+	
+	
+  </sect1>
+	&simpleQuery;
+  &all_rest_participant_operations;
+  </chapter>
+  <chapter id="examples">
+ <title>Examples</title>
+ &taskInfoExample; 
+  </chapter>
+ 
+
 </book>



Mime
View raw message