Sign in
< Back to User Guide Top

SSH FTP host

Use the SSH FTP host to specify a client file transfer interface to an SSH FTP server.

Not all SSH 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 SSH FTP method
Host Commands PUT Send one or more files to the host GET
  GET Receive one or more files from the host PUT
  DIR Get a directory listing of available files from the host LIST
  CD Changes the current directory on the host CD
  QUOTE command Sends a raw command to the server

command

Supported commands include:

  • CHGRP
  • CHMOD
  • CHOWN
  • MKDIR
  • MKDIRS
  • PWD
  • RENAME
  • RM
  • RMDIR
  • STAT
  • SYMLINK
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) -

SSH FTP Configuration

  1. Click the Templates tab in the tree pane.
  2. If necessary, expand the Hosts tree in the Templates tab to find the host you want to use.
  3. 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.

  4. Enter host-level configuration information.
    1. Click the new host in the tree pane.
    2. Enter host-level configuration information on the tabs in the content pane. See SSH FTP Host.
    3. Click Apply to save your work.
  5. Enter mailbox-level configuration information.
    1. Click the mailbox under your host in the tree pane.
    2. Enter mailbox-level configuration information on the tabs in the content pane. See SSH FTP Mailbox.
    3. Click Apply to save your work.
  6. Enter action-level configuration information.
    1. Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and select New Action.
    2. Edit action information on the tabs in the content pane. See SSH FTP Action.
    3. Click Apply to save your work.
  7. 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 product to prompt to you click Apply if you try to leave the page. However, 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.

SSH FTP Host

A host's parameters specify its location and how it is reached.

SSH FTP Host: General Tab

Field Description
Server Address Either a fully qualified name (recommended) or an IP address.

This is the address of your trading partner's server that will receive your messages.
Port

The port on the server where your trading partner will receive your messages. If no port number is included in your trading partner's URL, default values are assumed.

Possible values: Either a specific port number or -1 to indicate the default port for SSH FTP (22)
Default value: 22
Connection Type

The kind of connection you want to use for this host.

Possible values:

  • System Default - See for information about setting the system default.
  • Direct Internet Access or VPN - Use either a direct connection to the internet or a VPN.
Forward Proxy

The address of the forward proxy you want to use for this host.

Select the System Default check box to use the default proxy. See Configuring for a proxy for information about specifying a default proxy.
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 the Cleo VLTrader and Cleo Harmony applications, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and Outbox.  See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.

Note: If the host is has an external association, the default directories might be managed outside of the VersaLex application and not shown here.

Inbox

Default directory for incoming files. Enter a value directly or click … to navigate to and select a directory.

Possible values: Any local or shared directory.
Default value: inbox\
Outbox

Default directory for outgoing files. Enter a value directly or click … to navigate to and select a directory.

Possible values: Any local or shared directory.
Default value: outbox\
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.

Possible values: Any local or shared directory.
Default value: No default value.
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.

Possible values: Any local or shared directory.
Default value: No default value.

SSH FTP Host: SSH FTP Tab

Field Description
Host Key Verification Host Key Verification compares the SSH FTP host key sent from the SSH FTP server to the value in the Host Key field. If the value in the Host Key field does not match the value returned from the SSH FTP server, the connection is terminated.
Verify Host Key Select this check box to enable the Host Key field and the Set Key button, and allow host key verification.

Clear the Verify Host Key check box to disable fields and verification.
Host Key

The SSH FTP server certificate fingerprint retrieved from the SSH FTP server.

Click Set Key to connect to the SSH FTP server to retrieve the host key. If the host key is retrieved successfully, the Host Key field is updated with the server certificate fingerprint.

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.
Possible values: On or Off
Default value: Off
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.
Possible values: On or Off
Default value: Off
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.
Possible values: On or Off
Default value: Off
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.
Possible values: On or Off
Default value: Off
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.

Possible values: On or Off
Default value: On
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.
Possible values: Any value greater than zero.
Default value: 65535
Buffer Requests
Indicates that commands can be buffered to minimize the command/response delays during file transfers when the round trip time is significant.
Possible values: On or Off
Default value: On
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.

Possible values: 0 - n
Default value: 0
Connection Timeout
The amount of time allowed for each read operation.
Possible values: 0 - n seconds

0 indicates no timeout

Default value: 150 seconds
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.
Possible values: On or Off
Default value: Off
Delete Zero Length Files
Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
Possible values: On or Off
Default value: Off
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 -DEL option is being used, any zero length file ignored will also be deleted.
Possible values: On or Off
Default value: Off
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.

Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
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.

Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Fail
If an error occurs during a command, email the error condition.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Flag
If a flagged event occurs, email the event. See Configuring email or execute based on results.
Email addresses separated by commas (,), semicolons (;) or colons (:). The first address should be an internal email address.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
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.

Possible values: On or Off
Default value: On
Email On Successful Copy
Send an email notification after copying a file using LCOPY.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Successful Receive
Send an email notification after successfully receiving a file.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Successful Send
Send an email notification after successfully sending a file.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
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.

Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
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.

Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Fail
If an error occurs during a command, run a system command.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
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.

Possible values: On or Off
Default value: On
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.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
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.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
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.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values: 0 to n characters. 

Special character sequences:

  • \r - carriage return
  • \n - new line (linefeed)
  • \f - form feed
  • \t - horizontal tab
  • \0 - null
  • \\ - backslash
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.

Possible values: On or Off
Default value: Off
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.

Possible values: On or Off
Default value: Off
Fixed Record Length
The fixed record length after which end-of-line characters need to be inserted and/or deleted.
Possible values: 0 - n
Default value: 0
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.

Possible values: On or Off
Default value: Off
Get Number of Files Limit
Limits the number of files retrieved from a server directory listing by one GET command.
Possible values: 0 - n

0 indicates no limit.

Default value: 0
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 Configure > Options > Other to set the High Priority Transfers Percentage Available Bandwidth (defaults to 75). See Other system options for more information.

Note: This is a Cleo Harmony and Cleo VLTrader option.

Warning: If the trading partner’s bandwidth (and not Cleo Harmony's or Cleo VLTrader’s) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down other Cleo Harmony or Cleo VLTrader transfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance of Cleo Harmony or Cleo VLTrader is both the client and server (for example, a local looptest).

Possible values:
  • Incoming
  • Outgoing
  • Both
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.

Possible values: On or Off
Default value: The value specified for this property on the Options > Advanced panel
Ignore Directory Listing Attributes
Enable this property to allow directory listings on non-directory paths.
Possible values: On or Off
Default value: Off
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.
Possible values: On or Off
Default value: Off
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.
Possible values: 0 - n
Default value: 1024
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.
Possible values: 0 - n
Default value: 60
LCOPY Archive
If specified, contains the directory for archiving LCOPY source files.
Possible values: Any local or shared directory. Macros can be used.  See Using macro variables (LCOPY Archive context).
Default value: The value specified for this property on the Options > Advanced panel, if any.
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.

Possible values: On or Off
Default value: Off
Macro Date Format
Specifies the date format to be used when the %date% macro is used.
Possible values: See Using macro variables for information about usage and possible date/time formats.
Default value: The value specified for this property on the Options > Advanced panel, if any.
Macro Time Format
Specifies the time format to be used when the %time% macro is used.
Possible values: See Using macro variables for information about usage and possible date/time formats.
Default value: The value specified for this property on the Options > Advanced panel, if any.
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 0 does 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.
Possible values: 0 - n
Default value: 0
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 0 does 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.
Possible values: 0 - n
Default value: 0
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.
Possible values: On or Off
Default value: Off
Only Retrieve First Available File
Indicates a GET * should only retrieve the first available file from the server.
Possible values: On or Off
Default value: Off
Only Retrieve Last Available File
Indicates a GET * should only retrieve the last available file from the server.
Possible values: On or Off
Default value: Off
Outbox Sort
Controls the order in which multiple files are transferred for a PUT command.  If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.  For Alphabetical ordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique.
Possible values:
  • System Default
  • Alphabetical
  • Date/Time Modified
Default value: System Default
Outgoing Insert EOL Between Interchanges
If Fixed Record Outgoing Insert EOL is active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values: On or Off
Default value: Off
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.
Possible values: Email address(es) separated by commas (,), semicolons (;) or colons ( : ). 

Note: This is a Cleo LexiCom only option. For Cleo Harmony and Cleo VLTrader, this information is stored in the trading partner management table. See Managing Trading Partners.

PGP Compression Algorithm
Compression method used when OpenPGP packaging (with compression) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If System Default is specified, the value set on the Configure > Options > Advanced tab is in effect.
Possible values:
  • System Default
  • ZIP
  • ZLIB
Default value: System Default
PGP Encryption Algorithm
Encryption method used when OpenPGP packaging (with encryption) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.
Possible values:
  • System Default
  • TripleDES
  • Blowfish
  • CAST5
  • DES
  • AES-128
  • AES-192
  • AES-256
  • Twofish
Default value: System Default
PGP Hash Algorithm
Signing method used when OpenPGP packaging (with signing) is requested through the Configuring mailbox packaging.  If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.
Possible values:
  • System Default
  • MD2
  • MD5
  • RIPE-MD-160
  • SHA-1
  • SHA-256
  • SHA-384
  • SHA-512
Default value: System Default
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.
Possible values: On or Off
Default value: On
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.
Possible values: On or Off
Default value: On
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.

If multiple FTP commands are needed after the GET or PUT, set this property to all of the commands separated by semicolons (;).  If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes (").  Use of macro variables is supported.  Refer to Using macro variables (Post/Pre Command context) for a list of the applicable macros.
Preferred Cipher Algorithm
Used to control the transport cipher algorithm preference. The preferred algorithm is used if the server also supports it.
Possible values:
  • 3des-cbc
  • aes128-cbc
  • aes128-ctr
  • aes192-cbc
  • aes192-ctr
  • aes256-cbc
  • aes256-ctr
  • arcfour128
  • arcfour256
  • blowfish-cbc
  • cast128-cbc
  • twofish128-cbc
  • twofish192-cbc
  • twofish256-cbc
If no preference is specified, the cipher algorithms are presented to the server in this order:

blowfish-cbc, 3des-cbc, aes128-cbc, aes128-ctr, aes192-cbc, aes192-ctr, aes256-cbc, aes256-ctr, arcfour128, arcfour256, cast128-cbc, twofish128-cbc, twofish192-cbc, twofish256-cbc

Preferred Compression Algorithm
Used to control the transport compression algorithm preference. The preferred algorithm is used if the server also supports it.
Possible values:
  • none
  • zlib
  • zlib@openssh.com

If no preference is specified, the compression algorithms are presented to the server in this order: none, zlib, zlib@openssh.com

Preferred Key Exchange Algorithm

Used to control the transport key exchange algorithm preference. The preferred algorithm is used if the server also supports it.

Possible values:
  • curve25519-sha256@libssh.org
  • diffie-hellman-group-exchange-sha256
  • diffie-hellman-group1-sha1
  • diffie-hellman-group14-sha1
  • diffie-hellman-group-exchange-sha256
  • ecdh-sha2-nistp256
  • ecdh-sha2-nistp384
  • ecdh-sha2-nistp521
 If no preference is specified, the key exchange algorithms are presented to the server in this order:

curve25519-sha256@libssh.org, diffie-hellman-group-exchange-sha256, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group14-sha1, diffie-hellman-group1-sha1

Preferred MAC Algorithm
Used to control the transport MAC algorithm preference. The preferred algorithm is used if the server also supports it.
Possible values:
  • hmac-md5
  • hmac-md5-96
  • hmac-sha1
  • hmac-sha1-96
  • hmac-sha2-256
  • hmac-sha2-256-96
  • hmac-sha2-512
  • hmac-sha2-512-96
If no preference is specified, the MAC algorithms are presented to the server in this order:

hmac-sha2-256, hmac-sha2-512, hmac-sha1, hmac-sha2-256-96, hmac-sha2-512-96, hmac-sha1-96, hmac-md5, hmac-md5-96

Preferred Public Key Algorithm
Used to control the transport public key algorithm preference. The preferred algorithm is used if the server also supports it.
Possible values:
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ecdsa-sha2-nistp521
  • rsa-sha2-256
  • rsa-sha2-512
  • ssh-dss
  • ssh-ed25519
  • ssh-rsa
Default value: None

If no preference is specified, the public key algorithms are presented to the server in this order: rsa-sha2-256, rsa-sha2-512, ssh-rsa, ssh-dss, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521, ssh-ed25519

Note: The ssh-ed25519 algorithm is not supported in FIPS mode.

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.
If multiple FTP commands are needed prior to the GET or PUT, set this property to all of the commands separated by semicolons (;).  If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes (").  Use of macro variables is supported.  See Using macro variables (Post/Pre Command context) for a list of the applicable macros.
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.
Possible values: On or Off
Default value: On
Preserve File Timestamps
When selected, the original file timestamp is retained for the destination file for GET and PUT.
Possible values: On or Off
Default value: Off
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.

Possible values: On or Off
Default value: On for AS2. AS4, FTP and SSH FTP when the host has exactly one mailbox. Off in all other cases.
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, and REST STREAM extensions to FTP. For more information, visit http://tools.ietf.org/html/rfc3659.
Possible values: On or Off
Default value: Off
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.
Possible values:
  • Alphabetical (ascending)
  • Alphabetical (descending)
  • Date/Time Modified (ascending)
  • Date/Time Modified (descending)
  • Size (ascending)
  • Size (descending)
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.
Possible values: Any value greater than zero.
Default value: 60 seconds
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 Fail is on, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and then the action stops.  When Terminate On Fail is off, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and the action continues.

Regarding CHECK commands:  Terminate On Fail is only honored if the ConditionsMet parameter is set and the result of the CHECK is classified as Error. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications.

Possible values: On or Off
Default value: On
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. 
Possible values: On or Off
Default value: On
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.
Possible values: On or Off
Default value: On
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.
Possible values: 0-n
Default value: 131072
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 Default is specified, the value set on the Configure > Options > Advanced tab takes precedence. 
Possible values:
  • System Default
  • TripleDES
  • AES-128
  • AES-192
  • AES-256
Default value: System Default
Zip Comment
Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations.
Default value: The value specified for this property on the Options > Advanced panel, if set.
Zip Compression Level
Controls the level of compression for LCOPY -ZIP operations. If System Default is specified, the value set on the Configure > Options > Advanced takes precedence 
Possible values:
  • System Default
  • 9 - (Best Compression)
  • 8
  • 7
  • 6
  • 5
  • 4
  • 3
  • 2
  • 1
  • 0 - (No Compression)
Default value: System Default
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. 
Possible values: On or Off
Default value: On

SSH FTP Mailbox

A mailbox's parameters allow you access to the host system. 

Note: This feature is being deprecated. For similar functionality, use a Users host. See Users Host for more information.

SSH FTP Mailbox: SSH FTP Tab

Note: By default, SSH FTP hosts have the REST Enabled advanced property set to On, which prevents the host from having more than one mailbox. If you want more than one mailbox for this host, set the REST Enabled advanced property to Off. See REST Enabled advanced property.

You configure the SSH FTP mailbox using a Password and/or one of two Public Key Authentication (PKA) methods. Your Trading Partner should specify the required type(s) of authentication necessary to access your account. 

To use PKA, you must create your authentication certificate (see Creating and providing your signing/encryption certificates) and then export an SSH FTP key to send to your trading partner in either OpenSSH FTP Public Key or SSH FTP Public Key (IETF) format. See Certificate management and Exporting certificates. See also Private key authentication.

User Name
Password
Credentials for authentication to the remote server.
Use Public Key Authentication
Enables fields necessary to use public key authentication with a user certificate. See Private key authentication.
Exchange Certificates
Displays the Certificate Exchange dialog box, which allows you to send your certificates to your trading partner. See Exchanging certificates with your trading partner.
Certificate Alias
Certificate Password
Credentials used to access the user certificate for PKA.
Use Key From File
Enables fields necessary to use PKA with an existing SSH private key file. This option is only available when you select Use Public Key Authentication. See Private key authentication.
Private Key File
Private Key Password
Name of and the password protecting the SSH private key file to use for PKA.

Private key authentication

Private key authentication (PKA) allows you to connect to your Trading Partner's remote server without exchanging your password over the Internet. PKA uses two keys: a private key that only you have, and a public key placed on the accessing server, usually by your Trading Partner's system administrator when the account is set up. In the VersaLex application, the private key portion is maintained securely in a User Certificate protected with the Certificate Password. The Certificate Alias specifies the desired User Certificate to use for PKA.

Note: You must provide your Trading Partner with the corresponding SSH Public Key using the Certificate Manager. Using options Export >OpenPGP or SSH FTP Keys select either the OpenSSH FTP Public Key or SSH FTP Public Key (IETF) format. Do not select and send the SSH FTP Private Key format to your Trading Partner.

Alternatively, you can use an existing private key file. This file should be stored in a secure place and protected with a password. This feature is applicable only if you have an existing SSH private key for authentication with your Trading Partner and you are using JRE1.3. SSH private keys have no standard format. OpenSSH, SSH FTP Public Key (IETF), PuTTY, and ssh.com all have different proprietary formats. A private key generated with one cannot immediately be used with another. The VersaLex application supports both OpenSSH and SSH FTP Public Key (IETF) private key file formats. If the private key is in a format not supported by the VersaLex application, you should export if from the application that created it in an OpenSSH format. To determine the format of your key you can simply open it using a text editor and compare it to the partial example formats listed below.

Supported Private Key Formats
Type Partial Example
IEFT (DSA)  
---- BEGIN SSHTOOLS ENCRYPTED PRIVATE KEY ----
Comment: 1024-bit DSA
Subject: John Doe
AAAACDNERVMtQ0JD3yrqcRRh1OwAAAFQof0uP52Ya5iOnuVm1+G+o9TpQwXrOQfjPp0w8+GQ9uJ7
IETF (RSA) 
---- BEGIN SSHTOOLS ENCRYPTED PRIVATE KEY ----
Comment: 1024-bit RSS
Subject: Jonh Doe
AAAACDNERVMtQ0JDEOMMw0wR0TwAAAEoUYoVJjvLn7lEnvusvbovpjscf1EDkJOMLX7HUddw8k9f
OpenSSH (RSA)  
-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQDzl7h/4lkzqSPR5GhpwYr5MmUL6IeiY9TAsA24dA3Xa45a0JIQ
 
OpenSSH (DSA)  
-----BEGIN DSA PRIVATE KEY-----
MIIBuwIBAAKBgQD42waNRIv7eJQoTR1PSQt+A2o8F9P1pGKLaLyw/rAg8N4FEHIN
Unsupported Private Key Formats
Type Partial Example
PuTTY 
PuTTY-User-Key-File-2: ssh-rsa
Encryption: none
Comment: rsa-key-20070808
Public-Lines: 4
AAAAB3NzaC1yc2EAAAABJQAAAIBw8VeSCq0goiOwWqrlMu7H+N1QXAcBPdmvYttw
SSH.COM 
---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----
Comment: "rsa-key-20070808"
P2/56wAAAiwAAAA3aWYtbW9kbntzaWdue3JzYS1wa2NzMS1zaGExfSxlbmNyeXB0e3JzYS

SSH FTP Mailbox: Packaging Tab

See Configuring mailbox packaging for information about payload file packaging.

SSH FTP Action

An action's parameters capture a repeatable transaction for your mailbox on the host system.

You create actions under a mailbox.

SSH FTP Action: Action Tab

See Composing an action and SSH FTP Command Reference.

SSH FTP Command Reference

CD

Changes the current working directory on the host.

CD "directory"
"directory"
The new working directory.

CHECK

See CHECK Command for information about this command.

CHGRP

Changes the group ID of the file or directory on the host.

QUOTE CHGRP group "path"
group
The numeric group id for the new group.
"path"
The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

CHMOD

Changes the access permissions or modes of the file or directory on the host.

QUOTE CHMOD permissions "path"
permissions
The absolute mode of the file/directory. Absolute modes are octal numbers specifying the complete list of attributes for the files; you specify attributes by OR'ing together these bits.
  • 0400 - Individual read
  • 0200 - Individual write
  • 0100 - Individual execute (or list directory)
  • 0040 - Group read
  • 0020 - Group write
  • 0010 - Group execute
  • 0004 - Other read
  • 0002 - Other write
  • 0001 - Other execute
"path"
The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

CHOWN

Changes the user ID of the file or directory on the host.

QUOTE CHOWN owner "path"
owner
The numeric user id for the new owner.
"path"
The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
 

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. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

GET

Receive one or more files from the host

GET -REC –DEL –UNI|–APE "source" "destination"
-REC
Recursively retrieve nested subdirectories.
  • Nested server directory structure retained locally.
  • If used in conjunction with –DEL, the retrieved files, but not subdirectories, are deleted on the server.
-DEL
If the command is successful, delete the local file.
-UNI
Ensure the copied filename is unique.
-APE
Append copied file to existing destination file.
"source"
Remote source path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"
Local 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.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

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.
You cannot use this option with the -UNZ option.
-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 -REC option.
  • 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 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 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 ("...").
"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 -REC and -ZIP options, and Zip Subdirectories Into Individual Zip Files is 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 -APE option, or when copying a file with the -APE option 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 expressionsfor 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 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 ("...").
"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 With parameter is omitted, then the input bytes are deleted from the file.

PUT

Send one or more files to the host.

 PUT –DEL -APE "source" "destination" name=value,...
–DEL
If the PUT command is successful, delete local file(s).
-APE
Append copied file to existing destination file.
"source"
Local 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 outbox.
  • 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"
Remote destination path.
  • 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 ("...").

MKDIR

Creates a new directory on the host.

QUOTE MKDIR "directory"
"directory"
The name of the new directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

MKDIRS

Creates a new directory on the host.

QUOTE MKDIRS "path"
"path"
The path of directories to create. Subdirectories are created using the / delimiter. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").  

PWD

Returns the name of the current working directory on the host.

QUOTE PWD

RENAME

Renames a file or directory on the host.

QUOTE RENAME "source" "destination"
"source"
The source file/directory to rename. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").  
"destination"
- The destination file/directory name. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").  

RM

Removes a file on the host.

QUOTE RM "path"
"path"
The path of the file to remove. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").  

RMDIR

Removes a directory on the host.

QUOTE RMDIR "path"
"path"
The path of the directory to remove. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").    

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 property

    or

    SET property=
  • To clear a string property, use the CLEAR command

STAT

Returns the attributes of the file or directory on the host.

QUOTE STAT "path"
"path"
The path of the file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").    

SYMLINK

Creates a symbolic link on the host to a file or directory.

QUOTE SYMLINK "path" "link"
"path"
The target path of the file/directory for the symbolic link. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").    
"link"
The name for the new symbolic link. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").    

SYSTEM

Execute a local system command.

SYSTEM "path"
"path"
Local command path with arguments.

TOUCH

Sets the remote file access and modified times to the current time. 

QUOTE TOUCH "path"
"path"
The path of the file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").    

WAIT

Pause execution.

WAIT seconds
Seconds
Number of seconds to pause.

Related articles

Comments

0 comments

Please sign in to leave a comment.