summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2013-02-26 05:54:32 (EST)
committer Sven Rottstock2013-03-11 07:38:59 (EDT)
commit7cb0489cceb12f11cc5c130323713c32138d6314 (patch)
treeeea82584ee79f5867cedb3c0179dc25320e5dd4c
parent1e2353a360d7c4ec239b7503aabb5a2efd950c9c (diff)
downloadorg.eclipse.stardust.documentation-7cb0489cceb12f11cc5c130323713c32138d6314.zip
org.eclipse.stardust.documentation-7cb0489cceb12f11cc5c130323713c32138d6314.tar.gz
org.eclipse.stardust.documentation-7cb0489cceb12f11cc5c130323713c32138d6314.tar.bz2
CRNT-27834 - Added camel events implementation details
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@63242 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/file-config.pngbin0 -> 10853 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/file-param.pngbin0 -> 11785 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gen-camel-eve.pngbin0 -> 9683 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-config.pngbin0 -> 13254 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-param.pngbin0 -> 11872 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/timer-eve-config.pngbin0 -> 7383 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-events.htm196
-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
9 files changed, 193 insertions, 7 deletions
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/file-config.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/file-config.png
new file mode 100644
index 0000000..c98e44d
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/file-config.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/file-param.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/file-param.png
new file mode 100644
index 0000000..45a5bb2
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/file-param.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gen-camel-eve.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gen-camel-eve.png
new file mode 100644
index 0000000..63784fe
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gen-camel-eve.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-config.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-config.png
new file mode 100644
index 0000000..e9812a9
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-config.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-param.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-param.png
new file mode 100644
index 0000000..b3c23b9
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-param.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/timer-eve-config.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/timer-eve-config.png
new file mode 100644
index 0000000..87eee53
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/timer-eve-config.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 c918b94..276f247 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
@@ -52,6 +52,30 @@ Eclipse-based modeler do not display labels for the event. For more information,
<p class="image"><img src="images/create-statt-tool.png" alt=""> <br>
<strong>Figure:</strong> Create Start Event</p>
+<p>The Business Process Modeling perspective following types of start events:</p>
+<ul>
+ <li>None
+ <ul>
+ <li><a href="#man">Manual Trigger</a>
+ </ul>
+ </li>
+ <li>Message
+ <ul>
+ <li><a href="#file">File Event</a></li>
+ <li><a href="#mail">E-mail Event</a></li>
+ <li><a href="#msg">Message Event</a></li>
+ <li><a href="#cam">Generic Camel Route Event</a></li>
+ </ul>
+ </li>
+ <li>Timer
+ <ul>
+ <li><a href="#time">Timer Event</a></li>
+ </ul>
+ </li>
+</ul>
+
+
+
<h2 id ="adde">Adding End Event</h2>
<p>You can add End Event icon from toolbar and flyout menu of activity.</p>
@@ -178,7 +202,8 @@ in the flyout menu.</p>
Using this option, you can specify implementing event to initiate the process.</p>
<p>If you select the <strong>None</strong> option from the Event Class, then you need to specify <strong>Manual Trigger</strong>
as a start event.</p>
-<p>If you select the <strong>Message</strong> option from the Event Class, then the following implementing events are displayed.</p>
+<p>If you select the <strong>Message</strong> option from the Event Class, then the following implementing events are displayed.
+</p>
<p class="image"><img src="images/eve-impl-msg.png" alt=""> <br>
<strong>Figure:</strong> Message Event - Implementation</p>
@@ -187,18 +212,122 @@ as a start event.</p>
<p class="image"><img src="images/eve-impl-time.png" alt=""> <br>
<strong>Figure:</strong> Timer Event - Implementation</p>
+<p>The events of <strong>Message</strong> class and <strong>Timer</strong> class are the camel events that allows the users to configure camel routes from
+a process model using Apache Camel spring DSL. When an event is received a process instace is kicked-off and the data
+is mapped from the exchange message to the data. A basic solution needs to have at least:</p>
+
+<ul>
+ <li>a camel-context.xml file - This file contains the camel context route configuration. This file is required when you are
+ using camel event or camel application.</li>
+ <li>a process model</li>
+
+</ul>
-<h4>Message Event</h4>
-<p>The message event is used to receive JMS message from queue to @productname@. The required camel-context.xml file
-is already provided under the in WEB-INF/config/spring folder.
+<h4 id="file">File Event</h4>
+<p>The file event is used to configure a camel route that can detect file creation in a specific directory. When a file is created
+its content is retrieved and mapped accordingly. To configure the file event, specify the following details.</p>
+<ul>
+ <li>Configuration
+ <ul>
+ <li>File or Directory - Specify the path for a file or directory</li>
+ <li>Recursive - If a directory path is provided, if looks for files in all the sub-directories, as well.</li>
+ <li>Initial Interval - Duration before polling starts for file or directory</li>
+ <li>Repeat Interval - Duration before the next poll of the file/directory</li>
+ <li>Read Lock Behavior - To poll the files if it has exclusive read-lock on the file.
+ <ul>
+ <li>Mark File - Camel creates a marker file and then holds a lock on it.</li>
+ <li>Changed - Is using file length/modification timestamp to detect whether the file is currently being copied or not.</li>
+
+ </ul></li>
+ <li>Post Processing - Action to do after processing is finished.
+ <ul>
+ <li>Move - To move files once processing is finished</li>
+ <li>Leave - If true, the file is not moved or deleted in any way</li>
+ <li>Delete - To delete files once it is processed</li>
+ </ul></li>
+ </ul></li>
+ <p class="image"><img src="images/file-config.png" alt=""> <br>
+<strong>Figure:</strong> File Event - Configuration</p>
+
+ <li>Parameters - Using this tab users can map the data received from the incoming exchange
+ to data defined in the process model. For example, map the content of the incoming message to a primitive data.
+ <ul><li>
+ <li>Name - By default, name is displayed as Message. This field is not editable.</li>
+ <li>Direction - You can specify direction of data as In or Out.</li>
+ <li>Data Type - By default, Primitive is selected. This field is not editable.</li>
+ <li>Primitive Type - By default, Text is selected. This field is not editable.</li>
+ <li>Data - You can select primitive data defined in the current model.</li>
+
+ </ul></li>
+ <p class="image"><img src="images/file-param.png" alt=""> <br>
+<strong>Figure:</strong> File Event - Parameters</p>
+
+</ul>
+<h4 id="mail">E-mail Event</h4>
+
+<p>The email event overlay allows to start a process by receiving an incoming email,
+and passing all the information contained as input data.
</p>
+<ul>
+ <li>Configuration - Specify the mail server configurations.
+ <ul>
+ <li>Protocol - You can select between POP3 or IMAP4</li>
+ <li>Mail Server - Specify IP address of the mail server</li>
+ <li>Port - Specify port number for the mail server</li>
+ <li>Account - Specify account name of the mailbox</li>
+ <li>Password - Specify account password</li>
+ <li>Connection Timeout - Specify time period that is allowed before connection take place</li>
+ <li>Initial Delay - Specify time period before the polling starts</li>
+ <li>Unseen - Processes only unseen messages</li>
+ <li>Delete - Deletes the messages after they have been processed</li>
+ <li>Copy To - After processing a mail message, it can be copied to a mail folder specified in the adjacent text box.</li>
+ </ul>
+ </li>
+ <p class="image"><img src="images/mail-config.png" alt=""> <br>
+<strong>Figure:</strong> E-mail Event - Configuration</p>
+
+
+ <li>Parameters - You can map parameters from the mail object to a process data.
+ <ul>
+ <li>Name - By default, name is displayed as Message. This field is not editable.</li>
+ <li>Direction - You can specify direction of data as In or Out.</li>
+ <li>Data Type - By default, Primitive is selected. This field is not editable.</li>
+ <li>Primitive Type - By default, Text is selected. This field is not editable.</li>
+ <li>Data - You can select primitive data defined in the current model.</li>
+ </ul>
+ </li>
+
+ <p class="image"><img src="images/mail-param.png" alt=""> <br>
+<strong>Figure:</strong> E-mail Event - Parameters</p>
+</ul>
+
+
+<h4 id="msg">Message Event</h4>
+<p>The message event is used to configure route to receive JMS messages from a JMS broker. To configure the message
+event, you need to provide the following details.</p>
+<ul>
+ <li>Configuration
+ <ul>
+ <li>JMS Component ID - Specify name of the JMS component to be used. The default value is jms. This is a mandatory field.
+ </li>
+ <li>Queue - Specify the JMS queue name.</li>
+ <li>Client ID - Sets the JMS client ID to use.</li>
+ <li>Selector - Sets the JMS Selector, which is an SQL92 predicate that is used to filter messages within the broker.</li>
+
+
+ </ul></li>
+</ul>
+<!--
<p>The checkboxes are defined in JMS header.</p>
+ from queue to @productname@. The required camel-context.xml file
+is already provided under the in WEB-INF/config/spring folder.
+</p> -->
<h4>Scan Event</h4>
<p>Using the Scan event, you can start the process instance via Scan Tool. For more information on scan tool, please
@@ -214,12 +343,69 @@ to allow process instances to be started manually and via Infinity Process Platf
<li>Scanned Document - You can select the scanned document of the same model or other model.
The drop-down list displays the defined <strong>Document</strong> data type of the current model as well as other models.
</li>
- <li>Metadata Structure</li>
+ <li>Metadata Structure - This field displays the metadata associated with the document, if any.</li>
</ol>
<p class="image"><img src="images/scan-event.png" alt=""> <br>
<strong>Figure:</strong> Scan Event - Implementation</p>
+<h4 id="cam">Generic Camel Route Event</h4>
+
+<ul>
+ <li>Configuration -
+ <ul>
+ <li>Camel Context - You need to specify the name of camel context configuration file.
+ By default, the <tt>defaultCamelContext</tt> is
+ provided. This field is mandatory.</li>
+ <li>Route Definition - Specify a valid route configuration in this field. At runtime a route is started based on the provided configuration. </li>
+ <li>Additional Bean Specifications - You can specify spring configuration in this field.
+ At runtime the provided configuration is loaded to the spring context before the route is started.
+ The beans gets loaded only once. For example, if a bean xyz is already loaded
+ in the spring context, then Camel event won't load it again.
+ </li>
+ </ul></li>
+ <p class="image"><img src="images/gen-camel-eve.png" alt=""> <br>
+<strong>Figure:</strong> Generic Camel Route Event - Configuration</p>
+
+<li>Parameters - You can map parameters from the mail object to a process data.
+ <ul>
+ <li>Name - By default, name is displayed as Message. This field is not editable.</li>
+ <li>Direction - You can specify direction of data as In or Out.</li>
+ <li>Data Type - By default, Primitive is selected. This field is not editable.</li>
+ <li>Primitive Type - By default, Text is selected. This field is not editable.</li>
+ <li>Data - You can select primitive data defined in the current model.</li>
+ </ul>
+ </li>
+</ul>
+
+
+
+
+<h4 id="time">Timer Event</h4>
+
+<p>Using the Timer event you can:</p>
+<ul>
+ <li>start a process instance at a a specific time</li>
+ <li>start a process instance after a specific time interval</li>
+</ul>
+<p>You can specify following configuration details for timer event:</p>
+<ul>
+ <li>Configuration
+ <ul>
+ <li>Repeat Interval - If greater than 0, generate periodic events every x milliseconds.
+ </li>
+ <li>Repeat Count - Specifies a maximum limit the event should be fired. A value of zero or negative means
+ event would be fired continuously.
+ </li>
+ <li>Fixed Rate - Events take place at approximately regular intervals, separated by the specified period.
+ </li>
+ </ul></li>
+</ul>
+
+
+<p class="image"><img src="images/timer-eve-config.png" alt=""> <br>
+<strong>Figure:</strong> Timer Event - Configuration</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 fd6dec3..580fc87 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
@@ -260,7 +260,7 @@ drop the element. In that case, the following message is displayed:</p>
<h4 id="dmode">Dragging and Dropping Elements across Models</h4>
<p>Elements that are not publicly visible cannot be dragged and dropped across the models from the
My Process Models panel. If you try to drag and drop element for which the Public Visibility option is not
-selected, the following error message is displayed and the element do not get added to the process diagram canvas.</p>
+selected, the following error message is displayed and the element does not get added to the process diagram canvas.</p>
<p class="image"><img src="images/public-visiblity-no.png"
alt="Drag and Drop Elements - No Public Visibility" /> <br>
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 8d33f7c..0ba51c1 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
@@ -345,7 +345,7 @@ a relationship between models.
<p>Processes that do not have process interface defined cannot be dragged and dropped
across the models. If you try to drag and drop the process for which the process interface is not defined then
-the following message is displayed in the process diagram message area and the process do not get added to the
+the following message is displayed in the process diagram message area and the process does not get added to the
process diagram canvas:</p>
<p class="image"><img src="images/pro-dnd.png" alt=""> <br>