SSH FTP Host: Advanced Tab
Use the Advanced tab to configure certain properties for the SSH FTP host.
See Setting advanced host properties for information about how to use and set the properties supported in all protocols.
- Add Mailbox Alias Directory to Inbox
- Appends a subdirectory at the end of the host's configured inbox directory. This allows files received through different mailboxes to be kept separate.
- 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.
- Block Size
- The block size to be used for file transfers. Some SSH FTP servers cannot transfer files with the default Block Size. If the server is able to transfer files smaller than the default Block Size, try using a smaller Block Size of 32767.
- Buffer Requests
- Indicates that commands can be buffered to minimize the command/response delays during file transfers when the round trip time is significant.
- 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.
- Create File Times
- When creating files, sets the file creation and modified times to the current time. Used for compatibility with certain servers that cannot create files without the times specified.
- Delete Zero Length Files
- Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
- 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.
- Email On Successful Send
- Send an email notification after successfully sending a 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.
- 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. - 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.
- Ignore Directory Listing Attributes
- Enable this property to allow directory listings on non-directory paths.
- 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.
- Key Exchange Data Limit (mbytes)
- Maximum number of bytes allowed over a connection between key exchanges before a re-exchange is initiated. Set this value to zero to disable this limit from initiating a key exchange.
- Key Exchange Time Limit (minutes)
- Maximum number of minutes allowed over a connection between key exchanges before a re-exchange is initiated. Set this value to zero to disable this limit from initiating a key exchange.
- 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. SeeEmailing a profile to your trading partner.
- 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.
- Preferred Cipher Algorithm
- Used to control the transport cipher algorithm preference. The preferred algorithm is used if the server also supports it.
- Preferred Compression Algorithm
- Used to control the transport compression algorithm preference. The preferred algorithm is used if the server also supports it.
- Preferred Key Exchange Algorithm
-
Used to control the transport key exchange algorithm preference. The preferred algorithm is used if the server also supports it.
- Preferred MAC Algorithm
- Used to control the transport MAC algorithm preference. The preferred algorithm is used if the server also supports it.
- Preferred Public Key Algorithm
- Used to control the transport public key algorithm preference. The preferred algorithm is used if the server also supports it.
- 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 GET transfer 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 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.
- Preserve File Timestamps
- When selected, the original file timestamp is retained for the destination file for GET and PUT.
- 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.
- Server Side Path Name
- Optional. Default starting directory for a session. If you do not specify a value, session starts at /.
- 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.
- 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.
- Window Size (bytes)
- Maximum number of received bytes allowed before a window adjustment is required. When receiving (using a GET command), a typical Window Size setting would be equal to the largest expected file size or the default setting, whichever is greater. This setting will not normally affect sends, since the receiver (the server) requires the majority of adjustments.
- 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.