Stambia Actions Reference

Preface

This guide contains reference information about using the product to design and develop a Data Integration project.

Audience

This document is intended for users interested in using Stambia for their Data Integration Initiatives : Business Intelligence, Data Migration, E-commerce projects, Web Services, etc..

Document Conventions

This guide uses the following formatting conventions:

Convention	Meaning
boldface	Boldface type indicates a graphical user interface associated with an action, or a product specific term or concept.
italic	Italic type indicates a special emphasis or placeholder variable that you need to provide.
`monospace`	Monospace type indicates code example, text or commands that you enter.

Other Stambia Resources

In addition to the product manuals, Stambia provides other resources available on its company website: www.stambia.com and community website www.stambia.org.

Obtaining Help

To get help you can:

contact our global Technical Support Center: www.stambia.org/di/support.
consult the articles on our community website www.stambia.org.
consult or post topics on our forum on www.stambia.org.

Feedback

We welcome your comments and suggestions on the quality and usefulness of this documentation.
If you find any error or have any suggestion for improvement, please contact us at www.stambia.org/di/support and indicate the title of the documentation along with the chapter, section, and page number, if available. Please let us know if you want a reply.

Files

File actions perform operations in the Runtime engine file system.

Certain actions can provide the list of the files they manipulated:

This list can be stored in a table named IND_SESSION_FILE_OP_LST
1. Provide a SQL Connection to the action or define a Rdbms metadata link on the action
2. A table named IND_SESSION_FILE_OP_LST is automatically created and populated in the corresponding schema.
This list can be used through a bind link
1. Add a bind link to the action
2. Use the columns in the target action with the bind syntax. For instance: :{FILE_NAME}:

The following columns are available:

Column Name	Description
SESS_ID	ID of the Session in which the file operation has been performed. This can be used in conjunction with ${/CORE_SESSION_ID}$ to retrieve the list of files of a specific Session.
SESS_NAME	Name of the Session in which the file operation has been performed.
ACT_ID	ID of the Action which performed the operation. This can be used in conjunction with ${CORE_ACTION_ID}$ to retrieve the list of files of a specific Action.
ACT_NAME	Name of the Action which performed the operation
ACT_ITER	Action iteration number.
FILE_ID	A number corresponding to the position of the file in the operation queue.
FILE_OPERATION	File operation executed. E.g. «Wait», «Copy», ...
FILE_NAME	The file name.
FILE_DIR	Directory where the file is stored.
FILE_FROM_DIR	Original folder of the file.
FILE_FROM_FILE	Original file.
FILE_TO_DIR	Target directory.
FILE_TO_FILE	Target file.
FILE_OPERATION_DATE	Date when the operation has been performed on the file.
FILE_IS_HIDDEN	Indicates if the file is a hidden file in the file system (1=Yes, 0=No).
FILE_LAST_MODIFIED	Last modification timestamp.
FILE_LAST_MODIFIED_DATE	Last modification date.
FILE_CAN_READ	Indicates if the Runtime can read the file (1=Yes, 0=No).
FILE_CAN_WRITE	Indicates if the Runtime can write the file (1=Yes, 0=No).
FILE_CAN_EXECUTE	Indicates if the Runtime can execute the file (1=Yes, 0=No).
FILE_IS_DIRECTORY	Indicates if the file is a directory (1=Yes, 0=No).
FILE_LENGTH	Size of the file in Bytes.

Move Files

Description

Moves a set of files on the Runtime engine file system. This action also allows to store in a table the list of moved files.

Parameters

Name	Mandatory	Default	Description
File To Dir			Target directory. Mandatory if File to File is not set.
File To File			Target file. Mandatory if File to Dir is not set.
File From Dir			Source directory. Use with File Includes and File Excludes.
File From File			Source file.
File Overwrite Mode	No	NOT	Overwrite behavior. NOT: Never overwrite. ALWAYS: Always overwrite, NEWER: Overwrite older file, AFTER_DELAY: overwrite only files older by more than File Overwrite Delay (milliseconds).
File Overwrite Delay	No	0	Delay in milliseconds after which the file is considered older. Used with File Overwrite Mode = AFTER DELAY.
File Includes Empty Dirs	No	False	In recursive mode, defines whether empty directories are moved.
File Flatten Model	No	False	In recursive mode, defines whether the directory hierarchy is flattened.
File Preserve Last Modified	No	False	If set to yes, the original update date of the file is preserved.
File Includes	No		List of files to include. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
File Excludes	No		List of files to exclude. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
File Target Mapper	No		Correspondence mask for file names. For example: `.txt = BI.txt`.
SQL Connection	No		SQL connection into which the list of moved files is published.
SQL Transaction Name	No		SQL transaction into which the list of moved files is published.
SQL Schema Name	No		SQL schema into which the list of moved files is published.

Published Variables

Name	Description
FILE_NB	Number of files moved.

Copy Files

Description

Copies a set of files on the Runtime engine file system. This action also allows to store in a table the list of copied files.

Parameters

Name	Mandatory	Default	Description
File To Dir			Target directory. Mandatory if File to File is not set.
File To File			Target file. Mandatory if File to Dir is not set.
File From Dir			Source directory. Use with File Includes and File Excludes.
File From File			Source file.
File Overwrite Mode	No	NOT	Overwrite behavior. NOT: Never overwrite. ALWAYS: Always overwrite, NEWER: Overwrite older file, AFTER_DELAY: overwrite only files older by more than File Overwrite Delay (milliseconds).
File Overwrite Delay	No	0	Delay in milliseconds after which the file is considered older. Used with File Overwrite Mode = AFTER DELAY.
File Includes Empty Dirs	No	False	In recursive mode, defines whether empty directories are copied.
File Flatten Model	No	False	In recursive mode, defines whether the directory hierarchy is flattened.
File Preserve Last Modified	No	False	If set to yes, the original update date of the file is preserved.
File Includes	No		List of files to include. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
File Excludes	No		List of files to exclude. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
File Target Mapper	No		Correspondence mask for file names. For example: `.txt = BI.txt`.
SQL Connection	No		SQL connection into which the list of copied files is published.
SQL Transaction Name	No		SQL transaction into which the list of copied files is published.
SQL Schema Name	No		SQL schema into which the list of copied files is published.

Published Variables

Name	Description
FILE_NB	Number of files copied.

Delete Files

Description

Deletes a set of files in the Runtime engine file system. This action also allows to store in a table the list of deleted files.

Parameters

Name	Mandatory	Default	Description
Del Dir			Directory to Delete. Use with Del Includes and Del Excludes.
Del File			File to Delete. Note that both Del Dir and Del File can be used simultaneously. This will cause the two delete operations.
Del Includes	No		List of files to include. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
Del Excludes	No		List of files to exclude. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
Del Fails on Error	No	True	The action completes in error state if a file cannot be deleted.
Del Include Empty Dirs			In recursive mode, defines whether empty directories are deleted
SQL Connection	No		SQL connection into which the list of deleted files is published.
SQL Transaction Name	No		SQL transaction into which the list of deleted files is published.
SQL Schema Name	No		SQL schema into which the list of deleted files is published.

Published Variables

Name	Description
FILE_NB	Number of files deleted.

Write a File

Description

Creates a file in the Runtime engine file system and writes a text in this file.
The text written in this file is the text entered in the Code of the action (in the expression editor).

Parameters

Name	Mandatory	Default	Description
Txt Write Filename	Yes		Full path of the file to write.
Txt Write Newline Char	No		Line separator. Can be for example ‹\n› or ‹\r\n› or any string
Txt Write Encoding	No		Java charset of the file. The system charset is used by default.
Txt Write Append	No	False	If the file exists, append the text to it.
Txt Write Append Line Separator	No	True	Automatically add a line separator at the end of the file.

Make a Directory

Description

Creates a directory in the Runtime engine file system. This action also allows to store in a table the created directory.

Parameters

Name	Mandatory	Default	Description
File Dir	Yes		Full path of the directory to create.
File Fails on Error	No	False	The action completes in error state if a directory cannot be created.
SQL Connection	No		SQL connection into which the created directory is published.
SQL Transaction Name	No		SQL transaction into which the created directory is published.
SQL Schema Name	No		SQL schema into which the created directory is published.

Zip Files

Description

Compresses a set of files in ZIP format in the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
Zip To File	Yes		Target file.
File From Dir	Yes		Source directory containing the files to compress.
Zip Includes	No		List of files to include. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
Zip Excludes	No		List of files to exclude. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
Zip Compress	No	True	If set to true, the archive is compressed.
Zip Update	No	False	Update the zip file if it already exists.
Zip Encoding	No		Zip file encoding.
Zip Action If Empty	No	Skip	Behavior when no file corresponds to the selection: fail the action, skip it or create the zip file anyway.
Zip Action If Duplicated File	No	Add	Behavior when a file duplicate is found: fail the action, preserve the current file or add the new file.
Zip Comment	No		Comment to add to the archive.
Zip Compression Level	No	-1	Compression level. Can range from 0: No compression to 9:Maximum Compression

BZip File

Description

Compresses a file in BZIP format in the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
BZip To File	Yes		Target file.
BZip From File	Yes		Source file to compress.

GZip File

Description

Compresses a file in GZIP format in the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
GZip To File	Yes		Target file.
GZip From File	Yes		Source file to compress.

Tar Files

Description

Compresses a set of files in tar format in the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
Tar To File	Yes		Target file.
Tar From Dir	Yes		Source directory containing the files to compress.
Tar Includes	No		List of files to include. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
Tar Excludes	No		List of files to exclude. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
Tar Compression Method	No	none	Compression method used for the tarball file: none, gzip or bzip.
Tar Longfile Method	No	warn	Behavior for files with long names (greater than 100 characters): truncate the name, fail the action or simply warn, omit the file or use GNU file extensions to store long file names in the archive.

Unzip File

Description

Uncompresses a ZIP file in the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
Unzip From File	Yes		File to uncompress.
Unzip To Dir	Yes		Target directory.
Unzip Encoding	No		Zip file encoding.
Unzip Overwrite	No	true	Set to true to overwrite existing files in the target directory.

BUnzip File

Description

Uncompresses a file in BZIP format in the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
Bunzip From File	Yes		File to uncompress.
Bunzip To File	Yes		Target file.

GUnzip File

Description

Uncompresses a file in GZIP format in the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
Gunzip From File	Yes		File to uncompress.
Gunzip To File	Yes		Target file.

Untar File

Description

Uncompresses a TAR file in the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
Untar From File	Yes		File to uncompress.
Untar To Dir	Yes		Target directory.
Untar Compression Method	No		Compression method used for the tarball file: none, gzip or bzip.
Untar Overwrite	No	true	Set to true to overwrite existing files in the target directory.

Wait for Files

Description

Waits and detects a set of files on the Runtime engine file system using the poll technique. This Action also allows to bind the result or store in a table the list of detected files.

Parameters

Name	Mandatory	Default	Description
Wait File Dir			Detection directory. Mandatory if Wait File is not set or if Wait File Includes/Excludes are set.
Wait File			File to detect. Mandatory if Wait File Dir is not set.
Wait File Includes	No		List of files to include. This is a semi-colon separated list of file masks. The `` wildcard can be used to filter the files, and the `` wildcard can be used to retrieve also the files inside subdirectories. For instance to retrieve files contained in the current directory: `.xls;.xml;file.csv`. And to retrieve files contained in the current directory and subdirectories: `/.csv`
Wait File Excludes	No		List of files to exclude. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
Wait File Timeout	No	See description	Timeout in milliseconds after which the action stops trying to detect the files. -1 is an infinite waiting time. The default value is 1 if Wait File Nb Files=-1 and -1 otherwise.
Wait File Pollint	No	1000	Polling interval in milliseconds.
Wait File Nb Files	No	1	Number of files to wait for before completing the wait action. -1 means an infinite number of files.
SQL Connection	No		SQL connection into which the list of detected files is published.
SQL Transaction Name	No		SQL transaction into which the list of detected files is published.
SQL Schema Name	No		SQL schema into which the list of detected files is published.

Published Variables

Name	Description
FILE_NB	Number of files detected.

Concat Files

Description

Concatenates a set of files on the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
Out File Name	Yes		Target concatenated file.
In File Mask	Yes		Mask of the files to concatenate.
Header Text	No		Header text to remove in each file.
Header Size	No		Number of header characters to remove in each file.
Footer Text	No		Footer text to remove in each file.
Footer Size	No		Number of footer characters to remove in each file.
Keep Header On First	No	True	Keep the header on the first file concatenated.
Keep Footer On Last	No	True	Keep the footer on the last file concatenated.
Append Mode	No	false	If the target file already exists, append the concatenated files to it.
File Buffer Size	No		Size of the file buffer.
File Separator	No	System’s line break	ASCII separator written between each file content. It may be composed of several characters. \n, \r, \t and \f can be used to specify special characters.
File Xseparator	No		Hexadecimal separator written between each file content. It may be composed of several characters.

Published Variables

Name	Description
IN_NB_FILES	Number of files processed.
OUT_FILE_SIZE	Size of the target file.

XSLT Transformation

Description

Transforms an XML file into another XML file using a XSL-Transformation in the Runtime engine file system.

Parameters

Name	Mandatory	Description
In File Name	Yes	Source XML file.
Out File Name	Yes	Target (transformed) XML file.
XSLT File Name	No	Name of the XSL-Transform file.

Internet and Networking

Get Files with FTP

Description

Downloads a set of files from an FTP server to the Runtime engine file system.
The complete list of manipulated files is also returned by the action, see below for further information.

Parameters

Name	Mandatory	Default	Description
FTP Hostname	Yes		FTP host name or IP address.
FTP Port	No	21 in normal mode, 990 in secure mode.	FTP host port.
FTP User	Yes		FTP user.
FTP Password			This user’s encrypted password.
FTP Unencrypted Password			This user’s password in plain text.
FTP Remote Filename	No		Remote file name or pattern.
FTP Remote Path	No		Remote FTP path.
FTP Local Filename	No		Local file name. May be a name pattern if FTP Multiple Mode is set to true.
FTP Local Path	No		Local file path.
FTP File Mode	No	ascii	FTP file transfer mode: ascii or binary.
FTP Wait Mode	No	false	If set to true, the action waits for files to be detected on the remote host.
FTP Nb Files	No	1 if FTP Wait Mode is true, -1 if FTP Wait Mode is false.	Number of files to wait for. -1 stands for an infinite number of files.
FTP Wait Timeout	No	-1	Maximum waiting time. -1 stands for an infinite timeout.
FTP Wait Pollint	No	1000	Polling interval in milliseconds.
FTP Multiple Mode	No	true	Get multiple files from the FTP server. Use a name pattern for the FTP Remote Filename.
FTP Passive Mode	No	true	Use FTP passive (PASV) mode.
Delete File After Transfer	No	False	Delete the files on the remote server after the transfer.
FTP Disable Login	No	false	If true, the connection to the server will be performed anonymously, without using the login credentials.
FTP Implicit FTPs	No	true	Use FTPs Implicit mode.
FTP Secured Protocol	No	None	Protocol used for FTPs communication: none, tls, ssl
FTP Encrypt Channel Data	No	false	If set to true, channel data will be encrypted as specified by the PROT native FTP command.
FTP Protection Buffer Size	No		Defines the size to use for the Protection Buffer. Please refer to your FTP server provider for the possible values.
FTP System Type	No		Specifies the system type of the FTP Server. This helps to better treat the responses of the server. By default, the Runtime will try to auto-detect it. The following types are supported: UNIX,VMS,WINDOWS,OS/2,OS/400,AS/400,MVS,TYPE: L8,NETWARE
Ignore Trust Store	No	false	If true, the specified Trust Store will be ignored.
Proxy Host	No		Host name for the proxy server.
Proxy Port	No	1080	Port of the proxy server.
Proxy User	No		Proxy server user.
Proxy Password	No		Proxy server user password, encrypted.
Proxy Unencrypted Password	No		Proxy server user password in plain text.
Proxy Protocol	No		Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .
Socket Timeout	No		Set the timeout in milliseconds of a currently open connection.
Connection Timeout	No		Set the timeout in milliseconds when opening a connection.
Data Timeout	No		Set the timeout in milliseconds on the data connection.
SQL Connection	No		SQL connection into which the list of downloaded files is published.
SQL Transaction Name	No		SQL transaction into which the list of downloaded files is published.
SQL Schema Name	No		SQL schema into which the list of downloaded files is published.
Key Store	No		Full path to the Java Key Store to use when connecting to the server.
Key Store Type	No	JKS	Type of the Java Key Store.
Key Store Password	No		Encrypted password of the Java Key Store.
Trust Store	No		Full path to the Java Trust Store to use when connecting to the server.
Trust Store Type	No	JKS	Type of the Java Trust Store.
Trust Store Password	No		Encrypted password of the Java Trust Store.

Published Variables

Name	Description
FILE_NB	Number of files downloaded.

List of treated files

This action also provides the list of manipulated files:

This list can be stored in a table named IND_SESSION_FILE_OP_LST
1. Provide a SQL Connection to the action or define a Rdbms schema metadata link on the action
2. A table named IND_SESSION_FILE_OP_LST is automatically created and populated in the corresponding schema.
This list can also be used through a bind link
1. Add a bind link to the action
2. Use the columns in the target action with the bind syntax. For instance: :{FILE_NAME}:

The available columns / bind variables are the following:

Column Name	Description
SESS_ID	ID of the Session in which the file operation has been performed.
SESS_NAME	Name of the Session in which the file operation has been performed.
ACT_ID	ID of the Action which performed the operation.
ACT_NAME	Name of the Action which performed the operation
ACT_ITER	Action iteration number.
FILE_ID	A number corresponding to the position of the file in the operation queue.
FILE_OPERATION	File operation executed. For this action this will be ‹FtpGet›
FILE_NAME	The file name.
FILE_DIR	Directory where the file is stored.
FILE_FROM_DIR	Original folder of the file.
FILE_FROM_FILE	Original file.
FILE_TO_DIR	Target directory.
FILE_TO_FILE	Target file.
FILE_OPERATION_DATE	Date when the operation has been performed on the file.
FILE_IS_HIDDEN	Indicates if the file is a hidden file in the file system (1=Yes, 0=No).
FILE_LAST_MODIFIED	Last modification timestamp.
FILE_LAST_MODIFIED_DATE	Last modification date.
FILE_CAN_READ	Indicates if the Runtime can read the file (1=Yes, 0=No).
FILE_CAN_WRITE	Indicates if the Runtime can write the file (1=Yes, 0=No).
FILE_CAN_EXECUTE	Indicates if the Runtime can execute the file (1=Yes, 0=No).
FILE_IS_DIRECTORY	Indicates if the file is a directory (1=Yes, 0=No).
FILE_LENGTH	Size of the file in Bytes.

Send Files with FTP

Description

Uploads a set of files to an FTP server from the Runtime engine file system. This action also allows to store in a table the list of uploaded files.

Parameters

Name	Mandatory	Default	Description
FTP Hostname	Yes		FTP host name or IP address.
FTP Port	No	21 in normal mode, 990 in secure mode.	FTP host port.
FTP User	Yes		FTP user.
FTP Password			This user’s encrypted password.
FTP Unencrypted Password			This user’s password in plain text.
FTP Remote Filename	No		Remote file name. Ignored if FTP Multiple Mode is set to true.
FTP Remote Path	No		Remote FTP path.
FTP Local Filename	No		Local file name. May be a name pattern if FTP Multiple Mode is set to true.
FTP Local Path	No		Local file path.
FTP File Mode	No	ascii	FTP file transfer mode: ascii or binary.
FTP Append	No	false	Append the content being transferred to the target file if it already exists.
FTP Multiple Mode	No	true	Put multiple files from the FTP server. Use a name pattern for the FTP Local Filename.
FTP Nb Files	No	-1	Number of files to upload. -1 stands for an infinite number of files.
Delete File After Transfer	No	False	Delete the files on the remote server after the transfer.
FTP Passive Mode	No	true	Use FTP passive (PASV) mode.
FTP Disable Login	No	false	If true, the connection to the server will be performed anonymously, without using the login credentials.
FTP Implicit FTPs	No	true	Use FTPs Implicit mode.
FTP Secured Protocol	No	None	Protocol used for FTPs communication: none, tls, ssl
FTP Encrypt Channel Data	No	false	If set to true, channel data will be encrypted using the PROT command.
FTP Protection Buffer Size	No		Defines the size to use for the Protection Buffer. Please refer to your FTP server provider for the possible values.
FTP System Type	No		Specifies the system type of the FTP Server. This helps to better treat the responses of the server. By default, the Runtime will try to auto-detect it. The following types are supported: UNIX,VMS,WINDOWS,OS/2,OS/400,AS/400,MVS,TYPE: L8,NETWARE
Ignore Trust Store	No	false	If true, the specified Trust Store will be ignored.
Socket Timeout	No		Set the timeout in milliseconds of a currently open connection.
Connection Timeout	No		Set the timeout in milliseconds when opening a connection.
Data Timeout	No		Set the timeout in milliseconds on the data connection.
Proxy Host	No		Host name for the proxy server.
Proxy Port	No	1080	Port of the proxy server.
Proxy User	No		Proxy server user.
Proxy Password	No		Proxy server user password, encrypted.
Proxy Unencrypted Password	No		Proxy server user password in plain text.
Proxy Protocol	No		Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .
SQL Connection	No		SQL connection into which the list of uploaded files is published.
SQL Transaction Name	No		SQL transaction into which the list of uploaded files is published.
SQL Schema Name	No		SQL schema into which the list of uploaded files is published.
Key Store	No		Full path to the Java Key Store to use when connecting to the server.
Key Store Type	No	JKS	Type of the Java Key Store.
Key Store Password	No		Encrypted password of the Java Key Store.
Trust Store	No		Full path to the Java Trust Store to use when connecting to the server.
Trust Store Type	No	JKS	Type of the Java Trust Store.
Trust Store Password	No		Encrypted password of the Java Trust Store.

Published Variables

Name	Description
FILE_NB	Number of files uploaded.

Command with FTP

Description

Launches a script on an FTP server.
The FTP script is entered in the code of the action.

Parameters

Name	Mandatory	Default	Description
FTP Hostname	Yes		FTP host name or IP address.
FTP Port	No	21 in normal mode, 990 in secure mode.	FTP host port.
FTP User	Yes		FTP user.
FTP Password			This user’s encrypted password.
FTP Unencrypted Password			This user’s password in plain text.
FTP Passive Mode	No	true	Use FTP passive (PASV) mode.
FTP File Mode	No	ascii	FTP file transfer mode: ascii or binary.
FTP Remote Path	No		Remote FTP path.
FTP Disable Login	No	false	If true, the connection to the server will be performed anonymously, without using the login credentials.
FTP Implicit FTPs	No	true	Use FTPs Implicit mode.
FTP Secured Protocol	No	None	Protocol used for FTPs communication: none, tls, ssl.
FTP Protection Buffer Size	No		Defines the size to use for the Protection Buffer. Please refer to your FTP server provider for the possible values.
FTP System Type	No		Specifies the system type of the FTP Server. This helps to better treat the responses of the server. By default, the Runtime will try to auto-detect it. The following types are supported: UNIX,VMS,WINDOWS,OS/2,OS/400,AS/400,MVS,TYPE: L8,NETWARE
Ignore Trust Store	No	false	If true, the specified Trust Store will be ignored.
Proxy Host	No		Host name for the proxy server.
Proxy Port	No	1080	Port of the proxy server.
Proxy User	No		Proxy server user.
Proxy Password	No		Proxy server user password, encrypted.
Proxy Unencrypted Password	No		Proxy server user password in plain text.
Proxy Protocol	No		Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .
Socket Timeout	No		Timeout of the command on the socket.
Connection Timeout	No		Timeout of the FTP connection.
Data Timeout	No		Data Timeout of the FTP connection.
Key Store	No		Full path to the Java Key Store to use when connecting to the server.
Key Store Type	No	JKS	Type of the Java Key Store.
Key Store Password	No		Encrypted password of the Java Key Store.
Trust Store	No		Full path to the Java Trust Store to use when connecting to the server.
Trust Store Type	No	JKS	Type of the Java Trust Store.
Trust Store Password	No		Encrypted password of the Java Trust Store.

Send Email

Description

Sends an email.

Parameters

Name	Mandatory	Default	Description
Mail Hostname	Yes		Email server host name or IP address.
Mail Port	No	25 (or 995 if Mail Use SSL is set to true).	Email server host name or IP address.
Mail From	Yes		Email Sender.
Mail User	No		User connecting to the email server.
Mail Password	No		This user’s password, encrypted.
Mail Unencrypted Password	No		This user’s password, in plain text.
Mail To			Email Recipient. At least one of the Mail To, Mail Cc or Mail Bcc parameters must be set.
Mail Cc			Email Cc Recipient. At least one of the Mail To, Mail Cc or Mail Bcc parameters must be set.
Mail Bcc			Email Bcc Recipient. At least one of the Mail To, Mail Cc or Mail Bcc parameters must be set.
Mail Subject	No		Email subject.
Mail Attach	No		Semi-colon separated list of file names. These files are attached to the email.
Mail Text	No		Body of the email. If it is not set, then the code of the action is used as the body content.
Mail HTML Mode	No	false	Set to true if the email body format is HTML.
Mail Content File	No		If this value is set to true, the content of this file is used as the email body.
Mail Use SSL	No	False	Set to true of the email server requires a secured connection.
Mail SSL Protocol	No	SSL	Secured protocol used for the connection. SSL or TLS.

Read Emails

Description

Reads emails from an email server. These emails can be written to a file or stored in a table.

Parameters

Name	Mandatory	Default	Description
Mail Hostname	Yes		Email server host name or IP address.
Mail Port	No	110 (or 995 if Mail Use SSL is set to true).	Email server host name or IP address.
Mail Protocol	No	pop3	Protocol used with the email server: pop3 or imap.
Mail User	No		User connecting to the email server.
Mail Password	No		This user’s password, encrypted.
Mail Unencrypted Password	No		This user’s password, in plain text.
Mail Server Folder	No	INBOX	Folder in the email server from which emails are read.
Mail Keep on Server	No	false	Preserve a copy of the emails on the mail server.
Mail No Mail Error	No	false	If set to true, the action raises an error if no email is found on the server.
Mail From Filter	No		Filter applied to the email senders.
Mail To Filter	No		Filter applied to the email recipients.
Mail Cc Filter	No		Filter applied to the email Cc recipients.
Mail Subject Filter	No		Filter applied to the email subject text.
Mail Extract Message	No	true	Set to true to extract the email message to a file.
Mail Message Prefix	No	MSG	Prefix used for the email messages files.
Mail Extract Attachments	No	true	Set to true to extract the email attachments to a file.
Mail Attachment Prefix	No		Prefix used for the email attachments files.
Mail Files Folder	No	Temporary directory of the Runtime engine.	Directory into which the files are extracted.
Mail Folder Options	No	None	Organize the extracted files into subfolders named after the sender or subject. By default, all extracted files are in the Mail Files Folder (none).
Mail Use Ucase	No	false	Use uppercase names for the file names.
Mail Wait Mode	No	false	Waits for emails to appear on the server.
Mail Timeout	No	-1	Timeout for waiting for emails to appear on the server. -1 stands for an infinite timeout.
Mail Pollint	No	1000	Emails polling interval.
Mail Nb Msg	No	1 if Mail Wait Mode is true, infinite otherwise.	Number of messages to wait for.
Mail Use SSL	No	False	Set to true if the email server requires a secured connection.
Mail SSL Protocol	No	SSL	Secured protocol used for the connection. SSL or TLS.
Mail Mark As	No		After the email has been read, mark it as READ, UNREAD, DELETED, FLAGGED, ANSWERED, DRAFT or RECENT.
SQL Connection	No		SQL connection into which the list of downloaded emails is published.
SQL Transaction Name	No		SQL transaction into which the list of downloaded emails is published.
SQL Schema Name	No		SQL schema into which the list of downloaded emails is published.

Send Files with SCP

Description

Uploads a set of files using SCP from the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
SSH Host	Yes		SSH host name or IP address.
SSH Port	No	22	Connection port.
SSH User	Yes		SSH user.
SSH Password	No		This user’s encrypted password.
SSH Unencrypted Password	No		This user’s password in plain text.
SCP Remote Dir	No		Remote target directory.
SCP Local File	No		Full path to the local file to transfer. Mandatory if SCP Local Dir is not set.
SCP Local Dir	No		Local directory containing the files to transfer. Use with SCP File Includes and SCP File Excludes.
SCP File Includes	No		List of files to include. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
SCP File Excludes	No		List of files to exclude. This is a semi-colon separated list of file masks. For example: `.xls;.xml;file.csv`
SCP Use sFTP	No		Use the sFTP Protocol for transfer.
SSH Trust Hosts	No	true	Accept all the hosts. If set to false, a list of trusted hosts is provided in the SSH Known Hosts File.
SSH Known Hosts File	No		File containing the list of trusted hosts.
SSH Public Key File	No		Public keys used.
SSH Password Phrase	No		Encrypted Password Phrase.
SSH Unencrypted Password Phrase	No		Password Phrase in plain text.
Proxy Host	No		Host name for the proxy server.
Proxy Port	No	1080	Port of the proxy server.
Proxy User	No		Proxy server user.
Proxy Password	No		Proxy server user password, encrypted.
Proxy Unencrypted Password	No		Proxy server user password in plain text.
Proxy Protocol	No		Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .

Get Files with SCP

Description

Downloads a set of files using SCP from the Runtime engine file system.

Parameters

Name	Mandatory	Default	Description
SSH Host	Yes		SSH host name or IP address.
SSH Port	No	22	Connection port.
SSH User	Yes		SSH user.
SSH Password	No		This user’s encrypted password.
SSH Unencrypted Password	No		This user’s password in plain text.
SCP Remote File	No		Remote file to transfer. A wildcard character `*` can be used to get multiple files at once
SCP Local Dir	No		Local directory into which the files are transferred.
SCP Use sFTP	No		Use the sFTP Protocol for transfer.
SSH Trust Hosts	No	true	Accept all the hosts. If set to false, a list of trusted hosts is provided in the SSH Known Hosts File.
SSH Known Hosts File	No		File containing the list of trusted hosts.
SSH Public Key File	No		Public keys used.
SSH Password Phrase	No		Encrypted Password Phrase.
SSH Unencrypted Password Phrase	No		Password Phrase in plain text.
Proxy Host	No		Host name for the proxy server.
Proxy Port	No	1080	Port of the proxy server.
Proxy User	No		Proxy server user.
Proxy Password	No		Proxy server user password, encrypted.
Proxy Unencrypted Password	No		Proxy server user password in plain text.
Proxy Protocol	No		Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .

Execute SSH

Description

Runs a SSH script on a remote host.
The script is entered in the code of the action.

Parameters

Name	Mandatory	Default	Description
SSH Host	Yes		SSH host name or IP address.
SSH Port	No	22	Connection port.
SSH User	Yes		SSH user.
SSH Password	No		This user’s encrypted password.
SSH Unencrypted Password	No		This user’s password in plain text.
SSH Command	No		Command to execute. The command can be alternately provided in the action’s code or in the SSH Command File.
SSH Command File	No		File containing the commands to execute. The command can be alternately provided in the action’s code or in the SSH Command parameter.
SSH Output File	No		File storing the output of the command.
SSH Output Property	No	SSH_RET_MESS	Name of the session variable storing the output of the command.
SSH Error Output Property	No	SSH_ERR_MESS	Name of the session variable storing the error output of the command.
SSH Append Output File	No	false	If set to true, appends the command output to the output file.
SSH Timeout	No		SSH connection timeout.
SSH Trust Hosts	No	true	Accept all the hosts. If set to false, a list of trusted hosts is provided in the SSH Known Hosts File.
SSH Known Hosts File	No		File containing the list of trusted hosts.
SSH Public Key File	No		Public keys used.
SSH Password Phrase	No		Encrypted Password Phrase.
SSH Unencrypted Password Phrase	No		Password Phrase in plain text.
Proxy Host	No		Host name for the proxy server.
Proxy Port	No	1080	Port of the proxy server.
Proxy User	No		Proxy server user.
Proxy Password	No		Proxy server user password, encrypted.
Proxy Unencrypted Password	No		Proxy server user password in plain text.
Proxy Protocol	No		Protocol used for the proxy server: HTTP, SOCKS, SOCKS4 or SOCKS5 .

Send JMS File Message

Description

Send JMS Message(s) from file(s) on a remote JMS Server.

Parameters

Name	Mandatory	Default	Description
Jms Commit	No	False	Commit on the session after sending the message.
Jms Connection	Yes		JMS connection used for the command. This connection is automatically set on the action if a metadata link is added on this action.
Jms Acknowledge Mode	No	SESSION_TRANSACTED	The acknowledge mode is the way the consumer is going to inform the provider it has successfully received a message.
Jms Initial Context Factory	Yes		The JNDI naming service used by the JMS Server. It depends on the JMS Provider.
Jms Connection Factory Name	No	Connection Factory	Name of the connection Factory Used.
Jms Login	No		Login/Username of the JMS Server to use.
Jms Password	No		Encrypted password of the User.
Jms Uncrypted Password	No		Uncrypted password of the User.
Jms Provider Url	Yes		URL of the JMS server. The syntax of the url depends on the JMS Provider used.
Jms Client Id	No		Set a custom client ID. Multiple processes running at the same time cannot have the same client Id.
Jms Session Name	No	T1	Name of the JMS Session.
Jms Server Properties	No		Server specific properties.
In File Mask	Yes		The mask of the file(s) name to send.
Jms Message Type	Yes		Type of the message(s) sent.
In File Dir	No		The directory which contains the message file(s).
Jms Sent Files Dir	No		A directory in which sent file(s) will be stored after being sent if Jms Sent Files Behaviour property is set to move or copy.
Jms Sent Files Behaviour	No		Choose what to do with sent files.
Jms Destination Name	Yes		JMS Queue/Topic in which the message will be sent.
Jms User Defined Properties	No		Set custom properties. This properties can be retrieved and used in the Receive JMS File Message action.
Jms Properties	No		Set the predefined JMS properties manually.

Sent Files Behaviour:
keep: keep it where it is
move: move it in the directory set in ‹Jms Sent Files Dir› property
copy: copy it in the directory set in ‹Jms Sent Files Dir› property
delete: delete it

Jms Server Properties:
Jms Server Properties can be set with this parameter when sending messages with the following syntax:
<property name="propertyName" value="propertyValue"/>
It is automatically set on the action if a metadata link is added on this action.
This can be specifically usefull with ActiveMQ for example, which requires a property for each queue/topic.
It is set in the metadata by adding a property to the JMS Server (Recommended) or with

<property name="queue.<queueName>" value="<queueName>"/>
<property name="topic.<topicName>" value="<topicName>"/>.

JMS Properties:
This parameter can be used to specify standard JMS Properties that are attached to the JMS Message with the following syntax:
The syntax is <setProperty name="<propertyName>">Value</setProperty>
The available properties are:
JMSMessageID, JMSCorrelationID, JMSDeliveryMode, JMSDestination, JMSExpiration, JMSPriority, JMSRedelivered, JMSReplyTo, JMSTimestamp, JMSType

Jms User Defined Properties:
This parameter can be used to specify custom Properties that will be attached to the JMS Message.
The syntax is <setProperty name="<name>" type="<type>">Value</setProperty>
The type is optional and must be one of these:
STRING (default), INT, BOOLEAN, DOUBLE, LONG, FLOAT, BYTE, SHORT

Receive JMS File Message

Description

Receive JMS Message(s) from file(s) on a remote JMS Server.
This Action can be used as a source of a Bind Link to another target Action.

Parameters

Name	Mandatory	Default	Description
Jms Commit	No	False	Commit on the session after receiving the message(s).
Jms No Local	No	False	All messages sent in the same connection cannot be seen by the consumer. Usefull to prevent consuming own messages sent in the same process.
Jms Connection	Yes		JMS connection used for the command. This connection is automatically set on the action if a metadata link is added on this action.
Jms Acknowledge Mode	No	SESSION_TRANSACTED	The acknowledge mode is the way the consumer is going to inform the provider it has successfully received a message.
Jms Initial Context Factory	Yes		The JNDI naming service use by the JMS Server. It depends on the JMS Provider used.
Jms Connection Factory Name	No	Connection Factory	Name of the connection Factory Used.
Jms Login	No		Login/Username of the JMS Server to use.
Jms Password	No		Encrypted password of the User.
Jms Uncrypted Password	No		Uncrypted password of the User.
Jms Provider Url	Yes		URL of the JMS server. The syntax of the url depends on the JMS Provider used.
Jms Client Id	No		Set a custom client ID. Multiple processes running at the same time cannot have the same client Id.
Jms Session Name	No	T1	Name of the JMS Session.
Jms Server Properties	No		Server specific properties.
Jms Subscriber Name	No		The name of the subscriber from who the messages will be retrieved.
Jms Message Count	No	-1	Number of messages to wait for before completing the wait action. -1 means an infinite number of files.
Jms Receive Timeout	No	1000	The time in ms to wait for the files.
Out File Pattern	Yes		The pattern of the file(s) name to receive.
Out File Dir	No		The directory which contains the message(s) received.
Jms Destination Name	Yes		JMS Queue/Topic in which the message will be retrieved.
Jms User Defined Properties	No		Get custom properties.
Jms Message Content	No		Retrieve the message content. Usefull for binding for exemple.

Jms No Local
The availability of this feature depends on the effective implementation in the JMS provider. For instance OpenJMS and OpenMQ are known not to implement it.

Jms Server Properties:
Jms Server Properties can be set with this parameter when receiving messages with the following syntax:
<property name="propertyName" value="propertyValue"/>
It is automatically set on the action if a metadata link is added on this action.
This can be specifically usefull with ActiveMQ for example, which requires a property for each queue/topic.
It is set in the metadata by adding a property to the JMS Server (Recommended) or with

<property name="queue.<queueName>" value="<queueName>"/>
<property name="topic.<topicName>" value="<topicName>"/>.

Jms Message Content:
This parameter is used to specify a property to retrieve the message content when using the action as the source of a bind link.
The syntax is: <getMessageContent name="<nameWantedForBinding>" sqlType="<type>"/>
You can then use it in the target action with the syntax :{nameWantedForBinding}:

Jms User Defined Properties:
This parameter is used to retrieve custom properties set when sending the JMS Message.
The syntax is:
<getProperty name="<name>" type="<type>" sqlAlias="<alias>"/>
To see how to set custom properties, go to the Send Jms File Message Action documentation.
The type is optional and must be one of these:
STRING (default), INT, BOOLEAN, DOUBLE, LONG, FLOAT, BYTE, SHORT
The sqlAlias is optional too and defaults to the name.

Using JmsReceiveMessage as the source of a bind link

JmsReceiveMessage can be used as the source of a Bind Link allowing to pass the properties of the message(s) that have been received directly to the target Action.

The columns that can be used on the target action are:

Column Name	Type	Description
JMSCorrelationID	STRING	ID of a message linked to the current message.
JMSMessageID	STRING	Unique ID of the message.
JMSNormalizedMessageID	STRING	Normalized ID of the JMS Message. Special characters are replaced with underscores.
JMSType	STRING	Message type identifier (E.g. Bytes, Text, Stream, Map).
JMSDeliveryMode	STRING	The delivery mode of the message, which can be one of the following: 1=NON_PERSISTENT, 2=PERSISTENT. Integer values may vary depending on the JMS Provider.
JMSPriority	INTEGER	Priority of the message, from 0 to 9 (9 being the highest one).
JMSExpiration	LONG	Expiration time, in milliseconds.
JMSRedelivered	BOOLEAN	Indicate if the message has been redelivered at least once before. True=yes, False=no.
JMSTimestamp	LONG	Timestamp when the message has been sent, expressed as the number of milliseconds since 01/01/1970.
[userDefinedPropertyName]		JMS User defined property retrieved through the Jms User Defined Properties parameter.
[messageContentPropertyName]		Content of the JMS Message, with the property name defined in Jms Message Content.

JMS Operation Action

Description

Send a JMS Operation on a remote JMS Server.

Parameters

Name	Mandatory	Default	Description
Jms Connection	Yes		JMS connection used for the command. This connection is automatically set on the action if a metadata link is added on this action.
Jms Acknowledge Mode	No	SESSION_TRANSACTED	The acknowledge mode is the way the consumer is going to inform the provider it has successfully received a message.
Jms Initial Context Factory	Yes		The JNDI naming service use by the JMS Server. It depends on the JMS Provider used.
Jms Connection Factory Name	No	Connection Factory	Name of the connection Factory Used.
Jms Login	No		Login/Username of the JMS Server to use.
Jms Password	No		Encrypted password of the User.
Jms Uncrypted Password	No		Uncrypted password of the User.
Jms Provider Url	Yes		URL of the JMS server. The syntax of the url depends on the JMS Provider used.
Jms Client Id	No		Set a custom client ID. Multiple processes running at the same time cannot have the same clientId
Jms Session Name	No	T1	Name of the JMS Session.
Jms Operation	No	commit	Send an operation to the JMS Server.

Jms Operations:

Operation	Description
commit	Commit all the messages sent during the transaction.
rollback	Rollback the messages sent during the transaction.
closeSession	Close the session.
acknowledgeLastMessage	Acknowledge the last message. Usefull in CLIENT_ACKNOWLEDGE Mode, to inform the JMS Server the message are received/sent.
recoverSession	Stop message delivery in this session, and restart with the oldest unacknowledged message.
openSession	Open a new session.

AMQP Send Message

Description

Send a message on an AMQP broker.

Parameters

Common Parameters

Name	Mandatory	Default	Description
Amqp Commit	No	False	If true, the action commits after sending the message. Can be used only in SESSION_TRANSACTED Mode.
Amqp Wait Confirmation	No	False	If true, the action waits confirmation from the broker that the message is well sent. Can be used only in AUTO_ACKNOWLEDGE Mode and is specific to RabbitMQ.
Amqp Connection	Yes		Connection used to send the message.
Amqp Addresses	Yes		A comma separated list of AMQP broker addresses, using the following pattern: <host>:<port>
Amqp Virtual Host	No		Name of the AMQP Virtual Host used.
Amqp Login	No		Login/Username of the AMQP Broker to use.
Amqp Password	No		Encrypted password of the User.
Amqp Uncrypted Password	No		Uncrypted password of the User.
Amqp Connection Timeout	No		TCP connection timeout.
Amqp Hand Shake Timeout	No		AMQP protocol handshake timeout.
Amqp Acknowledge Mode	No	SESSION_TRANSACTED	The acknowledge mode defines how the acknowledgement of messages is done. With a transaction in SESSION_TRANSACTED mode, or automatically with AUTO_ACKNOWLEDGE mode.
Amqp Session Name	No	T1	Name of the session. Note that each session represents an AMQP Channel on the Broker.
Amqp Exchange Name	No		Name of the Exchange on which the message is sent.
Amqp Routing Key	No		Routing Key used to send the message.
Amqp Queue Name	No		Name of the Queue on which the message will be routed. This parameter is used to perform direct routing to a Queue.
Amqp Content Encoding	No		Encoding used to encode the message before sending it.

AMQP attributes

The AMQP attributes are optional and may be interpreted and used differently depending on the broker implementation. They are mostly used for informational purpose. They are added to the message and can be retrieved when the message is received with the AMQP Receive Actions.

Name	Type	Description
Amqp_App_Id	String	The application sending the message.
Amqp_Content_Type	String	Message’s content type.
Amqp_Message_Id	String	An identifier for the message.
Amqp_Reply_To	String	Address to reply to.
Amqp_Priority	String	A number representing the priority of the message. The range of priorities depends on the effective implementation of the broker used.
Amqp_Expiration	String	Message’s expiration. Brokers implementing this attribute use it to define the expiration of the message. The format depends on the broker. For RabbitMQ, it is a number of milliseconds.

AMQP headers

The action offers the possibility to add AMQP headers to the message.
Particularly useful for headers Exchanges.
To add an AMQP header to the message, add an AMQP_HEADER_<headerName> parameter to the action.
You can create as many headers as you want.

Name	Type	Description
AMQP_HEADER_<headerName>	String	A custom header.

AMQP Receive Message

Description

Receive messages from an AMQP broker.
This action must be binded to another action.

Parameters

Name	Mandatory	Default	Description
Amqp Commit	No	False	If true, the action commits after the reception. Can be used only in SESSION_TRANSACTED Mode.
Amqp Connection	Yes		Connection used for the reception.
Amqp Addresses	Yes		A comma separated list of AMQP broker addresses, using the following pattern: <host>:<port>
Amqp Virtual Host	No		Name of the AMQP Virtual Host used.
Amqp Login	No		Login/Username of the AMQP Broker to use.
Amqp Password	No		Encrypted password of the User.
Amqp Uncrypted Password	No		Uncrypted password of the User.
Amqp Connection Timeout	No		TCP connection timeout.
Amqp Hand Shake Timeout	No		AMQP protocol handshake timeout.
Amqp Acknowledge Mode	No	SESSION_TRANSACTED	The acknowledge mode defines how the acknowledgement of messages is done. With a transaction in SESSION_TRANSACTED mode, or automatically with AUTO_ACKNOWLEDGE mode.
Amqp Session Name	No	T1	Name of the session. Note that each session represents an AMQP Channel on the Broker.
Amqp Queue Name	No		Name of the Queue to look for messages.
Amqp Message Count	No	-1	Number of messages to retrieve. The messages are retrieved in the order they arrived on the broker.
Amqp Receive Timeout	No	1000	Time to wait for messages in milliseconds.
Amqp Content Encoding	No		Encoding used to decode the message. By default, the action uses the Content Type attribute of the message. If this parameter is set, it will override it.

The following variables are available through the bind link on the target action:

variable	Description
Amqp_String_Content	The content of the message.
<headerName>	Custom headers defined when sending the message.
<attributeName>	Message’s attributes. Refer to the AMQP Send Actions for the list of available attributes. E.g. Amqp_Priority.

AMQP Operation

Description

Perform operations on an AMQP broker.

Parameters

Name	Mandatory	Default	Used for operation	Description
Amqp Exchange Durable	No	False	declareExchange	If true, the Exchange declared will be durable.
Amqp Exchange Auto Delete	No	False	declareExchange	If true, the Exchange declared will auto delete.
Amqp Queue Durable	No	False	declareQueue	If true, the Queue declared will be durable.
Amqp Queue Exclusive	No	False	declareQueue	If true, the Queue declared will be exclusive.
Amqp Queue Auto Delete	No	False	declareQueue	If true, the Queue declared will auto delete.
Amqp Connection	Yes			Connection used for the operation.
Amqp Addresses	Yes			A comma separated list of AMQP broker addresses, using the following pattern: <host>:<port>
Amqp Virtual Host	No			Name of the AMQP Virtual Host used.
Amqp Login	No			Login/Username of the AMQP Broker to use.
Amqp Password	No			Encrypted password of the User.
Amqp Uncrypted Password	No			Uncrypted password of the User.
Amqp Connection Timeout	No			TCP connection timeout.
Amqp Hand Shake Timeout	No			AMQP protocol handshake timeout.
Amqp Acknowledge Mode	No	SESSION_TRANSACTED		The acknowledge mode defines how the acknowledgement of messages is done. With a transaction in SESSION_TRANSACTED mode, or automatically with AUTO_ACKNOWLEDGE mode.
Amqp Session Name	No	T1	openSession, closeSession	Name of the session. Note that each session represents an AMQP Channel on the Broker.
Amqp Operation	Yes	commit		The operation performed on the broker.
Amqp Exchange Name	No		declareExchange, deleteExchange, bindQueue, unbindQueue	Name of the Exchange.
Exchange Type	No	direct	declareExchange	Type of Exchange declared. Available types: direct, fanout, topic, headers.
Amqp Routing Key	No		bindQueue, unbindQueue	Routing Key used when binding a Queue to an Exchange.
Amqp Queue Name	No		declareQueue, deleteQueue, bindQueue, unbindQueue	Name of the Queue.

Operations
The following operations are available:

Operation	Description
commit	Commit the changes of the current session.
rollback	Rollback the changes to the last commit.
declareQueue	Declare a new Queue.
declareExchange	Declare a new Exchange.
bindQueue	Bind a Queue to an Exchange.
openSession	Open the session specified with Amqp Session Name.
deleteQueue	Delete a Queue.
deleteExchange	Delete an Exchange.
unbindQueue	Delete a bind between a Queue and an Exchange.
closeSession	Close the session specified with Amqp Session Name. A closed session cannot be re-opened.
closeConnection	Close the connection specified with Amqp Connection. A closed connection cannot be re-opened.

AMQP headers

The action offers the possibility to add AMQP headers for bindQueue and unbindQueue operations.
Particularly useful for headers Exchanges.
To add an AMQP header to a bind, add an AMQP_HEADER_<headerName> parameter to the action.
You can create as many headers as you want.

Name	Type	Used for operation	Description
AMQP_HEADER_<headerName>	String	bindQueue, unbindQueue	A custom header.

AMQP Send File

Description

Send a message retrieved from a file on an AMQP broker.

Parameters

Common Parameters

Name	Mandatory	Default	Description
Amqp Commit	No	False	If true, the action commits after sending the message. Can be used only in SESSION_TRANSACTED Mode.
Amqp Wait Confirmation	No	False	If true, the action waits confirmation from the broker that the message is well sent. Can be used only in AUTO_ACKNOWLEDGE Mode and is specific to RabbitMQ.
Amqp Connection	Yes		Connection used to send the message.
Amqp Addresses	Yes		A comma separated list of AMQP broker addresses, using the following pattern: <host>:<port>
Amqp Virtual Host	No		Name of the AMQP Virtual Host used.
Amqp Login	No		Login/Username of the AMQP Broker to use.
Amqp Password	No		Encrypted password of the User.
Amqp Uncrypted Password	No		Uncrypted password of the User.
Amqp Connection Timeout	No		TCP connection timeout.
Amqp Hand Shake Timeout	No		AMQP protocol handshake timeout.
Amqp Acknowledge Mode	No	SESSION_TRANSACTED	The acknowledge mode defines how the acknowledgement of messages is done. With a transaction in SESSION_TRANSACTED mode, or automatically with AUTO_ACKNOWLEDGE mode.
Amqp Session Name	No	T1	Name of the session. Note that each session represents an AMQP Channel on the Broker.
Amqp Exchange Name	No		Name of the Exchange on which the message is sent.
Amqp Routing Key	No		Routing Key used to send the message.
Amqp Queue Name	No		Name of the Queue on which the message will be routed. This parameter is used to perform direct routing to a Queue.
In File Mask	No		Mask of the files to send.
In File Dir	No		Directory containing the message files.
Amqp Sent Files Dir	No		Directory in which sent files will be stored after being sent if Amqp Sent Files Behaviour property is set to move or copy.
Amqp Sent Files Behaviour	No		What to do with sent files.
Amqp Content Encoding	No		Encoding used to encode the message before sending it.

Sent Files Behaviour:
keep: keep it where it is.
move: move it in the directory set in ‹Jms Sent Files Dir› property.
copy: copy it in the directory set in ‹Jms Sent Files Dir› property.
delete: delete it.

AMQP attributes

Name	Type	Description
Amqp_App_Id	String	The application sending the message.
Amqp_Content_Type	String	Message’s content type.
Amqp_Message_Id	String	An identifier for the message.
Amqp_Reply_To	String	Address to reply to.
Amqp_Priority	String	A number representing the priority of the message. The range of priorities depends on the effective implementation of the broker used.
Amqp_Expiration	String	Message’s expiration. Brokers implementing this attribute use it to define the expiration of the message. The format depends on the broker. For RabbitMQ, it is a number of milliseconds.

AMQP headers

Name	Type	Description
AMQP_HEADER_<headerName>	String	A custom header.

AMQP Receive File

Description

Receive messages from an AMQP broker and store it in files.

Parameters

Name	Mandatory	Default	Description
Amqp Commit	No	False	If true, the action commits after the reception. Can be used only in SESSION_TRANSACTED Mode.
Amqp Connection	Yes		Connection used for the reception.
Amqp Addresses	Yes		A comma separated list of AMQP broker addresses, using the following pattern: <host>:<port>
Amqp Virtual Host	No		Name of the AMQP Virtual Host used.
Amqp Login	No		Login/Username of the AMQP Broker to use.
Amqp Password	No		Encrypted password of the User.
Amqp Uncrypted Password	No		Uncrypted password of the User.
Amqp Connection Timeout	No		TCP connection timeout.
Amqp Hand Shake Timeout	No		AMQP protocol handshake timeout.
Amqp Acknowledge Mode	No	SESSION_TRANSACTED	The acknowledge mode defines how the acknowledgement of messages is done. With a transaction in SESSION_TRANSACTED mode, or automatically with AUTO_ACKNOWLEDGE mode.
Amqp Session Name	No	T1	Name of the session. Note that each session represents an AMQP Channel on the Broker.
Amqp Queue Name	No		Name of the Queue to look for messages.
Amqp Message Count	No	-1	Number of messages to retrieve. The messages are retrieved in the order they arrived on the broker.
Amqp Receive Timeout	No	1000	Time to wait for messages in milliseconds
Out File Pattern	Yes		Pattern of the files to receive.
Out File Dir	No		Directory in which the files will be stored.

The following variables are available through the bind link on the target action:

variable	Description
Amqp_String_Content	The content of the message.
<headerName>	Custom headers defined when sending the message.
<attributeName>	Message’s attributes. Refer to the AMQP Send Actions for the list of available attributes. E.g. Amqp_Priority.

Misc

Sleep

Description

Pauses the process for a certain amount of time.

Parameters

Name	Mandatory	Default	Description
Sleep Delay	No	1000	Sleep duration in milliseconds.

Operating System Command

Description

Runs a command on the Runtime engine’s operating system. The command is usually entered in the code of the action.

Parameters

Name	Mandatory	Default	Description
OS Ignore Stderr	No	false	When set to true the action will silently ignore the error output when computing the final status and only use the return code. When set to false the action will raise an error if the error output is not empty while computing the final status.
OS Shell Launcher	No		Shell used to start the command: sh -c (Shell), bsh -c (Bash) or cmd /c (Windows Command)
OS Working Dir	No	Runtime engine temporary folder.	Working directory in which the command starts.
OS Charset	No		Character set of the operating system.
OS Standard Input Limit Size	No	-1 (unlimited)	Maximum number of characters written in the OS_RET_MESS variable
OS Error Input Limit Size	No	-1 (unlimited)	Maximum number of characters written in the OS_ERR_MESS variable
OS Successful Exit Code	No	0	Default successful exit code returned by the command
OS Timeout	No	-1	Timeout in milliseconds for command execution. If this timeout is reached without the command to be ended an exception will be thrown. Note that you can use -1 for an infinite timeout.

Published Variables

Name	Description
OS_RET_MESS	Message returned by the OS Command.
OS_ERR_MESS	Error message returned by the OS Command if any.
OS_ERR_CODE	Error code returned by the OS Command if any.

Execute a Delivery

Description

Executes a delivery as a child session.
This delivery is either deployed in the Runtime or available in the Runtime’s file system.
The delivery to execute can be specified by defining the name of the delivery if it is installed on the Runtime, or by defining the delivery file’s path if it is available elsewhere on the file system.

Parameters

Name	Mandatory	Default	Description
Deliv Engine Host	No		This parameter allows to specify the Runtime which will execute the given delivery. When not specified, the current Runtime executing the session is used. You can specify in this parameter the Hostname or IP address of the remote Runtime that will run the delivery, or alternatively a cluster name when the current Runtime is configured to be able to execute on a Runtime cluster.
Deliv Engine Port	No		Port of the remote Runtime engine that will run this delivery.
Deliv Engine API	No	EngineServerAPI	For internal use.
Deliv Name	Yes if Delivery File Name is not set.		Name of the Delivery to execute, when the delivery is available in the Runtime that will execute it. If the delivery is located elsewhere on the file system, see Delivery File Name parameter. Note that this parameter will be ignored if Delivery File Name is set.
Deliv File Name	Yes if Delivery Name is not set.		Location of the Delivery File to execute. It can be either the absolute file path to delivery file (E.g. «D:/deliveries/mydeliv.deliv») or the relative file path from the Runtime executing the delivery (E.g. «build/deliveries/mydeliv.deliv»). Note that it cannot be used when executing a Delivery on a remote Runtime with the ‹Deliv Remote Delivery Mode› option enabled.
Deliv Session Name	No		Name of the session. If left empty, the session is named after the delivery.
Deliv Asynchrone Execution	No	false	If set to true, the action completes immediately and the session proceeds without waiting for the delivery to complete (Asynchronous Mode). If set to false, the action waits for the delivery to complete before proceeding.
Deliv Wait All Sessions	No	true	Wait for all sessions to complete before proceeding with the action.
Deliv Memory Mode	No	true	The delivery is invoked in memory in the same Runtime engine as the current session that uses this action. If this parameter is set to false, the delivery is executed in command line mode.
Deliv Configuration	No		Name of the delivery configuration that will be used. Mandatory for multi-configuration deliveries.
Deliv Remote Delivery Mode	No	false	Specifies if the delivery to execute should be searched in the local or remote runtime. When ‹Deliv Engine Host› and ‹Deliv Engine Port› parameters are set, by default the execute delivery action is looking for the delivery in the Runtime executing the action. You can set this option to true if you want it to search the delivery in the remote Runtime instead. In this case, the delivery doesn’t need to be present in the Runtime executing the execute delivery action, but it must be in the remote one instead.

About Remote Delivery Mode

Empty Action

Description

This action type is an empty action. This action type is useful for joining or splitting (forking) flows.

Variable Manager

Description

This action is used to manipulate variables.

Parameters

Name	Mandatory	Default	Description
Var Name	Yes		Name of the variable.
Var Type	Yes		Type of the variable: boolean, integer, float or string.
Var Default Value	No		Default value for this variable.
Var Don’t Save	No	false	Set to true to avoid persistence of the variable value.
Var Save Connection	No		Connection used to save the variable’s value.
Var Save Transaction	No		Transaction used to save the variable’s value.
Var Save Transaction Type	No	AUCOMMIT	Transaction type used to save the variable’s value.
Var Save Schema Name	No	AUCOMMIT	Type of transaction used to save the variable’s value.
Var Save Type	No	LastValue	This action can save either AllValues or the LastValue of the variable.
Var Value	No		Value given to the variable if a SetValue operation is used.
Var Increment Value	No		Value by which the variable will be incremented if an IncrementValue operation is used.
Var Operation	No	AutomaticValue	Operation performed on the variable. See below for more information.
Var Save Date Limit	No	-1	Limit (in milliseconds) during which the variable history is kept. Values beyond this limit are purged when PurgeHistory is performed or when the values are saved in the database. -1 stands for no time limit.
Var Save Number Limit	No	-1	Number of values to keep in the variable history. Values beyond this limit are purged when PurgeHistory is performed or when the values are saved in the database. -1 stands for no limit.
Var Refresh Connection	No		Connection used for the RefreshValue operation on this variable.
Var Refresh Transaction	No		Transaction used for the RefreshValue operation on this variable.
Var Refresh Transaction Type	No	AUTOCOMMIT	Type of transaction used for the RefreshValue operation on this variable.
Var Refresh SQL	No		SQL Code used to refresh the variable value.

Variable Operations

The following operations can be set in the Var Operation parameter.

AutomaticValue: Sets an automatic value for the variable (see below for more information)
SetValue: Sets the variable to the value provided in Var Value.
SetDefaultValue: Sets the variable to its default value. This default value must be defined.
RefreshValue: Refreshes the value with the SQL query defined in its metadata. This query must return a valid value.
IncrementValue: Increments the variable with the value provided in Var Increment Value.
SaveCurrentValue: Preserves the current value of the variable.
PurgeHistory: Purges the history for the variable according to the values defined in Var Save Data Limit and Var Save Number Limit.

When using the AutomaticValue operation, the variable is searched using the following sequence:

If the current session stores a value for this variable then it is used,
or else if the variable saves its values and saved values are available, the latest saved value available is used,
or else if a RefreshValue operation returns a valid value, this value is used,
otherwise an error is raised.

Scripting

Java Native Scripting

Description

This action enables allows to run a script as part of the action. This action provides scripting capabilities using the built-in Java scripting and supports Groovy, JavaScript (Rhino) and Jython languages.

When using this action, you must specify the language used for scripting in the Scripting Language parameter and the script code in the action code in the expression editor. This code does not need to be enclosed between the %e(<language>){...}e(<language>)% tags, and can use variables.

Parameters

Name	Mandatory	Default	Description
Scripting Language	Yes		Name of the scripting language: rhino, groovy or jython.
Scripting Connection	No		Name given to the scripting context shared across different actions.

Bean Scripting Framework

Description

This action enables allows to run a script as part of the action. This action provides scripting capabilities using the embedded Bean Scripting Framework and supports Groovy, JavaScript (Rhino), Jython and Java (Beanshell) languages.

Parameters

Name	Mandatory	Default	Description
Scripting Language	Yes		Name of the scripting language: rhino, groovy, beanshell or jython.
Scripting Connection	No		Name given to the scripting context shared across different actions.

SQL

SQL File Export

Description

Exports the result of a SQL query to a flat file.

Parameters

Name	Mandatory	Default	Description
SQL Exp File Append	No	false	Set to true to append the result of the query to the existing file. Otherwise, overwrite the existing file.
SQL Exp Generate Header	No	false	Adds a header line containing the line of fields at the beginning of the file.
SQL Exp Boolean As Numeric	No	true	Boolean values «true/false» are converted to «1/0».
SQL Exp Row Sep on Last Row	No	false	A row separator is added after the last row.
SQL Exp Row Sep On First Row When Append	No	true	If SQL Exp File Append is set to true, then a row separator is added before the first row.
SQL Exp Generate If Empty	No	false	Writes the file even if the query returns no record.
SQL Exp Add Record Number	No	false	Adds a record number at the beginning of each row.
SQL Exp Absolute Numeric	No	false	Use absolute numeric values.
SQL Exp Use Numeric Grouping Char	No	false	Use digit grouping and the digit grouping symbol.
SQL Exp Enclose All Fields	No	false	The SQL Exp String Delimiter is applied on all the fields.
SQL Exp Filename	Yes		Full path to the output file.
SQL Connection	No		SQL connection used for the query. This connection is automatically set on the action if a metadata link is added on this action.
SQL Transaction Name	No		SQL transaction name used for the query.
SQL Exp SQL Query	No		Query to execute. This query should return records. Alternately, you can provide this query in the action’s code or in a SQL Exp SQL Query File.
SQL Exp SQL Query File	No		File containing the query to execute. This query should return records. Alternately, you can provide this query in the action’s code or in the SQL Exp SQL Query parameter.
SQL Exp File Format	No	variable	Format of the output file: variable (delimited file) or positional (fixed width).
SQL Exp Row Sep	No	System’s line break	ASCII row separator. It may be composed of several characters. \n, \r, \t and \f can be used to specify special characters.
SQL Exp XRow Sep	No		Hexadecimal row separator. It may be composed of several characters.
SQL Exp Field Sep	No	«;»	ASCII field separator for a variable file. It may be composed of several characters. \n, \r, \t and \f can be used to specify special characters.
SQL Exp XField Sep	No		Hexadecimal field separator for a variable file. It may be composed of several characters.
SQL Exp String Delimiter	No		ASCII character used to delimit strings in a variable file.
SQL Exp XString Delimiter	No		Hexadecimal character used to delimit strings in a variable file.
SQL Exp Numeric Separator Char	No	System	Decimal Symbol.
SQL Exp Numeric Grouping Char	No	System	Digit grouping symbol. This symbol is used for example to group thousands, millions, etc.
SQL Exp Numeric Pad Char	No	Space	Character used to left-pad numbers in case of a positional file.
SQL Exp String Pad Char	No	Space	Character used to right-pad strings in case of a positional file.
SQL Exp Date Format	No	yyyy/MM/dd HH:mm:ss.SSS	Format for date fields. By default, the Runtime engine configuration value if used.
SQL Exp Short Date Format	No		Format for date fields. By default, the Runtime engine configuration value if used. There is no default value. If not specified, the default value will be the same as the Date Format parameter.
SQL Exp Fetch Size	No	1000	Fetch size (number of lines). By default, the Runtime engine configuration value if used.
SQL Exp File Buffer Size	No	8192	File buffer size in octets.
SQL Exp Max File Size	No	-1	Maximum size of the files to generate. This size is expressed in octets, but can also be expressed in other units: for example 64K, 5M, 1G. -1 stands for no size limit. If this parameter is set, the action will automatically chunk the data into files of this size, suffixing the file names with an increment starting with 1.
SQL Exp Local Language	No	System	Language used for writing the file. The default value is the system value for the Runtime engine. The language impacts the characters used, for example the character for the decimal separator.
SQL Exp File Encoding	No	System’s encoding	Encoding used for the file.

SQL Operation

Description

This action has several functions:

Execute Standalone DDL or DML SQL statements. The SQL code is provided in the action’s code.
Execute SELECT or INSERT/UPDATE/DELETE statements linked through a bind link. The SQL code is provided in the action’s code.
Wait for a query to return a number of records.

Parameters

Name	Mandatory	Default	Description
SQL Action Type	Yes	DDL_DML	Type of SQL Command. This command may be a standalone SQL command (DDL_DML), a SELECT command used as the source of a bind link, or an INSERT, UPDATE, DELETE command used as the target of a bind link.
SQL Connection	No		SQL connection used for the command. This connection is automatically set on the action if a metadata link is added on this action.
SQL Transaction Type	No	AUTOCOMMIT	Type of transaction. AUTOCOMMIT: an autocommit connection is picked up from the connection pool, COMMIT: a commit is issued after the SQL command, NOCOMMIT: no commit is issued after the SQL command, AUTONOMOUS: a separate autocommit connection is created for this command.
SQL Transaction Name	No	T1	SQL transaction name used for the command. Several actions can participate in the same transaction if the SQL transaction name is the same
SQL Transaction Commit Nb	No	-1	Number of lines after which a commit must be issued. This number if valid only for INSERT, UPDATE and DELETE commands. -1 stands for no commit.
SQL Transaction Isolation	No	default database value	Transaction isolation: TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE.
SQL Action Type Stat	No		Type of statistic. This field allows creation of a named statistic with the number of lines managed by the command. The Stat type name is prefixed with `SQL_STAT`. For example, if ‹INSERT› is written in this parameter, a `SQL_STAT_INSERT` variable will be created
SQL Fetch Size	No	1000	Fetch size (number of lines) for SELECT commands. By default, the Runtime engine configuration value is used.
SQL Batch Size	No	1000	Batch size (number of lines) for INSERT, UPDATE and DELETE commands. By default, the Runtime engine configuration value is used.
SQL Wait Data	No	false	Moves the command into data wait mode. The action waits until the query specified either in the action code or in SQL Wait Count Select returns at least SQL Wait Nb Rows or until the SQL Wait Timeout is reached.
SQL Wait Poll interval	No	1000	Polling interval when SQL Wait Data is set to true.
SQL Wait Timeout	No		Waiting timeout when SQL Wait Data is set to true.
SQL Wait Nb Rows	No		Number of rows to wait for when SQL Wait Data is set to true.
SQL Wait Count Select	No		Query returning a number of rows to wait for, when SQL Wait Data is set to true.
SQL Multi Queries	No	false	Activates the Multi-Query mode. In this mode, several statements can be set in the code, separated by the SQL Multi Queries Separator.
SQL Multi Queries Separator	No	;	Character separating the queries in the code when Multi-Query mode is activated.
SQL Multi Queries Exclusion Patterns	No		Regular expression defining the lines to exclude from the list of statements. These lines are typically SQL comments.
SQL Disable Nb Rows Statistic	No	false	Disables the computation of statistics when in multi-query mode: either for all queries (true), for none (false), or a specific query list (list with the query numbers separated by commas or semi-colons)

SQL To Parameters

Description

Publishes the result of a SQL query to a parameter.

Parameters

Name	Mandatory	Default	Description
SQL Transaction Name	No	T1	SQL transaction name used for the command.
SQL Transaction Type	No	AUTOCOMMIT	Type of transaction. AUTOCOMMIT: an autocommit connection is picked up from the connection pool, COMMIT: a commit is issued after the SQL command, NOCOMMIT: no commit is issued after the SQL command, AUTONOMOUS: a separate autocommit connection is created for this command.

In the action code, specify the parameter and the SQL query using the syntax below:

<sqlToParameters>
<parameter name="PARAMETER_PATH" type="PARAMETER_TYPE" failsIfNoRecord="FAILS_BOOLEAN" defaultValue="DEFAULT_VALUE" dateTimeFormat="DATETIME_FORMAT">
SQL_QUERY
</parameter>
</sqlToParameters>

Where

PARAMETER_PATH is a path and a name of the parameter to publish.
PARAMETER_TYPE is the type of parameter (String, Integer, Boolean, Long or Float).
FAILS_BOOLEAN is a boolean (true or false). The default is true. That means the action will fail if the Sql Order doesn’t return a value.
DEFAULT_VALUE is the default value in case the returned value is null. This can happen if no record is returned or if a null value is returned.
SQL_QUERY is the Sql query to be executed. This query should return a single cell (one row and one column). In other cases, the first column of the first row will be used.
DATETIME_FORMAT is the date format to use when converting a date or datetime to string. The syntax should comply to the specification of the Java SimpleDateFormat class. Eg. yyyyMMdd

The following example sets the SQL_NB_ROWS integer parameter to the value returned by the SELECT COUNT statement:

<sqlToParameters>
<parameter name="./SQL_NB_ROWS" type="Integer">
Select count(*) from %x{md:physicalPath($REF,'workName')}x%
</parameter>
</sqlToParameters>

The following example sets the SQL_NB_ROWS integer parameter to the value returned by the SELECT COUNT statement. The parameter is published on the father process:

<sqlToParameters>
<parameter name="../SQL_NB_ROWS" type="Integer">
Select count(*) from %x{md:physicalPath($REF,'workName')}x%
</parameter>
</sqlToParameters>