Montova Integrator Wiki

as400_rpg_soap

2010-03-29T11:26:42+02:00

1269853754		current
Line 1:		Line 1:
	====== Exporting RPG programs via SOAP ======		====== Exporting RPG programs via SOAP ======

-	When you combine features from the [[ml_named-pipe\|iSeries]] and [[ml_named-pipe\|SOAP]] extension packs, it is surprisingly easy to breath new life into your legacy RPG programs. Simply create a SOAP service and make it interface with your iSeries machine. Selecting an RPG can be as simple as prepending some characters by which to select the program to be executed. An example:	+	When you combine features from the [[iseries_extension_pack\|iSeries]] and [[service_soap\|SOAP]] extension packs, it is surprisingly easy to breath new life into your legacy RPG programs. Simply create a SOAP service and make it interface with your iSeries machine. Selecting an RPG can be as simple as prepending some characters by which to select the program to be executed. An example:

	<code xml>		<code xml>

auto_printing_pdfs

2010-03-29T11:26:29+02:00

1269853754		current
Line 1:		Line 1:
	====== Printing incoming PDF files ======		====== Printing incoming PDF files ======

-	Montova™ Integrator can automatically print incoming PDF files using the simple executable "pdfp.exe" (download: {{:pdfp.zip\|:pdfp.zip}}). Just execute it with the ''[[ml_named-pipe\|execute-program]]'' operation, giving it the argument "''-p''", followed by the printer to which the PDF should be printed, and the full path to the PDF.	+	Montova™ Integrator can automatically print incoming PDF files using the simple executable "pdfp.exe" (download: {{:pdfp.zip\|:pdfp.zip}}). Just execute it with the ''[[operation_execute-program\|execute-program]]'' operation, giving it the argument "''-p''", followed by the printer to which the PDF should be printed, and the full path to the PDF.

	The following monitor reads PDF files from the directory "c:\pdfs" and prints them to the "HPLJ4000" printer on 192.168.200.9. It then moves the file to the "c:\pdfs\printed" directory, as a way of archiving.		The following monitor reads PDF files from the directory "c:\pdfs" and prints them to the "HPLJ4000" printer on 192.168.200.9. It then moves the file to the "c:\pdfs\printed" directory, as a way of archiving.

broken

2009-02-16T13:27:06+02:00

1234787226		current
Line 1:		Line 1:
	===== Missing pages =====		===== Missing pages =====
-	~~ORPHANSWANTED:wanted!ssh!sftp!pgsql!brain2!wiki~~	+	~~ORPHANSWANTED:wanted!ssh!sftp!pgsql!brain2!wiki!some~~

	===== FIXME's =====		===== FIXME's =====

changelog

2012-03-28T17:50:00+02:00

1332949790		current
Line 12:		Line 12:
	\| [[Domino extension pack]] \| 4.1.0 \| 2010-07-01 \|		\| [[Domino extension pack]] \| 4.1.0 \| 2010-07-01 \|
	\| [[HL7 extension pack]] \| 4.1.0 \| - \|		\| [[HL7 extension pack]] \| 4.1.0 \| - \|
-	\| [[Internet extension pack]] \| 4.1.15 \| 2012-03-14 \|	+	\| [[Internet extension pack]] \| 4.1.15 \| 2012-03-28 \|
	\| [[iSeries extension pack]] \| 4.1.0 \| 2010-07-01 \|		\| [[iSeries extension pack]] \| 4.1.0 \| 2010-07-01 \|
	\| [[PDF extension pack]] \| 4.1.0 \| 2010-07-01 \|		\| [[PDF extension pack]] \| 4.1.0 \| 2010-07-01 \|

changing_extension

2010-03-02T09:02:16+02:00

1148456132	current
Line 1:	Line 1:
	+	====== Changing the filename extension ======

	+	When converting messages from one format to another, it might be desirable to change the filename extension as well, to reflect the new contents. For example, when converting a CSV file to some kind of XML format, the ".csv" extension should become ".xml":
	+
	+	<code xml>
	+	<extract-property scope="local" name="temp" from="${message:filename}">
	+	<regexp>(.*)\.csv</regexp>
	+	</extract-property>
	+	<set-filename>${local:temp}.xml</set-filename>
	+	</code>
	+
	+	For more information on regular expressions, see [[http://www.regular-expressions.info/tutorial.html\|this excellent tutorial]].

clustering

2010-03-02T09:02:16+02:00

1267516936		current
Line 1:		Line 1:
-	====== Clustering ======	+	===== Clustering =====

	Since: version 3.0		Since: version 3.0

compat_domino

2010-03-02T09:02:16+02:00

1228292870		current
Line 1:		Line 1:
-	==== Engine 3.9.x ====	+	====== Domino Extension Pack ======
		+
		+	===== Engine 3.9.x =====

	^ ^ Engine version ^^^^^^^^^^^^^^^^^^^^^^		^ ^ Engine version ^^^^^^^^^^^^^^^^^^^^^^
Line 10:		Line 12:
	^ 3.6.0 \| {{:question.gif}} \|		^ 3.6.0 \| {{:question.gif}} \|

-	==== Engine 3.8.x ====	+	===== Engine 3.8.x =====

	^ ^ Engine version ^^^^^^^^^		^ ^ Engine version ^^^^^^^^^
Line 21:		Line 23:
	^ 3.6.0 \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \|		^ 3.6.0 \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \| {{:no.gif}} \|

-	==== Engine 3.7.x ====	+	===== Engine 3.7.x =====

	^ ^ Engine version ^^^^^		^ ^ Engine version ^^^^^
Line 32:		Line 34:
	^ 3.6.0 \| {{:question.gif}} \| {{:question.gif}} \| {{:question.gif}} \| {{:question.gif}} \| {{:question.gif}} \|		^ 3.6.0 \| {{:question.gif}} \| {{:question.gif}} \| {{:question.gif}} \| {{:question.gif}} \| {{:question.gif}} \|

-	==== Engine 3.6.x ====	+	===== Engine 3.6.x =====

	^ ^ Engine version ^^^^		^ ^ Engine version ^^^^

compat_internet

2009-03-30T08:57:10+02:00

1228748135		current
Line 4:		Line 4:

	^ ^ Engine version ^^^^^^^^^^^^^^^^^^^^^^		^ ^ Engine version ^^^^^^^^^^^^^^^^^^^^^^
-	^ Version ^ 4.0.0 ^ 4.0.1 ^ 4.0.2 ^ 4.0.3 ^ 4.0.4 ^	+	^ Version ^ 4.0.0 ^ 4.0.1 ^ 4.0.2 ^ 4.0.3 ^ 4.0.4 ^ 4.0.5 ^
-	^ 4.0.0 \| {{:question.gif}} \| {{:question.gif}} \| {{:question.gif}} \| {{:question.gif}} \| {{:question.gif}} \|	+	^ 4.0.0 \| {{:famfamfam:e-f-g-h:error.png}}\\ SOAP service doesn't start \|\|\|\|\| {{ :yes.gif }} \|

	===== Engine 3.9.x =====		===== Engine 3.9.x =====

configuration

2011-10-25T14:50:09+02:00

1269936832		current
Line 47:		Line 47:
	close-after-get="yes\|no">...</source>		close-after-get="yes\|no">...</source>

-	<operations>...</operations>	+	<operations on-empty="yes\|no">...</operations>

	<on-success>...</on-success>		<on-success>...</on-success>

controllers

2010-12-03T13:04:46+02:00

1291377868		current
Line 9:		Line 9:
	<code xml>		<code xml>
	<controllers>		<controllers>
-	<console)controller id="some_id"/>	+	<console-controller id="some_id"/>
	</controllers>		</controllers>
	</code>		</code>
Line 20:		Line 20:
	<code xml>		<code xml>
	<controllers>		<controllers>
-	<;controller type=";mq" id="some_id">	+	<mq-controller id="some_id">
	<host>...</host>		<host>...</host>
	<port>...</port>		<port>...</port>
Line 27:		Line 27:
	<queue>...</queue>		<queue>...</queue>
	<reply-to-queue>...</reply-to-queue>		<reply-to-queue>...</reply-to-queue>
-	</controller>	+	</mq-controller>
	</controllers>		</controllers>
	</code>		</code>

cookbook

2012-02-17T10:28:10+02:00

1308300244		current
Line 15:		Line 15:
	* [[xslt2_stylevision\|Handling XSLT 2.0 output from Altova Stylevision]]		* [[xslt2_stylevision\|Handling XSLT 2.0 output from Altova Stylevision]]
	* [[emails_from_db\|Sending an e-mail to recipients listed in a database table]]		* [[emails_from_db\|Sending an e-mail to recipients listed in a database table]]
		+	* [[robust_retries\|Robustly handle retries.]]

	===== Printing =====		===== Printing =====

development_guide

2011-05-05T08:48:16+02:00

1269938306		current
Line 127:		Line 127:
	"r", // the default value if not specified		"r", // the default value if not specified
	new String[] { "r", "n" }, // the possible values		new String[] { "r", "n" }, // the possible values
-	1); // occurrence count (N/A for attributes)	+	1)); // occurrence count (N/A for attributes)

	config.addChild(UsageUtils.generateUsageConfig(		config.addChild(UsageUtils.generateUsageConfig(
Line 138:		Line 138:
	null, // the default value if not specified		null, // the default value if not specified
	null, // the possible values		null, // the possible values
-	1); // occurrence count (N/A for attributes)	+	1)); // occurrence count (N/A for attributes)

	return config;		return config;

domino_addin

2010-03-29T11:25:52+02:00

1269853756		current
Line 48:		Line 48:
	The "monitor" element has these attributes:		The "monitor" element has these attributes:

-	^ Attribute ^ Description ^ Default ^ Req? ^ [[ml_named-pipe\|Dyn]]? ^ Since ^	+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''id'' \| a unique ID (maximum 8 characters) identifying this monitor \| - \| {{:yes.gif}} \| - \| 3.6.0 \|		\| ''id'' \| a unique ID (maximum 8 characters) identifying this monitor \| - \| {{:yes.gif}} \| - \| 3.6.0 \|
	\| ''poll-interval'' \| polling interval in milliseconds \| "30000" \| - \| - \| 3.6.0 \|		\| ''poll-interval'' \| polling interval in milliseconds \| "30000" \| - \| - \| 3.6.0 \|
Line 57:		Line 57:
	The "monitor" element has these children:		The "monitor" element has these children:

-	^ Child ^ Description ^ Default ^ Req? ^ [[ml_named-pipe\|Dyn]]? ^ Since ^	+	^ Child ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''source'' \| database or view that is monitored for document changes \| - \| - \| - \| 3.6.0 \|		\| ''source'' \| database or view that is monitored for document changes \| - \| - \| - \| 3.6.0 \|
	\| ''destination'' \| MQ Series queue where notifications are stored \| - \| - \| - \| 3.6.0 \|		\| ''destination'' \| MQ Series queue where notifications are stored \| - \| - \| - \| 3.6.0 \|
Line 100:		Line 100:

	</code>		</code>
-
-

domino_extension_pack

2010-07-01T10:43:11+02:00

1277973196		current
Line 1:		Line 1:
	====== Domino Extension Pack ======		====== Domino Extension Pack ======
		+
		+	__Latest version__: 4.1.0

	The Domino extension pack contains components that allow reading and writing documents in a Lotus Domino environment.		The Domino extension pack contains components that allow reading and writing documents in a Lotus Domino environment.
Line 10:		Line 12:
	\| ''[[operation_create-domino-doc\|create-domino-doc]]'' \| maps a message to a Lotus Domino Document, using an external "map file" \| 1.0 \|		\| ''[[operation_create-domino-doc\|create-domino-doc]]'' \| maps a message to a Lotus Domino Document, using an external "map file" \| 1.0 \|
	\| ''[[operation_get-domino-doc\|get-domino-doc]]'' \| gets a Lotus Domino Document by UNID \| 3.6.0 \|		\| ''[[operation_get-domino-doc\|get-domino-doc]]'' \| gets a Lotus Domino Document by UNID \| 3.6.0 \|
		+
	==== Message locations ====		==== Message locations ====

Line 24:		Line 27:

	===== Required libraries =====		===== Required libraries =====
		+
	==== Version 4.1.0 or higher ====		==== Version 4.1.0 or higher ====

Line 38:		Line 42:

	[[compat_domino\|Compatibility matrix]]		[[compat_domino\|Compatibility matrix]]
		+
		+	=== 4.1.0 (2010-07-01) ===
		+	* [MIDOM-5] - FIXED: Call additional recycle() on Items that are being looped over for inclusion
		+	* [MIDOM-4] - IMPROVED: when exceptions are thrown, format the error message better
		+	* [MIDOM-6] - IMPROVED: extract body not in CDATA
		+	* [MIDOM-7] - IMPROVED: Allow encoding to be set for get-domino-doc, check various possible pitfalls
		+	* [MIDOM-9] - IMPROVED: more robust message location handling (port from 3.9.0)
		+	* [MIDOM-10] - IMPROVED: Avoid corrupt attachment/document retrieval when the target is being altered
		+	* [MIDOM-11] - IMPROVED: implement connection pooling
		+	* [MIDOM-1] - NEW: multi values for create-domino-doc operation
		+	* [MIDOM-12] - NEW: Allow a limit to be set for the size of retrieved items
		+	* [MIDOM-13] - NEW: Allow output to a property instead of a message in operation get-domino-doc

	=== 4.0.0 (2008-10-20) ===		=== 4.0.0 (2008-10-20) ===

dynamic

2010-03-02T09:02:16+02:00

	current
Line 1:	Line 1:
	+	====== Dynamic vs. non-dynamic configuration elements ======

	+	Dynamic configuration elements are configuration children or attributes whose value is retrieved everytime the message location or operation is executed.
	+
	+	Non-dynamic configuration elements are initialized only once:
	+
	+	* On a message location, a change to a such an element causes the message location to be closed and re-opened.
	+	* On an operation, these elements are initialized only once, when the operation is created (i.e. when a monitor is instantiated, but everytime a service is called).

emails_from_db

2010-03-29T11:25:40+02:00

1269853757		current
Line 1:		Line 1:
	===== Sending an e-mail to recipients listed in a database table =====		===== Sending an e-mail to recipients listed in a database table =====

-	The following example fetches e-mail addresses listed in a database table using the "[[ml_named-pipe\|execute-statement]]" operation. The resulting XML result set is then translated to a simple comma-separated list, stored in the local property "recipients". Before sending the e-mail using the "[[ml_named-pipe\|put]]" statement and the [[ml_named-pipe\|SMTP message location]], the previously saved message is restored, as the current message now erroneously contains the result of the database query.	+	The following example fetches e-mail addresses listed in a database table using the "[[operation_execute-statement\|execute-statement]]" operation. The resulting XML result set is then translated to a simple comma-separated list, stored in the local property "recipients". Before sending the e-mail using the "[[operation_put\|put]]" statement and the [[ml_smtp\|SMTP message location]], the previously saved message is restored, as the current message now erroneously contains the result of the database query.

	<code xml snippet.xml>		<code xml snippet.xml>

engine_pack

2010-06-22T11:21:27+02:00

1277198468		current
Line 106:		Line 106:
	\| ''[[operation_sleep\|sleep]]'' \| Sleeps for the specified time interval. \|		\| ''[[operation_sleep\|sleep]]'' \| Sleeps for the specified time interval. \|
	\| ''[[operation_ssh-call\|ssh-call]]'' \| Execute a ssh command on a remote host. \|		\| ''[[operation_ssh-call\|ssh-call]]'' \| Execute a ssh command on a remote host. \|
		+	\| ''[[operation_synchronized\|synchronized]]'' \| Runs a pipeline under protection of a lock, allowing synchronization between threads. \|

	===== Message Locations =====		===== Message Locations =====

expressions

2009-02-17T09:49:01+02:00

1234860541		current
Line 8:		Line 8:

	^ Expression ^ Description ^		^ Expression ^ Description ^
		+	\| first time \| ''true'' if this operation executes for the first time, ''false'' if not \|
	\| ${property} is null \| test if property doesn't exist \|		\| ${property} is null \| test if property doesn't exist \|
	\| ${property} == ‘’ \| " \|		\| ${property} == ‘’ \| " \|

extension_packs

2010-03-29T11:14:36+02:00

1269854076		current
Line 1:		Line 1:
-	====== Extension Packs ======	+	===== Extension Packs =====

	Extension packs extend the functionality of <montova>Integrator</montova> through new message locations, operations, service types and/or controllers. These new components usually deal with some common theme, like transforming, "intranet", "Internet" and so on.		Extension packs extend the functionality of <montova>Integrator</montova> through new message locations, operations, service types and/or controllers. These new components usually deal with some common theme, like transforming, "intranet", "Internet" and so on.

extracting_xml_encoding

2010-03-29T11:25:05+02:00

1269853759		current
Line 17:		Line 17:
	</code>		</code>

-	Now to extract the encoding of the message from the XML declaration, the operation "[[ml_named-pipe\|extract-property]]" can be used to first extract the declaration, and then the "encoding" attribute:	+	Now to extract the encoding of the message from the XML declaration, the operation "[[operation_extract-property\|extract-property]]" can be used to first extract the declaration, and then the "encoding" attribute:

	<code xml>		<code xml>

faq

2010-12-17T09:13:29+02:00

1288195083		current
Line 7:		Line 7:
	* What files do I need in the "''lib''" subdirectory?		* What files do I need in the "''lib''" subdirectory?
	* How do I get a substring of a property?		* How do I get a substring of a property?
		+	* The logs show an error "java.security.NoSuchProviderException: JCE cannot authenticate the provider BC" or "java.security.InvalidKeyException: Illegal key size". What's wrong?
	\\		\\

Line 191:		Line 192:
	</code>		</code>

		+	* The logs show an error "java.security.NoSuchProviderException: JCE cannot authenticate the provider BC" or "java.security.InvalidKeyException: Illegal key size". What's wrong?
		+	The Java Cryptography Extensions (JCE) protects its innards quite well, and you'll need to register the JCE provider included with <montova>Integrator</montova> with your JDK. To do this, find the file called "java.security" in the "jre/lib/security" folder in your JDK installation directory. Edit this file and add the BouncyCastle provider as follows:
		+
		+	<code ini>
		+	security.provider.9=org.bouncycastle.jce.provider.BouncyCastleProvider
		+	</code>
		+
		+	Finally, copy the "bcprov" and "bcmail" files from "lib/_Montova-engine-xxx/jdk1.6" to "jre/lib/ext" of your JDK installation directory.
		+
		+	The second error is also easy to solve. Just download the "JCE Unlimited Strength Jurisdiction Policy Files" from Sun at [[http://www.oracle.com/technetwork/java/javase/downloads/index.html]] and replace the original "local_policy.jar" and "US_export_policy.jar" files in the "jre/lib/security" of your JDK installation directory.

function

2010-03-02T09:02:16+02:00

	current
Line 1:	Line 1:
	+	====== Definition: Function ======
	+
	+	Using the "@" prefix instead of the "$" prefix, you can call various functions that return a dynamic value based on their argument(s).
	+
	+	Available functions include:
	+	* "''date()''": returns the current date & time based on the given format string (see documentation for Java's[[http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html\|SimpleDateFormat]])
	+	* "''random()''": returns a normally-distributed random integer between 0 and the given integer
	+	* "''currentTimeMillis()''": returns the Unix timestamp
	+
	+	The example below will set the filename of the current message to the string "request-", followed by the timestamp and a random integer between 0 and 2000:
	+
	+	<code xml>
	+	<set-filename>request-@{date('yyyyMMddHHmm')}-@{random(2000)}.txt</set-filename>
	+	</code>

hl7_extension_pack

2010-06-28T14:56:44+02:00

1269854695		current
Line 3:		Line 3:
	The HL7 extension pack contains a service with which HL7 clients can talk, and an HL7 client which can talk to an HL7 service.		The HL7 extension pack contains a service with which HL7 clients can talk, and an HL7 client which can talk to an HL7 service.

-	===== Services =====	+	===== Components =====
		+
		+	==== Services ====

	^ Name ^ Description ^		^ Name ^ Description ^
	\| ''[[service_hl7\|hl7]]'' \| "Health Level 7" service \|		\| ''[[service_hl7\|hl7]]'' \| "Health Level 7" service \|

-	===== Operations =====	+	==== Operations ====

	^ Name ^ Description ^		^ Name ^ Description ^

incubator_pack

2012-02-17T09:48:16+02:00

1329468314		current
Line 2:		Line 2:

	===== Required libraries =====		===== Required libraries =====
-
-	From [[FAQ]]:

	^ File ^ Description ^ Used by ^ For ^ On ^		^ File ^ Description ^ Used by ^ For ^ On ^

installation

2010-05-19T14:17:37+02:00

1270023196		current
Line 6:		Line 6:
	- Copy all JAR files to the lib directory.		- Copy all JAR files to the lib directory.
	- Take care of the file permissions depending on the user running the software.		- Take care of the file permissions depending on the user running the software.
		+
	===== Packs =====		===== Packs =====

Line 144:		Line 145:

	To register the service, run the "''InstallService-NT.bat''" file.		To register the service, run the "''InstallService-NT.bat''" file.
		+
		+	==== Multiple instances as separate services ====
		+
		+	Should you desire to run multiple Integrator instances as separate services, you will need to duplicate the "''InstallService-NT.bat''" and "''wrapper.conf''" for each service. E.g. for a TEST and LIVE instance, you'd first create the file "''InstallService-test.bat''" which references "''wrapper-test.conf''", which references "''configuration-test.xml''", and then do the same for "''InstallService-live.bat''", "''wrapper-live.conf''" and "''configuration-live.xml''". So this would look like this:
		+
		+	<code dos InstallService-test.bat>
		+	rem ...snip...
		+	set _WRAPPER_CONF="%_REALPATH%..\conf\wrapper-test.conf"
		+	rem ...snip...
		+	</code>
		+
		+	<code ini wrapper-test.conf>
		+	#...snip...
		+	# Application parameters
		+	wrapper.app.parameter.1=com.brain2.montova.integrator.Main
		+	wrapper.app.parameter.2=-home
		+	wrapper.app.parameter.3=..
		+	wrapper.app.parameter.4=-config
		+	wrapper.app.parameter.5=configuration-test.xml
		+	#...snip...
		+	# Name of the service
		+	wrapper.ntservice.name=MontovaIntegrator-TEST
		+
		+	# Display name of the service
		+	wrapper.ntservice.displayname=Montova Integrator (TEST)
		+
		+	# Description of the service
		+	wrapper.ntservice.description=Montova Integrator instance for the test environment
		+	</code>
		+
		+	<code dos InstallService-live.bat>
		+	rem ...snip...
		+	set _WRAPPER_CONF="%_REALPATH%..\conf\wrapper-live.conf"
		+	rem ...snip...
		+	</code>
		+
		+	<code ini wrapper-live.conf>
		+	#...snip...
		+	# Application parameters
		+	wrapper.app.parameter.1=com.brain2.montova.integrator.Main
		+	wrapper.app.parameter.2=-home
		+	wrapper.app.parameter.3=..
		+	wrapper.app.parameter.4=-config
		+	wrapper.app.parameter.5=configuration-live.xml
		+	#...snip...
		+	# Name of the service
		+	wrapper.ntservice.name=MontovaIntegrator-LIVE
		+
		+	# Display name of the service
		+	wrapper.ntservice.displayname=Montova Integrator (LIVE)
		+
		+	# Description of the service
		+	wrapper.ntservice.description=Montova Integrator instance for the live environment
		+	</code>

internet_extension_pack

2012-01-25T13:09:41+02:00

1321862254		current
Line 1:		Line 1:
	====== Internet Extension Pack ======		====== Internet Extension Pack ======

-	__Latest version__: 4.0.8 & 4.1.8	+	__Latest version__: 4.0.8 & 4.1.10

	The Internet extension pack contains operations and message location which employ the standard Internet protocols. There are components which talk POP3 and IMAP to access mailboxes, and SMTP to send out e-mails. For transferring files, there's FTP/FTPS and SFTP. And to access web services, we provide HTTP and SOAP components.		The Internet extension pack contains operations and message location which employ the standard Internet protocols. There are components which talk POP3 and IMAP to access mailboxes, and SMTP to send out e-mails. For transferring files, there's FTP/FTPS and SFTP. And to access web services, we provide HTTP and SOAP components.

iseries_extension_pack

2010-07-01T11:47:56+02:00

1277977124		current
Line 43:		Line 43:

	=== 4.0.2 (2010-02-26) ===		=== 4.0.2 (2010-02-26) ===
-	* [MIISE-7] - message desegmentation while getting messages is not working	+	* [MIISE-7] - FIXED: message desegmentation while getting messages is not working

	=== 4.0.1 (2009-04-21) ===		=== 4.0.1 (2009-04-21) ===
-	* [MIISE-2] - paramX child elements with X an integer conflicts with 4.x.x validation	+	* [MIISE-2] - FIXED: paramX child elements with X an integer conflicts with 4.x.x validation
-	* [MIISE-4] - Connection to AS400 might not be re-established if it fails at some point	+	* [MIISE-4] - FIXED: Connection to AS400 might not be re-established if it fails at some point
-	* [MIISE-5] - as-400 broker config validation for child on-failure	+	* [MIISE-5] - FIXED: "''as400-broker''" config validation for child on-failure

	=== 4.0.0 (2008-10-20) ===		=== 4.0.0 (2008-10-20) ===

iseries_integration

2010-11-16T13:24:44+02:00

1289910262		current
Line 27:		Line 27:
	</monitor>		</monitor>
	</code>		</code>
-
-	===== Physical file direct =====
-	FIXME

	===== SQL interface =====		===== SQL interface =====

killing_processes

2010-03-02T09:02:16+02:00

	current
Line 1:	Line 1:
	+	====== Killing selected OS processes ======

	+	===== Windows =====
	+
	+	Using the PsList and PsKill tools in the Microsoft PsTools package (found at the link below), Montova Integrator can be used to kill processes at specified times.
	+
	+	[[http://www.microsoft.com/technet/sysinternals/ProcessesAndThreads/PsTools.mspx]]
	+
	+	E.g. to kill a running Internet Explorer process every hour:
	+
	+	<code xml>
	+	<monitor id="kill-iexplore" schedule="0 * * * *">
	+	<operations>
	+
	+	<generate-message/>
	+
	+	<execute-program use-stdout="true">
	+	<program>c:\pstools\pslist.exe</program>
	+	</execute-program>
	+
	+	<extract-property name="pid">
	+	<regexp>iexplore\s*(\d+)</regexp>
	+	</extract-property>
	+
	+	<execute-program>
	+	<program>c:\pstools\pskill.exe</program>
	+	<param>${message:pid}</param>
	+	</execute-program>
	+
	+	</operations>
	+	</monitor>
	+	</code>

logging

2012-01-24T09:33:30+02:00

1327393988		current
Line 45:		Line 45:
	\| ''-log4j'' \| {{:no.gif\|}} \| {{:no.gif\|}} \|		\| ''-log4j'' \| {{:no.gif\|}} \| {{:no.gif\|}} \|

-	===== Disabling logging in versions prior to 4.0 ====	+	===== Disable logging in versions prior to 4.0 ====

	Prior to version 4.0, it's not possible to disable logging altogether, but minimal logging can be achieved by overriding the Log4J configuration, specifying no appenders, and a threshold of "FATAL".		Prior to version 4.0, it's not possible to disable logging altogether, but minimal logging can be achieved by overriding the Log4J configuration, specifying no appenders, and a threshold of "FATAL".

message_location

2010-03-29T11:22:07+02:00

1270025471		current
Line 12:		Line 12:
	\| ''[[ml_filesystem\|filesystem]]'' \| Read/write files from/to a local filesystem. \| [[engine pack]] \|		\| ''[[ml_filesystem\|filesystem]]'' \| Read/write files from/to a local filesystem. \| [[engine pack]] \|
	\| ''[[ml_ftp\|ftp]]'' \| Read/write files from/to a remote FTP(S) server. \| [[Internet extension pack]] \|		\| ''[[ml_ftp\|ftp]]'' \| Read/write files from/to a remote FTP(S) server. \| [[Internet extension pack]] \|
-	\| ''[[ml_http-post\|http-post]]'' \| POST data to a remote HTTP server. \| [[Internet extension pack]] \|	+	\| ''[[ml_http-get\|http-get]]'' \| Retrieve data from a remote HTTP server using the GET method. \| [[Internet extension pack]] \|
		+	\| ''[[ml_http-post\|http-post]]'' \| Send data to a remote HTTP server using the POST method. \| [[Internet extension pack]] \|
		+	\| ''[[ml_http-put\|http-put]]'' \| Send data to a remote HTTP server using the PUT method. \| [[Internet extension pack]] \|
	\| ''[[ml_imap\|imap]]'' \| Read mail messages from a remote IMAP server. \| [[Internet extension pack]] \|		\| ''[[ml_imap\|imap]]'' \| Read mail messages from a remote IMAP server. \| [[Internet extension pack]] \|
	\| ''[[ml_mqseries\|mqseries]]'' \| Read/write files from a queue on a local or remote queue manager. \| [[engine pack]] \|		\| ''[[ml_mqseries\|mqseries]]'' \| Read/write files from a queue on a local or remote queue manager. \| [[engine pack]] \|

migrating_to_version_4

2010-03-29T11:24:19+02:00

1269853762		current
Line 48:		Line 48:

	===== Other =====		===== Other =====
-	* The operation "[[ml_named-pipe\|sleep]]" no longer supports the attribute "interval". Use "time" instead.	+	* The operation "[[operation_sleep\|sleep]]" no longer supports the attribute "interval". Use "time" instead.

ml_as400-data-queue

2010-06-03T16:06:33+02:00

1269854646		current
Line 22:		Line 22:
	\| ''segment'' \| whether or not to segment if size greater max entry length? \| "false" \| - \| {{:yes.gif}} \| 3.0 \|		\| ''segment'' \| whether or not to segment if size greater max entry length? \| "false" \| - \| {{:yes.gif}} \| 3.0 \|
	\| ''desegment'' \| whether or not to desegment when keyed? \| "false" \| - \| {{:yes.gif}} \| 4.0 \|		\| ''desegment'' \| whether or not to desegment when keyed? \| "false" \| - \| {{:yes.gif}} \| 4.0 \|
-
	===== Properties =====		===== Properties =====

	^ Property ^ Description ^ Example ^ GET? ^ PUT? ^ Since ^		^ Property ^ Description ^ Example ^ GET? ^ PUT? ^ Since ^
	\| ''${message:dq.key}'' \| in case of a keyed data queue, the key for the retrieved message \| - \| {{:yes.gif}} \| {{:no.gif}} \| 1.0 \|		\| ''${message:dq.key}'' \| in case of a keyed data queue, the key for the retrieved message \| - \| {{:yes.gif}} \| {{:no.gif}} \| 1.0 \|
-	\| ''${message:dq.sender}'' \| the sender information \| - \| {{:yes.gif}} \| {{:no.gif}} \| 1.0 \|	+	\| ''${message:dq.sender-id}'' \| the sender information \| - \| {{:yes.gif}} \| {{:no.gif}} \| 1.0 \|

	===== Notes =====		===== Notes =====

ml_as400-ifs

2010-03-29T11:23:52+02:00

1269853763		current
Line 1:		Line 1:
	====== Message Location "as400-ifs" ======		====== Message Location "as400-ifs" ======

-	__Pack__: [[ml_named-pipe\|iSeries extension pack]]	+	__Pack__: [[iseries_extension_pack\|iSeries extension pack]]

	Accesses the Integrated File System (IFS) on a local/remote iSeries machine.		Accesses the Integrated File System (IFS) on a local/remote iSeries machine.
Line 7:		Line 7:
	===== Configuration =====		===== Configuration =====

-	^ Child ^ Description ^ Default ^ Req? ^ [[ml_named-pipe\|Dyn]]? ^ Since ^	+	^ Child ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''system-name'' \| hostname or IP address of remote iSeries machine \| "localhost" \| - \| - \| 1.0 \|		\| ''system-name'' \| hostname or IP address of remote iSeries machine \| "localhost" \| - \| - \| 1.0 \|
	\| ''user-id'' \| user ID of user profile to log in with \| - \| - \| - \| 1.0 \|		\| ''user-id'' \| user ID of user profile to log in with \| - \| - \| - \| 1.0 \|
Line 17:		Line 17:
	\| ''file-mask'' \| mask to determine which files to get \| - \| - \| {{ :yes.gif }} (3.0) \| 1.0 \|		\| ''file-mask'' \| mask to determine which files to get \| - \| - \| {{ :yes.gif }} (3.0) \| 1.0 \|

-	^ Attribute ^ Description ^ Default ^ Req? ^ [[ml_named-pipe\|Dyn]]? ^ Since ^	+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''overwrite'' \| overwrite if the file already exists? \| "false" \| - \| {{:yes.gif}} \| 1.0 \|		\| ''overwrite'' \| overwrite if the file already exists? \| "false" \| - \| {{:yes.gif}} \| 1.0 \|
	\| ''__file-mask__/re'' \| is file mask a regular expression? \| "true" \| - \| {{ :yes.gif }} (3.0) \| 1.0 \|		\| ''__file-mask__/re'' \| is file mask a regular expression? \| "true" \| - \| {{ :yes.gif }} (3.0) \| 1.0 \|

ml_as400-library

2010-07-22T11:15:05+02:00

1279790105		current
Line 3:		Line 3:
	__Pack__: [[iseries_extension_pack\|iSeries extension pack]]		__Pack__: [[iseries_extension_pack\|iSeries extension pack]]

-	Writes messages to a library on a local/remote iSeries machine in the form of physical files. One message translates to one physical file. Messages are split into records on record length.	+	Writes messages to a library on a local/remote iSeries machine in the form of physical files. One message translates to one physical file. The name of the pysical file is set to the message filename.
		+
		+	A message is split into records using the specified record length.

	===== Configuration =====		===== Configuration =====

ml_domino-view

2009-02-20T14:44:58+02:00

1234791470		current
Line 1:		Line 1:
	====== Message Location "domino-view" ======		====== Message Location "domino-view" ======

-	__Pack__: [[domino_extension_pack\|Domino extension pack]]	+	__Pack__: [[ml_named-pipe\|Domino extension pack]]

	Retrieves documents from a Lotus Domino View. After processing, a flag can be set to exclude the document from the View. Else, the document will be deleted.		Retrieves documents from a Lotus Domino View. After processing, a flag can be set to exclude the document from the View. Else, the document will be deleted.
Line 7:		Line 7:
	===== Configuration =====		===== Configuration =====

-	^ Child ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^	+	^ Child ^ Description ^ Default ^ Req? ^ [[ml_named-pipe\|Dyn]]? ^ Since ^
	\| ''server'' \| Lotus Domino server \| "localhost" \| - \| - \| 3.0 \|		\| ''server'' \| Lotus Domino server \| "localhost" \| - \| - \| 3.0 \|
	\| ''diiop-port'' \| DIIOP port \| "63148" \| - \| - \| 3.0 \|		\| ''diiop-port'' \| DIIOP port \| "63148" \| - \| - \| 3.0 \|
Line 19:		Line 19:
	\| ''include-fields'' \| Comma-separated list of form fields to include \| - \| - \| {{:yes.gif}} \| 3.1 \|		\| ''include-fields'' \| Comma-separated list of form fields to include \| - \| - \| {{:yes.gif}} \| 3.1 \|
	\| ''exclude-fields'' \| Comma-separated list of form fields to exclude \| - \| - \| {{:yes.gif}} \| 3.1 \|		\| ''exclude-fields'' \| Comma-separated list of form fields to exclude \| - \| - \| {{:yes.gif}} \| 3.1 \|
		+	\| ''split-multivalue'' \| split multivalues in seperated xml elements \| "false" \| - \| - \| 4.1 \|

	===== Example =====		===== Example =====

ml_filesystem

2010-03-23T13:44:29+02:00

1269348350		current
Line 20:		Line 20:
	\| ''locking'' \| try hard locking retrieved file? \| "true" \| - \| {{ :yes.gif }} (3.0) \| 3.0 \|		\| ''locking'' \| try hard locking retrieved file? \| "true" \| - \| {{ :yes.gif }} (3.0) \| 3.0 \|
	\| ''sort'' \| how to sort; one of "os", "date", "date-reverse", "name" or "name-reverse" \| "os" \| - \| {{:yes.gif}} \| 3.0 \|		\| ''sort'' \| how to sort; one of "os", "date", "date-reverse", "name" or "name-reverse" \| "os" \| - \| {{:yes.gif}} \| 3.0 \|
		+
	===== Properties =====		===== Properties =====

ml_ftp

2011-11-21T08:57:57+02:00

1321859208		current
Line 13:		Line 13:
	\| ''port'' \| TCP port \| "21" \| - \| - \| 1.0 \|		\| ''port'' \| TCP port \| "21" \| - \| - \| 1.0 \|
	\| ''ssl-mode'' \| SSL mode for FTPS servers; one of "none", "explicit" or "implicit" \| "none" \| - \| - \| 4.1.0 \|		\| ''ssl-mode'' \| SSL mode for FTPS servers; one of "none", "explicit" or "implicit" \| "none" \| - \| - \| 4.1.0 \|
-	\| ''secure-data-connection'' \| setup an encrypted data channel? \| "false" \| - \| - \| 4.1.7 \|	+	\| ''secure-data-connection'' \| setup an encrypted data channel? \| "false" \| - \| - \| 4.1.8 \|
	\| ''username'' \| user name to login \| "anonymous" \| - \| - \| 1.0 \|		\| ''username'' \| user name to login \| "anonymous" \| - \| - \| 1.0 \|
	\| ''password'' \| password to login \| - \| - \| - \| 1.0 \|		\| ''password'' \| password to login \| - \| - \| - \| 1.0 \|

ml_http-get

2010-10-12T13:19:32+02:00

1271763696		current
Line 34:		Line 34:

	E.g. the "''Content-type''" response header is available in "''${message:http.header.Content-type}''".		E.g. the "''Content-type''" response header is available in "''${message:http.header.Content-type}''".
-
	===== Example =====		===== Example =====

	<code xml>		<code xml>
-	<http-get>	+	<get>
-	<url>http://hostname:port/path/script.php</url>	+	<http-get>
-	<request-header name="login" value="A0000123"/>	+	<url>http://hostname:port/path/script.php</url>
-	</http-get>	+	<request-header name="login" value="A0000123"/>
		+	</http-get>
		+	</get>
	</code>		</code>

ml_http-post

2010-03-02T09:02:16+02:00

1271761128		current
Line 2:		Line 2:

	__Pack__: [[internet_extension_pack\|Internet extension pack]]		__Pack__: [[internet_extension_pack\|Internet extension pack]]
-
-	__Aliases__: ''http-post''

	Performs an HTTP POST to a website. The request headers, parameters/body can be set.		Performs an HTTP POST to a website. The request headers, parameters/body can be set.

ml_http-put

2010-06-24T16:43:12+02:00

1271763734		current
Line 4:		Line 4:

	Performs an HTTP PUT to store a resource on a web server.		Performs an HTTP PUT to store a resource on a web server.
-
	===== Configuration =====		===== Configuration =====

Line 23:		Line 22:
	\| ''__request-header__/name'' \| request header name \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 4.1.0 \|		\| ''__request-header__/name'' \| request header name \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 4.1.0 \|
	\| ''__request-header__/value'' \| request header value \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 4.1.0 \|		\| ''__request-header__/value'' \| request header value \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 4.1.0 \|
		+
		+	===== Trusting an HTTPS server =====
		+
		+	FIXME

	===== Properties =====		===== Properties =====

ml_imap

2010-11-16T10:27:00+02:00

1267516936		current
Line 13:		Line 13:
	\| ''password'' \| password \| - \| {{:yes.gif}} \| - \| - \|		\| ''password'' \| password \| - \| {{:yes.gif}} \| - \| - \|
	\| ''folder'' \| folder name \| "INBOX" \| - \| - \| - \|		\| ''folder'' \| folder name \| "INBOX" \| - \| - \| - \|
		+
		+	===== Properties =====
		+
		+	The metadata of the fetched message is set in the following properties:
		+
		+	^ Property ^ Description ^ Example ^ GET? ^ PUT? ^ Since ^
		+	\| ''${message:mail.folder}'' \| the folder from which this message was retrieved \| "INBOX" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.subject}'' \| the subject of the retrieved message \| "Message for you sir!" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.from}'' \| the sender of the retrieved message \| "wile@acme.com" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.to}'' \| comma-separated list of recipients of the retrieved message \| "bugs@acme.com,rrunner@acme.com" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.cc}'' \| comma-separated list of carbon-copy recipients of the retrieved message \| "tweety@acme.com" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.reply-to}'' \| the address to which the sender would like you to reply \| "coyote@acme.com" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.content-type}'' \| the MIME type of the retrieved message \| "application/pdf" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|

	===== Examples =====		===== Examples =====

ml_mqseries

2009-06-04T11:46:29+02:00

1244108789		current
Line 81:		Line 81:
	===== Data-length and maximum message size =====		===== Data-length and maximum message size =====

-	There are two factors that determine how a message will be dealt with if it exceeds a certain size: the settings of the Websphere MQ objects (specifically the queue manager, the queue itself and the connection channel) and the data-length attribute of this message location. The decision flow is as follows:	+	There are two factors that determine how a message will be dealt with if it exceeds a certain size: the settings of the Websphere MQ objects (specifically the queue manager, the queue itself and the connection channel) and the data-length child of this message location. The decision flow is as follows:
	- If the data-length child was set in the configuration, select this value		- If the data-length child was set in the configuration, select this value
	- If the data-length child was not set, the target queue is inquired for its maximum message length. If it's an alias queue, the references will be resolved until the actual queue was found. This value is used.		- If the data-length child was not set, the target queue is inquired for its maximum message length. If it's an alias queue, the references will be resolved until the actual queue was found. This value is used.

ml_named-pipe

2010-03-29T11:01:55+02:00

1269853315		current
Line 1:		Line 1:
-	====== ML: "named-pipe" ======	+	====== Message Location "named-pipe" ======

	__Pack__: [[engine_pack]]		__Pack__: [[engine_pack]]

ml_pop3

2011-01-10T08:04:39+02:00

1289908884		current
Line 3:		Line 3:
	__Pack__: [[Internet extension pack]]		__Pack__: [[Internet extension pack]]

-	Retrieve e-mail messages via the POP3 protocol.	+	Retrieve e-mail messages via the POP3 protocol. The content of the first attachment is used as message in the pipeline.

	===== Configuration =====		===== Configuration =====

ml_rabbitmq

2012-02-28T09:28:29+02:00

1329385874		current
Line 31:		Line 31:
	\| ''no-ack'' \| should a message be acknowledged? \| false \| - \| - \| 1.0 \|		\| ''no-ack'' \| should a message be acknowledged? \| false \| - \| - \| 1.0 \|
	\| ''ttl'' \| the queue's time to live \| 604800000 \| - \| - \| 1.0 \|		\| ''ttl'' \| the queue's time to live \| 604800000 \| - \| - \| 1.0 \|
		+	\| ''delivery-timeout'' \| the delivery timeout \| 0 \| - \| - \| 1.0 \|

ml_sftp

2010-12-21T10:01:59+02:00

1271767940		current
Line 9:		Line 9:
	* ''j2ssh-core.jar'' and ''j2ssh-common.jar'' from the J2SSH libraries (open source, license: [[http://en.wikipedia.org/wiki/LGPL\|LGPL]]), part of the SSHTools at [[http://sourceforge.net/projects/sshtools]]. Copyright (c) 2002-2003 Lee David Painter and Contributors.		* ''j2ssh-core.jar'' and ''j2ssh-common.jar'' from the J2SSH libraries (open source, license: [[http://en.wikipedia.org/wiki/LGPL\|LGPL]]), part of the SSHTools at [[http://sourceforge.net/projects/sshtools]]. Copyright (c) 2002-2003 Lee David Painter and Contributors.
	* ''bcprov-.jar'' and ''bcmail-.jar'' from the Bouncy Castle cryptography API (open source, license: [[http://en.wikipedia.org/wiki/LGPL\|LGPL]]-like) at [[http://www.bouncycastle.org/java.html]]. Copyright (c) 2000 - 2006 The Legion Of The Bouncy Castle.		* ''bcprov-.jar'' and ''bcmail-.jar'' from the Bouncy Castle cryptography API (open source, license: [[http://en.wikipedia.org/wiki/LGPL\|LGPL]]-like) at [[http://www.bouncycastle.org/java.html]]. Copyright (c) 2000 - 2006 The Legion Of The Bouncy Castle.
		+
	===== Configuration =====		===== Configuration =====

Line 23:		Line 24:
	\| ''process-prefix'' \| prefix to identify failed messages for local process \| - \| - \| - \| 3.0.1 \|		\| ''process-prefix'' \| prefix to identify failed messages for local process \| - \| - \| - \| 3.0.1 \|
	\| ''file-mask'' \| pattern for matching filenames \| - \| - \| {{ :yes.gif }} (3.0) \| 3.1.0 \|		\| ''file-mask'' \| pattern for matching filenames \| - \| - \| {{ :yes.gif }} (3.0) \| 3.1.0 \|
		+	\| ''provider'' \| name of class which implements SFTP functionality \| (see "Providers") \| - \| - \| 4.1.4 \|

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
Line 51:		Line 53:

	===== Locking =====		===== Locking =====
		+
	The "locking" parameter, which is set to true by default, will try to explicitly lock a file via whatever means the JDK offers. If this is not enough (i.e. files get picked up while they're being written by an external process), the "lock-extension" parameter will allow you to set to set an extension that will be used to rename the potential file. E.g. if the lock extension is ".part", a file to be picked up will be renamed to "<filename>.part". If this fails, it is assumed the file is in use.		The "locking" parameter, which is set to true by default, will try to explicitly lock a file via whatever means the JDK offers. If this is not enough (i.e. files get picked up while they're being written by an external process), the "lock-extension" parameter will allow you to set to set an extension that will be used to rename the potential file. E.g. if the lock extension is ".part", a file to be picked up will be renamed to "<filename>.part". If this fails, it is assumed the file is in use.
		+
		+	===== Providers =====
		+
		+	The Internet extension pack ships with the J2SSH library, which contains an open source component to connect to SFTP servers. However, this component is not compatible with all SFTP server instances. To alleviate this problem, an alternative is provided: the commercial library [[http://www.jscape.com/sftp/\|JScape Secure FTP Factory]]. If you put the "sftp.jar" in your "lib", it will automatically be recognized and used en lieu of the J2SSH library.
		+
		+	Should you the JScape Secure FTP Factory work for some SFTP servers, and not for other, you can use the "provider" element in your "sftp" element to explicitly use the J2SSH library. The value for this element should be set to "com.brain2.messaging.location.sftp.SFTPwJ2SSHMessageLocation". (Starting from version 4.1.4!)

ml_smb

2010-03-02T09:02:16+02:00

1268051677		current
Line 25:		Line 25:
	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''create-dupes'' \| should we create dupes? \| "true" \| - \| {{ :yes.gif }} (3.0.1) \| 1.0 \|		\| ''create-dupes'' \| should we create dupes? \| "true" \| - \| {{ :yes.gif }} (3.0.1) \| 1.0 \|
-	\| ''file-mask/re'' \| is file mask a regular expression? \| "true" \| - \| {{ :yes.gif }} (3.0.1) \| 1.0 \|	+	\| ''__file-mask__/re'' \| is file mask a regular expression? \| "true" \| - \| {{ :yes.gif }} (3.0.1) \| 1.0 \|
-	\| ''file-mask/negate'' \| negate result of file mask? \| "false" \| - \| {{ :yes.gif }} \| 4.1.0 \|	+	\| ''__file-mask__/negate'' \| negate result of file mask? \| "false" \| - \| {{ :yes.gif }} \| 4.1.0 \|
	\| ''sort'' \| how to sort; one of "os", "date", "date-reverse", "name" or "name-reverse" \| "os" \| - \| {{:yes.gif}} \| 3.0 \|		\| ''sort'' \| how to sort; one of "os", "date", "date-reverse", "name" or "name-reverse" \| "os" \| - \| {{:yes.gif}} \| 3.0 \|
	\| ''overwrite'' \| should we overwrite existing files? \| "false" \| - \| {{ :yes.gif }} \| 3.0.1 \|		\| ''overwrite'' \| should we overwrite existing files? \| "false" \| - \| {{ :yes.gif }} \| 3.0.1 \|

ml_smtp

2012-03-28T18:01:24+02:00

1332949569		current
Line 56:		Line 56:
	</code>		</code>

-	* Sending out an HTML message:	+	* Sending out an HTML message, using version 4.1.15 or later:

	<code xml>		<code xml>

monitor

2010-03-30T09:47:00+02:00

1269934423		current
Line 50:		Line 50:
	Should an error occur while during the retrieval/processing of an incoming message, the operations in the "on-failure operation pipeline" will be executed. This pipeline can be used to e.g. send alerts, or back up the message so that it can be discarded. If the source message location supports the two phase commit protocol, the monitor can either backout the current message or commit (and thereby discard) it. After this, it can either halt or continue running.		Should an error occur while during the retrieval/processing of an incoming message, the operations in the "on-failure operation pipeline" will be executed. This pipeline can be used to e.g. send alerts, or back up the message so that it can be discarded. If the source message location supports the two phase commit protocol, the monitor can either backout the current message or commit (and thereby discard) it. After this, it can either halt or continue running.

-	__Note__: If no source is present, an empty message will be sent through the main operation pipeline ((This way, applications like e.g. a heartbeat between hosts, which just needs to check some condition periodically, and thus doesn't need to fetch a message from anywhere, is accomodated.)) after the defined poll interval. If the main operation pipeline produces a message at the end of its execution, but there is no destination message location, this message is discarded.	+	If no source is present, an empty message will be sent through the main operation pipeline. This way, applications like e.g. a heartbeat between hosts, which just needs to check some condition periodically, and thus doesn't need to fetch a message from anywhere, is accomodated. If the main operation pipeline produces a message at the end of its execution, but there is no destination message location, this message is discarded.

monitor_filesystem

2011-04-08T09:38:35+02:00

1302248418		current
Line 52:		Line 52:
	</if>		</if>
	</operations>		</operations>
		+	<on-failure stop="no" discard-message="yes" />
	</monitor>		</monitor>
	</monitors>		</monitors>
	</configuration>		</configuration>
	</code>		</code>

mqseries_namedpipes

2010-03-02T09:02:16+02:00

	current
Line 1:	Line 1:
	+	====== Linking MQSeries and named pipes ======
	+
	+	This example configuration file will start 2 instances of the same monitor which will:
	+
	+	- read messages from MQSeries queue "QL.MQMLOCAL.REQ"
	+	- append a line feed character (0x0A) to the end of retrieved messages, just in case it isn't there (= kind of an end-of-file marker)
	+	- write retrieved messages on input pipes "/pipes/pipin1" (monitor "test01") and "/pipes/pipin2" (monitor "test02")
	+	- listen for the response on output pipes "/pipes/pipout1" (monitor "test01") and "/pipes/pipout2" (monitor "test02")
	+	- put the response on MQSeries queue "QL.MQMLOCAL.RESP"
	+
	+	<code xml>
	+	<?xml version="1.0" encoding="ISO-8859-1"?>
	+	<configuration>
	+	<monitors>
	+	<monitor id="test01" poll-interval="1000" log-on-get="yes" log-on-put="yes" instances="2">
	+	<source>
	+	<mqseries>
	+	<host>localhost</host>
	+	<queue-manager>MQMLOCAL</queue-manager>
	+	<queue>QL.MQMLOCAL.REQ</queue>
	+	</mqseries>
	+	</source>
	+	<operations>
	+	<set-property scope="local" name="mq.message-id">${message:mq.message-id}</set-property>
	+	<insert-data offset="${message:length}">#{0A}</insert-data>
	+	<put>
	+	<named-pipe use-nio="false">
	+	<name>/pipes/pipin${local:instance}</name>
	+	<timeout>30000</timeout>
	+	<segment-size>31950</segment-size>
	+	</named-pipe>
	+	</put>
	+	<get>
	+	<named-pipe use-nio="false">
	+	<name>/pipes/pipout${local:instance}</name>
	+	<timeout>30000</timeout>
	+	</named-pipe>
	+	</get>
	+	</operations>
	+	<on-failure stop="no" discard-message="yes"/>
	+	<destination>
	+	<mqseries>
	+	<host>localhost</host>
	+	<queue-manager>MQMLOCAL</queue-manager>
	+	<queue>QL.MQMLOCAL.RESP</queue>
	+	<correlation-id>${local:mq.message-id}</correlation-id>
	+	</mqseries>
	+	</destination>
	+	</monitor>
	+	</monitors>
	+	</configuration>
	+	</code>
	+
	+	__Note__: Because of the fact that the "get" operation overwrite the current message, thereby losing the MQ message ID needed for labelling the reponse message (using the MQ correlation ID), we need to store the MQ message ID in a local property:
	+
	+	<code xml>
	+	<set-property scope="local" name="mq.message-id">${message:mq.message-id}</set-property>
	+	</code>
	+
	+	We later re-use it as the correlation ID:
	+
	+	<code xml>
	+	<mqseries>
	+	<!-- snip -->
	+	<correlation-id>${local:mq.message-id}</correlation-id>
	+	</mqseries>
	+	</code>

mqseries_openvms_cluster

2010-03-02T09:02:16+02:00

	current
Line 1:	Line 1:
	+	====== Integrating with an MQSeries cluster on OpenVMS ======
	+
	+	Any nodes in an MQSeries cluster provides the name of the node on which the active queue manager is running in the ''MQS$QMGR_NODE'' symbol. If the node name is resolvable via DNS, we use its value directly in the ''hostname'' tag. Otherwise, we need to provide the mapping for ourselves, using the pre-pipeline, which gets executed before anything else.
	+
	+	* Using DNS:
	+
	+	<code xml>
	+	<monitor id="clustermonitor">
	+	<source>
	+	<mqseries>
	+	<hostname>${env:MQS$QMGR_NODE}</hostname>
	+	<!-- ... -->
	+	</mqseries>
	+	</source>
	+	<!-- ... -->
	+	</monitor>
	+	</code>
	+
	+	* Without using DNS:
	+
	+	<code xml>
	+	<monitor id="clustermonitor">
	+	<pre>
	+	<!-- here we map cluster node names to their IP addresses, should DNS not be available -->
	+	<switch value="${env:MQS$QMGR_NODE}">
	+	<case value="...">
	+	<set-property scope="local" name="ip" value="xxx.xxx.xxx.xxx"/>
	+	</case>
	+	<!-- more node name to node IP address mappings -->
	+	</switch>
	+	</pre>
	+	<source>
	+	<mqseries>
	+	<hostname>${local:ip}</hostname>
	+	<!-- ... -->
	+	</mqseries>
	+	</source>
	+	<!-- ... -->
	+	</monitor>
	+	</code>

notification

2010-03-02T09:02:16+02:00

1269937645		current
Line 25:		Line 25:

	ALERT < CRITICAL < EMERGENCY		ALERT < CRITICAL < EMERGENCY
-
	===== Notification via MQSeries =====		===== Notification via MQSeries =====

Line 31:		Line 30:

	<code xml>		<code xml>
-	<!-- snip -->
	<notification>		<notification>
	<providers>		<providers>
Line 48:		Line 46:
	</agents>		</agents>
	</notification>		</notification>
-	<!-- snip -->
	</code>		</code>
		+
	===== Notification via e-Mail =====		===== Notification via e-Mail =====

operation

2012-03-01T14:05:47+02:00

1277389407		current
Line 6:		Line 6:

	^ Name ^ Description ^ Pack ^		^ Name ^ Description ^ Pack ^
-	\| ''[[operation_add_to_zip\|add-to-zip]]'' \| Add message to ZIP archive. \| [[engine pack]] \|	+	\| ''[[operation_add-to-zip\|add-to-zip]]'' \| Add message to ZIP archive. \| [[engine pack]] \|
	\| ''[[operation_as400-broker\|as400-broker]]'' \| Session management for performance. \| [[iSeries extension pack]] \|		\| ''[[operation_as400-broker\|as400-broker]]'' \| Session management for performance. \| [[iSeries extension pack]] \|
	\| ''[[operation_call-as400-command\|call-as400-command]]'' \| Calls a command on a remote iSeries machine. \| [[iSeries extension pack]] \|		\| ''[[operation_call-as400-command\|call-as400-command]]'' \| Calls a command on a remote iSeries machine. \| [[iSeries extension pack]] \|

operation_add-to-zip

2012-03-01T14:04:54+02:00

	current
Line 1:	Line 1:
	+	====== Operation "add-to-zip" ======
	+
	+	__Pack__: [[engine pack]]
	+
	+	Adds the current message as a file to a ZIP archive.
	+
	+	===== Configuration =====
	+
	+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	+	\| ''file'' \| the name of the zip file you want to use (or create) \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 3.0 \|
	+
	+	^ Child ^ Description ^ Default ^ Req? ^ Dyn? ^ Since ^
	+	\| ''path'' \| path to add file to in zip file \| - \| - \| {{:yes.gif}} \| 3.0 \|
	+
	+	===== Full example =====
	+
	+	* This example looks for files in the "/tmp/zipme/" directory and adds them to the "/tmp/zipped.zip" ZIP archive:
	+
	+	<code xml>
	+	<monitor id="zipper">
	+	<source>
	+	<filesystem>
	+	<directory>/tmp/zipme/</directory>
	+	</filesystem>
	+	</source>
	+	<operations>
	+	<add-to-zip file="/tmp/zipped.zip" />
	+	</operations>
	+	</monitor>
	+	</code>

operation_as400-broker

2006-11-29T13:09:13+02:00

operation_call-as400-command

2008-04-17T10:01:48+02:00

1208419308		current
Line 15:		Line 15:
	\| ''command'' \| full command to execute \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 3.7.0 \|		\| ''command'' \| full command to execute \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 3.7.0 \|

		+	===== Properties =====
		+
		+	Messages returned by the command call have their text placed in message scope properties with names of the form as400.message.//index//, provided there is a message in the pipeline. \\
		+	For example, if two messages are returned by a specific command, these are stored in: \\
		+	${message:as400.message.0} \\
		+	${message:as400.message.1} \\

	===== Examples =====		===== Examples =====

operation_call-as400-program

2010-07-23T08:59:11+02:00

1279868292		current
Line 63:		Line 63:
	</call-as400-program>		</call-as400-program>
	</code>		</code>
-
-
	===== Examples =====		===== Examples =====

Line 77:		Line 75:
	</code>		</code>

-	* To pass 2 custom arguments of size 20 & 50 to the called program, use the "''paramX''" form:	+	* To pass 2 custom arguments of size 20 & 50 to the called program:

	<code xml>		<code xml>
	<call-as400-program pass-message="false">		<call-as400-program pass-message="false">
	<program-name>/QSYS.LIB/USER.LIB/PROGRAM.PGM</program-name>		<program-name>/QSYS.LIB/USER.LIB/PROGRAM.PGM</program-name>
-	<param1 length="20">value 1</param1>	+	<param length="20">value 1</param>
-	<param2 length="50">value 2</param2>	+	<param length="50">value 2</param>
	</call-as400-program>		</call-as400-program>
	</code>		</code>

operation_call-rfc

2008-02-20T15:08:16+02:00

1234855983		current
Line 1:		Line 1:
	====== Operation: call-rfc ======		====== Operation: call-rfc ======
		+
		+	__Pack__: [[SAP extension pack]] ≥ 3.6.0

	Executes an RFC function on a remote SAP server. The output parameters of the call are either stored as:		Executes an RFC function on a remote SAP server. The output parameters of the call are either stored as:

operation_call-sp

2010-03-02T09:02:16+02:00

1267516936		current
Line 14:		Line 14:
	\| ''nls_lang'' \| value of the NLS_LANG parameter \| - \| - \| {{:yes.gif}} \|		\| ''nls_lang'' \| value of the NLS_LANG parameter \| - \| - \| {{:yes.gif}} \|
	\| ''procedure'' \| name of the stored procedure to call \| - \| {{:yes.gif}} \| {{:yes.gif}} \|		\| ''procedure'' \| name of the stored procedure to call \| - \| {{:yes.gif}} \| {{:yes.gif}} \|
-

	^ Attribute ^ Type ^ Description ^ Default ^ Req? ^ Dyn? ^		^ Attribute ^ Type ^ Description ^ Default ^ Req? ^ Dyn? ^
	\| ''use-long-varchar'' \| boolean \| use LONGVARCHAR i.o. VARCHAR \| - \| {{:yes.gif}} \| {{:yes.gif}} \|		\| ''use-long-varchar'' \| boolean \| use LONGVARCHAR i.o. VARCHAR \| - \| {{:yes.gif}} \| {{:yes.gif}} \|

-	===== Example =====

operation_change-extension

2008-03-19T15:54:43+02:00

1212578940		current
Line 1:		Line 1:
	====== Operation "change-extension" ======		====== Operation "change-extension" ======

-	__Pack__: [[engine pack]]	+	__Pack__: [[engine pack]] ≥ 3.8.5

	Change the filename extension of the current message.		Change the filename extension of the current message.

operation_change-xml-attribute

2009-03-05T12:34:17+02:00

1236252857		current
Line 33:		Line 33:
	The interaction between these settings and their default values can be confusing, but allows for a flexible manipulation of XML attributes. Refer to the examples for some specific situations. The following chart indicates how decisions are made based on the operation settings:		The interaction between these settings and their default values can be confusing, but allows for a flexible manipulation of XML attributes. Refer to the examples for some specific situations. The following chart indicates how decisions are made based on the operation settings:

-	{{:operationchangexmlattributeflow.gif\|Flowchart}}	+	[[http://wiki.montova.com/integratorwiki/lib/exe/fetch.php?media=operationchangexmlattributeflow.gif \| Flowchart]]

	===== Encoding =====		===== Encoding =====

operation_change-xml-tag

2009-03-05T11:05:19+02:00

1236249286		current
Line 16:		Line 16:
	\| ''target-encoding'' \| Forces specific encoding for altered message \| detected encoding \| - \| {{ :yes.gif }} \| 4.1.0 \|		\| ''target-encoding'' \| Forces specific encoding for altered message \| detected encoding \| - \| {{ :yes.gif }} \| 4.1.0 \|
	\| ''index'' \| Where to place new content within target tag (ignored if overwrite is "true") \| - \| - \| {{ :yes.gif }} \| 4.1.0 \|		\| ''index'' \| Where to place new content within target tag (ignored if overwrite is "true") \| - \| - \| {{ :yes.gif }} \| 4.1.0 \|
-	\| ''pretty-print'' \| Use pretty print after change? \| "false" \| - \| {{ :yes.gif }} \| 4.1.0 \|	+	\| ''pretty-print'' \| Use pretty print after change? \| "false" \| - \| {{ :yes.gif }} \| 4.1.0 \|
	\| ''file'' \| File to get the new content from \| - \| - \| {{ :yes.gif }} \| 4.1.0 \|		\| ''file'' \| File to get the new content from \| - \| - \| {{ :yes.gif }} \| 4.1.0 \|

operation_clear-message

2010-06-22T11:04:57+02:00

1277197497		current
Line 1:		Line 1:
-	====== Operation "template" ======	+	====== Operation "clear-message" ======

	__Pack__: [[engine pack]] ≥ 4.1.0		__Pack__: [[engine pack]] ≥ 4.1.0

operation_clear-saved-messages

2010-03-09T07:20:32+02:00

1268058815		current
Line 1:		Line 1:
	====== Operation "clear-saved-messages" ======		====== Operation "clear-saved-messages" ======

-	__Since__: version 4.1.0	+	__Pack__: engine ≥ 4.1.0

	This operation clears the named saved messages created by the "[[operation_save-message\|save-message]]" operation.		This operation clears the named saved messages created by the "[[operation_save-message\|save-message]]" operation.

operation_clear

2010-06-18T12:48:38+02:00

1271863997		current
Line 4:		Line 4:

	Clears the given message location, deleting all messages. __Note__: clearing is not supported by all message locations.		Clears the given message location, deleting all messages. __Note__: clearing is not supported by all message locations.
-
	===== Configuration =====		===== Configuration =====

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''open-on-init'' \| open the message location on pipeline initialization time, instead of at run time? \| "false" \| - \| {{:yes.gif}} \| - \|		\| ''open-on-init'' \| open the message location on pipeline initialization time, instead of at run time? \| "false" \| - \| {{:yes.gif}} \| - \|
-	\| ''close-after-clear'' \| close the connection after clear \| "false" \| - \| {{ :yes.gif }} \| 1.0 \|	+	\| ''close-after-clear'' \| close the connection immediately after clearing? \| "false" \| - \| {{ :yes.gif }} \| - \|
	\| ''close-on-finish'' \| close message location when finished? \| "false" \| - \| {{:yes.gif}} \| - \|		\| ''close-on-finish'' \| close message location when finished? \| "false" \| - \| {{:yes.gif}} \| - \|
	\| ''spawn-close'' \| close message location in separate thread? \| "false" \| - \| {{:yes.gif}} \| - \|		\| ''spawn-close'' \| close message location in separate thread? \| "false" \| - \| {{:yes.gif}} \| - \|

operation_create-domino-doc

2010-06-11T13:54:23+02:00

1269346852		current
Line 9:		Line 9:

	^ Child ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Child ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''server'' \| Lotus Domino server \| "localhost" \| - \| - \| 3.6.0 \|	+	\| ''server'' \| Lotus Domino server \| "localhost" \| - \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''diiop-port'' \| DIIOP port \| "63148" \| - \| - \| 3.6.0 \|	+	\| ''diiop-port'' \| DIIOP port \| "63148" \| - \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''user'' \| Lotus Domino Internet user to log in with \| - \| {{:yes.gif}} \| - \| 3.6.0 \|	+	\| ''user'' \| Lotus Domino Internet user to log in with \| - \| {{:yes.gif}} \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''password'' \| password of user profile to log in with \| - \| {{:yes.gif}} \| - \| 3.6.0 \|	+	\| ''password'' \| password of user profile to log in with \| - \| {{:yes.gif}} \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''database'' \| database in which to create new document \| - \| {{:yes.gif}} \| - \| 3.6.0 \|	+	\| ''database'' \| database in which to create new document \| - \| {{:yes.gif}} \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''form'' \| form to be associated with new document \| - \| - \| - \| 3.6.0 \|	+	\| ''form'' \| form to be associated with new document \| - \| - \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''map'' \| full path to map file \| - \| {{:yes.gif}} \| - \| 3.6.0 \|	+	\| ''map'' \| full path to map file \| - \| {{:yes.gif}} \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|

operation_decode

2010-06-22T13:44:43+02:00

1267516936		current
Line 16:		Line 16:
	If no value is supplied, the message contents are decoded. If the attribute ''property'' isn't set, the decoded data will be written to the message contents.\\		If no value is supplied, the message contents are decoded. If the attribute ''property'' isn't set, the decoded data will be written to the message contents.\\
	The encoding attribute is only used when decoding to a property. Since a property is textual, the original text encoding of the base64-encoded message must be known to interpret the data correctly. If the data is decoded to the message instead of a property, it will be put into the message contents as uninterpreted binary data. If you wish to use the message as textual data, make sure [[operation_set-mime-type\|the mime-type has been set with the correct encoding/charset]]. This also means that if binary (non-textual) data is encoded, the decoding must be done to the message, not a property, in order to preserve the original binary content.		The encoding attribute is only used when decoding to a property. Since a property is textual, the original text encoding of the base64-encoded message must be known to interpret the data correctly. If the data is decoded to the message instead of a property, it will be put into the message contents as uninterpreted binary data. If you wish to use the message as textual data, make sure [[operation_set-mime-type\|the mime-type has been set with the correct encoding/charset]]. This also means that if binary (non-textual) data is encoded, the decoding must be done to the message, not a property, in order to preserve the original binary content.
-
	===== Codecs =====		===== Codecs =====

-	Available codecs:
	* Base64		* Base64

Line 57:		Line 55:

	* [[operation_encode\|encode]]		* [[operation_encode\|encode]]
-

operation_decrement-property

2010-06-22T09:28:21+02:00

1267516936		current
Line 6:		Line 6:

	Decrements the value for a property with a specified value.		Decrements the value for a property with a specified value.
-
	===== Configuration =====		===== Configuration =====

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''property'' \| property to decrement \| - \| - \| {{ :yes.gif }} \| 3.1.0 \|	+	\| ''name'' \| name of the property to decrement \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.1.3 \|
	\| ''scope'' \| scope of property to decrement \| "message" \| - \| {{ :yes.gif }} \| 3.1.0 \|		\| ''scope'' \| scope of property to decrement \| "message" \| - \| {{ :yes.gif }} \| 3.1.0 \|
	\| ''by'' \| value to decrement by \| "1" \| - \| {{ :yes.gif }} \| 3.1.0 \|		\| ''by'' \| value to decrement by \| "1" \| - \| {{ :yes.gif }} \| 3.1.0 \|
	\| ''float'' \| floating point? \| "false" \| - \| {{ :yes.gif }} \| 3.1.3 \|		\| ''float'' \| floating point? \| "false" \| - \| {{ :yes.gif }} \| 3.1.3 \|
-	\| ''name'' \| name of the result prop \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.1.3 \|

	===== Examples =====		===== Examples =====

operation_deflate

2008-03-19T14:54:27+02:00

1192684623	current
Line 1:	Line 1:
	+	====== Operation "deflate" ======
	+
	+	__Pack__: [[engine_pack\|engine pack]]
	+
	+	Deflate (compress) the data of a message.
	+
	+	__See also__: [[operation_inflate\|inflate]]
	+
	+	===== Configuration =====
	+
	+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	+	\| ''level'' \| compression level (see table "Compression Levels") \| "default" \| - \| {{:yes.gif}} \| 1.0 \|
	+	\| ''buffer-size'' \| size (in bytes) of memory buffer to use for deflation \| "32768" \| - \| - \| 1.0 \|
	+	\| ''nowrap'' \| enable for compatibility with PKZip \| "false" \| - \| - \| 1.0 \|
	+
	+	===== Compression Levels =====
	+
	+	^ Level ^ Description ^
	+	\| "default" \| Default compression level \|
	+	\| "bestcompression" \| Compression level for best compression \|
	+	\| "bestspeed" \| Compression level for fastest compression \|
	+
	+
	+	===== Example =====
	+
	+	Create the smallest PKZip-compatilbe compressed data:
	+	<code xml>
	+	<operations>
	+	<deflate level="bestcompression" nowrap="true"/>
	+	</operations>
	+	</code>
	+

operation_delete-data

2010-03-02T09:02:16+02:00

1205736821		current
Line 21:		Line 21:
	</code>		</code>

		+	===== See also =====
		+
		+	* [[operation_insert-data\|insert-data]]
		+	* [[operation_overwrite-data\|overwrite-data]]
		+	* [[operation_set-data\|set-data]]

operation_delete-file

2008-03-27T09:33:31+02:00

1206606811		current
Line 19:		Line 19:
	===== See also =====		===== See also =====

		+	* [[operation_move-file\|move-file]]
	* [[operation_read-file\|read-file]]		* [[operation_read-file\|read-file]]
	* [[operation_write-file\|write-file]]		* [[operation_write-file\|write-file]]

operation_divide-property

2010-06-22T09:30:13+02:00

1267516936		current
Line 6:		Line 6:

	Divide the value for a property by a specified value.		Divide the value for a property by a specified value.
-
	===== Configuration =====		===== Configuration =====

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''property'' \| property to divide \| - \| - \| {{ :yes.gif }} \| 3.1.0 \|	+	\| ''name'' \| name of the property to divide \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.1.3 \|
	\| ''scope'' \| scope of property to divide \| "message" \| - \| {{ :yes.gif }} \| 3.1.0 \|		\| ''scope'' \| scope of property to divide \| "message" \| - \| {{ :yes.gif }} \| 3.1.0 \|
	\| ''by'' \| value to divide by \| "1" \| - \| {{ :yes.gif }} \| 3.1.0 \|		\| ''by'' \| value to divide by \| "1" \| - \| {{ :yes.gif }} \| 3.1.0 \|
	\| ''float'' \| floating point? \| "false" \| - \| {{ :yes.gif }} \| 3.1.1 \|		\| ''float'' \| floating point? \| "false" \| - \| {{ :yes.gif }} \| 3.1.1 \|
-	\| ''name'' \| name of the result prop \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.1.3 \|

	===== Examples =====		===== Examples =====

operation_encode

2010-06-22T13:45:30+02:00

1277207130		current
Line 19:		Line 19:
	===== Examples =====		===== Examples =====

-	* Encode a message using Base64 to the local property "encoded-message":	+	* Encode a message using Base64:
	<code xml>		<code xml>
-	<encode codec=&quot;base64&quot; scope=&quot;local&quot; to="encoded-message"/>	+	<generate-message>The quick brown fox jumps over the lazy dog.</generate-message>
		+	<encode codec="base64"/>
		+	<!-- Resulting message should be: VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4= -->
	</code>		</code>
		+

	===== See also =====		===== See also =====

	* [[operation_decode\|decode]]		* [[operation_decode\|decode]]

operation_error

2009-02-16T11:47:46+02:00

1206609726		current
Line 2:		Line 2:

	__Pack__: [[engine pack]]		__Pack__: [[engine pack]]
		+
		+	__Aliases__: ''exception''

	Throws an exception with a configurable message. This exception can be caught within a "try" construct.		Throws an exception with a configurable message. This exception can be caught within a "try" construct.

operation_execute-program

2010-06-21T14:38:33+02:00

1267516936		current
Line 6:		Line 6:

	Runs a program on the local OS.		Runs a program on the local OS.
-
	===== Configuration =====		===== Configuration =====

Line 13:		Line 12:
	\| ''log-stdout'' \| should output written to [[http://en.wikipedia.org/wiki/Standard_streams\|standard out]] (stdout) be logged? \| "false" \| - \| {{:yes.gif}} \| 1.0 \|		\| ''log-stdout'' \| should output written to [[http://en.wikipedia.org/wiki/Standard_streams\|standard out]] (stdout) be logged? \| "false" \| - \| {{:yes.gif}} \| 1.0 \|
	\| ''log-stderr'' \| should output written to [[http://en.wikipedia.org/wiki/Standard_streams\|standard error]] (stderr) be logged? \| "false" \| - \| {{:yes.gif}} \| 1.0 \|		\| ''log-stderr'' \| should output written to [[http://en.wikipedia.org/wiki/Standard_streams\|standard error]] (stderr) be logged? \| "false" \| - \| {{:yes.gif}} \| 1.0 \|
		+	\| ''stdout-property'' \| store output written to [[http://en.wikipedia.org/wiki/Standard_streams\|standard out]] (stdout) to the named local property \| - \| - \| {{:yes.gif}} \| 4.1.0 \|
		+	\| ''stderr-property'' \| store output written to [[http://en.wikipedia.org/wiki/Standard_streams\|standard error]] (stderr) to the named local property \| - \| - \| {{:yes.gif}} \| 4.1.0 \|

	^ Child ^ Description ^ Default ^ Req? ^ Dyn? ^ Since ^		^ Child ^ Description ^ Default ^ Req? ^ Dyn? ^ Since ^
Line 18:		Line 19:
	\| ''param'' \| parameter to program; can be repeated as many times as needed \| - \| - \| - \| 1.0 \|		\| ''param'' \| parameter to program; can be repeated as many times as needed \| - \| - \| - \| 1.0 \|

-	Starting from version 4.1.0, the process return code is stored in the local property "exec.return".	+	===== Notes =====
		+	* Starting from version 4.1.0, the process return code is stored in the local property "''exec.return''".

	===== Examples =====		===== Examples =====
Line 43:		Line 45:
	</execute-program>		</execute-program>
	</code>		</code>
-

operation_execute-statement

2010-10-13T13:58:40+02:00

1283505585		current
Line 6:		Line 6:

	Execute SQL statements on database accessible via JDBC. DELETE/INSERT/UPDATE statements are supported, as well as SELECT statements which return a CSV or XML message containing the result rows.		Execute SQL statements on database accessible via JDBC. DELETE/INSERT/UPDATE statements are supported, as well as SELECT statements which return a CSV or XML message containing the result rows.
		+
		+	<note warning>
		+	When dumping to XML, the MIME character set is set to "UTF8", which is not a valid character set. You should overwrite this yourself using the "encoding" attribute:
		+
		+	<execute-statement format="xml" encoding="UTF-8">...</execute-statement>
		+	</note>
		+
	===== Configuration =====		===== Configuration =====

operation_extract-filename

2010-03-02T09:02:16+02:00

1177334909		current
Line 3:		Line 3:
	Extracts a filename from the current message, or from a property.		Extracts a filename from the current message, or from a property.

-	===== Configuration =====	+	__See also__: ''[[operation_set-filename\|set-filename]]'', ''[[operation_extract-property\|extract-property]]''

-	See [[operation_extract-property\|extract-property]].	+	===== Configuration =====

-	===== Examples =====	+	See ''[[operation_extract-property\|extract-property]]''.

-	FIXME

operation_extract-json-node

2012-02-17T09:08:40+02:00

1329466075		current
Line 1:		Line 1:
	====== Operation "extract-json-node" ======		====== Operation "extract-json-node" ======

-	__Pack__: [[Incubator custom pack]]	+	__Pack__: [[Incubator pack]]

	Extracts the value of the specified node within the message content assuming that the message content contains valid JSON content. In the case that there are multiple nodes with the same name, this method will simply return the first instance it finds.		Extracts the value of the specified node within the message content assuming that the message content contains valid JSON content. In the case that there are multiple nodes with the same name, this method will simply return the first instance it finds.

operation_extract-property

2011-09-12T14:53:29+02:00

1277383615		current
Line 106:		Line 106:

	==== Extraction method "xpath" ====		==== Extraction method "xpath" ====
		+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
		+	\| ''__xpath__/namespaces'' \| comma-separated list of namespace prefix to namespace URIs \| - \| - \| {{ :yes.gif }} \| 4.1.0 \|
		+
	* Extract the first child from the root element and store it as the local property "first-child":		* Extract the first child from the root element and store it as the local property "first-child":
	<code xml>		<code xml>
Line 113:		Line 116:
	</code>		</code>

-	==== Extraction method "regexp" ====	+	* Extract the value of the attribute "number" on the first "invoice" element under namespace "brain2", and store it as the message property "invoice-number":
-		+
-	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^	+
-	\| ''__xpath__/namespaces'' \| comma-separated list of namespace prefix to namespace URIs \| - \| - \| {{ :yes.gif }} \| 4.1.0 \|	+
-		+
-	* Extract the value of the attribute "number" on the first "invoice" element, and store it as the message property "invoice-number":	+
	<code xml>		<code xml>
-	<extract-property name="invoice-number">	+	<extract-property name="invoice-number" namespaces="brain2=http://www.brain2.com/ns1">
-	<xpath>//invoice[1]/@number</xpath>	+	<xpath>//brain2:invoice[1]/@number</xpath>
	</extract-property>		</extract-property>
	</code>		</code>

operation_extract-text-from-pdf

2008-03-05T10:21:01+02:00

1211873567		current
Line 11:		Line 11:
	\| ''to'' \| property to store text in \| - \| - \| {{:yes.gif}} \| - \|		\| ''to'' \| property to store text in \| - \| - \| {{:yes.gif}} \| - \|
	\| ''password'' \| password to open document \| - \| - \| - \| - \|		\| ''password'' \| password to open document \| - \| - \| - \| - \|
-	\| ''encoding'' \| FIXME \| message encoding \| - \| - \| - \|	+	\| ''encoding'' \| text encoding \| message encoding \| - \| - \| - \|
	\| ''sort'' \| sort by position? \| "false" \| - \| - \| - \|		\| ''sort'' \| sort by position? \| "false" \| - \| - \| - \|
	\| ''html'' \| to html? \| "false" \| - \| - \| - \|		\| ''html'' \| to html? \| "false" \| - \| - \| - \|

operation_flat2xml

2008-03-27T09:00:30+02:00

1206604854		current
Line 1:		Line 1:
	====== Operation "flat2xml" ======		====== Operation "flat2xml" ======

-	__Pack__: [[engine pack]]	+	__Pack__: [[transform_extension_pack\|Transform extension pack]]

	Convert a flat file to a xml file.		Convert a flat file to a xml file.

operation_generate-message

2010-03-02T09:02:16+02:00

1267516936		current
Line 4:		Line 4:

	Create a new, empty message.		Create a new, empty message.
-
	===== Configuration =====		===== Configuration =====

-	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^	+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''transaction'' \| message filename \| - \| - \| {{ :yes.gif }} \| 1.8 \|	+	\| ''filename'' \| filename for new message \| - \| - \| {{ :yes.gif }} \| 4.1.0 \|
-	\| ''mime-type'' \| specify mime-type \| - \| - \| {{ :yes.gif }} \| 1.8 \|	+	\| ''transaction'' \| filename for new message (alias for "filename") \| - \| - \| {{ :yes.gif }} \| 1.8 \|
-	\| ''size'' \| message size in bytes (if message data is specified size will be ignored) \| - \| - \| {{ :yes.gif }} \| 1.8 \|	+	\| ''mime-type'' \| MIME type for new message \| - \| - \| {{ :yes.gif }} \| 1.8 \|
		+	\| ''size'' \| size in bytes for new message (if message data is specified size will be ignored) \| - \| - \| {{ :yes.gif }} \| 1.8 \|

	===== Example =====		===== Example =====

operation_get-domino-doc

2010-06-11T13:56:55+02:00

operation_get-xml-encoding

2010-03-02T09:02:16+02:00

1267516936		current
Line 35:		Line 35:
	- if step 1 fails, look at "charset" parameter in MIME type, if present;		- if step 1 fails, look at "charset" parameter in MIME type, if present;
	- if step 2 fails, use "UTF-8".		- if step 2 fails, use "UTF-8".
-
	===== Examples =====		===== Examples =====

Line 45:		Line 44:
	* Retrieve encoding from an XML message to the local property "ENC", accessible thereafter via "${local:ENC}":		* Retrieve encoding from an XML message to the local property "ENC", accessible thereafter via "${local:ENC}":
	<code xml>		<code xml>
-	<get-xml-encoding scope="local" message="ENC"/>	+	<get-xml-encoding scope="local" property="ENC"/>
	</code>		</code>

operation_get

2010-06-18T11:16:05+02:00

1276851621		current
Line 11:		Line 11:
	\| ''commit-after-get'' \| commit retrieved message immediately after get operation? \| "true" \| - \| {{:yes.gif}} \| - \|		\| ''commit-after-get'' \| commit retrieved message immediately after get operation? \| "true" \| - \| {{:yes.gif}} \| - \|
	\| ''backout-after-get'' \| back out retrieved message immediately after get operation? \| "false" \| - \| {{:yes.gif}} \| - \|		\| ''backout-after-get'' \| back out retrieved message immediately after get operation? \| "false" \| - \| {{:yes.gif}} \| - \|
-	\| ''close-after-get'' \| close message location immediately after get operation? (implies "commit-after-get") \| "false" \| - \| {{:yes.gif}} \| - \|	+	\| ''close-after-get'' \| close message location immediately after get operation? (implies "''commit-after-get''") \| "false" \| - \| {{:yes.gif}} \| - \|
	\| ''close-on-finish'' \| close message location when finished? \| "false" \| - \| {{:yes.gif}} \| - \|		\| ''close-on-finish'' \| close message location when finished? \| "false" \| - \| {{:yes.gif}} \| - \|
	\| ''spawn-close'' \| close message location in separate thread? \| "false" \| - \| {{:yes.gif}} \| - \|		\| ''spawn-close'' \| close message location in separate thread? \| "false" \| - \| {{:yes.gif}} \| - \|
		+
	===== Notes ======		===== Notes ======

operation_has-json-node

2012-02-17T08:59:02+02:00

1329401229		current
Line 3:		Line 3:
	__Pack__: [[Incubator custom pack]]		__Pack__: [[Incubator custom pack]]

-	Extracts the value of the specified node within the message content assuming that the message content contains valid JSON content. In the case that there are multiple nodes with the same name, this method will simply return the first instance it finds.	+	Operation that can be used to find out if a certain node is present inside a JSON message. This operation will only search the root node by default unless you specify a parent node to find the requested node in.

	===== Configuration =====		===== Configuration =====
Line 9:		Line 9:
	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''node'' \| from what to extract the property \| - \| {{:yes.gif}} \| - \| 1.0 \|		\| ''node'' \| from what to extract the property \| - \| {{:yes.gif}} \| - \| 1.0 \|
		+	\| ''parent-node'' \| the parent node to find the requested node in \| - \| - \| - \| 1.0 \|
	\| ''scope'' \| property scope \| "message" \| - \| - \| 1.0 \|		\| ''scope'' \| property scope \| "message" \| - \| - \| 1.0 \|
	\| ''property'' \| property name \| - \| {{:yes.gif}} \| - \| 1.0 \|		\| ''property'' \| property name \| - \| {{:yes.gif}} \| - \| 1.0 \|
-	\| ''trim'' \| trim whitespaces \| false \| - \| - \| 1.0 \|
-	\| ''type'' \| data type \| - \| - \| - \| 1.0 \|
-	\| ''allow-unqouted-control-chars'' \| whether unquoted control characters should be allowed inside the value \| true \| - \| - \| 1.0 \|
-	\| ''allow-comments'' \| whether comments should be allowed inside the string value \| false \| - \| - \| 1.0 \|
-
-	===== Data Types =====
-
-	Optionally, you can specify the data type the extracted data should adhere to:
-
-	^ Data types ^ Description ^
-	\| numeric \| checked using [[http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Character.html#isDigit(char)\|isDigit(char)]] method from the java.lang.Character class \|
-	\| id \| first checks the [[http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Character.html#isJavaIdentifierStart(char)\|first character]] and continues to check the [[http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Character.html#isJavaIdentifierPart(char)\|other characters]] \|
-	\| date \| a valid date against the specified format \|
-	\| double \| a valid [[http://java.sun.com/docs/books/tutorial/java/nutsandbolts/datatypes.html\|double]] value \|
-	\| float \| a valid [[http://java.sun.com/docs/books/tutorial/java/nutsandbolts/datatypes.html\|float]] value \|
-	\| int \| a valid [[http://java.sun.com/docs/books/tutorial/java/nutsandbolts/datatypes.html\|integer]] value \|
-	\| long \| a valid [[http://java.sun.com/docs/books/tutorial/java/nutsandbolts/datatypes.html\|long]] value \|

	===== Example =====		===== Example =====
Line 39:		Line 23:
	</code>		</code>

-	The following call to extract-json-node will extract the value 'http://www.montova.com' from the JSON content and assign it to the 'url' property in the 'local' scope:	+	The following call to has-json-node will check wether the requested node 'url' is found inside the root node and assign the result to the 'url' property in the 'local' scope:

	<code xml>		<code xml>
-	<extract-json-node node="url" property="url" scope="local" />	+	<has-json-node node="url" property="url" scope="local" />
	</code>		</code>
		+
		+	The 'local:url' property will in this case contain the value 'true'

	===== See also =====		===== See also =====

	* [[operation_extract-json-node\|extract-json-node]]		* [[operation_extract-json-node\|extract-json-node]]

operation_hl7_client

2009-02-20T15:01:19+02:00

1206541592		current
Line 5:		Line 5:
	__Aliases__: ''hl7client, hl7''		__Aliases__: ''hl7client, hl7''

-	FIXME	+	===== Description =====
		+
		+	The HL7 client sends and receives messages to an HL7 service.
		+	\\ Start & stop sequence are automaticly wrapped around the request and removed from the response.
		+	\\ Start : 0x0B (ASCII 11)
		+	\\ Stop : 0x1C (ASCII 28) + 0x0D (ASCII 13)

	===== Configuration =====		===== Configuration =====

operation_http-post

2010-03-02T09:02:16+02:00

1271857187		current
Line 17:		Line 17:
	\| ''client-certificate-password'' \| client certificate password \| - \| - \| {{:yes.gif}} \| 3.6.0 \|		\| ''client-certificate-password'' \| client certificate password \| - \| - \| {{:yes.gif}} \| 3.6.0 \|
	\| ''content-type'' \| MIME type to enforce in request header \| - \| - \| {{:yes.gif}} \| 3.6.0 \|		\| ''content-type'' \| MIME type to enforce in request header \| - \| - \| {{:yes.gif}} \| 3.6.0 \|
		+	\| ''cookie-policy'' \| cookie policy (one of "default", "compatibility", "netscape", "rfc2109" or "ignoreCookies" \| - \| - \| {{:yes.gif}} \| 4.0.6 \|

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^

operation_if

2008-06-04T10:40:34+02:00

1164801929		current
Line 1:		Line 1:
	====== Operation "if" ======		====== Operation "if" ======

-	Executes two different operation pipelines depending on whether the specified test evaluates to true or false. For a list of boolean expressions, consult the "[[mi_expressions\|expressions]]" page.	+	Executes two different operation pipelines depending on whether the specified test evaluates to true or false. For a list of boolean expressions, consult the "[[expressions\|expressions]]" page.

	===== Configuration =====		===== Configuration =====

operation_ignore

2008-03-27T09:08:11+02:00

1206605291		current
Line 8:		Line 8:

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''open-on-init'' \| \| "false" \| - \| {{:yes.gif}} \| 1.0 \|	+	\| ''open-on-init'' \| open connection on init \| "false" \| - \| {{:yes.gif}} \| 1.0 \|
-	\| ''close-after-get'' \| \| "false" \| - \| {{:yes.gif}} \| 1.0 \|	+	\| ''close-after-get'' \| close connection after get \| "false" \| - \| {{:yes.gif}} \| 1.0 \|
-	\| ''count'' \| \| "0" \| - \| {{:yes.gif}} \| 1.0 \|	+	\| ''count'' \| count the number of messages \| "0" \| - \| {{:yes.gif}} \| 1.0 \|

	===== Examples =====		===== Examples =====

operation_increment-property

2010-06-22T09:29:41+02:00

1277191718		current
Line 9:		Line 9:

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''name'' \| name of the property to decrement \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.1.3 \|	+	\| ''name'' \| name of the property to increment \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.1.3 \|
	\| ''scope'' \| scope of property to increment \| "message" \| - \| {{ :yes.gif }} \| 3.1.0 \|		\| ''scope'' \| scope of property to increment \| "message" \| - \| {{ :yes.gif }} \| 3.1.0 \|
	\| ''by'' \| value to increment by \| "1" \| - \| {{ :yes.gif }} \| 3.1.0 \|		\| ''by'' \| value to increment by \| "1" \| - \| {{ :yes.gif }} \| 3.1.0 \|

operation_inflate

2008-03-19T14:50:59+02:00

1192684598	current
Line 1:	Line 1:
	+	====== Operation "inflate" ======
	+
	+	__Pack__: [[engine_pack\|engine pack]]
	+
	+	Inflate (decompress) the compressed data of a message.
	+
	+	__See also__: [[operation_deflate\|deflate]]
	+
	+	===== Configuration =====
	+
	+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	+	\| ''buffer-size'' \| size (in bytes) of memory buffer to use for deflation \| "32768" \| - \| - \| 1.0 \|
	+	\| ''nowrap'' \| enable for compatibility with PKZip \| "false" \| - \| - \| 1.0 \|
	+
	+	===== Full Example =====
	+
	+	* Pickup a file from the filesystem, decompress it and write it back to the filesystem:
	+
	+	<code xml>
	+	<?xml version="1.0" encoding="ISO-8859-1"?>
	+	<configuration>
	+	<monitors>
	+	<monitor id="inflateFile">
	+
	+	<source>
	+	<filesystem>
	+	<directory>c:\in\compressed</directory>
	+	</filesystem>
	+	</source>
	+
	+	<operations>
	+	<inflate/>
	+	</operations>
	+
	+	<destination>
	+	<filesystem>
	+	<directory>c:\in\decompressed</directory>
	+	</filesystem>
	+	</destination>
	+
	+	</monitor>
	+	</monitors>
	+	</configuration>
	+	</code>

operation_insert-data

2010-03-02T09:02:16+02:00

1205737122		current
Line 35:		Line 35:
	</code>		</code>

		+
		+	===== See also =====
		+
		+	* [[operation_delete-data\|delete-data]]
		+	* [[operation_overwrite-data\|overwrite-data]]
		+	* [[operation_set-data\|set-data]]

operation_insert-tag

2010-03-02T09:02:16+02:00

1207295077		current
Line 1:		Line 1:
	====== Operation "insert-tag" ======		====== Operation "insert-tag" ======

-	Insert an XML tag	+	__Pack__: [[XML extension pack]]
		+
		+	Insert a tag into a XML message.

	===== Configuration =====		===== Configuration =====

-	^ Attribute ^ Description ^ values ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^	+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''name'' \| name of the tag to insert \| String \| "newTag" \| - \| {{ :yes.gif }} \| 3.0 \|	+	\| ''validation'' \| XML validation is required? \| - \| - \| {{:yes.gif}} \| - \|
-	\| ''place'' \| XPath expression that will identify the parent of the inserted tab \| String \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.0 \|	+	\| ''place'' \| XPath expression for the place where to insert the XML tag \| "false" \| - \| {{:yes.gif}} \| - \|
-	\| ''validation'' \| validate xml document before inserting the message ? \| Boolean \| "no" \| - \| {{ :yes.gif }} \| 3.0 \|	+	\| ''name'' \| name of the tag \| "newTag" \| - \| {{:yes.gif}} \| - \|
-	\| ''prettyprint'' \| use pretty printing ? ( define encoding when using pretty print ) \| Boolean \| "no" \| - \| {{ :yes.gif }} \| 3.0 \|	+	\| ''targetencoding'' \| encoding of the document \| XML encoding \| - \| {{:yes.gif}} \| - \|
-	\| ''targetencoding'' \| encoding to use for the new xml file with the inserted tag \| String \| "UTF-8" \| - \| {{ :yes.gif }} \| 3.0 \|	+	\| ''prettyprint'' \| output prettier layout for the message \| "false" \| - \| {{:yes.gif}} \| - \|
		+	\| ''value'' \| value of the new XML tag \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 3.6.3 \|
		+
		+	===== Examples =====
		+
		+	* Insert tag "entry4" in XML below:
		+
		+	<code xml>

		+	<?xml version="1.0" encoding="UTF-8" ?>
		+	<basic>
		+	<entry1>value1</entry1>
		+	<entry2>value2</entry2>
		+	<extend>
		+	<entry3>value999</entry3>
		+	</extend>
		+	</basic>
		+	</code>

		+	Configuration:
		+	<code xml>
		+	<insert-tag place="/basic/extend" name="entry4" prettyprint="true" value="value567"/>
		+	</code>

-	===== Example =====	+	Result:
		+	<code xml>
		+	<?xml version="1.0" encoding="UTF-8" ?>
		+	<basic>
		+	<entry1>value1</entry1>
		+	<entry2>value2</entry2>
		+	<extend>
		+	<entry3>value999</entry3>
		+	<entry4>value567</entry4>
		+	</extend>
		+	</basic>
		+	</code>

-	FIXME

operation_insert-xml-tag

2008-04-04T09:36:55+02:00

1207295036		current
Line 4:		Line 4:

	Insert a tag into a XML message.		Insert a tag into a XML message.
		+
		+	<note>
		+	The operation "''[[operation_change-xml-tag\|change-xml-tag]]''" replaces this operation. It is a much more powerful tool for modifying your XML data.
		+	</note>

	===== Configuration =====		===== Configuration =====

operation_log-message

2008-03-21T12:04:41+02:00

1206096900		current
Line 8:		Line 8:


-	===== Configuration =====

-	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^	+	===== Configuration =====
-	\| ''level'' \| log level \| "info" \| - \| {{ :yes.gif }} \| 3.0 \|	+
-	\| ''log-content'' \| log message contents? \| "true" \| - \| {{ :yes.gif }} \| 3.0 \|	+
-	\| ''log-properties'' \| log the message properties? \| "true" \| - \| {{ :yes.gif }} \| 3.0 \|	+
-	\| ''hex'' \| log message contents in hexadecimal? \| "false" \| - \| {{ :yes.gif }} \| 3.0 \|	+
-	\| ''hex-matrix'' \| log message contents in a hexadecimal matrix? \| "false" \| - \| {{ :yes.gif }} \| 3.0 \|	+
-	\| ''encoding'' \| log message contents in the specified encoding \| - \| - \| {{ :yes.gif }} \| 3.0 \|	+
-	\| ''log-extended-data'' \| log message contents in the specified encoding \| - \| - \| {{ :yes.gif }} \| - \|	+

		+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
		+	\| ''level'' \| log level \| "info" \| - \| {{ :yes.gif }} \| 3.0 \|
		+	\| ''log-content'' \| log message contents? \| "true" \| - \| {{ :yes.gif }} \| 3.0 \|
		+	\| ''log-properties'' \| log the message properties? \| "true" \| - \| {{ :yes.gif }} \| 3.0 \|
		+	\| ''hex'' \| log message contents in hexadecimal? \| "false" \| - \| {{ :yes.gif }} \| 3.0 \|
		+	\| ''hex-matrix'' \| log message contents in a hexadecimal matrix? \| "false" \| - \| {{ :yes.gif }} \| 3.0 \|
		+	\| ''encoding'' \| log message contents in the specified encoding \| - \| - \| {{ :yes.gif }} \| 3.0 \|
		+	\| ''log-extended-data'' \| log message contents in extended data? \| "true" \| - \| {{ :yes.gif }} \| - \|
		+	\| ''string'' \| log message contents as string? \| - \| - \| {{ :yes.gif }} \| - \|

operation_log

2008-03-21T11:47:35+02:00

1206096455		current
Line 9:		Line 9:
	===== Configuration =====		===== Configuration =====

-	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^	+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''level'' \| log level \| "info" \| - \| {{ :yes.gif }} \| 3.0 \|	+	\| ''level'' \| log level \| "info" \| - \| {{ :yes.gif }} \| 3.0 \|

		+	===== Notes =====

-	===== Log Levels =====	+	* Log levels are "debug", "info", "warn", "error", "fatal" (in ascending order of severity).
-		+
-	^ Log Levels ^ Description ^	+
-	\| info \| default log level \|	+
-	\| debug \| \|	+
-	\| error \| \|	+
-	\| warn \| \|	+

	===== Example =====		===== Example =====

-	* add some text to the log	+	* Add some text to the log as a warning:
	<code xml>		<code xml>
-	<log> I want to add this text to the logging </log>	+	<log level="warn">Warning: worm-sign detected.</log>
	</code>		</code>
-

operation_lookup-property

2010-03-29T12:50:01+02:00

1269859801		current
Line 28:		Line 28:

	Properties files are parsed on first use, and cached for further calls. If the modification time of a properties file changes, that file is parsed again and the cached copy replaced.		Properties files are parsed on first use, and cached for further calls. If the modification time of a properties file changes, that file is parsed again and the cached copy replaced.
-
	===== Examples =====		===== Examples =====

Line 34:		Line 33:

	<code xml>		<code xml>
-	<lookup-property scope="local" name="type" key="my_type" files="user.properties,default.properties"/>	+	<lookup-property scope="local" name="type" key="my_type" files="user.properties,system.properties"/>
	</code>		</code>

operation_loop-property

2008-03-19T14:40:54+02:00

1205934054		current
Line 1:		Line 1:
	====== Operation "increment-property" ======		====== Operation "increment-property" ======

-	__Pack__: [[engine_pack\|engine pack]]	+	__Pack__: [[engine pack]]

	Loops over a set of values to set a property’s value. On first execution, the property is set to the first value, on the second execution to the second value, and so on. After the last value was used, the cycle restarts.		Loops over a set of values to set a property’s value. On first execution, the property is set to the first value, on the second execution to the second value, and so on. After the last value was used, the cycle restarts.
Line 25:		Line 25:
	</loop-property>		</loop-property>
	</code>		</code>
		+
		+	===== See also =====
		+
		+	* [[operation_extract-property\|extract-property]]
		+	* [[operation_remove-property\|remove-property]]
		+	* [[operation_rename-property\|rename-property]]
		+	* [[operation_set-property\|set-property]]

operation_mapforce-transform

2010-03-02T09:02:16+02:00

1274344449		current
Line 115:		Line 115:

	Next, create your .JAR file using the "''ant package''" command from a command prompt. You can rename the resulting "''package.jar''" file to a more descriptive filename.		Next, create your .JAR file using the "''ant package''" command from a command prompt. You can rename the resulting "''package.jar''" file to a more descriptive filename.
		+
		+	===== MapForce & JDBC =====
		+
		+	The JDBC settings set in MapForce take precedence over those in your Integrator configuration. So if you want to set these at runtime, just eave the JDBC settings in MapForce empty.

	===== MapForce 2010 =====		===== MapForce 2010 =====

operation_merge-pdf

2010-03-02T09:02:16+02:00

1208866045		current
Line 22:		Line 22:

	===== Full Example =====		===== Full Example =====
-
-	FIXME This example is not yet finished!

	This monitor is triggered by a trigger file in the directory "/var/trigger/". The trigger message contains the directory where to locate the PDF files to be merged into 1 big PDF file.		This monitor is triggered by a trigger file in the directory "/var/trigger/". The trigger message contains the directory where to locate the PDF files to be merged into 1 big PDF file.
		+
	<code xml>		<code xml>
	<monitor id="test">		<monitor id="test">
Line 50:		Line 49:
	</get>		</get>

-	<!-- if a file was read, merge it with the	+	<!-- if a file was read, write it to a temporary file, and merge it -->
	<if test="message !is null">		<if test="message !is null">
	<true>		<true>
		+	<write-file path="/var/inbox/temp/new.pdf"/>
	<merge-pdf>		<merge-pdf>
	<source>/var/inbox/temp/merge.pdf</source>		<source>/var/inbox/temp/merge.pdf</source>
		+	<source>/var/inbox/temp/new.pdf</source>
	</merge-pdf>		</merge-pdf>
	<write-file path="/var/inbox/temp/merge.pdf"/>		<write-file path="/var/inbox/temp/merge.pdf"/>

operation_move-file

2008-05-28T10:40:04+02:00

1211964558		current
Line 23:		Line 23:

	* [[operation_delete-file\|delete-file]]		* [[operation_delete-file\|delete-file]]
-	* [[operation_write-file\|read-file]]	+	* [[operation_read-file\|read-file]]
	* [[operation_write-file\|write-file]]		* [[operation_write-file\|write-file]]

operation_multiply-property

2010-06-22T09:29:58+02:00

1267516936		current
Line 6:		Line 6:

	Multiplies the value for a property by a specified value.		Multiplies the value for a property by a specified value.
-
	===== Configuration =====		===== Configuration =====

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''property'' \| property to multiply \| - \| - \| {{ :yes.gif }} \| 3.1.0 \|	+	\| ''name'' \| name of the property to multiply \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.1.3 \|
	\| ''scope'' \| scope of property to multiply \| "message" \| - \| {{ :yes.gif }} \| 3.1.0 \|		\| ''scope'' \| scope of property to multiply \| "message" \| - \| {{ :yes.gif }} \| 3.1.0 \|
	\| ''by'' \| value to multiply by \| "1" \| - \| {{ :yes.gif }} \| 3.1.0 \|		\| ''by'' \| value to multiply by \| "1" \| - \| {{ :yes.gif }} \| 3.1.0 \|
	\| ''float'' \| floating point? \| "false" \| - \| {{ :yes.gif }} \| 3.1.3 \|		\| ''float'' \| floating point? \| "false" \| - \| {{ :yes.gif }} \| 3.1.3 \|
-	\| ''name'' \| name of the result prop \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.1.3 \|

	===== Examples =====		===== Examples =====

operation_multirow-insert

2010-08-06T11:21:54+02:00

1277790392		current
Line 51:		Line 51:
	This means the "VALUES" keyword, as well as what follows, should not be typed. This will be added automatically by the operation. Note that a check on syntax is performed when executing the operation, which can throw an error should the statement be found to be malformed.		This means the "VALUES" keyword, as well as what follows, should not be typed. This will be added automatically by the operation. Note that a check on syntax is performed when executing the operation, which can throw an error should the statement be found to be malformed.

-	The values for the arguments are supplied by the incoming message. The message should bein XML, which is then divided into parts. These will count for one line each. The column values are then determined by XML subpaths. For a clearer look into what this constitutes precisely, refer to the examples which show a number of common (and less common) scenarios. In general, it is to be understood that an XML is mapped to a database table.	+	The values for the arguments are supplied by the incoming message. The message should be in an XML format, which is then divided into parts. Each part will serve to insert one line into the database table. The column values are then determined by XML subpaths. For a clearer look into what this constitutes precisely, refer to the examples which show a number of common (and less common) scenarios. In general, it is to be understood that an XML is mapped to a database table.

	/*		/*

operation_overwrite-data

2010-03-02T09:02:16+02:00

1205737162		current
Line 21:		Line 21:
	</code>		</code>

		+	===== See also =====
		+
		+	* [[operation_delete-data\|delete-data]]
		+	* [[operation_insert-data\|insert-data]]
		+	* [[operation_set-data\|set-data]]

operation_pipeline

2008-03-20T09:18:25+02:00

1206001105		current
Line 1:		Line 1:
	====== Operation "pipeline" ======		====== Operation "pipeline" ======

-	__Pack__: [[engine_pack\|engine pack]]	+	__Pack__: [[engine pack]]

	__Aliases__: ''operations''		__Aliases__: ''operations''
Line 10:		Line 10:

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| src \| filename to an other configuration file \| - \| - \| - \| 1.0 \|	+	\| ''src'' \| filename to an other configuration file \| - \| - \| - \| 1.0 \|
-		+
-		+

	===== Example =====		===== Example =====

-	* run the code from the config file "split.part.xml" in an other pipeline	+	* Run the code from the config file "split.part.xml" in an other pipeline:

	<code xml>		<code xml>
-	<pipeline src="split.part.xml"/>	+	<pipeline src="split.part.xml"/>
	</code>		</code>

-	* integrate the code from the file "split.part.xml" directly into your main configuration file	+	* Integrate the code from the file "split.part.xml" directly into your main configuration file:

	<code xml>		<code xml>

operation_put

2011-02-25T09:50:41+02:00

1277108661		current
Line 24:		Line 24:

	<code xml>		<code xml>
-	<put close-after-put="true" spawn-close="true">	+	<put close-after-put="true">
	<ftp>		<ftp>
	<host>ftpserver.acme.com</host>		<host>ftpserver.acme.com</host>

operation_read-file

2010-09-27T08:22:55+02:00

1267516936		current
Line 3:		Line 3:
	__Pack__: [[engine pack]] ≥ 3.3.0		__Pack__: [[engine pack]] ≥ 3.3.0

-	Reads the contents of a specified file into the current message.	+	Reads the contents of a specified file into the current message. If you store the file in the current message (i.e. don't use the "property" tag), the length of the file can be retrieved using the "${message:length}" property.

	===== Configuration =====		===== Configuration =====

operation_remove-properties

2010-03-29T10:49:54+02:00

1269852586		current
Line 16:		Line 16:

	<code xml>		<code xml>
-	<clear-properties names="first_name,last_name" scope="local"/>	+	<remove-properties names="first_name,last_name" scope="local"/>
	</code>		</code>

operation_remove-property

2008-03-19T14:41:15+02:00

1206601331		current
Line 12:		Line 12:
	\| ''name'' \| the name of the property you want to remove \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 1.0 \|		\| ''name'' \| the name of the property you want to remove \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 1.0 \|
	\| ''scope'' \| the scope from where you want to remove the property \| "message" \| - \| {{:yes.gif}} \| 1.0 \|		\| ''scope'' \| the scope from where you want to remove the property \| "message" \| - \| {{:yes.gif}} \| 1.0 \|
		+

	===== Full example =====		===== Full example =====

-	* Extract the message property "dummy", rename it to "bodytext" and then remove it again:	+	Extract the message property "dummy", rename it to "bodytext" and then remove it again:

	<code xml>		<code xml>
	<monitor id="test">		<monitor id="test">
		+
	<operations>		<operations>

Line 36:		Line 38:

	</operations>		</operations>
		+
	</monitor>		</monitor>
	</code>		</code>

operation_remove-xml-content

2009-03-05T11:05:31+02:00

1265213470		current
Line 148:		Line 148:

	<code xml\|operation configuration>		<code xml\|operation configuration>
-	<remove-xml-content place="/basic/entry[target="here"]/node() \| /basic/entry[target="here"]/@*" remove="all" prettyprint="true"/>	+	<remove-xml-content
		+	place="/basic/entry[target="here"]/node() \| /basic/entry[target="here"]/@*"
		+	remove="all" prettyprint="true"/>
	</code>		</code>

operation_rename-property

2008-03-19T14:41:34+02:00

1206540790		current
Line 1:		Line 1:
	====== Operation "rename-property" ======		====== Operation "rename-property" ======

-	__Pack__: [[engine_pack\|engine pack]]	+	__Pack__: [[engine pack]]

	__Aliases__: ''rename-message-property'', ''rename-message-variable'', ''rename-variable'', ''rename-message-option'', ''rename-option''		__Aliases__: ''rename-message-property'', ''rename-message-variable'', ''rename-variable'', ''rename-message-option'', ''rename-option''
Line 39:		Line 39:
	</code>		</code>

		+	===== See also =====
		+
		+	* [[operation_extract-property\|extract-property]]
		+	* [[operation_loop-property\|loop-property]]
		+	* [[operation_remove-property\|remove-property]]
		+	* [[operation_set-property\|set-property]]

operation_restore-message

2008-03-21T11:16:46+02:00

1205934562		current
Line 4:		Line 4:

	__Since__: 3.2.2		__Since__: 3.2.2
		+
		+	__Aliases__: ''restore''

	Restores a previously saved backup copy. This includes its data, filename, MIME type and properties. It allows one to perform multiple data-transforming tasks on the same message, restoring it to its original format before each step. Or to revert to the original message in case of an error.		Restores a previously saved backup copy. This includes its data, filename, MIME type and properties. It allows one to perform multiple data-transforming tasks on the same message, restoring it to its original format before each step. Or to revert to the original message in case of an error.

operation_run-java-code

2010-11-10T18:35:53+02:00

1267516936		current
Line 23:		Line 23:
	===== Examples =====		===== Examples =====

-	* Example 1	+	* Convert all text in the message data to uppercase:
-	Converting all text in the message data to uppercase.	+
	<code xml>		<code xml>
	<run-java-code data="string">		<run-java-code data="string">
Line 31:		Line 30:
	</code>		</code>

-	* Example 2	+	* Reverse the order of the message data bytes:
-	Reversing the order of the message data bytes.	+
	<code xml>		<code xml>
	<run-java-code data="bytes">		<run-java-code data="bytes">
Line 41:		Line 39:
	data[length - 1 - i] = temp;		data[length - 1 - i] = temp;
	}		}
		+	return data;
		+	</run-java-code>
		+	</code>
		+
		+	* Convert the filename to lowercase:
		+	<code xml>
		+	<run-java-code>
		+	message.setTransaction(message.getTransaction().toLowerCase());
	return data;		return data;
	</run-java-code>		</run-java-code>

operation_save-message

2008-03-21T12:11:16+02:00

1206097876		current
Line 1:		Line 1:
	====== Operation "save-message" ======		====== Operation "save-message" ======

-	__Pack__: [[engine_pack\|engine pack]]	+	__Pack__: [[engine_pack\|engine pack]] ≥ 3.2.2
-		+
-	__Since__: 3.2.2	+

	__Aliases__: ''save''		__Aliases__: ''save''

operation_sed

2008-03-17T09:50:03+02:00

1205743803		current
Line 4:		Line 4:

	Implements part of the UNIX "sed" command. Syntax: [s]/regexp/replacement/[g][i]		Implements part of the UNIX "sed" command. Syntax: [s]/regexp/replacement/[g][i]
-
-	FIXME
-
-
-

	===== Configuration =====		===== Configuration =====
Line 19:		Line 14:
	\| ''scope'' \| property scope \| message \| - \| {{:yes.gif}} \| 3.3.0 \|		\| ''scope'' \| property scope \| message \| - \| {{:yes.gif}} \| 3.3.0 \|

-	===== Back-referencing =====	+	===== Notes =====

-	Use the "$x" construct to refer to previously matched groups. E.g. "s/employee ([0-9]+)/drone #$1/g" will transform the following text:	+	* Back-referencing: use the "$x" construct to refer to previously matched groups.

-	<code>	+	===== Examples =====
-	employee 8472, name: John Doe	+
-	</code>	+

-	to:	+	* Replace all occurences of the string "header" with string "new header":
-		+	<code xml>
-	<code>	+	<sed>s/header/new $1/g</sed>
-	drone #8472, name: John Doe	+
	</code>		</code>

-	===== Example =====	+	* Replace using back-referencing:

	<code xml>		<code xml>
-	<sed>s/header/new $1/g</sed>	+	<!-- BEFORE: "employee 8472, name: John Doe" -->
		+	<sed>s/employee ([0-9]+)/drone #$1/g</sed>
		+	<!-- AFTER: "drone #8472, name: John Doe" -->
	</code>		</code>

-	... will replace all occurences of the string "header" with string "new header".

operation_set-data

2010-10-12T15:37:41+02:00

1286890603		current
Line 14:		Line 14:

	* The "type" parameter is not [[dynamic]], meaning that it is selected at start-up. Moreover, if it is "regexp", the regular expression is parsed only once at start-up, and remains static.		* The "type" parameter is not [[dynamic]], meaning that it is selected at start-up. Moreover, if it is "regexp", the regular expression is parsed only once at start-up, and remains static.
-
	===== Examples =====		===== Examples =====

Line 23:		Line 22:
	</code>		</code>

-	* Set the current message to some XML content:	+	* Set the current message to some XML content (just make sure you specify the same value for the "encoding" attribute as your configuration):

	<code xml>		<code xml>

operation_set-filename

2008-03-17T08:53:28+02:00

1205740408		current
Line 7:		Line 7:
	Set a filename on a message		Set a filename on a message

-	__See also__: ''[[operation_extract-filename\|extract-filename]]''	+	===== Examples =====

-	===== Example =====	+	* Set the filename "test.txt":

-	In this example we set the filename to (&quot;the value of property test"-"date".txt)	+	<code xml>
		+	<set-filename>test.txt</set-filename>
		+	</code>
		+
		+	* Set the filename to the value of the message property "test", followed by the current date, and the ".txt" extension:

	<code xml>		<code xml>
	<set-filename>${message:test}-@{date('yyyyMMdd')}.txt</set-filename>		<set-filename>${message:test}-@{date('yyyyMMdd')}.txt</set-filename>
	</code>		</code>
		+
		+	===== See also =====
		+
		+	* ''[[operation_extract-filename\|extract-filename]]'': Extract the filename from the message contents.
		+

operation_set-mime-type

2009-02-16T12:13:41+02:00

1205741976		current
Line 2:		Line 2:

	__Pack__: [[engine_pack\|engine pack]]		__Pack__: [[engine_pack\|engine pack]]
		+
		+	__Aliases__: ''set-format''

	Set a MIME type on a message		Set a MIME type on a message

operation_set-poll-interval

2008-03-21T13:21:28+02:00

1206102088		current
Line 4:		Line 4:

	Set the poll interval for the thread		Set the poll interval for the thread
-

	===== Configuration =====		===== Configuration =====

	^ Attribute ^ Description ^ Default ^ Req? ^ Dyn? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ Dyn? ^ Since ^
-	\| ''interval'' \| poll interval for thread \| - \| {{:yes.gif}} \| {{:yes.gif}} \| - \|	+	\| ''interval'' \| poll interval in milliseconds \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 3.0 \|

	===== Example =====		===== Example =====

-	In this example we set the poll inteval to 5000	+	* Set the poll inteval to 5000, i.e. 5 seconds:

	<code xml>		<code xml>
-	<interval>5000</interval>	+	<set-poll-interval interval=&quot;5000&quot;/>
	</code>		</code>

operation_set-property

2011-01-14T14:58:14+02:00

1295013474		current
Line 10:		Line 10:

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''scope'' \| the scope where you want to set the value (one of "message", "local", "global", "system", "newline" \| "message" \| - \| {{ :yes.gif }} \| 1.0 \|	+	\| ''scope'' \| the scope where you want to set the value (one of "message", "local", "global", "system" or "environment") \| "message" \| - \| {{ :yes.gif }} \| 1.0 \|
	\| ''name'' \| the name of the property you want to set \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 1.0 \|		\| ''name'' \| the name of the property you want to set \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 1.0 \|
	\| ''value'' \| the value you want to give the property \| "" \| - \| {{ :yes.gif }} \| 1.0 \|		\| ''value'' \| the value you want to give the property \| "" \| - \| {{ :yes.gif }} \| 1.0 \|

operation_set-retry-interval

2010-03-02T09:02:16+02:00

	current
Line 1:	Line 1:
	+	====== Operation "set-retry-interval" ======

	+	__Pack__: [[engine_pack\|engine pack]]
	+
	+	Set the retry interval of the thread
	+
	+
	+	===== Configuration =====
	+
	+	^ Attribute ^ Description ^ Default ^ Req? ^ Dyn? ^ Since ^
	+	\| ''interval'' \| retry interval for thread \| - \| {{:yes.gif}} \| {{:yes.gif}} \| - \|
	+
	+
	+	===== Example =====
	+
	+	In this example we set the retry inteval to 5000
	+
	+	<code xml>
	+	<interval>5000</interval>
	+	</code>

operation_set-xml-data

2010-10-12T15:35:31+02:00

1286890515		current
Line 2:		Line 2:

	<note warning>		<note warning>
-	Starting from version 4.0, this operation is no longer supported. The same result can be obtained using the "[[op_set-data\|set-data]]" operation and a CDATA construct.	+	Starting from version 4.0, this operation is no longer supported. The same result can be obtained using the "[[operation_set-data\|set-data]]" operation and a CDATA construct.

	<set-data><![CDATA[<?xml version="1.0" encoding="UTF-8"?><root><child attr="value"/><child/></root>]]></set-data>		<set-data><![CDATA[<?xml version="1.0" encoding="UTF-8"?><root><child attr="value"/><child/></root>]]></set-data>

operation_sleep

2009-02-16T11:23:10+02:00

1234779725		current
Line 11:		Line 11:
	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''time'' \| time to sleep in milliseconds \| - \| {{:yes.gif}} \| - \| 1.0 \|		\| ''time'' \| time to sleep in milliseconds \| - \| {{:yes.gif}} \| - \| 1.0 \|
-	\| ''interval'' \| time to sleep in milliseconds - DEPRECATED, please use "''time''" \| - \| {{:yes.gif}} \| - \| 1.0 \|	+	\| <del>''interval''</del> \| time to sleep in milliseconds - DEPRECATED, please use "''time''" \| - \| {{:yes.gif}} \| - \| 1.0 \|

operation_soap-call

2010-05-12T09:33:51+02:00

1272976294		current
Line 6:		Line 6:

	This operation will call a SOAP service using a XML document.		This operation will call a SOAP service using a XML document.
-
	===== Configuration =====		===== Configuration =====

Line 17:		Line 16:
	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''__call__/method'' \| the service method that will be called \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.6.0 \|		\| ''__call__/method'' \| the service method that will be called \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.6.0 \|
		+	\| ''__call__/style'' \| SOAP operation style; one of "rpc", "document", "wrapped" or "message" \| "rpc" \| - \| {{ :yes.gif }} \| 4.1.0 \|
	\| ''__call__/return-type'' \| the return type of the service call value \| - \| - \| {{ :yes.gif }} \| 3.6.0 \|		\| ''__call__/return-type'' \| the return type of the service call value \| - \| - \| {{ :yes.gif }} \| 3.6.0 \|
	\| ''__call__/scope'' \| scope of property to store return value in \| "message" \| - \| {{ :yes.gif }} \| 3.6.0 \|		\| ''__call__/scope'' \| scope of property to store return value in \| "message" \| - \| {{ :yes.gif }} \| 3.6.0 \|

operation_split-xpath

2010-03-02T09:02:16+02:00

1207287658		current
Line 1:		Line 1:
-	====== Operation "set-xml-data" ======	+	====== Operation "split-xpath" ======

	__Pack__: [[XML extension pack]] ≥ 3.6.3		__Pack__: [[XML extension pack]] ≥ 3.6.3

operation_split

2008-03-17T09:19:17+02:00

1205739515		current
Line 1:		Line 1:
	====== Operation "split" ======		====== Operation "split" ======
		+
		+	__Pack__: [[engine_pack\|engine pack]]

	Splits a message into several messages for separate treatment by a pipeline.		Splits a message into several messages for separate treatment by a pipeline.

operation_ssh-call

2010-10-22T09:39:00+02:00

1287733118		current
Line 27:		Line 27:
	===== Examples =====		===== Examples =====

-	* Log on to the host "192.160.1.123" with username root, create and enter the dir "rootdir", write some text to a file and create two more directories:	+	* Log on to the host "192.160.1.123" with username root, create the dir "rootdir", write some text to a file there and create two more sub-directories:
	<code xml>		<code xml>
	<ssh-call>		<ssh-call>

operation_strip_header

2009-02-16T11:35:51+02:00

1183027845	current
Line 1:	Line 1:
	+	====== Operation "strip-header" ======

	+	Delete bytes at the beginning of the message contents.
	+	This operation was replaced with the [[operation_delete-data\|delete-data]] operation which provides more options.
	+
	+	===== Configuration =====
	+
	+	^ Attribute ^ Description ^ values ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	+	\| ''length'' \| length (bytes) to delete \| Integer \| - \| {{ :yes.gif }} \| {{ :yes.gif }} \| 3.0 \|
	+
	+	===== Example =====
	+
	+	* remove 1 byte from message header
	+
	+	<code xml>
	+	<strip-header length="1"/>
	+	</code>

operation_switch

2006-11-29T13:09:58+02:00

1211803270		current
Line 27:		Line 27:
	</case>		</case>
	<default>		<default>
-	<log level="error">property "dummy" doesn't match any cases!</log>	+	<error>property "dummy" doesn't match any cases!</error>
		+	</default>
		+	</switch>
		+	</code>
		+
		+	* Make sure the local property "dummy" matches "abc" without regard of case:
		+
		+	<code xml>
		+	<switch value="${local:dummy}" case-sensitive="false">
		+	<case value="abc">
		+	<log>property "dummy" is some form of "abc"</log>
		+	</case>
		+	<default>
		+	<error>property "dummy" doesn't match any cases!</error>
	</default>		</default>
	</switch>		</switch>
	</code>		</code>

operation_synchronized

2010-06-22T11:21:40+02:00

1277198500		current
Line 1:		Line 1:
-	====== Operation "template" ======	+	====== Operation "synchronized" ======

	__Pack__: [[engine pack]] ≥ 4.1.0		__Pack__: [[engine pack]] ≥ 4.1.0

operation_to-csv

2008-03-27T12:39:50+02:00

1206617990		current
Line 1:		Line 1:
-	====== Operation "ToCSV" ======	+	====== Operation "to-csv" ======

	__Pack__: [[Transform extension pack]]		__Pack__: [[Transform extension pack]]

operation_transcode

2010-03-02T09:02:16+02:00

1267516936		current
Line 8:		Line 8:

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''mime-type'' \| destination MIME type \| - \| - \| - \| 1.0 \|	+	\| ''mime-type'' \| destination MIME type \| - \| - \| {{:yes.gif}} \| 1.0 \|
-	\| ''charset'' \| destination MIME character set \| - \| - \| - \| 1.0 \|	+	\| ''charset'' \| destination MIME character set \| - \| - \| {{:yes.gif}} \| 1.0 \|
-	\| ''encoding'' \| destination Java encoding \| system default \| - \| - \| 1.0 \|	+	\| ''encoding'' \| destination Java encoding \| system default \| - \| {{:yes.gif}} \| 1.0 \|

	===== Notes =====		===== Notes =====

operation_transitional-if

2010-03-02T09:02:16+02:00

1180949383		current
Line 17:		Line 17:
	===== Example =====		===== Example =====

-	* Make sure the local property "dummy" has the value "test":	+	* Perform a heartbeat using WebSphere MQ to test the connection between 2 queue managers. This will put a "PING" message on a remote queue on MQMTEST1, which forwards the "PING" to another remote queue on MQMTEST2, and back to a local queue on MQMTEST1. Based on the success of the previous attempt, a different message is logged.

	<code xml>		<code xml>
-	<transitional-if test="${local:dummy} == 'test'" start-with="false" >	+	<monitor id="heartbeat" poll-interval="10000">
-	<true-true>	+
-	<log> previous result is true and property "dummy" equals "test" </log>	+	<source/>
-	</true-true>	+
-	<true-false>	+	<operations>
-	<log>previous result is true and property "dummy" does not equals "test"</log>	+	<generate-message/>
-	</true-false>	+	<set-data>PING</set-data>
-	<false-true>	+	<set-mime-type log-level="info">text/plain; charset=ISO8859_1</set-mime-type>
-	<log>previous result is false and property "dummy" equals "test"</log>	+	<put log-level="info" log="true" clear-on-init="yes">
-	</false-true>	+	<mqs-message-location>
-	<false-false>	+	<host>mqmtest1</host>
-	<log>previous result is false and property "dummy" does not equals "test"</log>	+	<queue-manager>MQMTEST1</queue-manager>
-	</false-false>	+	<queue>QR.MQMTEST2.MQMTEST1.HEARTBEAT</queue>
-	</transitional-if>	+	</mqs-message-location>
		+	</put>
		+	<get log-level="info" log="true" clear-on-init="yes">
		+	<!-- wait max 60 seconds for reply -->
		+	<mqs-message-location>
		+	<host>mqmtest1</host>
		+	<queue-manager>MQMTEST1</queue-manager>
		+	<queue>QL.MQMTEST1.MQMTEST2.HEARTBEAT</queue>
		+	<wait-interval>5000</wait-interval>
		+	<correlation-id>${message.extra.mq.correlation-id}</correlation-id>
		+	</mqs-message-location>
		+	</get>
		+	<transitional-if test="message is not null" start-with="true">
		+	<false-true> <output level="warn">RECONNECTED</output> </false-true>
		+	<true-true> <output level="debug">STILL CONNECTED</output> </true-true>
		+	<true-false> <output level="warn">DISCONNECTED</output> </true-false>
		+	<false-false> <output level="warn">STILL DISCONNECTED</output> </false-false>
		+	</transitional-if>
		+	</operations>
		+
		+	<destination/>
		+
		+	</monitor>
	</code>		</code>

operation_try

2010-07-01T08:41:14+02:00

1277965343		current
Line 2:		Line 2:

	This operation is used to implement error handling in your application. When an error occurs in the main pipeline in a "try" operation, the catch pipeline will handle the error. This allows you to e.g. send out an e-mail, put the offending message on a message queue ...		This operation is used to implement error handling in your application. When an error occurs in the main pipeline in a "try" operation, the catch pipeline will handle the error. This allows you to e.g. send out an e-mail, put the offending message on a message queue ...
-
	===== Configuration =====		===== Configuration =====

Line 11:		Line 10:

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''log-exception'' \| should we log the exception? \| "false" \| - \| {{ :yes.gif }} \| 1.0 \|	+	\| ''log-exception'' \| should we log the exception? \| "true" \| - \| {{ :yes.gif }} \| 1.0 \|

	===== Full example =====		===== Full example =====

operation_unwrap-montova-message

2008-03-19T14:50:13+02:00

1196087279		current
Line 1:		Line 1:
	====== Operation "unwrap-montova-message" ======		====== Operation "unwrap-montova-message" ======
		+
		+	__Pack__: [[engine_pack\|engine pack]]

	Unwrap a montova message		Unwrap a montova message

operation_while

2008-06-04T10:40:34+02:00

1175254933		current
Line 1:		Line 1:
	====== Operation "while" ======		====== Operation "while" ======

-	Executes a pipeline while the specified test evaluates to true. For a list of boolean expressions, consult the "[[mi_expressions\|expressions]]" page.	+	Executes a pipeline while the specified test evaluates to true. For a list of boolean expressions, consult the "[[expressions\|expressions]]" page.

	===== Configuration =====		===== Configuration =====

operation_wrap-in-montova-message

2010-08-19T09:07:24+02:00

1282201633		current
Line 12:		Line 12:
	\| ''csn'' \| CSN (__C__ompany __S__ubclass __N__ode) address of remote partner \| - \| - \| - \| 3.3.0 \|		\| ''csn'' \| CSN (__C__ompany __S__ubclass __N__ode) address of remote partner \| - \| - \| - \| 3.3.0 \|
	\| ''category'' \| message category \| - \| - \| - \| 3.3.0 \|		\| ''category'' \| message category \| - \| - \| - \| 3.3.0 \|
-	\| ''operation'' \| operation code (deprecated!) \| - \| - \| - \| 3.3.0 \|	+
	/*		/*
		+	\| ''operation'' \| operation code (deprecated!) \| - \| - \| - \| 3.3.0 \|
	\| ''compress'' \| compress the message \| "false" \| - \| - \| 3.3.0 \|		\| ''compress'' \| compress the message \| "false" \| - \| - \| 3.3.0 \|
	\| ''compress-if-text'' \| compress if it is a text message \| "false" \| - \| - \| 3.3.0 \|		\| ''compress-if-text'' \| compress if it is a text message \| "false" \| - \| - \| 3.3.0 \|

operation_wrap-mime

2010-03-02T09:02:16+02:00

1234792300		current
Line 1:		Line 1:
	====== Operation "wrap-in-mime" ======		====== Operation "wrap-in-mime" ======

-	__Pack__: [[Internet extension pack]]	+	__Pack__: [[Internet extension pack]] ≥ 4.1.0

	Wraps the current message in a [[http://en.wikipedia.org/wiki/MIME\|MIME]]-compliant [[http://en.wikipedia.org/wiki/MIME#Multipart_messages\|multipart]] envelope.		Wraps the current message in a [[http://en.wikipedia.org/wiki/MIME\|MIME]]-compliant [[http://en.wikipedia.org/wiki/MIME#Multipart_messages\|multipart]] envelope.
Line 8:		Line 8:

	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
-	\| ''encoding'' \| value for the "[[http://en.wikipedia.org/wiki/MIME#Content-Transfer-Encoding\|Content-Transfer-Encoding]]" parameter ("7bit", "quoted-printable" or "base64") \| "quoted-printable" if primary MIME type is "text", else "base64" \| - \| {{ :yes.gif }} \| FIXME \|	+	\| ''encoding'' \| value for the "[[http://en.wikipedia.org/wiki/MIME#Content-Transfer-Encoding\|Content-Transfer-Encoding]]" parameter ("7bit", "quoted-printable" or "base64") \| "quoted-printable" if primary MIME type is "text", else "base64" \| - \| {{ :yes.gif }} \| 4.1.0 \|

	===== Example =====		===== Example =====
Line 17:		Line 17:
	</code>		</code>

		+	===== See also =====
		+
		+	* [[operation_wrap-smime\|wrap-smime]]

operation_wrap-smime

2010-11-25T13:21:31+02:00

1290687638		current
Line 36:		Line 36:
	</code>		</code>

-	===== Bug =====

-	If you receive an error message stating that "JCE cannot authenticate the provider BC"

	===== See also =====		===== See also =====

	* [[operation_wrap-mime\|wrap-mime]]		* [[operation_wrap-mime\|wrap-mime]]

operation_write-file

2008-07-24T11:21:07+02:00

1216275294		current
Line 11:		Line 11:
	\| ''overwrite'' \| overwrite the file if it exists? \| "false" \| - \| {{ :yes.gif }} \| 3.0 \|		\| ''overwrite'' \| overwrite the file if it exists? \| "false" \| - \| {{ :yes.gif }} \| 3.0 \|
	\| ''encoding'' \| encoding of element value? \| message encoding \| - \| {{ :yes.gif }} \| 3.6.0 \|		\| ''encoding'' \| encoding of element value? \| message encoding \| - \| {{ :yes.gif }} \| 3.6.0 \|
		+	\| ''append'' \| appending data to the file? \| "false" \| - \| {{ :yes.gif }} \| 3.8.5 \|

	===== Notes =====		===== Notes =====

operation_xml-dsig-sign

2008-03-13T09:13:58+02:00

1208172511		current
Line 1:		Line 1:
	====== Operation "xml-dsig-sign" ======		====== Operation "xml-dsig-sign" ======

-	__Pack__: [[XML extension pack]]	+	__Pack__: [[XML extension pack]] ≥ 3.7.0

	Signs a message according to the XML-DSig standard.		Signs a message according to the XML-DSig standard.

-	More info on XML-DSig standerd:	+	More info on XML-DSig standard:
	* W3.org specification: [[http://www.w3.org/Signature/]]		* W3.org specification: [[http://www.w3.org/Signature/]]
	* Wikipedia article: [[http://en.wikipedia.org/wiki/XML_Signature]]		* Wikipedia article: [[http://en.wikipedia.org/wiki/XML_Signature]]
Line 22:		Line 22:
	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''xml'' \| is the message to be signed an XML format? \| "false" \| - \| {{ :yes.gif }} \| - \|		\| ''xml'' \| is the message to be signed an XML format? \| "false" \| - \| {{ :yes.gif }} \| - \|
-	\| ''scope'' \| scope property where to store signed/unsigned data \| "message" \| - \| {{ :yes.gif }} \| - \|	+	\| ''scope'' \| property scope where to store signed/unsigned data \| "message" \| - \| {{ :yes.gif }} \| - \|
	\| ''property'' \| property where to store signed/unsigned data \| - \| - \| {{ :yes.gif }} \| - \|		\| ''property'' \| property where to store signed/unsigned data \| - \| - \| {{ :yes.gif }} \| - \|
	\| ''include-certificate'' \| include the signer's certificate? \| "true" \| - \| {{ :yes.gif }} \| - \|		\| ''include-certificate'' \| include the signer's certificate? \| "true" \| - \| {{ :yes.gif }} \| - \|

operation_xml-dsig-unsign

2008-03-13T09:12:43+02:00

1207289075		current
Line 1:		Line 1:
	====== Operation "xml-dsig-unsign" ======		====== Operation "xml-dsig-unsign" ======

-	__Pack__: [[xml_extension_pack\|XML extension pack]] ≥ 1.0	+	__Pack__: [[xml_extension_pack\|XML extension pack]]

	Unsigns a message according to the XML-DSig standard.		Unsigns a message according to the XML-DSig standard.

operation_xml-to-flf

2011-07-27T13:19:01+02:00

1272289231		current
Line 41:		Line 41:
	</row>		</row>
	<end>		<end>
-	<code>fin</code>	+	<aa>fin</aa>
	</end>		</end>
	</root>		</root>
Line 53:		Line 53:
	</row>		</row>
	<end start-line='final'>		<end start-line='final'>
-	<code>eof</code>	+	<aa>eof</aa>
	</end>		</end>
	</root>		</root>

operation_xslt-transform

2007-12-14T10:23:44+02:00

1236241919		current
Line 9:		Line 9:
	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn?]] ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn?]] ^ Since ^
	\| ''init-stylesheet'' \| initialize stylesheet at start-up \| "false" \| - \| - \| 1.0 \|		\| ''init-stylesheet'' \| initialize stylesheet at start-up \| "false" \| - \| - \| 1.0 \|
-	\| ''mime-type'' \| new MIME type to set on transformed message (bug: not working in versions < 4.0.1 and 4.1.0) \| - \| - \| {{:yes.gif}} \| 1.0 \|

	^ Child ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn?]] ^ Since ^		^ Child ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn?]] ^ Since ^

operation_xsltfo-transform

2008-12-18T11:37:18+02:00

1229599873		current
Line 9:		Line 9:
	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^		^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''format'' \| destination format (one of "afp", "afp_alt", "eps", "gif", "jpeg", "mif", "pcl", "pcl_alt", "pdf", "plaintext", "png", "postscript", "rtf", "rtf_alt1", "rtf_alt2", "svg", "tiff") \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 4.0.0 \|		\| ''format'' \| destination format (one of "afp", "afp_alt", "eps", "gif", "jpeg", "mif", "pcl", "pcl_alt", "pdf", "plaintext", "png", "postscript", "rtf", "rtf_alt1", "rtf_alt2", "svg", "tiff") \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 4.0.0 \|
-	\| ''stylesheet'' \| path to XSLT-FO stylesheet \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 4.0.0 \|	+	\| ''stylesheet'' \| path to XSL-FO stylesheet \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 4.0.0 \|
	\| ''base-url'' \| base URL for finding images \| - \| - \| {{:yes.gif}} \| 4.0.0 \|		\| ''base-url'' \| base URL for finding images \| - \| - \| {{:yes.gif}} \| 4.0.0 \|
	\| ''producer'' \| producer of target document \| "Apache FOP" \| - \| {{:yes.gif}} \| 4.0.0 \|		\| ''producer'' \| producer of target document \| "Apache FOP" \| - \| {{:yes.gif}} \| 4.0.0 \|

overview

2010-10-27T18:23:15+02:00

1288196569		current
Line 69:		Line 69:
	[[property\|{{:famfamfam:u-v-w-x-y-z:zoom_in.png\|}}]][[property\|Show me more]]		[[property\|{{:famfamfam:u-v-w-x-y-z:zoom_in.png\|}}]][[property\|Show me more]]

-	===== Miscellaneous =====	+	===== Functions =====
-		+
-	==== Functions ====	+

	Using the ”@” prefix instead of the “$” prefix, you can call various functions that return a dynamic value based on their arguments. You could use the "''date()''" function to generate the current date:		Using the ”@” prefix instead of the “$” prefix, you can call various functions that return a dynamic value based on their arguments. You could use the "''date()''" function to generate the current date:
Line 78:		Line 76:

	[[function\|{{:famfamfam:u-v-w-x-y-z:zoom_in.png\|}}]][[function\|Show me more]]		[[function\|{{:famfamfam:u-v-w-x-y-z:zoom_in.png\|}}]][[function\|Show me more]]
		+
		+	===== Miscellaneous =====

	==== Password obfuscation ====		==== Password obfuscation ====
Line 87:		Line 87:
	</code>		</code>

-	===== Non-printable characters =====	+	==== Non-printable characters ====

	Non-printable characters (or "special characters") like "Carriage Return" (''0x0D''), "Line Feed" (''0x0A'') and "Tab" (''0x09'') can be expressed in the configuration file using the format "#{xx}".		Non-printable characters (or "special characters") like "Carriage Return" (''0x0D''), "Line Feed" (''0x0A'') and "Tab" (''0x09'') can be expressed in the configuration file using the format "#{xx}".

pdf_extension_pack

2010-06-28T14:57:47+02:00

1277729360		current
Line 16:		Line 16:

	Starting from version 4.1.0, the libraries required for correct operation are included in the JAR file.		Starting from version 4.1.0, the libraries required for correct operation are included in the JAR file.
-
	==== Version 4.0.x or lower ====		==== Version 4.0.x or lower ====

-	^ File ^ Description ^ Used by ^ For ^ On ^	+	^ File ^ Description ^ Used for ^
-	\| ''FontBox-x.x.x.jar'' \| FontBox library ([[http://www.pdfbox.org/\|homepage]]) \| [[PDF extension pack]] \| PDF operations \| - \|	+	\| ''FontBox-x.x.x.jar'' \| FontBox library ([[http://www.pdfbox.org/\|homepage]]) \| PDF operations \|
-	\| ''iText-x.x.x.jar'' \| iText PDF library ([[http://www.lowagie.com/iText/\|homepage]]) \| [[PDF extension pack]] \| PDF operations \| - \|	+	\| ''iText-x.x.x.jar'' \| iText PDF library ([[http://www.lowagie.com/iText/\|homepage]]) \| PDF operations \|
-	\| ''PDFBox-x.x.x.jar'' \| PDFBox library ([[http://www.pdfbox.org/\|homepage]]) \| [[PDF extension pack]] \| PDF operations \| - \|	+	\| ''PDFBox-x.x.x.jar'' \| PDFBox library ([[http://www.pdfbox.org/\|homepage]]) \| PDF operations \|

	===== Changelog =====		===== Changelog =====
Line 30:		Line 29:
	=== 4.0.0 (2008-10-20) ===		=== 4.0.0 (2008-10-20) ===
	* added support for validation		* added support for validation
-

pipeline

2010-03-30T09:38:28+02:00

1267516936		current
Line 2:		Line 2:

	A pipeline is a series of operations, executed in-order, where the output of one operation (i.e. the current message) is passed on to the next operation. Using flow control operations "[[operation_if\|if]]", "[[operation_switch\|switch]]", "[[operation_try\|try]]" and "[[operation_while\|while]]", you can create alternate execution paths, depending on logic.		A pipeline is a series of operations, executed in-order, where the output of one operation (i.e. the current message) is passed on to the next operation. Using flow control operations "[[operation_if\|if]]", "[[operation_switch\|switch]]", "[[operation_try\|try]]" and "[[operation_while\|while]]", you can create alternate execution paths, depending on logic.
		+
		+	<graphviz neato>
		+	digraph monitor {
		+	bgcolor=transparent;
		+	rankdir=LR;
		+	node [style="rounded,filled", fontname=Arial, fontsize=10, fillcolor="#dee7ec", color="#8cacbb"];
		+	edge [fontname=Arial, fontsize=10];
		+	O1 [label="Operation 1", shape=box, pin=true, pos="1,2"];
		+	O2 [label="Operation 2", shape=box, pin=true, pos="3,2"];
		+	O3 [label="Operation 3", shape=box, pin=true, pos="5,2"];
		+	O1 -> O2 [label="Message"];
		+	O2 -> O3 [label="Message"];
		+	}
		+	</graphviz>
		+
		+	Moreover, an operation can in itself be a pipeline, or contain multiple pipelines which are executed depending on some condition. Arbitrarily complex applications can thus be created.
		+
		+	<graphviz neato>
		+	digraph monitor {
		+	bgcolor=transparent;
		+	rankdir=LR;
		+	node [style="rounded,filled", fontname=Arial, fontsize=10, fillcolor="#dee7ec", color="#8cacbb"];
		+	edge [fontname=Arial, fontsize=10];
		+	O1 [label="Operation", shape=box, pin=true, pos="1,2"];
		+	O2 [label="IF", shape=box, pin=true, pos="2.5,2"];
		+	O3 [label="Operation", shape=box, pin=true, pos="8,2"];
		+	O2T1 [label="Operation", shape=box, pin=true, pos="4,2.5"];
		+	O2T2 [label="Operation", shape=box, pin=true, pos="5.25,2.5"];
		+	O2T3 [label="Operation", shape=box, pin=true, pos="6.5,2.5"];
		+	O2F1 [label="Operation", shape=box, pin=true, pos="4,1.5"];
		+	O2F2 [label="CASE", shape=box, pin=true, pos="5.25,1.5"];
		+	O2F3 [label="Operation", shape=box, pin=true, pos="6.5,1.5"];
		+	O2F4 [label="Operation", shape=box, pin=true, pos="6.5,0.75"];
		+	O2F5 [label="Operation", shape=box, pin=true, pos="6.5,0"];
		+	O1 -> O2;
		+	O2 -> O2T1 [label="true"];
		+	O2T1 -> O2T2;
		+	O2T2 -> O2T3;
		+	O2T3 -> O3;
		+	O2 -> O2F1 [label="false"];
		+	O2F1 -> O2F2;
		+	O2F2 -> O2F3;
		+	O2F2 -> O2F4;
		+	O2F2 -> O2F5;
		+	O2F3 -> O3;
		+	O2F4 -> O3;
		+	O2F5 -> O3;
		+	}
		+	</graphviz>
		+

playground

2008-02-05T07:50:38+02:00

1202194238		current
Line 7:		Line 7:
	S [label="Source\nMessage\nLocation", shape=box, pin=true, pos="1,3"];		S [label="Source\nMessage\nLocation", shape=box, pin=true, pos="1,3"];
	P [label="Pipeline", shape=box, pin=true, pos="4,3"];		P [label="Pipeline", shape=box, pin=true, pos="4,3"];
-	D [label="Destination\nMessage\nLocation", shape=box, pin=true, pos="7,3"];	+	D [label="Destination\nMessage\nLocation", shape=diamond, pin=true, pos="7,3"];
	OFP [label="Pipeline", shape=box, pin=true, pos="4,1"];		OFP [label="Pipeline", shape=box, pin=true, pos="4,1"];
	OSP [label="Pipeline", shape=box, pin=true, pos="7,1"];		OSP [label="Pipeline", shape=box, pin=true, pos="7,1"];

pretty_print_xml

2010-03-02T09:02:16+02:00

1148388348		current
Line 1:		Line 1:
-	====== Pretty-printing XML messages ======	+	====== Pretty-printing XML messages ======
-		+
-	Using the xslt-transform operation in the [[transform_extension_pack\|Transform extension pack]], and the below XSL stylesheet, an XML message is formatted so that it becomes more readable to a human reader.	+	Using the "[[operation_xslt-transform\|xslt-transform]]" operation in the [[transform_extension_pack\|Transform extension pack]], and the below XSL stylesheet, an XML message is formatted so that it becomes more readable to a human reader.
-		+
-	<code xml>	+	<code xml>
-	<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">	+	<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
-	<xsl:output method="xml" indent="yes" encoding="ISO-8859-1"/>	+	<xsl:output method="xml" indent="yes" encoding="ISO-8859-1"/>
-	<xsl:template match="@*\|node( )">	+	<xsl:template match="@*\|node( )">
-	<xsl:copy>	+	<xsl:copy>
-	<xsl:apply-templates select="@*\|node( )"/>	+	<xsl:apply-templates select="@*\|node( )"/>
-	</xsl:copy>	+	</xsl:copy>
-	</xsl:template>	+	</xsl:template>
-	</xsl:stylesheet>	+	</xsl:stylesheet>
-	</code>	+	</code>
-		+
-	So dump the above XSL stylesheet into a file called "prettyxml.xsl" (or whatever you like) and call the "[[operation_xslt-transform\|xslt-transform]]" operation:	+	So dump the above XSL stylesheet into a file called "prettyxml.xsl" (or whatever you like) and call the "[[operation_xslt-transform\|xslt-transform]]" operation:
-		+
-	<code xml>	+	<code xml>
-	<xslt-transform>	+	<xslt-transform>
-	<stylesheet>/full/path/to/prettyxml.xsl</stylesheet>	+	<stylesheet>/full/path/to/prettyxml.xsl</stylesheet>
-	</xslt-transform>	+	</xslt-transform>
	</code>		</code>

printer_driver

2010-03-02T09:02:16+02:00

1175580861		current
Line 1:		Line 1:
-	====== Redirecting Printer Output to Integrator ======	+	====== Redirecting Printer Output to Montova™ Integrator ======

-	__NB__: The Montova™ Integrator configuration to pick up the files generated in the below solutions is left as an exercise to the reader. (Hint: It's a monitor with a "filesystem" source...)	+	__NB__: The <montova>Integrator</montova> configuration to pick up the files generated in the below solutions is left as an exercise to the reader. (Hint: It's a monitor with a "filesystem" source...)

	===== On Windows =====		===== On Windows =====

property

2010-11-15T15:13:36+02:00

1289830073		current
Line 90:		Line 90:
	This scope reads environment variables of the shell in which the Java Virtual Machine is running. This is achieved by executing a command dependent on the running Operating System:		This scope reads environment variables of the shell in which the Java Virtual Machine is running. This is achieved by executing a command dependent on the running Operating System:

-	* On Windows platforms: "''echo %property%''";	+	^ OS ^ Command ^
-	* On Unix systems: "''echo $property''";	+	\| Windows \| ''echo %property%'' \|
-	* On OpenVMS systems: "''SHOW SYMBOL property''" (indirect, via temporary DCL file).	+	\| Unix derivatives \| ''echo $property'' \|
		+	\| OpenVMS \| ''SHOW SYMBOL property'' (indirect, via temporary DCL file) \|

	===== List of properties =====		===== List of properties =====

robust_retries

2012-02-17T10:30:59+02:00

1329471059		current
Line 22:		Line 22:
	</true>		</true>
	<false>		<false>
-	<sleep interval="60000"/>	+	<sleep time="60000"/>
	</false>		</false>
	</if>		</if>

running

2011-01-13T13:11:55+02:00

1282728781		current
Line 91:		Line 91:
	<code>		<code>
	RUNJVA ... PROP(java.version '1.4')		RUNJVA ... PROP(java.version '1.4')
		+	</code>
		+
		+	Documentation states that the 'java.version' property for version 1.6 is ignored.
		+	The JDK version is determined from the value of the JAVA_HOME environment variable.
		+	To add the JAVA_HOME environment variable run the AS400 command
		+	<code>
		+	AddEnvVar EnvVar('JAVA_HOME') Value('/QOpenSys/QIBM/ProdData/JavaVM/jdk60/32bit') Level(*SYS)
		+	</code>
		+	To change the variable run the command
		+	<code>
		+	AddEnvVar EnvVar('JAVA_HOME') Value('/QOpenSys/QIBM/ProdData/JavaVM/jdk60/32bit') Level(SYS) Replace(Yes)
	</code>		</code>

sap_extension_pack

2010-07-01T10:35:00+02:00

1277973268		current
Line 1:		Line 1:
	====== SAP Extension Pack ======		====== SAP Extension Pack ======
		+
		+	__Latest version__: 4.0.0

	The SAP extension pack contains an operation to call an RFC on a remote SAP host.		The SAP extension pack contains an operation to call an RFC on a remote SAP host.

service_hl7

2008-10-03T13:20:04+02:00

1195125005		current
Line 24:		Line 24:

	^ Child ^ Description ^ Default ^		^ Child ^ Description ^ Default ^
-	\| ''time-out'' \| timeout in ms \| 300000 \|	+	\| ''timeout'' \| timeout in ms \| 300000 \|
	\| ''port'' \| TCP/IP port \| 1341 \|		\| ''port'' \| TCP/IP port \| 1341 \|

service_http

2012-01-17T13:04:18+02:00

1294650301		current
Line 4:		Line 4:

	A simple HTTP(S) web service to receive messages from an HTTP client.		A simple HTTP(S) web service to receive messages from an HTTP client.
		+	More info on how to use the web service can be found [[service_http_doc\|here]].
		+
	===== Configuration =====		===== Configuration =====

service_http_doc

2012-01-25T15:01:49+02:00

1327500096		current
Line 21:		Line 21:
	GET /HTTP/?message=TEST0123456789&filename=test.txt&mime-type=text/plain HTTP/1.0		GET /HTTP/?message=TEST0123456789&filename=test.txt&mime-type=text/plain HTTP/1.0

-	==== Using the "POST" method from a web form ====	+	===== Using the "POST" method from a web form =====
	Use a standard web form and the "message" parameter. This forces the content type to "application/x-www-form-urlencoded". Header "Content-Length" is required, or an error will be thrown.		Use a standard web form and the "message" parameter. This forces the content type to "application/x-www-form-urlencoded". Header "Content-Length" is required, or an error will be thrown.

Line 38:		Line 38:
	filename=test.txt&mime-type=text/plain&message=TEST0123456789		filename=test.txt&mime-type=text/plain&message=TEST0123456789

-	====== Using the "POST" method unencoded ======	+	===== Using the "POST" method unencoded =====
	Specify the message unencoded in the body of the request. Filename is passed as URL parameter. MIME type is passed via the "Content-Type" header, which is required, or an error will be thrown.		Specify the message unencoded in the body of the request. Filename is passed as URL parameter. MIME type is passed via the "Content-Type" header, which is required, or an error will be thrown.

service_soap

2010-05-04T14:24:22+02:00

1272974195		current
Line 111:		Line 111:
	</code>		</code>

-	===== Client Examples =====	+	===== Client Examples < 4.1.0 =====

	==== Java Client Using Apache Axis ====		==== Java Client Using Apache Axis ====
Line 197:		Line 197:
	print $soap		print $soap
	-> process( 'test' )		-> process( 'test' )
		+	-> result;
		+	</code>
		+
		+	===== Client Examples ≥ 4.1.0 =====
		+
		+	==== Java Client Using Apache Axis ====
		+
		+	<code java>
		+	Service service = new Service( );
		+	Call call = (Call) service.createCall( );
		+	call.setTargetEndpointAddress( new URL( endpoint ) );
		+	call.setMaintainSession( true );
		+	call.setOperationName( new QName("http://soapinterop.org/", "process") );
		+	String result = (String) call.invoke( new Object[] { "unique_service_id", "test" } );
		+	</code>
		+
		+	==== Perl Client Using SOAP::Lite ====
		+
		+	<code perl>
		+	use SOAP::Lite;
		+	use HTTP::Cookies;
		+	my $soap = SOAP::Lite
		+	-> uri( 'http://localhost:8080/axis/services/MontovaIntegratorSOAP' )
		+	-> proxy( 'http://localhost:8080/axis/services/MontovaIntegratorSOAP',
		+	cookie_jar => HTTP::Cookies->new( ignore_discard => 1 ) );
		+	print $soap
		+	-> process( 'unique_service_id', 'test' )
	-> result;		-> result;
	</code>		</code>

service_tips

2010-03-02T09:02:16+02:00

	current
Line 1:	Line 1:
	+	====== Performance tips for services ======
	+
	+	As a new thread gets started for each request to a service, a resource problem could develop here. The following modifications make sure there's as little as possible waste, and that used resources get de-allocated as soon as possible.
	+
	+	===== Lazy instantiation =====
	+
	+	Lazy instantiation of operations will ensure only objects which are actually used are instantiated. To enable:
	+
	+	* set attribute "lazy" on any "switch" operations to "true"
	+	<code xml>
	+	<switch value="${scope:property}" lazy="true" >
	+	<!-- ... -->
	+	</switch>
	+	</code>
	+
	+	* set attribute "lazy" on any "if" operations to "true":
	+	<code xml>
	+	<if test="${scope:property} equals 'true'" lazy="true">
	+	<!-- ... -->
	+	</if>
	+	</code>
	+
	+	* set attribute "lazy" on any "catch" pipelines in operation "try" to "true":
	+	<code xml>
	+	<try>
	+	<operations>
	+	<!-- ... -->
	+	</operations>
	+	<catch lazy="true">
	+	<!-- ... -->
	+	</catch>
	+	</try>
	+	</code>
	+
	+	===== Resource de-allocation =====
	+
	+	Close all resources after a "put" or "get" operation, as these connections are usually kept open for maximum performance. Also, forking these "close" calls in the background frees the client from waiting for them. Here's how:
	+
	+	* set attributes "close-after-put" & "spawn-close" on every "put" operation to "true":
	+	<code xml>
	+	<put close-after-put="true" spawn-close="true">
	+	<!-- ... -->
	+	</put>
	+	</code>
	+
	+	* set attributes "close-after-get" & "spawn-close" on every "get" operation to "true":
	+	<code xml>
	+	<get close-after-get="true" spawn-close="true">
	+	<!-- ... -->
	+	</get>
	+	</code>

sidebar

2010-10-27T18:28:44+02:00

1288196276		current
Line 2:		Line 2:

	\\		\\
-	{{:famfamfam:a-b:asterisk_orange.png }} Getting Started****	+	{{:famfamfam:a-b:asterisk_orange.png }} Getting started****
	* [[Overview]]		* [[Overview]]
	* [[installation\|Installing]]		* [[installation\|Installing]]
Line 10:		Line 10:

	\\		\\
-	{{:famfamfam:a-b:asterisk_orange.png }} Learn More****	+	{{:famfamfam:a-b:asterisk_orange.png }} Learn more****
-	* [[Clustering]]	+
	* [[Cookbook]]		* [[Cookbook]]
-	* [[Development Guide]]
	* [[Extension Packs]]		* [[Extension Packs]]
	* [[Logging]]		* [[Logging]]
	* [[Notification]]		* [[Notification]]
-	* [[Controllers\|Monitoring & Control]]
	* [[changelog\|Changes]]		* [[changelog\|Changes]]

	\\		\\
-	{{:famfamfam:a-b:asterisk_orange.png }} Quick Links****	+	{{:famfamfam:a-b:asterisk_orange.png }} Advanced topics
		+	* [[Clustering]]
		+	* [[Development Guide]]
		+	* [[Controllers\|Monitoring & Control]]
		+
		+	\\
		+	{{:famfamfam:a-b:asterisk_orange.png }} Quick links****
	* [[configuration#Flow Control\|Flow Control]]		* [[configuration#Flow Control\|Flow Control]]
	* [[message location\|Message Locations]]		* [[message location\|Message Locations]]

simple_example

2010-03-02T09:02:16+02:00

1267516936		current
Line 1:		Line 1:
-	====== A Simple Example ======	+	===== A Simple Example =====

	Suppose you want to transform XML messages found in a local directory using an XSLT stylesheet to a CSV format, sending the result to a different directory. Starting from the [[configuration#outline]], we create the following configuration file:		Suppose you want to transform XML messages found in a local directory using an XSLT stylesheet to a CSV format, sending the result to a different directory. Starting from the [[configuration#outline]], we create the following configuration file:

sql_extension_pack

2010-07-01T14:38:42+02:00

1277790546		current
Line 32:		Line 32:
	[[compat_sql\|Compatibility matrix]]		[[compat_sql\|Compatibility matrix]]

-	=== 4.1.0 (TBA) ===	+	=== 4.1.0 (2010-07-01) ===
-	* [MISQL-8] new operation for multirow inserts	+	* [MISQL-11] - FIXED: float parameters are casted to double, resulting in representational errors
-	* [MISQL-10] committing on pipeline finish when pipeline fails now optional in "[[operation_execute-statement\|execute-statement]]"	+	* [MISQL-5] - IMPROVED: allow the logging of the full SQL statement
-	* increased stability and committing behaviour in "[[operation_execute-statement\|execute-statement]]"	+	* [MISQL-6] - IMPROVED: allow SELECT statement output to property instead of message
-	* [MISQL-5] possibility to choose how much characters of the statement are to be logged in "[[operation_execute-statement\|execute-statement]]"	+	* [MISQL-10] - IMPROVED: allow commit on failed pipeline finish to be optional
		+	* [MISQL-7] - NEW: operation "execute-statement": add type datetime (timestamp)
		+	* [MISQL-8] - NEW: new operation for multirow inserts
		+	* [MISQL-12] - NEW: add "timestamp" type to "

	=== 4.0.2 (TBA) ===		=== 4.0.2 (TBA) ===

start

2012-04-10T15:16:14+02:00

1334063745		current
Line 1:		Line 1:
-	<note>From now on, all Montova documentation is available at [[http://docs.montova.com]]</note>
-
	===== What is Montova Integrator? =====		===== What is Montova Integrator? =====

	<montova>Integrator</montova> is an extensible ESB (Enterprise Service Bus) written entirely in standard Java. It can execute highly-configurable custom transformations of data exchanged between two applications. This is achieved through a strong focus on component modularity and re-use, inspired by Unix pipes, which contain many small components which perform clear-cut operations on your data.		<montova>Integrator</montova> is an extensible ESB (Enterprise Service Bus) written entirely in standard Java. It can execute highly-configurable custom transformations of data exchanged between two applications. This is achieved through a strong focus on component modularity and re-use, inspired by Unix pipes, which contain many small components which perform clear-cut operations on your data.
		+
		+	<note>From now on, all Montova documentation is available at [[http://docs.montova.com]]</note>

	===== Getting started =====		===== Getting started =====

tag_monitor-destination

2010-03-01T09:23:55+02:00

1267431835		current
Line 55:		Line 55:
	* [[tag_monitor-pre-post\|monitor/post]]		* [[tag_monitor-pre-post\|monitor/post]]
	* [[tag_monitor-pre-post\|monitor/pre]]		* [[tag_monitor-pre-post\|monitor/pre]]
-	* [[tag_properties\|monitor/properties]]
	* [[tag_monitor-source\|monitor/source]]		* [[tag_monitor-source\|monitor/source]]

tag_monitor-on-failure

2010-03-01T09:23:55+02:00

1267431835		current
Line 30:		Line 30:
	* [[tag_monitor-pre-post\|monitor/post]]		* [[tag_monitor-pre-post\|monitor/post]]
	* [[tag_monitor-pre-post\|monitor/pre]]		* [[tag_monitor-pre-post\|monitor/pre]]
-	* [[tag_properties\|monitor/properties]]
	* [[tag_monitor-source\|monitor/source]]		* [[tag_monitor-source\|monitor/source]]

tag_monitor-on-success

2010-03-01T09:23:56+02:00

1267431836		current
Line 35:		Line 35:
	* [[tag_monitor-pre-post\|monitor/post]]		* [[tag_monitor-pre-post\|monitor/post]]
	* [[tag_monitor-pre-post\|monitor/pre]]		* [[tag_monitor-pre-post\|monitor/pre]]
-	* [[tag_properties\|monitor/properties]]
	* [[tag_monitor-source\|monitor/source]]		* [[tag_monitor-source\|monitor/source]]

tag_monitor-operations

2010-03-01T09:23:56+02:00

1267431836		current
Line 20:		Line 20:
	* [[tag_monitor-pre-post\|monitor/post]]		* [[tag_monitor-pre-post\|monitor/post]]
	* [[tag_monitor-pre-post\|monitor/pre]]		* [[tag_monitor-pre-post\|monitor/pre]]
-	* [[tag_properties\|monitor/properties]]
	* [[tag_monitor-source\|monitor/source]]		* [[tag_monitor-source\|monitor/source]]

tag_monitor-pre-post

2010-03-01T09:23:56+02:00

1267431836		current
Line 49:		Line 49:
	* [[tag_monitor-on-success\|monitor/on-success]]		* [[tag_monitor-on-success\|monitor/on-success]]
	* [[tag_monitor-operations\|monitor/operations]]		* [[tag_monitor-operations\|monitor/operations]]
-	* [[tag_properties\|monitor/properties]]
	* [[tag_monitor-source\|monitor/source]]		* [[tag_monitor-source\|monitor/source]]

tag_monitor-source

2010-03-01T09:23:57+02:00

1267431837		current
Line 54:		Line 54:
	* [[tag_monitor-pre-post\|monitor/post]]		* [[tag_monitor-pre-post\|monitor/post]]
	* [[tag_monitor-pre-post\|monitor/pre]]		* [[tag_monitor-pre-post\|monitor/pre]]
-	* [[tag_properties\|monitor/properties]]

tag_properties

2010-03-02T09:02:16+02:00

1267516936		current
Line 1:		Line 1:
-	====== XML tag "monitor/properties" ======	+	====== XML tag "properties" ======

	The "''properties''" tag allows you to specify global properties.		The "''properties''" tag allows you to specify global properties.

transform_extension_pack

2011-11-15T18:42:08+02:00

1277985519		current
Line 34:		Line 34:

	[[compat_transform\|Compatibility matrix]]		[[compat_transform\|Compatibility matrix]]
		+
		+	=== 4.1.1 (2011-11-15) ===
		+	* [MITRA-15] - FIXED: cannot define multiple sources and destination of the same type in operation "[[operation_mapforce-transform\|mapforce-transform]]"

	=== 4.1.0 (2010-07-01) ===		=== 4.1.0 (2010-07-01) ===

trim_xml_attributes

2009-01-07T14:36:26+02:00

1231335346		current
Line 3:		Line 3:


-	Using the "[[operation_sed\|sed]]" operation you can remove leading and trailing whitespaces from attribute values in XML tags without touching the whitespaces in between words.	+	Using the "[[operation_sed\|sed]]" operation you can remove leading and trailing whitespace from attribute values in XML tags without touching the whitespace in between words.

	Removing leading whitespace (also trims empty attribute values):		Removing leading whitespace (also trims empty attribute values):

tutorial_xml-to-flf

2010-04-28T11:15:29+02:00

1272440099		current
Line 79:		Line 79:
	Instead of continuing to describe the XML structure in this way, we'll provide a sample structure showing the possible tags:		Instead of continuing to describe the XML structure in this way, we'll provide a sample structure showing the possible tags:

-	<code>	+	<code xml>
	<companylist>		<companylist>
	<company>		<company>
Line 132:		Line 132:
	This file is used to find out how the FLF text is structured. It contains a number of line definitions, and each line definition contains a number of field definitions. All of this is done using a specific XML format. The root element must have the name ''flf''. For each line definition you wish to use, an element with the name ''line'' should be added. Every line element has a mandatory attribute with the name ''key''. This attribute will provide an identifier for the line definition. The key attribute must be present, or the line definition can't be used. Also, a key can be used for only one line definition. Using the same key in two or more definitions will result in an error. \\		This file is used to find out how the FLF text is structured. It contains a number of line definitions, and each line definition contains a number of field definitions. All of this is done using a specific XML format. The root element must have the name ''flf''. For each line definition you wish to use, an element with the name ''line'' should be added. Every line element has a mandatory attribute with the name ''key''. This attribute will provide an identifier for the line definition. The key attribute must be present, or the line definition can't be used. Also, a key can be used for only one line definition. Using the same key in two or more definitions will result in an error. \\
	A basic FLF definition file could then look something like this: \\		A basic FLF definition file could then look something like this: \\
-	<code>	+	<code xml>
	<flf>		<flf>
	<line key="line1">		<line key="line1">
Line 153:		Line 153:
	The position attribute must be an integer. It must not necessarily be positive. The position is not an exact offset. So if, for example, we have one field with length 4 and another field with length 10, the position of the second field must not necessarily be 5. The first field can be given position 1 and the second position 2. Fields are ordered left to right within a line according to their position attributes, from lower to higher. The field tags do not need to be ordered within a line element according to their positions, but it is usually easier to do it that way and makes it clearer how the line is structured. The position attributes do not need to follow each other by increments of 1, but again this is the best approach.\\		The position attribute must be an integer. It must not necessarily be positive. The position is not an exact offset. So if, for example, we have one field with length 4 and another field with length 10, the position of the second field must not necessarily be 5. The first field can be given position 1 and the second position 2. Fields are ordered left to right within a line according to their position attributes, from lower to higher. The field tags do not need to be ordered within a line element according to their positions, but it is usually easier to do it that way and makes it clearer how the line is structured. The position attributes do not need to follow each other by increments of 1, but again this is the best approach.\\
	The FLF definition file could then take on a form like this:\\		The FLF definition file could then take on a form like this:\\
-	<code>	+	<code xml>
	<flf>		<flf>
	<line key="line1">		<line key="line1">
Line 180:		Line 180:
	All of these attributes can be used in any ''field'' element, and they will be remembered during your mapping for any field made with them.\\		All of these attributes can be used in any ''field'' element, and they will be remembered during your mapping for any field made with them.\\
	Consider the following scenario: we have a field that will contain a numeric value. Contrary to other fields, its contents should be aligned to the right, and the padding must be done using 0's. Truncation is not allowed, since it might affect the interpretation of the content. Also, if no content is mapped to the field, we wish it to appear in the line as a sequence of - symbols. Then our ''field'' element would look something like this:\\		Consider the following scenario: we have a field that will contain a numeric value. Contrary to other fields, its contents should be aligned to the right, and the padding must be done using 0's. Truncation is not allowed, since it might affect the interpretation of the content. Also, if no content is mapped to the field, we wish it to appear in the line as a sequence of - symbols. Then our ''field'' element would look something like this:\\
-	<code>	+	<code xml>
	<field name="numberfield" position="1" length="10" align="right" pad-char="0" truncate="error" fill-char="-"/>		<field name="numberfield" position="1" length="10" align="right" pad-char="0" truncate="error" fill-char="-"/>
	</code>		</code>
Line 199:		Line 199:
	Now that we know how an FLF definition file is structured, we can apply it to the scenario of company information described earlier. We had already given a description of each line and the fields it contains. This can be used to build our FLF definition. It would look like this:		Now that we know how an FLF definition file is structured, we can apply it to the scenario of company information described earlier. We had already given a description of each line and the fields it contains. This can be used to build our FLF definition. It would look like this:

-	<code>	+	<code xml>
	<flf>		<flf>
	<line key="COMP">		<line key="COMP">
Line 244:		Line 244:

	The first method could look, for example, as follows:\\		The first method could look, for example, as follows:\\
-	<code>	+	<code xml>
	<xml-to-flf>		<xml-to-flf>
	...		...
Line 254:		Line 254:

	The second method is somewhat more difficult. In this case, we have to write out our definition within the Integrator configuration. However, since the Integrator configuration itself is XML, simply putting in additional XML would disturb the validation. One way to fix this is to use XML character references, such as replacing < with <. It would look like this:\\		The second method is somewhat more difficult. In this case, we have to write out our definition within the Integrator configuration. However, since the Integrator configuration itself is XML, simply putting in additional XML would disturb the validation. One way to fix this is to use XML character references, such as replacing < with <. It would look like this:\\
-	<code>	+	<code xml>
	<xml-to-flf>		<xml-to-flf>
	...		...
Line 268:		Line 268:

	This is of course very unwieldy, so a better approach is to use XML's CDATA sections. Any content of a CDATA section is considered to be text and won't be parsed as XML markup. It could then look like this:\\		This is of course very unwieldy, so a better approach is to use XML's CDATA sections. Any content of a CDATA section is considered to be text and won't be parsed as XML markup. It could then look like this:\\
-	<code>	+	<code xml>
	<xml-to-flf>		<xml-to-flf>
	...		...
Line 286:		Line 286:

	Let's look at two approaches which are functionally the same, but where the second one is preferrable.\\		Let's look at two approaches which are functionally the same, but where the second one is preferrable.\\
-	<code>	+	<code xml>
	<loop-property name="flf_def" scope="local">		<loop-property name="flf_def" scope="local">
	<value>${system:montova.home}\conf\flf_configs\flf_first.xml</value>		<value>${system:montova.home}\conf\flf_configs\flf_first.xml</value>
Line 300:		Line 300:

	Another way to do this would be the following:\\		Another way to do this would be the following:\\
-	<code>	+	<code xml>
	<loop-property name="flf_def" scope="local">		<loop-property name="flf_def" scope="local">
	<value>first</value>		<value>first</value>
Line 336:		Line 336:
	Since it will be obvious that there is no single format for the XML definition as there was with the FLF definition, we'll immediately apply the definition to our sample. This, in combination with the FLF definition, will constitute a complete mapping from input XML to output FLF text. An explanation of each aspect follows afterwards.		Since it will be obvious that there is no single format for the XML definition as there was with the FLF definition, we'll immediately apply the definition to our sample. This, in combination with the FLF definition, will constitute a complete mapping from input XML to output FLF text. An explanation of each aspect follows afterwards.

-	<code>	+	<code xml>
	<companylist>		<companylist>
	<company start-line="COMP">		<company start-line="COMP">
Line 388:		Line 388:

	Mind that no indexes are kept to determine which ''company'' tag we're looking at. The parser is simply going to read the nodes one by one, and the expression being built will be used for finding the corresponding information in our XML definition file. In our XML definition, elements don't have to be repeated for each possible occurrence in the input. Thankfully so, because the input might have one ''company'', but could also have a hundred. The expression will simply be applied as an XPath expression to our XML definition file. So when we reach an ''emailaddress'' element, the expression given above will be applied to the XML definition and will retrieve the following element:\\		Mind that no indexes are kept to determine which ''company'' tag we're looking at. The parser is simply going to read the nodes one by one, and the expression being built will be used for finding the corresponding information in our XML definition file. In our XML definition, elements don't have to be repeated for each possible occurrence in the input. Thankfully so, because the input might have one ''company'', but could also have a hundred. The expression will simply be applied as an XPath expression to our XML definition file. So when we reach an ''emailaddress'' element, the expression given above will be applied to the XML definition and will retrieve the following element:\\
-	<code>	+	<code xml>
	<emailaddress start-line="MAIL">		<emailaddress start-line="MAIL">
	</code>		</code>

	In that element, we have indicated that we wish to start a new MAIL line. The definition for that line is sought in the FLF definition. It will find the following:\\		In that element, we have indicated that we wish to start a new MAIL line. The definition for that line is sought in the FLF definition. It will find the following:\\
-	<code>	+	<code xml>
	<line key="MAIL">		<line key="MAIL">
	<field name="id" length="4" position="1" init-value="MAIL"/>		<field name="id" length="4" position="1" init-value="MAIL"/>
Line 404:		Line 404:

	After some more parsing, we reach an ''email'' element. In the corresponding XML definition element, we have given a field name: "email". This is the name of the field to which the input ''email'' element must be mapped. We also know that we are currently working within the line with the "MAIL" key, since this was indicated earlier. The email field definition can be found in that line definition, and is looked up in our FLF definition file. What is found is this:\\		After some more parsing, we reach an ''email'' element. In the corresponding XML definition element, we have given a field name: "email". This is the name of the field to which the input ''email'' element must be mapped. We also know that we are currently working within the line with the "MAIL" key, since this was indicated earlier. The email field definition can be found in that line definition, and is looked up in our FLF definition file. What is found is this:\\
-	<code>	+	<code xml>
	<field name="email" length="32" position="2" truncate="error"/>		<field name="email" length="32" position="2" truncate="error"/>
	</code>		</code>
Line 440:		Line 440:

	Here is an example of the configuration for an xml-to-flf operation using only unchangeable file paths:\\		Here is an example of the configuration for an xml-to-flf operation using only unchangeable file paths:\\
-	<code>	+	<code xml>
	<xml-to-flf line-separator="#{0A}" count-start="0">		<xml-to-flf line-separator="#{0A}" count-start="0">
	<xml-configuration file="${system:montova.home}\conf\xml_configs\xml_definition.xml"/>		<xml-configuration file="${system:montova.home}\conf\xml_configs\xml_definition.xml"/>
Line 565:		Line 565:

	The XML input configuration is as follows:		The XML input configuration is as follows:
-	<code xml\|input_configuration.xml>	+	<code xml\| input_configuration.xml>
	<companylist>		<companylist>
	<company start-line="COMP">		<company start-line="COMP">
Line 608:		Line 608:

	The FLF output configuration is as follows:		The FLF output configuration is as follows:
-	<code xml\|output_configuration.xml>	+	<code xml\| output_configuration.xml>
	<flf>		<flf>
	<line key="COMP">		<line key="COMP">
Line 640:		Line 640:
	</flf>		</flf>
	</code>		</code>
		+
		+	The operation in an Integrator configuration could look like this:
		+	<code xml>
		+	<xml-to-flf line-separator="#{0D}#{0A}">
		+	<xml-configuration file="${system:montova.home}\conf\xml_configs\input_configuration.xml"/>
		+	<flf-configuration file="${system:montova.home}\conf\flf_configs\output_configuration.xml"/>
		+	</xml-to-flf>
		+	</code>
		+
		+	Using these configurations, the result of performing the operation on our company list sample is the following FLF text (all trailing white space is preserved):
		+	<code \| result.txt>
		+	COMPFoobar ltd.
		+	ADDRUnited States Oregon Portland 97086 Gibson st. 115
		+	CONTFoo Ling
		+	ADDRUnited States Oregon Portland 97086 Clarke Avenue 107
		+	PHON +1 321 1122334419Mobile number
		+	PHON +1 21 9144332211Business number
		+	MAILfooling@foobar-ltd.com Business mail
		+	CONTHarald Bar
		+	ADDRUnited States Oregon Portland 97086 Heinlein Boulevard 187
		+	PHON +1 21 9144332211Business number
		+	MAILharald.bar@foobar-ltd.com Business mail
		+	COMPAcme inc.
		+	ADDRBelgium Brussels Zaventem 1930 Belgiëstraat 11
		+	CONTJohn Doe
		+	PHON +32 498 1234567890Mobile number
		+	MAILjohn.doe@acme-inc.be Doe's mail
		+	</code>
		+
		+	This is a simple mapping and most of the functions it uses can be expected to be found in a typical project. \\
		+	In the input configuration, the only used attribute is ''start-line''. This is the minimum we can expect, since no mapping to output can occur if we don't start an FLF line first. Every element's content in the input is mapped to some output field. Often we will have mappings where some input is not mapped, either because we do not need the data or there are no fields in the FLF definition for it. \\
		+	In the output configuration we see the line and field definitions with all the mandatory attributes: ''key'', ''name'', ''length'' and ''position''. The first field of every line also has an ''init-value'' attribute. This makes sure that the field of a line is set to the supplied value when it is created. It is useful for fields that must have a constant value which is not supplied through the input, or to give a default value to a field should it not be overwritten. For the phonenumber field, we've used an ''align'' attribute with value "right" to indicate that we want the phone number must be placed in the right-hand side of the field. This alignment is typically used for numeric values. Finally, the ''truncate'' attribute was set to "error" for some fields, namely those fields that can't be safely truncated without losing their meaning. A street name longer than 32 letters would be truncated, but chances are we can still recognize it. However, should a phone number or postal code get truncated, it will then display incorrect information. So for such fields we explicitly prohibit truncation. If a value that is too long is written to such a field, an error will be thrown and the mapping will fail.
		+
		+	==== Count attribute ====
		+	Sometimes we want to map repeating elements in an XML document to different fields in the FLF output. The ''count'' attribute, usable in the input configuration, can help us with this. If it is set to "true", a counter is kept and incremented every time the same element in the input configuration is used. In other words, every time the path to the element with the count attribute is encountered, the counter is increased by 1. To use the counter, we can map to a field in our input configuration and indicate the number by using the '#' character.
		+
		+	An example will clarify this. Suppose we have an input document looking like this:
		+	<code xml>
		+	<root>
		+	<test>test1</test>
		+	<test>test2</test>
		+	<test>test3</test>
		+	...
		+	</root>
		+	</code>
		+
		+	We want each of the <test> elements to be mapped to sequential fields in the same FLF line. The FLF definition could be like this:
		+	<code xml>
		+	<flf>
		+	<line key="TEST">
		+	<field name="field1" length="6" position="1" />
		+	<field name="field2" length="6" position="2" />
		+	<field name="field3" length="6" position="3" />
		+	...
		+	</line>
		+	</flf>
		+	</code>
		+
		+	The ''count'' attribute can be used for this mapping as in the following input configuration:
		+	<code xml>
		+	<root start-line="TEST">
		+	<test count="true">field#</test>
		+	</root>
		+	</code>
		+
		+	We'll take a look at what happens when our input document is being parsed. \\
		+	First the element <root> is encountered. Our input configuration states that a new line with key "TEST" must be started. Within root, we then encounter the first <test> element. In the input configuration it is stated that a counter must be kept for this element. The counter is initialized to value 1 and it is remembered that the path for counting is "/root/test". We now want to map this element to the field with name "field#". Every occurrence of '#' in a field name is replaced with the current count value, so this gives us "field1". Input value "test1" gets mapped to that field. \\
		+	The next element is once again <test>. Just like before, the operation is going to notice that counting is on in the input configuration for that element. The path we were counting for is checked: "/root/test". This matches the current input path, so the counter is incremented from 1 to 2. Input value "test2" gets mapped to field "field2".
		+
		+	The counter is reset in the following circumstances:
		+	- A new line is started in the FLF output.
		+	- An element is encountered for which counting is enabled, but the path to this element is not the same as the previous count path. This is true by default for the first element on which counting starts. The count path is also cleared when a new output line is started.
		+	- The ''reset-count'' attribute with value "true" is used in the input configuration.
		+
		+	To see how the count attribute would be used in a more realistic example, we will adapt our company list sample. Up until now, a separate FLF line was started for each phone number and email address. We'll now look at an FLF definition where multiple phone numbers can be placed in one line, as well as multiple email addresses in one line. To make this a bit more readable, the "description" fields in lines PHON and MAIL will be removed.
		+
		+	We'll show the adjusted PHON and MAIL line definitions of the output configuration. The rest of the definition can remain as in the simple mapping:
		+	<code xml\| output_configuration>
		+	<line key="PHON">
		+	<field name="id" length="4" position="1" init-value="PHON"/>
		+	<field name="phonenumber1" length="24" position="2" align="right" truncate="error"/>
		+	<field name="phonenumber2" length="24" position="3" align="right" truncate="error"/>
		+	<field name="phonenumber3" length="24" position="4" align="right" truncate="error"/>
		+	<field name="phonenumber4" length="24" position="5" align="right" truncate="error"/>
		+	</line>
		+	<line key="MAIL">
		+	<field name="id" length="4" position="1" init-value="MAIL"/>
		+	<field name="email1" length="32" position="2" truncate="error"/>
		+	<field name="email2" length="32" position="3" truncate="error"/>
		+	<field name="email3" length="32" position="4" truncate="error"/>
		+	<field name="email4" length="32" position="5" truncate="error"/>
		+	</line>
		+	</code>
		+
		+	Likewise, the parts of the input configuration that are changed are shown here:
		+	<code xml\| input_configuration>
		+	<phonenumbers start-line="PHON">
		+	<phonenumber count="true">
		+	<number>phonenumber#</number>
		+	</phonenumber>
		+	</phonenumbers>
		+	<emailaddresses start-line="MAIL">
		+	<emailaddress count="true">
		+	<email>email#</email>
		+	</emailaddress>
		+	</emailaddresses>
		+	</code>
		+
		+	The first change is that a new PHON line is started on element <phonenumbers> and not for each <phonenumber>. For the email info, a new MAIL line is started on element <emailaddresses> instead of each <emailaddress>. The <phonenumber> element now has a count attribute, just like the <emailaddress> element. Mind that we did not put the attribute on the <number> and <email> elements, although it would actually work in this situation. Another change is that the field names now contain the '#' character to indicate the position where the counter must be filled in. Finally, the <description> elements no longer appear in the configuration. They might appear in the actual input document, but since they won't be found in the configuration they'll just be ignored.
		+
		+
		+
		+

validate_xml_to_xsd

2011-06-17T10:46:32+02:00

	current
Line 1:	Line 1:
	+	====== Validate an XML message to an XSD schema ======

	+	This can be done using a bit Java trickery, using the "[[operation_run-java-code\|run-java-code]]" operation.
	+	<code xml>
	+	<run-java-code data="bytes">
	+	try {
	+	javax.xml.validation.SchemaFactory factory = javax.xml.validation.SchemaFactory.newInstance("http://www.w3.org/2001/XMLSchema");
	+	java.io.File schemaLocation = new java.io.File("c:/Work/Invoice_AC_AIRPOWER.xsd");
	+	javax.xml.validation.Schema schema = factory.newSchema(schemaLocation);
	+	javax.xml.validation.Validator validator = schema.newValidator();
	+	javax.xml.transform.Source source = new javax.xml.transform.stream.StreamSource(new java.io.ByteArrayInputStream(data));
	+	validator.validate(source);
	+	return data;
	+	} catch (Exception e) {
	+	throw new com.brain2.montova.MontovaException("message \"" + message.getTransaction() + "\" was invalid: " + e.getMessage(), e);
	+	}
	+	</run-java-code>
	+	</code>

xml_extension_pack

2011-09-22T10:33:28+02:00

1289910877		current
Line 31:		Line 31:

	===== Changelog ======		===== Changelog ======
		+
		+	=== 4.1.1 (2011-09-22) ===
		+	* fixed bug where "[[operation_split-xpath\|split-xpath]]" didn't properly commit/backout its pipeline on success/failure

	=== 4.1.0 (2009-05-04) ===		=== 4.1.0 (2009-05-04) ===

xml_root_pipelines

2010-03-02T09:02:16+02:00

	current
Line 1:	Line 1:
	+	====== Executing different pipelines depending on the root element of an XML message ======

	+	The XPath expression "name(/*)" will select the name of the root element. Feed that expression into an [[operation_extract-property\|extract-property]] operation, and use a [[operation_switch\|switch-construct]] to execute different operations depending on the extracted name. Here's how:
	+
	+	<code xml>
	+	<extract-property name="xml.root">
	+	<xpath>name(/*)</xpath>
	+	</extract-property>
	+
	+	<switch value="${message:xml.root}">
	+	<case value="REQUEST">
	+	<!-- ... -->
	+	</case>
	+	<case value="CANCEL">
	+	<!-- ... -->
	+	</case>
	+	</switch>
	+	</code>

xslt2_stylevision

2011-05-04T08:56:34+02:00

1267516936		current
Line 1:		Line 1:
	There's no (free) XSLT 2.0 Java library to handle the FO output from Altova StyleVision correctly, so we can't use the "xslt-fo" operation. One solution, albeit Windows-specific, is to call Altova's very own XSLT engine to do the conversion:		There's no (free) XSLT 2.0 Java library to handle the FO output from Altova StyleVision correctly, so we can't use the "xslt-fo" operation. One solution, albeit Windows-specific, is to call Altova's very own XSLT engine to do the conversion:

-	<code xml\|configuration.xml>	+	<code xml configuration.xml>
	<configuration>		<configuration>
	<monitors>		<monitors>

1332949790		current
Line 12:		Line 12:
	\| [[Domino extension pack]] \| 4.1.0 \| 2010-07-01 \|		\| [[Domino extension pack]] \| 4.1.0 \| 2010-07-01 \|
	\| [[HL7 extension pack]] \| 4.1.0 \| - \|		\| [[HL7 extension pack]] \| 4.1.0 \| - \|
-	\| [[Internet extension pack]] \| 4.1.15 \| 2012-03-14 \|	+	\| [[Internet extension pack]] \| 4.1.15 \| 2012-03-28 \|
	\| [[iSeries extension pack]] \| 4.1.0 \| 2010-07-01 \|		\| [[iSeries extension pack]] \| 4.1.0 \| 2010-07-01 \|
	\| [[PDF extension pack]] \| 4.1.0 \| 2010-07-01 \|		\| [[PDF extension pack]] \| 4.1.0 \| 2010-07-01 \|

1270025471		current
Line 12:		Line 12:
	\| ''[[ml_filesystem\|filesystem]]'' \| Read/write files from/to a local filesystem. \| [[engine pack]] \|		\| ''[[ml_filesystem\|filesystem]]'' \| Read/write files from/to a local filesystem. \| [[engine pack]] \|
	\| ''[[ml_ftp\|ftp]]'' \| Read/write files from/to a remote FTP(S) server. \| [[Internet extension pack]] \|		\| ''[[ml_ftp\|ftp]]'' \| Read/write files from/to a remote FTP(S) server. \| [[Internet extension pack]] \|
-	\| ''[[ml_http-post\|http-post]]'' \| POST data to a remote HTTP server. \| [[Internet extension pack]] \|	+	\| ''[[ml_http-get\|http-get]]'' \| Retrieve data from a remote HTTP server using the GET method. \| [[Internet extension pack]] \|
		+	\| ''[[ml_http-post\|http-post]]'' \| Send data to a remote HTTP server using the POST method. \| [[Internet extension pack]] \|
		+	\| ''[[ml_http-put\|http-put]]'' \| Send data to a remote HTTP server using the PUT method. \| [[Internet extension pack]] \|
	\| ''[[ml_imap\|imap]]'' \| Read mail messages from a remote IMAP server. \| [[Internet extension pack]] \|		\| ''[[ml_imap\|imap]]'' \| Read mail messages from a remote IMAP server. \| [[Internet extension pack]] \|
	\| ''[[ml_mqseries\|mqseries]]'' \| Read/write files from a queue on a local or remote queue manager. \| [[engine pack]] \|		\| ''[[ml_mqseries\|mqseries]]'' \| Read/write files from a queue on a local or remote queue manager. \| [[engine pack]] \|

1269853763		current
Line 1:		Line 1:
	====== Message Location "as400-ifs" ======		====== Message Location "as400-ifs" ======

-	__Pack__: [[ml_named-pipe\|iSeries extension pack]]	+	__Pack__: [[iseries_extension_pack\|iSeries extension pack]]

	Accesses the Integrated File System (IFS) on a local/remote iSeries machine.		Accesses the Integrated File System (IFS) on a local/remote iSeries machine.
Line 7:		Line 7:
	===== Configuration =====		===== Configuration =====

-	^ Child ^ Description ^ Default ^ Req? ^ [[ml_named-pipe\|Dyn]]? ^ Since ^	+	^ Child ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''system-name'' \| hostname or IP address of remote iSeries machine \| "localhost" \| - \| - \| 1.0 \|		\| ''system-name'' \| hostname or IP address of remote iSeries machine \| "localhost" \| - \| - \| 1.0 \|
	\| ''user-id'' \| user ID of user profile to log in with \| - \| - \| - \| 1.0 \|		\| ''user-id'' \| user ID of user profile to log in with \| - \| - \| - \| 1.0 \|
Line 17:		Line 17:
	\| ''file-mask'' \| mask to determine which files to get \| - \| - \| {{ :yes.gif }} (3.0) \| 1.0 \|		\| ''file-mask'' \| mask to determine which files to get \| - \| - \| {{ :yes.gif }} (3.0) \| 1.0 \|

-	^ Attribute ^ Description ^ Default ^ Req? ^ [[ml_named-pipe\|Dyn]]? ^ Since ^	+	^ Attribute ^ Description ^ Default ^ Req? ^ [[dynamic\|Dyn]]? ^ Since ^
	\| ''overwrite'' \| overwrite if the file already exists? \| "false" \| - \| {{:yes.gif}} \| 1.0 \|		\| ''overwrite'' \| overwrite if the file already exists? \| "false" \| - \| {{:yes.gif}} \| 1.0 \|
	\| ''__file-mask__/re'' \| is file mask a regular expression? \| "true" \| - \| {{ :yes.gif }} (3.0) \| 1.0 \|		\| ''__file-mask__/re'' \| is file mask a regular expression? \| "true" \| - \| {{ :yes.gif }} (3.0) \| 1.0 \|

1321859208		current
Line 13:		Line 13:
	\| ''port'' \| TCP port \| "21" \| - \| - \| 1.0 \|		\| ''port'' \| TCP port \| "21" \| - \| - \| 1.0 \|
	\| ''ssl-mode'' \| SSL mode for FTPS servers; one of "none", "explicit" or "implicit" \| "none" \| - \| - \| 4.1.0 \|		\| ''ssl-mode'' \| SSL mode for FTPS servers; one of "none", "explicit" or "implicit" \| "none" \| - \| - \| 4.1.0 \|
-	\| ''secure-data-connection'' \| setup an encrypted data channel? \| "false" \| - \| - \| 4.1.7 \|	+	\| ''secure-data-connection'' \| setup an encrypted data channel? \| "false" \| - \| - \| 4.1.8 \|
	\| ''username'' \| user name to login \| "anonymous" \| - \| - \| 1.0 \|		\| ''username'' \| user name to login \| "anonymous" \| - \| - \| 1.0 \|
	\| ''password'' \| password to login \| - \| - \| - \| 1.0 \|		\| ''password'' \| password to login \| - \| - \| - \| 1.0 \|

1267516936		current
Line 13:		Line 13:
	\| ''password'' \| password \| - \| {{:yes.gif}} \| - \| - \|		\| ''password'' \| password \| - \| {{:yes.gif}} \| - \| - \|
	\| ''folder'' \| folder name \| "INBOX" \| - \| - \| - \|		\| ''folder'' \| folder name \| "INBOX" \| - \| - \| - \|
		+
		+	===== Properties =====
		+
		+	The metadata of the fetched message is set in the following properties:
		+
		+	^ Property ^ Description ^ Example ^ GET? ^ PUT? ^ Since ^
		+	\| ''${message:mail.folder}'' \| the folder from which this message was retrieved \| "INBOX" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.subject}'' \| the subject of the retrieved message \| "Message for you sir!" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.from}'' \| the sender of the retrieved message \| "wile@acme.com" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.to}'' \| comma-separated list of recipients of the retrieved message \| "bugs@acme.com,rrunner@acme.com" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.cc}'' \| comma-separated list of carbon-copy recipients of the retrieved message \| "tweety@acme.com" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.reply-to}'' \| the address to which the sender would like you to reply \| "coyote@acme.com" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|
		+	\| ''${message:mail.content-type}'' \| the MIME type of the retrieved message \| "application/pdf" \| {{:yes.gif}} \| {{:no.gif}} \| {{:question.gif}} \|

	===== Examples =====		===== Examples =====

1267516936		current
Line 6:		Line 6:

	Gets a Lotus Domino Document by UNID.		Gets a Lotus Domino Document by UNID.
-
	===== Configuration =====		===== Configuration =====

	^ Child ^ Description ^ Default ^ Req? ^ Dyn? ^ Since ^		^ Child ^ Description ^ Default ^ Req? ^ Dyn? ^ Since ^
-	\| ''server'' \| Lotus Domino server \| "localhost" \| - \| - \| 3.6.0 \|	+	\| ''server'' \| Lotus Domino server \| "localhost" \| - \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''diiop-port'' \| DIIOP port \| "63148" \| - \| - \| 3.6.0 \|	+	\| ''diiop-port'' \| DIIOP port \| "63148" \| - \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''user'' \| Lotus Domino Internet user to log in with \| - \| {{:yes.gif}} \| - \| 3.6.0 \|	+	\| ''user'' \| Lotus Domino Internet user to log in with \| - \| {{:yes.gif}} \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''password'' \| password of user profile to log in with \| - \| {{:yes.gif}} \| - \| 3.6.0 \|	+	\| ''password'' \| password of user profile to log in with \| - \| {{:yes.gif}} \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
-	\| ''database'' \| Domino database in which to create document \| - \| {{:yes.gif}} \| - \| 3.6.0 \|	+	\| ''database'' \| Domino database in which to create document \| - \| {{:yes.gif}} \| {{:yes.gif}} \\ 4.1.0 \| 3.6.0 \|
	\| ''UNID'' \| Lotus Notes Universal ID (UNID) of the document \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 3.6.0 \|		\| ''UNID'' \| Lotus Notes Universal ID (UNID) of the document \| - \| {{:yes.gif}} \| {{:yes.gif}} \| 3.6.0 \|
-	\| ''include-attachments'' \| whether or not to include attachments \| "false" \| - \| - \| 4.0.0 \|	+	\| ''include-attachments'' \| whether or not to include attachments \| "false" \| - \| {{:yes.gif}} \\ 4.1.0 \| 4.0.0 \|
-	\| ''include-fields'' \| comma-separated list of fields to include; all fields will be included if not specified \| - \| - \| {{:yes.gif}} \| 4.0.0 \|	+	\| ''include-fields'' \| comma-separated list of fields to include; all fields will be included if not specified \| - \| {{:yes.gif}} \\ 4.1.0 \| {{:yes.gif}} \| 4.0.0 \|
-	\| ''exclude-fields'' \| comma-separated list of fields to exclude; all fields will be included if not specified \| - \| - \| {{:yes.gif}} \| 4.0.0 \|	+	\| ''exclude-fields'' \| comma-separated list of fields to exclude; all fields will be included if not specified \| - \| {{:yes.gif}} \\ 4.1.0 \| {{:yes.gif}} \| 4.0.0 \|
-	\| ''split-multivalue'' \| split multivalues in seperated xml elements \| "false" \| - \| - \| 4.1.0 \|	+	\| ''split-multivalue'' \| split multivalues in seperated xml elements \| "false" \| - \| {{:yes.gif}} \\ 4.1.0 \| 4.1.0 \|
	\| ''encoding'' \| encoding of output XML document \| "UTF-8" \| - \| {{:yes.gif}} \| 4.1.0 \|		\| ''encoding'' \| encoding of output XML document \| "UTF-8" \| - \| {{:yes.gif}} \| 4.1.0 \|

Line 29:		Line 28:
	\| ''retry-count'' \| number of retries \| - \| 3 \| - \| - \| 4.1.0 \|		\| ''retry-count'' \| number of retries \| - \| 3 \| - \| - \| 4.1.0 \|
	\| ''wait-after-retry'' \| how long to wait in between document get attempts (in milliseconds) \| - \| 500 \| - \| - \| 4.1.0 \|		\| ''wait-after-retry'' \| how long to wait in between document get attempts (in milliseconds) \| - \| 500 \| - \| - \| 4.1.0 \|
		+	\| ''__database__/keep-open'' \| keep the database open? when false, child values will be dynamic \| "true" \| - \| - \| 4.1.0 \|

	===== Document locking & timestamp checks =====		===== Document locking & timestamp checks =====