Sign in
< Back to User Guide Top

AS4 host

AS4 Configuration

This section describes how to configure a generic AS4 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 AS4 Host configuration.
    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 AS4 Mailbox configuration.
    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 AS4 Action configuration.
    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.

AS4 Host configuration

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

AS4 Host: General Tab

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

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.
Note: The Server Address and Port settings are reflected as read-only through the PMode.Protocol.Address setting.
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 how 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.
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.

AS4 Host: AS4 Tab

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

Overwrite duplicate file names
Allows for unique naming of stored files. When this check box is selected, any files that exist in the specified inbox will be overwritten. When the check box is cleared, an incoming file with the same name as one that already exists is made unique according to the Unique File Algorithm as set under System Options > Other.
Note: This setting does not apply to inbound database payload.
Use default file name
Select the check box and specify the name you want to use for incoming files by default.
You can use any of the supported macros (Destination File context) allowing for the incoming file to be named, for example, with a date-time stamp. For more information about macro variables and the destination file context, see Using macro variables.
Note: This setting does not apply to inbound database payload.
If you select Use default file name and your default string includes any variant of the %sourcefile% macro, the source file name is determined as follows:
  • If the Content-Disposition header exists and it contains a "filename" attribute, then this value is used.
  • If the Content-Type header exists and it contains a "name" attribute, then this value is used.
  • If the Content-Id header exists, then this value is used.

If you do not select Use default file name, then the incoming file name will be determined as follows:

  • If the Content-Disposition header exists and it contains a "filename" attribute, then this value is used.
  • If the Content-Type header exists and it contains a "name" attribute, then this value is used.
  • If the Content-Id header exists, then use this value.
  • Otherwise, the incoming message ID, plus the ".file" extension is used.
Note: This setting does not apply to inbound database payload.
Note: When the incoming file is tied to an attachment, the Content-xxx headers are those that directly precede the attachment. When the incoming payload is tied to a body payload, the Content-xxx headers are those at the top level of the HTTP request.
Note: For outbound, to add the setting of the "name" attribute on the Content-Type header, you can simply append it, along with an optional macro (Destination File context). For example, application/octetstream; name=%sourcefile%

AS4 Host: HTTP Tab

Use the AS4 tab to specify values for HTTP-specific parameters.

Outbound
Indicates whether you use SSL or not for outbound file transfers.
HTTP
Do not require use SSL
HTTP/s
Require SSL for outbound file transfers.
If you select HTTP/s, you can select Check certificate server name.
Inbound
HTTP/s only
Require your trading partner to use Secure Socket Layer (SSL) for inbound file transfers.
Command
Lists the commands available to AS4. PUT will initiate a push operation and GET will initiate a pull operation.
Method
Specifies the HTTP verb to be used. The only valid Method for AS4 commands is POST.
Path
The server Path for the command.
If the remote server is also using the VersaLex application, the path should be /as4. The resource path must be properly specified in order for your trading partner’s system to process messages from you. Given the URL provided by your remote trading partner in the form:

http(s)://remote-host:port/resource-path?optional-parameters

Enter the bolded portion in this field (if it was supplied).

Parameters
By default, no Parameters are specified for sending AS4 messages. If parameters are required, they must be obtained from your trading partner when the trading relationship is established. Given the URL provided by your remote trading partner in the form: 

http(s)://remote-host:port/resource-path?optional-parameters

Enter the bolded portion in this field (if it was supplied).

Headers

The Header fields are filled in at the Mailbox level and specify values to be set in the HTTP headers that precede the body (actual content) of the message to be sent.

The following Header can optionally be specified when sending AS4 messages:

  • Content-Type - throughout the entire AS4 message, there are several Content-Type settings, many of which are predetermined and cannot be changed. This Content-Type header is used to control the value of the MimeType property, as packaged within <eb:PartInfo/eb:PartProperties/eb:Property@name>, along with the @MimeType attribute of the <xenc:EncryptedData> element when using SOAP with Attachments (SwA) packaging. The Content-Type value should represent the native format of the payload before any processing, for example, compression. If the payload format is unknown, a content-type setting of application/octet-stream is recommended as it generally represents all types of data. If this optional parameter is not specified, then a default is determined based on whether SOAP with Attachments (SwA) packaging (application/octet-stream) or <Body> payload (text/xml) is being used.

AS4 Host: Advanced Tab

While the fields on the host's Advanced tab typically do not affect your ability to connect to a host, 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 AS4 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.
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
Bundle All Outbox Files For Pull Operations
Indicates whether all files within the outbox should be returned in response to a Pull Request Signal. When off, only a single file will be returned within the packaged User Message response. This file will always be the oldest file in the outbox. When on, all files in the outbox will be returned within the packaged User Message response.
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.

This value is reflected as read-only through the PMode.ReceptionAwareness.Retry andPMode.ReceiptionAwareness.MaxRetries settings.

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
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
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
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
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
Perform Schema Validation
When selected, inbound XML content -- on both requests and responses -- is processed through XML schema validation.
Possible values: On or Off
Default value: On
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
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.
Possible values: -1 - n

-1 indicates no limit.

Default value: -1
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.
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.
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
Reuse SSL Sessions Across Actions
If selected, SSL sessions from previous connections to the same destination (address and port number) may be resumed to avoid costly negotiation. If unselected, only SSL sessions used in the current action to the same destination may be resumed.  When unselected, a new SSL session is created for the initial command port connection.
Possible values: On or Off
Default value: On
Security Token Reference Type
Controls the type of security token reference that is placed in outgoing User Messages and Receipt Signals. For more information on token references, see the OASIS "Web Services Security X.509 Certificate Token Profile" standard.
Possible values: Binary Security Token, Subject Key Identifier, or Issuer and Serial Number
Default value: Binary Security Token
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.
Possible values: On or Off
Default value: On
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.
Possible values: Any cipher from the supported list. If the server does not also support the cipher, an SSL handshake error will occur.
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).
Possible values:
  • SSL 3.0
  • TLS 1.0 (SSL 3.1)
  • TLS 1.1 (SSL 3.2)
  • TLS 1.2 (SSL 3.3)
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 0 to 112, 128, or 256 (depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing the No suitable cipher suites are enabled exception to occur.
Possible values: 0 - n bits
Default value: 0
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.
Possible values:
  • SSL 3.0
  • TLS 1.0 (SSL 3.1)
  • TLS 1.1 (SSL 3.2)
  • TLS 1.2 (SSL 3.3)
Default value: SSL 3.0
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.
Possible values: On or Off
Default value: On
Store Raw Ping Message
Indicates whether copies of the "raw" outgoing requests and corresponding incoming responses for PING operations are stored in the AS4\ping folder. These files can be useful in diagnosing problems, however, generally this property should be off to conserve disk space.
Possible values: On or Off
Default value: Off
Store Raw Sent Message
Indicates whether copies of the "raw" outgoing requests and corresponding incoming responses are stored in the AS4\sent+received folder.  These files can be useful in diagnosing problems, however, generally this property should be off to conserve disk space.
Possible values: On or Off
Default value: Off
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 destinatiuseon path. 
Possible values: On or Off
Default value: On
Use MIME Packaging For Signal Messages
Indicates whether or not MIME packaging should be used for signal messages (that is, Receipt Signals, Error Signals, and Pull Request Signals).
Possible values: On or Off
Default value: Off
Use Soap With Attachments Formatting
Indicates whether or not Soap With Attachments (SwA) formatting should be used when packaging outgoing User Messages. For information on SwA formatting, see http://docs.oasis-open.org/wss/v1.1/wss-v1.1-spec-os-SwAProfile.pdf.
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
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

AS4 Mailbox configuration

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

AS4 Mailbox: AS4 Tab

The mailbox's AS4 tab allows you to to configure a Usage Profile, along with all the associated AS4 Processing Mode (P-Mode) settings.

Usage Profile
To assist with the job of configuring all the required P-Mode settings, you can select a profile that provides the default values for many of the P-Mode fields. Profiles that are available:
  • AS4 profile
  • eDelivery profile
  • PEPPOL profile
Profile
Displays the name of the current profile.
The initial setting for this field is None. Although it's not required to select a profile, it is recommended.
Set Profile Defaults...
Click this button to display a list of profiles from which you can load processing mode settings.
Note: The settings configured here will override any existing settings already in place.
Ping...
Click this button to run a simple connectivity test by sending a User Message with a single payload to your trading partner. This payload is created dynamically and is wrapped within an XML-formatted file called "PING.xml". The PING operation is part of a feature that is provided in compliance with the eDelivery 1.14 "Test Service" feature. Below are some notes to consider related to outbound/inbound PING operations:
  • All mailbox PMode settings and all host Advanced property settings are considered for PING operations. These include, for example, signing, encryption, and compression.
  • All outbound/inbound PING operations are not logged as a transfer. Therefore, they will not be seen in any transfer reporting features.
  • When the Store Raw Ping Message advanced property is set, all inbound payloads that are associated with a PING operation are stored under the AS4/ping folder.
  • Receipts may or may not be exchanged as part of the PING operation, depending upon the active PMode settings. If Receipts are exchanged and the Store Raw Ping Message advanced property is set, they are stored under the AS4/ping/receipts folder.
Processing Mode (P-Mode) parameters
P-Mode parameters define how User Messages and Signal Messages should be processed. These parameters define either elements that are expected to be found in the messages or expected processing behavior.
This section contains a series of tabs on which you can enter values for various settings related to AS4 Processing Modes. Each tab contains a set of related fields, as defined by the AS4 specifications.
General tab
PMode.ID
An optional identifier for this P-Mode agreement, used primarily for the convenience of P-Mode management.
PMode.Agreement
A reference to the agreement governing all message exchange.
PMode.Agreement.Type
Additional information indicating how the parties will interpret the Agreement value.
PMode.Initiator.Party
Identifies the VersaLex party ID for this relationship.
Outbound User Messages use this value as the <eb:PartyInfo/eb:From/eb:PartyId> element value.
For inbound User Messages, the receiving message handler (MSH) takes the values of the <eb:PartyInfo/eb:To/eb:Party> and the <eb:PartyInfo/eb:From/eb:Party> elements and searches every AS4 mailbox for matches to PMode.Initiator.Party and PMode.Responder.Party settings, respectively. It does this in order to associate the inbound message with the proper recipient. If a match is not made, the request is not accepted. If more than one mailbox matches, the request is also not accepted. For this reason, the to/from settings must be unique within every AS4 mailbox of the VersaLex instance.
PMode.Initiator.Party.Type
The domain of names to which the string in the content of the <eb:PartyId> element belongs. The value of the type attribute must be mutually agreed to and understood by each of the parties.
PMode.Initiator.Role
Identifies the VersaLex role for this relationship. An outbound User Message will use this value as the<eb:PartyInfo/eb:From/eb:Role> element value.
PMode.Initiator.Authorization.username
This value defines the VersaLex username for this relationship. If an incoming User Message or Pull Request contains a UsernameToken, then this value is used to match to the incoming <wsse:Username> value.
PMode.Responder.Party
The trading partner party ID for this relationship.
Outbound User Messages use this value as the <eb:PartyInfo/eb:To/eb:PartyId> element value.
For inbound User Messages, the receiving message handler (MSH) takes the values of the <eb:PartyInfo/eb:To/eb:Party> and the <eb:PartyInfo/eb:From/eb:Party> elements and searches every AS4 mailbox for matches to PMode.Initiator.Party and PMode.Responder.Party settings, respectively. It does this in order to associate the inbound message with the proper recipient. If a match is not made, the request is not accepted. If more than one mailbox matches, the request is also not accepted. For this reason, the to/from settings must be unique within every AS4 mailbox of the VersaLex instance.
PMode.Responder.Party.Type
The domain of names to which the string in the content of the <eb:PartyId> element belongs. The value of the type attribute must be mutually agreed and understood by each of the parties.
PMode.Responder.Role
The trading partner role for this relationship. Outbound User Messages use this value as the <eb:PartyInfo/eb:To/eb:Role> element value.
PMode.Responder.Authorization.username
This value defines the VersaLex username for this relationship. If an incoming User Message contains a UsernameToken, and this User Message is in response to a Pull Request, then this value is used to match to the incoming <wsse:Username> value. This value may be the same as PMode.Initiator.Authorization.username.
PMode.Responder.Authorization.password
This value defines the VersaLex password for this relationship. If an incoming User Message contains a UsernameToken, and this User Message is in response to a Pull Request, then this value is used to match to the incoming <wsse:Password> value. This value may be the same as PMode.Initiator.Authorization.password.
PMode.MEP
The type of ebMS message exchange pattern (MEP) associated with this P-Mode.
PMode.MEPbinding
The transport channel binding assigned to the MEP (for example, push, pull).
Protocol tab
PMode.Protocol.Address
Read-only.
The server address and port of the receiving message handler (MSH). You can only change it through the host General configuration.
PMode.Protocol.SOAPVersione
Read-only.
The SOAP version to be used. SOAP 1.2 is supported.
Business Info tab
PMode.BusinessInfo.Service
The name of the service to which the User Message is intended to be delivered.
PMode.BusinessInfo.Service.Type
Additional information indicating how the parties will interpret the Service value.
PMode.BusinessInfo.Action
The name of the action the User Message is intended to invoke.
PMode.BusinessInfo.Properties[]
A table that contains a list of key-value pairs added to the User Message within the <eb:MessageProperties> element.
Note: For the eDelivery and PEPPOL profiles, these two properties are required:
  • originalSender
  • finalRecipient
PMode.BusinessInfo.MPC
When using a Message Partition Channel (MPC) in conjunction with Pull Requests, this value provides this connection's unique MPC identification. This value maps to the @mpc attribute of the <eb:PullRequest> element. If left blank, the default MPC is used.
Error Handling tab
PMode.ErrorHandling.Report.AsResponse
Indicates whether an error generated on reception of a User Message must be returned as a synchronous response over the same SOAP message exchanged pattern (MEP).
PMode.ErrorHandling.Report.ProcessErrorNotifyConsumer
Read-only.
Indicates whether the Consumer of User Message should be notified when an error occurs in the receiving message handler (MSH), during processing of the received User Message. By default and relative to how VersaLex operates, this setting is always true as processing errors are always logged.
PMode.ErrorHandling.Report.ProcessErrorNotifyProducer
Read-only.
Indicates whether the Producer of a User Message should be notified when an error occurs in the sending message handler (MSH), during processing of the User Message to be sent. By default and relative to how VersaLex operates, this setting is always true as processing errors are always logged.
PMode.ErrorHandling.Report.DeliveryFailuresNotifyProducer
Read-only.
Indicates whether the Producer of a User Message must be notified when the delivery to Consumer fails. By default and relative to how VersaLex operates, this setting is always true as transmission errors are always logged.
PMode.ErrorHandling.Report.MissingReceiptNotifyProducer
Read-only.
Indicates whether the Producer of a User Message must be notified when the required receipt is not received. By default and relative to how VersaLex operates, this setting is always true as transmission errors are always logged.
Security tab
PMode.Security.WSSVersion
Read-only.
The version of WS-Security you want to use. WSS 1.1.1 is supported.
PMode.Security.X509.Sign
Indicates whether User Messages and Pull Requests should be signed by a sending message handler (MSH). Also indicates whether Receipt Signals should be signed by a receiving MSH..
Select this check box to enable the other fields in this section of the tab.
Note: All of the security signing properties apply to both the sending MSH (for example, sending a User Message) and the receiving MSH (for example, returning a Receipt Signal) where applicable.
PMode.Security.X509.Sign.Element.Body
Indicates whether the <eb:Body> element should be included in the signature.
PMode.Security.X509.Sign.Element.Messaging
Indicates whether the <eb:Messaging> element should be included in the signature.
PMode.Security.X509.Sign.Attachment
Indicates whether attachments should be included in the signature.
PMode.Security.X509.Signature.Certificate
Read-only on this screen. It can be changed only through the host Certificates configuration.
The filename of the trading partner's certificate (stored in the certs/ folder). The public key of this certificate is used for validation of incoming signatures.
Note: If a signing certificate is not provided, then incoming content that is signed must contain a <wsse:BinarySecurityToken> element, which provides the certificate. It is this certificate's public key that is then used for signature validation.
 
PMode.Security.X509.Signature.HashFunction
The hash function to be used for signing.
PMode.Security.X509.Signature.Algorithm
The algorithm to be used for signing.
PMode.Security.X509.Encryption.Encrypt
Indicates whether User Messages should be encyrpted.
Per the eDelivery and PEPPOL specifications and, by reference, per the AS4 Profile specification, encryption takes place only on payloads (either body payload or attachment payload). No component of the <eb:Messaging> element is encrypted. If security is required for this element, transport level security should be used.
Select this check box to enable other fields in this section of the tab.
PMode.Security.X509.Encryption.Certificate
Read-only on this screen. It can be changed only through the host Certificates configuration.
The filename of the trading partner's certificate (stored in the certs/ folder). This certificate's public key is used to encrypt outgoing messages.
PMode.Security.X509.Encryption.Algorithm
The algorithm to be used for data encryption.
PMode.Security.X509.Encryption.KeyTransportAlgorithm
The algorithm to be used for key encryption.
PMode.Security.X509.Encryption.KeyTransportAlgorithm.Parameter
Represents both the mask generation and digest generation functions. This setting only applies when the RSA-OAEP key transport algorithm has been selected.
PMode.Security.SendReceipt
Indicates whether a Receipt signal should be used to acknowledge successful receipt of a User Message. This applies to User Messages received asynchronously or User Messages received synchronously in response to a Pull Request Signal.
Note: Regarding signing of receipts, the Cleo Harmony AS4 server will always sign receipts ifPMode.Security.X509.Sign is set to true.
Select this check box to enable the other fields in this section of the tab.
PMode.Security.SendReceipt.ReplyPattern
The mode in which a Receipt Signal should be sent.
  • Callback indicates the receipt should be sent asynchronously.
  • Response indicates the receipt should be sent synchronously.
Note: When sending a receipt to acknowledge receipt of a User Message sent in response to a Pull Request Signal, this transmission will always be sent asynchronously.
.
PMode.Security.SendReceipt.NonRepudiation
Indicates whether a Receipt Signal should contain an <ebbp:NonRepudiationInformation> (NRI) element. The NRI element can only be included if the original User Message is signed, as it contains references to the User Message digests. If the original User Message is unsigned, then the complete <eb:UserMessage> element from the inbound request is included instead, regardless of this setting.
PMode.Security.PModeAuthorize
This setting indicates whether outbound Pull Requests and initiating User Messages (not User Messages sent in response to a Pull Request) should contain a <wsse:UsernameToken>.
Select this check box to enable the other fields in this section of the tab.
PMode.Security.UsernameToken.username
For outbound processing of Pull Requests and initiating User Messages, if PModeAuthorize is 'true', this value defines the trading partner username that should go into the <wsse:Username> element of the <wsse:UsernameToken>.
PMode.Security.UsernameToken.password
For outbound processing of Pull Requests and initiating User Messages, if PModeAuthorize is 'true', this value defines the trading partner password that should go into the <wsse:Password> element of the <wsse:UsernameToken>.
PMode.Security.UsernameToken.Digest
This setting indicates whether the <wsse:Password> value should be a base64-encoded, SHA-1 hash value of the password.
PMode.Security.UsernameToken.Nonce
This setting indicates whether a nonce value should be included in the <wsse:UsernameToken> element.
PMode.Security.UsernameToken.Created
This setting indicates whether a created timestamp should be included in the <wsse:UsernameToken> element.
Payload Service tab
PMode.PayloadService.CompressionType
Indicates whether User Messages should be compressed (application/gzip) or uncompressed (<None>).
Reception Awareness tab
PMode.ReceptionAwareness
Indicates whether the sending message handler (MSH) expecting a receipt (related to a sent message) should generate an error if no receipt is received.
Select this check box to enable the rest of the fields on the tab.
PMode.ReceptionAwareness.Retry
Read-only. It can be changed only through the host Advanced properties (Command Retries > 0).
Indicates whether the sending message handler (MSH) should retry to send a User Message if a receipt is not received, either synchronously or asynchronously.
PMode.ReceptionAwareness.Retry.MaxRetries
Read-only. It can be changed only through the host Advanced properties (Command Retries).
Indicates how many times the sending message handler (MSH) should retry to send a User Message if a receipt is not received, either synchronously or asynchronously.
Note: This setting only applies to User Messages sent as part of a PUSH operation, not those sent in response to a PULL operation.
PMode.ReceptionAwareness.Retry.Period
Read-only. It can be changed only through the host Advanced properties (Retry Delay).
Indicates the amount of time (in seconds) the sending message handler (MSH) should wait between retry attempts.  This setting governs the policy for both synchronous (response) or asynchronous (callback) responses.
PMode.ReceptionAwareness.DuplicateDetection
Indicates whether the receiving message handler (MSH) should track received message IDs (<eb:MessageInfo>/<eb:MessageId>) in order to prevent duplicates from being available to the Consumer.
This means, in addition to detecting duplicates, the receiving MSH eliminates duplicates by blocking them from being received. An appropriate Error Signal is provided to the sending MSH when this occurs.
PMode.ReceptionAwareness.DuplicateDetection.MaxWindow
Indicates the number of days the receiving message handler (MSH) should store message IDs for the purpose of duplicate detection.

AS4 Mailbox: Certificates Tab

Use this tab to associate a trading partner's signing and encryption certificates with this mailbox and to override your own Local Listener's signing and encryption certificates, if necessary.

Acquire your trading partner's signing/encryption certificates and provide your trading partner with your signing/encryption certificates. See Acquiring your trading partner's signing and encryption certificates and Creating and providing your signing/encryption certificates.

Trading Partner's Certificates
Encryption Certificate
The name of the file containing your Trading Partner's encryption certificate. The public key of this certificate is used to encrypt payloads of outgoing User Messages.
Specify a value or click Browse to navigate to the file you want to select.
Note: This value is reflected as read-only through the PMode.Security.X509.Encryption.Certificate setting.
Signing Certificate
Select the check box to enable the field.
The name of the file containing your Trading Partner's signing certificate. The public key of this certificate is used to validate incoming signatures.
Specify a value or click Browse to navigate to the file you want to select.
Note: If a signing certificate is not provided, then incoming content that is signed must contain a <wsse:BinarySecurityToken> element, which provides the certificate. It is this certificate's public key that is then used for signature validation.
Note: This value is reflected as read-only through the PMode.Security.X509.Signature.Certificate setting.
Use encryption certificate
Indicates that your trading partner uses the same certificate for signing and encryption, which is a common practice among trading partners. When you select this check box, the Signing Certificate field is populated with the same certificate you selected in the Encryption Certificate field.
My Certificates
Override Local Listener Certificates
Enables fields where you specify signing and encryption certificates to use with this particular partner instead of the certificates you configured for the Local Listener. See Configuring certificates for Local Listener.
If you override the default certificates, you must also exchange the certificates you specify here with your partner.
Signing Certificate Alias
The name of the signing certificate registered with the VersaLex application through the Certificate Manager. This certificate is used to sign selected components (as configured through the PMode.Security.X509.Sign settings) of outbound User Messages and Receipt Signals.
Click Browse to view and select a certificate. Enter the Password for your signing certificate's private key.
Encryption Certificate Alias
The name of the encryption certificate registered with the VersaLex application through the Certificate Manager. This certificate is used to decrypt inbound User Messages.
Click Browse to view and select a certificate. Enter the Password for your encryption certificate.
Use signing certificate
Select this check box to use the same certificate for signing and decrypting your trading partner's messages. The Encryption Certificate Alias and Password are populated to match the Signing Certificate Alias and disabled.
Exchange Certificates
Invokes the Certificate Exchange dialog box. If you override the default the certificates, you must exchange these alternate certificates with your trading partner.

AS4 Mailbox: HTTP Tab

The mailbox's HTTP tab allows you to configure a Content-Type setting that can be used to control several values within the packaging.

It is recommended that you set this type according to the native payload type, before any processing, for example, compression. If the payload type is unknown, a content-type setting of application/octet-stream is recommended as it generally represents all types of data. If this optional parameter is not specified, then a default is determined based on whether SOAP with Attachments (SwA) packaging (application/octet-stream) or <Body> payload (text/xml) is being used.

To control the setting of the CharacterSet property within the <eb:PartProperties>, you can append a charset parameter after the content-type value. For example, application/octet-stream;charset=UTF-16. In this case, CharacterSet will be set to UTF-16. If you do not add this optional parameter, CharacterSet defaults to UTF-8.

AS4 Mailbox: Security Tab

The HTTP and HTTP/s radio buttons are read-only. They reflect the settings from the host HTTP tab.

If HTTP is selected, no further action is necessary on this tab.

If HTTP/s is selected, the target server can issue client certificates. In this case, import the client certificate using Certificate Manager (See Certificate management) and then specify (or browse for) the imported Certificate Alias and Password.

AS4 Action configuration

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

AS4 Command Reference

PUT

Send one or more files to the bank server.

PUT -MUL -DEL "source"
-MUL
Multiple file payload (attachments).
-DEL
If PUT is successful, delete the local file.
"source"
Local source path
  • Path can be to a filename or to a directory.
  • * and ?, or a regular expression, are supported in filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, the command uses the default outbox.
  • 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 ("...").

Note: The PUT command wizard will display an optional mpc parameter. This parameter is reserved for future use and is not used at this time.

GET

The GET command causes an AS4 Pull Request to be issued to the trading partner. The Pull Request synchronously returns one User Message, which may contain one or more payloads. Generally, the oldest payload on the trading partner's queue is returned.

GET

The GET command has no options because it always requests just a single User Message. There is an optional mpc parameter, however, that can be used to target a specific message partition channel. This value must match the PMode.BusinessInfo.MPC setting of your trading partner. When the mpc parameter is not specified, then PMode.Security.PModeAuthorize must be used to authenticate the request.

After the GET completes successfully, the source file is deleted by the trading partner.

Received file options, under AS4 Host > AS4 Tab, can be used to configure any special destination parameters for all received files, both solicited (through a GET command) and unsolicited (through a User Message push from the trading partner). See AS4 Host: AS4 Tab. 

 

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

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.

SYSTEM

Execute a local system command.

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

WAIT

Pause execution.

WAIT seconds
Seconds
Number of seconds to pause.

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 VersaLexCleo HarmonyCleo VLTraderCleo LexiCom 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 VersaLexCleo HarmonyCleo VLTraderCleo LexiCom 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 VersaLexCleo HarmonyCleo VLTraderCleo LexiCom 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 VersaLexCleo HarmonyCleo VLTraderCleo LexiCom 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 expressions for additional information.
  • If you specify a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"
Destination path.
  • Path can be to a filename or to a directory.
  • If you specify a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
  • You can use a single * within the destination path. In this context, it is not a wildcard. Rather, it is used to substitute a source file name or a source subdirectory name. When * is used in conjunction with both the -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 expressions for additional information.
  • If you specify a relative path, the command uses the default inbox.
  • Use of macro variables is supported. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

LREPLACE

Replace bytes in one or more files locally.

LREPLACE "source" Replace="input bytes" With="output bytes"
"source"
Source path.
  • Path can be to a filename or to a directory.
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular 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.

CHECK

See CHECK command for information about this advanced command.

SCRIPT

See to SCRIPT command for information about this advanced command.

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

 

Related articles

Comments

0 comments

Please sign in to leave a comment.