You are viewing a plain text version of this content. The canonical link for it is here.
Posted to hise-commits@incubator.apache.org by rr...@apache.org on 2010/08/06 13:02:08 UTC
svn commit: r982944 - in /incubator/hise/trunk/hise-docs/src/main/resources:
attachments.xml comments.xml filtering.xml participant_operations.xml
rendering.xml taskInstanceData.xml user-guide.xml
Author: rr
Date: Fri Aug 6 13:02:08 2010
New Revision: 982944
URL: http://svn.apache.org/viewvc?rev=982944&view=rev
Log:
HISE-65: Documentation part 2 (Thanks to Paweł Byszewski)
Modified:
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/participant_operations.xml
incubator/hise/trunk/hise-docs/src/main/resources/rendering.xml
incubator/hise/trunk/hise-docs/src/main/resources/taskInstanceData.xml
incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml
Modified: 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=982944&r1=982943&r2=982944&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/attachments.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/attachments.xml Fri Aug 6 13:02:08 2010
@@ -16,7 +16,7 @@
<code>inline</code>
.
</note>
- <para> The attachment can be any valid XML. Moreover the attachment
+ <para> The attachment can be any valid XML. Moreover the
attachment data is assumed to be of that type and if it is not, the
attachment is set on empty.</para>
<para>
@@ -30,7 +30,7 @@
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>
+ <para> There are four operations to manage attachments:</para>
<itemizedlist>
<listitem><para>addAttachment</para></listitem>
<listitem><para>deleteAttachments</para></listitem>
@@ -68,7 +68,7 @@
</sect2>
<sect2>
<title>getAttachmentInfos</title>
- <para> Returns attachment information for all attachments assotiadet
+ <para> Returns attachment information for all attachments associated
with the task:</para>
<itemizedlist>
<listitem><para>attached name</para></listitem>
@@ -79,9 +79,8 @@
</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>
+ <para>Get all attachments of the task with given name. For every
+ attachment is returned attachmentInfo and value of attachement</para>
</sect2>
Modified: 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=982944&r1=982943&r2=982944&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/comments.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/comments.xml Fri Aug 6 13:02:08 2010
@@ -1,39 +1,66 @@
-<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>
+<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 consists every information like ordinary
+ comment. Content of the 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 choose 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">
..........
@@ -45,9 +72,9 @@
..........
</htd:task>
]]>
- </programlisting>
- <para>and in english</para>
- <programlisting>
+ </programlisting>
+ <para>and in english</para>
+ <programlisting>
<![CDATA[
<htd:task name="exampleName">
..........
@@ -59,14 +86,6 @@
..........
</htd:task>
]]>
- </programlisting>
-
-
-
-
-
-
-
- </sect2>
-
+ </programlisting>
+ </sect2>
</sect1>
\ No newline at end of file
Modified: 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=982944&r1=982943&r2=982944&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/filtering.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/filtering.xml Fri Aug 6 13:02:08 2010
@@ -1,40 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
<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
-(â<>â), less than (â<â),
-greater than (â>â), less
-than or equals (â<=â),
-and greater than or
-equals (â>=â) <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>
+ <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 returned 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
+ ( "<> "), less than ( "< "),
+ greater than ( "> "), less
+ than or equals ( "<= "),
+ and greater than or
+ equals ( ">= ") <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
+ 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></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">
+ <para id="simpleQueryExample">
<programlisting>
<xsd:genericHumanRole>ACTUALOWNER</xsd:genericHumanRole>
<xsd:status>READY</xsd:status>
@@ -44,7 +32,7 @@ limit.
<xsd:maxTasks>30</xsd:maxTasks>
</programlisting>
-</para>
+ </para>
+ </para>
-</para>
</sect1>
\ No newline at end of file
Modified: 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=982944&r1=982943&r2=982944&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/participant_operations.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/participant_operations.xml Fri Aug 6 13:02:08 2010
@@ -383,6 +383,211 @@
</entry>
<entry> Actual Owner, Business Administrator</entry>
</row>
+ <row>
+ <entry>skip</entry>
+ <entry>Skip the task. Enable only if task is skipable</entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>void</listitem>
+ </itemizedlist>
+ </entry>
+ <entry> Actual Owner, Business Administrator,Task initiator</entry>
+ </row>
+ <row>
+ <entry>forward</entry>
+ <entry>Forward active task to another person or a set of people
+ </entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ <listitem>organizational entity</listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>void</listitem>
+ </itemizedlist>
+ </entry>
+ <entry> Actual Owner, Business Administrator, Potential Owners(only
+ in READY state)</entry>
+ </row>
+ <row>
+ <entry>delegate</entry>
+ <entry>Assign the task to one user and set the task to state
+ Reserved. If the recipient was not a potential owner then this
+ person is added to the set of potential owners.</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>
+ <row>
+ <entry>getTaskInfo</entry>
+ <entry>Applies to both tasks and notifications. Returns info about
+ the task.</entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>task</listitem>
+ </itemizedlist>
+ </entry>
+ <entry> Any</entry>
+ </row>
+ <row>
+ <entry>getTaskDescription</entry>
+ <entry>Applies to both tasks and notifications. Returns the
+ presentation description in the specified mime type.</entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ <listitem>content type â optional, default is text/plain
+ </listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>String</listitem>
+ </itemizedlist>
+ </entry>
+ <entry> any</entry>
+ </row>
+ /////////////
+ <row>
+ <entry>setOutput</entry>
+ <entry>Set the data for the part of the task's output message.
+ </entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ <listitem>part name (optional for single part messages )y
+ </listitem>
+ <listitem>output data of task</listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>void</listitem>
+ </itemizedlist>
+ </entry>
+ <entry>Actual Owner</entry>
+ </row>
+ <row>
+ <entry>deleteOutput</entry>
+ <entry>Deletes the output data of the task.</entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>void</listitem>
+ </itemizedlist>
+ </entry>
+ <entry>Actual Owner</entry>
+ </row>
+ <row>
+ <entry>setFault</entry>
+ <entry>Set the fault data of the task.</entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ <listitem>fault name</listitem>
+ <listitem>fault data of task</listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>void</listitem>
+ </itemizedlist>
+ </entry>
+ <entry>Actual Owner</entry>
+ </row>
+ <row>
+ <entry>delete Fault</entry>
+ <entry>Deletes the fault name and fault data of the task.</entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>void</listitem>
+ </itemizedlist>
+ </entry>
+ <entry>Actual Owner</entry>
+ </row>
+ <row>
+ <entry>getInput</entry>
+ <entry>Get the data for the part of the task's input message.
+ </entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ <listitem>part name (optional for single part messages)
+ </listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>any type</listitem>
+ </itemizedlist>
+ </entry>
+ <entry>Potentail Owners, Actual owner, Business Administrator
+ </entry>
+ </row>
+ <row>
+ <entry>getOutput</entry>
+ <entry>Get the data for the part of the task's output message.e
+ </entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ <listitem>part name (optional for single part messages)
+ </listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>any type</listitem>
+ </itemizedlist>
+ </entry>
+ <entry>Business Administrator, Actual Owner</entry>
+ </row>
+ <row>
+ <entry>getFault</entry>
+ <entry>Get fault data of the task</entry>
+ <entry>
+ in
+ <itemizedlist>
+ <listitem>task identifier</listitem>
+ </itemizedlist>
+ Out
+ <itemizedlist>
+ <listitem>fault name</listitem>
+ <listitem>fault data</listitem>
+ </itemizedlist>
+ </entry>
+ <entry>sd</entry>
+ </row>
</tbody>
</tgroup>
</table>
Modified: 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=982944&r1=982943&r2=982944&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/rendering.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/rendering.xml Fri Aug 6 13:02:08 2010
@@ -5,7 +5,7 @@ so the task engine does not depend on a
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>There is not oportunity to set one rendering for every task, each of task should 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>
@@ -33,10 +33,10 @@ one homogenous list and can handle the t
</htd:task>
]]>
</programlisting>
-<para>There are to functions connected with rendering:</para>
+<para>There are two functions connected with rendering:</para>
<itemizedlist>
<listitem><para>get rendering type</para></listitem>
-<listitem><apara>get rendering</apara></listitem>
+<listitem><para>get rendering</para></listitem>
</itemizedlist>
<sect3>
Modified: 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=982944&r1=982943&r2=982944&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/taskInstanceData.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/taskInstanceData.xml Fri Aug 6 13:02:08 2010
@@ -62,6 +62,6 @@
<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>
+ XQuery 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=982944&r1=982943&r2=982944&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 Fri Aug 6 13:02:08 2010
@@ -15,6 +15,7 @@
<!ENTITY taskInfoExample SYSTEM "taskInfoExample.xml">
<!ENTITY deadline SYSTEM "deadline.xml">
<!ENTITY delegate SYSTEM "delegate.xml">
+<!ENTITY presentation SYSTEM "presentation.xml">
<!ENTITY administrative-operations SYSTEM "administrative-operations.xml">
<!ENTITY generic-human_role SYSTEM "generic-human_role.xml">
<!ENTITY task-properties SYSTEM "task-properties.xml">
@@ -196,6 +197,7 @@ xsi:schemaLocation="http://docbook.org/n
&rendering;
&attachments;
&filtering;
+ &presentation;
</chapter>
<chapter id="taskOperations">
<title>Task operations</title>