This section provides information about advanced properties of connector hosts. See Setting advanced host properties for information about how to use and set the properties
supported in all protocols and connectors.
Note: When using the URI syntax to access this connector host, some Connector Host Advanced
Properties might overlap with properties of the originating host (for example,
Email On Fail or Terminate On Fail). When this
occurs, which property is used (originating host or Connector) depends on the host making
the decision. In the case of Terminate On Fail, it is the originating
host making the decision and that same property in the connector host is not used.
-
- 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
- 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 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 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 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 panel (if set).
- Email On Repetitive Action
Failures
- When "Email On Fail" is enabled and the same failure occurs each time an action is
run for a specific host, leaving this option unchecked suppresses emailing of the same
alert multiple times. If the same email alert continues to be suppressed after 24 hours,
the suppressed email alert will be sent every 24 hours and after every system restart if
the failure occurs again. When the failure is resolved an email alert will be
sent.
Note: This feature only suppresses multiple emails if the same failure occurs
multiple times in a row. Suppression is not maintained across synchronized
hosts.
- Possible values: On or Off
- Default value: On
- Email On Successful Copy
- Send an email notification after
copying a file using LCOPY. See Configuring email or execute based on results.
- Possible values: Email addresses separated by commas (,), semicolons (;) or
colons ( : ). The first address should be an internal email address.
- Default value:The value specified for this property on the 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 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 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 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 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 panel (if set).
- Execute On Repetitive Action
Failures
-
When Execute On Fail is enabled and the same failure occurs each
time an action is run for a specific host, leaving this option unchecked suppresses
multiple executions of the Execute On Fail command. If suppression
of execution of the command for this failure continues after 24 hours, the suppressed
Execute On Fail command will be executed every 24 hours and after a
system restart if the failure occurs again. When the failure is resolved, the
Execute On Fail command will be executed again. Users must account
for this by including the %status% macro variable for the Execute On
Fail command (see Using macro variables) and then checking for a
success or failure.
Note: This feature only suppresses multiple executions of the Execute On
Fail command if the same failure occurs multiple times in a row.
Suppression is not maintained across synchronized hosts.
- Possible values: On or Off
- Default value: On
- Execute On Successful Copy
- After successfully copying a file
using LCOPY, run a system command. This command may be used for
post-processing the file. See Configuring email or execute based on results.
- Possible values: System command to be executed.
- Default value: The value specified for this property on the 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 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 panel (if set).
- Fixed Record EOL Characters
- End-of-line characters to be inserted
and/or deleted.
- Possible values: 0 to n
characters.
Special character sequences:
- \r - carriage return
- \n - new line (linefeed)
- \f - form feed
- \t - horizontal tab
- \0 - null
- \\ - backslash
- Fixed Record Incoming Delete EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater
than 0, indicates to look for and delete EOL characters while receiving a file.
Note: When
using FTP ASCII mode, standard EOL characters may already be changing if transferring
between Windows and Unix platforms.
- Possible values: On or Off
- Default value: Off
- Fixed Record Incoming Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater
than 0, indicates to insert EOL characters while receiving a file.
Fixed Record Incoming
Delete EOL and Fixed Record Incoming Insert EOL are mutually exclusive
properties.
- Possible values: On or Off
- Default value: Off
- Fixed Record Length
- The fixed record length after which
end-of-line characters need to be inserted and/or deleted.
- Possible values: 0 - n
- Default value: 0
- Fixed Record Outgoing Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater
than 0, indicates to insert EOL characters while sending a file.
Note: When using FTP
ASCII mode, standard EOL characters may already be changing if transferring between
Windows and Unix platforms.
- Possible values: On or Off
- Default value: Off
- High Priority
- Indicates whether incoming and/or outgoing transfers through the host should be treated
as high priority. When both high priority and regular priority transfers are active, the
high priority transfers get a larger portion of the available
bandwidth. Go
to 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:
- 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 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 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
- Log Transfers For PUT and GET
- Enables and disables transfer logging for connector hosts when invoking
PUT and GET commands within the connector
host itself.
- When using the URI syntax to access a connector host, Log Transfers
For PUT and GET defaults to Off regardless of
its setting within the connector host itself. This is because transfers are
typically logged by the invoking host and duplicated transfer logging is not
desired. However, you can explicitly turn the connector host transfer logging back
on using a URI parameter (?LogTransfersForPutAndGet=On). You can
also use the %this% macro as a URI parameter
(?LogTransfersForPutAndGet=%this%) in an
LCOPY destination or source to log the
LCOPY URI transfer against the originating host/mailbox
instead of the connector host.
- Possible values: On, Off,
or %this%
- Default value: On or Off
depending on context.
- 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 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 panel, if any.
- 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 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
- 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
- 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
- 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 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 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