summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-09-14 02:52:58 (EDT)
committerStephan Born2012-09-14 02:52:58 (EDT)
commitd7665e7ec4c7e8c6a1290aa93f4b1144396c736e (patch)
tree8d634d179598d16ca99aee84600d594b85ac937b
parenta10e760bdb9f5a91907597554fad650f9e640f9c (diff)
downloadorg.eclipse.stardust.documentation-d7665e7ec4c7e8c6a1290aa93f4b1144396c736e.zip
org.eclipse.stardust.documentation-d7665e7ec4c7e8c6a1290aa93f4b1144396c736e.tar.gz
org.eclipse.stardust.documentation-d7665e7ec4c7e8c6a1290aa93f4b1144396c736e.tar.bz2
CRNT-24955 - Added participant details
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@59194 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-org-struct.htm104
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm2
2 files changed, 63 insertions, 43 deletions
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-org-struct.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-org-struct.htm
index f12f6e1..31961ed 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-org-struct.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-org-struct.htm
@@ -36,16 +36,16 @@ Individual human performers are created and assigned to these roles only in the
@productname@ Portal</a>, the
<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/handbooks/swing-portal/swing-portal.html">
@productname@ Swing Portal</a>, console administration tools or via embedding application.
-The following sections describes the usage of participants in Business Process Modeling:</p>
+The following sections describe the usage of participants in Business Process Modeling perspective:</p>
<ul>
<li><a href="#rep">Representation in the Business Process Modeling Perspective</a></li>
<li><a href="#org">Organizations</a></li>
<li><a href="#role">Roles</a></li>
<li><a href="#condPerformers">Conditional Performers</a></li>
- <li><a href="#associate">Establishing Associations between Organizational Elements</a></li>
+
</ul>
-<h2>Representation in the Business Process Modeling Perspective</h2>
+<h2 id="rep">Representation in the Business Process Modeling Perspective</h2>
<ul>
<li>Participants Node - <img src ="images/parti-icon.png"></li>
<li>Organization - <img src="images/org-icon.png"></li>
@@ -53,36 +53,48 @@ The following sections describes the usage of participants in Business Process M
<li>Conditional Performer - <img src="images/conditional-icon.png"></li>
</ul>
-<h2>Organization</h2>
+<p>You can work with following elements in the <strong>Participants</strong> node:</p>
+<ul>
+ <li>Roles</li>
+ <li>Organization</li>
+ <li>Conditional Performer</li>
+</ul>
+<p>Each model has at least one Administrator role, by default.</p>
+
+<h2 id="org">Organization</h2>
<p>An organization element represents a group of resources. For example, a department or any organizational unit.
This section describes which properties are provided and how to work with organization elements.</p>
<ul>
- <li>Creating Organization</li>
- <li>Renaming Organization</li>
- <li>Deleting Organization</li>
+ <li><a href="#cr">Creating Organization</a></li>
+ <li><a href="#re">Renaming Organization</a></li>
+ <li><a href="#del">Deleting Organization</a></li>
- <li>Creating Role</li>
- <li>Viewing and Editing Organization Properties</li>
+ <li><a href="#ro">Creating Role under Organization</a>
+ <ul>
+ <li><a href="#set">Set as Manager</a></li>
+ </ul></li>
+ <li><a href="">Creating Organization under Organization</a></li>
+ <li><a href="#ed">Viewing and Editing Organization Properties</a></li>
</ul>
-<h3>Creating Organization</h3>
-<p>To create organization, right-click <strong>Participants</strong> node in the <strong>My Process Models</strong> panel
+<h3 id="cr">Creating Organization</h3>
+<p>To create an organization, right-click <strong>Participants</strong> node in the <strong>My Process Models</strong> panel
and click <strong>Create Organization</strong>.</p>
<p class="image"><img src="images/create-org.png"
alt=""><br>
<strong>Figure:</strong> Create Organization</p>
-<h3>Renaming Organization</h3>
-<p>To rename the organization, right-click on the <strong>Organization</strong> node in the <strong>My Process Models</strong> panel
+<h3 id="re">Renaming Organization</h3>
+<p>To rename the organization, right-click the <strong>Organization</strong> node in the <strong>My Process Models</strong> panel
and click <strong>Rename</strong>.
Specify the new name for organization.</p>
<p class="image"><img src="images/org-rename.png"
alt=""><br>
<strong>Figure:</strong> Rename Organization</p>
-<h3>Deleting Organization</h3>
-<p>To delete organization, right-click on the <strong>Organization</strong> node in the <strong>My Process Models</strong> panel
+<h3 id="del">Deleting Organization</h3>
+<p>To delete organization, right-click the <strong>Organization</strong> node in the <strong>My Process Models</strong> panel
and click <strong>Delete</strong>.</p>
<p class="image"><img src="images/org-del.png"
@@ -92,9 +104,9 @@ alt=""><br>
<p class="image"><img src="images/del-confirm.png"
alt=""><br>
<strong>Figure:</strong> Delete Organization - Confirmation</p>
-<h3>Creating Role</h3>
+<h3 id="ro">Creating Role under Organization</h3>
-<p>To create a role under organization, right-click on the <strong>Organization</strong> node in
+<p>To create a role under organization, right-click the <strong>Organization</strong> node in
the <strong>My Process Models</strong> panel
and click <strong>Create Role</strong>.</p>
@@ -102,16 +114,16 @@ and click <strong>Create Role</strong>.</p>
<p class="image"><img src="images/org-role.png"
alt=""><br>
<strong>Figure:</strong> Organization - Create Role</p>
-<h3 id="set">Set as Manager</h3>
-<p>The role created under organization can be set as manager or team lead. Right-click on the role
+<h4 id="set">Set as Manager</h4>
+<p>The role created under organization can be set as manager. Right-click on the role
created under organization node and click <strong>Set as Manager</strong>.</p>
<p class="image"><img src="images/set-mgr.png"
alt=""><br>
<strong>Figure:</strong> Role - Set as Manager</p>
-<p>Note that at a time you can set only one role under organization as a team lead.</p>
-<h3>Creating Organization under Organization</h3>
-<p>To create organization under organization, right-click on the <strong>Organization</strong> node in
+<p>Note that at a time you can set only one role under organization as a manager.</p>
+<h3 id="org">Creating Organization under Organization</h3>
+<p>To create an organization under organization, right-click the <strong>Organization</strong> node in
the <strong>My Process Models</strong> panel
and click <strong>Create Organization</strong>.</p>
@@ -121,9 +133,9 @@ alt=""><br>
<strong>Figure:</strong> Organization - Create Organization</p>
-<p>Not yet implemented.</p>
-<h3>Viewing and Editing Organization Properties</h3>
+
+<h3 id="ed">Viewing and Editing Organization Properties</h3>
<p>To view organization properties, click the <strong>Organization</strong> node in
the <strong>My Process Models</strong> panel. The organization properties get displayed.
@@ -133,7 +145,10 @@ alt=""><br>
<p>Following properties are displayed:</p>
<ul>
-
+ <li>UUID - A unique ID gets generated as an identifier for client server communication.</li>
+ <li>ID - An ID generated automatically based on the organization name
+ </li>
+
<li>Organization Name</li>
<li>Description</li>
<li>Public Visibility - By default, this check box is selected. It indicates that the element is
@@ -157,10 +172,11 @@ alt=""><br>
<li>Data Path - Specify the data path for the selected structured data</li></ul></li>
<li>Team Lead - Click the Team Lead tab to specify the role that can act as a team lead.
There can only be one team leader per organization. You can also define the team leader, using the
- <strong>Set as Manager</strong> option.
+ <a href="#set">Set as Manager</a> option.
<ul>
- <li>Leader - By default, None is selected. You need to select the role from the drop-down list. </li>
- <p class="image"><img src="images/leader.png" alt=""><br>
+ <li>Leader - By default, None is selected. You need to select the role from the drop-down list.
+ Roles from the current model as well as other models are listed.
+ <p class="image"><img src="images/leader.png" alt=""><br></p></li>
</ul>
</li>
<li>Activity Assignment - You have the choice for activity assignment.
@@ -173,29 +189,29 @@ alt=""><br>
<li></li>
</ul>
-<h2>Creating Roles</h2>
+<h2 id="role">Roles</h2>
<p>You can create roles in two ways:</p>
<ul>
- <li>Creating roles under Organization node</li>
- <li>Creating roles under Participants node</li>
+ <li><a href="#ro">Creating roles under Organization node</a></li>
+ <li><a href="#partn">Creating roles under Participants node</a></li>
</ul>
-<h3>Creating Roles under Participants Node</h3>
-<p>To create role, right-click on <strong>Participants</strong> node and click <strong>Create Role</strong>.</p>
+<h3 id="partn">Creating Roles under Participants Node</h3>
+<p>To create a role, right-click the <strong>Participants</strong> node and click <strong>Create Role</strong>.</p>
<p class="image"><img src="images/create-role.png"
alt=""><br>
<strong>Figure:</strong> Create Role</p>
-<h4>Renaming Role</h4>
-<p>To rename role, right-click on role and click <strong>Rename Role</strong>.</p>
+<h3>Renaming Role</h3>
+<p>To rename the role, right-click on role and click <strong>Rename Role</strong>.</p>
<p class="image"><img src="images/rename-role.png"
alt=""><br>
<strong>Figure:</strong> Rename Role</p>
-<h4>Deleting Role</h4>
-<p>To delete role, right-click on role and click <strong>Delete Role</strong>.</p>
+<h3>Deleting Role</h3>
+<p>To delete the role, right-click on role and click <strong>Delete Role</strong>.</p>
<p class="image"><img src="images/del-role.png"
alt=""><br>
@@ -208,14 +224,18 @@ alt=""><br>
alt=""><br>
<strong>Figure:</strong> Role Properties</p>
<ul>
+ <li>UUID - A unique ID gets generated as an identifier for client server communication.</li>
+ <li>ID - An ID generated automatically based on the role name
+ </li>
<li>Role Name - Specify role name.</li>
<li>Description - Specify role description.</li>
- <li>Public Visibility - </li>
+ <li>Public Visibility - By default, this check box is selected. It indicates that the element is
+ visible and available for reference from any other model.</li>
<li>Activity Assignment -You have the choice for activity assignment.
The <strong>Choose Assignment</strong> option is selected by default. If you select <strong>Assign Automatically</strong>
option, then the Assembly Line mode gets activated. For more information, please refer to the chapter
<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/pp-launch-panels.html">Launch Panels</a>
- of the <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/toc.html">Enduser Handbook</a>></li>
+ of the <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/toc.html">Enduser Handbook</a></li>
<li>Controlling
<ul>
<li>Controlling Weeks per Year</li>
@@ -227,7 +247,7 @@ alt=""><br>
</li>
</ul>
-<h2>Conditional Performer</h2>
+<h2 id="condPerformers">Conditional Performer</h2>
<p>The conditional performer is evaluated at runtime and it determines the identity of the actual performer.
The following sections help you to work with conditional performers.</p>
@@ -244,7 +264,7 @@ alt=""><br>
<h3>Renaming Conditional Performer</h3>
<p>To create conditional performer, right-click on conditional performer
-in <strong>Participants</strong> node
+in the <strong>Participants</strong> node
and click <strong>Rename</strong>.</p>
@@ -264,7 +284,7 @@ alt=""><br>
<h3>Viewing Conditional Performer Properties</h3>
-
+<p>Properties are not yet fully implemented.</p>
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm
index 3767a91..b1dd695 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm
@@ -194,7 +194,7 @@ You can drag and drop the symbols as described in the chapter <a href="model-vie
<tr>
<td>Participant</td>
<td>Swim Lane</td>
- <td>Creates a new role, organization and conditional performer.</td>
+ <td>Creates a new swim lane and assigns the role to it automatically</td>
</tr>
<tr>
<td>Process</td>