Topic list |
Glossary |
Print this page |
Bookmark |
Using Connect:Direct Services in a Business Process
The Connect:Direct Server adapter and the Connect:Direct Requester adapter provide a suite of B2B services to establish communication between Gentran Integration Suite and Connect:Direct.
Using these services, you can create automated business processes to perform the same tasks performed with Connect:Direct Processes and with Connect:Direct commands.
The Connect:Direct Server services correspond to the Connect:Direct Process Language. These services work with the Connect:Direct Server adapter. These services are used when the Server adapter is the PNODE.
The Connect:Direct Requester services correspond to the Connect:Direct Requester API and work with the Connect:Direct Requester adapter.
The services created specifically for use with Connect:Direct are described in the following sections, along with a scenario of how each service is used within a business process.
Server Adapter Services
The Connect:Direct Server adapter provides the following services:
Connect:Direct Server Begin Session Service
The Begin Session service begins a session with a remote Connect:Direct Node.The service then uses the Connect:Direct Server adapter as the communications mechanism for outbound requests to the remote node.
For example, a Gentran Integration Suite business process includes a file as primary document to copy to a remote Connect:Direct node. Before the copy operation can begin, a session must be established with the remote Connect:Direct node using the Server Begin Session service.
This service must be configured with the Connect:Direct node name that exists in the netmap of a Connect:Direct Server adapter. You must obtain a valid user ID and password from the remote Connect:Direct node that you want to connect with. You must then specify this user ID and password during configuration of the Begin Session service.
The remote Connect:Direct node may provide you with a Connect:Direct proxy. The proxy enables you to have a special user ID that maps to a stored user ID and password. If you receive a proxy, use the proxy name in place of the RemoteUserId.
Connect:Direct Server BP Response Service
The BP Response service is used as the last operation in a business process started from a Connect:Direct Server adapter in response to a request from a remote Connect:Direct Server to copy (a file) from a business process. The service performs a callback on the Connect Direct Server adapter that started the business process to convey the primary document used as the response to send to the remote Connect:Direct Server. (This is similar to the HTTP Respond service, which performs a callback on the HTTP Server adapter). This service uses session information placed in the process data by the Connect:Direct Server adapter that started the business process. Therefore the service can only be used in business processes started by a Connect:Direct Server adapter.
A remote Connect:Direct Server initiates a session with a Connect:Direct Server adapter in Gentran Integration Suite and requests to copy (retrieve) the final primary document resulting from a business process started by the Connect:Direct Server adapter. The name of the business process is provided in the request from the remote Connect:Direct node. The last operation in the business process must be the BP Response service, so the service can call back the adapter to respond to the request from the remote Connect:Direct node.
Connect:Direct Server CopyFrom Service
The CopyFrom service copies a file from a remote Connect:Direct node.
To ensure the checkpointed copy performed by this service is restarted if interrupted by a failure of the Gentran Integration Suite server, the business process must have the recovery level set to Auto Resume. If so marked, the business process and the copy resumes automatically when Gentran Integration Suite restarts, if the remote Connect:Direct node is still active. When resumed, the copy restarts from the checkpoint. The checkpoint interval must be a value greater than zero. At least three checkpoint intervals must have been passed before the failure or the data transfer restarts at the beginning.
If the CopyFrom service is interrupted by a failure of the remote Connect:Direct node the business process enters a waiting state. When the remote Connect:Direct node is available, run the Schedule_BPExpirator business process in Gentran Integration Suite to resume the copy. At least three checkpoint intervals must have been passed before the failure or the data transfer restarts at the beginning.
Note: The BPExpirator business process runs automatically every 15 minutes (default). To resume the copy in a shorter time frame, run the Schedule_BPExpirator business process manually.Connect:Direct Server CopyTo Service
The CopyTo service copies a file to a remote Connect:Direct node. For example, a trading partner copies a business document to a remote Connect:Direct outside the organization.
To ensure the checkpointed copy performed by the CopyTo service is restarted if interrupted by a failure of the Gentran Integration Suite server, the business process must have the Recovery Level set to Auto Resume. If so marked, the business process and copy resumes automatically when Gentran Integration Suite restarts, if the remote Connect:Direct node is still active.
When resumed, the copy restarts as follows, depending upon the configuration of the Connect:Direct Server adapter:
Note: Gentran Integration Suite stores checkpoint information for 30 days, after which it is automatically purged. If your database is corrupted, you must purge this checkpoint information by performing a cold start. See Troubleshooting Connect:Direct Interoperability for the procedure.If the CopyTo service is interrupted by a failure of the remote Connect:Direct node the business process enters a waiting state. When the remote Connect:Direct node is available, run Schedule_BPExpirator in Gentran Integration Suite to resume the copy. At least three checkpoint intervals must have been passed before the failure or the data transfer restarts at the beginning.
Note: The BPExpirator business process runs automatically every 15 minutes (default). To resume the copy in a shorter time frame, run the Schedule_BPExpirator business process manually.Connect:Direct Server End Session Service
The End Session service ends a session established between two Connect:Direct nodes.Whenever Begin Session service is used in a business process, End Session service must also be used.The service uses the Server adapter as the communication mechanism for the outbound request to end the session.
For example, a Gentran Integration Suite business process has initiated a session with a remote Connect:Direct node using the Begin Session service. During the course of the session, some business activity occurs, for example a file is copied from the remote Connect:Direct node. After the operation is complete, the business process uses the End Session service to terminate the session.
Connect:Direct Server Run Job Service
The Run Job service submits work to the remote Connect:Direct node that executes asynchronously (relative to the remaining steps in the business process). Do not use the Run Job service to submit to a Connect:Direct Server adapter in Gentran Integration Suite.
For example, write a business process that uses the Run Job service to execute a script on a remote Connect:Direct node. You can use this service to execute a script that compresses and archives log files asynchronously on a remote Connect:Direct node.
Connect:Direct Server Run Task Service
The Run Task service submits work to the remote Connect:Direct node that executes synchronously relative to the remaining steps in the business process. Do not use the Run Task service to submit to a Connect:Direct Server adapter in Gentran Integration Suite.
For example, write a business process that uses the Run Task service to execute a script on a remote Connect:Direct node. You can use this service to execute a script that compresses and archives log files synchronously on a remote Connect:Direct node.
Connect:Direct Server Submit Service
The Submit service submits a Connect:Direct Process to another Connect:Direct node. The Process submitted must be saved in a file on the Connect:Direct node where the Submit Process statement executes.
Note: Connect:Direct Server adapter supports the Submit Process statement. It does not support the Submit Process command in Connect:Direct.Use this service to initiate work on a remote Connect:Direct node. During execution of a Connect:Direct Process, the submit statement causes a different Connect:Direct Process to be submitted to either the PNODE or the SNODE. The sysopts parameters specified in the Submit Process statement are passed to the business process. Any values specified through the Submit service override values in the process file.
Submit Process Name can also be formatted for submitting to a Gentran Integration Suite Connect:Direct Server adapter. Use a process name such as the following:
/businessprocess/serverbpname/somedocname
For example, a file on a remote Connect:Direct node is needed on another node. Create a business process to submit a Connect:Direct Process to the remote Connect:Direct node to transfer the file.
Requester Adapter Services
The Requester adapter provides the following services:
Connect:Direct Requester Select Process Service
The Select Process service retrieves information about a Process that is in progress on a remote Connect:Direct Server. Information can be retrieved based on query criteria such as Process name and number, SNODE, queue, status, or submitter node and user ID.
Use Select Process to get status information about a Process submitted to a remote Connect:Direct node. This service uses the Requester adapter as the communication mechanism for the request. For example, a business process submits a Connect:Direct Process to a remote Connect:Direct node, then uses the Select Process service to check the status of the Process.
Connect:Direct Requester Select Statistics Service
The Select Statistics service retrieves statistics from a remote Connect:Direct node based on various criteria, such as Process name, start and stop date, start and stop time, and so on. This service examines records in the Statistics Log for a remote Connect:Direct node.
Use Select Statistics to get status information about a Process submitted to a remote Connect:Direct node. This service uses the Requester adapter as the communication mechanism for the request. For example, a business process submits a Connect:Direct Process to a remote Connect:Direct node, then uses the Select Statistics service to check the completion status of the Process.
Connect:Direct Requester Submit Service
The Submit service submits a Connect:Direct Process to a remote Connect:Direct node.
Use the Submit service to initiate work on a remote Connect:Direct node. The service uses the Requester adapter as the communication mechanism for the request.
For example, a file on a remote Connect:Direct node is needed on another node. Create a business process to submit a Connect:Direct Process to the remote Connect:Direct Server to transfer the file from one node to the other.