Sterling Connect:Direct Requester Submit Process Service

Edit online

This table provides an overview of the Sterling Connect:Direct® Requester Submit Process service:

System Name Sterling Connect:Direct Requester Submit Process Service
Graphical Process Modeler (GPM) categories Applications > Sterling Commerce > Sterling Connect:Direct
Description This service is used to submit a Sterling Connect:Direct process to a remote Sterling Connect:Direct node.
Business usage A business user would use this service to initiate work on remote Sterling Connect:Direct node.
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 Requester Adapter must be configured before using this service.
Requires third party files? Sterling Connect:Direct Windows 4.0.00 or later, Sterling Connect:Direct UNIX 3.4.00 or later, or Sterling Connect:Direct OS/390 4.3.00 or later, available from IBM.
Platform availability All supported platforms
Related services Related services include Sterling Connect:Direct Requester Select Process Service and Sterling Connect:Direct Requester Select Statistics Service.
Application requirements None
Initiates business processes? No
Invocation The business process running this service must be started by a user with permission to issue the Submit command on the target Sterling Connect:Direct server.
Business process context considerations None
Returned status values
  • SUCCESS – Command was successfully executed.
  • ERROR – An error occurred while processing the command.
Restrictions None
Persistence level System default
Testing considerations Debug information for this service can be found in the Connect:Direct Interop log files.

Implementing the Sterling Connect:Direct Requester Submit Process Service

To implement the Sterling Connect:Direct Requester Submit Process service, complete the following tasks:

  1. Create a Sterling Connect:Direct Requester Submit Process service configuration.
  2. Configure the Sterling Connect:Direct Requester Submit Process service.
  3. Use the Sterling Connect:Direct Requester Submit Process service in a business process.

Sterling Connect:Direct Requester Submit Process Service Settings

To configure the Sterling Connect:Direct Requester Submit Process service, you must specify settings for the following fields in Sterling B2B Integrator:
Field Description
Name Unique and meaningful name for the service configuration. Required.
Description Meaningful description for the service configuration, for reference purposes. Required.
Select a Group Group of services or adapters of the same type that can act as peers. A Service Group name is used in BPML in place of the Service Configuration name. Service Groups show up in the GPM as if they were Service Configurations. Select a Service Group to associate with this adapter. Valid values are:
  • None – You do not want to include this configuration in a group at this time (default)
  • Create New Group – You can enter a name for a new group in this field, which is then created along with this configuration.
  • Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.

For more information about service groups see Managing Services and Adapters.
CDRequesterName Specifies the Connect:Direct Requester adapter to use with this service. Required.

Parameters Passed from Sterling Connect:Direct Requester Service to Business Process

This table describes the parameters passed from the Sterling Connect:Direct Requester Submit Process service to the business process:

Parameter Description
Class Determines the node-to-node session on which a process can be executed. Optional. Valid values are 1–10.
ConditionCode Specifies the return code values associated with step termination. Optional. Valid values are:
  • 0 – Successful execution of the process.
  • 4 – A warning error was encountered. The statement probably finished normally, but you should verify the execution results.
  • 8 – An error occurred during process execution.
  • 16 – A severe error occurred during process execution.
ExecutionPriority The priority under which the operating system thread that executes Sterling Connect:Direct runs. Valid values are 1–15. Optional.
Note: Applies to Windows only.
LogDateTime Specifies the date and time that the statistics record was written to the statistics log. Optional.
MessageId Specifies the current message ID for the process. Optional.
MessageText Specifies the short text associated with the message ID. Optional.
Pnode Specifies the primary node. Optional.
Priority Specifies the priority assigned to the process. Optional. The lower the number the higher the priority. Valid values are 1–15.
ProcessName Specifies the process name. Optional.
ProcessNumber Specifies the process number. Optional.
Queue Specifies the queue containing the process. Optional. Valid queue values are:
  • All–All processes in the TCQ.
  • Execution–Processes currently being executed.
  • Hold–Processes that are either held by the user or operator or held due to execution errors.
  • Timer–Processes that are scheduled to be executed later, or processes in time retry due to session errors.
  • Wait–Processes that are eligible for execution and are awaiting selection.
Snode Specifies the secondary node used for the process.
Status Process status. Optional. Valid status values are:
  • Execution -Process is executing.
  • Pending Execution -Process is selected for execution and startup is in progress.
  • Waiting Connection -Process is ready to execute, but all available connections to the SNODE are in use.
  • Waiting Start Time -Process is waiting in the Timer queue because it was submitted with a start time or date that has not expired.
  • Held Suspension - Operator issued a delete process request with Hold set to Yes.
  • Timer Retry - Process error occurred and the process was moved to the Timer queue in Timer Retry status with short-term and long-term wait times beginning.
  • Held for Call - Process was submitted with the Hold parameter set to Call. A session started from either node moves the process to the Wait queue in Waiting Connection status. The process is placed in the Execution queue when it is selected for execution.
  • Held Due to Error - Session error or other abnormal condition occurred.
  • Held Initially - Process was submitted with the Hold option set to Yes.
  • Held By Operator - Change process request with Hold set to Yes was issued.
  • Held By Retain - Process was submitted with Retain After Execution set to Yes or Initial.
Submitter Specifies the user ID that submitted the process. Optional.
SubmitterNode Specifies the node from which the process was submitted. Optional.

Parameters Passed from Business Process to Sterling Connect:Direct Requester Submit Service

This table describes the parameters passed from the business process to the Sterling Connect:Direct Requester Submit Process service:

Parameter Description
CDRequesterName Specifies the Sterling Connect:Direct Requester adapter to use with this service. Required.
Class Specifies the preferred session class for the process. The process can execute in the class specified or any higher class. Optional. This value overrides any defaults. Valid values range from one to the maximum number of PNODE sessions defined in the network map definition (default is 1).
Hold Specifies the Hold status of a process. Optional. Valid values are:
  • No – Do not place process in the Hold queue. It is executed as soon as resources are available (default).
  • Yes – Hold process in the Hold queue in Held Initially (HI) status until it is explicitly released.
  • Call – Hold process until the SNODE, as specified in the process SNODE parameter, connects to the PNODE. The process is then released for execution. The process is also released when another process on the PNODE connects to the SNODE.
MaxDelay Specifies the time to wait until a process has executed. Optional. Valid values are:
  • Unlimited – Wait indefinitely or until the process is complete.
  • Queued – Wait until the process is submitted and placed on the queue.
  • hh:mm:ss – Wait for a specific length of time.
  • 0 – The process must be placed on the Exec queue immediately or the submission of the process is considered unsuccessful.
NewName Specifies the new name of the process. The default is the label on the process statement. Optional.
NotifyUser Specifies the user ID to receive process completion messages. The user ID is notified through a Microsoft Exchange E-mail, a Windows dialog box, or a TSO notify. Optional.
PnodeAccounting Specifies user data passed to the PNODE. Optional.
PnodePassword Specifies the user password on the PNODE. This field is case-sensitive. Optional.
PnodeUserid Specifies the user ID used as a security ID on the PNODE. This ID must be the name of an existing user account. This field is case-sensitive. Optional.
Priority Specifies the priority of a process in the Transmission Control queue. Sterling Connect:Direct uses the Priority parameter for process selection. The lower the number, the higher the priority. A process with higher priority is selected for execution before a process with a lower priority. This parameter does not affect the priority during transmission. Optional. Valid values are 1–15 (default is 7).
ProcessDocumentId Specifies the Document ID of the document that contains text of the process to be submitted to the Sterling Connect:Direct server.

Optional (if both ProcessText and ProcessDocumentId are blank, then the primary document must contain the process text).
ProcessText Optional. Specifies:
  • the process statements (Text) to be submitted for execution on the remote node.

    OR

  • the filename in the syntax of the remote platform to the Sterling Connect:Direct process on the remote node.
    Note: If both ProcessText and ProcessDocumentId are blank, then the primary document is used to provide the value of this parameter.
Retain Whether Sterling Connect:Direct retains a copy of a process after it is runs. If you specify Retain with a start time, the process is released to run at the specified time. Each time a retained process is released, Sterling Connect:Direct creates a copy with a new process number. The copy is executed, and the original process remains in the queue. Optional. Valid values are:
  • Initial – Retain the process in the Hold queue for execution every time that Sterling Connect:Direct initializes. Do not specify a start time if you choose this option.
  • No – Do not retain the process after it is executed (default).
  • Yes – Retain the process in the Hold queue after it is executed. You can release the process for execution later or delete it. When you specify a start date and start time, set Retain to Yes to continually execute the process at the scheduled time.
Snode Specifies the secondary node to be used in this process. The secondary node name is a 1–16 alphanumeric character name that is defined in the network map. Optional. Valid values are alphanumeric or nationals (@#$.).
SnodeAccounting Specifies user data passed to the SNODE. Optional.
SnodePassword Specifies the user password on the SNODE. This field is case-sensitive. Optional.
SnodeUserid Specifies the user ID used as a security ID on the SNODE. This field is case-sensitive. Optional.
StartDate Specifies the day or date to execute the process. Optional.
StartTime Specifies the time to execute the process. Format is HH:MM [XM]. Optional.
Variables Specifies the symbolic variables to be used in the process. Symbolic variables are text strings in a process that are replaced with predefined values when the process is executed. This allows you to easily change processes when these values change.

For example, you can define a variable &filename and declare the value to be file1.txt. Whenever the process encounters the &filename variable, it substitutes file1.txt. If you want to use a different value, just change the &filename definition to the new file name, and the process will use that instead. Optional.
UserId User ID used to connect to the Sterling Connect:Direct server. Overrides the user ID specified in the Sterling Connect:Direct Requester adapter. Optional.
Password Password used to connect to the Sterling Connect:Direct server. Overrides the password specified in the Sterling Connect:Direct Requester adapter. Alphanumeric. Optional.

Business Process Example

This example business process illustrates submitting a process using text that is specified in the ProcessText field within the business process:
<process name="CDSubProc">
  <sequence>
    <operation name="CDSubProc">
      <participant name="CDSubProc"/>
      <output message="CDSubProc">
        <assign to="CDRequesterName">CDReq</assign>
        <assign to="." from="*"></assign>
        <assign to="ProcessText">PULL  PROCESS
            SNODE=cdnodename HOLD=yes
STEP02
        COPY
        FROM (
                FILE="/usr/test_data/inputfile"
                SNODE)
        TO (
                FILE="/usr/test_data/outputfile "
                PNODE
                DISP=RPL)
PEND</assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
</sequence>
</process>