summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-09-21 05:47:46 (EDT)
committerStephan Born2012-09-28 02:36:36 (EDT)
commit2edf90b94a0ea6993cd2df6f0e7ca1c7514634d3 (patch)
tree283e270baed88c96f2504b831d5200c69c589ca8
parent9ce6b7320b4bd563aef31d3eb4e42a19cf3479c3 (diff)
downloadorg.eclipse.stardust.documentation-2edf90b94a0ea6993cd2df6f0e7ca1c7514634d3.zip
org.eclipse.stardust.documentation-2edf90b94a0ea6993cd2df6f0e7ca1c7514634d3.tar.gz
org.eclipse.stardust.documentation-2edf90b94a0ea6993cd2df6f0e7ca1c7514634d3.tar.bz2
CRNT-26314 - Added gateway chapter
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@59411 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/activity-g.pngbin0 -> 1044 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/and.pngbin0 -> 595 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/annotation-icon.pngbin0 -> 4416 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/annotation.pngbin0 -> 4268 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/connect.pngbin0 -> 531 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-act.pngbin0 -> 6959 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-eve.pngbin0 -> 3767 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-gate.pngbin0 -> 4315 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate.pngbin0 -> 3554 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-annotation.pngbin0 -> 883 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/end.pngbin0 -> 872 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gateway-fly.pngbin0 -> 4351 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gateway-icon.pngbin0 -> 623 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gfly-del.pngbin0 -> 830 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/xor.pngbin0 -> 694 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-con-sequence.htm9
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm220
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-pools-lanes.htm2
18 files changed, 161 insertions, 70 deletions
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/activity-g.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/activity-g.png
new file mode 100644
index 0000000..7fef8e1
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/activity-g.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/and.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/and.png
new file mode 100644
index 0000000..8af2b71
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/and.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/annotation-icon.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/annotation-icon.png
new file mode 100644
index 0000000..1a84c42
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/annotation-icon.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/annotation.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/annotation.png
new file mode 100644
index 0000000..d3908f5
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/annotation.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/connect.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/connect.png
new file mode 100644
index 0000000..ad76869
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/connect.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-act.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-act.png
new file mode 100644
index 0000000..7446f2a
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-act.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-eve.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-eve.png
new file mode 100644
index 0000000..d0ba3f2
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-eve.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-gate.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-gate.png
new file mode 100644
index 0000000..494fb62
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate-gate.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate.png
new file mode 100644
index 0000000..12b44cc
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/cr-gate.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-annotation.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-annotation.png
new file mode 100644
index 0000000..1ff2f38
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-annotation.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/end.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/end.png
new file mode 100644
index 0000000..71a506d
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/end.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gateway-fly.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gateway-fly.png
new file mode 100644
index 0000000..6e48a17
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gateway-fly.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gateway-icon.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gateway-icon.png
new file mode 100644
index 0000000..bd49009
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gateway-icon.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gfly-del.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gfly-del.png
new file mode 100644
index 0000000..28322a3
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gfly-del.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/xor.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/xor.png
new file mode 100644
index 0000000..7e520f6
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/xor.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-con-sequence.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-con-sequence.htm
index 3f30854..9ba0e0e 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-con-sequence.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-con-sequence.htm
@@ -148,7 +148,14 @@ information on the Fork Transaction on Traversal functionality.</p>
<li>Condition Expression - You can specify a condition in this editor. The sequence is then traversed
and the next activity is performed, if the specified condition is fulfilled.
Conditions are specified if the successor activity is only to be performed under particular
- circumstances.
+ circumstances. If the return value of a transition condition is true, the sequence
+ will always be traversed and the successor activity executed.
+ A JavaScript based editor is provided to add arithmetic, relational and logical operators
+ as well as string matching operators.
+
+
+
+
</li>
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 a7dc0d0..40b18ea 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
@@ -19,77 +19,161 @@
</script>
<h1>Working with Gateways</h1>
-<p>Activities performed within the context of a business process may have to execute
-application logic. This application logic is defined by a concept called application. For
-more details on applications refer to <a href="mg-basics-7.htm">Applications</a>.</p>
-<p>This section will explain how to work with applications in the <strong>Process
-Workbench</strong>.</p>
-
-<h2>Creating Applications</h2>
-<p>To create an application you can either:</p>
-<ul>
- <li>In the toolbar palette of the <a href="model-views/views-diagrams.html">diagram</a>
- select <strong>Application</strong> under <strong>Items</strong>. The application is
- created by subsequently clicking on the diagram canvas and appears also in the <strong>Outline</strong>
- view.</li>
-</ul>
-<p class="image"><img src="images/mg-create-application.png" alt=""><br />
+<p>The square in the sequence flow which represents AND and OR is called gateway.
+The Business Process Modeling perspective supports AND and OR types of gateway connections.
+You can implicitly join or split the gateway depending on the sequence flow added.
+By default, XOR gateway type is supported.
</p>
+
+
+<p>For detail information on these gateways, please refer to the chapter
+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/concepts/workflow-basics/mg-basics-6.htm">Control Flow</a>
+of the
+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/concepts/key-concepts.html">
+Concepts handbook.</a></p>
+<p>You can perform following operations on gateways:</p>
+
<ul>
- <li>Or in the <strong>Application</strong> section of the <a
- href="model-views/views-outline.html">Outline view</a> area, choose <strong>New
- Application</strong> from the pop-up menu. The created application will appear in the <strong>Outline</strong>
- view and can be dragged to the diagram canvas.</li>
-</ul>
-<p>Next, open the application properties dialog by double-clicking on the
-applications symbol. Choose an ID and a name for the application.
-Please note that IDs containing
-hyphens, blanks or dots and IDs starting with digits are not supported.
-Using the Visibility Public option, you can also specify whether you want to import applications
-by reference when referenced in another model.
- <p class="image"><img src="images/visibility.png"
- alt="General Properties of an application"> <br>
-<strong>Figure:</strong> General Properties</p>
- <p> For more information, please refer to <a href="mg-preferences.html#multipackage">
- Multi Package Modeling Preferences</a> section of <a href="mg-preferences.html">Setting @productname@ Preferences</a> chapter.
-Edit the
-application type specific properties. </p>
-
-
-<h2>Modifying Applications</h2>
-<p>To modify an application, double-click the application symbol in the <a
- href="model-views/views-outline.html">Outline view</a> or in a <a
- href="model-views/views-diagrams.html">diagram</a>. The properties dialog
- opens where you can perform your changes.</p>
-<h3>Controlling</h3>
-<p>An application provides the following controlling properties:</p>
-<ul>
- <li>Cost Center</li>
- <li>Actual Cost Per Second</li>
+ <li><a href="#add">Adding Gateways</a></li>
+ <li><a href="#use">Using Gateway Flyout Menu</a></li>
+ <li><a href="#view">Viewing and Editing Properties of Gateway</a></li>
</ul>
-<p class="image"><img src="images/mg-appl-controlling.png" alt=""> <br>
-<strong>Figure:</strong> Controlling Properties of an Application</p>
-<h3>Simulation</h3>
-<p>In this section you can specify simulation configurations, as described detailed in the chapter
- <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.simulation/html/simulation/simulation-configurations.html">
- Simulation Configurations</a>
-of the
- <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.simulation/html/simulation/toc.html">
- Developer Simulation Guide</a>.)
-<h3>Effort Planning</h3>
-<p>In this section you can set the following Process Effort properties:</p>
-<p class="image"><img src="images/application-effort-planning-props.png" alt=""> <br>
-<strong>Figure:</strong> Effort Planning Properties of an Application</p>
-<p>Please refer to the chapter <a href="process-effort-calculation.html">Project Effort Calculation</a> for
-detailed information on this functionality.</p>
-
-<h2>Deleting Applications</h2>
-<p>To delete an application, use the option <strong>Delete </strong>in the
-application's pop-up menu in a diagram. In the <strong>Outline</strong> view, use the
-corresponding option <strong>Delete</strong>.</p>
-<p>To remove an application symbol from the diagram, choose the option <strong>Delete
-Symbol</strong> in the application's pop-up menu. After this operation the application will still
-be part of the model.</p>
+
+<h2 id="add">Adding Gateways</h2>
+<p>You can add gateways from main toolbar and the flyout menus of activity, start event and gateway itself.</p>
+<p>Click the <strong>Create Gateway</strong> icon in the main toolbar and drop it to swim lanes.</p>
+<p class="image"><img src="images/cr-gate.png" alt="">
+<br>
+<strong>Figure:</strong> Create Gateway Icon from Main Toolbar</p>
+<p>OR</p>
+
+<p>Hover the mouse in proximity of already added <strong>Activity</strong> icon in swim lanes,
+click the <strong>Gateway</strong> icon in flyout menu and drop it in the swim lanes.</p>
+
+<p class="image"><img src="images/cr-gate-act.png" alt="">
+<br>
+<strong>Figure:</strong> Create Gateway from Activity Flyout Menu</p>
+
+<p>OR</p>
+
+<p>Hover the mouse in proximity of already added <strong>Start Event</strong> icon in swim lanes,
+click the <strong>Gateway</strong> icon in flyout menu and drop it in the swim lanes.</p>
+
+
+<p class="image"><img src="images/cr-gate-eve.png" alt="">
+<br>
+<strong>Figure:</strong> Create Gateway from Event Flyout Menu</p>
+
+<p>OR</p>
+<p>Hover the mouse in proximity of already added <strong>Gateway</strong> icon in swim lanes,
+click the <strong>Gateway</strong> icon in flyout menu and drop it in the swim lanes.</p>
+<p class="image"><img src="images/cr-gate-gate.png" alt="">
+<br>
+<strong>Figure:</strong> Create Gateway from Gateway Flyout Menu</p>
+
+<h2 id="use">Using Gateway Flyout Menu</h2>
+<p>The gateway flyout menu is displayed when you hover the mouse in the proximity of the gateway.</p>
+
+<p class="image"><img src="images/gateway-fly.png" alt="">
+<br>
+<strong>Figure:</strong> Gateway Flyout Menu</p>
+
+<table>
+ <tr>
+ <th>Menu Icon</th>
+ <th>Menu Option</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><img src="images/gfly-del.png"></td>
+ <td>Delete</td>
+ <td>Deletes the gateway.</td>
+ </tr>
+ <tr>
+ <td><img src="images/xor.png"></td>
+ <td>XOR Gateway</td>
+ <td>Changes the gateway icon to XOR gateway, if applicable. Click the XOR icon to change the
+ gateway type to XOR.</td>
+ </tr>
+ <tr>
+ <td><img src="images/and.png"></td>
+ <td>AND Gateway</td>
+ <td>Changes the gateway icon to AND gateway, if applicable. Click the AND icon to change the
+ gateway type to AND.</td>
+ </tr>
+ <tr>
+ <td><img src="images/end.png"></td>
+ <td>End Event</td>
+ <td>Connects the end event icon to gateway. Click the End Event icon and drop it to swim lanes.
+ </td>
+ </tr>
+ <tr>
+ <td><img src="images/gateway-icon.png"></td>
+ <td>New Gateway</td>
+ <td>Connects new gateway to existing one. Click the Gateway icon and drop it to swim lanes.</td>
+ </tr>
+ <tr>
+ <td><img src="images/activity-g.png"></td>
+ <td>New Activity</td>
+ <td>Connects activity to the gateway. Click the Activity icon and drop it to swim lanes.</td>
+ </tr>
+ <tr>
+ <td><img src="images/connect.png"></td>
+ <td>Sequence Flow</td>
+ <td>Starts a connection from the gateway. Click the Sequence Flow icon and connect it to another element.</td>
+ </tr>
+
+</table>
+
+<h2 id="view">Viewing and Editing Properties of Gateway</h2>
+<h3>General Properties</h3>
+
+<p>To view and modify the properties of gateway, perform the following steps:</p>
+
+<ol>
+ <li>Select the gateway in the swim lane.
+ 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>
+
+ <li>Specify the properties:
+ <ul>
+ <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>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:
+ <ul>
+ <li>XOR - By default, this option is selected. It indicates that gateway supports sequence flow
+ of XOR type. The gateway icon square changes to cross sign.</li>
+ <li>AND - If selected, it indicates that gateway supports sequence flow of AND type. When you select
+ this option, the gateway icon square changes to plus sign.</li>
+ </ul>
+
+ </li>
+
+ </ul></li>
+ </ol>
+<h3>Annotation</h3>
+<p>You can add and delete annotations in the gateway properties.
+Select the gateway in the swim lanes and click the <strong>Annotation</strong>
+icon displayed at top right side of the diagram canvas. </p>
+<p class="image"><img src="images/annotation-icon.png" alt=""> <br>
+<strong>Figure:</strong> Gateway - Annotation</p>
+
+<p>Add annotation in the text box and click <strong>Submit</strong>.</p>
+
+<p class="image"><img src="images/annotation.png" alt=""> <br>
+<strong>Figure:</strong> Gateway - Add Annotation</p>
+
+<p>To delete the annotation, select the annotation and click <strong>Delete</strong> <img src="images/del-annotation.png"> icon.</p>
+
+
+
+
<script language="JavaScript" type="text/javascript">
<!--
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 f56dbec..488d44a 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
@@ -147,7 +147,7 @@ Existing elements can be dragged across lanes.
<h2 id="ges">Element Gestures</h2>
<p>To work with elements, you can use following gestures.</p>
<h4>Clicking and Dragging a Element</h4>
-<p>Click on the element in the toolbar and place it in the lane.
+<p>Click on the element icon in the toolbar and place it in the lane.
Then, click on element and drag it from one lane to any another lane.
The connections
to elements remain intact.</p>