summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2013-09-13 04:55:54 (EDT)
committer Stephan Born2013-10-23 06:42:47 (EDT)
commitfa79a7699aaa7dcd4de29db7423280c42a8054f5 (patch)
tree2224a73677d7e2c13b91510c6600a0f557addba4
parent90493ff76d438f695686ce83fd7299ba75f29877 (diff)
downloadorg.eclipse.stardust.documentation-fa79a7699aaa7dcd4de29db7423280c42a8054f5.zip
org.eclipse.stardust.documentation-fa79a7699aaa7dcd4de29db7423280c42a8054f5.tar.gz
org.eclipse.stardust.documentation-fa79a7699aaa7dcd4de29db7423280c42a8054f5.tar.bz2
Jira-ID: CRNT-29911
Added details for error event git-svn-id: https://svn.csa.sungard.com/repos/ipp2/product/trunk/stardust/documentation@67262 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b Signed-off-by: Vrishali Doke <vrishali.doke@sungard.com>
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/error-bound.pngbin0 -> 16032 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-events.htm155
-rw-r--r--org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/detail-views/process-details/images/proc-hist-error.pngbin0 -> 21740 bytes
-rw-r--r--org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/detail-views/process-details/proc-history-act.html31
4 files changed, 80 insertions, 106 deletions
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/error-bound.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/error-bound.png
new file mode 100644
index 0000000..e55ceb6
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/error-bound.png
Binary files differ
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 a5c6cc2..7b7e7eb 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
@@ -561,19 +561,16 @@ The user, who has submitted the comment, only that user can delete the comment.
If the other user selects the comment or no comment is selected, the Delete icon remains in disabled state.
</li>
</ol>
-
<h2 id="weve">Working with Intermediate Events</h2>
<p>The Web-based modeler supports Intermediate events which follows BPMN 2.0 semantics.
-Intermediate Events are events that occurs after a process has been started.
+Intermediate Events are events that occur after a process has been started.
An Intermediate Event affects the flow of the process by showing where messages
and delays are expected, distributing the normal flow through exception handling.
However, an Intermediate Event does not start or directly terminate a process.
</p>
-
<p>Following sub-types are supported: </p>
<ul>
- <li>Boundary Events -
- Note that Boundary events must have an exception flow.
+ <li>Boundary Events
<ul><li>Timer
<ul>
<li>Interrupting Timer Events</li>
@@ -584,15 +581,9 @@ However, an Intermediate Event does not start or directly terminate a process.
</li></ul></li>
</ul>
</li>
- <li>Non-boundary Events - Non-boundary event is always between two activities, or gateway and activity.
- Non-Boundary Intermediate Events should have one inbound and one
- outbound sequence flow, otherwise a warning is issued during model deployment.
+ <li>Non-boundary Events
<ul>
- <li>Timer - For non-boundary timer event, the activity goes into Hibernate state
- till the time period is defined. Once the time period criteria meets, the
- next activity gets activated by completing a timer for the underline activity.
-
-
+ <li>Timer
<ul>
<li>Non-interrupting Timer Events</li>
</ul>
@@ -600,9 +591,15 @@ However, an Intermediate Event does not start or directly terminate a process.
</ul>
</li>
</ul>
-
-
-<h3>Adding Intermediate Event</h3>
+<p>You can perform following operations on intermediate events:</p>
+<ul>
+ <li><a href="#add">Adding Intermediate Events</a></li>
+ <li><a href="#do">Dos and Don'ts wrt. Boundary Event Modeling</a></li>
+ <li><a href="#use">Using Intermediate Event Flyout Menu</a></li>
+ <li><a href="#view">Viewing and Editing Properties</a></li>
+ <li><a href="#exam">Examples</a></li>
+</ul>
+<h3 id="add">Adding Intermediate Events</h3>
<p>In the toolbar, click Create Intermediate Event icon and drop it to swim lanes.
By default, non-boundary Timer event gets created.
</p>
@@ -611,26 +608,26 @@ By default, non-boundary Timer event gets created.
<h4>Adding Boundary Event</h4>
<p>To add the boundary event, click the Create Intermediate Event icon and drop it on
activity or on the boundary of an activity.</p>
-
-
<p class="image"><img src="images/add-boundary.png" alt=""> <br>
<strong>Figure:</strong> Add Boundary Event</p>
-
<p>By default, Timer boundary event gets added. You can also define Error event as boundary event.</p>
-
<p class="image"><img src="images/boundary.png" alt=""> <br>
<strong>Figure:</strong> Boundary Event</p>
-
+<p>Note that Boundary events must have an exception flow.</p>
<h4>Adding Non-boundary Events</h4>
<p>To add the non-boundary event, click the Create Intermediate Event icon and drop it on
the diagram canvas between two activities or activity and gateway. </p>
-
<p class="image"><img src="images/non-boun.png" alt=""> <br>
<strong>Figure:</strong> Non-boundary Event</p>
-
-<p>Note that only Timer event can be added as a non-boundary event.</p>
-
-<h2>Dos and Don'ts wrt. boundary event modeling (29694)</h2>
+<p>Note that only Timer event can be added as a non-boundary event.
+Non-boundary event is always between two activities, or gateway and activity.
+Non-Boundary Intermediate Events should have one inbound and one
+outbound sequence flow, otherwise a warning is issued during model deployment.
+</p>
+<p>For non-boundary timer event, the activity goes into Hibernate state
+till the time period is defined. Once the time period criteria meet, the
+next activity gets activated by completing a timer for the underline activity.</p>
+<h2 id="do">Dos and Don'ts wrt. Boundary Event Modeling</h2>
<p>Following topology rules should be followed when modeling intermediate
events in the Web-based modeler:</p>
<ul>
@@ -639,35 +636,27 @@ events in the Web-based modeler:</p>
<li>For non-interrupting boundary events, the exception flow must not be joined back
into the normal flow (which would require an OR join gateway)</li>
<li>For interrupting boundary events, neither the normal flow nor the exception
- flow must be joined back into a priorily split parallel path (AND split).
+ flow must be joined back into a prior split parallel path (AND split).
The reason is as follows: when joining the normal or exception flow
back into a priorily split parallel path it's not guaranteed that this
flow will be followed and therefore, the AND split gateway might
wait infinitely (the split semantics of interrupting boundary events are
- comparable to XOR splits). This is shown in the picture below where the activity End
+ comparable to XOR splits). This is shown in the example below where the activity End
could never be reached, if the exception flow is followed.
-
<p class="image"><img src="images/topology.png" alt=""> <br>
<strong>Figure:</strong> Events - Topology</p>
-
- </li>
-
+ </li>
</ul>
-
-<h3>Using Intermediate Event Flyout Menu</h3>
-
+<h3 id="use">Using Intermediate Event Flyout Menu</h3>
<p>The intermediate event flyout menu is displayed when you hover the mouse in the proximity of the data.
</p>
-
<p class="image"><img src="images/event-fly.png" alt=""> <br>
<strong>Figure:</strong> Intermediate Event - Flyout Menu</p>
-
<table>
<tr>
<th>Menu Icon</th>
<th>Menu Option</th>
<th>Description</th>
-
</tr>
<tr>
<td><img src="images/data-connect.png"></td>
@@ -694,14 +683,10 @@ events in the Web-based modeler:</p>
<td>Delete</td>
<td>Deletes the event.</td>
</tr>
-
</table>
-
-
-<h3>Viewing and Editing Properties</h3>
+<h3 id="view">Viewing and Editing Properties</h3>
<h4 id="genp">General Properties</h4>
<p>Following properties are supported:</p>
-
<ul>
<li><strong>UUID</strong> - A unique identifier ID gets generated as an identifier for client server communication</li>
<li><strong>ID</strong> - An ID generated automatically based on the process name.
@@ -719,19 +704,14 @@ events in the Web-based modeler:</p>
In this case, the activity instance will be aborted and the
boundary event flow will follow the exception path connected to the Boundary Event.
The Interrupting Boundary Event icon is represented in solid circles.
-
-
<p class="image"><img src="images/interrupt.png" alt=""> <br>
<strong>Figure:</strong> Interrupting Boundary Event icon - Solid Circle</p>
-
If unmarked the boundary event is non-interrupting. The activity will continue
and exception path will also be followed.
Both, the normal flow and the exception paths will continue in parallel.
The Non-interrupting Boundary Event icon is represented in broken circles.
-
- <p class="image"><img src="images/non-interrupt.png" alt=""> <br>
+ <p class="image"><img src="images/non-interrupt.png" alt=""> <br>
<strong>Figure:</strong> Non-interrupting Boundary Event icon - Broken Circle</p>
-
</li>
<li><strong>Bound/Unbound Status</strong> -
Read-only text message that describes the event association with activity as either:
@@ -755,9 +735,6 @@ The user, who has submitted the comment, only that user can delete the comment.
If the other user selects the comment or no comment is selected, the Delete icon remains in disabled state.
</li>
</ol>
-
-
-
<h4>Timer Event - Implementation</h4>
<p>This option is available only when you switch to <a href="model-views/pep-panels.html">Integrator</a> profile.</p>
<p>Note that you need to start Event Daemon when working with Timer Event.
@@ -776,9 +753,7 @@ of the <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/handbooks/ex
documentation.</p>
<p class="image"><img src="images/tbound.png" alt=""> <br>
<strong>Figure:</strong> Timer Event - Implementation</p>
-
<p>You can specify following implementation properties:</p>
-
<ul>
<li>Log Handler - Determines whether to log an audit trail log item for execution of this event</li>
<li>Interrupting - This is similar to Interrupting option of <a href="#genp">General Properties</a>. This is selected by default.
@@ -789,10 +764,8 @@ documentation.</p>
<li>Constant - Specify the number of Years, Months, Days, Hours, Seconds,
or Milliseconds for the Delay Timer. Note that Decimal input is not allowed.
1.5 days should be entered as 36 hours.
-
- <p class="image"><img src="images/constant.png" alt=""> <br>
+ <p class="image"><img src="images/constant.png" alt=""> <br>
<strong>Figure:</strong> Event Trigger - Constant</p>
-
</li>
<li>Data -
<p class="image"><img src="images/tmer-data.png" alt=""> <br>
@@ -804,15 +777,12 @@ documentation.</p>
following warnings are displayed:
<ul>
<li>A warning is displayed at the time of model deployment
-
<p class="image"><img src="images/timer-warn.png" alt=""> <br>
<strong>Figure:</strong> Warning</p>
-
</li>
<li>A warning is flashed at the time of activity activation. To view the warning message,
go to <strong>Administration</strong> perspective and open <strong>Overview</strong> panel.
The Log Entries section displays the warning:
-
<p class="image"><img src="images/log.png" alt=""> <br>
<strong>Figure:</strong> Warning</p>
</li>
@@ -830,13 +800,15 @@ implicitly set to True.</p>
implicitly set to False.</p>
<h4>Error Boundary Event - Implementation</h4>
-<p>This option is available only when you switch to <a href="model-views/pep-panels.html">Integrator</a> profile.</p>
+<p>
+This option is available only when you switch to <a href="model-views/pep-panels.html">Integrator</a> profile.
+Note that you need to start Event Daemon when working with Error Event.
+</p>
<p>The Error Boundary Events may only be Interrupting,
meaning when the event is triggered the Activity that it is bound to is aborted
and the exception path follows.
The following properties are displayed:
</p>
-
<p class="image"><img src="images/error-impl.png" alt=""> <br>
<strong>Figure:</strong> Error Event - Implementation</p>
<ul>
@@ -852,26 +824,26 @@ The following properties are displayed:
<li>Other - If selected, you can specify custom exception in the following text box</li>
<p class="image"><img src="images/otherexcep.png" alt=""> <br>
<strong>Figure:</strong> Event Trigger- Other</p>
-
+
</ul>
</li>
</ul>
<p>Note that the Automatic Binding option is not supported in the Web-based modeler. However, it is
implicitly set to True.</p>
-
<p>If there are multiple error boundary events, the exception hierarchy is observed. For example,
for Activity 1 two error boundary events are added in order say Exception and Null pointer exception.
Then, in this case warning is displayed at the time of model deployment. Note that you can either specify
super class or sub class of the exception. If you specify both then in that case an error is displayed
at the time of deployment.
</p>
-
<!-- Adding multiple timer events, error events with diff exceptions -->
<!-- 29694 -->
-<h2>Examples</h2>
+<h2 id="exam">Examples</h2>
+<p class="note"><strong>Note</strong><br>
+To execute following examples, please start Event Daemon.</p>
<h3>Interrupting Timer Boundary Event</h3>
<p>In the following example, Timer event is specified for the activity named
-<strong>ProcessActvityInTime</strong>. If the user does not complete this activity
+<strong>ProcessActivityInTime</strong>. If the user does not complete this activity
before the specified time interval,
the timer is reached and the exception flow is followed.
</p>
@@ -892,11 +864,9 @@ the timer is reached and the exception flow is followed.
<strong>Aborted</strong> and the exception flow activity named <strong>TimerExceptionFlow</strong>
is in <strong>Suspended</strong> state.
</li>
-
<p class="image"><img src="images/timer-ex.png" alt=""> <br>
<strong>Figure:</strong> Activity Overview</p>
</ol>
-
<h3>Non-interrupting Timer Boundary Event</h3>
<h4>Scenario 1</h4>
<p>In the following example, the user waits for the specified time interval so that the
@@ -921,53 +891,58 @@ normal flow is followed.</p>
<p class="image"><img src="images/non-int-sus.png" alt=""> <br>
<strong>Figure:</strong> Activity Overview</p>
-
</ol>
-
<h4>Scenario 2</h4>
-
<p>In the following scenario, the user completes the activity to which the timer event is bound before the timer is over.</p>
-
<ol>
<li>Activate the <strong>SourceActivity</strong> and complete it before the specified timer is over</li>
<li>Wait for the time out</li>
<li>Verify that boundary event transition is not followed. In
the <strong>Activity Overview</strong> panel it does not display the status of the
activity named <strong>ExceptionFlow</strong>.</li>
-
- <p class="image"><img src="images/non-int-nor.png" alt=""> <br>
+ <p class="image"><img src="images/non-int-nor.png" alt=""> <br>
<strong>Figure:</strong> Activity Overview</p>
</ol>
-
<h3>Timer Non-boundary Event</h3>
<p>In the following example, the user completes the <strong>SourceActivity</strong> and once the
-the timer is reached, the next activity executes.</p>
-
+timer is reached, the next activity executes.</p>
<ol>
<li>Create a model as shown in the following screenshot</li>
<p class="image"><img src="images/tnon-boundary.png" alt=""> <br>
<strong>Figure:</strong> Timer Non-boundary Event - Example</p>
- <li>Specify the timer</li>
+ <li>Specify the timer implementation properties</li>
<p class="image"><img src="images/nonb-nonint.png" alt=""> <br>
<strong>Figure:</strong> Timer Non-boundary Event - Implementation</p>
-
<li>Now deploy the model and switch to the <strong>Workflow Execution</strong> perspective.</li>
<li>Activate the activity named <strong>SourceActivity</strong> and complete it</li>
- <p>Note that the next activity named <strong>TargetActvity</strong> is initiated only when
+ <p>Note that the next activity named <strong>TargetActivity</strong> is initiated only when
the timer is reached.</p>
-
- <li>Open the worklist of the user to activate and complete the next activity. </li>
+ <li>Open the worklist of the user to activate and complete the next activity. </li>
<p class="image"><img src="images/work-nonb.png" alt=""> <br>
<strong>Figure:</strong> Worklist - Non-boundary Timer Event Activity</p>
</ol>
<h3>Error Boundary Event</h3>
-
-
-
-
-
-
-<script language="JavaScript" type="text/javascript">
+<p>In the following example, the user completes the activity named <strong>FirstActivity</strong>.
+Then, the application activity <strong>MessageTransformation</strong> is executed. If the general exception is
+thrown then the exception flow is followed.
+</p>
+<ol>
+ <li>Create a model as shown in the following screenshot</li>
+ <p class="image"><img src="images/error-bound.png" alt=""> <br>
+<strong>Figure:</strong> Error Boundary Event - Example</p>
+ <li>Specify the error event implementation properties</li>
+ <p class="image"><img src="images/error-impl-ex.png" alt=""> <br>
+<strong>Figure:</strong> Error Boundary Event - Implementation</p>
+ <li>Now deploy the model and switch to the <strong>Workflow Execution</strong> perspective.</li>
+ <li>Activate the activity named <strong>FirstActivity</strong> and complete it.
+ Note that the <strong>ErrorFlow</strong> activity is followed.</li>
+ <li>Switch to the <strong>Administration</strong> perspective
+ and open the <strong>Activity Overview</strong> panel. Note that the
+ <strong>MessageTransformation</strong> activity is in Aborted state.</li>
+ <p class="image"><img src="images/error-flow.png" alt=""> <br>
+<strong>Figure:</strong> Activity Overview</p>
+ </ol>
+ <script language="JavaScript" type="text/javascript">
<!--
writeFooter();
-->
diff --git a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/detail-views/process-details/images/proc-hist-error.png b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/detail-views/process-details/images/proc-hist-error.png
new file mode 100644
index 0000000..ac2e155
--- /dev/null
+++ b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/detail-views/process-details/images/proc-hist-error.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/detail-views/process-details/proc-history-act.html b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/detail-views/process-details/proc-history-act.html
index 91d4b72..79cd84a 100644
--- a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/detail-views/process-details/proc-history-act.html
+++ b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/detail-views/process-details/proc-history-act.html
@@ -349,37 +349,36 @@ assurance code(s) is displayed.</p>
<h2 id="eve">Events in Process History</h2>
<p>To view the event in Process History, the <strong>Log Handler</strong> option in the <strong>Implementation</strong> properties of
event should be selected.</p>
-<h3>Non-boundary Timer Event</h3>
-
-<p>
-The event is visible under the route activity node. The Event Details displays the Name or
+<h3>Timer Non-boundary Event</h3>
+<p>The event is visible under the route activity node. The Event Details displays the Name or
ID if a name is not specified. It also displays the start time and last modification time.
-
</p>
<p class="image"><img src="images/tnonb-prochis.png"
alt="Event"> <br>
<strong>Figure:</strong> Event Activity in Process History</p>
-
-
-<h3>Boundary Timer Event Non-interrupting</h3>
+<h3>Non-interrupting Timer Boundary Event </h3>
<p>The event is visible under the activity node to which the fired event is bound.
The Event Details displays the Name or
ID if a name is not specified. It also displays the start time and last modification time. </p>
-
<p class="image"><img src="images/tboun-nonint.png"
alt="Event"> <br>
<strong>Figure:</strong> Event Activity in Process History</p>
-
-<h3>Boundary Timer Interrupting</h3>
-
-<p><p>The event is visible under the activity node to which the fired event is bound.
+<h3>Interrupting Timer Boundary Event</h3>
+<p>The event is visible under the activity node to which the fired event is bound.
The Event Details displays the Name or
-ID if a name is not specified, followed by an arrow and the text Abort Activity. It also displays the start time and last modification time. </p></p>
-
+ID if a name is not specified, followed by an arrow and the text Abort Activity.
+It also displays the start time and last modification time. </p>
<p class="image"><img src="images/bt-int.png"
alt="Event"> <br>
<strong>Figure:</strong> Event Activity in Process History</p>
-
+<h3>Interrupting Error Event</h3>
+<p>The event is visible under the activity node to which the fired event is bound.
+The Event Details displays the Name or
+ID if a name is not specified, followed by an arrow and the text Abort Activity.
+It also displays the start time and last modification time. </p>
+<p class="image"><img src="images/proc-hist-error.png"
+ alt="Event"> <br>
+<strong>Figure:</strong> Error Event Activity in Process History</p>
<script language="JavaScript" type="text/javascript">
<!--