Sterling Connect:Direct Server Submit Service

This table provides an overview of the Sterling Connect:Direct Server Submit Service:

System Name Sterling Connect:Direct® Server Submit Service
Graphical Process Modeler (GPM) categories All Services, Applications > IBM > IBM® Sterling Connect:Direct
Description Submits a Sterling Connect:Direct process to another Sterling Connect:Direct node. The submitted process must be in a file on the destination Sterling Connect:Direct node.
Business usage A business user uses this service to initiate work on a remote Sterling Connect:Direct node. This service performs the equivalent of a Submit statement in a Sterling Connect:Direct process. During execution of a Sterling Connect:Direct process, the Submit statement causes another Sterling Connect:Direct process to be submitted to either the Pnode, which is the node with process control, or the Snode, which is the remote node that participates in the process. Any parameter values that are specified in the Submit statement override the parameter values contained in a process statement that is named by the file parameter.
Usage example A business user has a file that exists on a remote node where Sterling Connect:Direct is running. This file is needed on another node. The user creates a business process that submits a Sterling Connect:Direct process to a remote Sterling Connect:Direct server to transfer the file from one node to the other.
Preconfigured? A Sterling Connect:Direct Server adapter must be configured before using this service.
Requires third party files? No
Platform availability All supported IBM Sterling Control Center platforms
Related services Connect:Direct Server adapter
Application requirements

For more information, search for Requirements.

Initiates business processes? No
Invocation The business process running this service must be started by a user with permission to issue the Submit statement on the target Sterling Connect:Direct server.
Business process context considerations None
Returned status values
  • Invalid Business Process Error – User submitted invalid business process in IBM Sterling Control Center.
  • User Permission Error – User does not have permission to submit the business process in IBM Sterling Control Center.
  • Sterling Connect:Direct Server Error – A generic error associated with the Sterling Connect:Direct Server has occurred.
  • Sterling Connect:Direct Error – A generic error associated with Sterling Connect:Direct has occurred.
  • Sterling Connect:Direct Service Error – A generic error associated with the Sterling Connect:Direct service has occurred.
Restrictions If the Submit Process request is issued to a remote Sterling Connect:Direct for z/OS® node, the request fails.

Sterling Connect:Direct for i5/OS does not support Submit Process.

Persistence level None
Testing considerations Debug information for this service is found in the Sterling Connect:Direct Interop log files.

Implementing the Sterling Connect:Direct Server Submit Service

To implement the Sterling Connect:Direct Server Submit service:

  1. Configure the Sterling Connect:Direct Server adapter to use with this service.
  2. Create a Sterling Connect:Direct Server Submit service configuration.
  3. Configure the Sterling Connect:Direct Server Submit.
  4. Use the service in a business process.

Sterling Connect:Direct Server Submit Service Settings

To configure the Sterling Connect:Direct Server Submit service, define the fields in IBM Sterling Control Center and the GPM. This table lists and describes the available fields:
Field Description
Config Name of the service configuration. Required.
RemoteProcessFile Process file on the remote Sterling Connect:Direct server that is submitted. Required.
RemoteProcessParms

A set of one or more parameters or arguments specified in the platform-specific syntax of the remote Sterling Connect:Direct server.

The parameters or arguments are submitted with the process specified by the RemoteProcessFile parameter on the remote Sterling Connect:Direct server. Optional.

Note: You must consult platform-specific Sterling Connect:Direct documentation for a list of parameters and syntax concerning process creation and submission.
Examples of parameters supported by Sterling Connect:Direct for Z/OS include:

PROC= member or DSN= dsn | dsn(member)
CASE= Yes | No
CLASS= n
DEBUG= trace settings for this Process
HOLD= Yes | No | Call
MAXDELAY= [unlimited | queued|0|hh:mm:ss]
NEWNAME= newname
NOTIFY= %USER | user
PACCT= 'pnode accounting data'
PLEXCLASS= (pnode class, snode class)
PNODE= primary node name
PNODEID= (ID, pswd, newpswd)
PRTY= n
REQUEUE= Yes | No
RETAIN= Yes | No | Initial
SACCT= 'snode accounting data'
SNODE= secondary node name | TCPNAME=tcpvalue;port
SNODEID= (ID, pswd, newpswd)
Examples of parameters supported by Sterling Connect:Direct for Windows include:

class = 1 | session number
execprty = nn
hold = yes | no | call
pacct = "pnode accounting data"
pnodeid = (id, pswd)
maxdelay = unlimited | hh:mm:ss | 0
newname = new process name
notify = userid
sacct = "snode accounting data"
retain = yes | no | initial
snode = nodename
snodeid = (id, [,pswd [,newpswd]])
prty = nn
startt = ([date | day][,time])
secure = ([protocol [,cipher | (list)]][,encrypt.data = yes | no])
SubmitUserId User ID for remote system other than the remoteUserId specified in the Connect:Direct Server Begin Session service. Optional. Valid value is any character string with a maximum of 30 characters. By default, the remote Sterling Connect:Direct server uses the user ID authenticated at the beginning of the current session (remoteUserId in the Begin Session service).
SubmitPasswd Password for remote system for user ID specified in SubmitUserId. Required when SubmitUserId is specified. Valid value is any character string with a maximum of 30 characters. By default, the remote Sterling Connect:Direct server uses password associated with the user ID authenticated at the beginning of the current session (remoteUserId in the Begin Session service)
SessionToken Identifies an established session between two Sterling Connect:Direct nodes. Required. Session integrity cannot be guaranteed if the session token is omitted.

Parameters Passed from a Business Process to the Sterling Connect:Direct Server Submit Service

This table lists and describes the parameters passed from a business process to the Sterling Connect:Direct Server Submit service:

Parameter Description
RemoteProcessFile Process file on the remote Sterling Connect:Direct server that is submitted. Required.
RemoteProcessParms

A set of one or more parameters or arguments specified in the platform-specific syntax of the remote Sterling Connect:Direct server.

The parameters or arguments are submitted with the process specified by the RemoteProcessFile parameter on the remote Sterling Connect:Direct server. Optional.

Note: You must consult platform-specific Sterling Connect:Direct documentation for a list of parameters and syntax concerning process creation and submission.
Examples of parameters supported by Sterling Connect:Direct for Z/OS include:

PROC= member or DSN= dsn | dsn(member)
CASE= Yes | No
CLASS= n
DEBUG= trace settings for this Process
HOLD= Yes | No | Call
MAXDELAY= [unlimited | queued|0|hh:mm:ss]
NEWNAME= newname
NOTIFY= %USER | user
PACCT= 'pnode accounting data'
PLEXCLASS= (pnode class, snode class)
PNODE= primary node name
PNODEID= (ID, pswd, newpswd)
PRTY= n
REQUEUE= Yes | No
RETAIN= Yes | No | Initial
SACCT= 'snode accounting data'
SNODE= secondary node name | TCPNAME=tcpvalue;port
SNODEID= (ID, pswd, newpswd)
Examples of parameters supported by Sterling Connect:Direct for Windows include:

class = 1 | session number
execprty = nn
hold = yes | no | call
pacct = "pnode accounting data"
pnodeid = (id, pswd)
maxdelay = unlimited | hh:mm:ss | 0
newname = new process name
notify = userid
sacct = "snode accounting data"
retain = yes | no | initial
snode = nodename
snodeid = (id, [,pswd [,newpswd]])
prty = nn
startt = ([date | day][,time])
secure = ([protocol [,cipher | (list)]][,encrypt.data = yes | no])
SubmitUserId User ID for remote system other than the remoteUserId specified in the Connect:Direct Server Begin Session service. Optional. Valid value is any character string with a maximum of 30 characters. By default, the remote Sterling Connect:Direct server uses the user ID authenticated at the beginning of the current session (remoteUserId in the Begin Session service).
SubmitPasswd Password for remote system for user ID specified in SubmitUserId. Required when SubmitUserId is specified. Valid value is any character string with a maximum of 30 characters. By default, the remote Sterling Connect:Direct server uses password associated with the user ID authenticated at the beginning of the current session (remoteUserId in the Begin Session service)
SessionToken Identifies an established session between two Sterling Connect:Direct nodes. Required. Valid value is an XML structure that includes the following elements:
  • SessionId
  • ProcessNumber
  • ProcessName
  • SubmitDateTime
  • RemoteCDNodeName
  • RemoteUserId
  • RemotePasswd
  • PlexClass
  • MaxRestartRetries
  • RestartRetryInterval
  • ShortTermMaxRetries
  • ShortTermRetryInterval

Parameters Passed From the Sterling Connect:Direct Server Submit Service to a Business Process

This table lists and describes the parameters passed from the Sterling Connect:Direct Server Submit service to the business process:

Parameter Description
LocalCDNodeName Specifies the local Sterling Connect:Direct node which submitted the process. Required.
RemoteCDNodeName Remote Sterling Connect:Direct node on which the process was submitted. Required.
Status Specifies the status of the submit statement execution. Required. Valid values are SUCCESS and ERROR.
SubmittedProcessNum Specifies the process number assigned to the process. Optionally returned (if > –1).
SubmittedProcessDateTime Specifies the date and time when the submit statement is executed. Required.

Business Process Example Using a Sterling Connect:Direct Submit Service

This example show how to use the Sterling Connect:Direct Server Submit service in a business process:

<process name=" SubmitStatementExample">
  <sequence name="CDServerSubmit">
    <!-- Begin Server Session -->
        <operation name="Sterling Connect:Direct Server Begin Session Service">
          <participant name="CDServerBeginSession"/>
          <output message="BeginSession">
            <assign to="." from="*"></assign>
            <assign to="LocalCDNodeName">TEST1_CDSERVER</assign>
            <assign to="RemoteCDNodeName">NMAYAKUNTLAVM2K</assign>
            <assign to="RemoteUserId">joeuser</assign>
            <assign to="RemotePasswd">joe123</assign>
          </output>
          <input message="inmsg">
            <assign to="BeginSessionResults" from="*"></assign>
          </input>
        </operation>
        <operation name="Connect:Direct Server Submit Service">
          <participant name="CDServerSubmit"/>
          <output message="SubmitRequest">
            <assign to="." from="*"></assign>
            <assign to="SessionToken"
		from="//BeginSessionResults/SessionToken/node()"></assign>
            <assign to="RemoteProcessFile">Lalitha.cd</assign>
            <assign to="RemoteProcessParms">SNODE=00.00.00.000;1364</assign>
                      </output>
          <input message="inmsg">
            <assign to=”SubmitResults" from="*"></assign>
          </input>
        </operation>
    <!-- End Server Session -->
        <operation name="Sterling Connect:Direct Server End Session Service">
          <participant name="CDServerEndSession"/>
          <output message="EndSession">
            <assign to="." from="*"></assign>
            <assign to="SessionToken"
		from="//BeginSessionResults/SessionToken/node()"></assign>
          </output>
          <input message="inmsg">
            <assign to="EndSessionResults" from="*"></assign>
          </input>
        </operation>
</sequence>
</process>