File Connector

The File connector is used to communicate with a native file system not requiring authentication and allows a script to be run after a PUT. Folders and files accessed by this connector use the credentials of the user running the Cleo Harmony process.

If a Root Path is configured in the File properties tab, files and folders at or below this path are accessible while those above are not accessible. If a Root Path is not configured, the file being accessed must be described by an absolute path.

If accessing a UNC path through a URI using this connector and the Root Path is not configured, the short-form URI syntax must be used. For example:

LCOPY ..\outbox\test\test.edi myfiles://filsvr01/public/subdir01/subdir02/test1.edi

where there is a File connector whose System Scheme Name property is set to myfiles.

Post Processing Commands

The Post Processing Command property is a string that supports a replacement token syntax, which allows the name of the file that was just PUT to be placed in the command line arbitrarily. The replacement token mechanism also supports additional tokens and expressions to allow the command line to include formatted timestamps, source metadata, and JavaScript expressions.

Tokens and expressions are embedded in the command line using the ${expression} syntax, where the simplest expression is a direct token reference. The following tokens and expressions are supported:

The following describes the relationship between the various filename components for /path/to/file/basefilename.extension

The following expressions all evaluate to the same result:

• ${path}${base}${ext}
• ${noext}${ext}
• ${file}
• ${path+base+ext}

As a performance optimization, any JavaScript expression of the form ${token} for one of the tokens above is expanded without invoking the JavaScript engine. Also, the primitives ${date('string')} or ${date("string")} are similarly expanded without invoking JavaScript. This means that although the four examples above produce the same result, the first three execute much more quickly. But the JavaScript engine provides more capability for some use cases.

This (Linux) example renames the file by inserting the last portion of the DocDBTransferID (a GUID) before the extension:
/bin/mv ${file} ${noext}.${source.DocDBTransferID.replace(/.*-/,'')}${ext}

A word about source['metadata']

If a script connection is used directly through a URI reference as the inbox of another Harmony connection (or host or mailbox), additional protocol-specific metadata may be available in addition to the file content being stored. The metadata is represented as a JavaScript array (so use square brackets to access the values). For example, values available for AS2 include:

Some examples of source['metadata']:

To inspect the available metadata for a particular configuration, use a post-process command like the following.

• On Linux:
  /bin/sh -c 'echo ${JSON.stringify(source)}'
• On Windows:
  cmd.exe /c echo.exe ${JSON.stringify(source)}

Command Output Logging

The intent of the Post Processing command is to process the file and indicate success with a process return code of 0 or failure with any nonzero return code. To aid with troubleshooting, the script connector also captures any output, including "standard output" (stdout) and "error output" (stderr) and copies them as detail records to the log, one log message per line.

Standard output records are prefixed with [stdout] and are logged at log level LOW, while standard error records are prefixed with [stderr] and are logged at log level ESSENTIAL.

File Connector Properties

Each instance of the File Connector can be configured using the following settings: