AS2 Host: Advanced Tab
The host's Advanced tab contains several property settings fields. These settings typically do not affect your 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 AS2 include:
- Add Mailbox Alias Directory to Inbox
- Appends a subdirectory at the end of the host's configured inbox directory. This allows files received through different mailboxes to be kept separate.
- Add Mailbox Alias Directory to Outbox
- Appends a subdirectory at the end of the host's configured outbox directory. This allows files to be sent through different mailboxes to be kept separate.
- Add Mailbox Alias Directory to Receivedbox
- Appends a subdirectory at the end of the host's configured receivedbox directory. This allows files that have been sent through different mailboxes to be kept separate.
- Add Mailbox Alias Directory to Sentbox
- Appends a subdirectory at the end of the host's configured sentbox directory. This allows files that have been sent through different mailboxes to be kept separate.
- Allow Actions To Run Concurrently
- Normally, actions and host actions within the same host are allowed to run
concurrently. You can use this property to not allow actions and host actions to run
concurrently.Note: This is a Cleo Harmony and Cleo VLTrader option.
- Allow Duplicate Incoming Message IDs
- Ignores messages with duplicate message IDs and allows reprocessing of the message.
- Async MDN Preferred Port
- When non-zero, defines the preferred
port on which asynchronous MDNs will be returned from the trading partner.Note: This setting will always override any port settings defined on the Listener and AS2 Service panels; and VLProxy’s reverse-proxy port, if applicable.
- Async MDN Resends
-
When sending a payload that has requested an asynchronous MDN, specifies the maximum number of attempts that will be made to resend the payload after the specified “Async MDN Timeout” has been exceeded and the MDN has still not been received.
When returning an asynchronous MDN in response to a received payload, specifies the maximum number of attempts that will be made to resend the asynchronous MDN to the trading partner (e.g., when the outbound connection cannot be established).
- Async MDN Retry Delay
- When resending an asynchronous MDN because the initial attempt to send it has failed, specifies the number of seconds to wait in between those resend attempts.
- Async MDN Timeout
- The maximum time (in minutes) to wait for an asynchronous MDN to be received before either resending the payload (if Async MDN Resends > 0 in either the Host or Listener) or logging an error.
- 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.
- 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.
- 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.
- Compression- Signing Order
- When both signing and compression are enabled, indicates which is applied first.
- Connection Timeout
- The amount of time allowed for each read operation.
- Delete Zero Length Files
- Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
- Disable TE Headers
- When selected, disables the TE and Transfer Encoding request headers.
- Do Not Send Zero Length Files
- Indicates whether zero length files to be sent to the server should be ignored
rather than processed. If the
-DELoption is being used, any zero length file ignored will also be deleted. - Email On Check Conditions Met
- Send an email notification after running a CHECK command where
the overall conditions of the check are met. See Configuring email or execute based on results. Note: This is a Cleo Harmony and Cleo VLTrader option.
- Email On Check Conditions Not Met
- Send an email notification after running a CHECK command where
the overall conditions of the check are not met. See Configuring email or execute based on results. Note: This is a Cleo Harmony and Cleo VLTrader option.
- Email On Fail
- If an error occurs during a command, email the error condition. See Email/Execute Based on Results.
- Email On Flag
- If a flagged event occurs, email the event. See Configuring email or execute based on results.
- Email On Repetitive Action Failures
- When "Email On Fail" is enabled and the same failure occurs each time an action is
run for a specific host, leaving this option unchecked suppresses emailing of the same
alert multiple times. If the same email alert continues to be suppressed after 24 hours,
the suppressed email alert will be sent every 24 hours and after every system restart if
the failure occurs again. When the failure is resolved an email alert will be
sent.Note: This feature only suppresses multiple emails if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
- Email On Repetitive Listener Failures
- When "Email On Fail" is enabled and the same failure occurs each time an inbound
message is processed by the Listener 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. If the failure can be associated
with a specific host, an email alert will be sent when the failure is resolved. Failure
resolution email alerts will not be sent for general Listener failures since it is not
possible to determine that these types of failures have been resolved.Note: This feature only suppresses multiple emails if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
- Email On Successful Copy
- Send an email notification after copying a file using LCOPY. See Configuring email or execute based on results.
- Email On Successful Receive
- Send an email notification after successfully receiving a file. See Configuring email or execute based on results.
- Email On Successful Send
- Send an email notification after successfully sending a file. See Configuring email or execute based on results.
- Execute On Check Conditions Met
- After executing a CHECK command where the overall conditions are
met, run a system command. See Configuring email or execute based on results. Note: This is a Cleo Harmony and Cleo VLTrader option.Note: Note that if multiple files contribute to the conditions being met, and one of the file macros is in the command (e.g., %file%), the system command will be executed repeatedly - once for each file.
- Execute On Check Conditions Not Met
- After executing a CHECK command where the overall conditions are
not met, run a system command. See Configuring email or execute based on results. Note: This is a Cleo Harmony and Cleo VLTrader option.
- Execute On Fail
- If an error occurs during a command, run a system command. See Configuring email or execute based on results.
- Execute On Repetitive Action Failures
-
When Execute On Fail is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of the Execute On Fail command. If suppression of execution of the command for this failure continues after 24 hours, the suppressed Execute On Fail command will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, the Execute On Fail command will be executed again. Users must account for this by including the %status% macro variable for the Execute On Fail command (see Using macro variables) and then checking for a success or failure.
Note: This feature only suppresses multiple executions of the Execute On Fail command if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts. - Execute On Repetitive Listener Failures
-
When Execute On Fail is enabled and the same failure occurs each time an inbound message is processed by the Listener 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 every system restart if the failure occurs again. If the failure can be associated with a specific host, the Execute On Fail command will be executed again when the failure is resolved. 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. Executions of the "Execute On Fail" command for resolution of general Listener failures will not be done since it is not possible to determine that these types of failures have been resolved.
Note: This feature only suppresses multiple executions of the Execute On Fail command if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts. - Execute On Successful Copy
- After successfully copying a file using LCOPY, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Execute On Successful Receive
- After successfully receiving a file, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Execute On Successful Send
- After successfully sending a file, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- Fixed Record EOL Characters
- End-of-line characters to be inserted and/or deleted.
- Fixed Record Incoming Delete EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater
than 0, indicates to look for and delete EOL characters while receiving a file.Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
- Fixed Record Incoming Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater
than 0, indicates to insert EOL characters while receiving a file.
Fixed Record Incoming Delete EOL and Fixed Record Incoming Insert EOL are mutually exclusive properties.
- Fixed Record Length
- The fixed record length after which end-of-line characters need to be inserted and/or deleted.
- Fixed Record Outgoing Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater
than 0, indicates to insert EOL characters while sending a file. Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
- High Priority
- Indicates whether incoming and/or outgoing transfers through the host should be treated
as high priority. When both high priority and regular priority transfers are active, the
high priority transfers get a larger portion of the available
bandwidth. Go
to to set the
High Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information. - Include Failure In Subject Of Email
- When specified, the exception message will be included in the email that is
generated on failure.Note: If the exception message exceeds 256 characters, it will be truncated.
- LCOPY Archive
- If specified, contains the directory for archiving LCOPY source files.
- Log Individual LCOPY Results To Transfer Logging
- When this option is enabled, a
<send>and<receive>result is logged to the transfer log for each file copied.Note: This is a Cleo Harmony and Cleo VLTrader option. - Macro Date Format
- Specifies the date format to be used when the
%date%macro is used. - Macro Time Format
- Specifies the time format to be used when the
%time%macro is used. - Maximum Incoming Transfer Rate (kbytes/s)
- Sets the maximum incoming transfer rate in Kbytes (1024 bytes) per second for each
mailbox or host. The default value of
0does not limit the transfer rate. The Maximum Incoming Transfer Rate system setting might also limit the transfer rates. The system Maximum Incoming Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers also affects individual transfer rates. See Advanced system options. - Maximum Outgoing Transfer Rate (kbytes/s)
- Sets the maximum outgoing transfer rate in Kbytes (1024 bytes) per second for each
mailbox or host. The default value of
0does not limit the transfer rate. The system setting might also limit the transfer rates. The system Maximum Outgoing Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers will also affect individual transfer rates. See Advanced system options for more information about Maximum Outgoing Transfer Rate. - Outbox Sort
- Controls the order in which multiple files are transferred for a
PUT command. If
System Defaultis specified, the value set on the tab takes precedence. ForAlphabeticalordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique. - Outgoing Insert EOL Between Interchanges
- If
Fixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file. - Override Listener CEM Auto Accept Setting
-
When selected, overrides the
Auto Accept Received Certificate (CEM)Advanced setting in the Listener allowing auto accepting of CEM requests to be allowed or disallowed on a per host basis. See Exchanging certificates with your trading partner. - Partner Email Address
- The email address of the trading partner for this trading relationship. When set, this address is automatically used to send your local profile information and/or certificates to your trading partner. SeeEmailing a profile to your trading partner.
- PGP Compression Algorithm
- Compression method used when OpenPGP packaging (with compression) is requested
through the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab is in effect. - PGP Encryption Algorithm
- Encryption method used when OpenPGP packaging (with encryption) is requested through
the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab takes precedence. - PGP Hash Algorithm
- Signing method used when OpenPGP packaging (with signing) is requested through the
Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab takes precedence. - PGP Integrity Check
- When OpenPGP encrypting (see Configuring mailbox packaging), include an integrity check on encrypted data. Can be disabled for compatibility with certain OpenPGP implementation.
- PGP Signature Verification
- Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. In general, this property should be enabled.
- PGP V3 Signature
- Put Multiple Files Limits
- Limits the number of files included in each generated multipart message when using the PUT -MUL option. The limit is only applied when sending out of a single directory; when sending multipart out of separate subdirectories, the files are kept as a group and not broken up into separate messages.
- Reset Connection After Timeout On Response
- When enabled will cause an immediate reset on the socket (instead of a graceful close) when a SocketTimeoutException occurs.
- REST Enabled
-
Allows the host to be accessible through the REST API. This feature is only supported on AS2, AS4, FTP and SSH FTP and only when the host has exactly one mailbox.
When this setting is enabled, new mailboxes cannot be created and the existing mailbox cannot be cloned, disabled, or removed.
- Resume Failed Transfers
- When selected and a transfer fails (and Command Retries > 0), attempt to resume
the transfer on a retry. If OpenPGP is enabled on the packaging tab (see Configuring mailbox packaging), the entire file is transferred instead of resuming
with a partial file. The server must support the
FEAT,SIZE, andREST STREAMextensions to FTP. For more information, visit http://tools.ietf.org/html/rfc3659. - Retain Temporary Inbound Message Files
-
Leaves any files that are used while processing inbound messages in the temp\ folder. The default action is to delete these files after processing has completed. These files may be helpful for problem diagnosis.
Note: These temporary files are retained for seven days. - Retry Delay
- The amount of time (in seconds) before a retry should be attempted.
- RSA-OAEP Key Algorithm Parameter
-
Represents the type of mask generation and hash generation functions that are applied when the RSAES-OAEP key algorithm is in use. See RFC4055 for a further description of the mask and hash generation functions.
- SSL Allow Legacy Renegotiation
- When selected, legacy renegotiation is allowed. If this property is not selected, the extension described in RFC5746 is used for renegotiation and the server must also support this extension. See RFC5746 for a description of the extension and the vulnerability it addresses.
- SSL Cipher
- Indicates a specific cipher to be used with the server for SSL key exchange, encryption, and hashing. If not set, the list of supported ciphers is presented to the server and the server picks one.
- SSL Maximum Protocol Version
- Specifies the maximum protocol version allowed. By default, this field is blank, designating that Cleo Harmony, Cleo VLTrader, or Cleo LexiCom will select the most recent version (currently TLS 1.2).
- SSL Minimum Encryption Key Size
- Specifies the minimum encryption key size allowed when selecting an SSL cipher. To
prevent use of low- or medium-strength ciphers, change from the default value of
0to112,128, or256(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabledexception to occur. - SSL Minimum Protocol Version
- Specifies the minimum protocol version allowed. SSL 3.0 is the default value for compatibility with servers that do not support the more recent TLS versions 1.0, 1.1, and 1.2.
- SSL Use Record Splitting
- Indicates whether to use 1/n-1 record splitting in CBC mode as a countermeasure against the Rizzo/Duong BEAST (Browser Exploit Against SSL/TLS) attack against the SSL 3.0 / TLS 1.0 protocol. Must be turned off if the SSL library on the other side of the connection does not support the feature.
- Store Raw Sent Message
- When this property is enabled, a copy of the outbound message is stored in the HTTP/sent directory.
- Terminate On Fail
- If an error occurs during a command, stop the action. Note:
Regarding non-CHECK commands: When
Terminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.Regarding CHECK commands:
Terminate On Failis only honored if theConditionsMetparameter is set and the result of the CHECK is classified asError. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications. - Unzip Use Path
- Indicates whether or not zip entry paths should be used for LCOPY -UNZIP operations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
- Use Content Type For File Extension
- By default, inbound messages that do not specifically contain the name of the target
file to be saved are stored using the value of the
Message-ID(of that message) with the .file extension. When this option is selected, inbound messages without a target file name specifier is stored using theMessage-IDand the appropriate file extension based on the Content-Type of the message. - Use Folded Headers For Outbound Messages
- Enables or disables automatic line wrapping of HTTP headers exceeding 76 characters. By default headers are not folded since some non-Cleo product remote hosts using Microsoft Internet Information Server (IIS) cannot handle folded headers properly. Unless your host has been pre-configured to enable folded headers, leave this setting cleared!
- Wait For Execute On
- Indicates whether execution should wait for processing to complete within an Execute On Fail, Execute On Successful Copy, Execute On Successful Receive, or Execute On Successful Send command. Note that this option does not apply to native AS400 execution.
- XML Encryption Algorithm
- The method used to encrypt/decrypt files when XML Encryption packaging is requested
through the Mailbox Packaging tab. See Configuring mailbox packaging . If
System Defaultis specified, the value set on the tab takes precedence. - Zip Comment
- Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations.
- Zip Compression Level
- Controls the level of compression for LCOPY -ZIP operations. If
System Defaultis specified, the value set on the takes precedence - Zip Subdirectories Into Individual Zip Files
- Indicates whether or not subdirectories should be bundled for LCOPY –ZIP
–REC operations. When enabled, each first-level subdirectory (and all of its
descendents) will be bundled together into an individual zip file. The name of this zip
file may optionally reflect the subdirectory name if an asterisk
(
*) is placed in the destination path. Any files that are directly off the source root directory will not be copied.