incubator-hise-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r.@apache.org
Subject svn commit: r982943 - in /incubator/hise/trunk/hise-docs/src/main/resources: administrative-operations.xml deadline.xml generic-human_role.xml logical-people-group.xml notifications.xml task-properties.xml user-guide.xml
Date Fri, 06 Aug 2010 12:59:02 GMT
Author: rr
Date: Fri Aug  6 12:59:02 2010
New Revision: 982943

URL: http://svn.apache.org/viewvc?rev=982943&view=rev
Log:
HISE-65: documentation next patch (Thanks to Michał Więcław)

Added:
    incubator/hise/trunk/hise-docs/src/main/resources/logical-people-group.xml
    incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml
Modified:
    incubator/hise/trunk/hise-docs/src/main/resources/administrative-operations.xml
    incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml
    incubator/hise/trunk/hise-docs/src/main/resources/generic-human_role.xml
    incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml
    incubator/hise/trunk/hise-docs/src/main/resources/user-guide.xml

Modified: incubator/hise/trunk/hise-docs/src/main/resources/administrative-operations.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/administrative-operations.xml?rev=982943&r1=982942&r2=982943&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/administrative-operations.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/administrative-operations.xml Fri Aug
 6 12:59:02 2010
@@ -5,6 +5,7 @@
 	administrators. These operations support task management.</para>
 
 <table frame="all">
+<title>Administrative Operations</title>
 <tgroup cols="4">
         <thead>
           <row>

Modified: incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml?rev=982943&r1=982942&r2=982943&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/deadline.xml Fri Aug  6 12:59:02 2010
@@ -78,9 +78,9 @@ The escalatino definition may contain:
 	   </para>
 
 	<sect3>
-	   <title>Condition</title>
+	   <title><para id='condition'>Condition</para></title>
 		
-	   <para id='condition'>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.
+	   <para>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.
 
 		<programlisting>
 	  	 <![CDATA[
@@ -92,9 +92,9 @@ The escalatino definition may contain:
 	   </para>
 	</sect3>
 	<sect3>	
-	   <title>Notifications</title>
+	   <title><para id='notification'>Notifications</para></title>
 
-	   <para id='notification'>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.
+	   <para>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.
 
 		<programlisting>
@@ -123,9 +123,9 @@ If not, then the toPart elements are use
 	   </para>
 	</sect3>
 	<sect3>	
-	   <title>ToParts</title>
+	   <title><para id='toParts'>ToParts</para></title>
 	
-	   <para id='toParts'>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.
+	   <para>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.
 
 		<programlisting>
 	  	 <![CDATA[
@@ -141,9 +141,9 @@ If not, then the toPart elements are use
 
 	</sect3>	
 	<sect3>	
-	   <title>Reassignments</title>
+	   <title><para id='reassignment'>Reassignments</para></title>
 	
-	   <para id='reassignment'>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
+	   <para>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.
 

Modified: incubator/hise/trunk/hise-docs/src/main/resources/generic-human_role.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/generic-human_role.xml?rev=982943&r1=982942&r2=982943&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/generic-human_role.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/generic-human_role.xml Fri Aug  6 12:59:02
2010
@@ -1,5 +1,5 @@
 
-    <sect1>
+  <sect1>
       <title>Generic Human Role</title>
 
       <para>Generic human roles define what a person or group of people
@@ -39,13 +39,20 @@
             <link linkend="potentialDelegatees">Potential delegatees</link>
           </listitem>
         </itemizedlist> </para>
+	
+    <sect2>
+      <title><para id="taskInitiator">Task initiator</para></title>
 
-      <para id="taskInitiator"><emphasis>Task initiator</emphasis> is the
+      <para>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.</para>
+    </sect2>
 
-      <para id="taskStakeholders"><emphasis>Task stakeholders</emphasis>
are
+    <sect2>
+      <title><para id="taskStakeholders">Task stakeholders</para></title>
+
+      <para >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
@@ -54,8 +61,12 @@
       notifications, such as resolving missed deadlines. Compliant
       implementations MUST ensure that at least one person is associated with
       this role at runtime.</para>
+    </sect2>
+
+    <sect2>
+      <title><para id="potentialOwners">Potential owners</para></title>
 
-      <para id="potentialOwners"><emphasis>Potential owners</emphasis>
of a
+      <para>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
@@ -63,36 +74,58 @@
       the priority of the task, adding ad-hoc attachments or comments. All
       excluded owners are implicitly removed from the set of potential
       owners.</para>
+    </sect2>
 
-      <para id="actualOner"><emphasis>Actual owner</emphasis> is the person
+    <sect2>
+      <title><para id="actualOner">Actual owner</para></title>
+
+      <para>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.</para>
+    </sect2>
+
+    <sect2>
+      <title><para id="businessAdministrators">Buisness administrators</para></title>
 
-      <para id="businessAdministrators">Buisness administrators are the people
+      <para>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.</para>
+    </sect2>
 
-      <para id="excludedOwners"><emphasis>Excluded owners</emphasis> may
not
+    <sect2>
+      <title><para id="excludedOwners">Excluded owners</para></title>
+
+      <para id="excludedOwners">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.</para>
+    </sect2>
+
+    <sect2>
+      <title><para id="recipients">Recipients</para></title>
 
-      <para id="recipients"><emphasis>Recipients</emphasis> are persons
who
+      <para>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.</para>
+    </sect2>
 
-      <para id="potentialDelegatees"><emphasis>Potential delegatees</emphasis>
+    <sect2>
+      <title><para id="potentialDelegatees">Potential delegatees</para></title>
+
+      <para>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. </para>
-    </sect1>
+
+    </sect2>
+  </sect1>
 

Added: incubator/hise/trunk/hise-docs/src/main/resources/logical-people-group.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/logical-people-group.xml?rev=982943&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/logical-people-group.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/logical-people-group.xml Fri Aug  6
12:59:02 2010
@@ -0,0 +1,19 @@
+<sect1>
+    <title>Logical People Group</title>
+    
+    <para>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. 
+    </para>
+	
+    <programlisting>
+	   <![CDATA[
+		<htd:logicalPeopleGroups>
+    
+    		    <htd:logicalPeopleGroup name="regionEmployees">
+            		<htd:documentation xml:lang="en-US">Employee group.</htd:documentation>
+            		<htd:parameter name="region" type="xsd:string"/>
+        	    </htd:logicalPeopleGroup>
+
+    		</htd:logicalPeopleGroups>
+	   ]]>
+    </programlisting>
+</sect1>

Added: incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml?rev=982943&view=auto
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml (added)
+++ incubator/hise/trunk/hise-docs/src/main/resources/notifications.xml Fri Aug  6 12:59:02
2010
@@ -0,0 +1,98 @@
+<sect1>
+	
+    <para>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. 
+    </para>
+
+    <para>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. They 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.
+    </para>
+	
+    <para>Definition of notifications</para>
+    <programlisting>
+	 <![CDATA[
+	<htd:notification name="NCName">
+
+  	  <htd:interface portType="QName" operation="NCName"/>
+    	  <htd:priority expressionLanguage="anyURI"?>?
+    	       integer-expression
+    	  </htd:priority>
+  
+	  <htd:peopleAssignments>
+    	     <htd:recipients>
+      		...
+    	     </htd:recipients>
+             <htd:businessAdministrators>?
+      		...
+    	     </htd:businessAdministrators>
+  	  </htd:peopleAssignments>
+  
+	  <htd:presentationElements>
+    		...
+  	  </htd:presentationElements>
+  
+	  <htd:renderings>?
+    		...
+          </htd:renderings>
+	</htd:notification>
+	 ]]>
+    </programlisting>
+
+    <sect2>
+	<title>Notification properties</title>
+ 	
+	<para>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. </para>
+
+	<para>The following attributes and elements are defined for notifications:
+	<itemizedlist>
+	     <listitem>name</listitem>
+	     <listitem>interface</listitem>
+	     <listitem>priority</listitem>
+	     <listitem>peopleAssignments</listitem>
+	     <listitem>presentationElements</listitem>
+	     <listitem>rendering</listitem>
+	</itemizedlist>
+	</para>
+
+    </sect2>
+</sect1>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+	
+

Modified: incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml
URL: http://svn.apache.org/viewvc/incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml?rev=982943&r1=982942&r2=982943&view=diff
==============================================================================
--- incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml (original)
+++ incubator/hise/trunk/hise-docs/src/main/resources/task-properties.xml Fri Aug  6 12:59:02
2010
@@ -3,21 +3,67 @@
 	
 	<para>The fallowing basic attributs are defined for tasks:
 
-	<itemizedlist>
-          <listitem>
-             <para>name - 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.</para>
-          </listitem>
-	  <listitem>
-             <para>priority - 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.</para>
-          </listitem>
-	  <listitem>
-             <para>autoActivate - 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 </para>
-          </listitem>
-	  <listitem>
-             <para>isSkipable - 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. </para>
-          </listitem>
-	</itemizedlist>
+	<sect2>
+	     <title>name</title>
+             <para>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.
+	     </para>
+        </sect2>
+	<sect2>  
+	     <title>priority</title>
+             <para>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.
+             </para>
+        </sect2>
+	<sect2>
+	     <title>autoActivate</title>
+             <para>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

+             </para>
+        </sect2>
+	<sect2>
+	     <title>isSkipable</title>
+             <para>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. 
+             </para>
+        </sect2>
+	<sect2>
+	     <title>peopleAssignments</title>
+	     <para> It is used to assign people and group of people to different generic human
role. 
+		This element is mandatory and is defined by &quot;Using Literals&quot; 
+		or &quot;Logical people groups&quot;.
+	     </para>
+	     <programlisting>
+	   	<![CDATA[
+	      <htd:peopleAssignments>
+            	<htd:potentialOwners>
+                  <htd:from>
+                    <htd:literal>
+                        <htd:organizationalEntity>
+                            <htd:users>
+                                <htd:user>user1</htd:user>
+                            </htd:users>
+                        </htd:organizationalEntity>
+                    </htd:literal>
+                  </htd:from>
+                </htd:potentialOwners>	
+
+		<htd:businessAdministrators>
+		         ...		
+		</htd:businessAdministrators>
+	      <htd:peopleAssignments>
+
+	...
+
+	      <htd:potentialOwners>
+ 		 <htd:from logicalPeopleGroup="regionalClerks">
+    		    <htd:argument name="region">
+       			htd:getInput("part1")/region
+    		    </htd:argument>
+  		 </htd:from>
+	      </htd:potentialOwners>
+		]]>
+	     </programlisting>
+	</sect2>
 	</para>
 </sect1>

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=982943&r1=982942&r2=982943&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 12:59:02 2010
@@ -18,6 +18,8 @@
 <!ENTITY administrative-operations SYSTEM "administrative-operations.xml">
 <!ENTITY generic-human_role SYSTEM "generic-human_role.xml">
 <!ENTITY task-properties SYSTEM "task-properties.xml">
+<!ENTITY logical-people-group SYSTEM "logical-people-group.xml">
+<!ENTITY notifications SYSTEM "notifications.xml">
 
 ]>
 
@@ -179,6 +181,7 @@ xsi:schemaLocation="http://docbook.org/n
   &intro;
   &taskInstanceData;
   &generic-human_role;
+  &logical-people-group;
   </chapter>
   <chapter id="task_properties">
   <title>Task properties</title>
@@ -230,6 +233,13 @@ explicitly. They have the same authoriza
 	&simpleQuery;
   &all_rest_participant_operations;
   </chapter>
+  
+  <chapter>
+     <title>Notifications</title>
+
+     &notifications;
+  </chapter>
+   
   <chapter id="examples">
  <title>Examples</title>
  &taskInfoExample; 



Mime
View raw message