Client Connection: IBM Sterling Connect:Direct

Fields with the asterisk * are mandatory.

PropertiesDescription
NAME *Name of the Connect:Direct connection you are creating. The maximum number of characters is 128. Blanks and these special characters: ' " | are not supported.
DESCRIPTIONDescription of the Connect:Direct connection you are creating. The maximum number of characters is 2048.
STATUSEnable or disable the client connection. Possible values:

  • Enabled (default value)
  • Disabled
  • NODE NAME *The Connect:Direct node name of the counterpart.
    USERNAMEInsert the credentials to access the counterpart Connect:Direct node.
    PASSWORDInsert the credentials to access the counterpart Connect:Direct node.
    DATA ONE C:D SERVER NAME *This fields must contain one of the "Connect:Direct" protocol type servers defined in Setup → STENG, Clusters and Servers → New Server.
    SCRIPT TO SEND FILESThe Connect:Direct CDP template to send a file to this counterpart.
    SCRIPT TO RECEIVE FILESThe Connect:Direct CDP template to send a file to this counterpart.
    CONFIGURATION TEST Use this section to test that the Cluster and the STENG are connected correctly. Select a Cluster and a STENG you want to test and click the TEST button. Data One automatically selects a Cluster and a STENG to test the connection. Note that a Cluster will be selected only if it is the only one available.
    A message with a green check will confirm a successful connection. A message with a red exclamation mark will warn about an unsuccessful connection. The message also details the reason why the connection fails.
    The connection might not be successful for different reasons, each of them depending on the transport type and the configuration.
    The first time you try to test the connection, if trusting certificates are missing, an error message detailing the unsuccessful connection will appear. In this case, go to Setup → Untrusted Cache → Certificates tab and trust the relevant certificates.
    Note that trusting certificates in the Untrusted Cache page may not be sufficient to establish a successful connection. Refer to the Untrusted Cache section of this guide for all the details.

    Buddie the Geek to ground control:

    "The receive and send file process template fields must contain the file name of CDP located in ${SPENG_HOME}/cfg/cdptemplates."

    Connect:Direct Configuration

    PRIMEUR Data One Steng Configuration

    When PRIMEUR Data One and the Connect:Direct Node reside on different machines, the first and most important step is to manage correctly shared folders between PRIMEUR Data One and ConnectDirect Node.

    Connect:Direct sends and receives files based on folder policies and the cdp script must contain direct reference to the filesystems.
    When Connect:Direct acts as a server, files are received on its filesystem in a folder specified by the sender. If Connect:Direct and PRIMEUR Data One do not reside on the same machine, they must share the folder, or files will not be received.

    To configure the Data One Steng for the Connect:Direct server, follow these steps:

    1. If the Connect:Direct server is remote, you must mount shared filesystems in order to exchange files between the PRIMEUR Data One server and the Connect:Direct server. See the “How to configure the remapping of the shared folders” section here below.
    2. If the ConnectDirect server is remote, go to /ghibli-home/wlp/usr/servers/steng/cfg to configure the speng.cd.pathremap.table file according to the shared folder defined at the previous step.
    3. Copy the ConnectDirect API library (CDJAI.jar) in this folder:
      /ghibli-home/wlp/usr/servers/steng/lib/cd.

    Important Note: Once the installation and the configuration are completed, restart the STENG before starting the server!

    How to configure the remapping of the shared folders

    Once the two filesystems are shared, you must configure the remapping of the shared folders. To do this, edit the path remap configuration speng.cd.pathremap.table file in the directory /ghibli-home/wlp/usr/servers/steng/cfg.

    Mainly this configuration file consists of several pairs of folder paths, to remap incoming and outgoing files. Here below, you can find some examples.
    Note: Paths may slightly change due to differences between Windows and Unix.

    #########
    ## SpEng Path <----> Local CD Path
    ## ex:
    ## C:\share\cd=/home/connect/share/cd
    ##
    ## SpEng Path <----> Remote CD Path
    ## ex:
    ## /winCdrive/Out/=C:\Out\
    #########
    
    # First (incoming files)
    C:\CDReceive=Z:\CDReceive
    
    # Second (push files)
    Z:\CDShared=C:\CDShared
    
    # Third (pull files)
    /winCdrive/Test/Out/=C:\Test\Out\
    /masterInDirCd=C:\CDShared
    C:/CDShared=Z:\CDShared
    

    The first example applies to incoming files:

    • "Z:\CDReceive" is the shared partition defined on the local machine (DataOne)
    • "C:/CDReceive" is the shared partition on the remote Connect:Direct server

    The File received by the Connect:Direct server will be placed in the "C:/CDReceive" folder.
    The DataOne\CD connector will be prompted that a new file has arrived.
    In the DataOne machine, the file is stored in the "Z:\CDReceive" folder, where it is taken and moved in the DataOne filesystem.

    The second example applies to push operations.
    Outgoing files are copied from the DataOne filesystem to the shared folder "Z:\CDShared". When the DataOne\CD connector submits the “cdp” script to the remote Connect:Direct server, the correct remapped folder "C:\CDShared" will be specified in the Connect:Direct server.

    The third example applies to pull operations.
    For Windows convention, we will use "/winCdrive" to indicate the "C:" drive path.
    The first step is to define a valid path for the Connect:Direct machine, for example: "/winCdrive/Test/Out/SourceFile.txt"
    and a virtual destination path, for example:
    "/masterInDirCd/DestFile.txt".
    Here below, you can find the remapping operations that are executed:

    • From /winCdrive/Test/Out/ to C:\Test\Out\ (remapped path to fetch the source file on the C:D remote node)
    • From /masterInDirCd to C:\CDShared (remapped path where the file is received on the C:D server)
    • From C:/CDShared to Z:\CDShared (remapped path when the file is received, see first example)

    Server configuration

    To create a new server configuration of "C:D" type, follow these steps:

    1. Go to Setup → STENG, Clusters & Servers.
    2. Select the cluster (if more than one is present) and click the New Server button.
    3. In Third Party Connectors, click the CD button to select the CD protocol type.
    4. Click the CONTINUE button to confirm. A new window will appear listing the parameters already entered.
    5. Move to the Actor section of PRIMEUR Data One and click the NEW button.
    6. Create the Actor that will be associated with the Connect:Direct Server.
    7. In the USERS tab, click the New User button and create the User that will access the Connect:Direct server.
    8. In the VFS tab, click the NEW button and create a new Virtual File System for the Actor.
    9. In the CONNECTION CONTRACTS tab, click the New Contract Clause button and create a new contract: after assigning Name and Description, click Save and Continue.
    10. In the CONNECTION dialog window, click the Select Server button and select the CDServer previously created – in our example, the CDServerWin server.
    11. Click the CONFIRM button to add your server.
    12. Click the ADD USER OR GROUP button and in the Add user/group and vfs window add the User and the VFS you created in steps 7 and 8.
    13. Click the CONFIRM button and check that the information entered is correct. Then, click SAVE.
    14. In the Actor main window, click the SAVE button at the top-right corner of the screen.

    You have successfully created the new server configuration!

    Client Connection Configuration

    PRIMEUR Data One CD connector uses Connect:Direct cdp scripts to perform push and pull file operations.
    These scripts contain the information to instruct the Connect:Direct server performing the required file transfer.
    Standard cdp templates are stored in <STENG_HOME>/cfg/cdptemplates and may also be implemented with Connect:Direct supported user-specific commands.
    Standard cdp templates are used to generate scripts that can be interpreted by Connect:Direct, after a macro-replacement process.
    Follow these steps to configure a Client connection:

    1. Go to the Actor section and edit the ConnectDirect Actor.
    2. Click the CLIENT CONNECTIONS tab and the NEW CLIENT CONNECTION button.
    3. In Third Party Connectors, select the IBM Sterling Connect:Direct protocol.
    4. In the New connection window fill in the required fields – see details above.
    5. Now click the CONFIRM button.



    If you need to use several ConnectDirect scripts (CDP) for a connection with the same Actor, you must define one or more REMOTE CONNECTION configurations, each one with the relevant RECEIVE FILE PROCESS TEMPLATE and SEND FILE PROCESS TEMPLATE.