Connect:Direct Server policy (CDServer)

Attach a Connect:Direct Server policy to one or more IBM® Sterling Connect:Direct® nodes in a message flow to control connection details at run time.

IBM Sterling Connect:Direct is a managed file transfer product that transfers files between, and within, enterprises. You can use a Connect:Direct Server policy to control, at run time, connection details and the location of staging directories for CDInput and CDOutput nodes.

To attach a Connect:Direct Service policy to an IBM Sterling Connect:Direct node, set the Policy property of the CDInput or CDOutput node to the name of the policy in the format {policyProjectName}:policyName. You must deploy this policy before the associated message flow is started.

If you redeploy a CDServer policy, all message flows that are using the policy will be stopped and restarted.

The properties of this policy are described in the following table.
Table 1. Properties of the Connect:Direct Server policy
Property Property name in .policyxml file Value
Host name hostname This property specifies the host name of the computer that is running the Connect:Direct server. This property has a default value of localhost.

Value type: String

Port number port This property specifies the API port on which the Connect:Direct server is listening. This property has a default value of 1363.

Value type: String

Security identity (DSN) securityIdentity This property specifies the security identity that is used to connect to the Connect:Direct server, in the format cd::name. This property has a default value of default, which means that the default security identity is used. You can specify any valid security identity that is defined on the integration server.

Value type: String

App Connect Enterprise path to staging directory brokerPathToStagingDir This property specifies the high-level path that is used by the CDOutput node when it stages files to transfer. The CDOutput node creates directories and files under this path.

The specified path is used by the integration node on the computer that is running IBM App Connect Enterprise. The Connect:Direct server must have access to these files; if the server is on a different computer, the directory must be mounted on the remote computer. If the remote path to the mounted directory is different on the IBM Sterling Connect:Direct computer, the Connect:Direct path to staging directory property must be set to the correct value.

If you do not specify a value for this property, the following default location is used: $MQSI_WORKPATH/common/CD/Tranfers. You can specify any path to which the integration node user has read and write access.

Value type: String

Connect:Direct path to staging directory cdPathToStagingDir This property specifies the high-level path that is used by the Connect:Direct server node to access files that are staged by the CDOutput node. The CDOutput node creates directories and files under this path, to which the Connect:Direct server must have access. The specified path is used by Connect:Direct on the computer that is running the Connect:Direct server.

If you do not specify a value for this property, the default location that is specified by the App Connect Enterprise path to staging directory property is used.

Value type: String

App Connect Enterprise path to input directory brokerPathToInputDir This property specifies the file path on the IBM App Connect Enterprise computer to files that were transferred by IBM App Connect Enterprise to the Connect:Direct path to input directory. If you do not specify a value for this property, the CDInput node uses the file path that is sent by the Connect:Direct server.

Value type: String

Connect:Direct path to input directory cdPathToInputDir This property specifies the directory (including all subdirectories) on the Connect:Direct server computer that contains the files that were transferred by Connect:Direct and that are applicable to this policy. Transfers to any other directory are ignored.

For IBM App Connect Enterprise to be able to process the files that were transferred to this directory, IBM App Connect Enterprise must be able to access this directory. If the directory is remote, it must be mounted to the computer where IBM App Connect Enterprise is running. If the mounted file system has a different path on the IBM App Connect Enterprise computer, this property must be set to the correct value.

If you do not specify a value for this property, the CDInput node uses the file path that is sent by the Connect:Direct server.

Value type: String

Connect:Direct protocol cdProtocol The Connect:Direct protocol configures the connection to the server. Use TCPIP for insecure connections, or TLS12 (for example) for secure connections. For more information, see https://www.ibm.com/support/pages/connectdirect-application-interface-java-protocol-and-cipher-suite-syntax
Queue prefix queuePrefix This property specifies the queue prefix to use when IBM App Connect Enterprise stores data on IBM MQ for this Connect:Direct server. The following two queues are used to store state:
  • SYSTEM.BROKER.CD.STATS
  • SYSTEM.BROKER.CD.TRANSFERS
If you specify a prefix, use the following queue name formats:
  • SYSTEM.BROKER.CD.queuePrefix.STATS
  • SYSTEM.BROKER.CD.queuePrefix.TRANSFERS
where queuePrefix must meet the following criteria:
  • The prefix must be a maximum length of 16 characters.
  • The prefix must be a valid value for a queue name.
  • The prefix must not begin or end with a period (.).

Value type: String