summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2013-03-04 07:19:37 (EST)
committer Sven Rottstock2013-03-11 07:39:23 (EDT)
commit445e1206e659d8e5a843be86ff8a7ba6b561b81a (patch)
tree2ea71e486673445714bf7cc67c8caf9efbd9926e
parenta7ca749d15e438c343e513888a039f7d5328056c (diff)
downloadorg.eclipse.stardust.documentation-445e1206e659d8e5a843be86ff8a7ba6b561b81a.zip
org.eclipse.stardust.documentation-445e1206e659d8e5a843be86ff8a7ba6b561b81a.tar.gz
org.eclipse.stardust.documentation-445e1206e659d8e5a843be86ff8a7ba6b561b81a.tar.bz2
CRNT-27834 - Camel events added
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@63446 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/file-param.pngbin11785 -> 9931 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-config.pngbin13254 -> 12775 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/mail-param.pngbin11872 -> 10060 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/msg-param.pngbin0 -> 10532 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/msgeve.pngbin0 -> 10209 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-application.htm12
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-events.htm136
7 files changed, 124 insertions, 24 deletions
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
index 45a5bb2..3065d5c 100644
--- 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
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
index e9812a9..4c183b5 100644
--- 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
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
index b3c23b9..9d5c73c 100644
--- 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
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/msg-param.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/msg-param.png
new file mode 100644
index 0000000..c811577
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/msg-param.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/msgeve.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/msgeve.png
new file mode 100644
index 0000000..694b3e8
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/msgeve.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-application.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-application.htm
index 2f2b08c..9baced6 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-application.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-application.htm
@@ -37,7 +37,7 @@ more details on applications, refer to
<ul>
<li><a href="#mt">Message Transformation Application</a></li>
<li><a href=#cam>Camel Route Application</a></li>
- <!-- <li>Web Service Application</li>-->
+ <li>Web Service Application</li>
<li><a href="#mash">UI Mashup</a></li>
</ul></li>
@@ -49,7 +49,7 @@ more details on applications, refer to
<ul>
<li>Message Transformation Application</li>
<li>Camel Route Application</li>
- <!-- <li>Web Service Application</li>-->
+ <li>Web Service Application</li>
<li>UI Mashup</li>
</ul>
<p>To create any of these applications, perform the following steps:</p>
@@ -87,7 +87,7 @@ panel. You can view and edit properties of following applications:</p>
<ul>
<li><a href="#mt">Message Transformation Application</a></li>
<li><a href="#cam">Camel Route Application</a></li>
- <!-- <li><a href="#web">Web Service Application</a></li> -->
+ <li><a href="#web">Web Service Application</a></li>
<li><a href="#mash">UI Mashup</a></li>
</ul>
@@ -524,7 +524,7 @@ press <strong>Enter</strong>.</li>
<strong>Figure:</strong> Comments</p>
</ul>
-<!--
+
<h3 id="web">Web Service Application</h3>
<p>Following properties are displayed:</p>
@@ -537,8 +537,6 @@ press <strong>Enter</strong>.</li>
<a href="model-views/pep-panels.html">Integrator</a> profile.</p>
<li>Application Name - Specify name of the application</li>
<li>Description - Specify the description</li>
-
-
<li></li>
<li></li>
<li></li>
@@ -547,7 +545,7 @@ press <strong>Enter</strong>.</li>
</ul>
- -->
+
<h3 id="cam">Camel Route Application</h3>
<p>Following properties of the camel route application need to be specified:</p>
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 b70daf9..c41e6084 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
@@ -56,7 +56,7 @@ Eclipse-based modeler do not display labels for the event. For more information,
<ul>
<li>None
<ul>
- <li><a href="#man">Manual Trigger</a>
+ <li><a href="#simpl">Manual Trigger</a>
</ul>
</li>
<li>Message
@@ -217,15 +217,78 @@ a process model using Apache Camel spring DSL. When an event is received a proce
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 default-camel-context.xml file</li>
<li>a process model</li>
</ul>
+<h3 id="defcam">Working with default-camel-context.xml</h3>
+<p>Note that to execute all the camel start events, you need the following <tt>default-camel-context.xml</tt> file.
+This file contains the camel context route configuration. This file is required when you are
+ using camel event or camel application. If you have RAD setup,
+then the <tt>default-camel-context.xml</tt> file is provided under <tt>ipp-portal/WEB-INF/config/ipp/spring</tt> folder.
+If not, then you need to create a file named <tt>default-camel-context.xml</tt> and define the required beans in it.
+</p>
-
-
-<h4 id="file">File Event</h4>
+<pre>
+&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;beans xmlns="http://www.springframework.org/schema/beans"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:camel="http://camel.apache.org/schema/spring"
+ xsi:schemaLocation="
+ http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+ http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd"&gt;
+
+ &lt;bean id="camelTriggerLoader"
+ class="org.eclipse.stardust.engine.extensions.camel.trigger.CamelTriggerLoader"&gt;
+ &lt;property name="forkingService" ref="carnotForkingService" /&gt;
+
+ &lt;property name="dataConverters"&gt;
+ &lt;list&gt;
+ &lt;ref bean="documentDataConverter" /&gt;
+ &lt;ref bean="sdtFileConverter" /&gt;
+ &lt;ref bean="docListFileConverter" /&gt;
+ &lt;/list&gt;
+ &lt;/property&gt;
+ &lt;/bean&gt;
+ &lt;bean id="structuredDataTranslator"
+ class="org.eclipse.stardust.engine.extensions.camel.util.converter.StructuredDataTranslator" /&gt;
+
+ &lt;bean id="documentDataConverter"
+ class="org.eclipse.stardust.engine.extensions.camel.converter.DocumentDataConverter"&gt;
+ &lt;property name="fromEndpoint"
+ value="org.eclipse.stardust.engine.api.runtime.FileEndpoint" /&gt;
+ &lt;property name="targetType" value="dmsDocument" /&gt;
+ &lt;/bean&gt;
+
+ &lt;bean id="sdtFileConverter"
+ class="org.eclipse.stardust.engine.extensions.camel.converter.SDTFileConverter"&gt;
+ &lt;property name="fromEndpoint"
+ value="org.eclipse.stardust.engine.api.runtime.FileEndpoint" /&gt;
+ &lt;property name="targetType" value="struct" /&gt;
+ &lt;property name="translator" ref="structuredDataTranslator" /&gt;
+ &lt;/bean&gt;
+
+ &lt;bean id="docListFileConverter"
+ class="org.eclipse.stardust.engine.extensions.camel.converter.DocumentListFileConverter"&gt;
+ &lt;property name="fromEndpoint"
+ value="org.eclipse.stardust.engine.api.runtime.FileEndpoint" /&gt;
+ &lt;property name="targetType" value="dmsDocumentList" /&gt;
+ &lt;property name="batchSize" value="2" /&gt;
+ &lt;/bean&gt;
+
+ &lt;bean id="required" class="org.apache.camel.spring.spi.SpringTransactionPolicy"&gt;
+ &lt;property name="transactionManager" ref="jtaTransactionManager" /&gt;
+ &lt;property name="propagationBehaviorName" value="PROPAGATION_REQUIRED" /&gt;
+ &lt;/bean&gt;
+
+
+ &lt;camelContext id="defaultCamelContext" trace="true"
+ xmlns="http://camel.apache.org/schema/spring"&gt;
+ &lt;/camelContext&gt;
+&lt;/bean&gt;
+</pre>
+
+
+<h3 id="file">File Event</h3>
<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>
@@ -255,7 +318,7 @@ its content is retrieved and mapped accordingly. To configure the file event, sp
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>
@@ -266,7 +329,7 @@ its content is retrieved and mapped accordingly. To configure the file event, sp
</ul>
-<h4 id="mail">E-mail Event</h4>
+<h3 id="mail">E-mail Event</h3>
<p>The email event overlay allows to start a process by receiving an incoming email,
and passing all the information contained as input data.
@@ -294,7 +357,7 @@ and passing all the information contained as input data.
<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>
@@ -306,22 +369,61 @@ and passing all the information contained as input data.
</ul>
-<h4 id="msg">Message Event</h4>
+<h3 id="msg">Message Event</h3>
<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>
+<h5>Adding Bean</h5>
+<p>You need to specify following bean details to the <a href="#defcam">default-camel-context.xml</a> file.
+
+</p>
+
+<pre>
+&lt;bean id="jmsFactory" class="org.apache.activemq.ActiveMQConnectionFactory"&gt;
+ &lt;property name="brokerURL"&gt;
+ &lt;value&gt;tcp://localhost:61616&lt;/value&gt;
+ &lt;/property&gt;
+&lt;/bean&gt;
+</pre>
+<h5>Downloading activemq Jars</h5>
+<p>Based on your JMS server, you need to download the activemq client jars. If you have RAD setup, then
+downloaded jars should be copied to <tt>ipp-portal/lib</tt> folder </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>JMS Component ID - Specify name of the JMS component to be used. Based on the bean specification in
+ the <tt>default-camel-context.xml</tt> file, you need to specify the component ID.
+ The default value is <tt>jms</tt>. 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>
+ <li>Transacted - Specifies whether to use transacted mode for sending/receiving messages using the InOnly</li>
+ <li>Preserve quality of service settings - Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages.
+ </li>
-
+
</ul></li>
</ul>
+
+
+<p class="image"><img src="images/msgeve.png" alt=""> <br>
+<strong>Figure:</strong> Message Event - Configuration</p>
+
+ <li>Parameters -
+ <ul>
+ <li>Name - By default, name is displayed as Message. This field is not editable.</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/msg-param.png" alt=""> <br>
+<strong>Figure:</strong> Message Event - Parameters</p>
+
+
+
<!--
<p>The checkboxes are defined in JMS header.</p>
@@ -329,7 +431,7 @@ event, you need to provide the following details.</p>
is already provided under the in WEB-INF/config/spring folder.
</p> -->
-<h4>Scan Event</h4>
+<h3>Scan Event</h3>
<p>Using the Scan event, you can start the process instance via Scan Tool. For more information on scan tool, please
refer to the Infinity Scan guide. Scan events are non-exclusive, which means that it is
possible to have both in one process definition, a Manual Trigger and a Scan event,
@@ -349,7 +451,7 @@ to allow process instances to be started manually and via Infinity Process Platf
<strong>Figure:</strong> Scan Event - Implementation</p>
-<h4 id="cam">Generic Camel Route Event</h4>
+<h3 id="cam">Generic Camel Route Event</h3>
<ul>
<li>Configuration -
@@ -367,10 +469,10 @@ to allow process instances to be started manually and via Infinity Process Platf
<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.
+<li>Parameters - Y
<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>
@@ -381,7 +483,7 @@ to allow process instances to be started manually and via Infinity Process Platf
-<h4 id="time">Timer Event</h4>
+<h3 id="time">Timer Event</h3>
<p>Using the Timer event you can:</p>
<ul>