summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-09-28 02:40:33 (EDT)
committer Robert Sauer2012-09-28 02:40:33 (EDT)
commit27f8cddc5f6acb2c5708cf0178acff33b25a6bff (patch)
tree83f62b645cb1e96c88602e14952d275ebd0f5349
parent6aaa42e161e2b71ca248e15175fafa5be5f56d89 (diff)
downloadorg.eclipse.stardust.documentation-27f8cddc5f6acb2c5708cf0178acff33b25a6bff.zip
org.eclipse.stardust.documentation-27f8cddc5f6acb2c5708cf0178acff33b25a6bff.tar.gz
org.eclipse.stardust.documentation-27f8cddc5f6acb2c5708cf0178acff33b25a6bff.tar.bz2
CRNT-25977 - Added property details for activity and other elements
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@59601 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-com-icon.pngbin0 -> 6261 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-comm.pngbin0 -> 4125 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-gen-prop.pngbin17047 -> 14131 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/control-icon.pngbin0 -> 5757 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/controlling.pngbin0 -> 8188 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/serv-par-icon.pngbin0 -> 5066 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/service-param.pngbin0 -> 3323 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/subprocess.pngbin0 -> 5005 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-activities.htm107
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-events.htm24
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm8
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-org-struct.htm5
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm2
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm2
14 files changed, 124 insertions, 24 deletions
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-com-icon.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-com-icon.png
new file mode 100644
index 0000000..7d1df32
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-com-icon.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-comm.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-comm.png
new file mode 100644
index 0000000..9007e34
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-comm.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-gen-prop.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-gen-prop.png
index 6b693fc..0722d7e 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-gen-prop.png
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/act-gen-prop.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/control-icon.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/control-icon.png
new file mode 100644
index 0000000..0e8b776
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/control-icon.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/controlling.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/controlling.png
new file mode 100644
index 0000000..d715622
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/controlling.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/serv-par-icon.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/serv-par-icon.png
new file mode 100644
index 0000000..d422b40
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/serv-par-icon.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/service-param.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/service-param.png
new file mode 100644
index 0000000..2443a81
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/service-param.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/subprocess.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/subprocess.png
new file mode 100644
index 0000000..5426d23
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/subprocess.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-activities.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-activities.htm
index 4ee50ca..6d7420c 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-activities.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-activities.htm
@@ -179,6 +179,8 @@ You can add activity using four different ways:
<ul>
<li>UUID - A unique identifier ID gets generated as an identifier for client server communication</li>
<li>ID - Default ID of the activity</li>
+ <p>The <strong>UUID</strong> and <strong>ID</strong> options are displayed only when you switch to
+ <a href="model-views/pep-panels.html">Integrator</a> profile.</p>
<li>Name - Specify name of the activity</li>
<li>Description - Specify the description</li>
<li>Allow Abort by Participant - Determines whether the assigned participant may abort instances of
@@ -193,31 +195,106 @@ You can add activity using four different ways:
<li>Supports relocation -Determines if relocation is supported for this
activity and it can be used as starting point for the relocation.
This check box is enabled for manual activities and application activities only.</li>
- <li>Is relocation target -Determines if the activity is allowed as
+ <li>Is Relocation Target -Determines if the activity is allowed as
target point of a relocation. For details on relocation,
- refer to chapter <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/
- html/handbooks/concepts/executing-workflow/concept-relocation.html"> Relocation of Activities</a>
- of the <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/
- html/handbooks/concepts/key-concepts.html">Concepts handbook</a>.</li>
+ refer to chapter
+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/concepts/executing-workflow/concept-relocation.html"> Relocation of Activities</a>
+ of the <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/concepts/key-concepts.html">Concepts handbook</a>.</li>
- <li>Application - By default, this option is selected. When you select this option, the activity icon
- changes to application icon and activity becomes application activity.
- The adjacent drop-down list displays list of applications
- defined in all the models displayed under the <strong>Models</strong> node.</li>
- <p class="image"><img src="images/act-gen-app.png" alt=""> <br>
-<strong>Figure:</strong> Activity - General Properties - Application</p>
+ <li>User Task - By default, this option is selected. It specifies that activity is interactive.
+ You should select a user interface for the activity from the drop-down list. By default,
+ <strong>Auto-generated Screen</strong> option is selected. It contains following interactive applications:
+ <ul>
+ <li>External Web Application</li>
+ <li>JFC Application</li>
+ <li>JSF Application</li>
+ <li>JSP Application</li>
+ </ul>
+ </li>
+ <li>Script Task - It specifies that the activity should execute a script (non-interactive application).
+ The drop-down list contains all defined non-interactive applications. By default, <strong>To be defined</strong>
+ option is selected.
+ </li>
+
<li>Subprocess - If you select the option, the activity acts as a subprocess and
the activity icon
changes to subprocess icon with a plus sign in the center-bottom of the activity.
The adjacent drop-down list displays all the processes defined in all the models
displayed under the <strong>Models</strong> node.
<ul>
- <li>Share Data with Current Process - TO DO. Clarification from Marc and Kyle. Told Caroline to
- ask them.</li>
- </ul>
-</ul>
+ <li>Execution - This option provides the facility to decide whether process can be executed synchronously or
+ asynchronously. By default, the <strong>Synchronous/Shared Data</strong> option is selected.
+ The drop-down list contains following options:
+ <ul>
+ <li>Synchronous/Shared Data</li>
+ <li>Synchronous/Separate Data</li>
+ <li>Asynchronous/Separate Data</li>
+ </ul>
+ The <strong>Copy All Data </strong> option is selected for all the three options, by default.
+ The <strong>Execution</strong> option is displayed only when you switch to
+ <a href="model-views/pep-panels.html">Integrator</a> profile.</li>
+ </ul></li></ul>
+
+ <p class="image"><img src="images/subprocess.png" alt=""> <br>
+<strong>Figure:</strong> Activity - Subprocess</p>
+
+
+ <p>For more information, please refer to the chapter
+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modeling/activities/mg-subprocesses.html">Configuring Subprocess Activities</a> of the
+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modeling/mg-preface.htm">Modeling Handbook</a>.</p>
+
+
</li>
</ol>
+<h3>Service Parameters</h3>
+<p>Click the <strong>Service Parameters</strong> icon displayed
+at the top-right side of the diagram canvas.</p>
+
+<p class="image"><img src="images/serv-par-icon.png" alt=""> <br>
+<strong>Figure:</strong> Service Parameters Icon</p>
+
+<p>Specify the service parameters as applicable.</p>
+<p class="image"><img src="images/service-param.png" alt=""> <br>
+<strong>Figure:</strong> Service Parameters</p>
+
+
+<h3>Controlling Properties</h3>
+<p>Click the <strong>Controlling Parameters</strong> icon displayed
+at the top-right side of the diagram canvas.</p>
+
+<p class="image"><img src="images/control-icon.png" alt=""> <br>
+<strong>Figure:</strong> Controlling Properties Icon</p>
+
+<p>
+
+The following controlling parameters are available for activities:</p>
+<ul>
+ <li><strong>Target Processing Time</strong></li>
+ <li><strong>Target Execution Time</strong></li>
+ <li><strong>Target Idle Time</strong></li>
+ <li><strong>Target Waiting Time</strong></li>
+ <li><strong>Target Queue Depth</strong></li>
+ <li><strong>Target Cost per Execution</strong> </li>
+ <li><strong>Resource Performance Calculation</strong> </li>
+
+</ul>
+<p class="image"><img src="images/controlling.png" alt=""> <br>
+<strong>Figure:</strong> Controlling</p>
+
+<h3>Comments</h3>
+
+<p>To add comments for activities, perform the following steps:</p>
+<ol>
+ <li>Click the <strong>Comments</strong> icon displayed at the top-right corner of the diagram canvas</li>
+ <p class="image"><img src="images/act-com-icon.png" alt=""> <br>
+<strong>Figure:</strong> Activity - Comment Icon</p>
+ <li>Add comment in the text box and click <strong>Submit</strong></li>
+ <p class="image"><img src="images/act-comm.png" alt=""> <br>
+<strong>Figure:</strong> Activity - Add Comment</p>
+ <li>To delete the comment, select the comment and click the <strong>Delete</strong> icon.</li>
+
+</ol>
+
<script language="JavaScript" type="text/javascript">
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-events.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-events.htm
index 5f713dc..4a0a1fb 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-events.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-events.htm
@@ -29,16 +29,28 @@ The Business Process Modeling perspective supports two types of events:</p>
<li>End Event - Represents the result of a process. This <img src="images/end-eve.png">icon represents the End Event.</li>
</ul>
+<p>This chapter covers the following:</p>
+
+<ul>
+ <li><a href="#adds">Adding Start Event</a></li>
+ <li><a href="#adde">Adding End Event</a></li>
+ <li><a href="#del">Deleting Events</a></li>
+ <li><a href="#fly">Using Events Flyout Menu</a></li>
+ <li><a href="#prop">Viewing and Editing Properties of Start Event</a></li>
+
+</ul>
+
+
-<h2>Adding Start Event</h2>
+<h2 id="adds">Adding Start Event</h2>
<p>In the toolbar, click <strong>Create Start Event</strong> icon and drop it to swim lanes.</p>
<p class="image"><img src="images/create-statt-tool.png" alt=""> <br>
<strong>Figure:</strong> Create Start Event</p>
-<h2>Adding End Event</h2>
+<h2 id ="adde">Adding End Event</h2>
<p>You can add End Event icon from toolbar and flyout menu of activity.</p>
@@ -59,13 +71,13 @@ The Business Process Modeling perspective supports two types of events:</p>
<li>Drop it in the swim lanes</li>
</ul>
-<h2>Deleting Events</h2>
+<h2 id="del">Deleting Events</h2>
<p>To delete events, hover the mouse over the event added to the swim lanes and click the <strong>Delete</strong> icon
in the flyout menu.</p>
<p class="image"><img src="images/del-eve.png" alt=""> <br>
<strong>Figure:</strong> Delete Start Event</p>
-<h2>Using Events Flyout Menu</h2>
+<h2 id="fly">Using Events Flyout Menu</h2>
<p>The event flyout menu is displayed when you hover the mouse in the proximity of the event.</p>
<p class="image"><img src="images/eve-fly.png" alt=""> <br>
<strong>Figure:</strong> Start Event - Flyout Menu</p>
@@ -102,7 +114,7 @@ in the flyout menu.</p>
</table>
-<h2>Viewing and Editing Properties of Start Event</h2>
+<h2 id="prop">Viewing and Editing Properties of Start Event</h2>
<h3>General Properties</h3>
<p>To view and modify properties of Start Event, perform the following steps:</p>
@@ -117,6 +129,8 @@ in the flyout menu.</p>
<ul>
<li>UUID - A unique identifier ID gets generated as an identifier for client server communication</li>
<li>ID - Default ID of the start event</li>
+ <p>The <strong>UUID</strong> and <strong>ID</strong> options are displayed only when you switch to
+ <a href="model-views/pep-panels.html">Integrator</a> profile.</p>
<li>Name - Specify name of the start event</li>
<li>Description - Specify the description</li>
<li>Event Type - By default, <strong>Manual Process Start</strong> option is selected.
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm
index b7b354d..2d643d6 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm
@@ -136,7 +136,7 @@ click the <strong>Gateway</strong> icon in flyout menu and drop it in the swim l
<ol>
<li>Select the gateway in the swim lane.
- The properties window is displayed at the top right corner of the swim lane. </li>
+ The properties window is displayed at the top-right corner of the swim lane. </li>
<p class="image"><img src="images/act-gen-prop.png" alt=""> <br>
<strong>Figure:</strong> Gateway - General Properties</p>
@@ -145,8 +145,10 @@ click the <strong>Gateway</strong> icon in flyout menu and drop it in the swim l
<li>UUID - A unique identifier ID gets generated as an identifier for client server communication.
This field is visible when you select <strong>Integrator</strong>
option from the <strong>Profile</strong> panel.</li>
- <li>ID - Default ID of the gateway. This field is visible when you select <strong>Integrator</strong>
- option from the <strong>Profile</strong> panel.</li>
+ <li>ID - Default ID of the gateway.</li>
+ <p>The <strong>UUID</strong> and <strong>ID</strong> options are displayed only when you switch to
+ <a href="model-views/pep-panels.html">Integrator</a> profile.</p>
+
<li>Name - Specify name for the gateway</li>
<li>Description - Specify description for gateway</li>
<li>Gateway Type - Select gateway type from the drop-down list. The available options are:
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 31961ed..3d6c350 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
@@ -148,7 +148,8 @@ alt=""><br>
<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>
-
+ <p>The <strong>UUID</strong> and <strong>ID</strong> options are displayed only when you switch to
+ <a href="model-views/pep-panels.html">Integrator</a> profile.</p>
<li>Organization Name</li>
<li>Description</li>
<li>Public Visibility - By default, this check box is selected. It indicates that the element is
@@ -227,6 +228,8 @@ alt=""><br>
<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>
+ <p>The <strong>UUID</strong> and <strong>ID</strong> options are displayed only when you switch to
+ <a href="model-views/pep-panels.html">Integrator</a> profile.</p>
<li>Role Name - Specify role name.</li>
<li>Description - Specify role description.</li>
<li>Public Visibility - By default, this check box is selected. It indicates that the element is
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 488d44a..d7e8183 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
@@ -112,6 +112,8 @@ at the right of the lanes.
<ul>
<li>UUID - A unique identifier ID gets generated as an identifier for client server communication.</li>
<li>ID - Default ID of the lane.</li>
+ <p>The <strong>UUID</strong> and <strong>ID</strong> options are displayed only when you switch to
+ <a href="model-views/pep-panels.html">Integrator</a> profile.</p>
<li>Name - Specify name of the lane.</li>
<li>Description - Specify the description.</li>
<li>Participant - By default, <strong>None</strong> option is displayed. All the participants defined in the
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm
index ac76e70..2c81ea0 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm
@@ -87,6 +87,8 @@ A typical process definition contains swim lanes, activities and gateways, appli
<ul>
<li>UUID - A unique identifier ID gets generated as an identifier for client server communication</li>
<li>ID - Default ID of the process</li>
+ <p>The <strong>UUID</strong> and <strong>ID</strong> options are displayed only when you switch to
+ <a href="model-views/pep-panels.html">Integrator</a> profile.</p>
<li>Name - Specify name of the process</li>
<li>Description - Specify the description</li>
<li>Default Priority - Specify process priority. By default, it is set to 0. You can specify following