< Back to User Guide Top

AS3 host

Use generic AS3 Hosts to specify an AS3 installation based on a specific AS3/FTP server product.

This includes the product's specific server choreography, or the commands needed to successfully log in to the remote server and send and receive files. The product choreography for each generic AS3 host was established during AS3 interoperability testing with the server products, and a generic host for all interoperability-certified AS3 products is included in the VersaLex installation. Since these hosts were created for a test environment, you might need to adjust some settings and commands to establish successful file transfers in a production environment. If it is available, use a pre-configured host specific to your trading partner's remote server. This makes for a faster and easier set up of your installation.

The AS3 standard provides the ability to securely transport EDI (and other data, including binary and XML) to a remote host over FTP, guaranteeing that the message has not been changed in-transit and has been received and can be read only by the intended trading partner. A Message Disposition Notification (MDN) receipt further guarantees that the intended trading partner has received the message.

AS3 uses the FTP protocol as its transport mechanism to send and receive files over the Internet. VersaLex uses the PUT/GET action commands to transport the secure data to/from the remote host.

Connector Access & Licensing

Connectors require separate licenses and are governed by commercial terms. Although all connectors are accessible in-product by default, usage beyond the Customer’s contract is subject to audit and adjustment.

For compliance or subscription inquiries, please contact Cleo Sales.

AS3 Configuration

A host describes the remote server of your trading partner to which messages will be sent. The host's parameters specify its location and how it is reached. Your remote trading partner should have provided information to you in the form of a URL, which you will use to configure the host parameters.

This section describes how to configure a generic AS3 pre-configured host.

  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 AS3 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 AS3 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 AS3 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.

AS3 Host

The following sections describe how to configure any of the generic AS3 hosts. A host describes the remote server of your trading partner to which messages will be sent. The host's parameters specify its location and how it is reached.

AS3 Host: General Tab

The host General tab for an AS3 Host contains the fields described in detail below. The default values of these fields vary per generic or pre-configured host. For pre-configured hosts, the fields on the General tab typically remain unchanged unless you need to either connect through a forward proxy or change the Default Directories.

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. 

Default value: 80 for HTTP and  443 for HTTPs (SSL)
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.

Default value: System Default
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  Cleo VLTrader and Cleo Harmony, 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 VersaLex and not shown here.
Directory Description
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

AS3 Host: AS3 Tab

Use the AS3 tab to specify values for AS3-specific parameters.

Setting Description
Overwrite duplicate file names Disabled for AS3.
Use default file name Disabled for AS3.
Add Content-Type Directory to Inbox

Allows you to sort incoming messages based on content-type to a subdirectory under the Inbox specified on the  General tab. Specify each of the Content-Types you want to direct to specific subdirectories by entering a name in the Directory field. You can specify directories for Content-Types of:  EDIFACT, X12, XML, Binary, Plain Text, EDI Consent and Other (a default for messages with all other Content-Types you might receive). You can specify the same subdirectory for multiple Content-Types. You can also leave Directory entries blank, which causes any received messages of that Content-Type to be stored in the Inbox specified on the  General tab. 

For IBM i / iSeries (AS/400) usage, see  AS/400 Setup and installation or  AS/400 PC network access setup for information on configuring the Content-Type Inbox settings to access the Native File System (NFS).

Note: If you use this feature, incoming messages are placed in the specified folder based on the content type specified in the HTTP header of the message.  VersaLex does not check the actual content of the message to determine its content type.

AS3 Host: FTP Tab

Field Description
Security Modes

If the AS3/FTP server requires use of the Secure Socket Layer (SSL), select a security mode. 

Possible values:

  • None - Indicates non-secure transfers; commands and data are clear-text.
  • SSL Implicit - For servers that support only SSL connections.
  • SSL Explicit - For servers that support SSL through the use of either the  AUTH SSL or  AUTH TLS command.

Default value:  SSL Explicit
Default Data Type The data type used when transferring files to and from the FTP server. The only valid Data Type for AS3 commands is Binary.
Data Channel Mode

The default behavior for opening data port connections between the AS3 client and AS3/FTP server.

Mode Description
Active mode Client listens 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 Server listens for an outbound connection from the client during data transfers. The server indicates the IP address and port number. The AS3/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 might be necessary if the server is advertising an internal rather than an external IP address.

AS3 Host: Advanced Tab

The host's Advanced tab contains several property settings fields. These settings typically do not affect the ability to connect to a host. However, you might want to change some of these settings when configuring a runtime environment.

See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for AS3 include:

Field Description
Abort In Process Transfers Indicates that the FTP server supports the ABORT command when a data transfer is interrupted. 

Possible values: On or Off 
Default value: Off
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
Allow Duplicate Incoming Message IDs Ignores messages with duplicate message IDs and allows reprocessing of the message. 

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

Possible values: On or Off 
Default value: Off
Base64 Encode Content Base64 is the encoding format used by Multi-purpose Internet Mail Extension (MIME) for transmitting non-text material over text-only communications channels. Base64 is based on a 64-character subset of US-ASCII, enabling 6 bits to be represented per printable character. 

Possible values: On or Off 
Default value: Off
Canonicalize Inbound Signed Content When this option is selected, a canonicalizer is used to ensure that ‘\r’ and ‘\n’ characters always occur together as ‘\r\n’.  This option may be used when the inbound signature hash verification fails and the trading partner is using OpenSSL to sign its messages. 

Possible values: On or Off 
Default value: Off
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
Compression- Signing Order When both signing and compression are enabled, indicates which is applied first. 

Possible values: Sign then compress or Compress then sign 
Default value: Sign then compress
Connection Keep Alive Timeout (seconds)

Allows the connection to the server to remain open while the message is being processed by sending  NOOP commands every n seconds.  This setting may be lowered if the connection to the server is being closed before the message can be fully processed. 

Possible values: 1 - n

0 or a negative value disables attempts to keep the connection open.

Default value: 60
Connection Timeout

The amount of time allowed for each read operation. 

Possible values: 0 - n seconds

0 indicates no timeout

Default value: 150 seconds
Data Socket Accept Timeout The amount of time allowed for each read operation on the data port. 

Possible values: 0 - 600 seconds, where 0 indicates no timeout. 
Default value: 150 seconds
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
Disable Address Resolution Indicates to connect directly to an IP address if the IP address is known and a DNS lookup is not desired. 

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
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
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
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, high priority transfers receive a larger portion of available bandwidth. 

Configure this percentage under Configure > Options > Other.

Note: This is a Cleo Harmony and Cleo VLTrader option.
Warning: Setting High Priority will not improve transfer rates if the trading partner’s bandwidth is the bottleneck.


Possible values:

  • Incoming
  • Outgoing
  • Both
Ignore Exception After Quit Indicates whether I/O errors that occur after issuing a QUIT command should be ignored. 

Possible values: On or Off
Default value: Off
Ignore Retrieve Error Code

Specifies FTP response codes (after a RETR) that should not be treated as errors.

Caution: Misuse may mask real errors.


Possible values: three‑digit codes, lists, or regular expressions.

Example: [550.*No such file.*]
Include Failure In Subject Of Email

Includes the exception message in failure notification emails.

Note: Messages longer than 256 characters are truncated.


Possible values: On or Off
Include Filename In Store Unique Command Indicates whether the FTP server expects a filename when using PUT -UNI. 

Possible values: On or Off
Default value: Off
Interim Retrieve Marks successfully retrieved files as Interim Success instead of Success. 

Possible values: On or Off
Default value: Off
Issue Command After Opening Data Connection Delays issuing transfer commands until after the data connection is established. 

Possible values: On or Off
Default value: Off
Keepalive Noop Command (seconds) Interval for issuing NOOP commands while a data transfer is active. 

Possible values: 0 – n
Default value: 0
LCOPY Archive Directory used to archive source files copied using LCOPY. 

Possible values: Any local or shared directory. Macros supported.
Log Individual LCOPY Results To Transfer Logging

Logs individual send/receive results for each file copied.

Note: Cleo Harmony and Cleo VLTrader only.


Possible values: On or Off
Macro Date Format Date format used by the %date% macro.
Macro Time Format Time format used by the %time% macro.
Maximum Incoming Transfer Rate (kbytes/s) Limits incoming transfer rates per host or mailbox. 

Possible values: 0 – n
Maximum Outgoing Transfer Rate (kbytes/s) Limits outgoing transfer rates per host or mailbox. 

Possible values: 0 – n
Next File On Fail Determines whether wildcard GET continues after a failure.
Only Retrieve First Available File Limits wildcard GET operations to the first available file.
Only Retrieve Last Available File Limits wildcard GET operations to the last available file.
Outbox Sort Controls file transfer order for PUT operations.
Outgoing Insert EOL Between Interchanges When Fixed Record Outgoing Insert EOL is enabled, also inserts EOL characters between EDI interchanges. 

Possible values: On or Off
Default value: Off
Partner Email Address

Email address of the trading partner. When set, it is used to send profile information and certificates. 

Possible values: One or more email addresses separated by commas, semicolons, or colons.

Note: Cleo LexiCom only. For Cleo Harmony and Cleo VLTrader, this is managed through Trading Partner Management.
Password Automatic Update (days) Number of days after which a new FTP password is generated and applied, when Password Update Format is set. 

Possible values: 0–n days
Default value: 0 days
Password Update Format Format of the PASS command when changing a password. Server-defined. 

Use %old% and %new% placeholders (for example, %old%/%new%).
PGP Compression Algorithm Compression algorithm used when OpenPGP packaging with compression is enabled. 

Possible values: System Default, ZIP, ZLIB
Default value: System Default
PGP Encryption Algorithm Encryption algorithm used for OpenPGP packaging with encryption. 

Possible values include: System Default, TripleDES, Blowfish, CAST5, DES, AES‑128/192/256, Twofish
Default value: System Default
PGP Hash Algorithm Signing hash algorithm used when OpenPGP signing is enabled. 

Possible values include: System Default, MD2, MD5, RIPE‑MD‑160, SHA‑1, SHA‑256/384/512
Default value: System Default
PGP Integrity Check Includes an integrity check when encrypting OpenPGP messages. 

Possible values: On or Off
Default value: On
PGP Signature Verification Verifies signatures on inbound signed PGP messages. 

Possible values: On or Off
Default value: On
PGP V3 Signature
Post Get Command Commands executed only after a successful GET. Use a SET command in the action before GET, not the Advanced tab.
Post Put Command Commands executed only after a successful PUT. Can be set to QUIT to force reconnects.
Pre Get Command Commands executed before a GET. Keeps logs scoped to GET operations.
Pre Put Command Commands executed before a PUT. Prevents unnecessary connections when no files exist.
Pre Put Change Directory Forces a CWD before issuing a PUT. 

Possible values: On or Off
Default value: Off
Pre Put Command For First File Only Executes Pre Put commands only once instead of per file. 

Possible values: On or Off
Default value: On
Resume Failed Transfers Attempts to resume failed transfers when retries are enabled. Requires FEAT, SIZE, and REST STREAM support. 

Possible values: On or Off
Default value: Off
Retain Temporary Inbound Message Files

Retains inbound temp files in the temp\ folder for diagnostics.

Note: Files are retained for seven days.


Possible values: On or Off
Default value: Off
Retrieve Directory Sort Controls file download order and forces use of LIST. 

Possible values: Alphabetical, Date/Time Modified, Size
Retrieve Last Failed File First Attempts the most recently failed file first on subsequent downloads.
Retry Delay Amount of time (in seconds) before a retry attempt is made. 

Possible values: Any value greater than zero
Default value: 60 seconds
Reuse SSL Session Reuses the command port SSL session for data port connections when possible. 

Possible values: On or Off
Default value: Off
Reuse SSL Sessions Across Actions Allows SSL sessions from previous actions to be reused for connections to the same destination. 

Possible values: On or Off
Default value: On
RSA-OAEP Key Algorithm Parameter Specifies the mask and hash generation functions used when the RSAES-OAEP algorithm is used. 

Possible values: MGF1-SHA1, MGF1-SHA256, MGF1-SHA512
Default value: MGF1-SHA1
SSL Allow Legacy Renegotiation Allows legacy SSL renegotiation. If disabled, RFC 5746 secure renegotiation is required. 

Possible values: On or Off
Default value: On
SSL Cipher Specifies the cipher used for SSL key exchange, encryption, and hashing. If unset, the server selects the cipher. 

Possible values: Any cipher from the supported list
SSL Maximum Protocol Version Specifies the maximum SSL/TLS protocol version allowed. If blank, the most recent supported version is used. 

Possible values: SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2
SSL Minimum Encryption Key Size Specifies the minimum allowed encryption key size. 

Possible values: 0 – n bits
Default value: 0
SSL Minimum Protocol Version Specifies the minimum SSL/TLS protocol version allowed. 

Possible values: SSL 3.0, TLS 1.0, TLS 1.1, TLS 1.2
Default value: SSL 3.0
SSL Use Record Splitting Enables 1/n‑1 record splitting in CBC mode as a mitigation for BEAST attacks. 

Possible values: On or Off
Default value: On
Store Raw Sent Message Stores a copy of the outbound message in the HTTP/sent directory. 

Possible values: On or Off
Default value: Off
Terminate On Fail

Stops the action when a command fails.

Note: Behavior differs for CHECK vs non‑CHECK commands.


Possible values: On or Off
Default value: On
Unzip Use Path Uses zip entry paths when extracting files via LCOPY -UNZIP. 

Possible values: On or Off
Default value: On
Use Content Type For File Extension Determines file extensions for inbound messages using Content‑Type instead of .file. 

Possible values: On or Off
Use EPRT and EPSV Uses EPRT/EPSV commands for IPv6‑style addressing. 

Possible values: On or Off
Default value: Off
Use External IP Address in PORT request Uses the external IP address in active‑mode PORT requests. 

Possible values: On or Off
Default value: Off
Use Folded Headers For Outbound Messages Enables line wrapping for outbound HTTP headers longer than 76 characters. 

Possible values: On or Off
Default value: Off
Use NLST Uses NLST rather than LIST for wildcard GET operations. 

Possible values: On or Off
Default value: On
Use SMIME Over FTP Headers Enables compatibility with pre‑AS3 servers by translating AS3 headers to standard SMTP headers. 

Possible values: On or Off
Default value: Off
Wait For Execute On Waits for Execute‑On commands to complete before continuing. 

Possible values: On or Off
Default value: On
XML Encryption Algorithm Specifies the encryption algorithm used for XML Encryption packaging. 

Possible values: System Default, TripleDES, AES‑128/192/256
Default value: System Default
Zip Comment Comment added to zip archives created using LCOPY -ZIP.
Zip Compression Level Controls compression level for zip operations. 

Possible values: 0 (none) – 9 (best)
Default value: System Default
Zip Subdirectories Into Individual Zip Files Bundles each first‑level subdirectory into its own zip file during recursive zip operations. 

Possible values: On or Off
Default value: On

AS3 Mailbox

Mailbox parameters allow you access to the remote host and define the security of files being sent. 

You can use the AS3 mailbox wizard to configure your system for the most common setup. See Using the wizard to create a host or mailbox.

AS3 Mailbox: AS3 Tab

Select encryption and signing for sending messages and optional security for receiving messages. If an MDN receipt is required, you can also select the format and delivery method of that receipt.

Setting Description
Request

Specify the S/MIME format for messages sent to the remote host.

  • Unsigned / unencrypted (neither Encrypted nor Signed selected)
  • Signed (only Signed selected)
  • Encrypted (only Encrypted selected)
  • Signed / Encrypted (both Signed and Encrypted selected)
Receipt Enables the MDN Receipt section. See MDN Receipt.
Encryption Algorithm When Encrypted is selected, allows you to choose the encryption algorithm used to send messages to the remote host. The trading partner must support the selected algorithm. 

Default encryption method: TripleDES. See Cryptographic Services.
Key Algorithm

When Encrypted is selected, specifies the algorithm used to encrypt the content encryption key with the trading partner’s public key. 

Possible values:

  • RSA (default)
  • RSAES-OEAP
Signature Algorithm

When Signed is selected, specifies how the signature hash is encrypted using your signing certificate. 

If RSA is selected, the chosen Hash/MIC Algorithm determines the signature algorithm (for example, sha256WithRSAEncryption). 

If RSASSA-PSS is selected, the signature is secured using RSASSA‑PSS with the selected hash algorithm. 

Possible values:

  • RSA (default)
  • RSASSA-PSS
Hash/MIC Algorithm

When Signed is selected in the Request section, this algorithm is used with the signature algorithm to secure the signature.

Note: If RSASSA‑PSS is used with SHA‑512, the signing certificate must support SHA256withRSA or stronger.


When Signed is selected in the MDN Receipt section, the same algorithm is used to compute the Message Integrity Check (MIC). 

Possible values:

  • SHA‑1 (default)
  • MD5 (cryptographically weak; not recommended)
  • SHA‑256
  • SHA‑384
  • SHA‑512
Compress Content When Compress is selected, the message is compressed using ZLIB to improve transfer efficiency and security, typically for large files.
Inbound Message Security Indicates how inbound messages must be received. 

Select any combination of Force Encryption, Force Signature, and Force MDN Signature to enforce message security requirements. 

If no options are selected, inbound message security is not checked.
MDN Receipt

Attributes of the Message Disposition Notification (MDN) receipt. 

MDNs for AS3 are returned asynchronously as part of a new FTP PUT or GET command.

Option Description
Signed Computes and stores an independent MIC over the sent message. The trading partner returns a signed MDN containing a MIC computed using the same algorithm. Matching MICs confirm message integrity.
Forward MDN to Email Forwards a copy of the received MDN to the specified email address.
Synchronous Disabled for AS3.
Asynchronously The only supported MDN mode for AS3. MDNs are returned in a separate FTP session after the acknowledgment phase.

AS3 Mailbox: Certificates Tab

Associate a trading partner's signing and encryption certificates with this AS3 mailbox and override the signing and encryption certificates defined in the Local Listener, if necessary. 

You must acquire your trading partner's signing and encryption certificates and provide yours to your trading partner. See Acquiring your trading partner's signing and encryption certificates and Creating and providing your signing/encryption certificates.

Section Description
Trading Partner's Certificates
Setting Description
Encryption Certificate The file containing your trading partner’s encryption certificate. Specify a value or click Browse to select a certificate file.
Signing Certificate Enable this field to specify your trading partner’s signing certificate.

The file containing your trading partner’s signing certificate. Specify a value or click Browse to select a certificate file.

If no signing certificate is specified, the VersaLex application uses all certificates in its certificate store to determine whether the signature of an incoming message is trusted.
Use encryption certificate

Indicates that your trading partner uses the same certificate for both signing and encryption (the most common practice).

When selected, the Signing Certificate field is automatically populated with the certificate selected in the Encryption Certificate field.

If the remote host supports Certificate Exchange Messages (CEM) or you want to email certificates to your trading partner, click Exchange Certificates.
My Certificates
Setting Description
Override Local Listener Certificates Enables partner‑specific signing and encryption certificates instead of the certificates configured for the Local Listener.

If you override the default certificates, you must also exchange the certificates specified here with your trading partner.
Exchange Certificates Opens the Certificate Exchange dialog, allowing you to send user and SSL certificates to your trading partner.
Signing Certificate Alias The alias of the signing certificate registered through the VersaLex Certificate Manager. The certificate must match the one exchanged with your trading partner, unless overridden at the Mailbox level.

Use Browse to select a certificate and enter the Password for the certificate’s private key.
Encryption Certificate Alias The certificate used to decrypt messages from your trading partner when a separate encryption certificate is used.

Use Browse to select a certificate and enter the Password.
Use signing certificate Uses the same certificate for signing and decrypting messages.

When selected, the Encryption Certificate Alias and Password fields are populated from the Signing Certificate Alias and disabled.
Exchange Certificates Opens the Certificate Exchange dialog. If default certificates are overridden, these alternate certificates must be exchanged with your trading partner.

Overriding AS3 Local Listener Certificates

By default, the certificates you configured on the Certificates tab of the Local Listener panel will be the certificates used to sign messages sent to your trading partner and decrypt messages received from your trading partner. See Configuring certificates for Local Listener.

Use Override Local Listener Certificates to select alternate certificates for signing and decrypting messages with this particular trading partner. If you do override the default the certificates, don't forget to export and exchange these alternate certificates with your trading partner.

AS3 Mailbox: FTP Tab

Section Description
Login
Field Description
User Name Credentials for authentication to the FTP server.

Select No Password Required if no password is required for authentication.

FTP Account is optional.
Password
FTP Account
Headers
Field Description
AS3-From

Enter the AS3-From and AS3-To names for this trading relationship.

Note: These values are agreed upon during partner setup. They may be company identifiers (for example, a DUNS number) or an agreed-upon string.

The AS3-From / AS3-To combination is case-sensitive and must be unique across all hosts, as it is used to determine the Inbox for received messages.
AS3-To
Subject Identifies the message and is returned in the human‑readable portion of an MDN, if requested.
Field Description
Content-Type

Optional. Specifies the format of the message being sent. Used by both sender and receiver to assemble and parse the message.

Supported values:

  • EDIFACT
  • X12
  • XML
  • Binary
  • Plain Text
  • EDI Consent
Note: If Content-Type is not specified, or if multiple payloads are attached, the content type is auto-detected—first by file content, then by file extension.

Detectable types include application/edifact, application/edi-x12, application/edi-tradacoms, application/xml, application/pdf, application/msword, application/x-msexcel, application/rtf, application/zip, image/bmp, image/gif, image/tiff, image/jpeg, text/plain, text/html, and video/mpg.

AS3 Mailbox: Security Tab

If a Security Mode is specified in the host's FTP tab, a remote host can issue client certificates. If so, import the client certificate using Certificate management and then specify or browse for the imported certificate's alias and password.  

AS3 Action

An action's parameters define a repeatable transaction for your mailbox designated for the host system.

AS3 Action: Action Tab

Use the Action tab to configure commands within the action. See Composing an action. See also FTP Command Reference for further information.

Verifying Your AS3 Names

When configuring a client to exchange messages with a Cleo VLTrader or Cleo Harmony AS3 server, you can use the following SITE command to verify the client has correctly defined the AS3-To and AS3-From names. The command syntax is:

SITE VERIFY AS3-To: ‘your-AS3-To-name’, AS3-From: ‘your-AS3-From-name’

If your AS3 names are properly configured, the server returns a positive response. Otherwise, a failure response is returned.

When using a VersaLex client, you can use the %as3.to% and %as3.from% macros in place of your-AS3-To-name and your-AS3-From-name, and so on.

SITE VERIFY AS3-To: %as3.to%, AS3-From: %as3.from%

Note: See Using macro variables for further information.

AS3-Specific Directories

The following additional directories are created either during the AS3 installation or as needed by the application:

Directory Purpose
lostandfound\ Default inbox where incoming data is deposited when the application cannot determine where to put it.
AS3\

Location where raw (unprocessed) incoming and outgoing messages are stored. Incoming messages are located in the AS3\received directory and outgoing messages are located in the AS3\sent directory. These files can be helpful in diagnosing problems. Old files should be deleted or archived by the user, if necessary. 

The AS3\unsent directory contains raw header, data and message setup information files. These files are used if a message needs to be retransmitted, and are deleted automatically by the application once the message transfer has either completed successfully or has failed due to timeouts, exceptions, or the number of retries has been exhausted.

The AS3\mdn directory contains subdirectories for received (and optionally sent) MDNs.  This directory can be changed on the AS3 Service Panel. MDNs can be automatically archived by the application or manually archived by the user from the MDNs tab on the listener panel. Archived MDNs are stored inAS3\mdn\received\archive\mdn.zip or AS3\mdn\sent\archive\mdn.zip.

The AS3\data directory contains an AS3msgs.txt file used by the application to determine the receipt of duplicate messages.  Entries in this file are retained for the time interval configured on the AS3 Service panel .
temp\ Temporary location where incoming messages can be stored while being processed by the application. By default, they are deleted automatically once the message has been completely processed; however, these files can be kept for problem diagnosis by using the Retain Temporary Inbound Message Files host-level Advanced property. These temporary files will automatically be deleted after 7 days.

Related articles

Comments

0 comments

Please sign in to leave a comment.