Use the Local Commands host for local commands only. With Local Commands hosts, there is no server, client, or protocol involved, nor any connection to another host. Local Commands mailboxes can have actions, but only operations that manipulate files within the local file system are provided. You can create multiple Local Commands hosts, schedule actions, and package files you have copied using an available packaging method, such as OpenPGP.
See Composing an action and Local command reference for more information.
Setting up local packaging for Local Commands host
Prior to setting up the Local section, you must create or acquire an encryption certificate to be used for local storage encryption, decryption, and signing. The Local section, along with the dialog boxes stemming from the Configure button, allows you to associate your signing/encryption certificate with this mailbox for packaging destination files and associate your signing/encryption certificate with this mailbox for un-packaging source files. Note that the certificates specified on this tab may reference the same certificate or two different certificates; this depends on your application.
Note: When you click Configure, either the Configure OpenPGP Local Packaging or Configure XML Encryption Local Packaging dialog box is displayed. It is important to understand that the Encrypt, Decrypt, and the certificate fields are shared between the two dialogs. This allows you to set up these fields once, and then simply use the Packaging selection on the Local section to toggle between packaging schemes.
Select an option from the Packaging drop-down menu. Choose from the following:
- None: local packaging is not active.
- OpenPGP: OpenPGP local packaging is active. See OpenPGP local packaging for Local Commands host reference for information on setting up OpenPGP local packaging.
- XML Encryption: XML Encryption local packaging is active. See XML Encryption local packaging for Local Commands host reference for information on setting up XML Encryption local packaging.
OpenPGP local packaging for Local Commands host reference
- Encrypt
- Enables you to sign and encrypt destination files. If you choose this option, you must also choose encryption options and you should enter both your trading partner's certificate and your user certificate as both might be necessary depending on other options you select. Note that the Encrypt and Decrypt options are mutually exclusive, as it is only practical to perform a single operation within an LCOPY command.
- Decrypt
- Enables you to verify signatures and decrypt source files. You should enter both your trading partner's certificate and your user certificate as both might be necessary depending on other options you select. Note that the Encrypt and Decrypt options are mutually exclusive, as it is only practical to perform a single operation within an LCOPY command.
- Encryption/Signature Verification
-
- Certificate
- The CA certificate you want to use for encryption and signature verification. You can specify a certificate explicitly or click Browse to navigate to a certificate.
- Decryption/Signing
-
- Override Local Listener Certificate
- Select the Override Local Listener Certificate check box enable the Certificate Alias and Password fields, where you can specify an certificate to use instead of the default signing certificate you specified for the Local Listener. See Configuring certificates for Local Listener.
- Certificate Alias
- The certificate you want to use for signing and decryption. You can specify a certificate alias explicitly or click Browse to navigate to a certificate.
- Password
- The password of the certificate's private key.
- Encryption Options
- You write a destination file to the file system with any combination of the following options (see Advanced system options for information about associated advanced properties):
- Encrypted
- Encrypt using the PGP Encryption Algorithm.
- Signed
- Sign using the PGP Hash Algorithm.
- Compressed
- Compress using the PGP Compression Algorithm.
- Armored (Base64)
- Armor (Base64 encode) the data. Base64 encoding converts binary data to printable ASCII characters.
- Encrypt to My Certificate
- Allow Signing/Decryption Certificate and Signature Verification/Encryption Certificate to decrypt inbound encrypted files. The Encrypted check box must be selected to enable this option.
- Decryption Options
-
- Force Encryption
- Force Signature
- Allow Non-OpenPGP
- Select one or more of these options to check all source files for the desired security level. An error is logged (and the file rejected) if the file is not packaged according to the corresponding security settings. If a setting is not selected, the file will not be checked for conformance with that security setting.
XML Encryption local packaging for Local Commands host reference
- Encrypt
- Enables you to encrypt destination files. Note that the Encrypt and Decrypt options are mutually exclusive, as it is only practical to perform a single operation within an LCOPY command.
- Decrypt
- Enables you to decrypt source files. Note that the Encrypt and Decrypt options are mutually exclusive, as it is only practical to perform a single operation within an LCOPY command.
- Encryption Certificate
-
- Certificate
- The CA certificate you want to use for encryption and signature verification. You can specify a certificate explicitly or click Browse to navigate to a certificate.
- Decryption Certificate
-
- Override Local Listener Certificate
- Select the Override Local Listener Certificate check box enable the Certificate Alias and Password fields, where you can specify a certificate to use instead of the default encryption certificate you specified for the Local Listener. See Configuring certificates for Local Listener.
- Certificate Alias
- The certificate you want to use for decryption. You can specify a certificate alias explicitly or click Browse to navigate to a certificate.
- Password
- The password of the certificate's private key.
Local Commands host advanced properties
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- Email On Fail
- If an error occurs during a command, email the error condition. See Configuring email or execute based on results.
- Email On Flag
- If a flagged event occurs, email the event. See Configuring email or execute based on results.
- 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.
- Email On Successful Copy
- Send an email notification after copying a file using LCOPY. See Configuring email or execute based on results.
- 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.
- 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.
- Execute On Fail
- If an error occurs during a command, run a system command. See Configuring email or execute based on results.
- 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. - 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.
- 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.
- LCOPY Archive
- If specified, contains the directory for archiving LCOPY source files.
- 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. - Macro Date Format
- Specifies the date format to be used when the
%date%macro is used. - Macro Time Format
- Specifies the time format to be used when the
%time%macro is used. - Outbox Sort
- Controls the order in which multiple files are transferred for a PUT command. If
System Defaultis specified, the value set on the tab takes precedence. ForAlphabeticalordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique. - PGP Compression Algorithm
- Compression method used when OpenPGP packaging (with compression) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab is in effect. - PGP Encryption Algorithm
- Encryption method used when OpenPGP packaging (with encryption) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab takes precedence. - PGP Hash Algorithm
- Signing method used when OpenPGP packaging (with signing) is requested through the Configuring mailbox packaging. If
System Defaultis specified, the value set on the tab takes precedence. - 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.
- 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.
- PGP V3 Signature
- Retry Delay
- The amount of time (in seconds) before a retry should be attempted.
- Terminate On Fail
- If an error occurs during a command, stop the action.
Note:
Regarding non-CHECK commands: When
Terminate 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.Regarding CHECK commands:
Terminate On Failis only honored if theConditionsMetparameter is set and the result of the CHECK is classified asError. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications. - 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.
- 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.
- 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 Defaultis specified, the value set on the tab takes precedence. - Zip Comment
- Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations.
- Zip Compression Level
- Controls the level of compression for LCOPY -ZIP operations. If
System Defaultis specified, the value set on the takes precedence - 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.
Comments
0 comments
Please sign in to leave a comment.