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.