Shared archive processing

The Gateway Server can be configured to receive and send files that reference a shared image archive. Files for a Viewpointe shared archive might include cross-reference results (XOUT) files (for more information, refer to the Viewpointe implementation guides), electronic check presentment files for forward presentment (ECPI/ECPF/ECP/ECPX files), and electronic check presentment files for returns (ECPR) files.

The Gateway Server uses Sterling Commerce® Connect:Direct® to receive files from and send files to a service delivery center. When a file is ready, the Gateway Server retrieves the file from the pickup zone of the service delivery center. When the Gateway Server sends a file, it sends it to both the primary landing zone and the disaster recovery landing zone of the service delivery center.

The transmittal message is used for notification purposes and can be sent or received through IBM® MQ. When the file is ready to pick up, the service delivery center sends a notification message in the receiving subtask queue. When Gateway Server tries to send a file to the service delivery center, it sends notify messages to both the sending task queue and the sending subtask queue.

The Gateway Server can support single-tier and two-tier Connect:Direct.

Figure 1. Single tier Connect:Direct diagram
gpy_izxd_g1_tier.jpg
The Connect:Direct remote node parameters are shown in the following lists. Parameters that are optional are surrounded by opening and closing brackets ([ and ]).
  • For sending to a primary landing zone:
    • saPriCDRemoteNode
    • [saPriCDRemoteUserID]
    • [saPriCDRemotePassword]
    • saPriCDLandDir
  • For sending to a disaster recovery landing zone:
    • [sa2ndCDRemoteNode]
    • [sa2ndCDRemoteUserID]
    • [sa2ndCDRemotePassword]
    • [sa2ndCDLandDir]
  • For receiving from a pickup zone:
    • saPickCDRemoteNode
    • [saPickCDRemoteUserID]
    • [saPickCDRemotePassword]
    • saPickCDPickDir
The Connect:Direct local node parameters are shown in the following list. Parameters that are optional are surrounded by opening and closing brackets ([ and ]).
  • For sending and receiving:
    • [saLocalCDNode]
    • [saLocalCDUserID]
    • [saLocalCDPassword]
    • [saLocalCDOutDir]
    • [saLocalCDReceiveDir]
The Gateway Server Connect:Direct related parameters are shown in the following list. Parameters that are optional are surrounded by opening and closing brackets ([ and ]).
  • Connect:Direct related directories:
    • outProcessingPath
    • cdLocalReceiveDir
The sending and retrieving process names are shown in the following list. The saProcessPrefix parameter is set to PDGW.
  • PDGWsndP: Local node -> Primary Land Zone node
  • PDGWsndD: Local node -> Disaster Recover Zone node
  • PDGWrcvP: Local node <- Pickup Zone node
Figure 2. Two-tier Connect:Direct diagram
gpy_izxd_g2_tier.jpg
The Connect:Direct remote node parameters are shown in the following lists. Parameters that are optional are surrounded by opening and closing brackets ([ and ]).
  • For sending to a primary landing zone:
    • saPriCDRemoteNode
    • [saPriCDRemoteUserID]
    • [saPriCDRemotePassword]
    • saPriCDLandDir
  • For sending to a disaster recovery landing zone:
    • [sa2ndCDRemoteNode]
    • [sa2ndCDRemoteUserID]
    • [sa2ndCDRemotePassword]
    • [sa2ndCDLandDir]
  • For receiving from a pickup zone:
    • saPickCDRemoteNode
    • [saPickCDRemoteUserID]
    • [saPickCDRemotePassword]
    • saPickCDPickDir
The Connect:Direct intermediate node parameters are shown in the following list. Parameters that are optional are surrounded by opening and closing brackets ([ and ]).
  • For sending and receiving:
    • saIntermediateCDDir
    • saIntermediateCDConfigFile
The Connect:Direct local node parameters are shown in the following list. Parameters that are optional are surrounded by opening and closing brackets ([ and ]).
  • For sending and receiving:
    • [saLocalCDNode]
    • [saLocalCDUserID]
    • [saLocalCDPassword]
    • [saLocalCDOutDir]
    • [saLocalCDReceiveDir]
The Gateway Server Connect:Direct related parameters are shown in the following list. Parameters that are optional are surrounded by opening and closing brackets ([ and ]).
  • Connect:Direct related directories:
    • outProcessingPath
    • cdLocalReceiveDir
The sending and retrieving process names are shown in the following list. The saProcessPrefix parameter is set to PDGW.
  • PDGWsndI: Local node -> Intermediate node
  • PDGWsndP: Intermediate node -> Primary Land Zone node
  • PDGWsndD: Intermediate node -> Disaster Recover Zone node
  • PDGWrcvP: Intermediate node <- Pickup Zone node
  • PDGWrcvI: Local node <- Intermediate node

The following table describes the configuration options that control how shared archive files are sent to and received from the service delivery center.

Table 1. Shared file configuration options
Keyword Values or examples Description
saEnable true or false Controls whether shared archive processing is enabled or not.
saMQUserId ${QMGR_USER} The user ID that is used to access the IBM MQ queue manager and queue. This user ID is needed only if the definition of the IBM MQ queue requires a user ID and password to access it. To configure this user ID, use the QMGR_USER key in the ftm-application-secret.
saMQPassword ${QMGR_PASSWORD} The password for the user ID that is used to access the IBM MQ queue manager and queue. This password is needed only if it is defined in the queue. To configure this password, use the QMGR_PASSWORD key in the ftm-application-secret.
saMQQmgrName ${QMGR_NAME} The name of the IBM MQ queue manager. The queue manager name is configured in the custom resource for your FTM offering.
saMQSendTaskQueue BANK_TO_TASK The name of the IBM MQ sending task queue.
saMQSendSubtaskQueue BANK_TO_SUBTASK The name of the IBM MQ sending subtask queue.
saMQRecvSubtaskQueue SUBTASK_TO_BANK The name of the IBM MQ receiving subtask queue.
saPriCDLocalConfigFile /opt/ibm/ftm/runtime-processing/connect-direct/PRICDDEF.BIN The fully qualified path and file name of the Connect:Direct node definition file. It defines the local node in its entirety so that the password does not have to be stored unencrypted in this file. This file is created by using the Connect:Direct Java node definition utility. The syntax of the command is: java -classpath CDJAI.jar com.sterlingcommerce.cd.sdk.JCU.

Store this file on the persistent volume at the following location: <ftm-instance>-gateway/connect-direct/. Create the folder if it does not exist.
saPriCDRemoteNode Remote name The name of the remote Connect:Direct node where the shared archive is.
saPriCDRemoteUserID ${SA_PRI_CD_REMOTE_USER} The user ID that is used to access the shared archive primary landing zone Connect:Direct node. To configure this user ID, use the SA_PRI_CD_REMOTE_USER key in the ftm-application-secret.
saPriCDRemotePassword ${SA_PRI_CD_REMOTE_PASSWORD} The password for the user ID that is used to access the shared archive primary landing zone Connect:Direct node. To configure this password, use the SA_PRI_CD_REMOTE_PASSWORD key in the ftm-application-secret.
saPriCDLandDir /opt/ibm/ftm/runtime-processing/connect-direct/saPriCDLandDir The absolute path of the primary landing zone Connect:Direct node. Create the primary Connect:Direct remote folder <ftm-instance>-gateway/connect-direct/saPriCDLandDir on the persistent volume if it doesn’t exist.
sa2ndCDLocalConfigFile /opt/ibm/ftm/runtime-processing/connect-direct/SNDCDDEF.BIN The fully qualified path and file name of the Connect:Direct node definition file. It defines the local node in its entirety so that the password does not have to be stored unencrypted in this file. This keyword is optional if the file is same as the saPriCDLocalConfigFile.

Store this file on the persistent volume at the following location: <ftm-instance>-gateway/connect-direct/.
sa2ndCDRemoteNode 2ndNode The name of the service delivery center disaster recovery landing zone Connect:Direct node.
sa2ndCDRemoteUserID ${SA_SEC_CD_REMOTE_USER} The user ID that is used to access the shared archive disaster recovery landing zone Connect:Direct node. To configure this user ID, use the SA_SEC_CD_REMOTE_USER key in the ftm-application-secret.
sa2ndCDRemotePassword ${SA_SEC_CD_REMOTE_PASSWORD} The password for the user ID that is used to access the shared archive disaster recovery landing zone Connect:Direct node. To configure this password, use the SA_SEC_CD_REMOTE_PASSWORD key in the ftm-application-secret.
sa2ndCDLandDir /opt/ibm/ftm/runtime-processing/connect-direct/sa2ndCDLandDir The absolute path of the disaster recovery landing zone Connect:Direct node. Create the <ftm-instance>-gateway/connect-direct/sa2ndCDLandDir folder on the persistent volume if it doesn’t exist.
saPickCDLocalConfigFile /opt/ibm/ftm/runtime-processing/connect-direct/PICKCDDEF.BIN The fully qualified path and file name of the Connect:Direct node definition file. It defines the local node in its entirety so that the password does not have to be stored unencrypted in this file. This keyword is optional if the file is same as the file that was specified in the saPriCDLocalConfigFile keyword.

Store this file on the persistent volume at the following location: <ftm-instance>-gateway/connect-direct/.
saPickCDRemoteNode pickNode The name of the service delivery center pickup zone Connect:Direct node.
saPickCDRemoteUserID ${SA_PICK_CD_REMOTE_USER} The user ID that is used to access the shared archive pickup zone Connect:Direct node. To configure this user ID, use the SA_PICK_CD_REMOTE_USER key in the ftm-application-secret.
saPickCDRemotePassword ${SA_PICK_CD_REMOTE_PASSWORD} The password for the user ID that is used to access the shared archive pickup zone Connect:Direct node. To configure this password, use the SA_PICK_CD_REMOTE_PASSWORD key in the ftm-application-secret.
saPickCDPickDir /opt/ibm/ftm/runtime-processing/connect-direct/saPickCDPickDir The absolute path of the service delivery center pickup zone Connect:Direct node. Create the <ftm-instance>-gateway/connect-direct/saPickCDPickDir folder on the persistent volume if it doesn’t exist.
saIntermediateCDDir /opt/ibm/ftm/runtime-processing/connect-direct/saIntermediateCDDir The absolute path of the intermediate Connect:Direct node. Gateway uses this directory to determine the Connect:Direct mode. If this option is set, it is two-tier Connect:Direct. Otherwise, it is single tier Connect:Direct.

Create the <ftm-instance>-gateway/connect-direct/saIntermediateCDDir folder on the persistent volume if it doesn’t exist.
saIntermediateCDConfigFile /opt/ibm/ftm/runtime-processing/connect-direct/LOCALCDDEF.BIN The fully qualified path and file name of the Connect:Direct intermediate node definition file. It defines the local node in its entirety so that the password does not have to be stored unencrypted in this file.

Store this file on the persistent volume at the following location: <ftm-instance>-gateway/connect-direct/.
saLocalCDNode local name The name of the local Connect:Direct node.
saLocalCDUserID ${SA_LOCAL_CD_REMOTE_USER} The user ID that is used to access the local Connect:Direct node. To configure this user ID, use the SA_LOCAL_CD_REMOTE_USER key in the ftm-application-secret.
saLocalCDPassword ${SA_LOCAL_CD_REMOTE_PASSWORD} The password for the user ID that is used to access the local Connect:Direct node. To configure this password, use the SA_LOCAL_CD_REMOTE_PASSWORD key in the ftm-application-secret.
saLocalCDOutDir /opt/ibm/ftm/runtime-processing/outbound/processing The absolute path to keep the output of Connect:Direct. The default value is outProcessingPath. This directory must point to the same directory as outProcessingPath Gateway Server property. Create the <ftm-instance>-gateway/outbound/processing folder on the persistent volume if it doesn’t exist.
saLocalCDReceiveDir /opt/ibm/ftm/runtime-processing/connect-direct/localCDReceiveDir The absolute path of the local Connect:Direct node. This directory must point to the same directory as cdLocalReceiveDir.

Create the <ftm-instance>-gateway/connect-direct/localCDReceiveDir folder on the persistent volume if it doesn’t exist.
saProcessPrefix PDGW The prefix of the Connect:Direct process name. The length of the process prefix is no more than four characters, otherwise it is truncated.
saBankID IBM The unique identifier for the bank within the service delivery center.
saSite IBM88 The site code for the location from which the file transmission originates.
saSDC c01 The unique identifier for the service delivery center that is assigned to the organization.
saXoutThreads 1 The number of threads that are used to process the XOUT files that are received from the service delivery center.
saResultErrorPercent 100 The maximum percentage of error items to allow before the entire file is rejected.
saMsgDir /opt/ibm/ftm/runtime-processing/transmittals/saMsgDir This keyword is the directory where the received and sent messages are stored. Create the <ftm-instance>-gateway/transmittals/saMsgDir folder on the persistent volume if it doesn’t exist.
vlfKeyWord SUBDOC The group field name of a substitute document in the IND file (within VLF file). An item has a substitute document if the group field value is not equal to null.
saSendThreads 0 - 10 The number of threads that are to be used to send shared archive work.
saReceiveThreads 0 - 10 The number of threads that are to be used to receive shared archive work.