Sign in
< Back to User Guide Top

Connector host

You can create connector hosts in the Cleo Harmony and Cleo VLTrader applications only.

Connector hosts all have the same general structure, which is slightly different from the other host types. Connector hosts do not have mailboxes. In addition, all properties specific to the connector type are segregated from other advanced properties. Several connector hosts ship with the product and are available in the Templates tree, including SMB, Clarify, EEI, File, S3 (Cleo Harmony only), HDFS (Cleo Harmony only), and LDAP. The SMB, Clarify, EEI, File S3, and HDFS connectors are all data connectors. The LDAP connector is an authentication connector, which is different from the rest.

A data connector host can be accessed from another host inbox or outbox or as the source or destination of a command by using one of the following URI syntaxes:
Long Form
scheme:host/subdir/filename?name=value
where,
  • scheme is the scheme name built into the connector, sometimes named after a protocol. For example, SMB.
  • host is the alias assigned to the active connector
  • subdir and filename are optional depending on use case
  • name=value is optional and can be used to override any connector or advanced properties. These properties temporarily override properties set in the connector host only during the use of the URI file instance.
Short Form
sysscheme:/subdir/filename?name=value
where,
  • sysscheme is the value of the System Scheme Name property as set under the connector properties tab
  • subdir and filename are optional depending on use case
  • name=value is optional and can be used to override any connector or advanced properties. These properties temporarily override properties set in the connector host only during the use of the URI file instance.
These powerful constructs allow you to move data seamlessly across hosts and connectors.

An authentication connector host can be accessed through a Users' mailbox by selecting the Connector Host authentication type. The same URI syntax applies as above; however, the optional subdir and filename path would never be applicable for an authentication connector.

There are specific rules for URI accessibility. The connector must be located within the same branch as the host for access to be granted, but there are special rules for the root host folder:

  • If the connector is in the root host folder, any host in any folder can access it via a URI. But a host in the root host folder can only access connectors also in the root host folder.
  • Otherwise, the connector must be in the same host subfolder or below for it to be accessible from the host.

Examples of using an URI as Inbox and Outbox

The data connector URIs are typically used as the Inbox and/or Outbox locations for other hosts. This section contains examples of using connector URIs as inboxes and outboxes.

Examples of URIs configured as the host Inbox
smb:MyServer/partner1/inbox
Stores incoming files to an SMB/CIFS file server in the partner1/inbox folder under the share path folder. The name of the file server, login credentials, and share path folder are defined in the MyServer SMB connector.
clarify:Prod/%host%/toclarify
Sends incoming files directly to the Cleo Clarify system(s) configured in the Prod Clarify connector. These files are tagged as coming from the current host alias (%host%). This URI scheme should be used for all Inbox configurations sending directly to Clarify. No sub-path should be specified after toclarify.
eei:Prod/
Sends incoming files directly to the Cleo EEI system configured in the Prod EEI connector host. This URI scheme should be used for all Inbox configurations sending directly to EEI. No sub-path should be specified after the connector alias (Prod in this example).
file:MyRoot/partner1/inbox
Stores incoming files on the file system in the partner1/inbox folder under the root path folder. The root path folder is defined in the MyRoot File connector.
s3:MyS3/partner1/inbox

Sends incoming files directly to the partner1/inbox folder object in an Amazon S3 bucket. The Amazon S3 login credentials, region, and bucket are defined in the MyS3 S3 connector.

hdfs:MyHDFS/partner1/inbox
Sends incoming files directly to the partner1/inbox folder in a Hadoop Distributed File System (HDFS). The HDFS login credentials are defined in the MyHDFS HDFS connector.
Examples of URIs configured as the host Outbox
smb:MyServer/partner1/outbox
Retrieves outgoing files from the partner1/outbox folder under the share path folder on an SMB/CIFS file server. The name of the file server, login credentials, and share path folder are defined in the MyServer SMB connector.
clarify:Prod/%host%/fromclarify
Retrieves outgoing files from the Cleo Clarify system(s) configured in the Prod Clarify connector. Clarify files for the current host alias (%host%) are retrieved directly from Clarify. This URI scheme should be used for all Outbox configurations sending directly from Clarify. No sub-path should be specified below fromclarify.
eei:Prod/partner1
Retrieves outgoing files for partner1 from the Cleo EEI system configured in the Prod EEI connector host. This URI scheme should be used for all Outbox configurations sending directly from EEI. No sub-path should be specified after the EEI partner name (partner1 in this example).
file:MyRoot/partner1/outbox
Retrieves outgoing files from the file system in the partner1/outbox folder under the root path folder. The root path folder is defined in the MyRoot File connector.
s3:MyS3/partner1/outbox
Retrieves outgoing files directly from the partner1/outbox folder object in an Amazon S3 bucket. The Amazon S3 login credentials, region, and bucket are defined in the MyS3 S3 connector.
hdfs:MyHDFS/partner1/outbox
Retrieves outgoing files directly from the partner1/outbox folder in a Hadoop Distributed File System (HDFS). The HDFS login credentials are defined in the MyHDFS HDFS connector.

Connector Configuration

A connector host is configured using parameters that specify its location and how it is reached.

  1. Click the Templates tab in the tree pane.
  2. If necessary, expand the Hosts tree in the Templates tab to find the host you want to use.
  3. Right-click the host and select Clone and Activate. 
    The entire pre-configured host branch (including actions) is copied and activated, the Active tab is selected in the tree pane, and the new active host is selected in the tree.  If necessary, the new active host alias is appended with a number to make it unique. 
    Note: The original pre-configured host remains in the pre-configured tree.
  4. Enter host-level configuration information.
    1. Click the new host in the tree pane.
    2. Enter host-level configuration information on the tabs in the content pane. See Connector Host Configuration.
    3. Click Apply to save your work.
  5. Enter action-level configuration information.
    1. Click an existing host action to display its configuration tabs. Alternatively, right-click the host and select New Host Action.
    2. Edit action information on the tabs in the content pane. See Connector Host Action Configuration.
    3. Click Apply to save your work.
Important: If you leave any of these panels without clicking Apply, your work will not be saved. You can configure the native UI to prompt to you click Apply when 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 click Apply and your updates will not be saved.

Connector Host Configuration

The connector host parameters indicate a host's location and how to reach it.

Connector Host: General Tab

Use the General tab to specify information about folders and directories the host uses before, during, and after transfers.

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 Cleo Harmony and Cleo VLTrader, 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 click … to navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: %system%\
Outbox
Default directory for outgoing files. Enter a value directly or click … to navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: %system%\
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 click … to navigate to and select a directory.
Note: Sentbox might not be available for all Connector Hosts.
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 click … to navigate to and select a directory.
Note: Receivedbox might not be available for all Connector Hosts.
Possible values: Any local or shared directory.
Default value: No default value.

Connector Host: Properties Tab

The label of the Properties tab reflects the name of the connector. When you activate a connector, it has connector properties for which you assign values, some of which are required. This tab is where you assign these values.

You can press Help to display a dialog box containing documentation for all connector properties.

Some properties have buttons associated with them that perform special functions. These functions vary from connector to connector. If a connector property is represented by a table of properties, click the […] button to display a Connector Property table. See Connector Property table for more information.

You can filter these properties using the filter options at the bottom of the table.

If you are using an authentication-type connector, you can use Test Authentication to enter a Username and Password to check against this connector. Optionally, click List Users to view a list of users who belong to this authenticator.

When you are satisfied with your changes, click Apply. You can click Reset to clear any information added or edited in this session.

Note: When using the URI syntax to access this connector host, some connector properties might overlap with properties of the originating host (for example, Command Retries or Do Not Send Zero Length Files). When this occurs, the property used (originating host or connector host) depends on the host making the decision. In the case of Do Not Send Zero Length Files, it is the originating host making the decision and that same property in the connector host is not used.

Connector Host: Advanced Tab

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 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 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 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 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 Harmonyor 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
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 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.
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
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 Failand 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 VLTraderapplications.

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

Connector Host: Info Tab

The Info tab provides information specific to the connector host type in question. For example, the Info tab for an SMB connector contains information specific to the SMB connector only.

Connector Host Action Configuration

An action's parameters capture a repeatable transaction for your host.

Connector Host Action: Action Tab

Use the Action tab to configure commands within an action.

See Composing an action. Also see Connector Host Command Reference.

Connector Host Command Reference

Descriptions of commands and their options, arguments, and parameters.

ATTR

Get attributes for a file on the connector

ATTR "source"
source

Source directory path

CHECK

See CHECK Command for information about this command.

CLEAR

Clear an action property string value. The cleared value only affects the commands that follow the CLEAR.

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.

DELETE

Remove a file from the connector

DELETE "source"
source

Source directory path

DIR

Get a directory listing of available files from the host

DIR "source"
source

Source directory path

GET

Receive one or more files from the host

GET [-DIR] [-DEL] [-UNI] "source" "destination"
-DIR
Get one or more files using a directory listing from the host.
Note: If -DIR is used, then there is no source parameter in the command.
-DEL
If GET is successful, delete remote file.
-UNI
Ensure local filename is unique.
source
Remote source path.
destination
Local destination path.
  • Path can be a filename or a directory.
  • If relative path, then uses the configured Inbox.
  • 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 -UNZ option.
-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 through Zip Comment and Zip Compression Level properties. See Setting advanced host properties.
  • The ZIP archive files created through the LCOPY command 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. The LCOPY command works only with ZIP-formatted files. In addition to the VersaLex 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, the VersaLex application 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 -REC option.
  • Use ZIP entry paths if Unzip Use Path is set. See Setting advanced host properties.
  • The ZIP archive files created through the LCOPY command 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. The LCOPY command 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, the VersaLex application 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 -REC and -ZIP options, and Zip Subdirectories Into Individual Zip Files is 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 -APE option, or when copying a file with the -APE option 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 to a filename or to a directory.
  • If you specify a relative path, the command uses the user's home directory.
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
  • 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 original input bytes.
  • Comma separated list of byte values (0-255).
  • If With parameter is omitted, then the input bytes are deleted from the file.

MKDIR

Make a directory on the connector

MKDIR "source"
source

Source directory path

PUT

Send one or more files to the host.

PUT [-DEL] [-UNI|-APE] "source" "destination"
-DEL
If PUT is successful, delete local file.
-UNI
Ensure remote filename unique
-APE
Append to existing destination file
source
Local source path
  • Path can be a filename or 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 the configured Outbox.
  • Use 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.

RENAME

Remove a directory from the connector

RENAME "source" "destination"
source

Source directory path.

destination

Destination path.

RMDIR

Remove a directory from the connector. This command recursively deletes the specified folder and all its subfolders and included file.

RMDIR "source"
source

Source directory path

SCRIPT

See SCRIPT Command for information about this command.

SET

Change an action property value. The new value only affects the commands that follow the SET.

Use the SET command to set both Advanced properties and Connector properties. To set a Connector property, the scheme name must be used as a prefix. For example, to set the EnableDebug property to true for an SMB connector: smb.EnableDebug=True.

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 the CLEAR command
Note:
You can use the SET command to override the values for setbox and receivedbox set on the Connector Host General tab using the general.Sentbox and general.Receivedbox properties. For example, to set the setbox to the sentbox2 folder, use this command: 
SET general.Sentbox=sentbox2
To disable setbox or receivedbox, use the %none% macro. For example, to turn off the receivedbox folder, use this command: 
SET general.Receivedbox=%none%

To set these properties back to their host-level settings, use the SET command without any values:

SET general.Sentbox= 
SET general.Receivedbox=

SYSTEM

Execute a local system command.

SYSTEM "path"
"path"
Local command path with arguments.

WAIT

Pause execution.

WAIT seconds
Seconds
Number of seconds to pause.

Related articles

Comments

0 comments

Please sign in to leave a comment.