OFTP Configuration / OFTP Host
Parent topic: OFTP Host

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: On or Off
Default value: Off
Add Mailbox Alias Directory to Outbox
Appends a subdirectory at the end of the host's configured outbox directory.  This allows files to be sent through different mailboxes to be kept separate.
Possible values: On or Off
Default value: Off
Add Mailbox Alias Directory to Receivedbox
Appends a subdirectory at the end of the host's configured receivedbox directory.  This allows files that have been sent through different mailboxes to be kept separate.
Possible values: On or Off
Default value: Off
Add Mailbox Alias Directory to Sentbox
Appends a subdirectory at the end of the host's configured sentbox directory.  This allows files that have been sent through different mailboxes to be kept separate.
Possible values: On or Off
Default value: Off
Allow Actions To Run Concurrently
Normally, actions and host actions within the same host are allowed to run concurrently. You can use this property to not allow actions and host actions to run concurrently.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: On or Off
Default value: On
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: On or Off
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: On or Off
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: On or Off
Default value: Off
Application Layer Receipts
Note: This applies only to the Cleo Harmony and Cleo VLTrader applications.
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.

The PUT -RET option 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 or Cleo VLTrader or Cleo Harmony database 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 the Place pending EERP… settings and interrogate the generated .eerp file.  

    If using the API ILexiComIncoming interface, the EERP.pending property in the open() method parameters object points to the location of the saved .eerp properties file or simply has a value of True.  If using database payload, this property value is stored in the VLIncomingProperties table.

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 - n seconds

0 indicates no timeout

Default value: 150 seconds
Delete Zero Length Files
Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
Possible values: On or Off
Default value: Off
Do Not Send Zero Length Files
Indicates whether zero length files to be sent to the server should be ignored rather than processed. If the -DEL option is being used, any zero length file ignored will also be deleted.
Possible values: On or Off
Default value: Off
Downgrade OFTP Version
Use may be necessary if the trading partner OFTP software does not on its own properly downgrade from Cleo Harmony, Cleo VLTrader, or Cleo LexiCom OFTP version 2.0. 
Possible values:
  • 1.2, 1.3, or 1.4 to force downgrade only when initiator of session
  • -1.2, -1.3, or -1.4 to 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 a CHECK command where the overall conditions of the check are met.  See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Check Conditions Not Met
Send an email notification after running a CHECK command where the overall conditions of the check are not met. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Fail
If an error occurs during a command, email the error condition.  See 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 the Options > Advanced panel (if set).
Email On Flag
If a flagged event occurs, email the event. See Configuring email or execute based on results.
Email addresses separated by commas (,), semicolons (;) or colons (:). The first address should be an internal email address.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Repetitive Action Failures
When "Email On Fail" is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses emailing of the same alert multiple times.  If the same email alert continues to be suppressed after 24 hours, the suppressed email alert will be sent every 24 hours and after every system restart if the failure occurs again. When the failure is resolved an email alert will be sent.
Note: This feature only suppresses multiple emails if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values: On or Off
Default value: On
Email On Repetitive Listener Failures
When "Email On Fail" is enabled and the same failure occurs each time an inbound message is processed by the Listener for a specific host, leaving this option unchecked suppresses emailing of the same alert multiple times. If the same email alert continues to be suppressed after 24 hours, the suppressed email alert will be sent every 24 hours and after every system restart if the failure occurs again. If the failure can be associated with a specific host, an email alert will be sent when the failure is resolved.  Failure resolution email alerts will not be sent for general Listener failures since it is not possible to determine that these types of failures have been resolved.
Note: This feature only suppresses multiple emails if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values: On or Off
Default value: On
Email On Successful Copy
Send an email notification after copying a file using LCOPY.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Successful Receive
Send an email notification after successfully receiving a file.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Successful Send
Send an email notification after successfully sending a file.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Execute On Check Conditions Met
After executing a CHECK command where the overall conditions are met, run a system command.  See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Note: Note that if multiple files contribute to the conditions being met, and one of the file macros is in the command (e.g., %file%),  the system command will be executed repeatedly - once for each file.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Check Conditions Not Met
After executing a CHECK command where the overall conditions are not met, run a system command.  See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Fail
If an error occurs during a command, run a system command.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Repetitive Action Failures

When Execute On Fail is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of the Execute On Fail command.  If suppression of execution of the command for this failure continues after 24 hours, the suppressed Execute On Fail command will be executed every 24 hours and after a system restart if the failure occurs again.  When the failure is resolved, the Execute On Fail command will be executed again.  Users must account for this by including the %status% macro variable for the Execute On Fail command (see Using macro variables) and then checking for a success or failure.    

Note: This feature only suppresses multiple executions of the Execute On Fail command if the same failure occurs multiple times in a row.  Suppression is not maintained across synchronized hosts.
Possible values: On or Off
Default value: On
Execute On Repetitive Listener Failures

When Execute On Fail is enabled and the same failure occurs each time an inbound message is processed by the Listener for a specific host, leaving this option unchecked suppresses multiple executions of the Execute On Fail command.  If suppression of execution of the command for this failure continues after 24 hours, the suppressed Execute On Fail command will be executed every 24 hours and after every system restart if the failure occurs again.  If the failure can be associated with a specific host, the Execute On Fail command will be executed again when the failure is resolved. Users must account for this by including the %status% macro variable for the Execute On Fail command (see Using macro variables) and then checking for a success or failure. Executions of the "Execute On Fail" command for resolution of general Listener failures will not be done since it is not possible to determine that these types of failures have been resolved.

Note: This feature only suppresses multiple executions of the Execute On Fail command if the same failure occurs multiple times in a row.  Suppression is not maintained across synchronized hosts.
Possible values: On or Off
Default value: On
Execute On Successful Copy
After successfully copying  a file using LCOPY, run a system command.  This command may be used for post-processing the file.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Successful Receive
After successfully receiving a file, run a system command.  This command may be used for post-processing the file.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Successful Send
After successfully sending a file, run a system command.  This command may be used for post-processing the file.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Fixed Record EOL Characters
End-of-line characters to be inserted and/or deleted.
Possible values: 0 to n characters. 
Special character sequences:
  • \r - carriage return
  • \n - new line (linefeed)
  • \f - form feed
  • \t - horizontal tab
  • \0 - null
  • \\ - backslash
Fixed Record Incoming Delete EOL
If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to look for and delete EOL characters while receiving a file.
Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
Possible values: On or Off
Default value: Off
Fixed Record Incoming Insert EOL
If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to insert EOL characters while receiving a file.

Fixed Record Incoming Delete EOL and Fixed Record Incoming Insert EOL are mutually exclusive properties.

Possible values: On or Off
Default value: Off
Fixed Record Length
The fixed record length after which end-of-line characters need to be inserted and/or deleted.
Possible values: 0 - n
Default value: 0
Fixed Record 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: On or Off
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: On or Off
Default value: Off
High Priority
Indicates whether incoming and/or outgoing transfers through the host should be treated as high priority. When both high priority and regular priority transfers are active, the high priority transfers get a larger portion of the available bandwidth. Go to Configure > Options > Other to set the High Priority Transfers Percentage Available Bandwidth (defaults to 75). See Other system options for more information.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Warning: If the trading partner’s bandwidth (and not Cleo Harmony's or Cleo VLTrader’s) is limiting the transfer rate, then setting High Priority will not increase the transfer rate and will only result in potentially slowing down other Cleo Harmony or Cleo VLTrader transfers. Also, do not attempt to set High Priority Incoming or Outgoing on a host where the same instance of Cleo Harmony or Cleo VLTrader is both the client and server (for example, a local looptest).
Possible values:
  • Incoming
  • Outgoing
  • Both
Include Failure In Subject Of Email
When specified, the exception message will be included in the email that is generated on failure.
Note: If the exception message exceeds 256 characters, it will be truncated.
Possible values: On or Off
Default value: The value specified for this property on the Options > Advanced panel
LCOPY Archive
If specified, contains the directory for archiving LCOPY source files.
Possible values: Any local or shared directory. Macros can be used.  See Using macro variables (LCOPY Archive context).
Default value: The value specified for this property on the Options > Advanced panel, if any.
Log Individual LCOPY Results To Transfer Logging
When this option is enabled, a <send> and <receive> result is logged to the transfer log for each file copied.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: On or Off
Default value: Off
Macro Date Format
Specifies the date format to be used when the %date% macro is used.
Possible values: See Using macro variables for information about usage and possible date/time formats.
Default value: The value specified for this property on the Options > Advanced panel, if any.
Macro Time Format
Specifies the time format to be used when the %time% macro is used.
Possible values: See Using macro variables for information about usage and possible date/time formats.
Default value: The value specified for this property on the Options > Advanced panel, if any.
Maximum Incoming Transfer Rate (kbytes/s)
Sets the maximum incoming transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of 0 does not limit the transfer rate. The Maximum Incoming Transfer Rate system setting might also limit the transfer rates. The system Maximum Incoming Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers also affects individual transfer rates. See Advanced system options.
Possible values: 0 - n
Default value: 0
Maximum Outgoing Transfer Rate (kbytes/s)
Sets the maximum outgoing transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of 0 does not limit the transfer rate. The system setting might also limit the transfer rates. The system Maximum Outgoing Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers will also affect individual transfer rates. See Advanced system options for more information about Maximum Outgoing Transfer Rate.
Possible values: 0 - n
Default value: 0
Outbox Sort
Controls the order in which multiple files are transferred for a PUT command.  If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.  For Alphabetical ordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique.
Possible values:
  • System Default
  • Alphabetical
  • Date/Time Modified
Default value: System Default
Outgoing Insert EOL Between Interchanges
If Fixed Record Outgoing Insert EOL is active, indicates to also insert EOL characters between EDI interchanges while sending the file.
Possible values: On or Off
Default value: Off
Partner Email Address
The email address of the trading partner for this trading relationship.  When set, this address is automatically used to send your local profile information and/or certificates to your trading partner. SeeEmailing a profile to your trading partner.
Possible values: Email address(es) separated by commas (,), semicolons (;) or colons ( : ). 
Note: This is a Cleo LexiCom only option. For Cleo Harmony and Cleo VLTrader, this information is stored in the trading partner management table. See Managing Trading Partners.
PGP Compression Algorithm
Compression method used when OpenPGP packaging (with compression) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If System Default is specified, the value set on the Configure > Options > Advanced tab is in effect.
Possible values:
  • System Default
  • ZIP
  • ZLIB
Default value: System Default
PGP Encryption Algorithm
Encryption method used when OpenPGP packaging (with encryption) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.
Possible values:
  • System Default
  • TripleDES
  • Blowfish
  • CAST5
  • DES
  • AES-128
  • AES-192
  • AES-256
  • Twofish
Default value: System Default
PGP Hash Algorithm
Signing method used when OpenPGP packaging (with signing) is requested through the Configuring mailbox packaging.  If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.
Possible values:
  • System Default
  • MD2
  • MD5
  • RIPE-MD-160
  • SHA-1
  • SHA-256
  • SHA-384
  • SHA-512
Default value: System Default
PGP Integrity Check
When OpenPGP encrypting (see Configuring mailbox packaging), include an integrity check on encrypted data. Can be disabled for compatibility with certain OpenPGP implementation.
Possible values: On or Off
Default value: On
PGP Signature Verification
Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. In general, this property should be enabled.
Possible values: On or Off
Default value: On
PGP V3 Signature
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: On or Off
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: On or Off
Default value: On
SSL Cipher
Indicates a specific cipher to be used with the server for SSL key exchange, encryption, and hashing. If not set, the list of supported ciphers is presented to the server and the server picks one.
Possible values: Any cipher from the supported list. If the server does not also support the cipher, an SSL handshake error will occur.
SSL Maximum Protocol Version
Specifies the maximum protocol version allowed. By default, this field is blank, designating that Cleo Harmony, Cleo VLTrader, or Cleo LexiCom will select the most recent version (currently TLS 1.2).
Possible values:
  • SSL 3.0
  • TLS 1.0 (SSL 3.1)
  • TLS 1.1 (SSL 3.2)
  • TLS 1.2 (SSL 3.3)
SSL Minimum Encryption Key Size
Specifies the minimum encryption key size allowed when selecting an SSL cipher. To prevent use of low- or medium-strength ciphers, change from the default value of 0 to 112, 128, or 256 (depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing the No suitable cipher suites are enabled exception to occur.
Possible values: 0 - n bits
Default value: 0
SSL Minimum Protocol Version
Specifies the minimum protocol version allowed. SSL 3.0 is the default value for compatibility with servers that do not support the more recent TLS versions 1.0, 1.1, and 1.2.
Possible values:
  • SSL 3.0
  • TLS 1.0 (SSL 3.1)
  • TLS 1.1 (SSL 3.2)
  • TLS 1.2 (SSL 3.3)
Default value: SSL 3.0
SSL Use Record Splitting
Indicates whether to use 1/n-1 record splitting in CBC mode as a countermeasure against the Rizzo/Duong BEAST (Browser Exploit Against SSL/TLS) attack against the SSL 3.0 / TLS 1.0 protocol. Must be turned off if the SSL library on the other side of the connection does not support the feature.
Possible values: On or Off
Default value: On
Store Raw Sent Message
When this property is enabled, a copy of the outbound message is stored in the HTTP/sent directory.
Possible values: On or Off
Default value: Off
Terminate On Fail
If an error occurs during a command, stop the action. 
Note:

Regarding non-CHECK commands:  When Terminate On Fail is on, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and then the action stops.  When Terminate On Fail is off, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and the action continues.

Regarding CHECK commands:  Terminate On Fail is only honored if the ConditionsMet parameter is set and the result of the CHECK is classified as Error. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications.

Possible values: On or Off
Default value: On
Unzip Use Path
Indicates whether or not zip entry paths should be used for LCOPY -UNZIP operations.  When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path. 
Possible values: On or Off
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: On or Off
Default value: Off
Wait For Disconnect After Sending End Of Session
Indicates that if the Cleo Harmony, Cleo VLTrader, or Cleo LexiCom application initiates end-of-session, it should wait for a disconnect request from the connected trading partner rather than immediately disconnecting.
Possible values: On or Off
Default value: Off
Wait For Execute On
Indicates whether execution should wait for processing to complete within an Execute On Fail, Execute On Successful Copy, Execute On Successful Receive, or Execute On Successful Send command.  Note that this option does not apply to native AS400 execution.
Possible values: On or Off
Default value: On
XML Encryption Algorithm
The method used to encrypt/decrypt files when XML Encryption packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging .  If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence. 
Possible values:
  • System Default
  • TripleDES
  • AES-128
  • AES-192
  • AES-256
Default value: System Default
Zip Comment
Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations.
Default value: The value specified for this property on the Options > Advanced panel, if set.
Zip Compression Level
Controls the level of compression for LCOPY -ZIP operations. If System Default is specified, the value set on the Configure > Options > Advanced takes precedence 
Possible values:
  • System Default
  • 9 - (Best Compression)
  • 8
  • 7
  • 6
  • 5
  • 4
  • 3
  • 2
  • 1
  • 0 - (No Compression)
Default value: System Default
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled for LCOPY –ZIP –REC operations.  When enabled, each first-level subdirectory (and all of its descendents) will be bundled together into an individual zip file.  The name of this zip file may optionally reflect the subdirectory name if an asterisk (*) is placed in the destination path.  Any files that are directly off the source root directory will not be copied. 
Possible values: On or Off
Default value: On
Parent topic: OFTP Host
© 2018 Cleo. All rights reserved.