Advanced system options

Advanced properties reference

Email On Check Conditions Met

Send an email notification after running a CHECK command where the overall conditions of the check are met.  See Configuring email or execute based on results.

Note: This is a Cleo Harmony and Cleo VLTrader option.

Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.

Default value:The value specified for this property on the Options > Advanced panel (if set).

Email On Check Conditions Not Met

Send an email notification after running a CHECK command where the overall conditions of the check are not met. See Configuring email or execute based on results.

Note: This is a Cleo Harmony and Cleo VLTrader option.

Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.

Default value:The value specified for this property on the Options > Advanced panel (if set).

Email On Fail

If an error occurs during a command, email the error condition.  See Configuring email or execute based on results.

Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.

Default value:The value specified for this property on the Options > Advanced panel (if set).

Email On Flag

If a flagged event occurs, email the event. See Configuring email or execute based on results.

Email addresses separated by commas (,), semicolons (;) or colons (:). The first address should be an internal email address.

Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.

Default value:The value specified for this property on the Options > Advanced panel (if set).

Email On Repetitive Action Failures

When "Email On Fail" is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses emailing of the same alert multiple times.  If the same email alert continues to be suppressed after 24 hours, the suppressed email alert will be sent every 24 hours and after every system restart if the failure occurs again. When the failure is resolved an email alert will be sent.

Note: This feature only suppresses multiple emails if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.

Possible values: On or Off

Default value: On

Email On 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 Repetitive System Failures

When “Email On Fail” is enabled and the same system failure occurs (unrelated to an action or inbound Listener message 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. Since it is not possible to determine that a system failure has been resolved, failure resolution email alerts will not 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, nor is supported for host-based actions.

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 Repetitive System Failures

When Execute On Fail is enabled and the same system failure occurs (unrelated to an action or inbound Listener message 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 if the failure occurs again.  Since it is not possible to determine that a system failure has been resolved, the Execute On Fail command will not be executed on resolution of the failure. 

Note: This feature only suppresses multiple executions of the Execute On Fail command if the same failure occurs multiple times in a row.  Suppression is not maintained across synchronized hosts.

Possible values: On or Off

Default value: On

Execute On Successful Copy

After successfully copying  a file using LCOPY, run a system command.  This command may be used for post-processing the file.  See Configuring email or execute based on results.

Possible values: System command to be executed.

Default value: The value specified for this property on the Options > Advanced panel (if set).

Execute On Successful Receive

After successfully receiving a file, run a system command.  This command may be used for post-processing the file.  SeeConfiguring 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).

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

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

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

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