ebXML host

The ebXML Message Service (ebMS) standard provides the ability to securely transport EDI (and other data, including binary and XML) to a 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.

This guarantees that the message has not been changed in transit and is received and can be read only by the intended trading partner. A returned acknowledgment further guarantees that the intended trading partner has received the message.

ebMS uses the HTTP protocol as its transport mechanism to send files over the Internet. VersaLex uses the PUT (HTTP POST) action command to transport the secure data to the remote host.

ebXML Configuration

Click the Templates tab in the tree pane.
If necessary, expand the Hosts tree in the Templates tab to find the host you want to use.
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.
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 ebXML Host.
3. Click Apply to save your work.
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 ebXML Mailbox.
3. Click Apply to save your work.
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 ebXML Action.
3. Click Apply to save your work.
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.

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 the Generic ebXML pre-configured host.

ebXML Host: General Tab

The fields on the General tab typically remain unchanged unless you need to connect through a forward proxy or change the Default Directories.

Setting	Description
Server Address	Either a fully qualified name (recommended) or an IP address. This is the address of your trading partner's server that will receive your messages.
Port	The port on the server where your trading partner will receive your messages. If no port number is included in your trading partner's URL, default values are assumed. 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 Specifying default host directories 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 the Cleo VLTrader and Cleo Harmony applications, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables. Note: If the host is has an external association, the default directories might be managed outside of the VersaLex application and not shown here.
Inbox	Default directory for incoming files. Enter a value directly or select … 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 select … 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 select … 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 select … to navigate to and select a directory. Possible values: Any local or shared directory. Default value: No default value.

ebXML Host: ebXML Tab

Setting

Description

Store raw sent

Save the content of the HTTP header and raw (unprocessed) message sent to the remote host. The files are stored in the ebXML\sent+received directory under the root path. These files can be useful in diagnosing problems, but should be disabled if disk space needs to be conserved. Select Resend to send a duplicate of a previously stored raw message to the trading partner.

Use default file name

Allows the incoming file to be given the name specified in its associated field. Use this option to override the file name specified by the sender. This feature is useful in situations where the received file name must be something other than its original file name, and is common for IBM i / iSeries (AS/400) platforms where the file name must be specified with a .mbr extension. This field can also include any of the supported macros allowing for the incoming file to be named, for example, with a date-time stamp. Subdirectory path identifiers (for example, ‘/’ or ‘\’) can also be used in conjunction with macros to allow filtering of the incoming file to a specific subdirectory under the inbox based on the value of the macro variable. See Using macro variables (Destination File context) for a discussion of all applicable macros.

Note: If a subdirectory path is specified and it does not already exist, it will automatically be created as needed unless the subdirectory path is under an inbox on the AS/400 Native File System. In that case, the physical file denoting the subdirectory path (in the form: DIRECTORY.FILE) must be created under the specified inbox before files can be written to it.

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. The VersaLex application does not check the actual content of the message to determine its content type.

ebXML Host: CPA Tab

Setting	Description
CPA Id	Identifies the Collaboration-Protocol Agreement (CPS) between you and your trading partner. VersaLex does not actually implement the CPP/CPA portion of the ebXML specification, but a unique CPA Id must still be agreed upon between trading partners. The CPA Id can be a concatenation of the From and To Party Ids, a URI prefixed with the Internet domain name of one of the parties, a namespace offered and managed by some other naming or registry service, or some other mutually agreed to naming convention.
To Party Id(s)	Your trading partner's identifiers. One or more party IDs can be listed (URI, email address, DUNS number, etc.). If the type attribute is not given in a party ID, the value must be a URI.
My Party Id(s)	Your identifiers. If you need to override the default values from the Local Listener (because this trading partner requires different settings), select Override Local Listener\ebMS CPA check box and supply alternate values.

ebXML Host: HTTP Tab

Setting	Description
Outbound	Indicates whether you use SSL for outbound file transfers.
HTTP	Do not require 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	In most cases, the CONNECT command is not used and should be left blank. In rare instances, CONNECT is required by the remote server to identify the client, particularly if SSL has not been used.
Method	The only valid Method for AS2 commands is PUT ("POST").
Path	The server Path for the PUT command. If the remote server is also using the VersaLex application, the path is `/ebMS`. The resource path must be properly specified in order for your trading partner’s ebMS installation 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 ebMS messages. If parameters are required, they must be obtained from your trading partner when the 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	These header fields are filled in at the Mailbox and/or Action level and specify the values set in the HTTP headers that precede the body of the message sent. At a minimum, the only Header required is the `SOAPAction: "ebXML"` header. Content-Type: is optional and can be specified at the mailbox and/or action level. Note: Entering a value for the Content-Type header is optional. If it is not specified, or if multiple payloads are attached, the content type is detected based first on file content and then the file extension. Detectable types include application/edifact, application/edi-x12, application/edi-tradacoms, application/xml (text/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. These header fields are filled in at the Mailbox and/or Action level and specify the values set in the HTTP headers that precede the body of the message sent.

ebXML Host: Advanced Tab

Use the Advanced tab to configure certain properties for your ebXML host.

The host's Advanced tab contains several property settings fields. These settings typically do not affect the ability to connect to a host. However, some of these settings might need to be changed 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 ebMS include:

Setting	Description
Connection Timeout	The amount of time allowed for each read operation. Possible values: `0` - `n` seconds `0` indicates no timeout Default value: `150` seconds
Conversation Id XML Payload Element	When set, indicates the element name or names in the XML payload whose value should be used as the ebMS `ConversationId` value. When multiple element values are to be concatenated and/or when additional, constant character values are needed, the element names must be enclosed in < and >. If a specified element appears more than once in the payload, the first element value is used. Possible values: Element namespace and local name (for example, `ed:ReferenceId`) or just local name (for example, `ReferenceId`). For multiple elements and/or additional characters, enclose each element name in < and > (for example, `<UID>_<ReferenceId>`).
Disregard Incoming Preserve Message Order Request	When set to false, indicates that a received ebMS message containing the Message Order option will be rejected as not supported. When set to true, the VersaLex system will accept an incoming request containing the Message Order option, but message order delivery inbound will not be strictly enforced. 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 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 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. 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).
Enclose Content Type Start With <>	Indicates whether the Content-Type start parameter value for an outgoing ebMS multipart/related message should contain enclosing angle brackets. The examples shown in the ebMS v2 specification are inconsistent, and some implementations might only accept one format or the other. VersaLex will accept either format for incoming messages. Possible values: `On` or `Off` Default value: `Off`
Encryption-Signing Order	When both encryption and compression are enabled, indicates which is applied first. Possible values: `Sign then encrypt` `Encrypt then sign` Default value: `Sign then encrypt`
Encryption Algorithm	The method used to encrypt/decrypt payload. Possible values: `AES/128` `AES/192` `AES/256` `SEED` `TripleDES` Default value: `TripleDES`
Encryption Encrypted Key Id	Include the specified value as the Id attribute of the <xenc:EncryptedKey> element in the encrypted data. Possible values: Any text
Encryption Include Certificate	Indicates to include the encryption certificate as an <ds:X509Certificate> element in the encrypted data. Possible values: `On` or `Off` Default value: `Off`
Encryption IV	Specifies the initialization vector (IV) to be used for encryption/decryption. If specified, the configured IV is NOT added to or expected at the beginning of <CipherValue>. The configured value must be prefixed with either a `c` or `x` to indicate whether the value following the prefix should be treated as a character or hexadecimal string, respectively.
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: If multiple files contribute to the conditions being met and a file macro (for example, %file%) is used, 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 repeated execution of the command. If suppression continues after 24 hours, the command is executed every 24 hours and after system restart if the failure persists. When the failure is resolved, the command is executed again. Include the %status% macro and evaluate success or failure (see Using macro variables). Note: Suppression applies only when the same failure occurs consecutively and is not maintained across synchronized hosts. Possible values: `On` or `Off` Default value: `On`
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 repeated execution of the command. If suppression continues after 24 hours, the command is executed every 24 hours and after system restart if the failure occurs again. If the failure can be associated with a specific host, the command is executed again when the failure is resolved. Include the %status% macro and evaluate success or failure (see Using macro variables). Executions for resolution of general Listener failures are not performed. Note: Suppression applies only when the same failure occurs consecutively and 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, setting High Priority will not increase the transfer rate and may slow other transfers. Also, do not set High Priority Incoming or Outgoing on a host where the same instance is both client and server. 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 Message Id Length	If set to a positive number, truncates the generated ebMS message ID if necessary. 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`
Outbound Message Time To Live (hours)	Indicates how long a message has to be delivered before it is considered expired. Possible values: `1` - `720` Default value: `24`
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, file extensions are not used unless needed to make filenames unique. Possible values: `System Default` `Alphabetical` `Date/Time Modified` Default value: `System Default`
Outgoing Insert EOL Between Interchanges	If `Fixed Record Outgoing Insert EOL` is active, indicates to also insert EOL characters between EDI interchanges while sending the file. Possible values: `On` or `Off` Default value: `Off`
Partner Email Address	The email address of the trading partner for this trading relationship. When set, this address is automatically used to send your local profile information and/or certificates to your trading partner. See Emailing a profile to your trading partner. Possible values: Email address(es) separated by commas (,), semicolons (;) or colons (:). Note: This is a Cleo LexiCom only option. For Cleo Harmony and Cleo VLTrader, this information is stored in the trading partner management table. See Managing Trading Partners.
PGP Compression Algorithm	Compression method used when OpenPGP packaging (with compression) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If `System Default` is specified, the value set on the Configure > Options > Advanced tab is used. 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 implementations. Possible values: `On` or `Off` Default value: `On`
PGP Signature Verification	Indicates whether signed inbound PGP messages should be 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
Profile Support	Indicates that an industry-specific business profile applies to this trading partner. Possible values: `CDC PHIN` - Centers for Disease Control and Prevention Public Health Information Network `STAR` - Standards for Technology in Automotive Retail XML BODs `HL7` - Health Level Seven `TCD Super Gateway` Default value: None
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`
Ref To Message Id XML Payload Element	When set indicates the element name or names in the XML payload whose value should be used as the ebMS RefToMessageId value. When multiple element values are to be concatenated and/or when additional, constant character values are needed, the element names must be enclosed in angle brackets (< and >). If a specified element appears more than once in the payload, the first element value is used. Element namespace and local name (for example, `ed:ReferenceId`) or just local name (for example, `ReferenceId`). For multiple elements and/or additional characters, enclose each element name in angle brackets (< and >) (for example, `<UID>_<ReferenceId>`).
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`
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`
Signing Hash Algorithm	Specifies the signature hash algorithm used when signing an outgoing ebMS message. If not specified, the private key's signature hash algorithm is used by default. This setting affects both the signature and digest method algorithms. Only applies to RSA private keys. Possible values: `SHA-1` `SHA-256` `SHA-384` `SHA-512`
Sign XML Payload If Signing	Indicates to sign XML payload in addition to signing the ebMS SOAP envelope. Possible values: `On` or `Off` Default value: `Off`
Sign XML Payload Omit XML Declaration	Indicates when signing to omit the XML declaration at the top of the XML payload. Possible values: `On` or `Off` Default value: `Off`
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. 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 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`
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, the same actions are processed and execution 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 available only in Cleo Harmony and Cleo VLTrader. 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 which case the absolute path is used instead. 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. 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 descendants) will be bundled into an individual zip file. The name of this zip file can optionally reflect the subdirectory name if an asterisk (``) is placed in the destination path. Files directly under the source root directory are not copied. Possible values: `On` or `Off` Default value*: `On`

ebXML Mailbox

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

ebXML Mailbox: ebXML Tab

Select options for encryption and signing outbound messages and security for inbound messages. Select the acknowledgment format if necessary.

Option	Description
Encrypted	Enable or disable TripleDES encryption when sending messages. See /hc/en-us/articles/360034266213Cryptographic Services for general information about encryption.
Signed	Enable or disable signing messages when sending them.
Ack	Enables the Acknowledgment section and includes a request for an acknowledgment (receipt) from your trading partner.
Compressed	Compress the message using GZIP compression. Compression is generally used for large files to conserver bandwidth and make the transfer more efficient and secure.
Synchronous Reply	Require requested acknowledgments and any ebXML errors be returned synchronously, using the same HTTP session as the HTTP response. If Synchronous Reply is cleared, requested acknowledgments and any ebXML errors will be returned asynchronously by your trading partner, as part of a new HTTP session in an HTTP request.
Eliminate Duplicates	Your trading partner checks for duplicate message IDs. If a duplicate is discovered, the message payload is ignored.
Preserve Message Order	Your trading partner ensures that messages are processed in proper sequence. VersaLex does not currently support preserving message order on incoming messages.
Acknowledgment
Signed	Request a signed acknowledgment.
Forward Ack to Email	An additional VersaLex feature is the ability to forward a copy of the acknowledgment received either synchronously or asynchronously to an email recipient when Forward Ack to Email is selected.
Inbound Message Security	When you select any of the options in this section,
Force Encryption Force Signature	When you select Force Encryption or Force Signature, all inbound messages are checked for the required security level. An error is logged and the message is rejected if the message is not received according to the corresponding message security settings. If either setting is not selected (default), the message is not checked for conformance with that security setting.
Honor Reply Requests	Accept requests for replies for messages that match the setting you choose from the following: Any - accept any message. Asychronous - accept only messages with asynchronous reply requests. Synchronous - accept only messages with synchronous reply requests.
Description	Optional. Provide a human readable description of the outgoing messages.
Ping	Click to check if the trading partner's message service is currently accepting messages.
Message Status	Click to check the status of a previously sent message.

ebXML Mailbox: CPA Tab

Whether you specify to and from roles explicitly or leave the fields blank, an ebXML mailbox corresponds to one and only one collaboration role within the CPA. Multiple mailboxes under one ebXML host must have different from roles and/or different services.

Option	Description
To Role	Optional. Identifies your trading partner's authorized role (for example, buyer, seller, or dealer) usually via a URI.
To Service To Action	These values must match your trading partner's settings. Required if you are sending messages to your trading partner using this mailbox.
From	This section contains fields you can use to override values you set at the Local Listener level.
Override Local Listener\ebMS CPA	Enables several fields in which you can provide values to override ebMS/CPA parameters set at the Local Listener level.
My Role	Identifies your authorized role (for example, buyer, seller, or dealer) usually using a URI. If necessary, your normal role can be overridden in the ebXML host and mailbox respectively for a specific trading partner.
My Service(s)	Messages received from your trading partner must match these values. If you list more than one service, each one must be on its own line. If necessary, your normal services can be overridden in the ebXML mailbox for a specific trading partner.
My Action(s)	Messages received from your trading partner must match these values. If you list more than one action, each one must be on its own line. If necessary, your normal actions can be overridden in the ebXML mailbox for a specific trading partner.

ebXML Mailbox: Certificates Tab

Associate a trading partner's signing and encryption certificates with this ebXML 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.

Trading Partner's Certificates

Option

Description

Signing Certificate

The name of the file containing your Trading Partner's signing certificate. Specify a value or click Browse to navigate to the file you want to select.

If you do not specify a signing certificate, the VersaLex application uses all the certificates in its certificate store to determine if the signature of the incoming data message is trusted.

Encryption Certificate

The name of the file containing your Trading Partner's encryption certificate. Specify a value or click Browse to navigate to the file you want to select.

Use encryption certificate

Indicates that your trading partner uses the same certificate for signing and encryption, which is the general practice among most 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

Option	Description
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.
Exchange Certificates	Displays the Certificate Exchange dialog box, which allows you to send your user and SSL certificates to your trading partner. See Exchanging certificates with your trading partner.
Signing Certificate Alias	The name of the signing certificate registered with the VersaLex application through the Certificate Manager. The certificate must be the same as the one exchanged with your remote trading partners, unless you want to override it at the Mailbox level. See Local HTTP Users Configuration. Click Browse to navigate to and select a certificate. Enter the Password for your signing certificate's private key.
Encryption Certificate Alias	The certificate for decrypting your trading partner’s messages, if you have created or obtained a separate certificate. Click Browse to navigate to 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.

ebXML Mailbox: HTTP Tab

The mailbox's HTTP tab allows you to assign a Content-Type for the documents to be transferred.

You can include optional parameters in valid Content-Type values by adding a semi-colon (;) after the value followed by the name=valuepair(s). Multiple parameters must be separated by semicolons. For example, to include a ‘charset’ parameter for the ‘XML’ Content-Typevalue, edit the XML field like this:

XML; charset=utf-8

During the packaging phase of the message, the XML value is converted to ‘application/xml’ and any optional parameters are appended. Parameters are only appended to the Content-Type of the payload parts.

If a Content-Type is not specified, VersaLex will attempt to detect the content type.

ebXML Mailbox: Security Tab

If HTTP/s is specified in the host's HTTP tab, a remote host can issue client certificates. In this case, import the client certificate and then specify or browse for the imported certificate's alias and password. See Certificate management.

ebXML Mailbox: Packaging Tab

See Configuring mailbox packaging for information regarding packaging of payload files.

ebXML Trading Partner

A trading partner's parameters define a unique identifier on the host system. By default, the Trading Partner branch is not created since it is not necessary for ebXML transactions.

ebXML Action

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

ebXML Action: Action Tab

Use the Action tab to configure commands within the action. See Composing an action. See also HTTP Command Reference.

Testing Your ebXML Installation

You can test your ebXML installation by configuring a host that will send messages to your Local Listener, therefore looping the messages back to yourself. Before attempting a trading relationship, you should test and validate that you can send and receive messages at your local installation. This will help narrow down connectivity issues that are due to firewall problems and not due to improper installation and configuration.

Configure the ebXML Message Service in the Local Listener. See Local Listener ebXML Message Service.
Clone and activate the Generic ebXML preconfigured host and rename it to Looptest ebXML.
Configure the ebXML Looptest host:
1. In the host General tab, set the Server Address to "localhost" and the Port # to the Local Listener's HTTP port (usually 5080).
2. In the host CPA tab, set the CPA Id to "looptest" and set the To Party Id(s) to match the Local Listener\ebMS CPA My Party Id(s).
3. In the mailbox CPA tab, set the To Role to match the Local Listener\ebMS CPA My Role. Also set the To Service and To Action to match one of the Local Listener\ebMS CPA My Service(s) and My Action(s).
4. In the action Action tab, change the PUT command's source file to be "test\test.edi" and remove the -DEL option.
In the action Action tab, run the action. Messages similar to the ones shown below will appear in the messages pane in the lower portion of your VersaLex application.
If signing and encryption is desired:
1. First export the Local Listener Signing and Encryption Certificate(s) into the VersaLex certs\ directory.
2. Then in the mailbox Certificates tab, set the Trading Partner's Certificates to these certificates.
3. In the mailbox ebXML tab, select Signed and Encrypted.
4. In the action Action tab, rerun the action. Messages similar to the ones shown below should now appear.
Set other ebXML options as desired.

ebXML-Specific Directories

The following additional directories will be created either during the ebXML installation or as needed by the application:

ebXML host

ebXML Configuration