Cleo FAQs
Cleo's Frequently Asked Questions page is a central hub where its customers can always go to with their most common questions. These are the 740 most popular questions Cleo receives.
Frequently Asked Questions About Cleo
This specialty course is designed for those that have successfully completed the prerequisite DT103 Data Transformation: Fundamentals course.
In this hands-on course that focuses on flows and EDI document types common to the Logistics sector (204, 214, 997), participants create new objects; edit existing objects; work with EDI, flat file, database, and XML data formats; and troubleshoot issues.
They see a demonstration of how Cleos Data Analytics tool is used toanalyze activity and investigate histories of transaction activity.
(4 days, 5 hours each day, maximum 5 students)
Price Per Student
$3,600
Available Dates/Times
January 27-30 (12 pm - 5 pm ET)
View ArticleGain an understanding of Cleos data integration platform and prepare to configure your own environment for day-to-day operations.
This course provides an overview, host configurations, local listeners and users, actions, internal integrations, and more.The curriculum is designed for users of Cleo LexiCom, Cleo VLTrader, and Cleo Harmony.
(2 days, 4 hours each day, maximum 5 students)
Price Per Student
$1,500
Available Dates/Times
January 6-7 (10 am - 2 pm ET)Course Full
January 28-29 (10 am - 2 pm ET)
February 10-11 (10 am - 2 pm ET)
March 2-3 (10 am - 2 pm ET)
View ArticleCleo Integration Cloud, Private Cloud Edition
License Request
Cleo Dashboards provide robust static and interactive reporting and data analysis capabilities. These capabilities can form part of an integrated end-to-end business integration suite with other applications, using common metadata and providing security services and automatic report scheduling.
Release Notes
Install Guide
User Guide
View ArticleCreating an EDI Schema instructs Clarify which segments and elements appear in your data.
SelectFile|New|EDI Schemafrom the main menu. TheNew EDI Schemawindow appears.
If you select the package in which the EDI Schema should reside before creating it, some parameters are automatically populated in theNew EDI Schemawindow.
Provide theSourcefolder,Package, andName.ClickNext.
UnderEDI Version / Message Selection, in theStandard Typearea, click the EDI standard you want to use.
If the version you want to use is not available, see Updating EDI Standards in the Studio.
Each standard has many associated messages. It may take a few seconds for the next field,MessageID, to load.
TheMessage IDarea displays all messages (such as 850 Purchase Order) available for that standard. Click the message for which you want to create a Schema.
ClickFinish.The EDI Schema's editor appears.
Next:Make any changes to your EDI Schema in its editor. If you need help customizing it, see Customizing EDI Schemas.
View ArticleCleo Integration Cloud: Private Cloud Edition
While most courses focus on particular aspects of the Cleo solution and are generally scheduled for just a few (2 or 4) hours on one day, several are multi-day, 5-hour-per-day offerings.For your convenience, all classes have been optimized for remote delivery, where you learn in your home/office via Webex and other internet-enabled applications.
Click a course title below to learn more and to register for an upcoming session.
ST103 Cleo Streem System Admin
Data Transformation Powered by Cleo Clarify
Learn to integrate with EDI, flat file, XML, database, Application Connectors, and more.
Data Movement Powered by Cleo Harmony, Cleo VLTrader and Cleo LexiCom
Learn to maximize the functionality of your data movement solutions.
Ancillary Including Cleo Streem
Learn to gain business insights from transaction activity, and all about the Cleo Streem products.
Core Courses
DT101 Data Transformation: EDI Basics
DT103 Data Transformation: Fundamentals
Specialty Courses
DT201 Data Transformation: Order to Cash
DT203 Data Transformation: Logistics & Transportation
DT221 Data Transformation: AS400/iSeries Developer
AN240 Analytics: Business Insights
Master Courses
DT301 Data Transformation: Administrator
DT303 Data Transformation: Project Lifecycle Management
DT323 Data Transformation: AS400/iSeries Administrator
Seasonal Courses
DT501 Data Transformation: What's New in Cleo Clarify 5
Core Courses
DM102 Data Movement: Fundamentals
DM104 Data Movement: Getting Started
Specialty Courses
DM202 Data Movement: Host Configurations
DM204 Data Movement: Actions
AN240 Analytics: Business Insights
Master Courses
DM302 Data Movement: Administrator
Core Courses
ST101 Cleo Streem Print
ST102 Cleo Streem Notify
View ArticleYou can control which of your users have access to your partners' data.
Go toNetwork>Partnersand click theUser Accesslink at the top right to display thePartners - User Accesspage.
TheUser Accesspage displays a list of partners that includes each partners name, ID, and the users who have access to the partner.
You can update a partners name and the list of users who have access to a partner. When you select a single partner, both theUpdate Trading Partner NameandUpdate Trading Partner Permissionsbuttons are enabled. When you select more than one partner, only the theUpdate Trading Partner Permissionsbutton is enabled.
Update a partner name.
Select a single partner.
Click theUpdate Trading Partner Namebutton to display theRenamedialog box.
Enter a new value in thePartner Namefield and clickRename.
Update the list of users with permissions.
Select one or more partners.
Click theUpdate Trading Partner Permissionsbutton to display theEdit Accessdialog box.
Select or clear a check box to toggle access to this partner for that user.
For a given user, theActivitypage and theMessagespage will display data from only the partners to which they have access.
View ArticleYou can apply filtering criteria on the Tile view and List view on theActivity>Messagespage. Managing saved filters
You can toggle filters on the messages displayed as follows:
Saved Filters- Displays a list of filters previously saved that you can apply. Select a saved filter to apply it. See.
Clear All - Removes all filters and displays messages from the last 30 days.
By message direction ClickInboundorOutbound.
By partner In thePartnersfield, enter a partners name or ID and pressEnter. You must enter the entire name or ID. You can enter a comma-separated list of partner names or IDs to search on multiple partners.
Alternatively, if you have access to more than one partner, theBrowse Partnerslink is displayed.
Click this link to display a dialog box in which you can select partners to search.
By issue
In theIssuesfield, enter an issue number and pressEnterto display only those messages pertaining to that issue. You can enter a comma-separated list of issue numbers to search on multiple issues.
ClickCurrentorResolvedto display only messages in the selected state.
There are several categories ofCurrentissues:
New- Issue is awaiting assignment to service representatvive.
Open- Issue has been assigned to a representative or action is pending from Cleo.
Pending- Action is Pending from a customer or an entity from outside of Cleo.
On-hold- Waiting for Partner.
There are two categories ofResolvedissues:
Solved- Issue is solved, but not closed. Issues are closed after 3 days of being marked asSolved.
Closed- Issue is closed.
By acknowledgement Click one or more of the FA types:
Rejected
Accepted
Pending
Late- You can refine this filter by choosing one of the following types ofLateFAs.
Received and Late- message was received but was late.
Not yet received & Late- message has not yet been received, but is already late.
By message In theMessagesfield, enter a message ID to display the matching message. You can enter just a portion of the message ID or you can use a%to search for values at the end of the ID. For example, enter%123to search for message IDs ending in123. You can enter a comma-separated list of message IDs to search for multiple messages. Searching my message ID iscase-insensitive.
By message type Select one or more message types to display just those message types. Deselect a message type to hide those messages. All messages are displayed when no message types are highlighted.
By date Select a date range to display messages that were sent in that range during that time.
Managing saved filters
You can save the current filter criteria. Click the Saved Filter link and select Save Current Filter. Enter a name for the filter and click Save.
You can delete an existing filter. Click the Saved Filter link and select Manager Filters. Select one or more filters you want to delete and click Delete.
View ArticleYou can create a link to the Tile or List view (see Viewing message information - Tile and List view ), or Business Process view (see Viewing message information - Business Process view ) of the Messages page to share with those you want to have access to the page. From the Tile, List, or Business Process view, click the link iconto create link and copy it to the clipboard.
Recipients can paste the link in the address bar in a browser to navigate to the page, but they must have permission to the linked page in order to access the page via the link. Without permissions, the recipient cannot see the page.
If you share the link with a recipient who is already logged in to Cleo Integration Cloud, access to the page is immediate.
If the recipient of the link is not logged in, the login page is displayed. After logging in, the recipient is taken directly to the page.
View ArticleBy default, theMessagespage displays as a series of tiles (Tileview) or as a list of messages (Listview). InTileview andListview, the main part of the page contains message information from your system and the left column contains some controls for filtering the messages displayed. See Filtering messages.
In eitherTileorListview, you can click any message to display theBusiness Processview for that message. See Business Process view.
Note:Data displayed in theTileandListviews is formatted per your locale.
Tile view
In theTileview, information about one message is displayed in each tile. This view is displayed by default when you selectActivity>Messagesor when you click theTile viewicon.
Reprocessing messages
Each tile provides details about a single message.
Note:Not all fields are displayed for all message types.
See Message status, Reprocessing status, and Functional acknowledgement status below for further information.
List view
InListview, information about one message is displayed in each line. This when you click theList viewicon.
Each line in the list provides details about a single message.
See Message status, Reprocessing status, and Functional acknowledgement status below for further information.
Message status
The message status indicates if there is an issue associated with a message and whether the issue is current or resolved.
Icon
Description
Indicates a Current issue.
Indicates a Resolved issue.
Reprocessing status
TheReprocessing statusindicates how many times the message has been reprocessed, if at all. See.
Functional acknowledgement status
A functional acknowledgement (FA) serves as a virtual receipt between trading partners that a transaction has occurred. FAs add transparency to the business process by indicating the state of the acknowledgement.
Cleo Integration Cloud provides four possible acknowledgement indicators.
Icon
Descrption
Successful acknowledgment. Click this icon to display acknowledgement data in a separate dialog box.
Error with acknowledgment. Click this icon to display acknowledgement data in a separate dialog box.
Acknowledgment not received.
Acknowledgment not expected.
Acknowledgment was received, but late.
Acknowledgment has not yet been received and is late.
View ArticleUse the SSH FTP host to specify a client file transfer interface to an SSH FTP server.
Not all SSH FTP servers will support or require the full set of host commands allowed by VersaLex. At a minimum, the server must support PUT and/or GET. The following action commands are available on VersaLex:
Table 1.Host commands
Command
Purpose
Underlying SSH FTP method
PUT
Send one or more files to the host
GET
GET
Receive one or more files from the host
PUT
DIR
Get a directory listing of available files from the host
LIST
CD
Changes the current directory on the host
CD
QUOTEcommand
Sends a raw command to the server
command
Supported commands include:
CHGRP
CHMOD
CHOWN
MKDIR
MKDIRS
PWD
RENAME
RM
RMDIR
STAT
SYMLINK
Table 2.Local commands
Command
Purpose
Underlying SSH FTP method
SYSTEM
Execute a local system command
-
WAIT
Pause
-
SET
Sets a property
CLEAR
Clears a string property
LCOPY
Copy one or more local files
-
LDELETE
Delete one or more local files
-
LREPLACE
Replace bytes in one or more local files
-
CHECK
Check for a transfer, file, or directory (VLTrader and Harmony only)
-
SCRIPT
Execute a JavaScript File (VLTrader and Harmony only)
-
SSH FTP Configuration
Click theTemplatestab in the tree pane.
If necessary, expand theHoststree in theTemplatestab to find the host you want to use.
Right-click thehostand selectClone and Activate.
The entire pre-configuredhostbranch (including a mailbox and actions) is copied and activated, theActivetab is selected in the tree pane, and the new activehostis 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.
Click the new host in the tree pane.
Enter host-level configuration information on the tabs in the content pane. See SSH FTP Host.
ClickApplyto save your work.
Enter mailbox-level configuration information.
Click the mailbox under your host in the tree pane.
Enter mailbox-level configuration information on the tabs in the content pane. See SSH FTP Mailbox.
ClickApplyto save your work.
Enter action-level configuration information.
Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and selectNew Action.
Edit action information on the tabs in the content pane. See SSH FTP Action.
ClickApplyto save your work.
ClickApplyto save your work.
Important:If you leave any of these panels without clickingApply, your work will not be saved. You can configure the product to prompt to you clickApplyif 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 clickApplyand your updates will not be saved.
SSH FTP Host
A host's parameters specify its location and how it is reached.
SSH FTP Host: General Tab
Server Address
Either a fully qualified name (recommended) or an IP address.
This is the address of your trading partner's server that will receive your messages.
Port
The port on the server where your trading partner will receive your messages. If no port number is included in your trading partner's URL, default values are assumed.
Possible values: Either a specific port number or-1to indicate the default port for SSH FTP (22)
Default value:22
Connection Type
The kind of connection you want to use for this host.
Possible values:
System Default- See for information about setting the system default.
Direct Internet Access or VPN- Use either a direct connection to the internet or a VPN.
Default value:System Default
Forward Proxy
The address of the forward proxy you want to use for this host.
Select theSystem Defaultcheck 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 theCleo VLTraderandCleo Harmonyapplications, 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 theVersaLexapplication and not shown here.
Inbox
Default directory for incoming files. Enter a value directly or clickto 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 clickto 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 clickto 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 clickto navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
SSH FTP Host: SSH FTP Tab
Host Key Verification
Host Key Verification compares the SSH FTP host key sent from the SSH FTP server to the value in theHost Keyfield. If the value in theHost Keyfield does not match the value returned from the SSH FTP server, the connection is terminated.
Verify Host Key
Select this check box to enable theHost Keyfield and theSet Keybutton, and allow host key verification.
Clear theVerify Host Keycheck box to disable fields and verification.
Host Key
The SSH FTP server certificate fingerprint retrieved from the SSH FTP server.
ClickSet Keyto connect to the SSH FTP server to retrieve the host key. If the host key is retrieved successfully, theHost Keyfield is updated with the server certificate fingerprint.
SSH FTP Host: Advanced Tab
Use theAdvancedtab to configure certain properties for the SSH FTP host.
See Setting advanced host properties for information about how to use and set the properties supported in all protocols.
Add Mailbox Alias Directory to Inbox
Appends a subdirectory at the end of the host's configured inbox directory. This allows files received through different mailboxes to be kept separate.
Possible values:OnorOff
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:OnorOff
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:OnorOff
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:OnorOff
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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
Default value:On
Block Size
The block size to be used for file transfers. Some SSH FTP servers cannot transfer files with the default Block Size. If the server is able to transfer files smaller than the default Block Size, try using a smaller Block Size of 32767.
Possible values: Any value greater than zero.
Default value:65535
Buffer Requests
Indicates that commands can be buffered to minimize the command/response delays during file transfers when the round trip time is significant.
Possible values:OnorOff
Default value:On
Command Retries
If an error or exception occurs during a command, the number of times the command should be retried.
Note:Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
Possible values:0-n
Default value:0
Connection Timeout
The amount of time allowed for each read operation.
Possible values:0-nseconds
0indicates no timeout
Default value:150seconds
Create File Times
When creating files, sets the file creation and modified times to the current time. Used for compatibility with certain servers that cannot create files without the times specified.
Possible values:OnorOff
Default value:Off
Delete Zero Length Files
Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
Possible values:OnorOff
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-DELoption is being used, any zero length file ignored will also be deleted.
Possible values:OnorOff
Default value:Off
Email On Check Conditions Met
Send an email notification after running aCHECKcommand where the overall conditions of the check are met. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Check Conditions Not Met
Send an email notification after running aCHECKcommand where the overall conditions of the check arenotmet.See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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:OnorOff
Default value:On
Email On Successful Copy
Send an email notification after copying a file usingLCOPY. 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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (if set).
Execute On Check Conditions Met
After executing aCHECKcommand where the overall conditions are met, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Check Conditions Not Met
After executing aCHECKcommand where the overall conditions arenotmet, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Possible values: System command to be executed.
Default value: The valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Repetitive Action Failures
WhenExecute On Failis enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, theExecute On Failcommand will be executed again. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Successful Copy
After successfully copying a file usingLCOPY, 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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values:0toncharacters.
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:OnorOff
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:OnorOff
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:OnorOff
Default value:Off
Get Number of Files Limit
Limits the number of files retrieved from a server directory listing by oneGETcommand.
Possible values:0-n
0indicates no limit.
Default value:0
High Priority
Indicates whether incoming and/or outgoing transfers through the host should be treated as high priority. When both high priority and regular priority transfers are active, the high priority transfers get a larger portion of the available bandwidth.Go toConfigure > Options > Otherto set theHigh Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Warning:If the trading partners bandwidth (and notCleo Harmony's orCleo VLTraders) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down otherCleo HarmonyorCleo VLTradertransfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance ofCleo HarmonyorCleo VLTraderis 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:OnorOff
Default value: The value specified for this property on theOptions > Advancedpanel
Ignore Directory Listing Attributes
Enable this property to allow directory listings on non-directory paths.
Possible values:OnorOff
Default value:Off
Interim Retrieve
Indicates to set result of any successfully retrieved file toInterim Successrather thanSuccess. This would normally be used when transfer logging is being monitored by a backend system to allow coordination of any post processing of the received file that needs to occur prior to setting the transfer status toSuccess.
Possible values:OnorOff
Default value:Off
Key Exchange Data Limit (mbytes)
Maximum number of bytes allowed over a connection between key exchanges before a re-exchange is initiated. Set this value to zero to disable this limit from initiating a key exchange.
Possible values:0-n
Default value: 1024
Key Exchange Time Limit (minutes)
Maximum number of minutes allowed over a connection between key exchanges before a re-exchange is initiated. Set this value to zero to disable this limit from initiating a key exchange.
Possible values:0-n
Default value: 60
LCOPY Archive
If specified, contains the directory for archivingLCOPYsource 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 theOptions > Advancedpanel, 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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
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 theOptions > Advancedpanel, 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 theOptions > Advancedpanel, 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 of0does 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 of0does not limit the transfer rate. The system setting might also limit the transfer rates. The system Maximum Outgoing Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers will also affect individual transfer rates. See Advanced system options for more information about Maximum Outgoing Transfer Rate.
Possible values:0-n
Default value:0
Next File On Fail
When a download fails, indicates whether a wildcardedGETshould proceed to the next available file rather than terminate if the server is still connected.
Possible values:OnorOff
Default value:Off
Only Retrieve First Available File
Indicates aGET *should only retrieve the first available file from the server.
Possible values:OnorOff
Default value:Off
Only Retrieve Last Available File
Indicates aGET *should only retrieve the last available file from the server.
Possible values:OnorOff
Default value:Off
Outbox Sort
Controls the order in which multiple files are transferred for aPUTcommand. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab takes precedence. ForAlphabeticalordering, 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
IfFixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values:OnorOff
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 aCleo LexiComonly option. ForCleo HarmonyandCleo 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 theMailbox Packagingtab. See Configuring mailbox packaging.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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:OnorOff
Default value:On
PGP Signature Verification
Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. In general, this property should be enabled.
Possible values:OnorOff
Default value:On
PGP V3 Signature
Post Get Command
Post Put Command
In an action, specify commands to be executed only after a successfulGETorPUTas post-get or post-put commands, respectively. When using this property, use aSETcommand within theactionbefore theGETorPUTcommandrather than theAdvancedtab.
The Post Put Command can be set toQUIT, which allows a disconnect and reconnect between file uploads when necessary.
If multiple FTP commands are needed after theGETorPUT, set this property toallof the commands separated by semicolons (;). If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes ("). Use of macro variables is supported. Refer to Using macro variables (Post/Pre Command context) for a list of the applicable macros.
Preferred Cipher Algorithm
Used to control the transport cipher algorithm preference. The preferred algorithm is used if the server also supports it.
Possible values:
3des-cbc
aes128-cbc
aes128-ctr
aes192-cbc
aes192-ctr
aes256-cbc
aes256-ctr
arcfour128
arcfour256
blowfish-cbc
cast128-cbc
twofish128-cbc
twofish192-cbc
twofish256-cbc
If no preference is specified, the cipher algorithms are presented to the server in this order:
blowfish-cbc,3des-cbc,aes128-cbc,aes128-ctr,aes192-cbc,aes192-ctr,aes256-cbc,aes256-ctr,arcfour128,arcfour256,cast128-cbc,twofish128-cbc,twofish192-cbc,twofish256-cbc
Preferred Compression Algorithm
Used to control the transport compression algorithm preference. The preferred algorithm is used if the server also supports it.
Possible values:
none
zlib
If no preference is specified, the compression algorithms are presented to the server in this order:none,zlib,[email protected]
Preferred Key Exchange Algorithm
Used to control the transport key exchange algorithm preference. The preferred algorithm is used if the server also supports it.
Possible values:
diffie-hellman-group-exchange-sha256
diffie-hellman-group1-sha1
diffie-hellman-group14-sha1
If no preference is specified, the key exchange algorithms are presented to the server in this order:
diffie-hellman-group-exchange-sha256,diffie-hellman-group1-sha1,diffie-hellman-group14-sha1,[email protected]
Preferred MAC Algorithm
Used to control the transport MAC algorithm preference. The preferred algorithm is used if the server also supports it.
Possible values:
hmac-md5
hmac-md5-96
hmac-sha1
hmac-sha1-96
hmac-sha2-256
If no preference is specified, the MAC algorithms are presented to the server in this order:
hmac-sha2-256,hmac-sha1,hmac-sha1-96,hmac-md5,hmac-md5-96
Preferred Public Key Algorithm
Used to control the transport public key algorithm preference. The preferred algorithm is used if the server also supports it.
Possible values:ssh-dssorssh-rsa
Default value: None
If no preference is specified, the public key algorithms are presented to the server in this order:ssh-rsa,ssh-dss
Pre Get Command
Pre Put Command
In an action, specify commands to be executed before aGETorPUTas pre-get or pre-put commands, respectively. This has the benefit of keeping the log results relative to justGETs andPUTs (especially important forCleo VLTraderandCleo HarmonyGETtransfer logging). In addition, for thePUT, it avoids connecting and logging into the server when there are no files to send. When using this property, use aSETcommand within the actionbefore theGETorPUTcommandrather than theAdvancedtab.
If multiple FTP commands are needed prior to the GET or PUT, set this property toallof the commands separated by semicolons (;). If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes ("). Use of macro variables is supported. See Using macro variables (Post/Pre Command context) for a list of the applicable macros.
Pre Put Command For First File Only
If a Pre Put Command is specified, indicates whether to execute them before each file being transferred by thePUTor only before the first file transfer.
Possible values:OnorOff
Default value:On
REST Enabled
Allows the host to be accessible through the REST API. This feature is only supported onAS2,AS4,FTPandSSH FTPandonly 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:OnorOff
Default value:OnforAS2.AS4,FTPandSSH FTPwhen the host has exactly one mailbox.Offin all other cases.
Resume Failed Transfers
When selected and a transfer fails (and Command Retries > 0), attempt to resume the transfer on a retry. If OpenPGP is enabled on the packaging tab (see Configuring mailbox packaging ), the entire file is transferred instead of resuming with a partial file. The server must support theFEAT,SIZE, andREST STREAMextensions to FTP. For more information, visit http://tools.ietf.org/html/rfc3659.
Possible values:OnorOff
Default value:Off
Retrieve Directory Sort
Used to control the order in which files are downloaded from the FTP server. Using this property does cause the LIST command rather than the NLST command to be used when VersaLex is determining the available file list which might be a problem if the server responds with different lists (e.g. NLST only lists files not previously downloaded while LIST lists all files regardless). Windows and Unix/Linux FTP servers are supported.
Possible values:
Alphabetical (ascending)
Alphabetical (descending)
Date/Time Modified (ascending)
Date/Time Modified (descending)
Size (ascending)
Size (descending)
Retrieve Last Failed File First
If a file download previously failed and you are attempting toGETa list of files again, this property indicates whether the previously failed file should be attempted first.
Retry Delay
The amount of time (in seconds) before a retry should be attempted.
Possible values: Any value greater than zero.
Default value:60 seconds
Server Side Path Name
Optional. Default starting directory for a session. If you do not specify a value, session starts at/.
Terminate On Fail
If an error occurs during a command, stop the action.
Note:
Regarding non-CHECKcommands: WhenTerminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.
RegardingCHECKcommands:Terminate On Failis only honored if theConditionsMetparameter is set and the result of theCHECKis classified asError. TheCHECKcommand is only available in theCleo HarmonyandCleo VLTraderapplications.
Possible values:OnorOff
Default value:On
Unzip Use Path
Indicates whether or not zip entry paths should be used forLCOPY -UNZIPoperations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
Possible values:OnorOff
Default value:On
Wait For Execute On
Indicates whether execution should wait for processing to complete within anExecute On Fail,Execute On Successful Copy,Execute On Successful Receive, orExecute On Successful Sendcommand. Note that this option does not apply to native AS400 execution.
Possible values:OnorOff
Default value:On
Window Size (bytes)
Maximum number of received bytes allowed before a window adjustment is required. When receiving (using aGETcommand), a typical Window Size setting would be equal to the largest expected file size or the default setting, whichever is greater. This setting will not normally affect sends, since the receiver (the server) requires the majority of adjustments.
Possible values:0-n
Default value:131072
XML Encryption Algorithm
The method used to encrypt/decrypt files when XML Encryption packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 inLCOPY -ZIPoperations.
Default value: The value specified for this property on theOptions > Advancedpanel, if set.
Zip Compression Level
Controls the level of compression forLCOPY -ZIPoperations.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtakes precedence
Possible values:
System Default
9- (Best Compression)
8
7
6
5
4
3
2
1
0- (No Compression)
Default value: SystemDefault
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled forLCOPY ZIP RECoperations. 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:OnorOff
Default value:On
SSH FTP Mailbox
A mailbox's parameters allow you access to the host system.
Note:This feature is being deprecated. For similar functionality, use a Users host. See Users Host for more information.
SSH FTP Mailbox: SSH FTP Tab
Note:By default, SSH FTP hosts have the REST Enabled advanced property set to On, which prevents the host from having more than one mailbox. If you want more than one mailbox for this host, set the REST Enabled advanced property to Off. See REST Enabled advanced property.
You configure theSSH FTPmailbox using a Password and/or one of two Public Key Authentication (PKA) methods. Your Trading Partner should specify the required type(s) of authentication necessary to access your account.
To use PKA, you must create your authentication certificate (see Creating and providing your signing/encryption certificates ) and then export an SSH FTP key to send to your trading partner in either OpenSSH FTP Public Key or SSH FTP Public Key (IETF) format. See Certificate management and Exporting certificates. See also Private key authentication.
User Name
Password
Credentials for authentication to the remote server.
Use Public Key Authentication
Enables fields necessary to use public key authentication with a user certificate. See Private key authentication.
Exchange Certificates
Displays the Certificate Exchange dialog box, which allows you to send your certificates to your trading partner. See Exchanging certificates with your trading partner.
Certificate Alias
Certificate Password
Credentials used to access the user certificate for PKA.
Use Key From File
Enables fields necessary to use PKA with an existing SSH private key file. This option is only available when you selectUse Public Key Authentication. See Private key authentication.
Private Key File
Private Key Password
Name of and the password protecting the SSH private key file to use for PKA.
Private key authentication
Private key authentication (PKA) allows you to connect to your Trading Partner's remote server without exchanging your password over the Internet. PKA uses two keys: a private key that only you have, and a public key placed on the accessing server, usually by your Trading Partner's system administrator when the account is set up. In theVersaLexapplication, the private key portion is maintained securely in a User Certificate protected with theCertificate Password. TheCertificate Aliasspecifies the desired User Certificate to use for PKA.
Note:You must provide your Trading Partner with the corresponding SSH Public Key using the Certificate Manager. Using optionsExport >OpenPGPorSSH FTP Keysselect either theOpenSSH FTP Public KeyorSSH FTP Public Key(IETF) format. Do not select and send theSSH FTP Private Keyformat to your Trading Partner.
Alternatively, you can use an existing private key file. This file should be stored in a secure place and protected with a password. This feature is applicable only if you have an existing SSH private key for authentication with your Trading Partner and you are using JRE1.3. SSH private keys have no standard format. OpenSSH, SSH FTP Public Key (IETF), PuTTY, and ssh.com all have different proprietary formats. A private key generated with one cannot immediately be used with another. TheVersaLexapplication supports both OpenSSH and SSH FTP Public Key (IETF) private key file formats. If the private key is in a format not supported by theVersaLexapplication, you should export if from the application that created it in an OpenSSH format. To determine the format of your key you can simply open it using a text editor and compare it to the partial example formats listed below.
Table 3.Supported Private Key Formats
Type
Partial Example
IEFT (DSA)
---- BEGIN SSHTOOLS ENCRYPTED PRIVATE KEY ----
Comment: 1024-bit DSA
Subject: John Doe
AAAACDNERVMtQ0JD3yrqcRRh1OwAAAFQof0uP52Ya5iOnuVm1+G+o9TpQwXrOQfjPp0w8+GQ9uJ7
IETF (RSA)
---- BEGIN SSHTOOLS ENCRYPTED PRIVATE KEY ----
Comment: 1024-bit RSS
Subject: Jonh Doe
AAAACDNERVMtQ0JDEOMMw0wR0TwAAAEoUYoVJjvLn7lEnvusvbovpjscf1EDkJOMLX7HUddw8k9f
OpenSSH (RSA)
-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQDzl7h/4lkzqSPR5GhpwYr5MmUL6IeiY9TAsA24dA3Xa45a0JIQ
OpenSSH (DSA)
-----BEGIN DSA PRIVATE KEY-----
MIIBuwIBAAKBgQD42waNRIv7eJQoTR1PSQt+A2o8F9P1pGKLaLyw/rAg8N4FEHIN
Table 4.Unsupported Private Key Formats
Type
Partial Example
PuTTY
PuTTY-User-Key-File-2: ssh-rsa
Encryption: none
Comment: rsa-key-20070808
Public-Lines: 4
AAAAB3NzaC1yc2EAAAABJQAAAIBw8VeSCq0goiOwWqrlMu7H+N1QXAcBPdmvYttw
SSH.COM
---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----
Comment: "rsa-key-20070808"
P2/56wAAAiwAAAA3aWYtbW9kbntzaWdue3JzYS1wa2NzMS1zaGExfSxlbmNyeXB0e3JzYS
SSH FTP Mailbox: Packaging Tab
See Configuring mailbox packaging for information about payload file packaging.
SSH FTP Action
An action's parameters capture a repeatable transaction for your mailbox on the host system.
You create actions under a mailbox.
SSH FTP Action: Action Tab
See Composing an action and SSH FTP Command Reference.
SSH FTP Command Reference
CD
Changes the current working directory on the host.
CD "directory"
"directory"
The new working directory.
CHECK
See CHECK Command for information about this command.
CHGRP
Changes the group ID of the file or directory on the host.
QUOTE CHGRP group "path"
group
The numeric group id for the new group.
"path"
The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
CHMOD
Changes the access permissions or modes of the file or directory on the host.
QUOTE CHMOD permissions "path"
permissions
The absolute mode of the file/directory. Absolute modes are octal numbers specifying the complete list of attributes for the files; you specify attributes by OR'ing together these bits.
0400- Individual read
0200- Individual write
0100- Individual execute (or list directory)
0040- Group read
0020- Group write
0010- Group execute
0004- Other read
0002- Other write
0001- Other execute
"path"
The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
CHOWN
Changes the user ID of the file or directory on the host.
QUOTE CHOWN owner "path"
owner
The numeric user id for the new owner.
"path"
The path to the remote file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
CLEAR
Clear an action property string value. The cleared value only affects the commands thatfollowtheCLEAR.
CLEAR property
property
Action property name with no embedded spaces.
Comment
# text...
Lines in the action starting with a # character are considered comments and will be ignored when the action executes. Lines starting with # are generally used for documentation purposes.
DIR
Get a directory listing of available files from the host.
DIR "source"
"source"
Remote source directory path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
GET
Receive one or more files from the host
GET -REC DEL UNI|APE "source" "destination"
-REC
Recursively retrieve nested subdirectories.
Nested server directory structure retained locally.
If used in conjunction withDEL, the retrieved files, but not subdirectories, are deleted on the server.
-DEL
If the command is successful, delete the local file.
-UNI
Ensure the copied filename is unique.
-APE
Append copied file to existing destination file.
"source"
Remote source path. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"
Local destination path.
Path can be to a filename or to a directory.
If you specify a relative path, the command uses the default inbox.
You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
LCOPY
Copy one or more files locally.
LCOPY DEL -REC {UNI|APE} {-ZIP|-UNZ} "source" "destination"
-DEL
If the command is successful, delete the local file.
-REC
Recursively search all subdirectories.
You cannot use this option with the-UNZoption.
-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 throughZip CommentandZip Compression Levelproperties. See Setting advanced host properties.
The ZIP archive files created through theLCOPYcommand 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. TheLCOPYcommand works only with ZIP-formatted files. In addition to theVersaLexapplication, 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, theVersaLexapplication 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-RECoption.
Use ZIP entry paths ifUnzip Use Pathis set. See Setting advanced host properties.
The ZIP archive files created through theLCOPYcommand 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. TheLCOPYcommand works only with ZIP-formatted files. In addition to the application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
In addition to standard ZIP-formatted archives, theVersaLexapplication 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-RECand-ZIPoptions, andZip Subdirectories Into Individual Zip Filesis 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-APEoption, or when copying a file with the-APEoption 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 originalinput bytes.
Comma separated list of byte values (0-255).
IfWithparameter is omitted, then theinput bytesare deleted from the file.
PUT
Send one or more files to the host.
PUT DEL -APE "source" "destination" name=value,...
DEL
If thePUTcommand is successful, delete local file(s).
-APE
Append copied file to existing destination file.
"source"
Local source path
Path can be to a filename or to a directory
You can use*and?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
If you specify a relative path, the command uses the default outbox.
You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"
Remote destination path.
You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
MKDIR
Creates a new directory on the host.
QUOTE MKDIR "directory"
"directory"
The name of the new directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
MKDIRS
Creates a new directory on the host.
QUOTE MKDIRS "path"
"path"
The path of directories to create. Subdirectories are created using the/delimiter. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
PWD
Returns the name of the current working directory on the host.
QUOTE PWD
RENAME
Renames a file or directory on the host.
QUOTE RENAME "source" "destination"
"source"
The source file/directory to rename. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"
- The destination file/directory name. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
RM
Removes a file on the host.
QUOTE RM "path"
"path"
The path of the file to remove. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
RMDIR
Removes a directory on the host.
QUOTE RMDIR "path"
"path"
The path of the directory to remove. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
SCRIPT
See SCRIPT command for information about this command.
SET
Change an action property value. The new value only affects the commands thatfollowtheSET.
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 theCLEARcommand
STAT
Returns the attributes of the file or directory on the host.
QUOTE STAT "path"
"path"
The path of the file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
SYMLINK
Creates a symbolic link on the host to a file or directory.
QUOTE SYMLINK "path" "link"
"path"
The target path of the file/directory for the symbolic link. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"link"
The name for the new symbolic link. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
SYSTEM
Execute a local system command.
SYSTEM "path"
"path"
Local command path with arguments.
If you specify a relative path or no path, the command uses the home directory.
See Using operating system commands in actions for additional information
TOUCH
Sets the remote file access and modified times to the current time.
QUOTE TOUCH "path"
"path"
The path of the file/directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
WAIT
Pause execution.
WAIT seconds
Seconds
Number of seconds to pause.
View ArticleCLEO COMMUNICATIONSEND USER LICENSE AGREEMENT
IMPORTANT - THIS END USER LICENSE AGREEMENT (THIS "AGREEMENT" OR "EULA") IS A LEGAL AGREEMENT BETWEEN YOU ACTING INDIVIDUALLY AND ON BEHALF OF THE COMPANY OR OTHER ORGANIZATION ON WHOSE BEHALF YOU ACCEPT THIS AGREEMENT (COLLECTIVELY, "CUSTOMER") AND CLEO COMMUNICATIONS US, LLC ("CLEO" OR "Cleo"). PLEASE CAREFULLY READ THE TERMS AND CONDITIONS OF THIS AGREEMENT BEFORE ACCEPTING THIS AGREEMENT. BY CLICKING THE "I ACCEPT" BUTTON BELOW OR BY ACCESSING OR USING ANY PART OF THE SOFTWARE OR SERVICES (DEFINED BELOW), YOU REPRESENT AND ACKNOWLEDGE THAT YOU HAVE READ AND UNDERSTAND THIS AGREEMENT, THAT YOU AND CUSTOMER ARE BOUND LEGALLY BY ITS TERMS, AND THAT YOU ARE AUTHORIZED TO ACCEPT THIS AGREEMENT AND TO BIND CUSTOMER.IF YOU DO NOT AGREE TO ALL OF THE TERMS OF THIS AGREEMENT OR IF YOU DO NOT HAVE THE AUTHORITY TO BIND CUSTOMER, YOU ARE NOT GRANTED PERMISSION TO ACCESS OR USE THE SOFTWARE OR SERVICES. IN SUCH CASE, CLICK THE "I REJECT" BUTTON BELOW AND PROMPTLY RETURN AND/OR DELETE ANY MATERIALS RELATED TO THE CLEO PRODUCTS (DEFINED BELOW) THAT YOU HAVE RECEIVED OR THAT ARE IN YOUR POSSESSION.IF YOU OR CUSTOMER HAVE ENTERED INTO A SEPARATE MASTER AGREEMENT WITH CLEO FOR SPECIFIC SOFTWARE AND/OR SERVICES, THEN THE TERMS OF THAT SIGNED MASTER AGREEMENT CONTROL TO THE EXTENT IT CONFLICTS WITH THESE TERMS.1. DEFINITIONS. Capitalized terms used but not otherwise defined in this Agreement have the following meanings:1.1 "Cleo System" means Cleo's platform of online software applications in effect from time to time supporting business data transfer and integration.1.2 "Cleo Products" means the Cleo System, the Software and the Cleo Technology.1.3 "Cleo Technology" means: (i) the Cleo technology, methodologies and intellectual property (including, without limitation, products, software tools, hardware designs, algorithms, software (in source and object code forms), architecture, objects and documentation (both printed and electronic) existing at any time or otherwise arising outside of this Agreement; (ii) all derivatives, improvements, enhancements or extensions of any of the foregoing, whether or not conceived, reduced to practice or developed during the term of this Agreement; and (iii) all Intellectual Property Rights relating to any of the foregoing.1.4 "Deliverables" means any deliverables actually provided to Customer as part of the Services (if any) provided by Cleo to Customer pursuant to an Order Agreement.1.5 "Intellectual Property Rights" means any and all intellectual property rights throughout the world, including, without limitation, any and all patents, copyrights, trademarks, applications for any of the foregoing, trade secret rights, moral rights, unregistered design rights, rights to know-how, inventions, and algorithms, and any and all similar or equivalent rights throughout the world.1.6 "Malicious Code" means any undocumented malicious data, code, program, or other internal component (e.g., computer worm, computer time bomb or similar component), which could damage, destroy, alter or disrupt any computer program, firmware or hardware, or which could, in any manner, reveal, damage, destroy, alter or disrupt any data or other information accessed through or processed by the Software or Cleo's computer systems in any manner.1.7 "Order Agreement" means either (i) the separate Purchase Agreement document or other product order confirmation provided by Cleo to Customer in connection with Customer's purchase, access and use of the Software setting forth the term of Customer's right to use the Software and the fees payable in connection therewith; and/or (ii) a statement of work or other written agreement based on which Cleo provides Customer with certain specified Services and any related Deliverables.1.8 "Services" means any professional services, including, but not limited to, implementation services and consulting services, provided by Cleo to Customer pursuant to the terms of an Order Agreement.1.9 "Software" means the Cleo System and software applications which are made available by Cleo to Customer from time to time under this Agreement. 1.10 "Users" means individuals who are authorized by Customer to use the Software and who have been supplied with user identifications and passwords by Customer (or by Cleo at Customer's request). 2. USE OF THE SOFTWARE, DELIVERABLES AND LIMITATIONS.2.1 Grant of Use Rights. Subject to the terms and conditions of this Agreement, Cleo hereby grants to Customer, solely for its internal business purposes and for no other purpose, a non-exclusive, revocable, non-transferable right to access and use the Software and the Deliverables, if any, in accordance with this Agreement and applicable law for the term set forth in the Order Agreement.2.2 Customer Responsibilities. Customer is responsible at all times for the following: (i) Customer's implementation of the Software; (ii) Customer's use of the Deliverables: (iii) using the most current licensed versions of an Internet browser in connection with accessing and using the Software; (iv) protecting the names and passwords of the Users of the Software; (v) preventing, and for promptly notifying Cleo of, any unauthorized access to or use of the Software; (vi) each User's compliance with the terms and conditions of this Agreement and each User's acts and omissions; (vii) the reliability, integrity, accuracy, quality and lawfulness of, and the results obtained from, the Software; (viii) using the Software and the related data created or generated by Customer and the Deliverables within the permitted scope and limitations and only in accordance with this Agreement and applicable law; (ix) maintaining archival and backup copies of all data (and any prior versions thereof) accessed, created or generated by any User; and (x) using the Software and the Deliverables in accordance with applicable laws.2.3 Restrictions. Customer shall not (and shall not permit others) at any time to: (i) license, sublicense, sell, re-sell, rent, lease, transfer, distribute or time share the Software or the Deliverables, or make it or them available for access by third parties, including, without limitation, in the manner of a service bureau or hosted application; (ii) create derivative works based on or otherwise modify the Software or the Deliverables; (iii) disassemble, reverse engineer or decompile the Software, the Deliverables or the Cleo Technology; (iv) access the Software, the Deliverables or information related to the Software or the Deliverables in order to develop a competing product or service; (v) use the Software or the Deliverables to provide a service for others; (vi) use, include, store or send Malicious Code in or from the Software or the Deliverables; (vii) interfere with the integrity of the Software, the Deliverables or its or their data; (viii) remove or modify a copyright or other proprietary rights notice on or in the Software or the Deliverables; (ix) use the Software or the Deliverables to reproduce, distribute, display, transmit or use material protected by copyright or other Intellectual Property Right (including the rights of publicity or privacy) without first obtaining the permission of the owner; (x) violate any law or regulation of the United States, any state thereof or other governmental authority; (xi) disable, hack or otherwise interfere with any security, digital signing, digital rights management, verification or authentication mechanisms implemented in or by the Software or the Deliverables; (xii) disrupt the integrity of the Software or the Deliverables; or (xiii) alter, disable, or erase any computer data, computer programs or computer software without authorization.3. FEES.3.1 Fees; Invoicing and Payment. Cleo will invoice and Customer agrees to pay all fees reflected in the Order Agreement for the use of the Software and (if applicable) for provision of the Services in accordance with the payment terms set forth in the Order Agreement. If no payment terms are indicated in the Order Agreement, each invoice submitted to Customer will be due and payable within 30 days after the date of the invoice. All fees and other payment obligations hereunder are non-cancellable and all amounts paid are nonrefundable. 3.2 Price Adjustments. Cleo may increase the fees and any other fees and charges for the Software at any time upon notice to Customer.3.3 Amounts Payable; Taxes. All amounts payable under this Agreement are (i) exclusive of any sales, use, excise, value added, goods and services, and gross receipts taxes, and any and all similar taxes or legally imposed fees, duties or contributions based upon such amounts, except for franchise and margin taxes, if any, or taxes based upon the net income of Cleo; and (ii) reflect the net cash payable to Cleo, net of any and all such taxes, levies, fees and withholdings of every kind or nature. All such taxes, levies, fees and withholdings and the obligation to pay such amounts to the appropriate taxing authorities in a timely manner are the sole responsibility of Customer. 3.4 Late Payments/No Offset. Any invoice remaining unpaid after the due date will accrue interest from the due date until the date Cleo receives such payment at a rate equal to the lesser of one and one-half percent (1.5%) per month or the highest rate permitted by law. Customer shall not offset any amounts owed under this Agreement against any other agreement with Cleo. 3.5 Suspension of use of the Software. Notwithstanding any other provision contained in this Agreement, if Customer fails to pay any amount when due hereunder, Cleo may suspend Customer's ability to use the Software until all outstanding past due amounts are received by Cleo.4. OWNERSHIP. Cleo owns all right, title, and interest and any and all Intellectual Property Rights in and to the Software, the Deliverables and the Cleo Products. Except as expressly provided in this Agreement, Cleo does not grant (and expressly reserves) any rights, express or implied, or ownership in or to the Software, the Deliverables and the Cleo Products. Customer acknowledges that this Agreement does not provide Customer with title to or ownership of the Software, the Deliverables or the Cleo Products, but rather provides Customer only a limited right of use consistent with the express terms and conditions of this Agreement. Cleo has a perpetual, irrevocable, royalty-free, worldwide, non-exclusive, transferable, sublicensable right to make, use, sell, offer for sale, import, or otherwise incorporate into the Software, the Deliverables and/or the Cleo Products any suggestions, enhancements, recommendations or other feedback provided by Customer and its Users relating to the Software, the Deliverables and/or the Cleo Products.5. WARRANTIES AND DISCLAIMERS. 5.1 By Customer. Customer represents and warrants to Cleo as follows:(i) Authority. The individual who accepts this Agreement on behalf of Customer is authorized by all necessary corporate (or other entity) action to do so, and this Agreement is the legal, valid and binding obligation of Customer, enforceable against Customer in accordance with its terms.(ii) Compliance with Laws. Customer and Customer's Users will comply with all laws, rules, regulations, ordinances, and codes that are applicable to accessing and using the Software. 5.2 DISCLAIMER OF WARRANTIES. (i) CUSTOMER EXPRESSLY ACKNOWLEDGES AND AGREES THAT THE USE OF THE SOFTWARE AND THE DELIVERABLES IS AT ITS SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS SOLELY WITH CUSTOMER.(ii) CLEO MAKES NO REPRESENTATIONS, WARRANTIES OR AGREEMENTS WITH RESPECT TO THE SOFTWARE, THE DELIVERABLES OR THE CLEO PRODUCTS AND CLEO SPECIFICALLY DISCLAIMS AND EXCLUDES, TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, ANY AND ALL WARRANTIES OF ANY KIND, INCLUDING, WITHOUT LIMITATION, WARRANTIES ARISING UNDER STATUTE, WARRANTIES OF MERCHANTABILITY, ACCURACY, TITLE, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE, OR ANY WARRANTIES ARISING FROM USAGE OR TRADE, COURSE OF DEALING OR COURSE OF PERFORMANCE. CLEO SPECIFICALLY DOES NOT WARRANT THAT THE SOFTWARE, THE DELIVERABLES OR THE CLEO PRODUCTS WILL MEET THE REQUIREMENTS OF CUSTOMER, THAT THEY WILL BE ACCURATE OR OPERATE WITHOUT INTERRUPTION OR ERROR, OR THAT DEFECTS IN THE SOFTWARE, THE DELIVERABLES OR THE CLEO PRODUCTS WILL BE CORRECTED, AND CUSTOMER ACKNOWLEDGES THAT IT ASSUMES THE ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. THE SOFTWARE, THE DELIVERABLES AND CLEO PRODUCTS, AS DELIVERED, ARE NOT GUARANTEED TO MEET ALL OF CUSTOMER'S ACTUAL OR STATED REQUIREMENTS AND CLEO MAKES NO REPRESENTATIONS OR WARRANTIES REGARDING, WITHOUT LIMITATION, THE SECURITY, INTEGRITY, EFFICIENCY OR CAPABILITIES OF THE SOFTWARE, THE DELIVERABLES OR THE CLEO PRODUCTS AND CUSTOMER ACKNOWLEDGES THAT CUSTOMER IS SOLELY RESPONSIBLE FOR ALL DECISIONS IT MAKES WITH REGARD TO OPERATION OF ITS BUSINESS AND OPERATIONS. 6. INDEMNIFICATION AND LIMITATION OF LIABILITY.6.1 By Cleo. Except to the extent Customer is responsible for indemnifying Cleo under Section 6.2 below and subject to the limitations set forth in Section 6.3 below, Cleo agrees to defend, indemnify and hold harmless Customer and its officers, directors, employees and agents against any third-party claims, suits or actions (a "Claim") that the Software or the Deliverables infringe any patent, copyright, trademark, trade secret, or other Intellectual Property Right of a third party, provided that Customer: (i) promptly informs and furnishes Cleo with a copy of such Claim; (ii) gives Cleo all relevant evidence in Customer's possession, custody or control; and (iii) gives Cleo reasonable assistance in such Claim, at Cleo's expense, and the sole control of the defense thereof and all negotiations for its compromise or settlement, provided that Cleo agrees that it will not compromise or settle any such Claim unless Customer is unconditionally released from all liability.6.2 By Customer. Customer shall defend, indemnify and hold harmless Cleo and its officers, directors, employees and agents against any and all Claims arising from or related, directly or indirectly, to: (a) Customer's use of the Software and the Deliverables, including any data created, transmitted or received by Customer; (b) Customer's violation of any statutes, laws, rules, regulations and codes of any governmental authority; or (c) a breach by Customer of its representations, warranties, covenants and agreements contained in this Agreement, provided that Cleo: (i) promptly informs and furnishes Customer with a copy of such Claim; (ii) gives Customer all relevant evidence in Cleo's possession, custody or control; and (iii) gives Customer reasonable assistance in such Claim, at Customer's expense, and the sole control of the defense thereof and all negotiations for its compromise or settlement, provided that Customer shall not compromise or settle any such Claim unless Cleo is unconditionally released from all liability.6.3 LIMITATION OF LIABILITY. EXCEPT FOR ITS INDEMNITY OBLIGATIONS IN SECTION 6, THE CUMULATIVE, AGGREGATE LIABILITY OF CLEO TO CUSTOMER FOR ALL CLAIMS ARISING OUT OF OR RELATED TO THIS AGREEMENT WILL NOT EXCEED THE AMOUNTS PAID BY CUSTOMER HEREUNDER FOR THE THREE-MONTH PERIOD IMMEDIATELY PRIOR TO THE EVENT GIVING RISE TO THE CLAIM. NOTWITHSTANDING THE FOREGOING, IN NO EVENT WILL CLEO BE LIABLE TO CUSTOMER FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, INDIRECT OR PUNITIVE DAMAGES ARISING OUT OF OR IN ANY WAY RELATED TO THIS AGREEMENT, INCLUDING, WITHOUT LIMITATION, ANY DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOST REVENUE, LOSS OF USE, LOSS OF DATA, COSTS OF RECREATING LOST DATA, THE COST OF ANY SUBSTITUTE EQUIPMENT, PROGRAM, OR DATA, OR CLAIMS BY ANY THIRD PARTY. THE EXISTENCE OF MORE THAN ONE CLAIM WILL NOT ENLARGE OR EXTEND THESE LIMITS.7. TERM AND TERMINATION. 7.1 Term. The term of this Agreement commences upon Customer's acceptance as set forth herein and will continue in full force until terminated. 7.2 Termination. This Agreement will terminate upon the following:(a) Automatically and without notice on any of the following events: (i) Customer's breach of Section 2.3 or Section 3.5; (ii) Customer voluntarily or involuntarily becomes the subject of a petition in bankruptcy or of any proceeding relating to insolvency, receivership, liquidation, or composition for the benefit of creditors that is not dismissed or discharged within 60 days after being commenced; (iii) Customer admits in writing its inability to pay its debts generally as they become due (or takes any corporate action tantamount to such admission); (iv) Customer makes an assignment for the benefit of its creditors; or (v) Customer ceases to do business or commences dissolution or liquidation proceedings; (b) Customer's breach of this Agreement (other than as set forth in Section 7.2(a) above) that is not cured within 10 days (or within 5 days with respect to a failure to make any payment required hereunder) after Cleo gives Customer written notice of such breach; or(c) Automatically, at the end of the term specified in the applicable Order Agreement.7.3 Rights and Remedies upon Termination. In the event of any termination pursuant to either Section 7.2(a) or Section 7.2(b), Cleo will be entitled to all other rights and remedies which it may have under this Agreement and under applicable law.7.4 Data Backup. Cleo has no obligation to backup or archive any data created or generated by Customer through use of the Software. Customer is at all times solely responsible for ensuring that it has a copy of any such data (or portions thereof) that it may need for its ongoing operations outside of its use of the Software.7.5 Survival. The provisions of this Agreement regarding payment, ownership, indemnification, limitation of liability and all others that by their sense and context are intended to survive the execution, delivery, performance, termination or expiration of this Agreement survive and continue in effect.8. GENERAL PROVISIONS.8.1 Governing Law, Jurisdiction, and Venue. This Agreement (and the rights and obligations of the parties with respect to their relationship under this Agreement) are governed by and must be construed and enforced in accordance with the laws of the State of Illinois, excluding its conflict of laws rules to the extent such rules would apply the law of another jurisdiction. The parties hereto consent to the jurisdiction of all federal and state courts in Illinois, and agree that venue lies exclusively in Winnebago County, Illinois.8.2 Attorneys' Fees. The prevailing party in any action or proceeding to enforce this Agreement, including any efforts to collect amounts due under this Agreement by engagement of any attorney, collection agency or otherwise, is entitled to recover from the other party its costs and attorneys' fees in addition to any damages available to such party. 8.3 Entire Agreement. This Agreement and any other documents expressly contemplated hereby constitute the entire agreement between the parties with respect to the subject matter hereof. This Agreement supersedes all prior written or oral agreements, communications, and understandings between the parties with respect to the subject matter hereof.8.4 Amendment. Cleo has the right, at any time and without prior notice to Customer, to add to or modify the terms of this Agreement by delivering notice of such amended terms to Customer by email at the address provided to Cleo by Customer or by posting notice of such amended terms to Cleo's website www.cleo.com. Customer's access to or use of the Software or Services after the date that notice of such amended terms is delivered to Customer or posted on Cleo's website will be deemed to constitute acceptance of such amended terms.8.5 Waiver. No waiver of any provision of this Agreement is effective unless in writing and signed by the party against whom such waiver is sought to be enforced. No failure or delay by either party in exercising any right, power, or remedy under this Agreement will operate as a waiver of any such right, power, or remedy. The express waiver of any right or default hereunder will be effective only in the instance given and will not operate as or imply a waiver of any similar right or default on any subsequent occasion.8.6 Notices. Any notice, demand, request, or other communication required or permitted to be given under this Agreement must be made in writing, properly addressed to the party to receive notice at the address set forth herein or at such other address for notice as such party may hereafter designate by written notice to the other party given in the manner provided herein. In the case of notice to Cleo, the notice must be sent (i) via email with a confirmed receipt at [email protected] or (ii) via U.S. certified or registered mail, return receipt requested, postage prepaid, to the attention of Cleo Communications US, LLC, Attn.: Legal Department, at 4949 Harrison Avenue, Suite 200, Rockford, IL 61108. In the case of notice to Customer, the notice must be sent via email with a confirmed receipt to the email address provided to Cleo. Notice will be deemed received: (a) on the date of a confirmed email receipt, or (b) on the third business day after deposit with the U.S. Postal Service if sent by certified or registered mail, return receipt requested, postage prepaid. Customer agrees to accept communications from Cleo via email.8.7 Construction. If any provision of this Agreement is for any reason held to be invalid, illegal, or unenforceable under applicable law in any respect, then: (i) such invalidity, illegality, or unenforceability will not affect the other provisions of this Agreement; (ii) this Agreement will be construed as if such invalid, illegal, or unenforceable provision were excluded from this Agreement; and (iii) the court in its discretion may substitute for the excluded provision an enforceable provision which in economic substance reasonably approximates the excluded provision. 8.8 Assignment. Customer shall not transfer or assign this Agreement or any rights or obligations under this Agreement (whether by operation of law or otherwise) or delegate any duties under this Agreement without the prior written consent of Cleo, which consent may be withheld in its sole and absolute discretion, and any purported attempt to do so in violation of this Section will be null and void. 8.9 Force Majeure. If by reason of labor disputes, strikes, lockouts, riots, war, inability to obtain labor or materials, earthquake, fire or other action of the elements, accidents, Internet service provider failures or delays, governmental restrictions, appropriations or other causes beyond the reasonable control of a party hereto (each, a "Force Majeure Event"), either party is unable to perform in whole or in part its obligations as set forth in this Agreement, excluding any obligations to make payments hereunder, then such party will be relieved of those obligations to the extent it is so unable to perform and such inability to perform will not make such party liable to the other party. Neither party will be liable for any losses, injury, delay or damages suffered or incurred by the other party due to a Force Majeure Event. 8.10 Specific Performance; Remedies Cumulative. Customer acknowledges that a breach of this Agreement cannot be adequately compensated for by money damages and agrees that specific performance is an appropriate remedy for any breach or threatened breach hereof. Customer acknowledges that compliance with the provisions of this Agreement is necessary in order to protect the proprietary rights of Cleo. Accordingly, Customer hereby: (i) consents to the issuance of any injunctive relief or the enforcement of other equitable remedies against it at the suit of Cleo, without bond or other security, to compel performance of any of the terms of this Agreement; and (ii) waives any defenses thereto, including, without limitation, the defenses of failure of consideration, breach of any other provision of this Agreement, and availability of relief in damages. All remedies, whether under this Agreement, provided by law, or otherwise, are cumulative and not alternative.
Revised August 7, 2019
View ArticleHardware
Single core or higher processor
1 GB RAM minimum, 2 GB RAM recommended
10 Mbit network connection (100 Mbit recommended)
Minimum of 500 MB of disk space for the Cleo LexiCom application and associated files (1 GB recommended)
Must have a properly configured Internet connection
Disk space required for transferred files depends on number of trading partners, size of the files transferred, and number of files transferred (Recommended minimum disk space for files is 5 MB per trading partner)
Minimum of 350 MB of temporary space
Note:Greater hardware requirements may also be necessary depending upon your choice of Operating System.
Supported Operating Systems with Platform-Specific Installs
Windows Server 2016
Windows Server 2008 R2 & 2012 R2
Windows Professional 7
Windows 8, 8.1 & 10
Notes
It may be necessary to upgrade to the current version of Cleo LexiCom to run on the listed Operating Systems.
Java Runtime Environment
Cleo LexiCom ships with the version of JRE listed below as appropriate for the installation:
Oracle 1.8
Other Requirements
On Windows, LexiCom can be installed as a Windows service. However, by default, Windows services run under a local system account and do not see mapped network drives. If you must access a network drive through LexiCom, then you will have to use full network path names (UNC paths) instead of mapped network drives. Also, the network share permissions should be reviewed.
A physical Graphical User Interface (GUI) is required
Protocol-based Requirements
Odette FTP (OFTP)
Client Side and Server Side implementations of OFTP
OFTP over TCP/IP supported on all platforms
OFTP over ISDN supported on Windows platform only
ISDN Card must support to CAPI 2.0 interface
No special configuration is necessary
The following cards are supported:
Eicon Diva PCI
AVM Fritz!Card PCI (Not recommendedfor high volume or large file transfers)
IBMWebSphereMQ
Client connections to local or remote queue managers
Supported on all platforms
Requires WebSphere MQ 7.1 or later
IBM and WebSphere are registered trademarks of International Business Machines Corporation
View ArticleClick to download PDF versions of Cleo LexiCom v5.6.1 docs:
Cleo LexiCom v5.6.1 Release Notes - PDF
Cleo LexiCom v5.6.1 Installation and Configuration Guide - PDF
Cleo LexiCom v5.6.1 User Guide - PDF
View ArticleBelow are the minimum hardware and software specifications for installing and running LexiCom on AS/400 systems.
AS/400 Hardware Requirements
System i5 9406 520 or greater
1 gigabyte of processor memory
512 megabytes of IFS disk space
One Local Area Network (LAN) card and a persistent Internet connection
AS/400 Software Requirements
IBM i7.3 (V7R3)
Latest Cumulative PTFs
Latest Java and TCP/IP Group PTFs
5770JV1 IBM Developer Kit for Java
5770JV1 Option 17 Java SE 8 64 bit
5770SS1 Option 30 QShell
5770TC1 TCP/IP Connectivity Utilities for i5/0S
5770XE1 IBM i Access for Windows
5770XW1 IBM i Access Family
IBM i7.2 (V7R2)
Latest Cumulative PTFs
Latest Java and TCP/IP Group PTFs
5770JV1 IBM Developer Kit for Java
5770JV1 Option 17 Java SE 8 64 bit
5770SS1 Option 30 QShell
5770TC1 TCP/IP Connectivity Utilities for i5/0S
5770XE1 IBM i Access for Windows
5770XW1 IBM i Access Family
IBM i7.1 (V7R1)
Latest Cumulative PTFs
Latest Java and TCP/IP Group PTFs
5761JV1 IBM Developer Kit for Java
5761JV1 Option 17 Java SE 8 64 bit
5770SS1 Option 30 QShell
5770TC1 TCP/IP Connectivity Utilities for i5/0S
5770XE1 IBM i Access for Windows
5770XW1 IBM i Access Family
Secondary Windows-based Computer Requirements
Supported Windows platform for running the GUI
This Windows computer or the AS/400 may run the LexiCom service, depending upon your configuration
Windows 7 requires SP1
Windows 8 (may require OS Java version 1.8.0_92)
Windows 8.1
Windows 2008 Server requires SR2
Windows 10 isnotsupported
View ArticleCLEO COMMUNICATIONS
END USER LICENSE AGREEMENT
IMPORTANT - THIS END USER LICENSE AGREEMENT (THIS "AGREEMENT" OR "EULA") IS A LEGAL AGREEMENT BETWEEN YOU ACTING INDIVIDUALLY AND ON BEHALF OF THE COMPANY OR OTHER ORGANIZATION ON WHOSE BEHALF YOU ACCEPT THIS AGREEMENT (COLLECTIVELY, "CUSTOMER") AND CLEO COMMUNICATIONS US, LLC ("CLEO" OR "Cleo").
PLEASE CAREFULLY READ THE TERMS AND CONDITIONS OF THIS AGREEMENT BEFORE ACCEPTING THIS AGREEMENT. BY CLICKING THE "I ACCEPT" BUTTON BELOW OR BY ACCESSING OR USING ANY PART OF THE SOFTWARE OR SERVICES (DEFINED BELOW), YOU REPRESENT AND ACKNOWLEDGE THAT YOU HAVE READ AND UNDERSTAND THIS AGREEMENT, THAT YOU AND CUSTOMER ARE BOUND LEGALLY BY ITS TERMS, AND THAT YOU ARE AUTHORIZED TO ACCEPT THIS AGREEMENT AND TO BIND CUSTOMER.
IF YOU DO NOT AGREE TO ALL OF THE TERMS OF THIS AGREEMENT OR IF YOU DO NOT HAVE THE AUTHORITY TO BIND CUSTOMER, YOU ARE NOT GRANTED PERMISSION TO ACCESS OR USE THE SOFTWARE OR SERVICES. IN SUCH CASE, CLICK THE "I REJECT" BUTTON BELOW AND PROMPTLY RETURN AND/OR DELETE ANY MATERIALS RELATED TO THE CLEO PRODUCTS (DEFINED BELOW) THAT YOU HAVE RECEIVED OR THAT ARE IN YOUR POSSESSION.
IF YOU OR CUSTOMER HAVE ENTERED INTO A SEPARATE MASTER AGREEMENT WITH CLEO FOR SPECIFIC SOFTWARE AND/OR SERVICES, THEN THE TERMS OF THAT SIGNED MASTER AGREEMENT CONTROL TO THE EXTENT IT CONFLICTS WITH THESE TERMS.
1. DEFINITIONS. Capitalized terms used but not otherwise defined in this Agreement have the following meanings:
1.1 "Cleo System" means Cleo's platform of online software applications in effect from time to time supporting business data transfer and integration.
1.2 "Cleo Products" means the Cleo System, the Software and the Cleo Technology.
1.3 "Cleo Technology" means: (i) the Cleo technology, methodologies and intellectual property (including, without limitation, products, software tools, hardware designs, algorithms, software (in source and object code forms), architecture, objects and documentation (both printed and electronic) existing at any time or otherwise arising outside of this Agreement; (ii) all derivatives, improvements, enhancements or extensions of any of the foregoing, whether or not conceived, reduced to practice or developed during the term of this Agreement; and (iii) all Intellectual Property Rights relating to any of the foregoing.
1.4 "Deliverables" means any deliverables actually provided to Customer as part of the Services (if any) provided by Cleo to Customer pursuant to an Order Agreement.
1.5 "Intellectual Property Rights" means any and all intellectual property rights throughout the world, including, without limitation, any and all patents, copyrights, trademarks, applications for any of the foregoing, trade secret rights, moral rights, unregistered design rights, rights to know-how, inventions, and algorithms, and any and all similar or equivalent rights throughout the world.
1.6 "Malicious Code" means any undocumented malicious data, code, program, or other internal component (e.g., computer worm, computer time bomb or similar component), which could damage, destroy, alter or disrupt any computer program, firmware or hardware, or which could, in any manner, reveal, damage, destroy, alter or disrupt any data or other information accessed through or processed by the Software or Cleo's computer systems in any manner.
1.7 "Order Agreement" means either (i) the separate Purchase Agreement document or other product order confirmation provided by Cleo to Customer in connection with Customer's purchase, access and use of the Software setting forth the term of Customer's right to use the Software and the fees payable in connection therewith; and/or (ii) a statement of work or other written agreement based on which Cleo provides Customer with certain specified Services and any related Deliverables.
1.8 "Services" means any professional services, including, but not limited to, implementation services and consulting services, provided by Cleo to Customer pursuant to the terms of an Order Agreement.
1.9 "Software" means the Cleo System and software applications which are made available by Cleo to Customer from time to time under this Agreement.
1.10 "Users" means individuals who are authorized by Customer to use the Software and who have been supplied with user identifications and passwords by Customer (or by Cleo at Customer's request).
2. USE OF THE SOFTWARE, DELIVERABLES AND LIMITATIONS.
2.1 Grant of Use Rights. Subject to the terms and conditions of this Agreement, Cleo hereby grants to Customer, solely for its internal business purposes and for no other purpose, a non-exclusive, revocable, non-transferable right to access and use the Software and the Deliverables, if any, in accordance with this Agreement and applicable law for the term set forth in the Order Agreement.
2.2 Customer Responsibilities. Customer is responsible at all times for the following: (i) Customer's implementation of the Software; (ii) Customer's use of the Deliverables: (iii) using the most current licensed versions of an Internet browser in connection with accessing and using the Software; (iv) protecting the names and passwords of the Users of the Software; (v) preventing, and for promptly notifying Cleo of, any unauthorized access to or use of the Software; (vi) each User's compliance with the terms and conditions of this Agreement and each User's acts and omissions; (vii) the reliability, integrity, accuracy, quality and lawfulness of, and the results obtained from, the Software; (viii) using the Software and the related data created or generated by Customer and the Deliverables within the permitted scope and limitations and only in accordance with this Agreement and applicable law; (ix) maintaining archival and backup copies of all data (and any prior versions thereof) accessed, created or generated by any User; and (x) using the Software and the Deliverables in accordance with applicable laws.
2.3 Restrictions. Customer shall not (and shall not permit others) at any time to: (i) license, sublicense, sell, re-sell, rent, lease, transfer, distribute or time share the Software or the Deliverables, or make it or them available for access by third parties, including, without limitation, in the manner of a service bureau or hosted application; (ii) create derivative works based on or otherwise modify the Software or the Deliverables; (iii) disassemble, reverse engineer or decompile the Software, the Deliverables or the Cleo Technology; (iv) access the Software, the Deliverables or information related to the Software or the Deliverables in order to develop a competing product or service; (v) use the Software or the Deliverables to provide a service for others; (vi) use, include, store or send Malicious Code in or from the Software or the Deliverables; (vii) interfere with the integrity of the Software, the Deliverables or its or their data; (viii) remove or modify a copyright or other proprietary rights notice on or in the Software or the Deliverables; (ix) use the Software or the Deliverables to reproduce, distribute, display, transmit or use material protected by copyright or other Intellectual Property Right (including the rights of publicity or privacy) without first obtaining the permission of the owner; (x) violate any law or regulation of the United States, any state thereof or other governmental authority; (xi) disable, hack or otherwise interfere with any security, digital signing, digital rights management, verification or authentication mechanisms implemented in or by the Software or the Deliverables; (xii) disrupt the integrity of the Software or the Deliverables; or (xiii) alter, disable, or erase any computer data, computer programs or computer software without authorization.
3. FEES.
3.1 Fees; Invoicing and Payment. Cleo will invoice and Customer agrees to pay all fees reflected in the Order Agreement for the use of the Software and (if applicable) for provision of the Services in accordance with the payment terms set forth in the Order Agreement. If no payment terms are indicated in the Order Agreement, each invoice submitted to Customer will be due and payable within 30 days after the date of the invoice. All fees and other payment obligations hereunder are non-cancellable and all amounts paid are nonrefundable.
3.2 Price Adjustments. Cleo may increase the fees and any other fees and charges for the Software at any time upon notice to Customer.
3.3 Amounts Payable; Taxes. All amounts payable under this Agreement are (i) exclusive of any sales, use, excise, value added, goods and services, and gross receipts taxes, and any and all similar taxes or legally imposed fees, duties or contributions based upon such amounts, except for franchise and margin taxes, if any, or taxes based upon the net income of Cleo; and (ii) reflect the net cash payable to Cleo, net of any and all such taxes, levies, fees and withholdings of every kind or nature. All such taxes, levies, fees and withholdings and the obligation to pay such amounts to the appropriate taxing authorities in a timely manner are the sole responsibility of Customer.
3.4 Late Payments/No Offset. Any invoice remaining unpaid after the due date will accrue interest from the due date until the date Cleo receives such payment at a rate equal to the lesser of one and one-half percent (1.5%) per month or the highest rate permitted by law. Customer shall not offset any amounts owed under this Agreement against any other agreement with Cleo.
3.5 Suspension of use of the Software. Notwithstanding any other provision contained in this Agreement, if Customer fails to pay any amount when due hereunder, Cleo may suspend Customer's ability to use the Software until all outstanding past due amounts are received by Cleo.
4. OWNERSHIP. Cleo owns all right, title, and interest and any and all Intellectual Property Rights in and to the Software, the Deliverables and the Cleo Products. Except as expressly provided in this Agreement, Cleo does not grant (and expressly reserves) any rights, express or implied, or ownership in or to the Software, the Deliverables and the Cleo Products. Customer acknowledges that this Agreement does not provide Customer with title to or ownership of the Software, the Deliverables or the Cleo Products, but rather provides Customer only a limited right of use consistent with the express terms and conditions of this Agreement. Cleo has a perpetual, irrevocable, royalty-free, worldwide, non-exclusive, transferable, sublicensable right to make, use, sell, offer for sale, import, or otherwise incorporate into the Software, the Deliverables and/or the Cleo Products any suggestions, enhancements, recommendations or other feedback provided by Customer and its Users relating to the Software, the Deliverables and/or the Cleo Products.
5. WARRANTIES AND DISCLAIMERS.
5.1 By Customer. Customer represents and warrants to Cleo as follows:
(i) Authority. The individual who accepts this Agreement on behalf of Customer is authorized by all necessary corporate (or other entity) action to do so, and this Agreement is the legal, valid and binding obligation of Customer, enforceable against Customer in accordance with its terms.
(ii) Compliance with Laws. Customer and Customer's Users will comply with all laws, rules, regulations, ordinances, and codes that are applicable to accessing and using the Software.
5.2 DISCLAIMER OF WARRANTIES.
(i) CUSTOMER EXPRESSLY ACKNOWLEDGES AND AGREES THAT THE USE OF THE SOFTWARE AND THE DELIVERABLES IS AT ITS SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS SOLELY WITH CUSTOMER.
(ii) CLEO MAKES NO REPRESENTATIONS, WARRANTIES OR AGREEMENTS WITH RESPECT TO THE SOFTWARE, THE DELIVERABLES OR THE CLEO PRODUCTS AND CLEO SPECIFICALLY DISCLAIMS AND EXCLUDES, TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, ANY AND ALL WARRANTIES OF ANY KIND, INCLUDING, WITHOUT LIMITATION, WARRANTIES ARISING UNDER STATUTE, WARRANTIES OF MERCHANTABILITY, ACCURACY, TITLE, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE, OR ANY WARRANTIES ARISING FROM USAGE OR TRADE, COURSE OF DEALING OR COURSE OF PERFORMANCE. CLEO SPECIFICALLY DOES NOT WARRANT THAT THE SOFTWARE, THE DELIVERABLES OR THE CLEO PRODUCTS WILL MEET THE REQUIREMENTS OF CUSTOMER, THAT THEY WILL BE ACCURATE OR OPERATE WITHOUT INTERRUPTION OR ERROR, OR THAT DEFECTS IN THE SOFTWARE, THE DELIVERABLES OR THE CLEO PRODUCTS WILL BE CORRECTED, AND CUSTOMER ACKNOWLEDGES THAT IT ASSUMES THE ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. THE SOFTWARE, THE DELIVERABLES AND CLEO PRODUCTS, AS DELIVERED, ARE NOT GUARANTEED TO MEET ALL OF CUSTOMER'S ACTUAL OR STATED REQUIREMENTS AND CLEO MAKES NO REPRESENTATIONS OR WARRANTIES REGARDING, WITHOUT LIMITATION, THE SECURITY, INTEGRITY, EFFICIENCY OR CAPABILITIES OF THE SOFTWARE, THE DELIVERABLES OR THE CLEO PRODUCTS AND CUSTOMER ACKNOWLEDGES THAT CUSTOMER IS SOLELY RESPONSIBLE FOR ALL DECISIONS IT MAKES WITH REGARD TO OPERATION OF ITS BUSINESS AND OPERATIONS.
6. INDEMNIFICATION AND LIMITATION OF LIABILITY.
6.1 By Cleo. Except to the extent Customer is responsible for indemnifying Cleo under Section 6.2 below and subject to the limitations set forth in Section 6.3 below, Cleo agrees to defend, indemnify and hold harmless Customer and its officers, directors, employees and agents against any third-party claims, suits or actions (a "Claim") that the Software or the Deliverables infringe any patent, copyright, trademark, trade secret, or other Intellectual Property Right of a third party, provided that Customer: (i) promptly informs and furnishes Cleo with a copy of such Claim; (ii) gives Cleo all relevant evidence in Customer's possession, custody or control; and (iii) gives Cleo reasonable assistance in such Claim, at Cleo's expense, and the sole control of the defense thereof and all negotiations for its compromise or settlement, provided that Cleo agrees that it will not compromise or settle any such Claim unless Customer is unconditionally released from all liability.
6.2 By Customer. Customer shall defend, indemnify and hold harmless Cleo and its officers, directors, employees and agents against any and all Claims arising from or related, directly or indirectly, to: (a) Customer's use of the Software and the Deliverables, including any data created, transmitted or received by Customer; (b) Customer's violation of any statutes, laws, rules, regulations and codes of any governmental authority; or (c) a breach by Customer of its representations, warranties, covenants and agreements contained in this Agreement, provided that Cleo: (i) promptly informs and furnishes Customer with a copy of such Claim; (ii) gives Customer all relevant evidence in Cleo's possession, custody or control; and (iii) gives Customer reasonable assistance in such Claim, at Customer's expense, and the sole control of the defense thereof and all negotiations for its compromise or settlement, provided that Customer shall not compromise or settle any such Claim unless Cleo is unconditionally released from all liability.
6.3 LIMITATION OF LIABILITY. EXCEPT FOR ITS INDEMNITY OBLIGATIONS IN SECTION 6, THE CUMULATIVE, AGGREGATE LIABILITY OF CLEO TO CUSTOMER FOR ALL CLAIMS ARISING OUT OF OR RELATED TO THIS AGREEMENT WILL NOT EXCEED THE AMOUNTS PAID BY CUSTOMER HEREUNDER FOR THE THREE-MONTH PERIOD IMMEDIATELY PRIOR TO THE EVENT GIVING RISE TO THE CLAIM. NOTWITHSTANDING THE FOREGOING, IN NO EVENT WILL CLEO BE LIABLE TO CUSTOMER FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, INDIRECT OR PUNITIVE DAMAGES ARISING OUT OF OR IN ANY WAY RELATED TO THIS AGREEMENT, INCLUDING, WITHOUT LIMITATION, ANY DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOST REVENUE, LOSS OF USE, LOSS OF DATA, COSTS OF RECREATING LOST DATA, THE COST OF ANY SUBSTITUTE EQUIPMENT, PROGRAM, OR DATA, OR CLAIMS BY ANY THIRD PARTY. THE EXISTENCE OF MORE THAN ONE CLAIM WILL NOT ENLARGE OR EXTEND THESE LIMITS.
7. TERM AND TERMINATION.
7.1 Term. The term of this Agreement commences upon Customer's acceptance as set forth herein and will continue in full force until terminated.
7.2 Termination. This Agreement will terminate upon the following:
(a) Automatically and without notice on any of the following events: (i) Customer's breach of Section 2.3 or Section 3.5; (ii) Customer voluntarily or involuntarily becomes the subject of a petition in bankruptcy or of any proceeding relating to insolvency, receivership, liquidation, or composition for the benefit of creditors that is not dismissed or discharged within 60 days after being commenced; (iii) Customer admits in writing its inability to pay its debts generally as they become due (or takes any corporate action tantamount to such admission); (iv) Customer makes an assignment for the benefit of its creditors; or (v) Customer ceases to do business or commences dissolution or liquidation proceedings;
(b) Customer's breach of this Agreement (other than as set forth in Section 7.2(a) above) that is not cured within 10 days (or within 5 days with respect to a failure to make any payment required hereunder) after Cleo gives Customer written notice of such breach; or
(c) Automatically, at the end of the term specified in the applicable Order Agreement.
7.3 Rights and Remedies upon Termination. In the event of any termination pursuant to either Section 7.2(a) or Section 7.2(b), Cleo will be entitled to all other rights and remedies which it may have under this Agreement and under applicable law.
7.4 Data Backup. Cleo has no obligation to backup or archive any data created or generated by Customer through use of the Software. Customer is at all times solely responsible for ensuring that it has a copy of any such data (or portions thereof) that it may need for its ongoing operations outside of its use of the Software.
7.5 Survival. The provisions of this Agreement regarding payment, ownership, indemnification, limitation of liability and all others that by their sense and context are intended to survive the execution, delivery, performance, termination or expiration of this Agreement survive and continue in effect.
8. GENERAL PROVISIONS.
8.1 Governing Law, Jurisdiction, and Venue. This Agreement (and the rights and obligations of the parties with respect to their relationship under this Agreement) are governed by and must be construed and enforced in accordance with the laws of the State of Illinois, excluding its conflict of laws rules to the extent such rules would apply the law of another jurisdiction. The parties hereto consent to the jurisdiction of all federal and state courts in Illinois, and agree that venue lies exclusively in Winnebago County, Illinois.
8.2 Attorneys' Fees. The prevailing party in any action or proceeding to enforce this Agreement, including any efforts to collect amounts due under this Agreement by engagement of any attorney, collection agency or otherwise, is entitled to recover from the other party its costs and attorneys' fees in addition to any damages available to such party.
8.3 Entire Agreement. This Agreement and any other documents expressly contemplated hereby constitute the entire agreement between the parties with respect to the subject matter hereof. This Agreement supersedes all prior written or oral agreements, communications, and understandings between the parties with respect to the subject matter hereof.
8.4 Amendment. Cleo has the right, at any time and without prior notice to Customer, to add to or modify the terms of this Agreement by delivering notice of such amended terms to Customer by email at the address provided to Cleo by Customer or by posting notice of such amended terms to Cleo's website www.cleo.com. Customer's access to or use of the Software or Services after the date that notice of such amended terms is delivered to Customer or posted on Cleo's website will be deemed to constitute acceptance of such amended terms.
8.5 Waiver. No waiver of any provision of this Agreement is effective unless in writing and signed by the party against whom such waiver is sought to be enforced. No failure or delay by either party in exercising any right, power, or remedy under this Agreement will operate as a waiver of any such right, power, or remedy. The express waiver of any right or default hereunder will be effective only in the instance given and will not operate as or imply a waiver of any similar right or default on any subsequent occasion.
8.6 Notices. Any notice, demand, request, or other communication required or permitted to be given under this Agreement must be made in writing, properly addressed to the party to receive notice at the address set forth herein or at such other address for notice as such party may hereafter designate by written notice to the other party given in the manner provided herein. In the case of notice to Cleo, the notice must be sent (i) via email with a confirmed receipt at [email protected] or (ii) via U.S. certified or registered mail, return receipt requested, postage prepaid, to the attention of Cleo Communications US, LLC, Attn.: Legal Department, at 4949 Harrison Avenue, Suite 200, Rockford, IL 61108. In the case of notice to Customer, the notice must be sent via email with a confirmed receipt to the email address provided to Cleo. Notice will be deemed received: (a) on the date of a confirmed email receipt, or (b) on the third business day after deposit with the U.S. Postal Service if sent by certified or registered mail, return receipt requested, postage prepaid. Customer agrees to accept communications from Cleo via email.
8.7 Construction. If any provision of this Agreement is for any reason held to be invalid, illegal, or unenforceable under applicable law in any respect, then: (i) such invalidity, illegality, or unenforceability will not affect the other provisions of this Agreement; (ii) this Agreement will be construed as if such invalid, illegal, or unenforceable provision were excluded from this Agreement; and (iii) the court in its discretion may substitute for the excluded provision an enforceable provision which in economic substance reasonably approximates the excluded provision.
8.8 Assignment. Customer shall not transfer or assign this Agreement or any rights or obligations under this Agreement (whether by operation of law or otherwise) or delegate any duties under this Agreement without the prior written consent of Cleo, which consent may be withheld in its sole and absolute discretion, and any purported attempt to do so in violation of this Section will be null and void.
8.9 Force Majeure. If by reason of labor disputes, strikes, lockouts, riots, war, inability to obtain labor or materials, earthquake, fire or other action of the elements, accidents, Internet service provider failures or delays, governmental restrictions, appropriations or other causes beyond the reasonable control of a party hereto (each, a "Force Majeure Event"), either party is unable to perform in whole or in part its obligations as set forth in this Agreement, excluding any obligations to make payments hereunder, then such party will be relieved of those obligations to the extent it is so unable to perform and such inability to perform will not make such party liable to the other party. Neither party will be liable for any losses, injury, delay or damages suffered or incurred by the other party due to a Force Majeure Event.
8.10 Specific Performance; Remedies Cumulative. Customer acknowledges that a breach of this Agreement cannot be adequately compensated for by money damages and agrees that specific performance is an appropriate remedy for any breach or threatened breach hereof. Customer acknowledges that compliance with the provisions of this Agreement is necessary in order to protect the proprietary rights of Cleo. Accordingly, Customer hereby: (i) consents to the issuance of any injunctive relief or the enforcement of other equitable remedies against it at the suit of Cleo, without bond or other security, to compel performance of any of the terms of this Agreement; and (ii) waives any defenses thereto, including, without limitation, the defenses of failure of consideration, breach of any other provision of this Agreement, and availability of relief in damages. All remedies, whether under this Agreement, provided by law, or otherwise, are cumulative and not alternative.
Revised August 7, 2019
View ArticleSeveral new control flow tasks (i.e. a Business Process task composed of several other tasks) are available that provide easier data looping and conditional constructs are available in Clarify 5. The editor has also changed to reflect this structured flow.
The following new types can be used as parameters and variables in the Business Process editor.
Dictionary: A collection containing key-value pairs.
Tasks include: Create, Get, Has Key, Keys, Values, Put, Remove, and Size.
List: A collection containing an ordered list of objects.
Tasks include: Create, Get, Add, Remove, Last, and Size.
JSON: Data that is structured in the JSON format.
Tasks include: Read from Create, Type, Get, Set, To Dictionary, To List, and To StorageNode.
New tasks include:
For each: For each item in a list, a specified task is executed.
Do while: Executes a task while a specified condition is true. The specified task is executed before the condition is checked. This means that the specified task is always executed at least one time. Then the condition is checked. If the condition is true, then it executes again (then the condition is checked again). And so on.
While do: While a specified condition is true, a specified task is executed. The condition is initially checked before the given task is executed. This means that the condition is checked first before the task is performed. So, if the condition isn't immediately true, then the task is never executed.
If/Then/Else: (Shown here) If a given condition is true, a specified task will be executed in the then block. If the given condition is false, the specified task will be executed in the else block. In the example below, different Business Processes will execute based on the result of the initial If statement.
Using Pass/Fail Parameters with Control Flow tasks
Task labels and pass/fail parameters can still be still used to control the sequence of logic in a Business Process. While task labels and pass/fail parameters can be used at the control flow task level (If/Then/Else, for example) they cannot be used by the sub-tasks contained within control flow tasks themselves.
Force Step Failure task (typically used with If/Then/Else)
The Force Step Failure task can be used to force the entire step that it is contained within a control flow task to fail. When using control flow tasks, if a singular task does not complete successfully, the overall control flow task (If/Then/Else, for example) does not necessarily stop nor appear as failed in the Auditor. By using the Force Step Failure task, an optional error message can be provided when the task is executed (thereby providing better troubleshooting).
For example, in the Business Process below the Force Step Failure task has been included within a While Do task. If the ReadLocationsFA (File Adapter) task fails, then the entire step fails, and an error message can be made to appear in the Auditor.
Additional information on these Business Process enhancements can be found in the Designing Integration Solutions | Processing the Data | Business Processes section the Online User Guide or In-Product Help.
View ArticleReplication can be used create an up-to-date copy of your production server on another machine.
This copy is not meant to be actively processing documents, but to be held in reserve as a recovery option during emergencies or planned maintenance. The replication process involves two distinct stages:
Replicating the PostgreSQL database to a second PostgreSQL database.
Replicating the remote server and Clarify Shared Workspaces on the file system.Note: the server cluster must be shut down in order for server/workspace replication to be successful. Refer toHow to Stop, Suspend, and Resume the Server Cluster inthe Clarify Server Installation Guide.
Recommendations
For maximum redundancy, you should replicate to a different machine rather than just a different folder or drive volume on the same machine.
View ArticlePlease review the following recommendations and best practices that cover these major cluster topics.
Planning and Installation
Troubleshooting
Backup and Restore
Note: Always review the minimum system requirements. Note that the specifics of your implementation may require more resources than outlined here. Consult your Customer Account Manager or Technical Support for more information.
Know your sizing requirements before you install
The sizing of your server cluster is critical to the stability and performance of your integration solution. Sizing refers to the volume of transactions you expect, as well as the size of the files/data that are part of those transactions.
Generally the larger the file size, the more impact on memory. While there are other factors that determine which sizing requirements are best for you - such as file type - the important thing is to provide the maximum amount of memory allocation possible.
In Summary:
Evaluate the overall performance and capacity requirements for your data traffic.
The larger the file size, the more impact it has on memory.
Good planning prevents problems and poor performance down the line.
Understand the importance of user permissions before you install
Pay careful attention to the installation procedures, especially when assigning permissions to the files and directories that are part of a server cluster. It is critical to understand which types of access should be assigned before installation occurs.
This is especially important when installing a server cluster on a Linux system. There are only two roles that have the ability to change the permissions of a file or directory:
The owner of the file or directory
The root user*
* The exception is the postgres user, which should always be used for the Postgres database. Giving root ownership to the database may cause permission problems.
Under most circumstances, only a System Administrator should have access to the root account (and use it to maintain the server cluster environment). The root user is a superuser who has permission to do anything and everything.
Normal users should typically have access to files and directories in their home directory only.
For more information
Refer to the Pre-Installation: Set up your environment section of the Clarify Server Installation Guide. Topics include:
Create an installation directory and enable sharing
Create a domain user with administrative privileges
Create symbolic links
Ensure certain power-saving settings are disabled
Note: When installing the server cluster database on Linux, the installation must be done as root.
Troubleshooting commonproblems and recommended solutions
Problem: ClassNotFoundExceptions in Clarify logs.
Possible Cause and solution: This is due to a problem communicating with the Clarify server share and shared workspace Problem communicating with the Clarify server share and shared workspace. Antivirus software locks files, and is often the cause of this error. As stated in the Cluster installation guide, do not run virus protection software over the Server, Share, and Database directories. Turn off if running.
Also, be aware that other issues may cause this error. It can also be replication, snapshots, VMotion and other automated load balancing, network failures, etc. Basically, anything that causes downtime on the Share machine or interrupts the cluster's communication with it can impede communication.
Problem: Node excluded due to network failures.
Possible Cause and solution: Network card power settings may be set to sleep.
As stated in the Cluster installation guide, default power save settings on Windows servers may disable network adapters; doing so will cause Server Cluster performance to interrupt.
Always make sure that the power save settings for network adapters (on all servers) are disabled. This can usually be done through the Device Manager.
Problem: Node excluded due to replication.
Possible Cause and solution: Be aware that replication tools can cause a server node to inadvertently stop or pause.
Problem: Node excluded due to VM snapshots and VMotion.
Possible Cause and solution: Be aware that snapshots and VMotion can cause a virtual machine server node to inadvertently stop or pause.
Problem: Cluster appears to be too slow or experiences slowness.
Possible Cause and solution: The sharing of CPU resources is often the cause. CPU shares are not equivalent to percentages of CPU resources. Shares are used to define the relative importance of workloads in relation to other workloads. When you assign CPU shares to a project, your primary concern is not the number of shares the project has. Knowing how many shares the project has in comparison with other projects is more important. You must also take into account how many of those other projects will be competing with it for CPU resources.
Problem: Out of memory
Possible Cause and solution: Sharing of memory between Clarify and other applications is not recommended. The server cluster needs exclusive memory.
What happens to jobs being processed when an active server node fails?
Whenever a server node experiences some type of failure event, there may be Business Processes and related tasks caught in-process. The way in which these processes are affected may differ - it may cause tasks to abort, or partially complete. The important thing is to know how to identify any failed processes, and the recommended steps for recovery.
Typically, the following actions should take place:
Check the Studios Admin Console Auditor for failures and specific details as to which processes and tasks may have failed.
Re-process any Business Process that did not complete.
Check for other, non-Clarify systems/processes that may need to be manually restarted or further analyzed.
Server cluster backups
Cleo recommends backing up the database and file system in one comprehensive process. It is imperative that these are both backed up together.
Database backup: creates a backup of the database using a script provided by Cleo; a corresponding script can then restore the database from the backup.
File System backup: requires use of a third-party tool (or a set of scripts to copy the files to another location) that you choose; this must backup important Clarify file system resources.
Replication: can duplicate your entire Clarify environment in almost real-time. This is accomplished by replicating the database via a PostgreSQL tool and by replicating Clarify file system resources via a third-party replication tool.
For more information
How to gracefully shut down a Server Cluster for an OS backup or Windows update (off-line update)
Backup and Restore (including on-line procedures)
View ArticleThe server cluster must be completely down for an Operating System backup or Windows Update to not have a negative impact on the system. This is due to the other components of the cluster that are not halted during a suspension, such as the internal program that allows cluster nodes to communicate with each other, as well as database activity.
Note: Automating a complete reboot of a cluster will require many more utilities than the scripts currently provided.
This is the recommendedprocedure:
Launch the clarify_ctl.bat -suspendCluster command to suspend the cluster (this can be automated with our script).
Launch the clarify_ctl.bat -shutdownCluster command to shut down the Clarify Windows service (this can be automated with our script).
Shutdown cis-conductor Windows services on each node (must be done by user unless custom scripts are created).
Shutdown postgresql-9.4 Windows service on Database machine (must be done by user unless custom scripts are created).
Once complete, thestartup procedurewould be:
Turn on postgresql-9.4 Windows service on Database machine (must be done by the user unless custom scripts are created).
Turn on cis-conductor Windows services on each node (must be done by the user unless custom scripts are created).
Turn on Clarify Windows services on each node (must be done by the user unless custom scripts are created).
Launch clarify_ctl.bat -resumeCluster command (this can be automated with a script).
Note: For instructions on how to perform updates while the server cluster remains on-line, refer to the Online User Guide:
Backup and Restore (including on-line procedures)
View ArticleThe basic building block of command execution within the product takes place within an action. This course includes hands-on exercises and will focus on actions for users of Cleo VLTrader and Cleo Harmony.
Prerequisite: DM102 Fundamentals OR DM104 Getting Started
(4 hours)
Price Per Student
$800
Available Dates/Times
January 9 (11 am - 3 pm ET)
February 13 (11 am - 3 pm ET)
March 5 (11 am - 3 pm ET)
View ArticleYour support team is eager to ensure that you quickly and continuously enjoy the value of your Cleo products and services. As a quick introduction, the Cleo Support Leadership Team (below) and the entire extended worldwide Cleo Support Team are extremely proud to serve your business.
When contacting the Cleo support team, please have your contact information, product you are calling about, and serial number (if available). This will help expedite the initial contact process so that we can respond to your needs faster. During the support process we may request additional information, such as a support bundle. This additional information will vary depending on the type of request or issue you are calling about.
For customers with Mission Critical Support (MCS), you can reach out directly to your customer concierge to follow up on requests. You also may schedule weekly or monthly calls to go over your support experience and open requests.
Cleo offers three levels of support for most Cleo solutions in addition to a product-specific support package for Cleo Streem customers.
If you have questions or concerns about Cleo Support that have not been addressed by the appropriate Manager, please reach out to the Director of Support. View the Support Leadership page.
Request a License
Important Links
Cleo Support Tiers
Cleo Severity Levels
Core Support Services
Contact Information
Cleo Support Phone: +1-815-282-7894, US (Toll Free): +1-866-444-CLEO (2536), UK: +44 2038653439
Cleo LexiCom, VLTrader, Harmony Email: [email protected]
Cleo Streem Products Email: [email protected]
Cleo EEI, ESX, VAN, Clarify: [email protected]
Support Services
Support Services are available to customers with current annual Support Subscriptions, who have attended the required Product Training Classes.
If customer does not have a current Support Subscription and requires Support Services, customer will be required to pay Fees for the intervening time since the lapse of a Support Subscription or since purchase of Licensed Product(s).
To purchase or renew an annual subscription, upgrade Support Subscription, purchase value added services, or request a consulting services quote, please contact your Cleo Sales Representative by calling +1-800-233-2536 (in North America) or +1-815-282-7695 (International). You may also email questions to .
View ArticleSecurity for Web Service Providers
The following configuration steps allow you to enable or disable specific SSL protocols and cipher suites.
Logging is available (Server version 4.14 and above) indicating which protocols and cipher suites are currently enabled and disabled. The Clarify Serverserver.logfile can be viewed by:
1) Viewing theserver.logfile within a Clarify Studio that is connected to the particular Clarify Server (or)
2) Directly viewing the Clarify Serverserver.logfile by locating the file:
<Clarify Runtime Workspace Directory>\nodes\workspace\logs\server.log
(the log file can be viewed using om a text editor)
Each time the Clarify Server starts logging to this file occurs. To locate this logging, look for the timestamps near the most recent time that the Clarify Server was started (if the Clarify Server was just started you should be able to look near the most recent timestamps at the end of the file). Alternatively you can do a text search in the log file for the text:
[com.extol.application.util.server.JettyLauncherImpl] Jetty Server dump:
Or just simply:Jetty Server dump:
The logging will look like the following example:
Scroll down approximately 40-50 lines until you see a section that looks like the following:
Notice in this example above the title Protocol Selections, followed by Enabled and several protocol names, and Disabled followed by several protocol names. This indicates which SSL protocols are currently enabled and disabled in the Clarify Server.
Disabling specific protocols and/or cipher suites
Configuration settings will be edited in theSSLConfig.propertiesfile, which can be found here:
<Clarify Runtime Workspace Directory>\resources\config\server\misc
The following optional properties can be added:
ssl.webservice.provider.protocols.exclude
This optional property allows for the specifying of a comma-separated list of protocols to exclude from use by SSL web service communications.Note: this list is subtractive; that is, whatever protocols are currently enabled in the Clarify Server, items specified on this list will simply be removed from the list of enabled protocols.
Here is an example of adding this property to exclude the SSLv3 and TLSv1 protocols from use:
ssl.webservice.provider.protocols.exclude = SSLv3, TLSv1
ssl.webservice.provider.ciphers.exclude
This optional property allows for the specifying of a comma-separated list of cipher suites to exclude from use by SSL web service communications.Notethat this list is subtractive; that is, whatever cipher suites are currently enabled in the Clarify Server, items specified on this list will simply be removed from the list of enabled cipher suites.
Here is an example of adding this property to exclude the following cipher suites from use:ssl.webservice.provider.ciphers.exclude = SSL_RSA_WITH_RC4_128_MD5, SSL_RSA_WITH_RC4_128_SHA
BEST PRACTICE: The use of these two properties is the recommended best practice for most common scenarios of manipulating the enabled/disabled protocols and cipher suites.
Once you have completed modifications to theSSLConfig.propertiesfile, save the changes and restart the Clarify Server for the configuration settings to take effect. Once the Clarify Server starts up, you should confirm that your changes have been applied. Follow the process outlined in the topic above: Determining which protocols and/or cipher suites are currently enabled/disabled
Advanced settings - Specifying exhaustively the only protocols and cipher suites to enable
In addition to the two properties to exclude protocols and cipher suites from use, there are two advanced property settings that allow for the configuration of only the specific protocols and cipher suites that are to be enabled. Note that these settings differ in behavior from the two *.exclude properties explained above: while the *.exclude properties behave in a subtractive manner, the two *.include properties explained in this section behave in an exhaustive manner; that is, ONLY the protocols / cipher suites listed in these properties will be enabled for use.
The file in which the configuration settings need to be made is:
<Clarify Runtime Workspace Directory>\resources\config\server\misc\SSLConfig.properties
The following optional properties can be added:
ssl.webservice.provider.protocols.include
This optional property allows for the specifying of a comma-separated, exhaustive list of protocols to include for use by SSL web service communications. Note well that this list is exhaustive; that is, ONLY the protocols that are specified in this list will be enabled for use in the Clarify Server; all other protocols will be disabled.
An example of adding this property to ONLY use TLSv1.1 and TLSv1.2 protocols would be as follows:
ssl.webservice.provider.protocols.exclude = TLSv1.1, TLSv1.2
All other protocols aside from the two specified in this property would be disabled.
ssl.webservice.provider.ciphers.include
This optional property allows for the specifying of a comma-separated, exhaustive list of cipher suites to include for use by SSL web service communications. Note well that this list is exhaustive; that is, ONLY the cipher suites that are specified in this list will be enabled for use in the Clarify Server; all other cipher suites will be disabled.
An example of adding this property to ONLY use and protocols would be as follows:
ssl.webservice.provider.ciphers.include = TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256
All other cipher suites aside from those listed in this property would be disabled.
Once you have completed modifications to theSSLConfig.propertiesfile, save the changes and restart the Clarify Server for the configuration settings to take effect. Once the Clarify Server starts up, you should confirm that your changes have been applied. Follow the process outlined in the topic above: Determining which protocols and/or cipher suites are currently enabled/disabled
View ArticleIssue: The customer was migrated yesterday from ESX to Lexicom, today when his NCR programs run he is getting a ton of Receive errors.Resolution: The customer recently moved to an iASP. I had asked if the IFS was in the iASP and had no response so the QSYS.LIB directory string was kept as normal in the *FTP_VL scripts. He was getting receive errors on the CPYFRMSTMF command because it could not find QSYS.LIB...... Further investigation I found that the IFS is in the iASP and the QSYS.LIB needed to be as follows:'/IASPHA/QSYS.LIB/EXT_FTP.LIB/VLIN.FILE/VLIN.MBR/' The IASPHA is the name of the iASP on the customer's system. To find the name of an iASP run DSPLIB over EXTSYSF and the iASP name will be displayed in the Library ASP Device.I went in and added the name of the iASP to both the send and receive scripts for network *FTP_VL*NOTE only the '/QSYS.LIB needs the iASP name in front of it, not the other directories.
*NOTE also when running the DSPLIB if the value in Library ASP Device is *SYSBAS, an iASP is not being used.
View ArticleThe AS2 standard provides the ability tosecurely transport EDI (and other data, including binary and XML) to a remote host.
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 Message Disposition Notification receipt (MDN) further guarantees that the intended trading partner has received the message.
AS2 uses the HTTP protocol as its transport mechanism to send files over the Internet.CleoVersaLexsoftware uses thePUT(HTTP POST) action command to transport the secure data to the remote host.
CleoVersaLexsoftware supports AS2 versions 1.0, 1.1 and 1.2.
AS2 Process Map
This section outlines the configuration necessary to set up the Generic AS2 host.
AS2 Configuration
Acquiring your trading partner's signing and encryption certificates
Determining and providing your URL information
Creating and providing your signing/encryption certificates
Complete configuration of:
Local Listener
AS2 Host Configuration
AS2 Mailbox Configuration
Composing an action
Testing Your AS2 Installation
AS2 Configuration
A host describes the remote server of your trading partner to which messages will be sent. The host's parameters specify its location and how it is reached. Your remote trading partner should provide information to you in the form of a URL, which is used to configure the host parameters.
To configure a generic AS2 pre-configured host:
Click theTemplatestab in the tree pane.
If necessary, expand theHoststree in theTemplatestab to find the host you want to use.
Right-click thehostand selectClone and Activate.
The entire pre-configuredhostbranch (including a mailbox and actions) is copied and activated, theActivetab is selected in the tree pane, and the new activehostis 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.
Click the new host in the tree pane.
Enter host-level configuration information on the tabs in the content pane. See AS2 Host Configuration.
ClickApplyto save your work.
Enter mailbox-level configuration information.
Click the mailbox under your host in the tree pane.
Enter mailbox-level configuration information on the tabs in the content pane. See AS2 Mailbox Configuration.
ClickApplyto save your work.
Enter action-level configuration information.
Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and selectNew Action.
Edit action information on the tabs in the content pane. See AS2 Action.
ClickApplyto save your work.
ClickApplyto save your work.
Important:If you leave any of these panels without clickingApply, your work will not be saved. You can configure the product to prompt to you clickApplyif 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 clickApplyand your updates will not be saved.
AS2 Host Configuration
A host describes the remote server of your trading partner to which messages will be sent. The host's parameters specify its location and how it is reached. Your remote trading partner should provide information to you in the form of a URL, which you will use to configure the host parameters.
This section describes how to configure a generic AS2 pre-configured host.
AS2 Host: General Tab
Server Address
Either a fully qualified name (recommended) or an IP address.
This is the address of your trading partner's server that will receive your messages.
Port
The port on the server where your trading partner will receive your messages.
Default value:80for HTTP and443for HTTPs (SSL)
Connection Type
The kind of connection you want to use for this host.
Possible values:
System Default- See for information about setting the system default.
Direct Internet Access or VPN- Use either a direct connection to the internet or a VPN.
Default value:System Default
Forward Proxy
The address of the forward proxy you want to use for this host.
Select theSystem Defaultcheck box to use the default proxy. See Specifying default host directories 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 theCleo VLTraderandCleo Harmonyapplications, 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 theVersaLexapplication and not shown here.
Inbox
Default directory for incoming files. Enter a value directly or clickto 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 clickto 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 clickto 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 clickto navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
AS2 Host: AS2 Tab
Partner Is CEM-Capable
Specifies whether the trading partner is capable of sending and receiving certificates through Certificate Exchange Messaging (CEM) and allows you to enableSendinCertificate Exchange. See Exchanging certificates with your trading partner.
Possible values:
True: Indicates your trading partner specifies their AS2 product is capable of processing CEM messages but they have not yet sent messages with the header designating their AS2 product's CEM capability.
Note:This field should only be manually set toTrueif your trading partner has specifically stated that their AS2 product is CEM-Capable.
False: Indicates your trading partner is not CEM-capable. However, when messages are received from a trading partner with the appropriate header designating that it is CEM-capable, this value is automatically changed toTrue.
False and Ignore Further Detection: Indicates your trading partner is not CEM-capable and disables automatic updating of this value based on inbound trading partner messages.
Default value:False
Override AS2 Service Filename Preservation MDN Response Settings
UseOverride AS2 Service Filename Preservation MDN Response Settingsto select settings different from the system settings defined in theAS2 Service > AS2 Tab(see Configuring AS2 Service,) and then useGenerate Filename Preservation MDN Responsesto toggle Filename Preservation for this trading partner.
Filename Preservation is a feature designed for trading relationships requiring stringent file-naming rules. AS2 products complying with Filename Preservation use theContent-Dispositionheader within the message payload to name the file and when this feature is enabled, a file name must be included in the payload and must conform to specific file-naming rules. Additionally, this feature detects when a file name has already been used within a designated period of time (defined in the AS2 Service: AS2 Tab ) and alerts the trading partner with the appropriate warning or error disposition in the returned MDN.
When selected and different from the system setting, theDuplicate Filename Actionis also enabled, allowing the following choices:
Retain as Unique, Return Warning: A warning will be returned to the trading partner in the MDN, the message payload will be stored in therejectboxsubdirectory (it will not be made available for back-end processing) and an error will be logged.
Reject Payload, Return Error:An error will be returned to the trading partner in the MDN, no payload will be stored and an Exception will be logged.
Note:WheneverGenerate Filename Preservation MDN Responsesis selected (either using or overriding the system setting),Overwrite duplicate file namesandUse default file nameare disabled.
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 cleared, incoming files with the same name as one that already exists will be appended with a unique number beginning with 1 and incremented each time a new file is saved.
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 (i.e., / 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 for sorting of incoming messages based on content-type to a subdirectory (under the Inbox specified on theGeneraltab).Specify each of the Content-Types that you would like directed to specific subdirectories by entering a name in theDirectoryfield. Directory entries may be made for Content-Types of: EDIFACT, X12, XML, Binary, Plain Text, EDI Consent and Other (a default catch-all for messages with all other Content-Types you could receive). The same subdirectory can be used for multiple Content-Types.You can also leave Directory entries blank, which will cause any received messages of that Content-Type to be stored in the Inbox specified on theGeneraltab.
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 will be placed in the specified folder based on the content type specified in the HTTP header of the message. TheVersaLexapplication does not check the actual content of the message to determine its content type.
AS2 Host: HTTP Tab
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 selectCheck 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 theCONNECTcommand 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 validMethodfor AS2 commands isPUT("POST").
Path
The serverPathfor thePUTcommand.
If the remote server is also using theVersaLexapplication, the path is either/as2for newer installations or/for older installations. The resource path must be properly specified in order for your trading partners AS2 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, noParametersare specified for sending AS2 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
At a minimum, the followingHeadersmust always be specified in order to properly send AS2 messages:
AS2-From- the alias of the sender of the AS2 message.
AS2-To- the alias of the receiver of the AS2 message.
Note:TheAS2-From/AS2-Tofields are determined and agreed upon as part of the initial setup of the trading relationship. These fields could be company-specific, such as DUNS number, or could simply be an agreed-upon identification string.TheAS2-From/AS2-Tocombination is case-sensitive and must be unique across all hosts defined in your system, since this combination is used to determine into which Inbox messages are stored when received from remote hosts.
Subject- identifies the message and is returned in the human-readable section of an MDN, if requested.
Content-Type- specifies the format of the message being sent and is used by the sending and receiving applications to properly assemble and parse the message. Currently supported content types (in the pull-down menu) are:
EDIFACT
X12
XML
Binary
Plain Text
EDI Consent
Note:Entering a value for theContent-Typeheader is optional. IfContent-Typeis not specified or if multiple payloads are attached in the message, theContent-Typeis detected based first on file content and then the file extension.Detectable types includeapplication/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, andvideo/mpg.
These header fields are filled in at the Mailbox or Action level and specify values to be set in the HTTP headers that precede the body (actual content) of the message to be sent.
AS2 Host: Advanced Tab
The host'sAdvancedtab contains several property settings fields. These settings typically do not affect your ability to connect to a host. However, you might want to change some of these settings when configuring a runtime environment.
See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for AS2 include:
Add Mailbox Alias Directory to Inbox
Appends a subdirectory at the end of the host's configured inbox directory. This allows files received through different mailboxes to be kept separate.
Possible values:OnorOff
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:OnorOff
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:OnorOff
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:OnorOff
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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
Default value:On
Allow Duplicate Incoming Message IDs
Ignores messages with duplicate message IDs and allows reprocessing of the message.
Possible values:OnorOff
Default value:Off
Async MDN Preferred Port
When non-zero, defines the preferred port on which asynchronous MDNs will be returned from the trading partner.
Note:This setting will always override any port settings defined on the Listener and AS2 Service panels; and VLProxys reverse-proxy port, if applicable.
Possible values:165535
Default value:0
Async MDN Resends
When sending a payload that has requested an asynchronous MDN, specifies the maximum number of attempts that will be made to resend the payload after the specified Async MDN Timeout has been exceeded and the MDN has still not been received.
When returning an asynchronous MDN in response to a received payload, specifies the maximum number of attempts that will be made to resend the asynchronous MDN to the trading partner (e.g., when the outbound connection cannot be established).
Possible values: Any value-1,0or> 0. When set to a value other than the default (-1), this value overrides the setting in the Local Listener.
Default value:-1
Async MDN Retry Delay
When resending an asynchronous MDN because the initial attempt to send it has failed, specifies the number of seconds to wait in between those resend attempts.
Possible values: Any value0or> 0
Default value:60
Async MDN Timeout
The maximum time (in minutes) to wait for an asynchronous MDN to be received before either resending the payload (if Async MDN Resends > 0 in either the Host or Listener) or logging an error.
Possible values: Any value-1,0or> 0. When set to a value other than the default (-1), this value overrides the setting in the Local Listener.
Default value:-1
Base64 Encode Content
Base64is the encoding format used by Multi-purpose Internet Mail Extension (MIME) for transmitting non-text material over text-only communications channels. Base64 is based on a 64-character subset of US-ASCII, enabling 6 bits to be represented per printable character.
Possible values:OnorOff
Default value:Off
Canonicalize Inbound Signed Content
When this option is selected, a canonicalizer is used to ensure that \r and \n characters always occur together as \r\n. This option may be used when the inbound signature hash verification fails and the trading partner is using OpenSSL to sign its messages.
Possible values:OnorOff
Default value:Off
Command Retries
If an error or exception occurs during a command, the number of times the command should be retried.
Note:Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
Possible values:0-n
Default value:0
Compression- Signing Order
When both signing and compression are enabled, indicates which is applied first.
Possible values:Sign then compressorCompress then sign
Default value:Sign then compress
Connection Timeout
The amount of time allowed for each read operation.
Possible values:0-nseconds
0indicates no timeout
Default value:150seconds
Delete Zero Length Files
Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
Possible values:OnorOff
Default value:Off
Disable TE Headers
When selected, disables the TE and Transfer Encoding request headers.
Possible values:OnorOff
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-DELoption is being used, any zero length file ignored will also be deleted.
Possible values:OnorOff
Default value:Off
Email On Check Conditions Met
Send an email notification after running aCHECKcommand where the overall conditions of the check are met. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Check Conditions Not Met
Send an email notification after running aCHECKcommand where the overall conditions of the check arenotmet.See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Fail
If an error occurs during a command, email the error condition. See Email/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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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:OnorOff
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:OnorOff
Default value:On
Email On Successful Copy
Send an email notification after copying a file usingLCOPY. 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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (if set).
Execute On Check Conditions Met
After executing aCHECKcommand where the overall conditions are met, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Check Conditions Not Met
After executing aCHECKcommand where the overall conditions arenotmet, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Possible values: System command to be executed.
Default value: The valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Repetitive Action Failures
WhenExecute On Failis enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, theExecute On Failcommand will be executed again. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Repetitive Listener Failures
WhenExecute On Failis enabled and the same failure occurs each time an inbound message is processed by the Listener for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after every system restart if the failure occurs again. If the failure can be associated with a specific host, theExecute On Failcommand will be executed again when the failure is resolved. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure. Executions of the "Execute On Fail" command for resolution of general Listener failures will not be done since it is not possible to determine that these types of failures have been resolved.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Successful Copy
After successfully copying a file usingLCOPY, 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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values:0toncharacters.
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:OnorOff
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:OnorOff
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:OnorOff
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 toConfigure > Options > Otherto set theHigh Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Warning:If the trading partners bandwidth (and notCleo Harmony's orCleo VLTraders) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down otherCleo HarmonyorCleo VLTradertransfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance ofCleo HarmonyorCleo VLTraderis 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:OnorOff
Default value: The value specified for this property on theOptions > Advancedpanel
LCOPY Archive
If specified, contains the directory for archivingLCOPYsource 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 theOptions > Advancedpanel, 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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
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 theOptions > Advancedpanel, 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 theOptions > Advancedpanel, 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 of0does 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 of0does 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 aPUTcommand. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab takes precedence. ForAlphabeticalordering, 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
IfFixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values:OnorOff
Default value:Off
Override Listener CEM Auto Accept Setting
When selected, overrides theAuto Accept Received Certificate (CEM)Advanced setting in the Listener allowing auto accepting of CEM requests to be allowed or disallowed on a per host basis. See Exchanging certificates with your trading partner.
Possible values:OnorOff
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 aCleo LexiComonly option. ForCleo HarmonyandCleo 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 theMailbox Packagingtab. See Configuring mailbox packaging.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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:OnorOff
Default value:On
PGP Signature Verification
Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. In general, this property should be enabled.
Possible values:OnorOff
Default value:On
PGP V3 Signature
Put Multiple Files Limits
Limits the number of files included in each generated multipart message when using thePUT -MULoption. 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
-1indicates 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 aSocketTimeoutExceptionoccurs.
Possible values:OnorOff
Default value:Off
REST Enabled
Allows the host to be accessible through the REST API. This feature is only supported onAS2,AS4,FTPandSSH FTPandonly 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:OnorOff
Default value:OnforAS2.AS4,FTPandSSH FTPwhen the host has exactly one mailbox.Offin all other cases.
Resume Failed Transfers
When selected and a transfer fails (and Command Retries > 0), attempt to resume the transfer on a retry. If OpenPGP is enabled on the packaging tab (see Configuring mailbox packaging ), the entire file is transferred instead of resuming with a partial file. The server must support theFEAT,SIZE, andREST STREAMextensions to FTP. For more information, visit http://tools.ietf.org/html/rfc3659.
Possible values:OnorOff
Default value:Off
Retain Temporary Inbound Message Files
Leaves any files that are used while processing inbound messages in thetemp\folder. The default action is to delete these files after processing has completed. These files may be helpful for problem diagnosis.
Note:These temporary files are retained for seven days.
Possible values:OnorOff
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
RSA-OAEP Key Algorithm Parameter
Represents the type of mask generation and hash generation functions that are applied when theRSAES-OAEPkey algorithm is in use. See RFC4055 for a further description of the mask and hash generation functions.
Possible values:MGF1-SHA1,MGF1-SHA256,MGF1-SHA512
Default value:MGF1-SHA1
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:OnorOff
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 thatCleo Harmony,Cleo VLTrader, orCleo LexiComwill 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 of0to112,128, or256(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabledexception to occur.
Possible values:0-nbits
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:OnorOff
Default value:On
Store Raw Sent Message
When this property is enabled, a copy of the outbound message is stored in the HTTP/sent directory.
Possible values:OnorOff
Default value:Off
Terminate On Fail
If an error occurs during a command, stop the action.
Note:
Regarding non-CHECKcommands: WhenTerminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.
RegardingCHECKcommands:Terminate On Failis only honored if theConditionsMetparameter is set and the result of theCHECKis classified asError. TheCHECKcommand is only available in theCleo HarmonyandCleo VLTraderapplications.
Possible values:OnorOff
Default value:On
Unzip Use Path
Indicates whether or not zip entry paths should be used forLCOPY -UNZIPoperations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
Possible values:OnorOff
Default value:On
Use Content Type For File Extension
By default, inbound messages that do not specifically contain the name of the target file to be saved are stored using the value of theMessage-ID(of that message) with the.fileextension. When this option is selected, inbound messages without a target file name specifier is stored using theMessage-IDand the appropriate file extension based on the Content-Type of the message.
Possible values:OnorOff
Default value:
Offfor existing hosts
Onfor newly cloned hosts
Use Folded Headers For Outbound Messages
Enables or disables automatic line wrapping of HTTP headers exceeding 76 characters. By default headers are not folded since some non-Cleo product remote hosts using Microsoft Internet Information Server (IIS) cannot handle folded headers properly. Unless your host has been pre-configured to enable folded headers, leave this setting cleared!
Possible values:OnorOff
Default value:Off
Wait For Execute On
Indicates whether execution should wait for processing to complete within anExecute On Fail,Execute On Successful Copy,Execute On Successful Receive, orExecute On Successful Sendcommand. Note that this option does not apply to native AS400 execution.
Possible values:OnorOff
Default value:On
XML Encryption Algorithm
The method used to encrypt/decrypt files when XML Encryption packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 inLCOPY -ZIPoperations.
Default value: The value specified for this property on theOptions > Advancedpanel, if set.
Zip Compression Level
Controls the level of compression forLCOPY -ZIPoperations.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtakes precedence
Possible values:
System Default
9- (Best Compression)
8
7
6
5
4
3
2
1
0- (No Compression)
Default value: SystemDefault
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled forLCOPY ZIP RECoperations. 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:OnorOff
Default value:On
AS2 Mailbox Configuration
A mailbox's parameters allow you access to the remote host and define the security of the file being sent.You can use the AS2 mailboxwizard to configure for the most common setup. See Using the wizard to create a host or mailbox. The following sections describe the mailbox parameters.
AS2 Mailbox: AS2 Tab
The mailbox'sAS2tab allows you to select the desired encryption and signing for sending messages and the optional desired security for receiving messages. If an MDN receipt is desired, you can also select the format and delivery method of that receipt.
Request
Specify the S/MIME format for messages to send to the remote host.
Unsigned / unencrypted (neitherEncryptednorSignedselected)
Signed (onlySignedselected)
Encrypted (onlyEncryptedselected)
Signed / Encrypted (bothSignedandEncryptedselected)
Receipt
Enables theMDN Receiptsection. See MDN Receipt.
Encryption Algorithm
WhenEncryptedis selected, theEncryption Algorithmfield is enabled and allows you to choose the encryption algorithm for the message to be sent to the remote host.The remote host must be able to decrypt the message using the algorithm you choose. For a non-VersaLextrading partner, it is important to verify that your trading partner can use the selected algorithm prior to sending an encrypted message. The default encryption algorithm isTripleDES. See Cryptographic Services for more information on choosing an encryption algorithm.
Key Algorithm
WhenEncryptedis selected, theKey Algorithmfield is enabled and allows you to choose the algorithm to encrypt the content encryption key with the public key of your trading partners encryption certificate. Your trading partner uses the private key of their encryption certificate to decrypt the content encryption key that is subsequently used to decrypt the content of the message.
Possible values:
RSA(default)
RSAES-OEAP
Signature Algorithm
WhenSignedis selected, theSignature Algorithmis used to encrypt the hash value of the signature with the private key of your signing certificate. Your trading partner uses the public key of your signing certificate to decrypt the hash value of the signature that authenticates you as the sender of the message. WhenRSAis selected, the selectedHash/MIC Algorithmis used to determine the appropriate signature algorithm, for example,rsaEncryption,sha256WithRSAEncryption,sha384WithRSAEncryptionorsha512WithRSAEncryption. IfRSASSA-PSSis selected, the combination of the private key of your signing certificate and the hash algorithm is used in conjunction with the RSASSA-PSS algorithm to secure the signature.
Possible values:
RSA(default)
RSASSA-PSS
Hash/MIC Algorithm
When theSignedoption in theRequestsection is selected, the combination of the signature algorithm and the selected hash algorithm is used to secure the signature.
Note:If the RSASSA-PSS signature algorithm is used and the SHA-512 hash algorithm is selected, the strength of the signature algorithm of your signing certificate must be SHA256withRSA or better.
When the Signed option in the MDN Receipt section is selected, the selected Hash/MIC Algorithm is used to compute the independent Message Integrity Check (MIC) that is returned in the MDN Receipt.
Possible values:
SHA-1(default)
MD5(cryptographically weak and should not be used unless no other Hash/MIC algorithm is available)
SHA-256
SHA-384
SHA-512
Compress Content
Compresses the message using ZLIB compression. Compression is generally used for large files so that the message will conserve bandwidth and be transferred more efficiently and securely over the Internet.
Inbound Message Security
Indicates how inbound messages should be received.
Select any combination ofForce Encryption,Force SignatureandForce MDN Signatureto check the level of inbound message security. If the message is not received according to the corresponding message security settings, the message is rejected and an error is logged.
By default, no settings are selected. If no settings are selected, the security level of the message is not checked.
See AS2 Checklist, item 13 for determining the type of request being sent.
MDN Receipt
Attributes of the Message Disposition Notification (MDN) receipt you requested.
Message Disposition Notifications can be returned Synchronously (as part of the same HTTP session, that is, the MDN is returned during the acknowledgement phase of the message response) or Asynchronously (as part of a new HTTP session, that is, just the HTTP status message is returned during the acknowledgment phase of the message response and the MDN is returned later in a separate HTTP POST message.) The receiver must be capable of handling the specified delivery method; some non-VersaLexhosts may not be able to return either a synchronous or asynchronous MDN.This information must be obtained and noted during the initial set-up of the trading relationship.VersaLexcan handle either method of delivery.
Signed
Compute and remember an independent hash over the content of the sent message using the Hash/MIC Algorithm you select. The trading partner returns the MDN with a digital signature; and computes an independent MIC value over the content of the message it received (using the same MIC algorithm) and returns this value as a base64-encoded value in the human-readable portion of the MDN. When the MDN is received, the original MIC is compared against the received MIC. When the MIC values match, the sender is guaranteed that the message read by the trading partner is identical to the message that came from the sender and was not modified in any way.
Forward MDN to Email
Forward a copy of the MDN received via HTTP or HTTPS (either synchronously or asynchronously) to the email address specified in theEmail Addressfield. When the asynchronous SMTP option is selected, theForward MDN to Emailfield is disabled.
An additional feature available inVersaLexis the ability to forward a copy of the MDN received via HTTP or HTTPS (either synchronously or asynchronously) to an email recipient whenForward MDN to Emailis selected.
Synchronous
Return the MDN as part of the same HTTP session, that is, the MDN is returned during the acknowledgment phase of the message response. You must determine whether the receiver can handle this delivery method and plan accordingly.
Asynchronously
Return the MDN as part of a new HTTP session, that is, just the HTTP status message is returned during the acknowledgment phase of the message response and the MDN is returned later in a separate HTTPPOSTmessage.
When you selectAsynchronous, you can choose the method used to process the message returned:
HTTP: The MDN is received and processed by the local non-secure listener configured in the Local Listener Panel.
HTTPS: The MDN is received and processed by the local SSL listener configured in the Local Listener Panel.
SMTP: The MDN is emailed to the trading partner.
Note:When you selectSMTP, you must provide theEmail Addresswhere the MDN will be sent. TheEmail Addressfield is only enabled for editing when you selectSMTPas the delivery method.
See AS2 Checklist, items 17 and 18, for determining the MDN delivery method.
See AS2 Checklist, items 15 and 16, to determine the type of MDN response that will be requested.
AS2 Mailbox: Certificates Tab
Use this tab to associate a trading partner's signing and encryption certificateswith 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. Specify a value or clickBrowseto navigate to the file you want to select.
Signing Certificate
Select the check box to enable the field.
The name of the file containing your Trading Partner's signing certificate. Specify a value or clickBrowseto navigate to the file you want to select.
If you do not specify a signing certificate, theVersaLexapplication uses all the certificates in its certificate store to determine if the signature of the incoming data message is trusted.
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, theSigning Certificatefield is populated with the same certificate you selected in theEncryption Certificatefield.
If the remote host is capable of receiving Certificate Exchange Messages (CEM) or you want to email your certificates to your trading partner, you can send your user and SSL certificates to the remote host by clickingExchange Certificates.
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 theVersaLexapplication 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.
ClickBrowseto view and select a certificate. Enter thePasswordfor your signing certificate's private key.
Encryption Certificate Alias
The certificate for decrypting your trading partners messages, if you have created or obtained a separate certificate.
ClickBrowseto view and select a certificate. Enter thePasswordfor your encryption certificate.
Use signing certificate
Select thi
View ArticleThe ebXML Message Service (ebMS) standard provides the ability to securely transport EDI (and other data, including binary and XML) to a remote host.
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 theTemplatestab in the tree pane.
If necessary, expand theHoststree in theTemplatestab to find the host you want to use.
Right-click thehostand selectClone and Activate.
The entire pre-configuredhostbranch (including a mailbox and actions) is copied and activated, theActivetab is selected in the tree pane, and the new activehostis 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.
Click the new host in the tree pane.
Enter host-level configuration information on the tabs in the content pane. See ebXML Host.
ClickApplyto save your work.
Enter mailbox-level configuration information.
Click the mailbox under your host in the tree pane.
Enter mailbox-level configuration information on the tabs in the content pane. See ebXML Mailbox.
ClickApplyto save your work.
Enter action-level configuration information.
Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and selectNew Action.
Edit action information on the tabs in the content pane. See ebXML Action.
ClickApplyto save your work.
ClickApplyto save your work.
Important:If you leave any of these panels without clickingApply, your work will not be saved. You can configure the product to prompt to you clickApplyif 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 clickApplyand your updates will not be saved.
ebXML Host
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 theGeneraltab typically remain unchanged unless you need to connect through a forward proxy or change theDefault 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. If no port number is included in your trading partner's URL, default values are assumed.
Default value:80for HTTP and443for 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 theSystem Defaultcheck 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 theCleo VLTraderandCleo Harmonyapplications, 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 theVersaLexapplication and not shown here.
Inbox
Default directory for incoming files. Enter a value directly or clickto 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 clickto 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 clickto 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 clickto navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
ebXML Host: ebXML Tab
Store raw sent
Save the content of the HTTP header and raw (unprocessed) message sent to the remote host. The files are stored in theebXML\sent+receiveddirectory under the root path. These files can be useful in diagnosing problems, but should be disabled if disk space needs to be conserved. ClickResendto 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 theGeneraltab.Specify each of the Content-Types you want to direct to specific subdirectories by entering a name in theDirectoryfield. 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 theGeneraltab.
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. TheVersaLexapplication does not check the actual content of the message to determine its content type.
ebXML Host: CPA Tab
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), selectOverride Local Listener\ebMS CPAcheck box and supply alternate values.
ebXML Host: HTTP Tab
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 selectCheck 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 theCONNECTcommand 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 validMethodfor AS2 commands isPUT("POST").
Path
The serverPathfor thePUTcommand.
If the remote server is also using theVersaLexapplication, the path is/ebMS. The resource path must be properly specified in order for your trading partners 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, noParametersare specified for sending ebMS 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
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 onlyHeaderrequired is theSOAPAction: "ebXML"header.Content-Type:is optional and can be specified at the mailbox and/or action level.
Note:Entering a value for theContent-Typeheader is optional. IfContent-Typeis not specified or if multiple payloads are attached in the message, theContent-Typeis detected based first on file content and then the file extension.Detectable types includeapplication/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, andvideo/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'sAdvancedtab 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:
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:OnorOff
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:OnorOff
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:OnorOff
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:OnorOff
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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
Default value:On
Always Send Multipart Messages
Indicates to always send a multipart MIME message to the trading partner, even when there is only one attachment in the message.
Possible values:OnorOff
Default value:On
Async Ack Resends
Specifies the number of attempts that will be made to resend a transaction for which the asynchronous acknowledgment has not been received within the specified timeout period.
Possible values: Any value-1,0or> 0. When set to a value other than the default (-1), this value overrides the setting in the Local Listener.
Default value:-1
Async Ack Timeout
The maximum time (in minutes) to wait for an asynchronous acknowledgment before either resending the transaction (if Async Ack Resends > 0 in either the Host or Listener) or logging an error.
Possible values: Any value-1,0or> 0. When set to a value other than the default (-1), this value overrides the setting in the Local Listener.
Default value:-1
Command Retries
If an error or exception occurs during a command, the number of times the command should be retried.
Note:Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
Possible values:0-n
Default value:0
Compression- Signing Order
When both signing and compression are enabled, indicates which is applied first.
Possible values:Sign then compressorCompress then sign
Default value:Sign then compress
Connection Timeout
The amount of time allowed for each read operation.
Possible values:0-nseconds
0indicates no timeout
Default value:150seconds
Conversation Id XML Payload Element
When set, indicates the element name or names in the XML payload whose value should be used as the ebMSConversationIdvalue. 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:OnorOff
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-DELoption is being used, any zero length file ignored will also be deleted.
Possible values:OnorOff
Default value:Off
Email On Check Conditions Met
Send an email notification after running aCHECKcommand where the overall conditions of the check are met. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Check Conditions Not Met
Send an email notification after running aCHECKcommand where the overall conditions of the check arenotmet.See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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:OnorOff
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:OnorOff
Default value:On
Email On Successful Copy
Send an email notification after copying a file usingLCOPY. 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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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:OnorOff
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:OnorOff
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 acorxto indicate whether the value following the prefix should be treated as a character or hexadecimal string, respectively.
Execute On Check Conditions Met
After executing aCHECKcommand where the overall conditions are met, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Check Conditions Not Met
After executing aCHECKcommand where the overall conditions arenotmet, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Possible values: System command to be executed.
Default value: The valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Repetitive Action Failures
WhenExecute On Failis enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, theExecute On Failcommand will be executed again. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Repetitive Listener Failures
WhenExecute On Failis enabled and the same failure occurs each time an inbound message is processed by the Listener for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after every system restart if the failure occurs again. If the failure can be associated with a specific host, theExecute On Failcommand will be executed again when the failure is resolved. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure. Executions of the "Execute On Fail" command for resolution of general Listener failures will not be done since it is not possible to determine that these types of failures have been resolved.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Successful Copy
After successfully copying a file usingLCOPY, 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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values:0toncharacters.
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:OnorOff
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:OnorOff
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:OnorOff
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 toConfigure > Options > Otherto set theHigh Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Warning:If the trading partners bandwidth (and notCleo Harmony's orCleo VLTraders) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down otherCleo HarmonyorCleo VLTradertransfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance ofCleo HarmonyorCleo VLTraderis 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:OnorOff
Default value: The value specified for this property on theOptions > Advancedpanel
LCOPY Archive
If specified, contains the directory for archivingLCOPYsource 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 theOptions > Advancedpanel, 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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
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 theOptions > Advancedpanel, 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 theOptions > Advancedpanel, 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 of0does 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 of0does 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 aPUTcommand. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab takes precedence. ForAlphabeticalordering, 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
IfFixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values:OnorOff
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 aCleo LexiComonly option. ForCleo HarmonyandCleo 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 theMailbox Packagingtab. See Configuring mailbox packaging.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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:OnorOff
Default value:On
PGP Signature Verification
Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. In general, this property should be enabled.
Possible values:OnorOff
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 thePUT -MULoption. 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
-1indicates 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 aSocketTimeoutExceptionoccurs.
Possible values:OnorOff
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:OnorOff
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:OnorOff
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:OnorOff
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:OnorOff
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 thatCleo Harmony,Cleo VLTrader, orCleo LexiComwill 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 of0to112,128, or256(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabledexception to occur.
Possible values:0-nbits
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:OnorOff
Default value:On
Terminate On Fail
If an error occurs during a command, stop the action.
Note:
Regarding non-CHECKcommands: WhenTerminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.
RegardingCHECKcommands:Terminate On Failis only honored if theConditionsMetparameter is set and the result of theCHECKis classified asError. TheCHECKcommand is only available in theCleo HarmonyandCleo VLTraderapplications.
Possible values:OnorOff
Default value:On
Unzip Use Path
Indicates whether or not zip entry paths should be used forLCOPY -UNZIPoperations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
Possible values:OnorOff
Default value:On
Wait For Execute On
Indicates whether execution should wait for processing to complete within anExecute On Fail,Execute On Successful Copy,Execute On Successful Receive, orExecute On Successful Sendcommand. Note that this option does not apply to native AS400 execution.
Possible values:OnorOff
Default value:On
XML Encryption Algorithm
The method used to encrypt/decrypt files when XML Encryption packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 inLCOPY -ZIPoperations.
Default value: The value specified for this property on theOptions > Advancedpanel, if set.
Zip Compression Level
Controls the level of compression forLCOPY -ZIPoperations.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtakes precedence
Possible values:
System Default
9- (Best Compression)
8
7
6
5
4
3
2
1
0- (No Compression)
Default value: SystemDefault
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled forLCOPY ZIP RECoperations. 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:OnorOff
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.
Encrypted
Enable or disable TripleDES encryption when sending messages. See Cryptographic Services for general information about encryption.
Signed
Enable or disable signing messages when sending them.
Ack
Enables theAcknowledgmentsection 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. IfSynchronous Replyis 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 whenForward Ack to Emailis selected.
Inbound Message Security
When you select any of the options in this section,
Force Encryption
Force Signature
When you selectForce EncryptionorForce 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 specifytoandfromroles 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 differentfromroles and/or different services.
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
Signing Certificate
The name of the file containing your Trading Partner's signing certificate. Specify a value or clickBrowseto navigate to the file you want to select.
If you do not specify a signing certificate, theVersaLexapplication 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 clickBrowseto 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, theSigning Certificatefield is populated with the same certificate you selected in theEncryption Certificatefield.
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.
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 theVersaLexapplication 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.
ClickBrowseto navigate to and select a certificate. Enter thePasswordfor your signing certificate's private key.
Encryption Certificate Alias
The certificate for decrypting your trading partners messages, if you have created or obtained a separate certificate.
ClickBrowseto navigate to and select a certificate. Enter thePasswordfor your encryption certificate.
Use signing certificate
Select this check box to use the same certificate for signing and decrypting your trading partner's messages. TheEncryption Certificate AliasandPasswordare populated to match theSigning Certificate Aliasand disabled.
Exchange Certificates
Invokes theCertificate Exchangedialog box. If you override the default the certificates, you must exchange these alternate certificates with your trading partner.
ebXML Mailbox: HTTP Tab
The mailbox'sHTTPtab allows you to assign aContent-Typefor the documents to be transferred.
You can include optional parameters in validContent-Typevalues by adding a semi-colon (;) after the value followed by thename=valuepair(s). Multiple parameters must be separated by semicolons. For example, to include a charset parameter for the XMLContent-Typevalue, edit the XML field like this:
XML; charset=utf-8
During the packaging phase of the message, the XML value is converted toapplication/xmland any optional parameters are appended. Parameters are only appended to theContent-Typeof the payload parts.
If aContent-Typeis not specified,VersaLexwill attempt to detect the content type.
ebXML Mailbox: Security Tab
If HTTP/s is specified in the host'sHTTPtab, 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 parametersdefine a unique identifier on the host system. By default, theTrading Partnerbranch 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 themailbox.
ebXML Action: Action Tab
Use theActiontab 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 firewallproblems 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 toLooptest ebXML.
Configure the ebXML Looptest host:
In the hostGeneraltab, set theServer Addressto "localhost" and thePort #to the Local Listener's HTTP port (usually 5080).
In the Local Listener ebXML Message Service hostCPAtab, set theCPA Idto "looptest" and set theTo Party Id(s)to match the Local Listener\ebMS CPAMy Party Id(s).
In the mailboxCPAtab, set theTo Roleto match the Local Listener\ebMS CPAMy Role. Also set theTo ServiceandTo Actionto match one of the Local Listener\ebMS CPAMy Service(s)andMy Action(s).
In the actionActiontab, change the PUT command's source file to be "test\test.edi" and remove the-DELoption.
In the actionActiontab, run the action. Messages similar to the ones shown below will appear in the messages pane in the lower portion of yourVersaLexapplication.
If signing and encryption is desired:
First export the Local Listener Signing and Encryption Certificate(s) into theVersaLexcerts\directory.
Then in the mailboxCertificatestab, set the Trading Partner's Certificates to these certificates.
In the mailboxebXMLtab, selectSignedandEncrypted.
In the actionActiontab, 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:
Directory
Purpose
ebXML\
TheebXML\ackdirectory contains subdirectories for received (and optionally sent) acknowledgments. This directory can be changed on the ebXML Message Service Panel. Acknowledgments can be automatically archived by the application or manually archived by the user from the "Acks" tab on the listener panel.Archived acknowledgments are stored inebXML\ack\received\archive\ack.ziporebXML\ack\sent\archive\ack.zip.
TheebXML\datadirectory contains an ebXMLmsgs.txt file that is used by the application to determine the receipt of duplicate messages. Entries in this file are retained for the time interval configured for the.
TheebXML\schemasdirectory contains XML schema (.xsd) files that describe the format of various ebXML documents.
TheebXML\sent+receiveddirectory contains "raw" (unprocessed) incoming and outgoing messages.These files can be helpful in diagnosing problems.Old files should be deleted or archived by the user, if necessary.
TheebXML\unsentdirectory contains raw header, data and message setup information files.These files are used if a message needs to be retransmitted and are deleted automatically by the application once the message transfer has either completed successfully or has failed due to timeouts, exceptions or exhausting the number of retries.
lostandfound\
Default inbox where incoming data will be deposited when the application cannot determine where to put it.
temp\
Temporary location where large incoming messages or compressed messages may be stored while they are being processed by the application.These are deleted automatically once the message has been completely processed.This directory is only created if large messages or compressed messages need to be processed.
View ArticleElectronic Banking Internet Communication Standard (EBICS) uses the HTTPs protocol as its transport mechanism to send files over the Internet.
VersaLex uses thePUTandGETaction commands, both usingHTTP POST, to transport the secure data to the remote banking server.All EBICS messages are encapsulated within XML packaging.In addition to SSL/TLS-level encryption, the package content is also encrypted.Within EBICS, there is strong usage of signatures, both hand-written and electronic.
EBICS has a client-server architecture, where the bank is theserverand the bank's customer (company or individual) is theclient.Within EBICS, the client uploads so-calledordersto the server and the server processes the orders.Order direction is classified as either anupload order, where the customer is sending payload to the server (e.g., order type IZV - upload of a domestic payment) or adownload order, where the bank is sending data to its customer (e.g., order type STA - download SWIFT daily accounts).Whether the order is an upload or download order, the transaction is always initiated from the client.
The EBICS specification classifies orders asbank-technicalorsystem-related(organizational or ancillary transfers).Bank-technical orders transfer specific data between the customer and bank (e.g., payments, statements, etc.).System-related orders are used for administrative details such key management or for bank-customer contractual information exchange.The EBICS specification defines many different order types that encompass both bank-technical and system-related orders.With the exception of a few system-related orders, the VersaLex EBICS client is not required to know or understand the content of the orders; it will simply transport the information without parsing the content. With VersaLex, all supported bank-technical orders are transmitted through theGETor PUTaction commands, and all supported system-related orders are transmitted through functions on theEBICS mailbox: EBICStab. See EBICS Mailbox.
While the EBICS specification calls for many different order types that can accommodate specific requests, the FUL and FDL orders are defined by the specification to support general uploads (FUL) and downloads (FDL).See the EBICS specification at www.ebics.org for details on order types.
Customers and Users
In the context of EBICS, acustomeris defined as the organizational unit that concludes a contract with the bank, and auseris defined as a human or technical system that is assigned to a customer.Customers are often also referred to aspartner, and users are often also referred to assubscriber.The customer/partner has aPartner IDto uniquely identify it, and the user/subscriber has aUser ID.The customer-user combination is tied to a mailbox, and their associated IDs are specified on theEBICS mailbox: EBICStab. See EBICS Mailbox. These IDs are sent with almost every initial request to the bank server.
Technical Subscribers
The EBICS specification explains the concept oftechnical subscribers.When requests are sent from a technical subscriber, the optional <SystemID> element is defined. Technical subscribers do not exist in the context of the VersaLex EBICS client, therefore, the <SystemID> element will never be specified.
Bank-Customers Contracts
Initially, a contract is established between a bank and a customer.The contract includes details such as the orders the customer can issue, which accounts are accessible, and signing permission level..All contractual details are outside of the EBICS specification and are therefore outside the scope of the VersaLex EBICS client.The management of these contractual details are maintained somewhere within the environment of the financial institution, and not within the VersaLex environment. Therefore, it is the responsibility of the financial institution to guard against unauthorized transactions. For example, if a certain VersaLex user is not authorized to issue a particular order, this transaction will ultimately be prevented when the bank server issues the appropriate return code (that is,EBICS_INVALID_USER_STATE) during the initialization phase of an order.
File-Based Transfers
All order data tranmissions are file-based. The VersaLex EBICS client, by default, ensures that all upload requests specify an HTTP headerContent-Typenameparameter corresponding to the original file name within the VersaLex file system. Conversely, it is anticipated that the bank server will provide aContent-Type"name" parameter or aContent-Disposition"filename" parameter within the returned HTTP headers for all download requests.While this is anticipated, it is not required for download orders. See Inbound File Names.
Data Segmentation and Checkpoint Restart
According to the EBICS specification, there is a one (1) MB limit on the size of the payload (i.e., the data encapsulated within the <OrderData> element). After the payload has been compressed, encrypted, and base64-encoded, if larger than 1 MB, it must be segmented into multiple transaction steps.The EBICS specification defines optional checkpoint restart rules at the segment breaks.The VersaLex EBICS client supports the checkpoint restart capability for both uploads and downloads.
Signatures
EBICS calls for multiple levels of signatures.Almost every message request and response carries a signature; this signature is wrapped within the <AuthSignature> element and it uses the XML Signature methodology.This is referred to as theidentification and authenticationsignature, and it is required for almost every EBICS request and response. In addition to the identification and authentication signature, a so-calledelectronic signature(abbreviated as ES) can also be present on an EBICS upload request.This signature is embodied within the <UserSignatureData> element. TheESsigns the payload and theidentification and authentication signaturesigns overall EBICS packages.
Order Attributes
The EBICS specification requires the <OrderAttribute> element on most EBICS requests.See the table below.To learn more, see the EBICS specification at www.ebics.org.
The <OrderAttribute> element is 5-character field.The setting for each character is as follows:
Position
Meaning
Permitted Values
Position
Meaning
Permitted Values
1
Type of data transmitted
O= order data and ES
U= ES only
D= order data and transport ES
(or no ES in the case of certain key management orders like HIA and INI)
2
Compression type
Z= ZIP compression
3
Encryption type for order data and/or ES
N= no encryption
H= hybrid encryption AES/RSA
4
Reserved
N= reserved setting
5
Reserved
N= reserved setting
Security Media For Private Keys
The EBICS specification defines the following codes for identification of the medium for storage of private keys.
Security Medium
Setting
Security Medium
Setting
No specification
0000
Diskette
01dd
Chipcard
02dd
Other removable storage medium
03dd
Non-removable storage medium
04dd
Note that "dd" represents any number combination that is configurable by the customer.This value is specified through theEBICS Host: EBICStab. See EBICS Host.
Inbound File Names
Inbound files can be received via aGETcommand or via one of the ancillary orders executed through theEBICS mailbox: EBICStab (usingExecute Ancillary OrderorDownload Bank Keys). See EBICS Mailbox.
The general order of precedence is as follows:
If a "destination" name is specified on theGETcommand, it is used.
Otherwise, theDefault File Namesetting from theEBICS Host: EBICStab is used.See EBICS Host
Within the destination string of aGETcommand or within theDefault File Name, source file macros (e.g., %sourcefile%) can be used to build the final destination name.When a macro is used, if theContent-Disposition"filename" or theContent-Type"name" is specified on the inbound response from the bank server, then it is used to resolve the macro.If both parameters are specified, thenContent-Dispositiontakes precedence.Conversely, if neither parameter is specified, then the generic string, "receive.file", is used for the macro substitution.
After the inbound file name is determined, the following will determine its final name.These steps are different for files associated with aGETcommand and for files associated with an ancillary or key download.
If a file is associated with aGETcommand:
if -UNI is specified on the command, and the file already exists, the name will be made unique (e.g., changingFDL.xmltoFDL1.xml) to avoid overwriting the file.
if -APE is specified on the command, the file will be appended to if it already exists.
if neither -UNI nor -APE are specified, and the file already exists, it will be overwritten.
If a file is associated with an ancillary or key download:
if the file already exists, the name will be made unique (e.g., changingHTD.xmltoHTD1.xml) to avoid overwriting the file.
Key Management
The EBICS specification defines several provisions and order types associated with the exchange of public keys. Three sets of public-private keys are defined for EBICS application-level encryption and signing. They are:
key pair for encryption
key pair for identification and authentication signature
key pair for electronic signature (ES)
According to the specification, key pairs 1 and 2 can be the same pair, but key pair 3 must be unique.The bank server will respond with appropriate error codes if this requirement is not met.
SSL/TLS Keys
In addition to the keys used at the application-level, there is a public-private key pair for TLS-level encryption. The EBICS specification makes no restrictions as to whether or not this key pair may coincide with one of the application-level keys.
Key Exchange
When a user is first created, the bank will classify the user asNew. Prior to conducting transactions, the user must be classified asReady. TheReadystate means that the bank has all the information necessary for the user to start submission of orders, including bank's download keys. To achieve theReadystate, the bank requires the receipt of certain keys.Know the requirements of your banking partner in order to provide the necessary keys according to the prescribed methods.
The transfer of keys from the client to the server and from the server to the client is referred to askey exchangeand is supported through theEBICS mailbox: EBICStab. See EBICS Mailbox. Under EBICS, provisions have been made for key exchange through certain order types defined within the specification.The key exchange order types implemented through the VersaLex EBICS client are:
Upload:
INI- Upload ES key
HIA- Upload signing and encryption keys
H3K- Upload signing, encryption, and ES keys
PUB- Update ES key
HCA- Update signing and encryption keys
HCS- Update signing, encryption, and ES keys
Download:
HPB- Download signing and encryption keys
The EBICS specification also calls for hardcopy "initialisation letters" through which a secondary submission of key information is passed.The VersaLex EBICS client also provides functions to produce these letters.
EBICS Client Order Types
Below is a table summarizing the order types referenced in the EBICS specification at www.ebics.org. The source of the table originated from Appendix 13 ofSpecification EBICS Version 2.5. The last column of the table displays where the order type is supported within the framework of an EBICS host, mailbox, or action.
Order Type
Direction of Transfer
Text
Specification Status
Where Supported in VersaLex
FDL
D
Download file with any format
Optional
Supported throughtheGETcommand.
See EBICS Command Reference
FUL
U
Upload file with any format
Optional
Supported throughthePUTcommand.
See EBICS Command Reference
HAA
D
Download retrievable order types
Optional
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HAC
D
Download status information (XML Format)
Mandatory
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HCA
U
Update signing and encryption keys
Mandatory
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HCS
U
Update signing, encryption, and ES keys
Mandatory
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HEV
D
Download supported versions
Mandatory
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HIA
U
Upload signing and encryption keys
Mandatory
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HKD
D
Download customer data for all users
Optional
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HPB
D
Download signing and encryption keys
Mandatory
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HPD
D
Download bank parameters
Mandatory
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HSA
U
Upload subscriber keys for FTAM users
Optional
Not Planned [4]
HTD
D
Download customer data for this specific user
Optional
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
HVD
D
Retrieve VEU state
Conditional
HVE
U
Add VEU state
Conditional
HVS
U
VEU cancellation
Conditional
HVT
D
Retrieve VEU cancellation details
Conditional
HVU
D
Download VEU overview
Conditional
HVZ
D
Download VEU overview with additional information
Conditional
H3K
U
Upload signing, encryption, and ES keys
Optional
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
INI
U
Upload ES key
Optional
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
PTK
D
Download status information (German version only)
Optional
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
PUB
U
Update ES Key
Optional
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
SPR
U
Suspend user
Optional
Supported through theEBICS mailbox: EBICStab.
See EBICS Mailbox
AEA, AIA, etc. [5]
U/D
Variable
Variable
Upload commands supported through thePUTcommand .
Download command supported through theGETcommand .
See EBICS Command Reference
EBICS Configuration
The following sections explain how to configure an EBICS host from scratch using the generic EBICS preconfigured host.Only use this host if Cleo does not have a preconfigured host for the banking partner being connected to.Visit www.cleo.com/products/lexihubs.asp for a list of available preconfigured hosts.
Obtain the following parameters from your bank server:
URL, of the formhttps://remote-host:port/resource-path?optional-parameters.
The server's Host ID.
EBICS version supported (2.4 or 2.5).
ES (electronic signature) version supported (A005 or A006).
Provide the following parameters to your bank server:
Your Partner ID
Your User ID
Click theTemplatestab in the tree pane.
If necessary, expand theHoststree in theTemplatestab to find the host you want to use.
Right-click thehostand selectClone and Activate.
The entire pre-configuredhostbranch (including a mailbox and actions) is copied and activated, theActivetab is selected in the tree pane, and the new activehostis 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.
Click the new host in the tree pane.
Enter host-level configuration information on the tabs in the content pane. See EBICS Host.
ClickApplyto save your work.
Enter mailbox-level configuration information.
Click the mailbox under your host in the tree pane.
Enter mailbox-level configuration information on the tabs in the content pane. See EBICS Mailbox.
ClickApplyto save your work.
Enter action-level configuration information.
Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and selectNew Action.
Edit action information on the tabs in the content pane. See EBICS Action.
ClickApplyto save your work.
ClickApplyto save your work.
Important:If you leave any of these panels without clickingApply, your work will not be saved. You can configure the native UI to prompt to you clickApplywhen changes are made. See Other system options. However, in the web UI, this is not valid. 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 clickApplyand your updates will not be saved.
EBICS Host
The following describes configuration of the Generic EBICS preconfigured host.
To rename the host alias, right-click on the host and chooseRename. Alternatively, you can change the host alias by modifying theHostalias field in the content pane and clickingApply.
EBICS Host: General Tab
Server Address
The address where your trading partner's server receives requests. Either a fully qualified name (recommended) or an IP address.
Port
The port where your trading partner's server receives requests. You can specify either a specific port number or-1to indicate the default port for HTTP (80) or HTTP/s (443).
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 theSystem Defaultcheck 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 VLTrader and Harmony, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and/or Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Inbox
Default directory for incoming files. Enter a value directly or clickto 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 clickto 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 clickto 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 clickto navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
EBICS Host: EBICS Tab
To
Host ID
The bank server's identifier, up to 35 characters with pattern [a-zA-Z0-9,=].The value you enter here is placed in the<HostID>element of requests.
Received Files
Default File Name
The filename to be used when an inbound file name is not otherwise specified. To understand the rules for naming inbound files, see EBICS Overview.This field can include any supported macros; see Using Macro Variables for information about applicable macros (Destination File context) and example usage.Also, note the EBICS-specific reserved macro variable,%ebics.ordertype%, which substitutes the three-character order type.
Ancillary Order Inbox
Specify the destination location for the ancillary download orders through theAncillary Order Inbox. All ancillary order data downloaded throughExecute Ancillary Orderwill be placed in this location, as well as the <HPBResponseOrderData> associated withDownload Bank Keys. See EBICS Mailbox. Click[...]to change the ancillary order inbox location, or select "%inbox%" or a custom macro variable from the drop-down list.If this field is left blank, the default inbox location (as set on thehostGeneraltab) will be inserted automatically and used.
Initial Requests
Specify product information
SelectSpecify product informationto specify the optional <Product> element on each initial EBICS request (that is, "initialisation" phase).When selected, the following element will be included in the XML:<Product Language="en" InstituteID="Cleo Communications">VersaLex4.5</Product>. Language (i.e., "en" for English) is in accordance with ISO 639-1."VersaLex" will be replaced by "LexiCom", "VLTrader", or "Harmony" as necessary, followed by the current version level of the software product.
Security Medium ID
Specify theSecurity Medium ID. This is the two-digit identifier that the EBICS specification requires as part of the <SecurityMedium> element.Since allVersaLexprivate keys are stored on a non-removable medium, the following element will be included in the XML (given the example value of "00" as shown in the panel above):<SecurityMedium>0400</ SecurityMedium>.
EBICS Host: HTTP Tab
HTTP/HTTPs
OnlyHTTP/sis allowed for EBICS; therefore, it is pre-selected and cannot be changed.However, to verify that the server name in the received SSL server certificate matches the connected server name, selectCheck certificate server name.
Check certificate server name
Verifies that the server name in the received SSL server certificate matches the server name actually connected to.
Method
UsePOSTfor both thePUTandGETcommands sincePOSTis used exclusively within the context of EBICS.
Path
The bank server's resource path. Given the URL provided by your banking partner in the formhttps://remote-host:port/resource-path?optional-parameters, the bolded portion in this field should be entered.Note that the beginning slash ("/") is required.
Parameters
Specify any optional URL parameters.By default, no parameters are specified for EBICS messages.If parameters are required, you must obtain them from your banking partner when the relationship is established.Given the URL provided by the banking partner in the formhttps://remote-host:port/resource-path?optional-parametersthe bolded portion in this field should be entered.
For syntax and rules on specifying HTTP parameters, see HTTP Configuration section. Note that you cannot specify a parameter that matches an EBICSPUT/GETreserved parameter (for example,OrderType).
Headers
Specify values to override any default headers or add new, custom headers.When overriding default headers, make sure they meet the requirements of the EBICS specification.TheVersaLexEBICS client will, by default, generate the following headers on all generated HTTP requests:
Hostheader (for example,Host: bank01.bank.com:443)
Content-typeheader, with thenameparameter if applicable (for example,Content-Type: text/xml; name=cust01.pain.001.001.02)
Content-Lengthheader (for example,Content-length:1000)
TheVersaLexEBICS client will in turn honor the following headers on all generated HTTP responses:
Content-typeheader, with thenameparameter if applicable (for example,Content-type: text/xml; name=cust01.camt.053.001.02)
Content-Lengthheader (for example,Content-length:1000)
Content-Dispositionheader, with thefilenameparameter if applicable (for example,Content-disposition: inline; filename= cust01.camt.053.001.02)
EBICS Host: Advanced Tab
The host'sAdvancedtab contains several property settings fields. These settings typically do not affect your ability to connect to a host. However, you may 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 EBICS 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:OnorOff
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:OnorOff
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:OnorOff
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:OnorOff
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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
Default value:On
Command Retries
If an error or exception occurs during a command, the number of times the command should be retried.
Note:Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
Possible values:0-n
Default value:0
Connection Timeout
The amount of time allowed for each read operation.
Possible values:0-nseconds
0indicates no timeout
Default value:150seconds
Do Not Send Zero Length Files
Indicates whether zero length files to be sent to the server should be ignored rather than processed. If the-DELoption is being used, any zero length file ignored will also be deleted.
Possible values:OnorOff
Default value:Off
EBICS Version
Specifies the version of EBICS that should be used.
Possible values:EBICS 2.4orEBICS 2.5
Default value:EBICS 2.4
Email On Check Conditions Met
Send an email notification after running aCHECKcommand where the overall conditions of the check are met. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Check Conditions Not Met
Send an email notification after running aCHECKcommand where the overall conditions of the check arenotmet.See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Fail
If an error occurs during a command, email the error condition. See Email/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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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:OnorOff
Default value:On
Encryption Algorithm
The method used to encrypt/decrypt payload.
Possible values:
AES/128
AES/192
AES/256
SEED
TripleDES
Default value:TripleDES
ES Version
Specifies the version of ES that should be used.
Possible values:
A005
A006
Default value:A005
Execute On Check Conditions Met
After executing aCHECKcommand where the overall conditions are met, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Check Conditions Not Met
After executing aCHECKcommand where the overall conditions arenotmet, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Possible values: System command to be executed.
Default value: The valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Repetitive Action Failures
WhenExecute On Failis enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, theExecute On Failcommand will be executed again. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Successful Copy
After successfully copying a file usingLCOPY, 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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values:0toncharacters.
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:OnorOff
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:OnorOff
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:OnorOff
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 toConfigure > Options > Otherto set theHigh Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Warning:If the trading partners bandwidth (and notCleo Harmony's orCleo VLTraders) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down otherCleo HarmonyorCleo VLTradertransfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance ofCleo HarmonyorCleo VLTraderis both the client and server (for example, a local looptest).
Possible values:
Incoming
Outgoing
Both
Ignore EOL Characters In ES Hash Calculation
If selected, all CR and LF characters that are in the payload will be ignored in the ES hash calculation.
Possible values:OnorOff
Default value:Off
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:OnorOff
Default value: The value specified for this property on theOptions > Advancedpanel
Include Line Separators In Base64 Content
If selected, indicates that CRLF should be used to break Base64 <OrderData> content into fixed-length blocks (generally 64 bytes). If false, Base64 <OrderData> will be output with no line breaks.
Possible values:OnorOff
Default value:Off
LCOPY Archive
If specified, contains the directory for archivingLCOPYsource 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 theOptions > Advancedpanel, 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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
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 theOptions > Advancedpanel, 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 theOptions > Advancedpanel, 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 of0does 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 of0does 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
Omit Name Parameter From Content Type
When selected, the applicable file name is not included in the Content-Type header.
Possible values:OnorOff
Default value:Off
Outbox Sort
Controls the order in which multiple files are transferred for aPUTcommand. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab takes precedence. ForAlphabeticalordering, 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
IfFixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values:OnorOff
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 aCleo LexiComonly option. ForCleo HarmonyandCleo 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 theMailbox Packagingtab. See Configuring mailbox packaging.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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:OnorOff
Default value:On
PGP Signature Verification
Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. In general, this property should be enabled.
Possible values:OnorOff
Default value:On
PGP V3 Signature
Reset Connection After Timeout On Response
When enabled will cause an immediate reset on the socket (instead of a graceful close) when aSocketTimeoutExceptionoccurs.
Possible values:OnorOff
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:OnorOff
Default value:On
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:OnorOff
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 thatCleo Harmony,Cleo VLTrader, orCleo LexiComwill 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 of0to112,128, or256(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabledexception to occur.
Possible values:0-nbits
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:OnorOff
Default value:On
Store Raw Sent And Received
Indicates whether copies of the "raw" outgoing requests and corresponding incoming responses are stored in the EBICS\sent+received folder. These files may be useful in diagnosing problems, however, generally this property should be 'off' to conserve disk space.
Possible values:OnorOff
Default value:Off
Terminate On Fail
If an error occurs during a command, stop the action.
Note:
Regarding non-CHECKcommands: WhenTerminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.
RegardingCHECKcommands:Terminate On Failis only honored if theConditionsMetparameter is set and the result of theCHECKis classified asError. TheCHECKcommand is only available in theCleo HarmonyandCleo VLTraderapplications.
Possible values:OnorOff
Default value:On
Unzip Use Path
Indicates whether or not zip entry paths should be used forLCOPY -UNZIPoperations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
Possible values:OnorOff
Default value:On
Wait For Execute On
Indicates whether execution should wait for processing to complete within anExecute On Fail,Execute On Successful Copy,Execute On Successful Receive, orExecute On Successful Sendcommand. Note that this option does not apply to native AS400 execution.
Possible values:OnorOff
Default value:On
XML Encryption Algorithm
The method used to encrypt/decrypt files when XML Encryption packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 inLCOPY -ZIPoperations.
Default value: The value specified for this property on theOptions > Advancedpanel, if set.
Zip Compression Level
Controls the level of compression forLCOPY -ZIPoperations.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtakes precedence
Possible values:
System Default
9- (Best Compression)
8
7
6
5
4
3
2
1
0- (No Compression)
Default value: SystemDefault
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled forLCOPY ZIP RECoperations. 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:OnorOff
Default value:On
EBICS Mailbox
A mailbox's parameters allow access to the remote bank server and define the desired security level of the file being sent.
EBICS Mailbox: EBICS Tab
Set up your identification to the bank server, manage key exchange, and perform several ancillary functions.
From
While these fields are not required for all EBICS requests, they are required for most and therefore values must be specified.
My Partner ID
My User ID
Your identification. Up to 35 characters with pattern[a-zA-Z0-9,=]for each field..
Ancillary Orders
Execute Ancillary Order
ClickExecute Ancillary Orderto display theExecuting Ancillary Orderdialog box. See Executing an ancillary order.
Key Management
Perform key management tasks. See Managing keys within EBICS.
Executing an ancillary order
Optional. Override the value in theAncillary Order Inboxfield.
Select an order from theOrder Typemenu.
Choose from the following:
Download Retrievable Orders (HAA)
Download Customer Acknowledgment (HAC)
Download Supported Versions (HEV)
Download Customer Data (HKD)
Download Bank Parameters (HPD)
Download Subscriber Data (HTD)
Download Customer Protocol (PTK)
Depending upon the order type selected, theStart DateandEnd Datewill be enabled. In this case, specify values. The date values must be in the formYYYY-MM-DD.
ClickExecuteto run the order.
Messages are displayed as the transaction steps take place for execution of the order.
Optional. ClickCancelat any point to interrupt the execution.
Some of the ancillary orders might not be supported by the server, either because they are optional or because they are not supported under the particular EBICS version.When this occurs, it is possible to see the return codeEBICS_UNSUPPORTED_ORDER_TYPEorEBICS_INVALID_ORDER_TYPE.
For all ancillary orders except HEV, the downloaded order data will be placed in ancillary order inbox (as seen in the FILE record shown in the dialog box above). Since the response data is very simple for HEV, it will be reported immediately through detail messages.
Managing keys within EBICS
The exchange of all keys takes place from theKey Managementpanel. To understand key-pair requirements and key exchange within the context of EBICS, see EBICS Overview.
Uploading your keys
On the EBICS mailbox EBICS tab, clickUpload My Keys.
TheUploading My Keysdialog box appears.
In theOrder Typemenu, select the upload order to execute.
Choose from the following:
Upload ES Key (INI)
Upload Signing and Encryption Keys (HIA)
Upload Signing, Encryption, and ES Keys (H3K)
Update ES Key (PUB)
Update Signing and Encryption Keys (HCA)
Upload Signing, Encryption, and ES Keys (HCS)
ClickExecuteto begin the transaction for uploading.As the transaction takes place, the progress is shown through messages displayed within the dialog box.
Optional. ClickCancelat any point to interrupt the execution.
Downloading the bank keys
On the EBICS mailbox EBICS tab, clickDownload Bank Keys.
TheDownloading Bank Keysdialog box appears and the download begins.
As the transaction takes place, the progress is shown through messages displayed within the dialog box.
The <OrderData> of the HPB response (embodied in <ebicsKeyManagementResponse>) is decoded, decrypted, and decompressed, yielding an <HPBResponseOrderData> instance document.This document is stored in the ancillary order inbox location in a file name according to theInbound File Names. See EBICS Overview. In addition, the pertinent key information contained within the <HPBResponseOrderData> is also stored in the host file associated with this mailbox.
Optional. ClickCancelat any point to interrupt the download.
Printing initialization letters
If you have uploaded your keys to the bank through the INI and HIA transactions, the EBICS specification calls for separate hard copy letters.
On the EBICS mailbox EBICS tab, clickPrint Initialisation Letters.
Separate confirmation dialog boxes appears for each type of transaction - INI and HIA.
ClickOKfor each confirmation.
The system prints two letters containing the data according the EBICS specification. For more information, visit www.ebics.org.
Suspending your account
If your account or its associated keys have been compromised in some way, you can easily suspend your account.
On the EBICS mailboxEBICStab, clickSuspend My User Account.
The system executes the SPR order and displays a dialog box containing information about the order.
The SPR order is a special upload transaction, transmitting only the ES of a dummy one-space payload.Since only the ES is sent, the <OrderAttributes> will be set toUZHNN. See EBICS Overview.
EBICS Mailbox: ES Tab
ES Certificate Alias
Password
Enter yourES Certificate Alias.This is the name of the ES certificate that is registered with theVersaLexapplication through the Certificate Manager.ClickBrowseto view and select this certificate.
Enter the for your certificate's private key.
Signature Class
If you are transacting business with a bank that is EBICS T compliant, thenSignature Classshould be set toTransport signature (type 'T'). If you are transacting business with a bank that is EBICS TS compliant, thenSignature Classshould be set toSingle signature (type 'E').Note that the A and B signature classes, as defined in the EBICS specification, will not be supported until VEU is fully supported. See EBICS Overview.
Note:
Referring to the EBICS specification and theebics_signature.xsdschema (found at www.ebics.org ), it appears that the element <OrderSignatureData> is unbounded within the <UserSignatureData> element.At this time, theVersaLexEBICS client supports only one instance of <OrderSignatureData>.
The bank server will maintain a record of your partner and user ID, along with your associated signature permission level.The mechanism the bank uses to obtain and initialize these records is outside the scope of the Cleo VerasLex EBICS client.
The EBICS specification requires that the certificate used for ES is different from the certificate used for identification and authentication and encryption. See EBICS Overview. See EBICS Mailbox: Certificates Tab for information about defining identification and authentication certificate and the encryption certificate.
EBICS Mailbox: Certificates Tab
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 theVersaLexapplication 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 Configuring certificates for Local Listener.
ClickBrowseto navigate to and select a certificate. Enter thePasswordfor your signing certificate's private key.
Encryption Certificate Alias
The certificate for decrypting your trading partners messages, if you have created or obtained a separate certificate.
ClickBrowseto navigate to and select a certificate. Enter thePasswordfor your encryption certificate.
Use signing certificate
Select this check box to use the same certificate for signing and decrypting your trading partner's messages. TheEncryption Certificate AliasandPasswordare populated to match theSigning Certificate Aliasand disabled.
EBICS Mailbox: HTTP Tab
Use the mailboxHTTPtab to assignDefault Valuesfor headers forGETandPUT. For EBICS, the default value of theContent-Typeheader must always betext/xmlorapplication/xml.
EBICS Mailbox: Authenticate Tab
If the target server requires WWW authentication, select the appropriate type and provide aUsernameandPasswordand, optionally, theRealm.
EBICS Mailbox: Security Tab
Since it is mandated for EBICS, HTTP/s is pre-selected on theSecuritytab.With HTTP/s, the target bank server can issue client certificates. If so,
View ArticleOdette FTP (OFTP) is a state-driven, point-to-point file transfer protocol.
The initiator of the connection is the speaker, but speaker and listener roles can be reversed at anytime during the session.
All four OFTP file formats are supported Text, Unstructured, Fixed, and Variable.
VersaLex OFTP can be used to perform EBCDIC-to-ASCII and ASCII-to-EBCDICtranslations during the OFTP transfer.
OFTP sessions can be over ISDN (Windows users only) or TCP/IP.ISDN equipment must support the Common ISDN API (CAPI) interface, version 2.0.
Support for OFTP receipts (End-to-End Responses) is included.
VersaLex is compatible with Odette FTP versions 1.2, 1.3, 1.4, and 2.0.
VersaLex supports the OFTP2 specification, including secure transport over TLS, session authentication, encryption, compression, and document signing.
VersaLex does not support forwarding OFTP messages VersaLex must be an endpoint.
VersaLex OFTP can receive files, both solicited via an OFTP receive SCRIPT command action or unsolicited via theLocal ListenerOdette FTP service.
VersaLex OFTP can send files only via an OFTP sendaction; files cannot be sent by theLocal ListenerOdette FTP service.
The following action commands are available on VersaLex:
Command
Purpose
Possible underlying OFTP commands
Host commands
PUT
Send one or more files to the host
SFID (Start File Identification)
DATA (Data exchange buffer)
EFID (End of File Identification)
CD (Change Direction)
RTR (Ready to Receive)
EERP (End to End Response)
NERP (Negative End Response)
GET
Receive one or more files and receipts from the host
CD (Change Direction)
SFPA (Start File Positive Answer)
SFNA (Start File Negative Answer)
CDT (Set Credit)
EFPA (End File Positive Answer)
EFNA (End File Negative Answer)
EERP (End to End Response)
NERP (Negative End Response)
Local commands
SYSTEM
Execute a local system command
-
WAIT
Pause
-
SET
Sets a property
CLEAR
Clears a string property
LCOPY
Copy one or more local files
-
LDELETE
Delete one or more local files
-
LREPLACE
Replace bytes in one or more local files
-
CHECK
Check for a transfer, file, or directory (VLTrader and Harmony only)
-
SCRIPT
Execute a JavaScript File (VLTrader and Harmony only)
-
OFTP Configuration
Configure an Odette FTP (OFTP) host starting with the generic OFTP pre-configured host.
Only use this host if Cleo does not have a pre-configured host for the connecting trading partner. Visit www.cleo.com/products/lexihubs.asp for a list of available pre-configured hosts.
As part of the configuration process, you must also configure your Local Listener to receive OFTP messages. See Configuring a Local Listener for OFTP and Configuring OFTP Service for detailed information about configuring your local host for OFTP.
First activate either a trading partner specific host or the generic OFTP pre-configured host.
Click theTemplatestab in the tree pane.
If necessary, expand theHoststree in theTemplatestab to find the host you want to use.
Right-click thehostand selectClone and Activate.
The entire pre-configuredhostbranch (including a mailbox and actions) is copied and activated, theActivetab is selected in the tree pane, and the new activehostis 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.
Click the new host in the tree pane.
Enter host-level configuration information on the tabs in the content pane. See OFTP Host.
ClickApplyto save your work.
Enter mailbox-level configuration information.
Click the mailbox under your host in the tree pane.
Enter mailbox-level configuration information on the tabs in the content pane. See OFTP Mailbox.
ClickApplyto save your work.
Enter action-level configuration information.
Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and selectNew Action.
Edit action information on the tabs in the content pane. See OFTP Action.
ClickApplyto save your work.
ClickApplyto save your work.
Important:If you leave any of these panels without clickingApply, your work will not be saved. You can configure the product to prompt to you clickApplyif 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 clickApplyand your updates will not be saved.
OFTP Host
A host's parameters specify its location and how it is reached.
OFTP Host: General Tab
Use theGeneraltab to configure three different types of connections: ISDN, TCP/IP, and Server Only
ISDN connection
ISDN equipment must already be installed and must support the Common ISDN API (CAPI) interface, version 2.0.
OFTP ISDN Addresses
A list of ISDN numbers the product will use to attempt to connect to the trading partner. The product will try each number until a successful conneciton is made. For each ISDN address, specify values for the following fields.
ISDN Phone Number
Your partner's ISDN phone number. If you are making an international call and are unsure of how to specify the number, www.countrycallingcodes.com can be used to determine your international dialing code and your trading partner's country code.
ISDN Subaddress
X.25 Network User Address
X.25 Network User Identification
Optional attributes that your trading partner might use.
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 VLTrader and Harmony, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and/or Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Inbox
Default directory for incoming files. Enter a value directly or clickto 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 clickto 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 clickto 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 clickto navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
TCP/IP connection
Server Address
Either a fully qualified name (recommended) or an IP address.
Port
The OFTP port. You can specify either a specific port number or-1to indicate the default port (3305).Note that for secure connections using TLS, the default port is6619.
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 theSystem Defaultcheck 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 VLTrader and Harmony, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and/or Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Inbox
Default directory for incoming files. Enter a value directly or clickto 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 clickto 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 clickto 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 clickto navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
Server-only connection
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 VLTrader and Harmony, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and/or Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Inbox
Default directory for incoming files. Enter a value directly or clickto 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 clickto 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 clickto 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 clickto navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
OFTP Host: OFTP Tab
Buffer Size
can be between 128 and 99999 bytes.
Buffer Credits
his is the number of data exchange buffers that can be sent consecutively by the speaker without listener acknowledgment.
can be between 1 and 999.
Compress Content
indicates whether the OFTP data compression algorithm should be invoked.This applies to buffer-level compression.OFTP2 utilizes better compression algorithms, which can be specified on the mailboxs V2 tab.
Allow Restart
Maximum Record Size
indicates the maximum length of any single record when transferring a file. Maximum Record Size applies to the OFTP Text, Fixed, and Variable file formats; it does not apply to the OFTP Unstructured file format.In the case of the OFTP Fixed file format, Maximum Record Size specifies the fixed record length.
Incoming
Optional. Only specify an Incoming filter if you need to override the default inbox/filename or if EBCDIC translation or special end-of-record processing is required.
To add anIncomingdestination or parameter, clickNew. See Adding an incoming destination or parameter
Adding an incoming destination or parameter
Add incoming destination information when you need to override the default inbox/filename or if EBCDIC translation or when special end-of-record processing is required.
On theOFTPtab in theIncomingsection, clickNewto display theOFTP Incoming Filterdialog box.
Identify incoming files.
If different incoming files are destined for different directories/filenames or require different parameters, uniquely identify the incoming file by specifying either aVirtual Filename,Originator,Destination,DescriptionorFile Format. Additionally, the Virtual Filename, Originator, Destination, and Description can contain wildcards or regular expressions if partial or global matching is needed on these fields. See Using wildcards and regular expressions. If theFile Identificationis left entirely blank, then theFile Destinationand/orParametersspecified below apply to all incoming files for which the originator and destination match the mailbox's trading partner ID and your ID respectively.If incoming originator and/or destination values differ from the mailbox login IDs, then the originator and/or destination values in the incoming filter must be set to match (either exactly or via wildcarding or regular expression) in order for the filter to be applied.
If globally allowing incoming originator and/or destination values to differ from mailbox IDs in the Odette FTP Service, then the filter is optional. See Local Listener Odette FTP Service.
Otherwise, if not globally allowing differing originator/destination, then an incoming filter with originator/destination filled in is required in order to accept the incoming file.
Specify a destination.
If theDirectoryis left blank, the host Inbox directory under theOFTP Host: General Tabis used.See OFTP Host. The host Inbox directory can be further subfoldered by enablingAdd Mailbox Alias Directory to Inboxunder theOFTP Host: Advanced Tab. See OFTP Host: Advanced Tab.
If theFilenameis left blank, the Virtual Filename is used. If the filename already exists, a number is appended to the filename to ensure uniqueness. This field can also include any of the supported macros allowing for the inclusion of a date-time stamp in the name of an incoming file, for example, as shown in the diagram above. See Using macro variables (Destination File context) for information about all applicable macros.
Optional. Specify destination parameters.
Translate from EBCDICindicates that incoming characters should be translated from EBCDIC to ASCII.EBCDIC Encodingunder theOFTP Host: Advanced Tabspecifies the encoding character set. See OFTP Host.
Trim Characters at End-Of-Recordapplies to the OFTP Fixed file format only.The character or set of characters will be trimmed from the end of each incoming record, when present.Use a 0x prefix to specify hexadecimal character values.
Insert End-Of-Record Delimiterapplies to the OFTP Fixed or Variable file format only.The character or set of characters should be inserted at the end of each incoming record.Use a 0x prefix to specify hexadecimal character values.
OFTP Host: V2 Tab
Starting with OFTP2, transport layer security (TLS) is an option for secure communications. When downgrading the OFTP version (see Advanced Tab below), non-secure communications are used regardless of any values you set on this page.
Partner Is ACE-Capable
Indicates whether the trading partner is capable of sending and receiving certificates through Automatic Certificate Exchange (ACE), and enables theACEsubtab in theOFTP Mailbox: Securitytab. See OFTP Mailbox: Security Tab.
Possible values:
True- Indicates your partner's OFTP2 product is capable of processing ACE messages, but no messages have been sent with the appropriate virtual filename
False- Indicates your partner's product is not capable of processing ACE messages. However, when messages with the appropriate virtual filename (SFIDDSN) are received from a trading partner, this field is automatically changed toTrue.
False and Ignore Further Detection- Indicates your partner's product is not capable of processing ACE messages and this field will not be updated automatically even if messages with the appropriate virtual filename (SFIDDSN) are received from a trading partner.
Default value:False
Outbound
TheOutboundgroup settings are enabled for TCP/IP connections. See OFTP Host: General Tab.
TCP/IP
Select this option to use non-secure TCP/IP for outbound connections
Secure TCP/IP
Select this option to require TLS for outbound connections.
Check certificate server name
See OFTP Host: General Tab.
Inbound
TheInboundgroup is enabled for either Server Only or TCP/IP connections.
Secure TCP/IP only
Select this option to require your trading partner to use TLS for inbound file transfers. See OFTP Host: General Tab.
OFTP Host: Advanced Tab
See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for OFTP 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:OnorOff
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:OnorOff
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:OnorOff
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:OnorOff
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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
Default value:On
Always Change Direction After Sending
Indicates that a CD should always be sent after finished sending a set of files, giving the trading partner the opportunity to provide pending EERPs.
Possible values:OnorOff
Default value:Off
Always Disconnect ISDN After End Of Session
Disable this setting if, for incoming ISDN calls, host should wait for trading partner to issue disconnect.
Possible values:OnorOff
Default value:On
Always Include EERP Hash
Indicates whether to include a hash (EERPHSH) value in returned EERPs even if a signature (EERPSIG) is not included.The property defaults to off, and is included for backward compatibility.
Possible values:OnorOff
Default value:Off
Application Layer Receipts
Note:This applies only to theCleo HarmonyandCleo VLTraderapplications.
Allows an EERP to not be returned until a received file has been processed by a backend application. Pending .eerp properties files can be stored in the configured inbox or the EERP storage folder or not at all.
For OFTP2 relationships, if processing should fail, the pending EERP can be changed to a NERP by adding a NERPREAS= property. (The SSIDLEV= property value for an OFTP2 relationship will be >= 5.) Valid application layer NERPREAS values are:
34 - File processing failed
35 - Not delivered to recipient
36 - Not acknowledged by recipient
99 - Unspecified reason
See section 5.3.14 in http://tools.ietf.org/html/rfc5024 for the full list of reason codes. An optional NERPREAST= property, which gives an additional description of the problem, can also be included.
ThePUT -REToption must be used when the pending return receipt is being sent back.
Possible values:
Off
Place pending EERP in inbox
Place pending EERP in EERP storage subfolder
On but do not generate a pending EERP- This value can only be used when the API ILexiComIncoming interface orCleo VLTraderorCleo Harmonydatabase payload is also being used; otherwise, the needed EERP property values will not be known. This setting also requires that the backend application generate a base64-encoded SHA-1 hash value for OFTP2 relationships. To know for sure what EERP properties are required, first use one of thePlace pending EERPsettings and interrogate the generated .eerp file.
If using the APIILexiComIncominginterface, theEERP.pendingproperty in theopen()method parameters object points to the location of the saved.eerpproperties file or simply has a value ofTrue. If using database payload, this property value is stored in theVLIncomingPropertiestable.
Default value:Off
Command Retries
If an error or exception occurs during a command, the number of times the command should be retried.
Note:Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
Possible values:0-n
Default value:0
Connection Timeout
The amount of time allowed for each read operation.
Possible values:0-nseconds
0indicates no timeout
Default value:150seconds
Delete Zero Length Files
Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
Possible values:OnorOff
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-DELoption is being used, any zero length file ignored will also be deleted.
Possible values:OnorOff
Default value:Off
Downgrade OFTP Version
Use may be necessary if the trading partner OFTP software does not on its own properly downgrade fromCleo Harmony,Cleo VLTrader, orCleo LexiComOFTP version 2.0.
Possible values:
1.2,1.3, or1.4to force downgrade only when initiator of session
-1.2,-1.3, or-1.4to force downgrade whether initiator of session or not
EBCDIC Encoding
When translating to and from EBCDIC, indicates the specific EBCDIC character encoding.
Possible values:Cp037-Cp1149
Default value:Cp500- EBCDIC International
Email On Check Conditions Met
Send an email notification after running aCHECKcommand where the overall conditions of the check are met. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Check Conditions Not Met
Send an email notification after running aCHECKcommand where the overall conditions of the check arenotmet.See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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:OnorOff
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:OnorOff
Default value:On
Email On Successful Copy
Send an email notification after copying a file usingLCOPY. 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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (if set).
Execute On Check Conditions Met
After executing aCHECKcommand where the overall conditions are met, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Check Conditions Not Met
After executing aCHECKcommand where the overall conditions arenotmet, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Possible values: System command to be executed.
Default value: The valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Repetitive Action Failures
WhenExecute On Failis enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, theExecute On Failcommand will be executed again. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Repetitive Listener Failures
WhenExecute On Failis enabled and the same failure occurs each time an inbound message is processed by the Listener for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after every system restart if the failure occurs again. If the failure can be associated with a specific host, theExecute On Failcommand will be executed again when the failure is resolved. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure. Executions of the "Execute On Fail" command for resolution of general Listener failures will not be done since it is not possible to determine that these types of failures have been resolved.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Successful Copy
After successfully copying a file usingLCOPY, 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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values:0toncharacters.
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:OnorOff
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:OnorOff
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 Length From OFTP
Causes EOL characters to be inserted while receiving a file based on the SFIDLRECL value.
Note:For this property to be effective, Fixed Record EOL Characters must be specified, Fixed Record Incoming Insert EOL must be enabled, and a fixed SFIDFMT format with a positive SFIDLRECL value must be requested by the OFTP trading partner.
Possible values:OnorOff
Default value:Off
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:OnorOff
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 toConfigure > Options > Otherto set theHigh Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Warning:If the trading partners bandwidth (and notCleo Harmony's orCleo VLTraders) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down otherCleo HarmonyorCleo VLTradertransfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance ofCleo HarmonyorCleo VLTraderis 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:OnorOff
Default value: The value specified for this property on theOptions > Advancedpanel
LCOPY Archive
If specified, contains the directory for archivingLCOPYsource 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 theOptions > Advancedpanel, 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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
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 theOptions > Advancedpanel, 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 theOptions > Advancedpanel, 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 of0does 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 of0does 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 aPUTcommand. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab takes precedence. ForAlphabeticalordering, 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
IfFixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values:OnorOff
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 aCleo LexiComonly option. ForCleo HarmonyandCleo 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 theMailbox Packagingtab. See Configuring mailbox packaging.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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:OnorOff
Default value:On
PGP Signature Verification
Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. In general, this property should be enabled.
Possible values:OnorOff
Default value:On
PGP V3 Signature
Processing Disconnect Timeout (seconds)
When sending multiple large files within a put action, pre-processing (encryption, compression, signing) of files can take a while.This option will disconnect the connection if the processing time between files exceeds the timeout.The connection is re-established when file being processed is complete
Possible values:0-99999
Default value:20
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:OnorOff
Default value:On
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:OnorOff
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 thatCleo Harmony,Cleo VLTrader, orCleo LexiComwill 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 of0to112,128, or256(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabledexception to occur.
Possible values:0-nbits
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:OnorOff
Default value:On
Store Raw Sent Message
When this property is enabled, a copy of the outbound message is stored in the HTTP/sent directory.
Possible values:OnorOff
Default value:Off
Terminate On Fail
If an error occurs during a command, stop the action.
Note:
Regarding non-CHECKcommands: WhenTerminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.
RegardingCHECKcommands:Terminate On Failis only honored if theConditionsMetparameter is set and the result of theCHECKis classified asError. TheCHECKcommand is only available in theCleo HarmonyandCleo VLTraderapplications.
Possible values:OnorOff
Default value:On
Unzip Use Path
Indicates whether or not zip entry paths should be used forLCOPY -UNZIPoperations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
Possible values:OnorOff
Default value:On
Verify Calling Party ISDN Address
When receive an incoming call for this ISDN host, indicates whether the call's source phone number must be one of the configured outgoing phone numbers.
Possible values:OnorOff
Default value:Off
Wait For Disconnect After Sending End Of Session
Indicates that if theCleo Harmony,Cleo VLTrader, orCleo LexiComapplication initiates end-of-session, it should wait for a disconnect request from the connected trading partner rather than immediately disconnecting.
Possible values:OnorOff
Default value:Off
Wait For Execute On
Indicates whether execution should wait for processing to complete within anExecute On Fail,Execute On Successful Copy,Execute On Successful Receive, orExecute On Successful Sendcommand. Note that this option does not apply to native AS400 execution.
Possible values:OnorOff
Default value:On
XML Encryption Algorithm
The method used to encrypt/decrypt files when XML Encryption packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 inLCOPY -ZIPoperations.
Default value: The value specified for this property on theOptions > Advancedpanel, if set.
Zip Compression Level
Controls the level of compression forLCOPY -ZIPoperations.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtakes precedence
Possible values:
System Default
9- (Best Compression)
8
7
6
5
4
3
2
1
0- (No Compression)
Default value: SystemDefault
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled forLCOPY ZIP RECoperations. 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:OnorOff
Default value:On
OFTP Mailbox
A mailbox's parameters allow access to the host system.
Create a newmailbox under the host.
OFTP Mailbox: OFTP Tab
User ID (SSIDCODE)
Password (SSIDPASWD)
Credentials that identify your trading partner.
Outgoing
Default Virtual Filename (SFIDDSN)
Optionally, enter an outgoingDefault Virtual Filename. An action'sPUTcommand destination, if specified, will override this value. If aPUTcommand does not specify a destination and a Default Virtual Filename is also not specified, then the source filename is used.
Originator
A user ID identifying the sender. Select the check box and provide a value to override the default. You can also use theSETcommand in an action to override these values.
Default value: your User ID.
Destination
A user ID identifying the receiver. Select the check box and provide a value to override the default. You can also use theSETcommand in an action to override these values.
Default value: your trading partner's User ID.
Send files when partner initiates connection
Enables theSend Actionfield.
Note:Available in theCleo HarmonyandCleo VLTraderapplications only.
Send Action
The action to be run whenever a trading partner-initiated connection makes theCleo HarmonyorCleo VLTraderapplication the speaker. This allows theCleo HarmonyorCleo VLTraderOFTP to act as the server in a traditional client-server model, where trading partner clients are both pushing and pulling files.If theGeneraltab (see OFTP Host: General Tab ) is set toServer Onlyand outgoing database payload is being used, any unsent database payload for the mailbox is also sent using the configured send action commands when the partner-initiated connection makes theCleo HarmonyorCleo VLTraderapplication the speaker.
My Identification
User ID
Password
Override your default credentials.
Substation Mailbox
Enables a drop down menu where you select a substation mailbox. The mailbox uses the same user ID (SSIDCODE) and password (SSIDPASWD) as the managing mailbox, but has a different originator (SFIDORIG)/destination (SFIDDEST) pair (so these two override flags are automatically set).For OFTP2, a substation mailbox can have different signing, encryption, and/or EERP certificates.
OFTP Mailbox: V2 Tab
The following settings pertain only to OFTP2 sessions or later.
Session
Cipher Suite
Used for encryption, signing, and generating hash values.
Require Authentication
Select to require session authentication with your trading partner. Clearing this option can still result in session authentication if your trading partner requires it.The certificates used for session authentication are specified on theSessionsub-tab of theMailbox Securitytab.
Request
Encrypted Content
Select to encrypt outgoing files. Certificates used for encryption are specified on theMailbox Certificatestab.
Signed Content
Select to sign outgoing files.Certificates used for signing are specified on theMailbox Certificatestab.
Signed Receipt (EERPs/NERPs)
Select to sign outgoing EERPs and NERPs.Certificates used to sign EERPs/NERPs are specified on theEERPsub-tab of theMailbox Securitytab.
CMS Compression
Select to compress the file using CMS compression before sending.This is generally more effective than the legacy buffer compression used prior to OFTP2.
Inbound Message Security
Force Encryption
Select to only accept encrypted files from your trading partner that can be decrypted using a specified certificate.
Force Signed Content
Select to only accept signed files from your trading partner.
OFTP Mailbox: Certificates Tab
The following settings pertain only to OFTP2 sessions or later.
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
Signing Certificate
The certificate used to verify a signature from an incoming file that is signed.This certificate is optional.
Specify a value or clickBrowseto navigate to the file you want to select.
If you do not specify a value, the incoming content's signature is compared to all valid certificates in the local certificate store.
Encryption Certificate
The certificate used to encrypt outgoing files ifEncrypted Contentis selected on the mailboxV2tab.
Specify a value or clickBrowseto 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, theSigning Certificatefield is populated with the same certificate you selected in theEncryption Certificatefield.
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.
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
TheSigning Certificate Aliasrefers to the certificate used to sign outgoing files
ClickBrowseto navigate to and select a certificate. Enter thePasswordfor your signing certificate's private key.
Encryption Certificate Alias
TheEncryption Certificate Aliasis for decrypting incoming encrypted files.
ClickBrowseto navigate to and select a certificate. Enter thePasswordfor your encryption certificate.
Use signing certificate
Select this check box to use the same certificate for signing and decrypting your trading partner's messages. TheEncryption Certificate AliasandPasswordare populated to match theSigning Certificate Aliasand disabled.
OFTP Mailbox: Security Tab
TheSecuritytab is divided into five sub-tabs:TCP,Session,EERP,CLID, andACE.
Note:The settings in this tab pertain only to OFTP2 sessions or later.
OFTP Mailbox Security: TCP Tab
Use theTCPtab to specify an optional client certificate.This certificate is not applicable to ISDN connections and only needs to be specified for those servers that require a client certificate be specified.
Certificate Alias
The certificate to use for TLS over secure TCP/IP.This certificate is optional.
Specify a value or clickBrowseto navigate to the file you want to select.
Password
The password for the certificate you specify.
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.
OTFP Mailbox Security: Session Tab
Trading Partner's Certificates
Authentication Certificate
The certificate to use for authenticating your trading partner's OFTP2 session.
Specify a value or clickBrowseto navigate to the file you want to select.
If you do not specify a value, the incoming content's signature is compared to all valid certificates in the local certificate store.
Use encryption certificate
Indicates that your trading partner uses the same certificate for authentication as specified for encryption. When you select this check box, theAuthentication Certificatefield is populated with the same certificate you selected in theEncryption Certificatefield on theCertificatestab (see OFTP Mailbox: Certificates Tab ).
My Certificate
Authentication Certificate
The certificate to use for authenticating your OFTP2 session.
Specify a value or clickBrowseto navigate to the file you want to select.
Password
The password for the certificate you specify.
Use encryption certificate
Indicates that you want to use same certificate for authentication as specified for encryption. When you select this check box, theAuthentication Certificatefield is populated with the same certificate you selected in theEncryption Certificatefield on theCertificatestab (see OFTP Mailbox: Certificates Tab ).
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.
OFTP Mailbox Security: EERP Tab
TheEERPtab is used to specify a certificate for EERP and NERP packet signing.The trading partner's signing certificate is used to validate an incoming signed EERP/NERP. Note that this certificate is optional.If it is not specified, the incoming signed EERP/NERP's signature is compared to all valid certificates in the local certificate store.My Certificatesigning certificate is used to sign outgoing EERP/NERPs.
Trading Partner's Certificates
Signing Certificate
The certificate to use to validate an incoming signed EERP/NERPs.
Specify a value or clickBrowseto navigate to the file you want to select.
If you do not specify a value, the incoming EERP/NERP's signature is compared to all valid certificates in the local certificate store.
Use signing certificate
Indicates that your trading partner uses the same certificate as specified for signing in theSigning Certificatefield on theCertificatestab (see OFTP Mailbox: Certificates Tab ).
My Certificate
Signing Certificate
The certificate to use to sign outgoing EERP/NERPs.
Specify a value or clickBrowseto navigate to the file you want to select.
Password
The password for the certificate you specify.
Use encryption certificate
Indicates that you want to use the same certificate as specified for signing in theSigning Certificatefield on theCertificatestab (see OFTP Mailbox: Certificates Tab ).
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.
OFTP Mailbox Security: CLID Tab
Use theCLIDtab to specify the Certificate Logical Identification Data (CLID) for your trading partner's certificates.If your trading partner provides their CLID, it allows for validation that the supplied certificates match, whether the certificate is provided automatically through ACE or imported and configured manually.Depending on which security features are used in the trading relationship and whether separate certificates are used for each feature, between one and five CLIDs are specified for signing, encryption, EERP, session, and TLS use.
A CLID consists of:
The certificates subject and issuer in the formEMAIL=xxx,CN=xxx,OU=xxx,O=xxx,L=xxx,ST=xxx,C=xxx(the fields present and the order of the fields are dictated by the trading partner).
Existence ofdigitalSignature,keyEncipherment,clientAuth, and/orserverAuthkey usage flags.
If a configured certificate does not match its CLID, the mailbox is not considered ready.A certificate received through ACE that does not have a matching CLID is rejected.
OFTP Mailbox Security: ACE Tab
Use theACE(Automatic Certificate Exchange) tab to trade certificates with your partner through the same OFTP channel used t
View ArticleThe generic FTP and FTP/s hosts enable a user to fully specify a client file transfer interface to an FTP server. If at all possible, use a pre-configured host specific to the target server; this will save the effort of having to research, specify, and then debug the interface.
The generic FTP host provides an interface over non-secure FTP. If you or your trading partner requires Secure Socket Layer (SSL) FTP, use the generic FTP/s host.
Not all FTP servers will support or require the full set of host commands allowed by VersaLex. At a minimum, the server must support PUT and/or GET. The following action commands are available on VersaLex:
Command
Purpose
Underlying FTP method
Host commands
PUT
Send one or more files to the host
STOR
GET
Receive one or more files from the host
RETR
DIR
Get a directory listing of available files from the host
LIST
CD
Changes the current directory on the host.
CHDIR
QUOTEcommand
Sends a raw command to the server
command
SITE
Sends a site specific command to the server
SITE
TYPE
Sets file data type to ASCII or BINARY
TYPE
Local commands
SYSTEM
Execute a local system command
-
WAIT
Pause
-
SET
Sets a property
CLEAR
Clears a string property
LCOPY
Copy one or more local files
-
LDELETE
Delete one or more local files
-
LREPLACE
Replace bytes in one or more local files
-
CHECK
Check for a transfer, file, or directory (VLTrader and Harmony only)
-
SCRIPT
Execute a JavaScript File (VLTrader and Harmony only)
-
FTP Configuration
Activate either a trading partner-specific host or the generic FTP or FTP/s pre-configured host and then configure host, mailbox and actions.
Click theTemplatestab in the tree pane.
If necessary, expand theHoststree in theTemplatestab to find the host you want to use.
Right-click thehostand selectClone and Activate.
The entire pre-configuredhostbranch (including a mailbox and actions) is copied and activated, theActivetab is selected in the tree pane, and the new activehostis 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.
Click the new host in the tree pane.
Enter host-level configuration information on the tabs in the content pane. See FTP Host Configuration.
ClickApplyto save your work.
Enter mailbox-level configuration information.
Click the mailbox under your host in the tree pane.
Enter mailbox-level configuration information on the tabs in the content pane. See FTP Mailbox Configuration.
ClickApplyto save your work.
Enter action-level configuration information.
Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and selectNew Action.
Edit action information on the tabs in the content pane. See FTP Action Configuration.
ClickApplyto save your work.
ClickApplyto save your work.
Important:If you leave any of these panels without clickingApply, your work will not be saved. You can configure the native UI to prompt to you clickApplywhen changes are made. See Other system options. However, in the web UI, this is not valid. 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 clickApplyand your updates will not be saved.
FTP Host Configuration
The FTP Host parameters indicate a host's location and how to reach it.
FTP Host: General Tab
Server Address
Either a fully qualified name (recommended) or an IP address.
Port
The FTP command port. You can specify either a specific port number or-1to indicate the default port for FTP (21) or FTP/s (990).
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 theSystem Defaultcheck 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 VLTrader and Harmony, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and/or Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Inbox
Default directory for incoming files. Enter a value directly or clickto 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 clickto 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 clickto 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 clickto navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
FTP Host: FTP Tab
Security Modes
For FTPs servers only.
Possible values:
None- For servers that require Secure Socket Layer (SSL). Indicates non-secure transfers; commands and data are clear-text.
SSL Implicit- For servers that support only SSL connections.
SSL Explicit- For servers that support SSL through the use of either theAUTH SSLorAUTH TLScommand.
Default value:SSL Explicit
Default Data Type
The data type used when transferring files to and from the FTP server.
Possible values:ASCIIorBinary
Default value:ASCII
Data Channel Mode
The sets the default behavior for opening data port connections between the FTP client and FTP server.
Active mode
causes the client to listen for an inbound connection from the server during data transfers. TheLow Port/High Port, if left at 0/0, will be a random number between 1024-65535; otherwise specify a specific range. Because this is active mode, this port range must be open inbound on your firewall.
Passive mode
causes the server to listen for an outbound connection from the client during data transfers. The server indicates the IP address and port number. The FTP server will cycle through port numbers, usually a subset of 1024-65535.Substitute Passive IP Addressindicates that VersaLex should ignore the IP address specified by the server and reuse the command port address instead. (This may be necessary if the server is advertising an internal rather than an external IP address.)
FTP Host: Advanced Tab
See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for FTP include:
Abort In Process Transfers
Indicates that the FTP server supports theABORTcommand when a data transfer is interrupted.
Possible values:OnorOff
Default value:Off
Add Mailbox Alias Directory to Inbox
Possible values:OnorOff
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:OnorOff
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:OnorOff
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:OnorOff
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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
Default value:On
Avoid List Command When Space In Path
When using the retrieving nested subdirectories (GET RECoption) and any of the nested subdirectories have spaces, indicates that the FTP server does not properly handle spaces in theLISTcommand path and that CDs should be used to avoid the issue.
Possible values:OnorOff
Default value:Off
Command Retries
If an error or exception occurs during a command, the number of times the command should be retried.
Note:Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
Possible values:0-n
Default value:0
Connection Timeout
The amount of time allowed for each read operation.
Possible values:0-nseconds
0indicates no timeout
Default value:150seconds
Data Socket Accept Timeout
The amount of time allowed for each read operation on the data port.
Possible values:0-600seconds, where0indicates no timeout.
Default value:150seconds
Delete Zero Length Files
Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
Possible values:OnorOff
Default value:Off
Disable Address Resolution
Indicates to connect directly to an IP address if the IP address is known and a DNS lookup is not desired.
Possible values:OnorOff
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-DELoption is being used, any zero length file ignored will also be deleted.
Possible values:OnorOff
Default value:Off
Email On Check Conditions Met
Send an email notification after running aCHECKcommand where the overall conditions of the check are met. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Check Conditions Not Met
Send an email notification after running aCHECKcommand where the overall conditions of the check arenotmet.See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Fail
If an error occurs during a command, email the error condition. See Email/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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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:OnorOff
Default value:On
Email On Successful Copy
Send an email notification after copying a file usingLCOPY. 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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Check Conditions Met
After executing aCHECKcommand where the overall conditions are met, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Check Conditions Not Met
After executing aCHECKcommand where the overall conditions arenotmet, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Possible values: System command to be executed.
Default value: The valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Repetitive Action Failures
WhenExecute On Failis enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, theExecute On Failcommand will be executed again. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Successful Copy
After successfully copying a file usingLCOPY, 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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Explicit SSL Command
Indicates the AUTH command to be used when the Security Mode specified on the Host/FTP tab is SSL Explicit.
Possible values:
AUTH SSL
AUTH TLS
AUTH TLS-C
AUTH TLS-P
Default value: Depends on the requirements of the trading partners FTP server.
Explicit SSL Post Command
A command or set of commands to be issued after the Explicit SSL Command and login sequence. ThePBSZandPROTcommands (PBSZ 0;PROT P) are required by some servers regardless of the AUTH type used and are necessary for data channel protection (AUTH TLS or AUTH TLS-C).
If multiple FTP commands are needed after the AUTH command, set this property toallof the commands separated by semicolons (;).
File List Parse Method
The NLST commands on some FTP servers do not return a standard file list.
Possible values:TradanetorGXS NBT
Default value: None
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values:0toncharacters.
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:OnorOff
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:OnorOff
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:OnorOff
Default value:Off
Get Number of Files Limit
Limits the number of files retrieved from a server directory listing by oneGETcommand.
Possible values:0-n
0indicates no limit.
Default value:0
High Priority
Indicates whether incoming and/or outgoing transfers through the host should be treated as high priority. When both high priority and regular priority transfers are active, the high priority transfers get a larger portion of the available bandwidth.Go toConfigure > Options > Otherto set theHigh Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Warning:If the trading partners bandwidth (and notCleo Harmony's orCleo VLTraders) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down otherCleo HarmonyorCleo VLTradertransfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance ofCleo HarmonyorCleo VLTraderis both the client and server (for example, a local looptest).
Possible values:
Incoming
Outgoing
Both
Ignore Exception After Quit
Indicates to ignore any I/O errors that occur when attempting to read the SMTP server response after issuing aQUITcommand.
Possible values:OnorOff
Default value:Off
Ignore Retrieve Error Code
Indicates an FTP server response code (after an FTPRETRrequest) that should not be treated as an error condition. This property is useful when the absence of a file on the server is not considered an error.
CAUTION:If the server uses the same error code for multiple reasons, this property can potentially mask unknown error conditions.
Possible values: Three-digit error code value.
You can specify multiple error codes separated by commas (,) or semicolons (;). Alternatively, you can use a regular expression (denoted by enclosing it in square brackets []) instead of a three-digit error code. For example,[550.*No such file.*]would ignore550errors containing No Such File. If it is necessary to include a, or ; in the regular expression, the character would need to be escaped (\x2C or\x3B) instead of using a comma or semicolon. See Using wildcards and regular expressions for additional information.
Include Failure In Subject Of Email
When specified, the exception message will be included in the email that is generated on failure.
Note:If the exception message exceeds 256 characters, it will be truncated.
Possible values:OnorOff
Default value: The value specified for this property on theOptions > Advancedpanel
Include Filename In Store Unique Command
Indicates whether the FTP server expects a starting filename to be included when using the store unique option (PUT -UNI).
Possible values:OnorOff
Default value:Off
Interim Retrieve
Indicates to set result of any successfully retrieved file toInterim Successrather thanSuccess. This would normally be used when transfer logging is being monitored by a backend system to allow coordination of any post processing of the received file that needs to occur prior to setting the transfer status toSuccess.
Possible values:OnorOff
Default value:Off
Issue Command After Opening Data Connection
Indicates to issue the retrieve, store, or list command until after the data port connection has been established rather than before.
Possible values:OnorOff
Default value:Off
Keepalive Noop Command (seconds)
Indicates the amount of time in-between issuingNOOPcommands on the command port while a transfer is active on the data port. 0 indicates to not issueNOOPs.
Possible values:0-n
Default value: 0
LCOPY Archive
If specified, contains the directory for archivingLCOPYsource 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 theOptions > Advancedpanel, 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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
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 theOptions > Advancedpanel, 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 theOptions > Advancedpanel, 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 of0does 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 of0does not limit the transfer rate. The system setting might also limit the transfer rates. The system Maximum Outgoing Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers will also affect individual transfer rates. See Advanced system options for more information about Maximum Outgoing Transfer Rate.
Possible values:0-n
Default value:0
Next File On Fail
When a download fails, indicates whether a wildcardedGETshould proceed to the next available file rather than terminate if the server is still connected.
Possible values:OnorOff
Default value:Off
Only Retrieve First Available File
Indicates aGET *should only retrieve the first available file from the server.
Possible values:OnorOff
Default value:Off
Only Retrieve Last Available File
Indicates aGET *should only retrieve the last available file from the server.
Possible values:OnorOff
Default value:Off
Outbox Sort
Controls the order in which multiple files are transferred for aPUTcommand. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab takes precedence. ForAlphabeticalordering, 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
IfFixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values:OnorOff
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 aCleo LexiComonly option. ForCleo HarmonyandCleo VLTrader, this information is stored in the trading partner management table. See Managing Trading Partners.
Password Automatic Update (days)
If greater than zero andPassword Update Formathas been set, the number of days after which the software will generate and apply a new FTP password.
Possible values:0-n days
Default value:0 days
Password Update Format
If supported by the server, the format of thePASScommand value when changing a user's password. The server dictates the format.
Use%old%and%new%keywords to specify the format, for example,%old%/%new%.
PGP Compression Algorithm
Compression method used when OpenPGP packaging (with compression) is requested through theMailbox Packagingtab. See Configuring mailbox packaging.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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:OnorOff
Default value:On
PGP Signature Verification
Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. In general, this property should be enabled.
Possible values:OnorOff
Default value:On
PGP V3 Signature
Post Get Command
Post Put Command
In an action, specify commands to be executed only after a successfulGETorPUTas post-get or post-put commands, respectively. When using this property, use aSETcommand within theactionbefore theGETorPUTcommandrather than theAdvancedtab.
The Post Put Command can be set toQUIT, which allows a disconnect and reconnect between file uploads when necessary.
If multiple FTP commands are needed after theGETorPUT, set this property toallof the commands separated by semicolons (;). If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes ("). Use of macro variables is supported. Refer to Using macro variables (Post/Pre Command context) for a list of the applicable macros.
Pre Get Command
Pre Put Command
In an action, specify commands to be executed before aGETorPUTas pre-get or pre-put commands, respectively. This has the benefit of keeping the log results relative to justGETs andPUTs (especially important forCleo VLTraderandCleo HarmonyGETtransfer logging). In addition, for thePUT, it avoids connecting and logging into the server when there are no files to send. When using this property, use aSETcommand within the actionbefore theGETorPUTcommandrather than theAdvancedtab.
If multiple FTP commands are needed prior to the GET or PUT, set this property toallof the commands separated by semicolons (;). If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes ("). Use of macro variables is supported. See Using macro variables (Post/Pre Command context) for a list of the applicable macros.
Pre Put Change Directory
ForPUTcommands whose destination contains a directory path, forces an explicitCWDrequest to the destination directory path prior to issuing theSTORErequest.
Some FTP servers treat directories as logical rather than physical directories, and require directories be set only through aCWDrequest.
Possible values:OnorOff
Default value:Off
Pre Put Command For First File Only
If a Pre Put Command is specified, indicates whether to execute them before each file being transferred by thePUTor only before the first file transfer.
Possible values:OnorOff
Default value:On
REST Enabled
Allows the host to be accessible through the REST API. This feature is only supported onAS2,AS4,FTPandSSH FTPandonly 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:OnorOff
Default value:OnforAS2.AS4,FTPandSSH FTPwhen the host has exactly one mailbox.Offin all other cases.
Resume Failed Transfers
When selected and a transfer fails (and Command Retries > 0), attempt to resume the transfer on a retry. If OpenPGP is enabled on the packaging tab (see Configuring mailbox packaging ), the entire file is transferred instead of resuming with a partial file. The server must support theFEAT,SIZE, andREST STREAMextensions to FTP. For more information, visit http://tools.ietf.org/html/rfc3659.
Possible values:OnorOff
Default value:Off
Retrieve Directory Sort
Used to control the order in which files are downloaded from the FTP server. Using this property does cause the LIST command rather than the NLST command to be used when VersaLex is determining the available file list which might be a problem if the server responds with different lists (e.g. NLST only lists files not previously downloaded while LIST lists all files regardless). Windows and Unix/Linux FTP servers are supported.
Possible values:
Alphabetical (ascending)
Alphabetical (descending)
Date/Time Modified (ascending)
Date/Time Modified (descending)
Size (ascending)
Size (descending)
Retrieve Last Failed File First
If a file download previously failed and you are attempting toGETa list of files again, this property indicates whether the previously failed file should be attempted first.
Retry Delay
The amount of time (in seconds) before a retry should be attempted.
Possible values: Any value greater than zero.
Default value:60 seconds
Reuse SSL Session
Indicates the command port SSL session should be reused when possible for any subsequent data port SSL connections. This setting does not affect the reuse of command port SSL sessions.
Possible values:OnorOff
Default value:Off
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:OnorOff
Default value:On
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:OnorOff
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 thatCleo Harmony,Cleo VLTrader, orCleo LexiComwill 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 of0to112,128, or256(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabledexception to occur.
Possible values:0-nbits
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:OnorOff
Default value:On
Terminate On Fail
If an error occurs during a command, stop the action.
Note:
Regarding non-CHECKcommands: WhenTerminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.
RegardingCHECKcommands:Terminate On Failis only honored if theConditionsMetparameter is set and the result of theCHECKis classified asError. TheCHECKcommand is only available in theCleo HarmonyandCleo VLTraderapplications.
Possible values:OnorOff
Default value:On
Unzip Use Path
Indicates whether or not zip entry paths should be used forLCOPY -UNZIPoperations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
Possible values:OnorOff
Default value:On
Use EPRT and EPSV
Indicates to use Extended Port (EPRT) and Extended Passive (EPSV) commands for IPv6-style network addressing. EPRT/EPSV is used regardless of this setting if the host address is or resolves to an IPv6-style address.
Possible values:OnorOff
Default value:Off
Use External IP Address in PORT request
Indicates for active (aka port) mode that the external rather than the local IP address should be included in data port requests to the FTP server.
Possible values:OnorOff
Default value:Off
Use NLST
During aGET *command, indicates that VersaLex should use anNLSTcommand rather thanLISTwhen getting the list of files available for download.
Possible values:OnorOff
Default value:On
Wait For Execute On
Indicates whether execution should wait for processing to complete within anExecute On Fail,Execute On Successful Copy,Execute On Successful Receive, orExecute On Successful Sendcommand. Note that this option does not apply to native AS400 execution.
Possible values:OnorOff
Default value:On
XML Encryption Algorithm
The method used to encrypt/decrypt files when XML Encryption packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 inLCOPY -ZIPoperations.
Default value: The value specified for this property on theOptions > Advancedpanel, if set.
Zip Compression Level
Controls the level of compression forLCOPY -ZIPoperations.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtakes precedence
Possible values:
System Default
9- (Best Compression)
8
7
6
5
4
3
2
1
0- (No Compression)
Default value: SystemDefault
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled forLCOPY ZIP RECoperations. 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:OnorOff
Default value:On
FTP Mailbox Configuration
The FTP Mailbox parameters allow you access to the host system.
Note:This feature is being deprecated. For protocols other than AS3, use a Users host. See Users Host for more information. For AS3, you can continue to use the FTP Users host and mailbox until further notice.
FTP Mailbox: FTP Tab
User Name
Password
FTP Account
Credentials for authentication to the FTP server. SelectNo Password Requiredif there is no password required for authentication.
FTP Accountis optional.
FTP Mailbox: Security Tab
Note:This tab applies only to FTPs hosts.
Security Mode
Possible values:
None- For non-secure transfers, and commands and data are clear-text.
SSL Implicit- For servers that support only SSL connections.
SSL Explicit- For servers that support SSL by using either theAUTH SSLorAUTH TLScommand.
Client Certificate
IfSSL ExplicitorSSL Implicitis specified in theHost FTPtab, the target server can issue client certificates. In this case, import the client certificate using Certificate management and then use the Certificate Alias and Password fields to specify (or browse for) the imported certificate.
FTP Mailbox: Packaging Tab
See Configuring mailbox packaging for information regarding payload file packaging.
FTP Action Configuration
An action's parameters capture a repeatable transaction for your mailbox on the host system. Create a new action under the mailbox.
FTP Action: Action Tab
See Composing an action and FTP Command Reference.
FTP Command Reference
Descriptions of commands and their options, arguments, and parameters.
CHECK
See CHECK Command for information about this command.
CLEAR
Clear an action property string value. The cleared value only affects the commands thatfollowtheCLEAR.
CLEAR property
property
Action property name with no embedded spaces.
Comment
# text...
Lines in the action starting with a # character are considered comments and will be ignored when the action executes. Lines starting with # are generally used for documentation purposes.
DIR
Get a directory listing of available files from the host
DIR "source"
source
Remote source directory path
GET
Receive one or more files from the host
GET [-ASC|-BIN] [-REC] [-DEL] [-UNI|-APE] "source" "destination"
ASC
Transfer file in ASCII format.
BIN
Transfer file in Binary format.
REC
Recursively retrieve nested subdirectories.
When you use theRECoption, nested server directory structure is maintained locally.
When you use theRECoption in conjunction with theDELoption, the retrieved files are deleted from the server, but the subdirectories remain.
DEL
IfGETis successful, delete remote file.
UNI
Ensure local filename is unique.
APE
Append to existing destination file.
source
Remote source path
destination
Local destination path. Use of macro variables is supported. See Using Macro Variables (Destination File context) for a list of the applicable macros.
Path can be to a filename or to a directory.
If relative path, then uses user's home directory.
Use of macro variables is supported. See Using Macro Variables (Destination File context) for a list of the applicable macros.
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-UNZoption.
-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 throughZip CommentandZip Compression Levelproperties. See Setting advanced host properties.
The ZIP archive files created through theLCOPYcommand 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. TheLCOPYcommand works only with ZIP-formatted files. In addition to theVersaLexapplication, 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, theVersaLexapplication 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-RECoption.
Use ZIP entry paths ifUnzip Use Pathis set. See Setting advanced host properties.
The ZIP archive files created through theLCOPYcommand 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. TheLCOPYcommand works only with ZIP-formatted files. In addition to the application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
In addition to standard ZIP-formatted archives, theVersaLexapplication also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Encryption of Zip Files in Cryptographic Services 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-RECand-ZIPoptions, andZip Subdirectories Into Individual Zip Filesis 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-APEoption, or when copying a file with the-APEoption 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 originalinput bytes.
Comma separated list of byte values (0-255).
IfWithparameter is omitted, then theinput bytesare deleted from the file.
PUT
Send one or more files to the host.
PUT [-ASC|-BIN] [-DEL] [-UNI|-APE] "source" "destination"
ASC
Transfer file in ASCII format
BIN
Transfer file in Binary format
DEL
IfPUTis successful, delete local file.
UNI
Ensure remote filename unique
APE
Append to existing destination file
source
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 relative path, then uses user's home directory
usage of macro variables is supported. See Using Macro Variables (Source File context) for a list of the applicable macros.
destination
Remote destination path. Use of macro variables is supported. See Using Macro Variables (Destination File context) for a list of the applicable macros.
QUOTE
Send a raw command to the FTP server
QUOTE "command"
source
Command to be sent to the server. (Example: PWD, CWD, DELE) See the FTP RFC 959 for more details on specific FTP commands.
SCRIPT
See SCRIPT command for information about this command.
SET
Change an action property value. The new value only affects the commands thatfollowtheSET.
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 theCLEARcommand
SITE
Sends a site-specific command to the server.
SITE "command"
command
Site specific command with any arguments
SYSTEM
Execute a local system command.
SYSTEM "path"
"path"
Local command path with arguments.
If you specify a relative path or no path, the command uses the home directory.
See Using operating system commands in actions for additional information
TYPE
Set the default data type for file transfers.
TYPE "data type"
data type
ASCII or Binary
WAIT
Pause execution.
WAIT seconds
Seconds
Number of seconds to pause.
View ArticleA macro variable is a string enclosed in a set of percent signs (for example, %inbox%), used to indicate substitution of other data. You can use macros for many reasons, including, for example, defining a unique file destination, indirectly referencing directory locations (for inboxes, outboxes, etc.), or passing information to anExecute On Successful Sendcommand.
Types of macro variables
Macro variables are classified in one of three ways:
Reserved Macro Variables:Variables that are predefined within theCleo Harmonyproduct. See the table below.
Custom Directory Macro Variables: Directory variables that are defined by theCleo Harmonyuser.See Specifying Default Host Directories for more information about specifying Custom Directory Macro Variables.
Custom Macro Variables Defined as System Properties: Variables that are defined as name=value pairs using the Java D Command Line parameters (see Bootstrap Configuration for further information) or are specified in theconf/system.propertiesfile. Note that Custom Macro Variables are resolved after Reserved Macro and Custom Directory Macro Variables and therefore cannot be used to override those variables.
The following table outlines the macro variables (both reserved and custom) and the various contexts in which they can be used.
Table 1.Macro Variables and their Contexts
Macro Variable
Context
Source File
Destination Files
SYSTEM Command
Default Host Directory
Default Local User Active Directory
Default Root Directory
Windows/Unix Folders
Custom Variable
Execute-On
Pre/Post Command
LCOPY Archive
Accessible through API
Directories Only
Banner/Welcome Message
%system%
X
X
%none%
X
X
%inbox%
X
X
X
X
X
X
X
X
%outbox%
X
X
X
X
X
X
X
X
%file%
X
X
%sourcefile%
X
X
X
X
%srcfile%
X
X
X
X
%sourcefilebase%
X
X
X
X
%srcfilebase%
X
X
X
X
%sourcefileext%
X
X
X
X
%srcfileext%
X
X
X
X
%destfile%
X
X
X
%destfilebase%
X
X
X
%destfileext%
X
X
X
%date%
X
X
X
X
X
X
X
X
X
%time%
X
X
X
X
X
X
X
%index%
X
X
X
X
X
X
%host%
X
X
X
X
X
X
X
X
X
%mailbox%
X
X
X
X
X
X
X
X
X
%status%
X
X
%crc%
X
X
%filesize%
X
X
%transferid%
X
X
X
%filesin%
X
X
%filesout%
X
X
%ebms.timestamp.date%
X
%ebms.timestamp.time%
X
%ebms.action%
X
%ebms.service%
X
%ebms.cpaid%
X
%as2.to%
X
%as2.from%
X
%as2.subject%
X
%oftp.sfiddsn%
X
%oftp.sfidorig%
X
%oftp.sfiddest%
X
%oftp.sfiddesc%
X
%as3.to%
X
%as3.from%
X
%ebics.ordertype%
X
%command%
X
X
custom directory variable
X
X
X
X
X
X
X
X
X
X
X
system.properties variable
X
X
X
X
X
X
X
X
X
X
X
Note:Cells with a bolded, italicized, underscoredXindicate the value might not be known. If the value is not known, the macro name (for example,%sourcefile%) is simply passed through. Further, if a macro is used that is not supported within a particular context (for example, referencing%crc%within a Destination File context), it will simply be passed through as well.
Usingsystem.propertiesVariables
It is possible to add general variables to theconf/system.propertiesfile and use them within the contexts outlined in the table. To add a general variable toconf/system.properties, the syntax is:varName=replacementText. For example, ifconf/system.propertieshas the following:myvar=hello, the usage would be%myvar%in the desired location.
Note:
Unlike other macro variables that are case-insensitive,system.propertiesmacros are case-sensitive.
After adding a macro toconf/system.properties, the service must be cycled before the macro can be processed.
Context Definitions
Macro variables are valid in certain contexts. The following describes the various contexts in which macro variables are valid. Not all macro variables are valid in all contexts.
Source File
Applies to the source values ofLCOPY,LDELETE,LREPLACE,PUT, andCHECKcommands (Cleo HarmonyandCleo VLTraderapplications only). Macros are also supported for the HTTP(s) "filename" parameter and the source values of theGETcommands for FTP and SFTP protocols only. Macros are not supported for the source values ofGETcommands for other protocols or theDIRcommand.
Destination File
Applies to the destination values ofLCOPY,PUT,GET, andCHECKcommands (Cleo HarmonyandCleo VLTraderapplications only). It also applies to default file names, as specified under the hostAS2tab (see AS2 Host: AS2 Tab ), the hostebXMLtab (see ebXML Host: ebXML Tab ), the host EBICS tab (see EBICS Host: EBICS Tab ), and the Local HTTP Users HTTP tab (see Configuring access for HTTP host users ). It also applies to the file destination, as specified under the hostOFTPtab (see OFTP Host: OFTP Tab ). The Destination File context also applies to macros that can be included within HTTP parameter/header values, as defined under the HTTP tabs for HTTP-based protocols (e.g., AS2, ebXML).Also, this context applies to theFileFormatparameter on EBICSGETcommand. See EBICS Command Reference. The Destination File context macro variables may also be used within the Subject header of the SMTP tab.
SYSTEM Command
Applies to theSYSTEMcommand that can be run within the host actions (see Using operating system commands in actions ).
Default Directories
Applies to the default inbox/outbox/sentbox/receivedbox, as specified under the host General tabs (for an example, see FTP Configuration ). The%host%macro variable is supported, but not%mailbox%.
In addition, the%date%macro is supported, but the%time%macro is not. Be careful using the%date%macro in the default outbox because files in the date-stamped outbox subdirectory will not be sent if the send action occurs after midnight. Likewise, archiving entries in sentbox and receivedbox date-stamped directories will only occur for the current date.
Default Local User Archive Directories
Applies to the sentbox and receivedbox archive directories as specified under the local user host General tabs (for an example, refer to Configuring local FTP users ). Both the %host% and %mailbox% macro variables are supported in this context.
In addition, the%date%macro is supported, but the%time%macro is not. Be advised that archiving entries in sentbox archive and receivedbox archive date-stamped directories will only occur for the current date.
Default Root Directory
Applies to the default root directory, as specified under the local user FTP tab, HTTP tab, and SSH FTP tab (for an example, refer to Configuring local FTP users ).It also applies to the user home directory, as specified under the local user mailbox FTP tab, HTTP tab, and SSH FTP tab (for an example, see FTP Mailbox: FTP Tab ).
Windows/Unix Folders
Applies to the UNC paths specified when you set up Windows/Unix folder access. See CIFS Directories. Macros used in this context should always be UNC paths starting with two backslashes (\\). No other macros are supported within macros used in this context.
Custom Variables
Applies to the values that can be specified under custom directory variables on theGeneraltab underConfigure System Options. See Other System Options for more information.
Execute-On
Applies to the system commands that can be specified within the Execute On Successful Send/Receive/Copy/Check properties and the Execute On Fail property (system, host, or action level). See Advanced System Options for information about theAdvancedtab underConfigure System Optionsfor definitions of these properties. With regard to Execute On Fail command, when a command is executed as a result of a failed transfer (either on the client or the server), then all applicable macros are supported.When a command is executed as a result of a general system failure, then only %date%, %time% and %status% are supported.
Post/Pre Command
Applies to the FTP properties Post Get Command, Post Put Command, Pre Get Command, and Pre Put Command, as specified under the FTP Host: Advanced Tab. This context also applies to the Post Put Command and Pre Put Command properties as defined in the SSH FTP Host: Advanced Tab.
LCOPY Archive
Applies to the archive directory that can be specified with the LCOPY Archive property (system, host, or action level). See Advanced System Options for more information.
Accessible through API
Applies to macros that are available throughIactionControllerinterface of the API (if the API is licensed). Refer to the API javadocs for a description of this interface and the method that can be used to obtain a given macro value.
Directories Only
Applies in several places where only the custom directories macros or %inbox%/%outbox% are appropriate.
Banner/Welcome Message
Applies to the banner and/or welcome messages for the HTTP, FTP, SMTP, and SSH FTP servers. See Configuring Local Listener Responses.
Rules Regarding Macro Variable Use
Below are some general rules for macro variable use.
Macros are identified by%c%, wherecis one-to-many characters.
Macro variables are case insensitive. You can enter them in lowercase or uppercase.
You cannot place a%within a macro variable.
When a string contains macros to be resolved and a%that is not tied to a macro, you must escape the non-macro%with%%. After all macro substitution takes place, the software strips the extra%, yielding the intended character sequence. For example,LCOPY test.edi %%%date%_%index%is resolved to%20090714_01.
The*and?characters are not allowed within a macro name. Use other special characters with caution.
When using the%date%and%time%macros, it is your responsibility to ensure the formats for the date and time do not violate any file system naming conventions, for example, if the macros are being used to build a filename or directory.
Macros are not allowed within a source filename that contains a*,?, or regular expression. For example, inLCOPY inbox/%mailbox%*,%mailbox%is not resolved. However, inLCOPY inbox/%mailbox%/*,%mailbox%is resolved because it is referenced in the source directory path and not the source filename.
You can use macros multiple times within the same command. For%date%,%time%and%index%, the same substitution value is used in all references within the same command. However, when you use either of these macros within the destination path of anLCOPY, and multiple files are being copied in one command, the following special rules are enforced:
If these macros are used anywhere within the directory path, they are only resolved once within command.
If these macors are used within the file token, they are resolved for each filename.
Macros you use within a system command, either within theSYSTEMCommand context or within the Execute-On context,can be used as part of the actual command or as parameters to a batch file.
If the absolute path of the any of the files referenced in the macros contain embedded spaces (for example.,%file%resolves toProgram Files\LexiCom\inbox\testHost\test.edi) it might be necessary to add double quotes to the macro specification(s) in the command in order for the command to be properly processed by the operating system. For example,copy %file% %file%.bad.
Special rules apply to using directory macro variables for example,%inbox%,%outbox%,and custom directory variables.
If you use these macros in a source file, destination file, custom directory variable definition, or anLCOPYArchive context, and the path is a non-URI path, they are replaced only at the beginning of the string. For all other contexts (for example, URI source/destination paths,SYSTEMcommands), they are replaced anywhere in the string.
Although allowed, you should not use directory macros should within a remote destination file context, as they reference local directory paths and are therefore nonsensical in this context.
When preceding a path with a directory macro, you should place a file separator character (for example, /or \ between the macro and the subsequent path (for example,%inbox%/test.edi).
When using directory macros, care should be used so as not to create circular references (for example, host outbox references%CustomVar%and%CustomVar%references%outbox%).
All directory macro variables reference their absolute paths.
Reserved Macro Variables
Below is the table of all reserved macro variables.
Macro
Description
Framework Macros
%system%
References the system-level inbox/outbox/sentbox/receivedbox.
%none%
For sentbox/receivedbox fields where this option is available to select, this indicates that there should be no associated sent/receivedbox (rather than defaulting to the system values in the absence of a selection)
%inbox%
References the absolute path of the configured host or local user inbox.
%outbox%
References the absolute path of the configured host or local user outbox.
%file%
References the local file (including the absolute path) involved in the current operation. ForPUTand certainCHECKcommands,%file%is the source file. ForGET,LCOPY, and certainCHECKcommands%file%is the destination file. See CHECK Command.
Note:TheCHECKcommand is only available inCleo HarmonyandCleo VLTraderapplications.
%sourcefile%
%srcfile%
References the source file name involved in the current operation. If the source file is local, and it is referenced in the Execute-On context, then the absolute path is included.
%sourcefilebase%
%srcfilebase%
References the source file name base (everything up to, but not including, the last '.'.
%sourcefileext%
%srcfileext%
References the source file name extension (everything from, and including, the last '.'. If no extension is contained in the source file, blank is returned.
%destfile%
References the destination file name involved in the current operation. If the destination file is local, and it is referenced in the Execute-On context, then the absolute path is included.
%destfilebase%
References the destination file name base (everything up to, but not including, the last '.'.
%destfileext%
References the destination file name extension (everything from, and including, the last '.'. If no extension is contained in the destination file, blank is returned.
%date%
Specifies the current date in the format defined in theMacro Date Formatsetting (system, host, or action level). See Advanced System Options for more information about this property.
%date[+/-#y][+/-#m][+/-#d][,MacroDateFormat=...]%
Specifies a variant of the date as a value in either the past or the future. The '#' character specifies one or more digit values and the order of the +/- fields (y=year, m=month, d=day) dictates the order of the operation, however calendar rules still apply (e.g., if the operation causes the day to wrap to the next month then the month value is automatically incremented). The MacroDateFormat parameter variable is case-insensitive, however if it is specified with the +/- field(s), it must be specified as the last parameter. If it is not specified, the format defined in the 'Macro Date Format'setting (system, host, or action level) is used. See Advanced System Options for more information about this property.
%time%
Specifies the current time in the format defined in the 'Macro Time Format' setting (system, host, or action level). See Advanced System Options for more information about this property.
%time[+/-#h][+/-#m][+/-#s][,MacroTimeFormat=...]%
Specifies a variant of the time as a value in either the past or the future. The '#' character specifies one or more digit values and the order of the +/- fields (h=hour, m=minute, s=second) dictates the order of the operation, however calendar rules still apply (e.g., if the operation causes the minute to wrap to the next hour then the hour value is automatically incremented). The MacroTimeFormat parameter variable is case-insensitive, however if it is specified with the +/- field(s), it must be specified as the last parameter. If it is not specified, the format defined in the 'Macro Time Format'setting (system, host, or action level) is used. See Advanced System Options for more information about this property.
%index%
Specifies the usage of a daily host index value; often used to help guarantee file uniqueness. Each host's index is reset to 1 at the beginning of each day. It is incremented by one every time %index% is referenced.
The minimum number of digits in the index string is determined by the 'Minimum Number Of Macro Index Digits' setting of the of Configure System Options. See Advanced System Options for more information.
%host%
The alias of the host involved in the current operation.
%mailbox%
The alias of the mailbox involved in the current operation.
%status%
The status of the current operation. Returned status values are either "Success" or "Warning" (both denote a successful transaction) and "Error" or "Exception" (both denote a failed transaction).
%crc%
The value of the computed CRC-32 associated with a transferred file. The CRC is computed only when 'Compute CRC on transfers' is on (see Logs for information about the Messages tab in Configure System Options). This feature is available only forCleo HarmonyandCleo VLTraderapplications.
%filesize%
The size of a transferred file in measured in bytes.
%transferid%
The value of the unique ID assigned to a transferred file. This feature is available only forCleo HarmonyandCleo VLTraderapplications.
%filesin%
The number of files received through within an action.
%filesout%
The number of files sent through within an action.
%command%
The full command syntax (only available for the Execute-On context of CHECK commands).
ebMS Macros
%ebms.timestamp.date%
The date portion of the SOAP header's <eb:Timestamp> value. The format of the date is determined by the 'Macro Date Format' setting (system, host, or action level). See Advanced System Options for information about Advanced tab under Configure System Options for a definition of this property. This macro will only be resolved when used in the default file name.
%ebms.timestamp.time%
The time portion of the SOAP header's <eb:Timestamp> value. The format of the time is determined by the 'Macro Time Format' setting (system, host, or action level). See Advanced System Options for information about Advanced tab under Configure System Options for a definition of this property. This macro will only be resolved when used in the default file name.
%ebms.action%
%ebms.service%
%ebms.cpaid%
%ebms.action%= the SOAP header's <eb:Action> value.
%ebms.service%= the SOAP header's <eb:Service> value.
%ebms.cpaid% = the SOAP header's <eb:CPAId> value.
These macros will only be resolved when used in the default file name.
AS2 Macros
%as2.to%
The current AS2-To value provided in the received message header. This macro will only be resolved when used in the default file name.
%as2.from%
The current AS2-From value provided in the received message header. This macro will only be resolved when used in the default file name.
%as2.subject%
The current Subject value provided in the received message header. This macro will only be resolved when used in the default file name.
AS3 Macros
%as3.to%
The AS3-To name of a client. This macro will only be resolved when used in the SITE command within an action to verify that the AS3 names are properly configured on the VersaLex AS3 server.
%as3.from%
The AS3-From name of a client. This macro will only be resolved when used in the SITE command within an action to verify that the AS3 names are properly configured on the VersaLex server.
EBICS Macros
%ebics.ordertype%
For EBICS, this macro will resolve to the order type of the EBICS transaction.
Formatting %date% and %time% Macros
The default%date%setting isyyyyMMddand the default%time%setting isHHmmssSSS.
To specify a different%date%or%time%format, use a pattern string in the 'Macro Date Format' and 'Macro Time Format' setting (system, host, or action level). See Advanced System Options for information about the Advanced tab under Configure System Options for definitions of these properties. Formats may also be specified as part of the macro definition, e.g.,%date,MacroDateFormat=yyyyMMdd%and%time,MacroTimeFormat=HHmmssSSS%
In the pattern, all ASCII letters are reserved as pattern letters, which are defined as the following:
Symbol
Meaning
Example
G
era designator
AD
y
year
2004
M
month in year
September & 09
d
day in month
15
h
hour in am/pm (1~12)
12
H
hour in day (0~23)
0
m
minute in hour
30
s
second in minute
24
S
millisecond
352
E
day in week
Wednesday
D
day in year
259
F
day of week in month
2 (2ndWed in September)
w
week in year
35
W
week in month
2
a
am/pm marker
PM
k
hour in day (1~24)
24
K
hour in am/pm (0~11)
0
z
time zone
Central Standard Time
'
escape for text
delimiter
"
single quote
'
Any characters in the pattern that are not in the ranges of ['a'..'z'] and ['A'..'Z'] will be treated as quoted text. For instance, characters like '.', '#' and '@' will appear in the resulting date or time text even if they are not embraced within single quotes.
Note:A pattern containing any invalid pattern letter will result in a thrown exception during formatting or parsing.
Examples Using Pattern Strings:
%date% Format Pattern
Result
MM-dd-yyyy
09-15-2004
EEE_MMM_d_yy
Wed_September_15_04
%time% Format Pattern
Result
h_mm_a
12_08_PM
K_mma-z
0_00PM-CST
Macro Variable Usage Examples
Destination File Examples:
Action Command
Destination File Result
PUTtest.edi %date%_%time%.edi
20090714_131524352.edi
PUTtest.edi %date-1d,MacroDateFormat=MMdd%.edi
0713.edi
GETtest.edi %srcfile%%date%-%time%-%index%
test.edi20090714-131524352-1
LCOPYtest.edi %date%_%time%.%srcfileext%
20090714_131524352.edi
LCOPYtest.edi %%%date%_%time%
%20090714_131524352
Source File Examples:
Action Command
Source File Result
PUT%inbox%%date%\test.edi
inbox\20090714\test.edi
PUT%inbox%%date,MacroDateFormat=yyyy%
inbox\2009\test.edi
PUT%outbox%%mailbox%\*
outbox\myMailbox\*
Execute-On Examples:
After successful execution of 'LCOPY test.edi test2.edi':
Execute On Successful Copy System Command
System Command Result
cmd.exe /c copy "%destfile%" "c:\temp%destfilebase%.copy"
cmd.exe /c copy "c:\LexiCom\inbox\test2.edi" "c:\temp\test2.copy"
cmd.exe /c ExecuteOnCopy.bat "%destfile%" "c:\temp%destfilebase%.copy"
cmd.exe /c ExecuteOnCopy.bat "c:\LexiCom\inbox\test2.edi" "c:\temp\test2.copy"
Default Host Directory Examples:
Assume the system-level inbox is 'myInbox\' and the custom directory variable, '%custom1%', is set to '\\filsvr01\serverInbox\'.
Host Default Directory (Inbox) Setting
Resolved Location
%custom1%
\\filsvr01\serverInbox\
%custom1%\inbox1
\\filsvr01\serverInbox\inbox1
%system%
myInbox\
%system%\inbox1
myInbox\inbox1
View ArticleWhat's new in version 5.6.1
New connectors and protocol support
New connectors and protocol support have been added in version 5.6.1, including:
AS4 protocol (Server and client)
Kafka connector
AMQP connector
Refer to the Info tab, located in the content pane when you select a connector host, in your Cleo Harmony system for information on using these new connectors. For information on the AS4 protocol, see the AS4 section of the Cleo Harmony User's Guide.
Framework enhancements
There have been several enhancements to the framework of the VersaLex product family in version 5.6.1, including security and performance enhancements. For instance, the Transfers and Event Logs pages now have server-side filtering to pre-filter data before it reaches your system. See Fixed issues in version 5.6.1 for more information about framework enhancements.
Future-proofing your Cleo Harmony program
Deprecating features
The following features are being deprecated in future releases. You can future-proof your program by using newer features instead of the deprecating ones. A warning message has been added to each of the deprecated features' panels with a suggestion of a newer feature to use instead:
Win Unix/File System > CIFS Directories use SMB hosts instead
Router use Router hosts instead
VLPortal use Portal instead
Options > LDAP / User Management > LDAP Settings use LDAP hosts instead
Local FTP Users use Users hosts instead
Local SSH FTP Users use Users hosts instead
Upgrading to version 5.6.1
When upgrading to Cleo Harmony version 5.6.1, Cleo recommends the following:
Back up your configuration using the Export functionality. In the web UI, go to Administration > System > Export. In the native UI, go to File > Export. Performing an Export will save your data in a format that you can import using the Cleo Harmony Import functionality should the need arise.
Make sure your system meets the system requirements for Cleo Harmony version 5.6.1, as it requires greater resources than earlier versions. 64-bit operating systems are strongly recommended. 32-bit operating systems are supported only for existing customers. All new installs must be 64-bit. Visit http://www.cleo.com/supportportal and click the System Requirements link for your product.
AIX is no longer supported in versions 5.6.1 and later.
Run the Cleo Harmony 5.6.1 installer to perform an in-place upgrade. Your data and configuration remain intact from the previous version of the Cleo Harmony software.
Update history
The following sections contain descriptions of issues fixed in Version 5.6.1 and subsequent patch releases:
Fixed issues in version 5.6.1
Major Enhancements AS4
Cleo Harmony only: Added server support for the AS4 protocol. Current offering includes support for eDelivery AS4 Common Profile (version 1.13) and PEPPOL AS4 Profile (version 1.0).
Cleo Harmony only: Added client support for the AS4 protocol. Current offering includes support for eDelivery AS4 Common Profile (version 1.13) and PEPPOL AS4 Profile (version 1.0).
Enhancements Framework
Cleo Harmony only: Added AMQP (Advanced Messaging Queue Protocol) connector host.
Cleo Harmony only: Added Kafka connector host.
Added permissions to Cleo VLNavigator for SYSTEM and SCRIPT commands to allow administrators to restrict users' ability to edit or run these commands.
Added the ability to turn off HTTP basic access authentication for REST API requests.
Added the ability to blacklist IP addresses for REST API requests.
Added ability to select the preferred cipher, digest and compression algorithms when exporting OpenPGP public keys or OpenPGP Public/Private key pairs.
Added server-side filtering to Transfers and Event Logs pages. Document DB queries have been optimized to improve server-side performance. Transfer and Event Log queries have been limited to returning a maximum 250,000 results.
Note: Local Listener and System events require additional data in the records to be properly displayed. As a result, only Local Listener and System events generated after you install or upgrade to the 5.6.1.0 release are displayed using the server-side filtering.
On the new host tree, scheduled actions are now represented with a unique icon: the action icon with a clock on it.
Updated the instances of the Apache common-fileupload.jar currently installed in the VersaLex products to version 1.3.3 to address reported security vulnerabilities.
Cleo Harmony and Cleo VLTrader only: Added setting, Require password reset before first use, to the Password Rules for Users hosts. This new setting requires users to change their password before gaining access to the system. This affects FTP, SFTP, and Portal users.
Cleo Harmony and Cleo VLTrader only: Email address is no longer required for users if the group they belong to does not have HTTP protocol enabled.
The SSL/TLS client handshake now includes the Server Name Indication extension described in RFC 4366 and RFC 6066. The server name sent during the handshake is derived from the host name of the server to which a connection is being established. If this extension is not supported by the SSL/TLS server to which you are connecting, the RFCs require the extension be ignored and the handshake to proceed anyway. If this extension causes handshake errors with any of your trading partner servers, you can set the cleo.ssl.disableservernameindication system property to True to disable this extension in all your SSL/TLS client connections.
Cleo Harmony and Cleo VLTrader only: Added the ability to override the default number of messages returned from the /api/actions/{actionId}/run REST API call using a new ?messagesCount=#### parameter.
Enhancements AS2/AS3
AS2 only: Fixed an issue where, when incoming messages fail with an InsufficientSecurityException, the Email On Fail alert was being sent to the system-wide email address configured in the System > Advanced panel instead of the email address configured for the receiving host.
Enhancements ebMS
Added the ability to include additional Content-Type parameters when sending ebXML payload. See the User's Guide for further information.
Enhancements Portal
Added external.ip.address.http.port and external.ip.address.https.port properties to the extended.properties file so that administrators can customize the port for URLs in Portal emails.
Portal users will now be redirected to a password reset page after their initial successful login attempt when the Require password reset before first use property is set.
Enhancements Connector
Added the ability for the Router to move incorrectly formed EDI documents to the error destination.
Cleo Harmony and Cleo VLTrader only: In the Clarify connector host, support for future Clarify functionality was added to allow use of the filename passed from Clarify as part of the VersaLex filename. Therefore, PUT commands using the Clarify connector host can be used to selectively send specific file types coming from Clarify. Check your Clarify documentation for availability. Note: Requires use of the SendMessageToHarmonyWithMetadata task in Cleo Clarify.
Cleo Harmony and Cleo VLTrader only: Added support for recursion option on DIR, MKDIR, and RMDIR connector commands in general. However, this means the File connector MKDIR no longer recursively makes parent directories without the -REC option, and the SMB connector RMDIR no longer recursively removes child directories and files without the -REC option. Also note that -REC is also supported on GET * and that this will replicate the directory structure from the source to the destination.
Cleo Harmony and Cleo VLTrader only: Added transparent encryption support to the HDFS connector.
Enhancements AS2/FTP/SSHFTP
Cleo Harmony and Cleo VLTrader only: All properties are now supported for AS2, FTP, and SSHFTP via the /connections REST endpoints. However, responses from /connections endpoints will not include properties when the values for those properties match their default value. This can be overridden by adding the ? includeDefaults=true query parameter to the request. See developer.cleo.com for more details.
Bug Fixes Framework
Fixed an issue where it was possible that duplicate UIDs could be generated for different resources. Now, if an existing resource is found to have a duplicate UID, it is given a new one.
Fixed an issue where scheduling an empty action for event triggers would cause a null pointer exception and prevent triggering other actions. All actions are now triggered appropriately even when an empty action is scheduled.
Fixed an issue where cloning a host from the native UI would result in the cloned host throwing an error when used until the service is restarted.
Fixed an issue where VLMailc would return a 0 exit code if invalid parameters are specified. Specifying invalid parameters now returns a 255 error code as expected.
Cleo Harmony and Cleo VLTrader only: Fixed an issue where LDAP users in a Users host were incorrectly counted against the mailbox license count when the Home Directory was disabled for those users.
Fixed an issue where password rules were being set incorrectly via the /authenticators endpoint.
Fixed an issue where some non-OpenPGP files would cause a PGPIOException to occur instead of processing the file when the Allow Non-OpenPGP setting was enabled within Local and Partner Packaging.
Cleo Harmony and Cleo VLTrader only: Fixed an issue where, when LDAP local users were defined, REST API calls were causing LDAP lookups for every request.
Cleo Harmony and Cleo VLTrader only: Fixed an issue where importing an existing host using the command line would cause a null in ComputerName of the VLOpAuditTrail table, which would cause an error to be logged.
Fixed an issue where scheduling a monthly action with a timezone different than the local one caused the action to run twice.
Fixed an issue where the Autosend Retry Attempts property (Administration > System > Other) was not being honored (causing failed transfers to run continually) and would never stop for the Autosend Restart period.
Fixed an issue where certificates stored in the certs directory could not be exported through the Export User Files export window on Linux.
Cleo Harmony and Cleo VLTrader only: Fixed an issue where an inbound transfer for an LDAP user, configured for incoming database payload, would be marked as 'Interim Success' instead of 'Success'.
Cleo Harmony and Cleo VLTrader only: Fixed an issue where exporting an action from the new host tree right-click menu would export the mailbox instead.
Fixed an issue where, if you had a host with multiple mailboxes and two contained an action with the same name, attempting to export one of the actions would not actually export the action.
Cleo Harmony and Cleo VLTrader only: Fixed an issue on the web admin UI Transfers page where a transferred file without a file size could not be viewed.
Fixed an issue where applying a permanent license from the web admin UI would require a restart for the license to take effect. The license now takes effect immediately.
Fixed an issue where the Email Profile and Wizard right-click menu dialogs were not being displayed in the web UI.
Bug Fixes FTP
Fixed an issue for specific FTP servers where FTP/s implicit would not send correct SSL commands.
Bug Fixes AS2/AS3
Fixed an issue where AS2 compressed messages would not be processed if the smime-type had quotes around 'compressed-data'.
Fixed an issue where a NullPointerException would be logged while processing the signature of a partner's MDN that did not include a signature algorithm or digest algorithm.
Bug Fixes SSH FTP
Fixed an issue where, when multiple simultaneous calls were being made to get the preferred cipher algorithms list, a ConcurrentModificationException was being thrown.
Fixed an issue where SSH FTP extended file attribute responses would not be read correctly.
Bug Fixes WS
Fixed an issue where the configured forward proxy was not used to load the WSDL from the configured WSDL location URL.
Bug Fixes Connector
Cleo Harmony and Cleo VLTrader only: Fixed an issue where, when a connector was being used to stream data from a directory containing a large number of files and the action that was using it was interrupted, the connector would continue to list the files in the background.
Cleo Harmony only: The Azure Blob Connector now returns the full path to a directory on a DIR command instead of a relative path.
Cleo Harmony only: Fixed an issue with the S3 connector where not setting the region caused an exception. Not setting the region now uses the default region as expected.
Cleo Harmony and Cleo VLTrader only: Leading or trailing spaces included in configured EEI connector trading partners and their related IFS folders will now be ignored. With this update, 'tpname' and 'tpname ' will be considered the same and will cause duplicate trading partner detection in enabled hosts.
Cleo Harmony and Cleo VLTrader only: Fixed an issue where the Home connector would always throw an Unauthorized Path error if it resolved to another connector with Authorized Roots enabled.
Security Framework
Cleo Harmony and Cleo VLTrader only: Fixed an issue where a connector that an administrative user does not have access to could be used as a directory for a User group.
Expired trusted CA certificates will not be installed for new Cleo VersaLex software installs. The expired certificates will remain intact for Cleo VersaLex software upgrades. Additional trusted CA certificates have been added.
Security Portal
Cleo Harmony and Cleo VLTrader only: Sharing permissions are now required to obtain anonymous download links for files and folders in Portal.
Cleo Harmony and Cleo VLTrader only: Fixed an issue where personal information was displayed in the developer console when logging into Portal.
Known issues in version 5.6.1
The following are known issues in Cleo Harmony 5.6.1:
Due to ever-changing security requirements, you might encounter system protection on Windows that refuses to run the installer. Click Run anyway to dismiss the notification and continue the installation process.
In Firefox, after downloading a file in Portal, the loading spinner remains on the screen and prevents any elements on the page from being clicked. Refreshing the page removes the loading spinner and allows the user to continue to use Portal.
View ArticleCleo Harmonysoftware provides you with a wide variety and combination of file transfer capabilities that allow you to initiate transfers, control your transfers and environment, monitor your file transfer activities, and take actions as appropriate based on your file transfer activities.
Cleo VersaLexis the platform that powers theCleofamily of Secure Data Integration (SDI) productsTheCleo LexiCom product is a desktop-based client solution for communication with major trading networks. TheCleo VLTrader product is a server-level solution designed to meet the needs of mid-enterprise organizations. TheCleo Harmony product is tailored for large enterprise needs. Enterprise capabilities include system monitoring, enhanced business-level dashboards, VLTracker, SNMP traps, dynamic blacklisting, and whitelisting.
What's new in release 5.6
NewCleo Portalfeatures
Cleo Portaland Unify in Portal supports simple ad-hoc data movement between end users. New features were added toCleo Portalin version 5.6 to streamline sharing and user management. Sharing features have been expandend to include a replacement for the retired Outlook Connector using anonymous links. Users now also have the capability to move, copy, and rename files in Portal. User management enhancements include shared SAML/Local login, two-factor authentication, and expiration dates for access to certain items.
New Connectors
New connectors have been added in version 5.6, including:
Azure Blob: Connect with Microsoft's Azure Blob storage.
GCP Storage: Connect with Google Cloud Platform's file storage containers.
Router: Route files based on file names and content.
Refreshed Host Tree
The web admin user interface has undergone a transformation to improve usability and responsiveness as well as decrease required resource overhead. In version 5.6, the Host Tree in the web UI is refreshed with a new aesthetic and new options. Users now have the ability to search within hosts, including an advanced search. The Local Listener has been moved out of the Host Tree and can be found in the Administration tile.
Framework enhancements
There have been several enhancements to the framework of theVersaLexproduct family, including security and performance enhancements. See Fixed issues in version 5.6.0.0 for more information.
Upgrading to version 5.6
When upgrading toCleo Harmonyversion 5.6, Cleo recommends the following:
Back up your configuration using the Export functionality. In the web UI, go toAdministration > System > Export. In the native UI, go toFile > Export. Performing an Export will save your data in a format that you can import using theCleo HarmonyImport functionality should the need arise.
Make sure your system meets the system requirements forCleo Harmonyversion 5.6, as it requires greater resources than earlier versions. 64-bit operating systems are strongly recommended. 32-bit operating systems are supported only for existing customers. All new installs must be 64-bit. Visit http://www.cleo.com/supportportal and click theSystem Requirementslink for your product.
Run theCleo Harmony5.6 installer to perform an in-place upgrade. Your data and configuration remain intact from the previous version of theCleo Harmonysoftware.
Upgrade considerations
There are some upgrades made available in version 5.6 that can affect your system in ways you might not anticipate and that you should be aware of.
Cleo Portal custom branding
If you implemented custom branding in Cleo Portal, you might need to modify your implementation before upgrading. Please refer to the product Help section "Customizing Cleo Portal" for instructions on changing custom branding.
Local Listener moved to Administration
In the web admin UI, the Local Listener has moved from the Hosts page toAdministration>Network. The functionality of the Local Listener has not changed from previous releases.
ThirdParty database driver .jars removed
The.../lib/secureshare/mysql-connector-java-5.1.25.bin.jarand.../lib/secureshare/sqljdbc4.jar.jars have been removed from the product. While they should not have been used, these files could connect to the configured enterprise database. To ensure enterprise database connectivity, make sure you have the correct JDBC driver .jar for the database in the.../lib/ext/directory.
VLIncoming database table size changed
The database payloadVLIncoming.Filenamecolumn size has been increased from 100 to 255.
Update history
The following sections contain descriptions of issues fixed in Version 5.6 and subsequent patch releases:
Fixed issues in version 5.6.0.1
The following issues are fixed in Version 5.6.0.1:
Bug Fixes Framework
Fixed an issue where applying a permanent license from the web admin UI would require a restart for the license to take effect. The license now takes effect immediately.
Bug Fixes AS2/AS3
Fixed an issue where aNullPointerExceptionwould be logged while processing the signature of a partner's MDN that did not include a signature algorithm or digest algorithm.
Security Framework
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where a connector that an administrative user does not have access to could be used as a directory for a User group.
Security Portal
Cleo HarmonyandCleo VLTraderonly: Sharing permissions are now required to obtain anonymous download links for files and folders in Portal.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where personal information was displayed in the developer console when logging into Portal.
Fixed issues in version 5.6.0.0
The following issues are fixed in Version 5.6.0.0:
Major Enhancements Framework
Cleo HarmonyandCleo VLTraderonly: Added a new inbound/outbound Router connector that can be used to route files based on filenames and/or file content. Common routing tokens are natively extracted for EDI (X12, EDIFACT, TRADACOMS) and HL7 files; tokens can be extracted from other text files using regular expressions. Route destinations can be file systems or other connectors, and destination filenames can make use of any of the extracted tokens. Refer to theInfotab within theTemplates>Generic>Generic Routerhost connection for more details.
Cleo Harmonyonly: Added a new connector to allow communication with Microsoft Azure Blob Storage. Refer to theInfotab within theTemplates>Generic>Generic AzureBlobhost for more details.
Major Enhancements Portal
Enabled moving, copying, and renaming of files and folders in Cleo Portal.
Enhancements Framework
Cleo HarmonyandCleo VLTraderonly: Improved performance when retrieving events through the REST API.
Reduced the number of times the file system is accessed when resolving a unique filename to increase performance on file systems with high latency.
Added newRetry All Failed Scheduled Actionsproperty to theAdministration>System>Otherpanel. When enabled, the scheduler automatically retries actions that fail. Retries occur after theAutosend Restarttime (in minutes) has elapsed. By default, when some actions fail (both autosend and periodic), the user is instructed to correct the action and either run it interactively or restart the schedule. Enable this option to avoid this manual intervention.
Cleo HarmonyandCleo VLTraderonly: SynchronizedCleo VLTraderandCleo Harmonynodes can now be organized into logical groups that designate how production and backup systems will respond when production systems go offline. Supported group configurations are multiple production/backup groups or one all-production group and one all-backup group. See theSynchronizationsection of the User's Guide for further details.
Cleo HarmonyandCleo VLTraderonly: Added support for URL parameters in virtual subfolders in Users hosts. Additionally, the%username%macro is supported in the URL parameter. Example:MyHome=Smb:SmbHost?smb.SharePath=//filsvr01/users/home/%username%
Cleo HarmonyandCleo VLTraderonly: Added a new page in the Web UI allowing administrators to view all Portal users.
Cleo HarmonyandCleo VLTraderonly: Updated the/users/{userId}REST API endpoint to provide more user information. The endpoint/users/{userId}now returns login and sharing information if Unify in Portal is licensed and enabled. Added the endpoint/usersfor administrators to obtain a list of users they can view.
Cleo HarmonyandCleo VLTraderonly: Added a new design for the VersaLex event logs report.
Cleo UnifyandCleo Portal: Added option for two-factor authentication for User hosts when Unify in Portal is licensed.
When a 'New License is available' email is generated, the email now contains all the differences between the active and available license.
Cleo HarmonyandCleo VLTraderonly: AddedAdministration>Other>LDAP SSL Minimum Protocol VersionandAdministration>Other>LDAP SSL Maximum Protocol Versionproperties, allowing client connections to LDAP servers to be negotiated with SSL protocol versions other than the default settings of SSL 3.0 for the minimum value and TLS 1.2 for the maximum value.
The%date%macro is now supported in default inbox/outbox/sentbox/receivedbox directories defined under the hostGeneraltabs and the sentbox and receivedbox archive directories defined under the local user hostGeneraltabs. Be careful using the%date%macro in the default outbox because files in the date-stamped outbox subdirectory will not be sent if the send action occurs after midnight. Likewise, archiving entries in the sentbox, receivedbox, sentbox archive and receivedbox archive date-stamped directories will only occur for the current date.
Cleo HarmonyandCleo VLTraderonly: Added ability to Schedule and Unschedule multiple Actions in a single operation on the Web UISchedulerpage.
Cleo HarmonyandCleo VLTraderonly: Changed the behavior inCleo Portaland the Web admin UI so that a session timeout while logged in with SAML now causes the user to be taken to the same thank you page as when explicitly logging out. The thank you page contains a link to log in again. Previously, a session timeout would cause the user to be taken back through the SAML login flow immediately.
Cleo HarmonyandCleo VLTraderonly: Implemented shortcuts for unscheduling actions on the Web UISchedulerpage.
Cleo HarmonyandCleo VLTraderonly: Added ability to resize and reposition certain dialog boxes in the new Web UI.
Cleo HarmonyandCleo VLTraderonly: Added ability to locate a table row containing the related information displayed in theInformationpanel.
Cleo HarmonyandCleo VLTraderonly: The session powering the classic pages in the web admin UI (for example, the Hosts page) is now prevented from timing out while using the non-classic pages. This means that a user will no longer experience delays (identified by the "spinning wheel") when transitioning from the Scheduler, Transfers, Logs, or Administration pages back to the Hosts page or another classic page.
Cleo HarmonyandCleo VLTraderonly: Increased the database payloadVLIncoming.Filenamecolumn size from 100 to 255.
Cleo HarmonyandCleo VLTraderonly: Added the ability forCleo VLNavigatorusers to impersonate other non-administrator users. Added the propertyAllow User Impersonationto the VLNav connector to permit impersonation of users. See VLNav connector and developer.cleo.com for more information.
Improved speed of inbound and outbound PGP and XML encryption (Packagingtab) by increasing buffer size from 1KB to 8KB.
LexiCom is now supported on IBM i7.3 (AS/400 V7R3). For further information on installation and setup, see the AS/400 Setup and Installation section in the Cleo LexiCom User Guide.
Cleo HarmonyandCleo VLTraderonly: Improved the connector property table editor, adding cloning and search capabilities. Also added a table row editor for larger tables and fields. Additionally, added row order controls for certain connectors.
Cleo HarmonyandCleo VLTraderonly: Added ability to customize the FTP server's SYST command response. See the User's Guide for further details. Note:Cleo VLProxy3.7.0.1 or later is needed if usingCleo VLProxy.
Cleo HarmonyandCleo VLTraderonly: Added the ability in IP Filters to add an IP or IP range that should never be blacklisted. Note:Cleo VLProxy3.7.0.1 or later is needed if usingCleo VLProxy.
Added more debug logging when exceptions occur while the UI is attempting to add a host.
Cleo HarmonyandCleo VLTraderonly: Added File connector support for the inbox, outbox, and home directories when issuing REST requests. Previously, all URI paths containing the 'file:' prefix would be removed so an actual File URI could not be set. The 'file:' prefix in the JSON content should only be used when the URI is an actual File connector; however, the URI path is checked and the 'file:' prefix is removed if the URI is not referencing an actual File connector.
Cleo HarmonyandCleo VLTraderonly: Added functionality forNew FileandSession Endtrigger actions to run when files are re-received.
Cleo HarmonyandCleo VLTraderonly: Added the ability to add an action to aUsersmailbox through the REST API.
Added the ability to export CA certificates that contain an OpenPGP or SSH FTP public key.
Enhancements HTTP
Added the capability to output specific headers in response to invalid resource paths. Specifying[ALWAYS]at the end of a Web Browser Response Header will include that header in cases where the resource path is invalid. Note:Cleo VLProxy3.7.0.8 or later is required if usingCleo VLProxy.
Enhancements AS2/AS3
Added support for theRSASSA-PSSsignature algorithm andRSAES-OAEPkey encryption algorithm. These new algorithms can be configured through the newSignature AlgorithmandKey Algorithmfields in theAS2andAS3mailbox panels and theLocal FTP User AS3panel.
Enhancements SSH FTP
Cleo HarmonyandCleo VLTraderonly: A password is no longer required for a mailbox to be ready in a Users host where only theSSH FTPprotocol is enabled and SSH Key authentication is being used.
Cleo HarmonyandCleo VLTraderonly: A mailbox in a Users host can now be set to require both a password and an SSH key when authenticating.
Enhancements OFTP
Added a new Advanced property,Fixed Record Length From OFTP, that, if set, causes EOL characters to be inserted while receiving a file based on theSFIDLRECLvalue. Note: In order for this property to take effect, the following must be true:Fixed Record EOL Charactersmust be specified,Fixed Record Incoming Insert EOLmust be enabled, and a fixedSFIDFMTformat with a positiveSFIDLRECLvalue must be requested by the OFTP trading partner.
Enhancements MQ
Added the option to use a default Queue Manager for MQ hosts.
Enhancements Portal
Enabled adding and modifying user access expiration dates on shared items.
Cleo HarmonyandCleo VLTraderonly: Added the ability to enable both SAML and local login forCleo Portalusers at the same time.
Cleo HarmonyandCleo VLTraderonly: Updated the/foldersand/folders/{folderId}/childrenresponses to return an object calledsharing.sharedByTypeto indicate how the Resource was shared with this user. Renamed thesharing.sharedByobject tosharing.sharedByUser.
Reduce loading time for initial logins to Portal when Unify in Portal is enabled.
Made improvements to reduce the time it takes to display the files in a directory through Portal. This is especially evident on folders with a large number of files.
Enhancements Connector
Cleo HarmonyandCleo VLTraderonly: Added the ability for the S3 connector to use transfer acceleration with an S3 bucket enabled with accelerate mode.
Added source deletion monitoring feature to connector hosts.
Cleo HarmonyandCleo VLTraderonly: Added the ability for the S3 connector to use the default credentials provider chain when running VersaLex on an EC2 instance. In this case, if an IAM role is defined, theAccess KeyandSecret Access Keyproperties become optional.
Cleo HarmonyandCleo VLTraderonly: Added a store-and-forward feature that is available when configuring an EEI connector URI as the inbox. When theStore And Forwardconnector property is enabled and the host's receivedbox is configured, if a failure occurs on an inbound transfer while attempting to access the EEI queue on the AS/400, the receivedbox copy is still completely 'stored' and then 'forwarded' later when the EEI queue is available again. Note: For this feature to work,Administration>Other>Disable Date/Time Portion Of Filenames In Sent/Received Boxmust be unchecked.
Added aSystem Publicproperty for connectors that permits access to a connector from any folder branch.
Bug Fixes Framework
Fixed an issue where VersaLex would fail to startup ifAuthorized Rootswas enabled and a connector used itself as a host directory (for example, inbox or outbox).
Cleo HarmonyandCleo VLTraderonly: Added support for an endpoint atPATCH/actions/{actionId}so that users with view-only permissions on hosts are still able to schedule actions as long they have the permission to edit the schedule.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where the SQL Query used forUPDATEwith functional acknowledgment tracking was not valid when using a Postgres database.
Removing a host folder from one node now removes it from all other nodes in the synchronization pool.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where, when EDI tracking was enabled, actions would not complete if there was a large number of spaces at the end of the EDI file.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where some unused database connections were not being closed causing certain database systems to run out of connections.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where files containing less-than and greater-than signs could not be properly viewed on theTransferspage in the web admin.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where triggered actions could be missed when the trigger event happened at the same time as the start of aSchedulerloop.
Fixed an issue where aCustom LexiComOutgoing Thread Classwould not execute properly if VersaLex was running as a service or daemon.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where a new thread would be created with each SAML request.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue in Portal where anonymous file download links were unable to bypass the login page when SAML mixed mode was enabled.
Added missing documentation in the User Guide for the -b (backup) command line option.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where a REST API call for transfers would fail if there were more than 1024 AS2 Async MDN transfers in the results.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where permissions listed on a Users home directory would be ignored for FTP and SFTP unless either permissions or a virtual file system link were used on a subfolder. Also fixed an issue where resolving the%inbox%and%outbox%macros would expand to include any permissions and/or links specified for those folders.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where aConcurrentModificationExceptionwas seen intermittently under high load against the VersaLex SOAP web service endpoint.
Fixed a problem where mailboxes configured to authenticate usingConnector Hostauthentication were unable to login correctly. This problem was introduced in patch 5.5.0.7.
Fixed a problem that could cause deadlocks to occur, for example, suspended AS2 actions and suspended scheduler processing. This problem was introduced in patch 5.5.0.7.
Updated the Event Logs' advanced Event Type filter dialog box to fix an issue where response errors were not filtered correctly.
Fixed an issue where breadcrumbs were not being populated appropriately when displaying Administration User Management features.
Fixed an issue where using inline filtering could leave the page in an invalid state.
Fixed an issue where synchronization over HTTP/s could cause performance related issues when there are more than several thousand CA certificates loaded.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue with authentication against Lotus LDAP.
Fixed an issue where anAccess is Deniederror was being logged on startup while attempting to read the host files.
Fixed an issue where a store-and-forward file could remain on the active IO list, causing the trading partner to see an error if the file is resent very quickly (within a few seconds).
Updated expired test.cleo.com SSL and signing/encryption certificate used for Support Bundles and Cleo System Test hosts.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where aNullPointerExceptionwould occur when attempting to log in to the FTP server through LDAP, but the LDAP server was not configured. This issue would only occur whenCleo Harmony/Cleo VLTradercontained a Users host configured to use a VLNav connector.
Fixed an issue in the UI where the user was blocked from updating a host Inbox/Outbox/Sentbox/Receivedbox setting from an invalid path to a valid path value. This was most often seen when using URI values for the Inbox/Outbox values.
Fixed an issue where duplicate Email entries were being added when importing a Users host and merging it with an existing Users host.
Fixed an issue where certain scheduled items could throw aNullPointerExceptionwhen run on a slave node of a cluster. This would only occur for actions that were not scheduled for autosend. Furthermore, this problem would not block the action from ultimately running, as the master node would recover and run the action.
Fixed an issue where a remote user would not be able to log in after the host was deleted outside the product and imported again using the same name with a different combination of uppercase and lowercase characters.
Fixed an issue where an action would get scheduled twice if a host was imported with the same alias as an existing host, but using a different combination of uppercase and lowercase characters.
Fixed an issue where, when you tried to change the case of any character in a host name from uppercase to lowercase or vice versa, a hidden window would open and cause the service to become locked.
Fixed an issue where the software update function would not use proxies other than the system default as a forward proxy, even if they are available.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where the user to be impersonated (typically identified by either email address or username) could not be identified by email address.
Fixed a problem where a native AS/400 sign-on dialog box could unexpectedly be displayed on the user's computer.
Fixed an issue where LDAP users configured in Cleo VLNavigator were not able to log into the admin web UI.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where a PGP certificate would cause an incorrect error message during a certificate expiration check.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem in the Web UI where transfer events were not being sorted correctly.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where/api/actionswould return aNullPointerExceptionafter an outbox file is downloaded through the REST API.
Changed method for passing stable files lists to scheduled autosend actions, making the process more reliable.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where a bad trading partner certificate used in a mailbox could prevent the Local Listener from properly starting.
Fixed a problem where, when running natively on the AS/400 and using theBrowsebutton to select a new certificate, a dialog box would be displayed incorrectly stating that the certificate was a duplicate.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem on the Scheduler Page in the web UI where the host filter options contained out-of-date values.
Fixed a problem where the%sourcefile%macro was not resolving in theExecute On Successful Copycommand.
Fixed a problem that caused aPUTcommand to erroneously delete the source when a precedingPUT -DELcommand failed during its source deletion phase.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where access to the Web admin UI viaCleo VLProxywas being allowed even though it was configured to be disabled. This occurred whenCleo VLProxywas being accessed through the portal web UI.Cleo VLProxyVLProxy 3.7.0.2 or later.
Cleo HarmonyandCleo VLTraderonly: Fixed a database payload issue where updating the VLSend table could result in a SQL syntax exception after a failed send attempt.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where the Scheduler table did not correctly restore the saved column states.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where scrolling through the date filter's calendar did not display the correct months.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where listening on server ports would be delayed if the local user folder creation was slow.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem in the FIPS edition of the product where you could neither configure nor use SAML.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where any logged-in user could see all host actions when performing a search regardless of permissions.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where updating a connector table property through the REST API would have an issue if special characters like{and}appeared in the table property value.
Cleo HarmonyandCleo VLTraderonly: Fixed problem where aUsers Privilegespanel would not update appropriately after a new product license was applied.
Fixed an issue in the Web admin UI where inapplicable pages were shown when an anonymous user was logged in.
Fixed a problem where downloading an installer through software update would fail at the end of the download with an EOFException.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where an LDAP user could not be added to a non-LDAP user group inCleo VLNavigatorbecause an Email Address was required.
Cleo HarmonyandCleo VLTraderonly: Added proper support for SAML deflate encoding/decoding with signatures.
Cleo HarmonyandCleo VLTraderonly: Fixed a potential problem with the ability to log into the Web admin UI if the Local Listener host had been manually deleted.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where apostrophes in file names would cause child folder listings to fail in Portal.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where autosend actions would not run if there was an error with any Connector Host used within any autosend action.
Improved appearance of pointer when hovering over a selectable table row.
Bug Fixes FTP
Fixed a problem where theSource.Directoryproperty was not being included as part of the properties that can be retrieved through the Java API'sILexiComIncominginterface.
Bug Fixes AS2/AS3
Fixed an issue where VLTransfers will show 'In Progress' transfers when receiving a CEM request or response.
Fixed an issue where, when embedded '@' characters were included in the host and/or mailbox alias, the host and mailbox names would be displayed incorrectly in the MDN panel and resends after an asynchronous MDN timeout (AS2 only) would fail.
AS2 Only: Fixed an issue where, when using PGP or XML packaging on an AS2 outbound stream and an IOException occurred, the connection would hang indefinitely.
Fixed a problem where a large, AS2 compressed message containing 'compressed' in the source file name could not be successfully decompressed.
Bug Fixes ebMS
Fixed an issue where, when embedded '@' characters were included in the host and/or mailbox alias, the host and mailbox names would be displayed incorrectly in the Acks panel.
Fixed an issue where, when sending database payload using HTTP/s through Cleo VLProxy, the action would hang indefinitely if the connection to the remote host could not be made.
Bug Fixes SSH FTP
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where some SFTP clients connecting to theCleo HarmonyorCleo VLTraderSFTP server would see a 12-hour timestamp instead of a 24-hour timestamp.
Fixed a problem where theSource.Directoryproperty was not being included as part of the properties that can be retrieved through the Java API'sILexiComIncominginterface.
Bug Fixes OFTP
Fixed an issue in which, when an OFTP trading partner was sending to a VersaLex OFTP 'Server Only' host but disconnected before the host sent all its files to the trading partner, aNullPointerExceptionwas being thrown while the host attempted to re-establish the connection.
Fixed a problem where back-to-back CD requests should be allowed following an EFPA(Speaker=Yes) request, as per RFC 5024 Section 3.3.4.2 Rule 4.
Fixed a problem where if the server successfully received a file but the client sent an ESID right after the transfer finished, the transfer was not being marked as completed.
When VersaLex returns an OFTP EERP or NERP, now in all cases a hash value is only included if either the ERRP or NERP is signed or if the 'Always Include EERP Hash' advanced property is on.
Bug Fixes SMTP
Fixed a problem with SMTP where the stringnullwas preceding the source file string when using a%sourcefilebase%macro in theSubjectfield. This condition would only occur when the message also contained "Inline" text.
Bug Fixes WS
Fixed an issue where if the%index%macro was used in a WS action, the UI and service/daemon would lock up. Also fixed an issue for all host types where the index would be incremented erroneously when validating the commands of the action.
Bug Fixes Portal
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where clustering empty graph databases sometimes caused one to start incorrectly.
Cleo HarmonyandCleo VLTraderonly: Removed default minimum date on datepickers in Cleo Portal.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where a newly added LDAP user would not be able to login to Portal without a long wait or triggering an LDAP update through the UI.
Cleo HarmonyandCleo VLTraderonly: Fixed bug where single quotes in folder names caused these names to be appended to child folder names.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where file uploads through Portal failed to fire triggers which were configured to respond to the uploads.
Fixed an issue with concurrent downloads through Portal on the same file causing an exception.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where only the 'administrator' user of the Administrators group could login directly to the Web admin UI with SAML enabled.
Bug Fixes Connector
Fixed an issue that could cause duplicate Connector send actions to be executed when receiving a SFTP transfer with inbound decryption.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where aNullPointerExceptionwas thrown ifDo Not Send Zero Length Fileswas enabled on a Connector host and an attempt to send a zero-byte file was made.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where resending a connector transfer would fail through REST and the Web UI (non-classic mode).
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where, when the EEI connector's AS400 connection was re-established after a connection failure, old connections would continue to use system resources.
Cleo Harmonyonly: Fixed an issue in the S3 connector where commands would fail when access was not available to all the parent folders.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where having multiple EEI connectors in use could eventually cause socket exceptions with "No buffer space available".
Fixed an issue where a '%' followed by a hexadecimal value in an action name could result in an exception or incorrect values in the database when using 'LogTransfersForPutAndGet=%this%' in a URI path.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue where a Connector Action with aSETcommand would not properly be triggered.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where a property change in a newly imported Connector Host is not seen on the first run of an action within that host.
Cleo HarmonyandCleo VLTraderonly: Fixed an issue with the SMB connector where SMB1 only shares would incorrectly show all files as 0 bytes in Portal.
Bug Fixes HSP
The HSP server is now more resilient when an unexpected exception occurs. Previously, this would cause an HSP session to not be properly closed, leaving the destination file in a locked state and not allowing a retry attempt from the trading partner.
Fixed an issue with HSP where the transfer would fail if the inbox on the receiver was using a Connector Host.
Bug Fixes Router
Fixed an issue where a file transferred using the Router connector would incorrectly show the timestamp of the file as 01/01/1970 00:00:00.
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where a URI (for example,smb:Fileserver01/...) could not be used as a destination in the new Router connector.
Security Framework
Access tokens in URL query strings are no longer accepted as valid authorization for any endpoints except /files and /folders GET requests.
Addressed an issue where a fuzzing operation performed on the user invitation functionality corrupted a host file, which subsequently prevented the user from logging in to the web UI. Note: Although Cleo was not able to reproduce this error, extra checks were added to better verify the integrity of email addresses for user invitation operations. Further, more descriptive messaging has been added to better inform you in the event of file corruption.
Cleo HarmonyandCleo VLTraderonly: Added the header "Cache-Control: no-cache, no-store" to all REST API responses to prevent the client from caching login information.
Security HTTP
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where the IP address of a Local HTTPs User logging in using SSL client authentication would not be compared to the configured whitelist. RequiresCleo VLProxy3.7.0.3 or later.
Security SSH FTP
Cleo HarmonyandCleo VLTraderonly: Fixed a problem where the IP address of a user logging in through SSH FTP using PKA would not be compared to the configured whitelist. RequiresCleo VLProxy3.7.0.3 or later.
Known issues in version 5.6
The following are known issues inCleo Harmony5.6:
In the web UI, you might experience some refresh inconsistencies between the left host tree and the right content panel. These inconsistencies will be remediated once Cleo has completed implementing the Web UI in HTML 5. Refreshing the webpage will correct the view.
The Unify in Portal feature is not supported on AIX installations due to incompatibility of GraphDB and AIX. On AIX installations, the Logs and Transfers cannot be viewed through the web UI due to AIX not being a supported platform for ElasticSearch. You can use Classic Mode to see the logs and transfers.
There is an issue with the addition of newSignature AlgorithmandDigest Algorithmentries in the informational section of the MDN. If these values are not included in a trading partners signature, the message,ERROR: MDN archival failure! - java.lang.NullPointerException, is logged and is followed by a stack trace. It does not cause the signature to fail, however. In addition, it will not generate anEmail On Failbecause the Result is a success. On upgrade to version 5.6.0.0, this error might occur, but only appears to occur in conjunction with a small number products that do not include the newSignature AlgorithmandDigest Algorithmentries.
View ArticleGenerating an operator audit trail report from the command line
Note:This section applies to theCleo HarmonyandCleo VLTraderapplications only.
You can useVLTradercorHarmonycfrom the command line to generate an Operator Audit Trail report that is either:
Stored in an HTML file
Stored in a CSV file
E-mailed to a list of users
You can use operating system features to schedule a report to be automatically generated at a certain time.
Harmonyc s OpAudit [-f xmlFilterFile] [-d destination] [-t title]
VLTraderc s OpAudit [-f xmlFilterFile] [-d destination] [-t title]
-s OpAudit
Generates an Operator Audit Trail report.
-fxmlFilterFile
Uses the file,xmlFilterFile, to set the Operator Audit Trail Filter settings. You can save a filter usingSave Asin the Operator Audit Trail Filter dialog box. See Operator Audit Trail. If thefoption is not present on the command line, only the current days operator audit trail events will be in the report.
-ddestination
Outputs the Operator Audit Trail report to thedestination(HTML file, CVS file, or email addresses) you specify. Specifies an HTML file, CVS file, or email as thedestinationfor the Operator Audit Trail report. If the filename has a.csvextension, the file is output as a comma-separated values (CSV) formatted file. If thedestinationcontains an@symbol, it is assumed to be an email address. If you want to specify a list of email addresses, use commas to separate them. If thedoption is not present, the results will be displayed in CSV format to the console.
-ttitle
Appendstitleto the HTML report title and the email subject if applicable. If thetitlecontains whitespace, enclose it within double-quotes, for example:
"title with whitespace"
Running from the command line
You can run theCleo Harmony,Cleo VLTrader, orCleo LexiComapplication from the command line (absent a GUI) to do the following:
Import and export hosts, certificates, and configurations
Enable or disable one or more actions
Run one or more actions
Run as a service
Modify properties
Print current license and version information
Note:
In Unix, the backward slash character (\) is a special escape character. To use the backward slash character in a host\mailbox\action path as shown below, use two backward slashes (\\) or more instead of one. An alternative is to just use the forward slash (/) instead of the backward slash (\). If, however, the actual host, mailbox, or action name has a forward slash in its name, use two forward slashes (//) in its place.
Host actions are available only within theCleo VLTraderandCleo Harmonyapplications and, therefore, all references tohostactionshould be ignored if you use theCleo LexiComapplication.
Since the special characters,<,>,@,/, and\, can be used to construct a host, mailbox, action, or hostaction string, you should avoid using these characters in the actual name of any of these objects.
Command line operations do cause extra system overhead. The system has to start up another JVM (Java Virtual Machine) as well as another copy of theCleo Harmony,Cleo VLTrader, orCleo LexiComapplication. So, this startup process will use additional disk, memory, and CPU resources to run each command line. It might also use extra database resources depending on the command. The additional database connections are only active while the command line process is active. You should consider use of the API or web service to reduce the additional system overhead.
Using the command line
RunHarmony,VLTrader, orLexiComfrom the command line.
Harmonyc [Import][Enable][Disable][Run][String]
VLTraderc [Import][Enable][Disable][Run][String]
LexiComc [Import][Enable][Disable][Run][String]
Note:Be sure to runHarmonyc.exe,VLTraderc.exe, orLexiComc.exein theHarmony,VLTrader, orLexiComhome directory rather thanHarmony.exe,VLTrader.exe, orLexiCom.exe.
Command options
General options
-?
Show command line options.
-f "path"
Process command line options specified in a file.
-m
Show all messages; default isfalse.
-x
Show error messages only; default isfalse.
-l "path"
Generate a log file; replaces existing log file.
-b
Export (back up) specified files and directories to a zip file.
Import options
Use the-ioption to import a host from a file. You can use the-eand-doptions with the-ioption to enable and disable actions, respectively, after import.
-i "path"
Import host; replaces existing host. See Importing and activating a host.
-e "<action>mailbox@host"
-e "host\mailbox\action"
Enable action(s);*and?are supported. See Enabling or disabling actions.
-d "action>mailbox@host"
-d "host\mailbox\action"
Disable action(s);*and?are supported. See Enabling or disabling actions.
Export options
Use the-bcommand to export (back up) specified files and directories to a .zip file.
-b [-f "xmlFileFilter path"] -d "zip file path" -pp "passphrase"
-b
Export (back up) specified files and directories to a .zip file.
-f
Specifies the XML file filter on which to export. If unspecified, the entire configuration will be exported.
-d "zip file path"
Specifies the name of the .zip file that contains the backed-up files. If the file already exists, this action will replace the existing .zip file.
-pp
Passphrase used during export.
Run options
Use the-roption to run an action. You can use the-cand-toptions with the-roption to replace existing commands and modify properties, respectively.
-r "<action>mailbox@host"
-r "host\mailbox\action"
Runs one or more actions;*and?are supported. See Run actions.
-c "command"
Replaces existing commands. You can use the-coption mutliple times.
-t "<Host><tag>value"
-t "<Mailbox><tag>value"
-t "<Action><tag>value"
Modifies a property value. Specifies a host-, mailbox- or action-level property modification, the name of the property (tag) and the new value of the property. You can use the-toption mutliple times. See Supplying new property values while running actions
Modify options
Use the-poption to specify a host, mailbox, or action you want to modify without running an actions and use the-toption to specify the property within that host, mailbox or action you want to change and its new value. You can specify more than one-toption for each-poption.
For examples of how to use-pand-ttogether, see Supplying new property values without running actions.
-p "<action>mailbox@host"
-p "host\mailbox\action"
-p "host/mailbox/action"
Specifies an action in a mailbox and host for which you want to modify properties.
-p "host\service"
Specifies a host and service for you which you want to modify properties.
-p "<hostaction>@host"
-p "host\\hostaction"
-p "host//hostaction"
Specifies a hostaction and host for which you want to modify properties.
-p "standalone action"
Specifies a standalone action for which you want to modify properties.
-t "<Host><tag>value"
-t "<Mailbox><tag>value"
-t "<Action><tag>value"
Specifies a host-, mailbox-, or action-level property modification, the name of the property (tag) and the new value of the property.
String options
-s "service"
Runs theCleo Harmony,Cleo VLTrader, orCleo LexiComapplication as a service. See Running as a service.
-s remote,target
Runs theCleo Harmony,Cleo VLTrader, orCleo LexiComapplication remotely. See Running as a service.
-s "license"
Displays license information. See Printing license information.
-s "version"
Displays version information. See Printing version information.
-s "service,stop"
Waits for ongoing transfers to complete and then stops the service.
-s "service,kill"
Stops the service immediately without waiting for ongoing transfers to complete.
-s "scheduler,start"
Starts the scheduler.
-s "scheduler,stop"
Stops the scheduler.
-s "router,start"
Starts the router.
-s "router,stop"
Stops the router.
-s "transfers"
Generates a transfer report. See Transfers.
Printing command line options
Print a list of command line options.
Harmonyc ?
VLTraderc ?
LexiComc ?
Printing messages
Print all messages (-m) while processing command line.
Harmonyc m ...
VLTraderc m ...
LexiComc m ...
Print only error messages (-x) while processing command line
Harmonyc x ...
VLTraderc x ...
LexiComc x ...
You can use either of these options withi,-e,-d,-r, ors.
You can increase your screen buffer width to ~160 characters to avoid message line wrapping.
Generating a log file
Generate a log file (-l) while processing a command line.
Harmonyc l path ...
VLTraderc l path ...
LexiComc l path ...
You can use this option withi,-e,-d,-r, ors.
If the log file already exists, it is overwritten.
The system log file is not affected by this option.
Importing and activating a host
Import and activate a host (-i)
Harmonyc i path
VLTraderc i path
LexiComc i path
pathmust point to a valid.zipfile. The.zipshould be structured to match the directory structure ofCleo Harmony,Cleo VLTrader, orCleo LexiCom. If it is a just file in a.zip, it is placed in the appropriate home directory.
If the active host alias already exists, it is overwritten.
You can use the-ioption to import patch files (usually in conjunction with-m):
Harmonyc i path_to_patch_file/0.1.zip
The-roption can follow this option to run a newly imported host.
Enabling or disabling actions
Enable (-e) one or more actions.
Harmonyc e <action>mailbox@host
Harmonyc e host\mailbox\action
VLTraderc e <action>mailbox@host
VLTraderc e host\mailbox\action
LexiComc e <action>mailbox@host
LexiComc e host\mailbox\action
Disable (-d) one or more actions
Harmonyc d <action>mailbox@host
Harmonyc d host\mailbox\action
VLTraderc d <action>mailbox@host
VLTraderc d host\mailbox\action
LexiComc d <action>mailbox@host
LexiComc d host\mailbox\action
You can specify either action path format. You can use*and?to wildcard the path and possibly match more than one action. You can use/instead of a\.
You can specify a partial path (for example,hostorhost\mailboxormailbox@host) to enable or disable ALL actions within the path.*and?can also be used to wildcard the partial path.
Run actions
Run one or more actions (-r).
Harmonyc r <action> mailbox@host
Harmonyc r host\mailbox\action
VLTraderc r <action> mailbox@host
VLTraderc r host\mailbox\action
LexiComc r <action> mailbox@host
LexiComc r host\mailbox\action
You can specify either action path format. You can use*and?to wildcard the path and possibly match more than one action. You can use/instead of a\.
You can specify a partial path (for example,hostorhost\mailboxormailbox@host) to run ALL actions within the path.*and?can also be used to wildcard the partial path.
If more than one action is matched, the actions are run sequentially one-by-one.
Seesample.batin theCleo Harmony,Cleo VLTrader, orCleo LexiComhome directory for an example.
Supplying new property values while running actions
Supply new property values while running one or more actions (-rwith-t/-n).
Harmonyc r <action>mailbox@host t <Action><Commands>PUT ... n GET ... ...
VLTraderc r <action>mailbox@host t <Action><Commands>PUT ... n GET ... ...
LexiComc r <action>mailbox@host t <Action><Commands>PUT ... n GET ... ...
The-toption specifies a host-, mailbox- or action-level property modification, the name of the property (tag) and the new value of the property. The property names correspond to the tagged valuesin the host XML file. See XML file formats for information about the layout of a host XML file.
You can use the-toption mutliple times.
To specify a multi-line value, usetto specify the first line, and then immediately following specify each remaining line withnvalues.
More than onetvalue (followed bynvalues) can be specified to update multiple properties.
If more than one action is being run, the tagged valuesare applied to each action as it is run.
Supplying new property values without running actions
Supply new property values without running any actions (-pwith-t/-n).
Harmonyc p <action>mailbox@host t <Action><Commands>PUT ... n GET ... ...
VLTraderc p <action>mailbox@host t <Action><Commands>PUT ... n GET ... ...
LexiComc p <action>mailbox@host t <Action><Commands>PUT ... n GET ... ...
The-toption specifies a host-, mailbox- or action-level property modification, the name of the property (tag) and the new value of the property. The property names correspond to the tagged valuesin the host XML file. See XML file formats for information about the layout of a host XML file.
You can use the-toption mutliple times.
To specify a multi-line value, usetto specify the first line, and then immediately following specify each remaining line withnvalues.
More than onetvalue (followed bynvalues) can be specified to update multiple properties.
Running as a service
Run theCleo Harmony,Cleo VLTrader, orCleo LexiComapplication as a service (-s):
Harmonyc s service
Running theCleo Harmony,Cleo VLTrader, orCleo LexiComapplication as a serviceis identical to how they run when installed as a Windows service. Installing and running as a service has the following advantages:
The service can run continuously. A user does not have to be logged into the computer to start the application.This is important for users wanting to schedule actions to run automatically. This is even more important for users who must have a local host always running listening for incoming messages.
The GUI can still be started while the application is running as a service.When the GUI is exited, the service continues to run.
Command line can also be used while the application is running as a service.
Running remotely
Run theCleo Harmony,Cleo VLTrader, orCleo LexiComapplication remotely (-s):
Harmonyc s remote,target ...
VLTraderc s remote,target ...
LexiComc s remote,target ...
This option can be used with-e,-d, orr. The action paths specified with these options must exist withinCleo Harmony,Cleo VLTrader, orCleo LexiComon the target computer.
Thetargetcan be specified as a computer name or IP address.TheCleo Harmony,Cleo VLTrader, orCleo LexiComapplication must be installed and/or running as a service (s service) on the target server for the remote command to be accepted.
The-loption can be used to generate a local log file.
This option only requires a license on the target computer.
Printing license information
Print current license information (-s):
Harmonyc s license
VLTraderc s license
LexiComc s license
This will generate output similar to the following:
License Key = eb]|-y{8R-LyLo-GGjd-M{42-GkE4-QI7B-mqL^
License Owner = Cleo Communications
Serial Number = LX9012
Host ID = LO6354
Key Expires = 2003/01/08 (evaluation)
Max # of Hosts = Unlimited
Max # of Mailboxes per Host = 5
Translator Integration = Yes
AS2 = Yes
FTP = Yes
FTP/S = Yes
HTTP = Yes
HTTP/S = Yes
API = Yes
Printing version information
Print current version information (s).
Harmonyc s version
VLTraderc s version
LexiComc s version
This will generate output similar to the following:
Version = 2.0.03
2002/05/08 07:48:28 CDT as2bean.jar
2002/04/29 16:31:22 CDT dcebmxhttpsbean.jar
2002/05/09 09:48:54 CDT ftp.jar
2002/05/09 09:48:58 CDT ftps.jar
2002/05/06 16:57:26 CDT httpbean.jar
2002/04/26 16:37:54 CDT HTTPClient.jar
2002/05/06 16:57:30 CDT httpsbean.jar
2002/05/06 16:57:20 CDT lexbean.jar
2002/05/08 09:53:38 CDT LexiCom.jar
Processing command line options from a file
Process command line options specified in a file (f) .
Harmonyc f path
VLTraderc f path
LexiComc f path
And an example file:
-m
-l log.xml
-i "hosts\preconfigured\ABC VAN.xml"
-r "ABC VAN\myMailbox\send+receive"
-t "<Host><Inbox>G:\edi\in\"
-t "<Host><Outbox>G:\edi\out\"
-c "CONNECT user=test,*pswd=test"
-c "PUT -DEL .\ receiver=EDI,type=X12"
-c "GET -DIR -CON -UNI .\[type]=X12"
The contents the file can contain any of the other command line options besidesf.Within the file, arguments can be separated by spaces and/or exist on separate lines.
Importing files
Import a file originally exported from theCleo Harmony,Cleo VLTrader, orCleo LexiComapplication:
VersaLexc -i VersaLexConfig.zip -pp cleocleo -cp keypswd1 -cp keypswd2 -m
where:
-iVersaLexConfig.zip
Import the file,VersaLexConfig.zip.
-ppcleocleo
Specifies thatcleocleois the passphrase used when the data was exported.
-cpcleo-cpkeypswd1-cpkeypswd2
Provides certificate private key passwords the system attempts to use in rotation until one matches.
View ArticleAnnouncing the new Training section of Cleo Solution Center. We're pleased to offer live registrations for our three course tracks: Data Movement, Data Transformation, and Ancillary.
View ArticleHow frequently are classes offered?
With over two dozen offerings, the frequency varies. Several are scheduled once each month, and a few twice monthly. Others maybe only every other month. The individual page that details each course provides the next several available dates.
When do they start/finish?
Each course is different with respect to the day(s) of the week it is conducted and the start/stop times. So, for example, you may see a 2-day course scheduled next week Monday and Tuesday from 1 pm to 5 pm ET, but that same course is offered a month later Wednesday and Thursday from 10 am to 2 pm ET.
Are there scheduled breaks?
Yes, the instructor will announce the plan at the start of each session. In a 5-hour session, for example, s/he may decide to have three 90-minute sprints with 15-minute breaks between. Or, the plan may be to have one 30-minute break between two 2-hour-15-minute sprints.
How do I register?
The Cleo Solution Center is where to start. On the appropriate course registration page, complete the required information (be sure to note the days/times as they differ for each session).
How do I attend?
All remote sessions are delivered via a Webex training classroom, and access credentials are emailed to you by the Cleo Training team about a week before the class begins.
Some courses require attendees to perform work. In that case, in that same access credentials email there will be an attachment that allows for accessing an RDP session over an AWS instance where the classroom lab environment has been established. In fact, soon after the registration is approved, you will receive an email with an RDP attachment and instruction to test your AWS access ability.
How do I obtain the materials?
If the Cleo Training team has not emailed the PDFs, PPTs, and other files, you can access them from the Solution Center before the course begins and then save/print (if a hard copy is preferred).
What else is needed?
Two monitors! this allows for watching the instructors screen (via a Webex session) on one monitor and, on the other monitor, watch (via an RDP session) the work to be done by you in your lab environment. And if its a class for which no work is required, that second monitor can be used to view the PDFs, PPTs, and other files.
Are the courses recorded?
No.
View ArticleIn this course you will learn to Install, upgrade, create additional environments, data management, and ensure operational integrity ofCleo EEI.
(4 hours)
Price Per Student
$800
Available Dates/Times
March 28 (10 am - 2 pm ET)
August 29 (10 am - 2 pm ET)
December 12 (10 am - 2 pm ET)
View ArticleAdministrators must install, license, enable, access, sign in, and then configure theCleo DashboardsServer. Well do all of that in this course. Then, the fun begins as we demonstrate how you can analyze activity and investigate histories of transaction activity.
(2 hours)
Price Per Student
$400
Available Dates/Times
January 9 (10 am - 12 pm ET)
February 6 (10 am - 12 pm ET)
March 5 (10 am - 12 pm ET)
View ArticleGain an understanding of how Cleo's data movement software fits within the enterprise operation and review the installation process for deployment.The curriculum is designed for users of Cleo LexiCom, Cleo VLTrader, and Cleo Harmony.
(2 hours)
Price Per Student
$400
Available Dates/Times
January 8 (11 am - 1 pm ET)
February 12 (11 am - 1 pm ET)
March 4 (11 am - 1 pm ET)
View ArticleVarious host configurations are addressed with hands-on exercises. The curriculum is designed for users of Cleo VLTrader and Cleo Harmony.
(2 hours)
Price Per Student
$400
Available Dates/Times
January 8 (2 pm - 4 pm ET)
February 12 (2 pm - 4 pm ET)
March 4 (2 pm - 4 pm ET)
View ArticlePrepare to successfully undertake day-to-day administrative duties over the entire life cycle, from initial deployment to active production, for Cleos enterprise data integration platform.
The course provides an in-depth look at configuring hosts, administration, Cleo VLNavigator, Cleo VLProxy, local listeners and users, actions, internal integrations, security, and more.
The curriculum is designed for users of Cleo LexiCom, Cleo VLTrader, and Cleo Harmony.
Learners will receive a certificate upon successful completion of an exam.
(4 days, 5 hours each day, maximum 5 students)
Price Per Student
$3,600
Available Dates/Times
January 13-16 (10 am - 3 pm ET)
February 17-20 (10 am - 3 pm ET)
March 16-19 (10 am - 3 pm ET)
View ArticleWhat is EDI? Why is this decades-old syntax more popular than ever?
As we take an in-depth look at standards & versions and compare documents vs. EDI documents, the answers will become clear. Well also look at how Cleo leverages the rigid structure of EDI to your advantage.
(2 hours)
Price Per Student
$400
Available Dates/Times
Please email for availability.
View ArticleDesigned for beginners and those seeking a basic understanding of CICs capabilities, we start with an overview of EDI jargon, Cleo terminology, and standards/practices that provide insight into the essentials for designing your solution.
With just the right amount of theory combined with simple hands-on exercises to give you the fundamental experience youll need, this course serves as the foundation for one or more of the specialty courses that follow.
Completing this course allows you to register for one or more of the Data Transformation multi-day specialty courses completing one of those classes qualifies you as certified.
(2 days, 5 hours each day, maximum 5 students)
Price Per Student
$1,800
Available Dates/Times
January 6-7 (11 am - 4 pm ET)
January 20-21 (11 am - 4 pm ET)
February 3-4 (11 am - 4 pm ET)
February 17-18 (12 pm - 5 pm ET)
March 2-3 (11 am - 4 pm ET)
March 9-10 (12 pm - 5 pm ET)
View ArticleThis specialty course is designed for thosethat have successfully completed the prerequisiteDT103 Data Transformation: Fundamentalscourse.
In this hands-on course that focuses on data flows and EDI (X12.004010) documents common to the Order to Cash process (810, 850), participants create new solutions that work with EDI, database, XML, and flat file data formats.
Then, there's a demonstration of how Cleos Data Analytics tool is used toanalyze activity and investigate histories of transaction activity.
(4 days, 5 hours each day, maximum 5 students)
Price Per Student
$3.600
Available Dates/Times
January 13-16 (11 am - 4 pm ET)
February 10-13 (12 pm - 5 pm ET)
March 9-12 (10 am - 3 pm ET)
View ArticleParticipants learn how to develop mapping for both inbound and outbound EDI data transformation on IBM i using Cleo EEI,as well as trading partner configuration.
(4 days, 8 hours each day, maximum 5 students)
Price Per Student
$5,000
Available Dates/Times
March 23-27 (10 am - 6 pm ET)
August 24-28 (10 am - 6 pm ET)
December 7-11 (10 am - 6 pm ET)
View ArticleThis course is designed for those with an IT infrastructure background and an understanding of current systems within your business. In this course, you learn how to install, maintain, and ensure operational integrity ofClarify Studio, Clarify Server, and Cleo Dashboards.
Also, the instructor shows you how to monitor system availability and data flows, and detect common transformation errors/warnings.
(4 hours)
Price Per Student
$800
Available Dates/Times
January 9 (1 pm - 5 pm ET)
February 6 (1 pm - 5 pm ET)
March 5 (1 pm - 5 pm ET)
View ArticleThis specialty course is designed for thosethat have successfully completed the prerequisiteDT103 Data Transformation: Fundamentalscourse.
So, your Project is complete, shared and synchronized, and published to the development server. Now, how do you get it ready for the production environment? And, once its there, how do you incorporate into PROD changes made back in DEV . In this session, we'll discuss and demonstrate.
(4 hours)
Price Per Student
$800
Available Dates/Times
January 23 (1 pm - 5 pm ET)
February 20 (1 pm - 5 pm ET)
March 12 (1 pm - 5 pm ET)
View ArticleFeatures and functions not available in prior versions are discussed and demonstrated.
(2 hours)
Price Per Student
$200
Available Dates/Times
Please email [email protected] for availability.
View ArticleParticipants will learn to use Cleos Streem Print Application The course is designed to enable a participant to successfully undertake sending faxes from their desktop.
(1 hour)
Price Per Student
FREE
Available Dates/Times
January 20 (9 am - 10 am ET)
February 17 (9 am - 10 am ET)
March 16 (9 am - 10 am ET)
View ArticleParticipants will learn the basic functionality of Cleos Streem Notify. The course is designed to enable a participant to successfully undertake launching mass messages.
(1 hour)
Price Per Student
FREE
Available Dates/Times
January 20 (11 am - 12 pm ET)
February 17 (11 am - 12 pm ET)
March 16 (11 am - 12 pm ET)
View ArticleParticipants will learn to administer the Cleo Streem Server. The course is designed to enable a participant to successfully manage the server component of the server fax solution.
(1.5 hours)
Price Per Student
FREE
Available Dates/Times
January 27 (9 am - 10:30 am ET)
February 24 (9 am - 10:30 am ET)
March 23 (9 am - 10:30 pm ET)
View ArticleUse generic AS3 Hosts to specify an AS3 installation based on a specific AS3/FTP server product.
This includes the product's specific server choreography, or the commands needed to successfully log in to the remote server and send and receive files. The product choreography for each generic AS3 host was established during AS3 interoperability testing with the server products, and a generic host for all interoperability-certified AS3 products is included in the VersaLex installation. Since these hosts were created for a test environment, you might need to adjust some settings and commands to establish successful file transfers in a production environment. If it is available, use a pre-configured host specific to your trading partner's remote server.This makes for a faster and easier set up of your installation.
The AS3 standard provides the ability tosecurely transport EDI (and other data, including binary and XML) to a remote host over FTP, guaranteeing that the message has not been changed in-transit and has been received and can be read only by the intended trading partner.An Message Disposition Notification (MDN) receipt further guarantees that the intended trading partner has received the message.
AS3 uses the FTP protocol as its transport mechanism to send and receive files over the Internet. VersaLex uses thePUT/GETaction commands to transport the secure data to/from the remote host.
AS3 Configuration
A host describes the remote server of your trading partner to which messages will be sent. The host's parameters specify its location and how it is reached. Your remote trading partner should have provided information to you in the form of a URL, which you will use to configure the host parameters.
This section describes how to configure a generic AS3 pre-configured host.
Click theTemplatestab in the tree pane.
If necessary, expand theHoststree in theTemplatestab to find the host you want to use.
Right-click thehostand selectClone and Activate.
The entire pre-configuredhostbranch (including a mailbox and actions) is copied and activated, theActivetab is selected in the tree pane, and the new activehostis 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.
Click the new host in the tree pane.
Enter host-level configuration information on the tabs in the content pane. See AS3 Host.
ClickApplyto save your work.
Enter mailbox-level configuration information.
Click the mailbox under your host in the tree pane.
Enter mailbox-level configuration information on the tabs in the content pane. See AS3 Mailbox.
ClickApplyto save your work.
Enter action-level configuration information.
Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and selectNew Action.
Edit action information on the tabs in the content pane. See AS3 Action.
ClickApplyto save your work.
ClickApplyto save your work.
Important:If you leave any of these panels without clickingApply, your work will not be saved. You can configure the product to prompt to you clickApplyif 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 clickApplyand your updates will not be saved.
AS3 Host
The following sections describe how to configure any of the generic AS3 hosts.A host describes the remote server of your trading partner to which messages will be sent. The host's parameters specify its location and how it is reached.
AS3 Host: General Tab
The hostGeneraltab for an AS3 Host contains the fields described in detail below.The default values of these fields vary per generic or pre-configured host.For pre-configured hosts, the fields on theGeneraltab 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.
Default value:80for HTTP and443for HTTPs (SSL)
Connection Type
The kind of connection you want to use for this host.
Possible values:
System Default- See for information about setting the system default.
Direct Internet Access or VPN- Use either a direct connection to the internet or a VPN.
Default value:System Default
Forward Proxy
The address of the forward proxy you want to use for this host.
Select theSystem Defaultcheck 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. ForCleo VLTraderandCleo Harmony, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and Outbox. See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Note:If the host is has an external association, the default directories might be managed outside ofVersaLexand not shown here.
Inbox
Default directory for incoming files. Enter a value directly or clickto 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 clickto 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 clickto 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 clickto navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: No default value.
AS3 Host: AS3 Tab
Use theAS3tab to specify values for AS3-specific parameters.
Overwrite duplicate file names
Disabled for AS3.
Use default file name
Disabled for AS3.
Add Content-Type Directory to Inbox
Allows you to sort incoming messages based on content-type to a subdirectory under the Inbox specified on theGeneraltab.Specify each of the Content-Types you want to direct to specific subdirectories by entering a name in theDirectoryfield. 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 theGeneraltab.
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.VersaLexdoes not check the actual content of the message to determine its content type.
AS3 Host: FTP Tab
Security Modes
If the AS3/FTP server requires use of the Secure Socket Layer (SSL), select a security mode.
Possible values:
None- Indicates non-secure transfers; commands and data are clear-text.
SSL Implicit- For servers that support only SSL connections.
SSL Explicit- For servers that support SSL through the use of either theAUTH SSLorAUTH TLScommand.
Default value:SSL Explicit
Default Data Type
The data type used when transferring files to and from the FTP server. The only validData Typefor AS3 commands isBinary.
Data Channel Mode
The default behavior for opening data port connections between the AS3 client and AS3/FTP server.
Active mode
Client listens for an inbound connection from the server during data transfers. TheLow Port/High Port, if left at 0/0, will be a random number between 1024-65535; otherwise specify a specific range. Because this is active mode, this port range must be open inbound on your firewall.
Passive mode
Server listens for an outbound connection from the client during data transfers. The server indicates the IP address and port number. The AS3/FTP server will cycle through port numbers, usually a subset of1024-65535.Substitute Passive IP Addressindicates that VersaLex should ignore the IP address specified by the server and reuse the command port address instead. This might be necessary if the server is advertising an internal rather than an external IP address.
AS3 Host: Advanced Tab
The host'sAdvancedtab contains several property settings fields.These settings typically do not affect the ability to connect to a host.However, you might want to change some of these settings when configuring a runtime environment.
See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for AS3 include:
Abort In Process Transfers
Indicates that the FTP server supports theABORTcommand when a data transfer is interrupted.
Possible values:OnorOff
Default value:Off
Add Mailbox Alias Directory to Inbox
Appends a subdirectory at the end of the host's configured inbox directory. This allows files received through different mailboxes to be kept separate.
Possible values:OnorOff
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:OnorOff
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:OnorOff
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:OnorOff
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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
Default value:On
Allow Duplicate Incoming Message IDs
Ignores messages with duplicate message IDs and allows reprocessing of the message.
Possible values:OnorOff
Default value:Off
Avoid List Command When Space In Path
When using the retrieving nested subdirectories (GET RECoption) and any of the nested subdirectories have spaces, indicates that the FTP server does not properly handle spaces in theLISTcommand path and that CDs should be used to avoid the issue.
Possible values:OnorOff
Default value:Off
Base64 Encode Content
Base64is the encoding format used by Multi-purpose Internet Mail Extension (MIME) for transmitting non-text material over text-only communications channels. Base64 is based on a 64-character subset of US-ASCII, enabling 6 bits to be represented per printable character.
Possible values:OnorOff
Default value:Off
Canonicalize Inbound Signed Content
When this option is selected, a canonicalizer is used to ensure that \r and \n characters always occur together as \r\n. This option may be used when the inbound signature hash verification fails and the trading partner is using OpenSSL to sign its messages.
Possible values:OnorOff
Default value:Off
Command Retries
If an error or exception occurs during a command, the number of times the command should be retried.
Note:Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
Possible values:0-n
Default value:0
Compression- Signing Order
When both signing and compression are enabled, indicates which is applied first.
Possible values:Sign then compressorCompress then sign
Default value:Sign then compress
Connection Keep Alive Timeout (seconds)
Allows the connection to the server to remain open while the message is being processed by sendingNOOPcommandseverynseconds. This setting may be lowered if the connection to the server is being closed before the message can be fully processed.
Possible values:1-n
0or a negative value disables attempts to keep the connection open.
Default value:60
Connection Timeout
The amount of time allowed for each read operation.
Possible values:0-nseconds
0indicates no timeout
Default value:150seconds
Data Socket Accept Timeout
The amount of time allowed for each read operation on the data port.
Possible values:0-600seconds, where0indicates no timeout.
Default value:150seconds
Delete Zero Length Files
Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
Possible values:OnorOff
Default value:Off
Disable Address Resolution
Indicates to connect directly to an IP address if the IP address is known and a DNS lookup is not desired.
Possible values:OnorOff
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-DELoption is being used, any zero length file ignored will also be deleted.
Possible values:OnorOff
Default value:Off
Email On Check Conditions Met
Send an email notification after running aCHECKcommand where the overall conditions of the check are met. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (if set).
Email On Check Conditions Not Met
Send an email notification after running aCHECKcommand where the overall conditions of the check arenotmet.See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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:OnorOff
Default value:On
Email On Successful Copy
Send an email notification after copying a file usingLCOPY. 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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (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 theOptions > Advancedpanel (if set).
Execute On Check Conditions Met
After executing aCHECKcommand where the overall conditions are met, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Check Conditions Not Met
After executing aCHECKcommand where the overall conditions arenotmet, run a system command. See Configuring email or execute based on results.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Possible values: System command to be executed.
Default value: The valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Execute On Repetitive Action Failures
WhenExecute On Failis enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of theExecute On Failcommand. If suppression of execution of the command for this failure continues after 24 hours, the suppressedExecute On Failcommand will be executed every 24 hours and after a system restart if the failure occurs again. When the failure is resolved, theExecute On Failcommand will be executed again. Users must account for this by including the %status% macro variable for theExecute On Failcommand (see Using macro variables ) and then checking for a success or failure.
Note:This feature only suppresses multiple executions of theExecute On Failcommand if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values:OnorOff
Default value:On
Execute On Successful Copy
After successfully copying a file usingLCOPY, 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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (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 valuespecified for this property on theOptions > Advancedpanel (if set).
Explicit SSL Command
Indicates the AUTH command to be used when the Security Mode specified on the Host/FTP tab is SSL Explicit.
Possible values:
AUTH SSL
AUTH TLS
AUTH TLS-C
AUTH TLS-P
Default value: Depends on the requirements of the trading partners FTP server.
Explicit SSL Post Command
A command or set of commands to be issued after the Explicit SSL Command and login sequence. ThePBSZandPROTcommands (PBSZ 0;PROT P) are required by some servers regardless of the AUTH type used and are necessary for data channel protection (AUTH TLS or AUTH TLS-C).
If multiple FTP commands are needed after the AUTH command, set this property toallof the commands separated by semicolons (;).
File List Parse Method
The NLST commands on some FTP servers do not return a standard file list.
Possible values:TradanetorGXS NBT
Default value: None
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values:0toncharacters.
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:OnorOff
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:OnorOff
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:OnorOff
Default value:Off
Get Number of Files Limit
Limits the number of files retrieved from a server directory listing by oneGETcommand.
Possible values:0-n
0indicates no limit.
Default value:0
High Priority
Indicates whether incoming and/or outgoing transfers through the host should be treated as high priority. When both high priority and regular priority transfers are active, the high priority transfers get a larger portion of the available bandwidth.Go toConfigure > Options > Otherto set theHigh Priority Transfers Percentage Available Bandwidth(defaults to 75). See Other system options for more information.
Note:This is aCleo HarmonyandCleo VLTraderoption.
Warning:If the trading partners bandwidth (and notCleo Harmony's orCleo VLTraders) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down otherCleo HarmonyorCleo VLTradertransfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance ofCleo HarmonyorCleo VLTraderis both the client and server (for example, a local looptest).
Possible values:
Incoming
Outgoing
Both
Ignore Exception After Quit
Indicates to ignore any I/O errors that occur when attempting to read the SMTP server response after issuing aQUITcommand.
Possible values:OnorOff
Default value:Off
Ignore Retrieve Error Code
Indicates an FTP server response code (after an FTPRETRrequest) that should not be treated as an error condition. This property is useful when the absence of a file on the server is not considered an error.
CAUTION:If the server uses the same error code for multiple reasons, this property can potentially mask unknown error conditions.
Possible values: Three-digit error code value.
You can specify multiple error codes separated by commas (,) or semicolons (;). Alternatively, you can use a regular expression (denoted by enclosing it in square brackets []) instead of a three-digit error code. For example,[550.*No such file.*]would ignore550errors containing No Such File. If it is necessary to include a, or ; in the regular expression, the character would need to be escaped (\x2C or\x3B) instead of using a comma or semicolon. See Using wildcards and regular expressions for additional information.
Include Failure In Subject Of Email
When specified, the exception message will be included in the email that is generated on failure.
Note:If the exception message exceeds 256 characters, it will be truncated.
Possible values:OnorOff
Default value: The value specified for this property on theOptions > Advancedpanel
Include Filename In Store Unique Command
Indicates whether the FTP server expects a starting filename to be included when using the store unique option (PUT -UNI).
Possible values:OnorOff
Default value:Off
Interim Retrieve
Indicates to set result of any successfully retrieved file toInterim Successrather thanSuccess. This would normally be used when transfer logging is being monitored by a backend system to allow coordination of any post processing of the received file that needs to occur prior to setting the transfer status toSuccess.
Possible values:OnorOff
Default value:Off
Issue Command After Opening Data Connection
Indicates to issue the retrieve, store, or list command until after the data port connection has been established rather than before.
Possible values:OnorOff
Default value:Off
Keepalive Noop Command (seconds)
Indicates the amount of time in-between issuingNOOPcommands on the command port while a transfer is active on the data port. 0 indicates to not issueNOOPs.
Possible values:0-n
Default value: 0
LCOPY Archive
If specified, contains the directory for archivingLCOPYsource 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 theOptions > Advancedpanel, 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 aCleo HarmonyandCleo VLTraderoption.
Possible values:OnorOff
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 theOptions > Advancedpanel, 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 theOptions > Advancedpanel, 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 of0does 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 of0does not limit the transfer rate. The system setting might also limit the transfer rates. The system Maximum Outgoing Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers will also affect individual transfer rates. See Advanced system options for more information about Maximum Outgoing Transfer Rate.
Possible values:0-n
Default value:0
Next File On Fail
When a download fails, indicates whether a wildcardedGETshould proceed to the next available file rather than terminate if the server is still connected.
Possible values:OnorOff
Default value:Off
Only Retrieve First Available File
Indicates aGET *should only retrieve the first available file from the server.
Possible values:OnorOff
Default value:Off
Only Retrieve Last Available File
Indicates aGET *should only retrieve the last available file from the server.
Possible values:OnorOff
Default value:Off
Outbox Sort
Controls the order in which multiple files are transferred for aPUTcommand. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab takes precedence. ForAlphabeticalordering, 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
IfFixed Record Outgoing Insert EOLis active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values:OnorOff
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 aCleo LexiComonly option. ForCleo HarmonyandCleo VLTrader, this information is stored in the trading partner management table. See Managing Trading Partners.
Password Automatic Update (days)
If greater than zero andPassword Update Formathas been set, the number of days after which the software will generate and apply a new FTP password.
Possible values:0-n days
Default value:0 days
Password Update Format
If supported by the server, the format of thePASScommand value when changing a user's password. The server dictates the format.
Use%old%and%new%keywords to specify the format, for example,%old%/%new%.
PGP Compression Algorithm
Compression method used when OpenPGP packaging (with compression) is requested through theMailbox Packagingtab. See Configuring mailbox packaging.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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:OnorOff
Default value:On
PGP Signature Verification
Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. In general, this property should be enabled.
Possible values:OnorOff
Default value:On
PGP V3 Signature
Post Get Command
Post Put Command
In an action, specify commands to be executed only after a successfulGETorPUTas post-get or post-put commands, respectively. When using this property, use aSETcommand within theactionbefore theGETorPUTcommandrather than theAdvancedtab.
The Post Put Command can be set toQUIT, which allows a disconnect and reconnect between file uploads when necessary.
If multiple FTP commands are needed after theGETorPUT, set this property toallof the commands separated by semicolons (;). If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes ("). Use of macro variables is supported. Refer to Using macro variables (Post/Pre Command context) for a list of the applicable macros.
Pre Get Command
Pre Put Command
In an action, specify commands to be executed before aGETorPUTas pre-get or pre-put commands, respectively. This has the benefit of keeping the log results relative to justGETs andPUTs (especially important forCleo VLTraderandCleo HarmonyGETtransfer logging). In addition, for thePUT, it avoids connecting and logging into the server when there are no files to send. When using this property, use aSETcommand within the actionbefore theGETorPUTcommandrather than theAdvancedtab.
If multiple FTP commands are needed prior to the GET or PUT, set this property toallof the commands separated by semicolons (;). If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes ("). Use of macro variables is supported. See Using macro variables (Post/Pre Command context) for a list of the applicable macros.
Pre Put Change Directory
ForPUTcommands whose destination contains a directory path, forces an explicitCWDrequest to the destination directory path prior to issuing theSTORErequest.
Some FTP servers treat directories as logical rather than physical directories, and require directories be set only through aCWDrequest.
Possible values:OnorOff
Default value:Off
Pre Put Command For First File Only
If a Pre Put Command is specified, indicates whether to execute them before each file being transferred by thePUTor only before the first file transfer.
Possible values:OnorOff
Default value:On
Resume Failed Transfers
When selected and a transfer fails (and Command Retries > 0), attempt to resume the transfer on a retry. If OpenPGP is enabled on the packaging tab (see Configuring mailbox packaging ), the entire file is transferred instead of resuming with a partial file. The server must support theFEAT,SIZE, andREST STREAMextensions to FTP. For more information, visit http://tools.ietf.org/html/rfc3659.
Possible values:OnorOff
Default value:Off
Retain Temporary Inbound Message Files
Leaves any files that are used while processing inbound messages in thetemp\folder. The default action is to delete these files after processing has completed. These files may be helpful for problem diagnosis.
Note:These temporary files are retained for seven days.
Possible values:OnorOff
Default value:Off
Retrieve Directory Sort
Used to control the order in which files are downloaded from the FTP server. Using this property does cause the LIST command rather than the NLST command to be used when VersaLex is determining the available file list which might be a problem if the server responds with different lists (e.g. NLST only lists files not previously downloaded while LIST lists all files regardless). Windows and Unix/Linux FTP servers are supported.
Possible values:
Alphabetical (ascending)
Alphabetical (descending)
Date/Time Modified (ascending)
Date/Time Modified (descending)
Size (ascending)
Size (descending)
Retrieve Last Failed File First
If a file download previously failed and you are attempting toGETa list of files again, this property indicates whether the previously failed file should be attempted first.
Retry Delay
The amount of time (in seconds) before a retry should be attempted.
Possible values: Any value greater than zero.
Default value:60 seconds
Reuse SSL Session
Indicates the command port SSL session should be reused when possible for any subsequent data port SSL connections. This setting does not affect the reuse of command port SSL sessions.
Possible values:OnorOff
Default value:Off
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:OnorOff
Default value:On
RSA-OAEP Key Algorithm Parameter
Represents the type of mask generation and hash generation functions that are applied when theRSAES-OAEPkey algorithm is in use. See RFC4055 for a further description of the mask and hash generation functions.
Possible values:MGF1-SHA1,MGF1-SHA256,MGF1-SHA512
Default value:MGF1-SHA1
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:OnorOff
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 thatCleo Harmony,Cleo VLTrader, orCleo LexiComwill 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 of0to112,128, or256(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabledexception to occur.
Possible values:0-nbits
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:OnorOff
Default value:On
Store Raw Sent Message
When this property is enabled, a copy of the outbound message is stored in the HTTP/sent directory.
Possible values:OnorOff
Default value:Off
Terminate On Fail
If an error occurs during a command, stop the action.
Note:
Regarding non-CHECKcommands: WhenTerminate On Failis on, if a command fails,Email On FailandExecute On Fail, if set, are processed, and then the action stops. WhenTerminate On Failis off, if a command fails,Email On FailandExecute On Fail, if set, are processed, and the action continues.
RegardingCHECKcommands:Terminate On Failis only honored if theConditionsMetparameter is set and the result of theCHECKis classified asError. TheCHECKcommand is only available in theCleo HarmonyandCleo VLTraderapplications.
Possible values:OnorOff
Default value:On
Unzip Use Path
Indicates whether or not zip entry paths should be used forLCOPY -UNZIPoperations. When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path.
Possible values:OnorOff
Default value:On
Use Content Type For File Extension
By default, inbound messages that do not specifically contain the name of the target file to be saved are stored using the value of theMessage-ID(of that message) with the.fileextension. When this option is selected, inbound messages without a target file name specifier is stored using theMessage-IDand the appropriate file extension based on the Content-Type of the message.
Possible values:OnorOff
Default value:
Offfor existing hosts
Onfor newly cloned hosts
Use EPRT and EPSV
Indicates to use Extended Port (EPRT) and Extended Passive (EPSV) commands for IPv6-style network addressing. EPRT/EPSV is used regardless of this setting if the host address is or resolves to an IPv6-style address.
Possible values:OnorOff
Default value:Off
Use External IP Address in PORT request
Indicates for active (aka port) mode that the external rather than the local IP address should be included in data port requests to the FTP server.
Possible values:OnorOff
Default value:Off
Use Folded Headers For Outbound Messages
Enables or disables automatic line wrapping of HTTP headers exceeding 76 characters. By default headers are not folded since some non-Cleo product remote hosts using Microsoft Internet Information Server (IIS) cannot handle folded headers properly. Unless your host has been pre-configured to enable folded headers, leave this setting cleared!
Possible values:OnorOff
Default value:Off
Use NLST
During aGET *command, indicates that VersaLex should use anNLSTcommand rather thanLISTwhen getting the list of files available for download.
Possible values:OnorOff
Default value:On
Use SMIME Over FTP Headers
Allows message compatibility with non-standard (pre-AS3) servers. When set, the AS3-To and AS3-From headers specified for that trading partner are translated to To and From headers before the message is sent.
Possible values:OnorOff
Default value:Off
Wait For Execute On
Indicates whether execution should wait for processing to complete within anExecute On Fail,Execute On Successful Copy,Execute On Successful Receive, orExecute On Successful Sendcommand. Note that this option does not apply to native AS400 execution.
Possible values:OnorOff
Default value:On
XML Encryption Algorithm
The method used to encrypt/decrypt files when XML Encryption packaging is requested through theMailbox Packagingtab. See Configuring mailbox packaging. IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtab 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 inLCOPY -ZIPoperations.
Default value: The value specified for this property on theOptions > Advancedpanel, if set.
Zip Compression Level
Controls the level of compression forLCOPY -ZIPoperations.IfSystem Defaultis specified, the value set on theConfigure > Options > Advancedtakes precedence
Possible values:
System Default
9- (Best Compression)
8
7
6
5
4
3
2
1
0- (No Compression)
Default value: SystemDefault
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled forLCOPY ZIP RECoperations. 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:OnorOff
Default value:On
AS3 Mailbox
Mailbox parameters allow you access to the remote host and define the security of files being sent.
You can use the AS3 mailbox wizard to configure your system for the most common setup.See Using the wizard to create a host or mailbox.
AS3 Mailbox: AS3 Tab
Select encryption and signing for sending messages and optional security for receiving messages.If an MDN receipt is required, you can also select the format and delivery method of that receipt.
Request
Specify the S/MIME format for messages to send to the remote host.
Unsigned / unencrypted (neitherEncryptednorSignedselected)
Signed (onlySignedselected)
Encrypted (onlyEncryptedselected)
Signed / Encrypted (bothSignedandEncryptedselected)
Receipt
Enables theMDN Receiptsection. See MDN Receipt.
Encryption Algorithm
WhenEncryptedis selected, theEncryption Algorithmfield is enabled and allows you to choose the encryption algorithm for the message to be sent to the remote host.The remote host must be able to decrypt the message using the algorithm you choose. For a non-VersaLextrading partner, it is important to verify that your trading partner can use the selected algorithm prior to sending an encrypted message. The default encryption method isTripleDES. See Cryptographic Services for more information on choosing an encryption algorithm.
Key Algorithm
WhenEncryptedis selected, theKey Algorithmfield is enabled and allows you to choose the algorithm to encrypt the content encryption key with the public key of your trading partners encryption certificate. Your trading partner uses the private key of their encryption certificate to decrypt the content encryption key that is subsequently used to decrypt the content of the message.
Possible values:
RSA(default)
RSAES-OEAP
Signature Algorithm
WhenSignedis selected, theSignature Algorithmis used to encrypt the hash value of the signature with the private key of your signing certificate. Your trading partner uses the public key of your signing certificate to decrypt the hash value of the signature that authenticates you as the sender of the message. WhenRSAis selected, the selectedHash/MIC Algorithmis used to determine the appropriate signature algorithm; for example,rsaEncryption,sha256WithRSAEncryption,sha384WithRSAEncryptionorsha512WithRSAEncryption. IfRSASSA-PSSis selected, the combination of the private key of your signing certificate and the hash algorithm is used in conjunction with the RSASSA-PSS algorithm to secure the signature.
Possible values:
RSA(default)
RSASSA-PSS
Hash/MIC Algorithm
WhenSignedin theRequestsection is selected, the combination of the signature algorithm and the selected hash algorithm is used to secure the signature.
Note:If the RSASSA-PSS signature algorithm is used and the SHA-512 hash algorithm is selected, the strength of the signature algorithm of your signing certificate must be SHA256withRSA or better.
When theSignedoption in theMDN Receiptsection is selected, the selectedHash/MIC Algorithmis used to compute the independent Message Integrity Check (MIC) that is returned in the MDN Receipt.
Possible values:
SHA-1(default)
MD5(cryptographically weak and should not be used unless no other Hash/MIC algorithm is available)
SHA-256
SHA-384
SHA-512
Compress Content
WhenCompressis selected, the message will be compressed using ZLIB compression. Compression is generally used for large files so that the message will conserve bandwidth and be transferred more efficiently and securely over the Internet.
Inbound Message Security
Indicates how inbound messages should be received.
Select any combination ofForce Encryption,Force SignatureandForce MDN Signatureto check the level of the inbound message security. If the message is not received according to the corresponding message security settings, the message is rejected and an error is logged.
By default, no settings are selected. If no settings are selected, the security level of the message is not checked.
MDN Receipt
Attributes of the Message Disposition Notification (MDN) receipt you requested.
Message Disposition Notifications can only be returned Asynchronously in AS3 as part of a new FTPPUTorGETcommand.
Signed
Compute and remember an independent hash over the content of the sent message using theHash/MIC Algorithmyou select. The trading partner returns the MDN with a digital signature; and computes an independent MIC value over the content of the message it received (using the same MIC algorithm) and returns this value as a base64-encoded value in the human-readable portion of the MDN. When the MDN is received, the original MIC is compared against the received MIC. When the MIC values match, the sender is guaranteed that the message read by the trading partner is identical to the message that came from the sender and was not modified in any way.
Forward MDN to Email
Forward a copy of the MDN received to the email address specified in theEmail Addressfield.
Synchronous
Disabled for AS3.
Asynchronously
The only option available for AS3.
Return the MDN as part of a new FTP session, that is, only the FTP status message is returned during the acknowledgment phase of the message response and the MDN is returned later in a separate FTPPUTorGETcommand.
AS3 Mailbox: Certificates Tab
Associate a trading partner's signing and encryption certificates with this AS3 mailbox and override the signing and encryption certificates defined in the Local Listener, if necessary.
You must acquire your trading partner's signing and encryption certificates and provide yours to your trading partner.See Acquiring your trading partner's signing and encryption certificates and Creating and providing your signing/encryption certificates.
Trading Partner's Certificates
Encryption Certificate
The name of the file containing your Trading Partner's encryption certificate. Specify a value or clickBrowseto navigate to the file you want to select.
Signing Certificate
Select the check box to enable the field.
The name of the file containing your Trading Partner's signing certificate. Specify a value or clickBrowseto navigate to the file you want to select.
If you do not specify a signing certificate, theVersaLexapplication uses all the certificates in its certificate store to determine if the signature of the incoming data message is trusted.
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, theSigning Certificatefield is populated with the same certificate you selected in theEncryption Certificatefield.
If the remote host is capable of receiving Certificate Exchange Messages (CEM) or you want to email your certificates to your trading partner, you can send your user and SSL certificates to the remote host by clickingExchange Certificates.
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.
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 theVersaLexapplication 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.
ClickBrowseto navigate to and select a certificate. Enter thePasswordfor your signing certificate's private key.
Encryption Certificate Alias
The certificate for decrypting your trading partners messages, if you have created or obtained a separate certificate.
ClickBrowseto navigate to and select a certificate. Enter thePasswordfor your encryption certificate.
Use signing certificate
Select this check box to use the same certificate for signing and decrypting your trading partner's messages. TheEncryption Certificate AliasandPasswordare populated to match theSigning Certificate Aliasand disabled.
Exchange Certificates
Invokes theCertificate Exchangedialog box. If you override the default the certificates, you must exchange these alternate certificates with your trading partner.
Overriding AS3 Local Listener Certificates
By default, the certificates you configured on theCertificatestab of the Local Listener panel will be the certificates used to sign messages sent to your trading partner and decrypt messages received from your trading partner. See Configuring certificates for Local Listener.
UseOverride Local Listener Certificatesto select alternate certificates for signing and decrypting messages with this particular trading partner. If you do override the default the certificates, don't forget to export and exchange these alternate certificates with your trading partner.
AS3 Mailbox: FTP Tab
Login
User Name
Password
FTP Account
Credentials for authentication to the FTP server. SelectNo Password Requiredif there is no password required for authentication.
FTP Accountis optional.
Headers
AS3-From
AS3-To
Enter theAS3-FromandAS3-Tonames for this trading relationship.
Note:The values in theAS3-FromandAS3-Tofields are determined and agreed upon as part of initially setting up the trading relationship. These fields can be company-specific, such as DUNS number, or an agreed-upon identification string.TheAS3-From/AS3-Tocombination is case-sensitive and must be unique across all hosts defined in your system because it is used to determine in which Inbox messages are stored when received from remote hosts.
Subject
Identifies the message and is returned in the human-readable section of an MDN, if requested.
Content-Type
Optional. The format of the message being sent. Used by the sending and receiving applications to properly assemble and parse the message. Choose from the following:
EDIFACT
X12
XML
Binary
Plain Text
EDI Consent
Note:IfContent-Typeis not specified or if multiple payloads are attached in the message, theContent-Typeis detected based first on file content and then the file extension.Detectable types includeapplication/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, andvideo/mpg.
AS3 Mailbox: Security Tab
If aSecurity Modeis specified in the host's FTP tab, a remote host can issue client certificates.If so, import the client certificate using Certificate management and then specify or browse for the imported certificate's alias and password.
AS3 Action
An action's parameters define a repeatable transaction for your mailbox designated for the host system.
AS3 Action: Action Tab
Use theActiontab to configure commands within the action. See Composing an action.See also FTP Command Reference for further information.
VerifyingYourAS3 Names
When configuring a client to exchange messages with aCleo VLTraderorCleo HarmonyAS3 server, you can use the following SITE command to verify the client has correctly defined the AS3-To and AS3-From names.The command syntax is:
SITE VERIFY AS3-To: your-AS3-To-name, AS3-From: your-AS3-From-name
If your AS3 names are properly configured, the server returns a positive response. Otherwise, a failure response is returned.
When using a VersaLex client, you can use the%as3.to%and%as3.from%macros in place ofyour-AS3-To-nameandyour-AS3-From-name, and so on.
SITE VERIFY AS3-To: %as3.to%, AS3-From: %as3.from%
Note:See Using macro variables for further information.
AS3-Specific Directories
The following additional directories are created either during the AS3 installation or as needed by the application:
Directory
Purpose
lostandfound\
Default inbox where incoming data is deposited when the application cannot determine where to put it.
AS3\
Location where raw (unprocessed) incoming and outgoing messages are stored.Incoming messages are located in theAS3\receiveddirectory and outgoing messages are located in theAS3\sentdirectory. These files can be helpful in diagnosing problems. Old files should be deleted or archived by the user, if necessary.
TheAS3\unsentdirectory contains raw header, data and message setup information files. These files are used if a message needs to be retransmitted, and are deleted automatically by the application once the message transfer has either completed successfully or has failed due to timeouts, exceptions, or the number of retries has been exhausted.
TheAS3\mdndirectory contains subdirectories for received (and optionally sent) MDNs. This directory can be changed on the AS3 Service Panel. MDNs can be automatically archived by the application or manually archived by the user from theMDNstab on the listener panel.Archived MDNs are stored inAS3\mdn\received\archive\mdn.ziporAS3\mdn\sent\archive\mdn.zip.
TheAS3\datadirectory contains anAS3msgs.txtfile used by the application to determine the receipt of duplicate messages. Entries in this file are retained for the time interval configured on the AS3 Service panel.
temp\
Temporary location where incoming messages can be stored while being processed by the application.By default, they are deleted automatically once the message has been completely processed; however, these files can be kept for problem diagnosis by using theRetain Temporary Inbound Message Fileshost-level Advanced property.These temporary files will automatically be deleted after 7 days.
View Article
Working at Cleo
Recently Asked Questions
Recent Cleo Employee Reviews
- Its great to work for a company that has a razor focus strategy and a team of colleagues that are bedt in class.
- They work very hard and are amazing
- cleo harmony is good and robust
- Flexible schedule while working remotely.
- Merchandise goes on sale online, cant purchase in the store...yet when you order online, they don't have your size,BUT YOUR SIZE IS SITTING AT THE STORE, BUT YOU CANT GET IT FOR THE SALE PRICE