The generic FTP and FTP/s hosts enable a user to fully specify a client file transfer interface to an FTP server. If at all possible, use a pre-configured host specific to the target server; this will save the effort of having to research, specify, and then debug the interface.
The generic FTP host provides an interface over non-secure FTP. If you or your trading partner requires Secure Socket Layer (SSL) FTP, use the generic FTP/s host.
Not all FTP servers will support or require the full set of host commands allowed by VersaLex. At a minimum, the server must support PUT and/or GET. The following action commands are available on VersaLex:
| Command | Purpose | Underlying FTP method | |
|---|---|---|---|
| Host commands | PUT | Send one or more files to the host | STOR |
| GET | Receive one or more files from the host | RETR | |
| DIR | Get a directory listing of available files from the host | LIST | |
| CD | Changes the current directory on the host. | CHDIR | |
| QUOTE command | Sends a raw command to the server | command | |
| SITE | Sends a site-specific command to the server | SITE | |
| TYPE | Sets file data type to ASCII or BINARY | TYPE | |
| Local commands | SYSTEM | Execute a local system command | - |
| WAIT | Pause | - | |
| SET | Sets a property | ||
| CLEAR | Clears a string property | ||
| LCOPY | Copy one or more local files | - | |
| LDELETE | Delete one or more local files | - | |
| LREPLACE | Replace bytes in one or more local files | - | |
| CHECK | Check for a transfer, file, or directory (VLTrader and Harmony only) | - | |
| SCRIPT | Execute a JavaScript File (VLTrader and Harmony only) | - |
FTP Configuration
Activate either a trading partner-specific host or the generic FTP or FTP/s pre-configured host and then configure host, mailbox and actions.
- Click the Templates tab in the tree pane.
- If necessary, expand the Hosts tree in the Templates tab to find the host you want to use.
- Right-click the host and select Clone and Activate.
The entire pre-configured host branch (including a mailbox and actions) is copied and activated, the Active tab is selected in the tree pane, and the new active host is selected in the tree. If necessary, you can append the new active host alias with a number to make it unique.
Note: The original pre-configured host remains in the pre-configured tree.
- Enter host-level configuration information.
- Click the new host in the tree pane.
- Enter host-level configuration information on the tabs in the content pane. See FTP Host Configuration.
- Click Apply to save your work.
- Enter mailbox-level configuration information.
- Click the mailbox under your host in the tree pane.
- Enter mailbox-level configuration information on the tabs in the content pane. See FTP Mailbox Configuration.
- Click Apply to save your work.
- Enter action-level configuration information.
- Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and select New Action.
- Edit action information on the tabs in the content pane. See FTP Action Configuration.
- Click Apply to save your work.
- Click Apply to save your work.
Important: If you leave any of these panels without clicking Apply, your work will not be saved. You can configure the native UI to prompt to you click Apply when changes are made. See Other system options. However, in the web UI, this is not valid. In the web UI, if you make updates to a host and then click a part of the product not related to a host, for example any of the buttons in the banner, the product will not prompt you to click Apply and your updates will not be saved.
FTP Host Configuration
The FTP Host parameters indicate a host's location and how to reach it.
FTP Host: General Tab
- Server Address
- Either a fully qualified name (recommended) or an IP address.
- Port
- The FTP command port. You can specify either a specific port number or -1 to indicate the default port for FTP (21) or FTP/s (990).
- Connection Type
- The kind of connection you want to use for this host.
- Forward Proxy
- The address of the forward proxy you want to use for this host.
- Default Directories
- Modify the default directories, if necessary. You can use macro variables from the drop-down lists. See Using Macro Variables for a list of the applicable macros (Default Host Directory context) and example usage. For VLTrader and Harmony, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and/or Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
- Inbox
- Default directory for incoming files. Enter a value directly or click … to navigate to and select a directory.
- Outbox
- Default directory for outgoing files. Enter a value directly or click … to navigate to and select a directory.
- Sentbox
- If specified, default directory for retaining sent files. Files are a copy of the original source file; any file manipulations performed as part of the send are not reflected in the sentbox copies. Enter a value directly or click … to navigate to and select a directory.
- Receivedbox
- If specified, default directory for retaining received files. Files are a copy of the final destination file; any file manipulations performed as part of the receive are reflected in the receivedbox copies. Enter a value directly or click … to navigate to and select a directory.
FTP Host: FTP Tab
- Security Modes
- For FTPs servers only.
- Default Data Type
- The data type used when transferring files to and from the FTP server.
- Data Channel Mode
- The sets the default behavior for opening data port connections between the FTP client and FTP server.
- Active mode
- causes the client to listen for an inbound connection from the server during data transfers. The Low Port / High Port, if left at 0/0, will be a random number between 1024-65535; otherwise specify a specific range. Because this is active mode, this port range must be open inbound on your firewall.
- Passive mode
- causes the server to listen for an outbound connection from the client during data transfers. The server indicates the IP address and port number. The FTP server will cycle through port numbers, usually a subset of 1024-65535. Substitute Passive IP Address indicates that VersaLex should ignore the IP address specified by the server and reuse the command port address instead. (This may be necessary if the server is advertising an internal rather than an external IP address.)
FTP Host: Advanced Tab
See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for FTP include:
- Abort In Process Transfers
- Indicates that the FTP server supports the ABORT command when a data transfer is interrupted.
- Add Mailbox Alias Directory to Inbox
-
Possible values:
OnorOff - Add Mailbox Alias Directory to Outbox
- Appends a subdirectory at the end of the host's configured outbox directory. This allows files to be sent through different mailboxes to be kept separate.
- Add Mailbox Alias Directory to Receivedbox
- Appends a subdirectory at the end of the host's configured receivedbox directory. This allows files that have been sent through different mailboxes to be kept separate.
- Add Mailbox Alias Directory to Sentbox
- Appends a subdirectory at the end of the host's configured sentbox directory. This allows files that have been sent through different mailboxes to be kept separate.
- Allow Actions To Run Concurrently
- Normally, actions and host actions within the same host are allowed to run concurrently. You can use this property to not allow actions and host actions to run concurrently.
Note: This is a Cleo Harmony and Cleo VLTrader option.
- Avoid List Command When Space In Path
- When using the retrieving nested subdirectories (GET –REC option) and any of the nested subdirectories have spaces, indicates that the FTP server does not properly handle spaces in the LIST command path and that CDs should be used to avoid the issue.
- Command Retries
- If an error or exception occurs during a command, the number of times the command should be retried.
Note: Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
- Connection Timeout
- The amount of time allowed for each read operation.
- Data Socket Accept Timeout
- The amount of time allowed for each read operation on the data port.
- Delete Zero Length Files
- Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
- Disable Address Resolution
- Indicates to connect directly to an IP address if the IP address is known and a DNS lookup is not desired.
- Do Not Send Zero Length Files
- Indicates whether zero length files to be sent to the server should be ignored rather than processed. If the
-DELoption is being used, any zero length file ignored will also be deleted. - Email On Check Conditions Met
- Send an email notification after running a CHECK command where the overall conditions of the check are met. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
- Email On Check Conditions Not Met
- Send an email notification after running a CHECK command where the overall conditions of the check are not met. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
- Email On Fail
- If an error occurs during a command, email the error condition. See Email/Execute Based on Results.
- Email On Flag
- If a flagged event occurs, email the event. See Configuring email or execute based on results.
- Email On Repetitive Action Failures
- When "Email On Fail" is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses emailing of the same alert multiple times. If the same email alert continues to be suppressed after 24 hours, the suppressed email alert will be sent every 24 hours and after every system restart if the failure occurs again. When the failure is resolved an email alert will be sent.
Note: This feature only suppresses multiple emails if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
- Email On Successful Copy
- Send an email notification after copying a file using LCOPY. See Configuring email or execute based on results.
- Email On Successful Receive
- Send an email notification after successfully receiving a file. See Configuring email or execute based on results.
- Execute On Successful Send
- After successfully sending a file, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Execute On Check Conditions Met
- After executing a CHECK command where the overall conditions are met, run a system command. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.Note: Note that if multiple files contribute to the conditions being met, and one of the file macros is in the command (e.g., %file%), the system command will be executed repeatedly - once for each file.
- Execute On Check Conditions Not Met
- After executing a CHECK command where the overall conditions are not met, run a system command. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
- Execute On Fail
- If an error occurs during a command, run a system command. See Configuring email or execute based on results.
- Execute On Repetitive Action Failures
-
When Execute On Fail is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of the Execute On Fail command. If suppression of execution of the command for this failure continues after 24 hours, the suppressed Execute On Fail command will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, the Execute On Fail command will be executed again. Users must account for this by including the %status% macro variable for the Execute On Fail command (see Using macro variables) and then checking for a success or failure.
Note: This feature only suppresses multiple executions of the Execute On Fail command if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts. - Execute On Successful Copy
- After successfully copying a file using LCOPY, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Execute On Successful Receive
- After successfully receiving a file, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Execute On Successful Send
- After successfully sending a file, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Explicit SSL Command
- Indicates the AUTH command to be used when the Security Mode specified on the Host/FTP tab is “SSL Explicit”.
- Explicit SSL Post Command
- A command or set of commands to be issued after the Explicit SSL Command and login sequence. The PBSZ and PROTcommands (“PBSZ 0;PROT P”) are required by some servers regardless of the AUTH type used and are necessary for data channel protection (AUTH TLS or AUTH TLS-C).
- File List Parse Method
- The NLST commands on some FTP servers do not return a standard file list.
- Fixed Record EOL Characters
- End-of-line characters to be inserted and/or deleted.
- Fixed Record Incoming Delete EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to look for and delete EOL characters while receiving a file.
Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
- Fixed Record Incoming Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to insert EOL characters while receiving a file.
Fixed Record Incoming Delete EOL and Fixed Record Incoming Insert EOL are mutually exclusive properties.
- Fixed Record Length
- The fixed record length after which end-of-line characters need to be inserted and/or deleted.
- Fixed Record Outgoing Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to insert EOL characters while sending a file.
Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
- Get Number of Files Limit
- Limits the number of files retrieved from a server directory listing by one GET command.
- High Priority
- Indicates whether incoming and/or outgoing transfers through the host should be treated as high priority. When both high priority and regular priority transfers are active, the high priority transfers get a larger portion of the available bandwidth. Go to to set the
High Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information. - Ignore Exception After Quit
- Indicates to ignore any I/O errors that occur when attempting to read the SMTP server response after issuing a QUIT command.
- Ignore Retrieve Error Code
- Indicates an FTP server response code (after an FTP RETR request) that should not be treated as an error condition. This property is useful when the absence of a file on the server is not considered an error.
CAUTION: If the server uses the same error code for multiple reasons, this property can potentially mask unknown error conditions.
- Include Failure In Subject Of Email
- When specified, the exception message will be included in the email that is generated on failure.
Note: If the exception message exceeds 256 characters, it will be truncated.
- Include Filename In Store Unique Command
- Indicates whether the FTP server expects a starting filename to be included when using the store unique option (PUT -UNI).
- Interim Retrieve
- Indicates to set result of any successfully retrieved file to Interim Success rather than Success. This would normally be used when transfer logging is being monitored by a backend system to allow coordination of any post processing of the received file that needs to occur prior to setting the transfer status to Success.
- Issue Command After Opening Data Connection
- Indicates to issue the retrieve, store, or list command until after the data port connection has been established rather than before.
- Keepalive Noop Command (seconds)
- Indicates the amount of time in-between issuing NOOP commands on the command port while a transfer is active on the data port. 0 indicates to not issue NOOPs.
- LCOPY Archive
- If specified, contains the directory for archiving LCOPY source files.
- Log Individual LCOPY Results To Transfer Logging
- When this option is enabled, a
<send>and<receive>result is logged to the transfer log for each file copied.Note: This is a Cleo Harmony and Cleo VLTrader option. - Macro Date Format
- Specifies the date format to be used when the
%date%macro is used. - Macro Time Format
- Specifies the time format to be used when the
%time%macro is used. - Maximum Incoming Transfer Rate (kbytes/s)
- Sets the maximum incoming transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of
0does not limit the transfer rate. The Maximum Incoming Transfer Rate system setting might also limit the transfer rates. The system Maximum Incoming Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers also affects individual transfer rates. See Advanced system options. - Maximum Outgoing Transfer Rate (kbytes/s)
- Sets the maximum outgoing transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of
0does not limit the transfer rate. The system setting might also limit the transfer rates. The system Maximum Outgoing Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers will also affect individual transfer rates. See Advanced system options for more information about Maximum Outgoing Transfer Rate. - Next File On Fail
- When a download fails, indicates whether a wildcarded GET should proceed to the next available file rather than terminate if the server is still connected.
- Only Retrieve First Available File
- Indicates a GET * should only retrieve the first available file from the server.
- Only Retrieve Last Available File
- Indicates a GET * should only retrieve the last available file from the server.
- Outbox Sort
- Controls the order in which multiple files are transferred for a PUT command. If
System Defaultis specified, the value set on the tab takes precedence. ForAlphabeticalordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique. - Outgoing Insert EOL Between Interchanges
- If
Fixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file. - Partner Email Address
- The email address of the trading partner for this trading relationship. When set, this address is automatically used to send your local profile information and/or certificates to your trading partner. See Emailing a profile to your trading partner.
- Password Automatic Update (days)
- If greater than zero and
Password Update Formathas been set, the number of days after which the software will generate and apply a new FTP password. - Password Update Format
- If supported by the server, the format of the PASS command value when changing a user's password. The server dictates the format.
- PGP Compression Algorithm
- Compression method used when OpenPGP packaging (with compression) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab is in effect. - PGP Encryption Algorithm
- Encryption method used when OpenPGP packaging (with encryption) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab takes precedence. - PGP Hash Algorithm
- Signing method used when OpenPGP packaging (with signing) is requested through the Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab takes precedence. - PGP Integrity Check
- When OpenPGP encrypting (see Configuring mailbox packaging), include an integrity check on encrypted data. Can be disabled for compatibility with certain OpenPGP implementation.
- PGP Signature Verification
- Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. In general, this property should be enabled.
- PGP V3 Signature
- Post Get Command
- Post Put Command
-
In an action, specify commands to be executed only after a successful GET or PUT as post-get or post-put commands, respectively. When using this property, use a SET command within the action before the GET or PUT command rather than the Advanced tab.
The Post Put Command can be set to QUIT, which allows a disconnect and reconnect between file uploads when necessary.
- Pre Get Command
- Pre Put Command
- In an action, specify commands to be executed before a GET or PUT as pre-get or pre-put commands, respectively. This has the benefit of keeping the log results relative to just GETs and PUTs (especially important for Cleo VLTrader and Cleo Harmony GETtransfer logging). In addition, for the PUT, it avoids connecting and logging into the server when there are no files to send. When using this property, use a SET command within the action before the GET or PUT command rather than the Advanced tab.
- Pre Put Change Directory
- For PUT commands whose destination contains a directory path, forces an explicit CWD request to the destination directory path prior to issuing the STORE request.
Some FTP servers treat directories as logical rather than physical directories, and require directories be set only through a
CWDrequest. - Pre Put Command For First File Only
- If a Pre Put Command is specified, indicates whether to execute them before each file being transferred by the PUT or only before the first file transfer.
- REST Enabled
-
Allows the host to be accessible through the REST API. This feature is only supported on AS2, AS4, FTP and SSH FTP and only when the host has exactly one mailbox.
When this setting is enabled, new mailboxes cannot be created and the existing mailbox cannot be cloned, disabled, or removed.
- Resume Failed Transfers
- When selected and a transfer fails (and Command Retries > 0), attempt to resume the transfer on a retry. If OpenPGP is enabled on the packaging tab (see Configuring mailbox packaging), the entire file is transferred instead of resuming with a partial file. The server must support the
FEAT,SIZE, andREST STREAMextensions to FTP. For more information, visit http://tools.ietf.org/html/rfc3659. - Retrieve Directory Sort
- Used to control the order in which files are downloaded from the FTP server. Using this property does cause the LIST command rather than the NLST command to be used when VersaLex is determining the available file list – which might be a problem if the server responds with different lists (e.g. NLST only lists files not previously downloaded while LIST lists all files regardless). Windows and Unix/Linux FTP servers are supported.
- Retrieve Last Failed File First
- If a file download previously failed and you are attempting to GET a list of files again, this property indicates whether the previously failed file should be attempted first.
- Retry Delay
- The amount of time (in seconds) before a retry should be attempted.
- Reuse SSL Session
- Indicates the command port SSL session should be reused when possible for any subsequent data port SSL connections. This setting does not affect the reuse of command port SSL sessions.
- Reuse SSL Sessions Across Actions
- If selected, SSL sessions from previous connections to the same destination (address and port number) may be resumed to avoid costly negotiation. If unselected, only SSL sessions used in the current action to the same destination may be resumed. When unselected, a new SSL session is created for the initial command port connection.
- SSL Allow Legacy Renegotiation
- When selected, legacy renegotiation is allowed. If this property is not selected, the extension described in RFC5746 is used for renegotiation and the server must also support this extension. See RFC5746 for a description of the extension and the vulnerability it addresses.
- SSL Cipher
- Indicates a specific cipher to be used with the server for SSL key exchange, encryption, and hashing. If not set, the list of supported ciphers is presented to the server and the server picks one.
- SSL Maximum Protocol Version
- Specifies the maximum protocol version allowed. By default, this field is blank, designating that Cleo Harmony, Cleo VLTrader, or Cleo LexiCom will select the most recent version (currently TLS 1.2).
- SSL Minimum Encryption Key Size
- Specifies the minimum encryption key size allowed when selecting an SSL cipher. To prevent use of low- or medium-strength ciphers, change from the default value of
0to112,128, or256(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabledexception to occur. - SSL Minimum Protocol Version
- Specifies the minimum protocol version allowed. SSL 3.0 is the default value for compatibility with servers that do not support the more recent TLS versions 1.0, 1.1, and 1.2.
- SSL Use Record Splitting
- Indicates whether to use 1/n-1 record splitting in CBC mode as a countermeasure against the Rizzo/Duong BEAST (Browser Exploit Against SSL/TLS) attack against the SSL 3.0 / TLS 1.0 protocol. Must be turned off if the SSL library on the other side of the connection does not support the feature.
- Terminate On Fail
- If an error occurs during a command, stop the action.
Note:
Regarding non-CHECK commands: When
Terminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.Regarding CHECK commands:
Terminate On Failis only honored if theConditionsMetparameter is set and the result of the CHECK is classified asError. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications. - Unzip Use Path
- Indicates whether or not zip entry paths should be used for LCOPY -UNZIP operations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
- Use EPRT and EPSV
- Indicates to use Extended Port (EPRT) and Extended Passive (EPSV) commands for IPv6-style network addressing. EPRT/EPSV is used regardless of this setting if the host address is or resolves to an IPv6-style address.
- Use External IP Address in PORT request
- Indicates for active (aka port) mode that the external rather than the local IP address should be included in data port requests to the FTP server.
- Use NLST
- During a
GET *command, indicates that VersaLex should use an NLST command rather than LIST when getting the list of files available for download. - Wait For Execute On
- Indicates whether execution should wait for processing to complete within an Execute On Fail, Execute On Successful Copy,Execute On Successful Receive, or Execute On Successful Send command. Note that this option does not apply to native AS400 execution.
- XML Encryption Algorithm
- The method used to encrypt/decrypt files when XML Encryption packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging . If
System Defaultis specified, the value set on the tab takes precedence. - Zip Comment
- Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations.
- Zip Compression Level
- Controls the level of compression for LCOPY -ZIP operations. If
System Defaultis specified, the value set on the takes precedence - Zip Subdirectories Into Individual Zip Files
- Indicates whether or not subdirectories should be bundled for LCOPY –ZIP –REC operations. When enabled, each first-level subdirectory (and all of its descendents) will be bundled together into an individual zip file. The name of this zip file may optionally reflect the subdirectory name if an asterisk (
*) is placed in the destination path. Any files that are directly off the source root directory will not be copied.
FTP Mailbox Configuration
The FTP Mailbox parameters allow you access to the host system.
Note: This feature is being deprecated. For protocols other than AS3, use a Users host. See Users Host for more information. For AS3, you can continue to use the FTP Users host and mailbox until further notice.
FTP Mailbox: FTP Tab
- User Name
- Password
- FTP Account
- Credentials for authentication to the FTP server. Select No Password Required if there is no password required for authentication.
FTP Mailbox: Security Tab
Note: This tab applies only to FTPs hosts.
- Security Mode
- Possible values:
- None - For non-secure transfers, and commands and data are clear-text.
- SSL Implicit - For servers that support only SSL connections.
- SSL Explicit - For servers that support SSL by using either the AUTH SSL or AUTH TLS command.
- Client Certificate
- If SSL Explicit or SSL Implicit is specified in the Host FTP tab, the target server can issue client certificates. In this case, import the client certificate using Certificate management and then use the Certificate Alias and Password fields to specify (or browse for) the imported certificate.
FTP Mailbox: Packaging Tab
See Configuring mailbox packaging for information regarding payload file packaging.
FTP Action Configuration
An action's parameters capture a repeatable transaction for your mailbox on the host system. Create a new action under the mailbox.
FTP Action: Action Tab
See Composing an action and FTP Command Reference.
FTP Command Reference
Descriptions of commands and their options, arguments, and parameters.
CHECK
See CHECK Command for information about this command.
CLEAR
Clear an action property string value. The cleared value only affects the commands that follow the CLEAR.
CLEAR property- property
- Action property name with no embedded spaces.
Comment
# text...Lines in the action starting with a # character are considered comments and will be ignored when the action executes. Lines starting with # are generally used for documentation purposes.
DIR
Get a directory listing of available files from the host
DIR "source" - source
-
Remote source directory path
GET
Receive one or more files from the host
GET [-ASC|-BIN] [-REC] [-DEL] [-UNI|-APE] "source" "destination"- ASC
- Transfer file in ASCII format.
- BIN
- Transfer file in Binary format.
- REC
- Recursively retrieve nested subdirectories.
- DEL
- If GET is successful, delete remote file.
- UNI
- Ensure local filename is unique.
- APE
- Append to existing destination file.
- source
-
Remote source path
- destination
-
Local destination path. Use of macro variables is supported. See Using Macro Variables (Destination File context) for a list of the applicable macros.
- Path can be to a filename or to a directory.
- If relative path, then uses user's home directory.
- Use of macro variables is supported. See Using Macro Variables (Destination File context) for a list of the applicable macros.
LCOPY
Copy one or more files locally.
LCOPY –DEL -REC {–UNI|–APE} {-ZIP|-UNZ} "source" "destination"- -DEL
- If the command is successful, delete the local file.
- -REC
- Recursively search all subdirectories.
- -UNI
- Ensure the copied filename is unique.
- -APE
- Append copied file to existing destination file.
- -ZIP
- Zip all the files into one or more ZIP archive files, depending on the destination specified.
- Specify ZIP comment and compression level through Zip Comment and Zip Compression Level properties. See Setting advanced host properties.
- The ZIP archive files created through the LCOPY command conform to the standard ZIP file format. Visit http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html. The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the VersaLex application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
- In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Cryptographic Services.
- -UNZ
- Unzip the source file(s).
- All source files must be ZIP archive files.
- You cannot use this option with the
-RECoption. - Use ZIP entry paths if Unzip Use Path is set. See Setting advanced host properties.
- The ZIP archive files created through the LCOPY command conform to the standard ZIP file format (reference http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html). The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
- In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Encryption of Zip Files in Cryptographic Services for more information on this capability.
- "source"
- Source path
- Path can be to a filename or to a directory
- You can use
*and?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information. - If you specify a relative path, the command uses the default inbox.
- You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- "destination"
- Destination path.
- Path can be to a filename or to a directory.
- If you specify a relative path, the command uses the default inbox.
- You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
- You can use a single
*within the destination path. In this context, it is not a wildcard. Rather, it is used to substitute a source file name or a source subdirectory name. When*is used in conjunction with both the-RECand-ZIPoptions, andZip Subdirectories Into Individual Zip Filesis enabled, then*is substituted with each first-level subdirectory name. When*is not used for bundling zipped subdirectories, then it is used as a shortcut for the%sourcefilename%or%srcfilename%macro. Only one*is allowed in the destination path. See Setting advanced host properties. - When copying a file without the
-APEoption, or when copying a file with the-APEoption where the destination file does not already exist, a temporary file name is used while the copy operation is taking place. This temporary file is placed in the destination directory. Its name begins with the product name and ends with .tmp. Once the copy completes successfully, the temporary file is renamed to the destination name. - If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
LDELETE
Delete one or more files locally.
LDELETE "source"- "source"
- Source path.
- Path can be a filename or a directory.
- You can use
*and?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information. - If you specify a relative path, the command uses the default inbox.
- Use of macro variables is supported. See Using macro variables (Source File context) for a list of the applicable macros.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
LREPLACE
Replace bytes in one or more files locally.
LREPLACE "source" Replace="input bytes" With="output bytes"- "source"
- Source path.
- Path can be to a filename or to a directory.
- You can use
*and?, or a regular expression when you specify a filename. See Using wildcards and regular expressionsfor additional information. - If you specify a relative path, the command uses the default inbox.
- You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- "input bytes"
- List of bytes to be replaced.
- Comma separated list of byte values (0-255).
- All bytes in comma-separated list must be found in the file in listed sequence in order to be replaced.
- "output bytes"
- List of bytes to be substituted for original
input bytes.- Comma separated list of byte values (0-255).
- If
Withparameter is omitted, then theinput bytesare deleted from the file.
PUT
Send one or more files to the host.
PUT [-ASC|-BIN] [-DEL] [-UNI|-APE] "source" "destination"- ASC
- Transfer file in ASCII format
- BIN
- Transfer file in Binary format
- DEL
- If PUT is successful, delete local file.
- UNI
- Ensure remote filename unique
- APE
- Append to existing destination file
- source
-
Source path
- path can be to a filename or to a directory
- * and ?, or a regular expression, are supported in filename. See Using wildcards and regular expressions for additional information.
- if relative path, then uses user's home directory
- usage of macro variables is supported. See Using Macro Variables (Source File context) for a list of the applicable macros.
- destination
-
Remote destination path. Use of macro variables is supported. See Using Macro Variables (Destination File context) for a list of the applicable macros.
QUOTE
Send a raw command to the FTP server
QUOTE "command" - source
- Command to be sent to the server. (Example: PWD, CWD, DELE) See the FTP RFC 959 for more details on specific FTP commands.
SCRIPT
See SCRIPT command for information about this command.
SET
Change an action property value. The new value only affects the commands that follow the SET.
SET property=value- property = value
- Action property and new value
- The property name must have no embedded spaces.
- The value specified remains in effect until it is set again or until the end of action.
- To reset property back to default value (host-level or system-level), specify
SET propertyor
SET property= - To clear a string property, use the CLEAR command
SITE
Sends a site-specific command to the server.
SITE "command"- command
- Site specific command with any arguments
SYSTEM
Execute a local system command.
SYSTEM "path"- "path"
- Local command path with arguments.
- If you specify a relative path or no path, the command uses the home directory.
- See Using operating system commands in actions for additional information
TYPE
Set the default data type for file transfers.
TYPE "data type"- data type
- ASCII or Binary
WAIT
Pause execution.
WAIT seconds- Seconds
- Number of seconds to pause.
Comments
0 comments
Please sign in to leave a comment.