Internet and Networking | ||
---|---|---|
Previous | Next | |
Files | Misc |
Downloads a set of files from an FTP server to the runtime engine file system. This action also allows to store in a table the list of downloaded files.
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 Implicit FTPs | No | true | Use FTPs Implicit mode. |
FTP Secured Protocol | No | None | Protocol used for FTPs communication: none, tls, ssl |
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 File Mode | No | ascii | FTP file transfer mode: ascii or binary. |
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. | |
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 . | |
FTP Wait Mode | No | false | If set to true, the action waits for files to be detected on the remote host. |
FTP Wait Timeout | No | -1 | Maximum waiting time. -1 stands for an infinite timeout. |
FTP Wait Pollint | No | 1000 | Polling interval in milliseconds. |
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. |
Socket Timeout | No | Set the timeout in milliseconds of a currently open connection. | |
Connection Timeout | No | Set the timeout in milliseconds when openning 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. |
Note: Passwords are encrypted using the
encrypt <password>
command on the runtime engine console (engine command line tool).
Name | Description |
---|---|
FILE_NB | Number of files downloaded. |
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.
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 Implicit FTPs | No | true | Use FTPs Implicit mode. |
FTP Secured Protocol | No | None | Protocol used for FTPs communication: none, tls, ssl |
FTP Multiple Mode | No | true | Put multiple files from the FTP server. Use a name pattern for the FTP Local 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 File Mode | No | ascii | FTP file transfer mode: ascii or binary. |
FTP Remote Filename | No | Remote file name. This parameter is 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 Append | No | false | Append the content being transferred to the target file if it already exists. |
Socket Timeout | No | Set the timeout in milliseconds of a currently open connection. | |
Connection Timeout | No | Set the timeout in milliseconds when openning 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 . | |
FTP Nb Files | No | -1 | Number of files to upload. -1 stands for an infinite number of files. |
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. |
Note: Passwords are encrypted using the
encrypt <password>
command on the runtime engine console (engine command line tool).
Name | Description |
---|---|
FILE_NB | Number of files uploaded. |
Launches a script on an FTP server.
The FTP script is entered in the
code of the action.
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 Implicit FTPs | No | true | Use FTPs Implicit mode. |
FTP Secured Protocol | No | None | Protocol used for FTPs communication: none, tls, ssl. |
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. | |
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. |
Note: Passwords are encrypted using the
encrypt <password>
command on the runtime engine console (engine command line tool).
Sends an email.
Name | Mandatory | Default | Description |
---|---|---|---|
Mail Hostname | Yes | Mail server host name or IP address. | |
Mail Port | No | 25 (or 995 if Mail Use SSL is set to true). | Mail server host name or IP address. |
Mail From | Yes | Mail Sender. | |
Mail User | No | User connecting to the mail server. | |
Mail Password | No | This user’s password, encrypted. | |
Mail Unencrypted Password | No | This user’s password, in plain text. | |
Mail To | Mail Recipient. At least one of the Mail To, Mail Cc or Mail Bcc parameters must be set. | ||
Mail Cc | Mail Cc Recipient. At least one of the Mail To, Mail Cc or Mail Bcc parameters must be set. | ||
Mail Bcc | Mail 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 mail 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 mail server requires a secured connection. |
Mail SSL Protocol | No | Secured protocol used for the connection. SSL or TLS. |
Note: Passwords are encrypted using the
encrypt <password>
command on the runtime engine console (engine command line tool).
Reads emails from a mail server. These emails can be written to a file or stored in a table.
Name | Mandatory | Default | Description |
---|---|---|---|
Mail Hostname | Yes | Mail server host name or IP address. | |
Mail Port | No | 110 (or 995 if Mail Use SSL is set to true). | Mail server host name or IP address. |
Mail Protocol | No | pop3 | Protocol used with the mail server: pop3 or imap. |
Mail User | No | User connecting to the mail 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 mail 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 mail is found on the server. |
Mail From Filter | Yes | Filter applied to the mail senders. | |
Mail To Filter | No | Filter applied to the mail recipients. | |
Mail Cc Filter | No | Filter applied to the mail Cc recipients. | |
Mail Subject Filter | No | Filter applied to the mail subject text. | |
Mail Extract Message | No | true | Set to true to extract the mail message to a file. |
Mail Message Prefix | No | MSG | Prefix used for the mail messages files. |
Mail Extract Attachments | No | true | Set to true to extract the mail attachments to a file. |
Mail Attachment Prefix | No | Prefix used for the mail 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 mail server requires a secured connection. |
Mail SSL Protocol | No | 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. |
Note: Passwords are encrypted using the
encrypt <password>
command on the runtime engine console (engine command line tool).
Uploads a set of files using SCP from the runtime engine file system.
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 Private Key File | No | Private 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 . |
Note: Passwords are encrypted using the
encrypt <password>
command on the runtime engine console (engine command line tool).
Downloads a set of files using SCP from the runtime engine file system.
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. | |
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 Private Key File | No | Private 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 . |
Note: Passwords are encrypted using the
encrypt <password>
command on the runtime engine console (engine command line tool).
Runs a SSH script on a remote host.
The script is entered in the
code of the action.
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 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 Private Key File | No | Private 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 . |
Note: Passwords are encrypted using the
encrypt <password>
command on the runtime engine console (engine command line tool).
Previous | Top | Next |
Files | Misc |