Open topic with navigation

TIBCO® Managed File Transfer Platform Server for z/OS 8.1.0

# SUBJCL Parameter Substitution

When submitting a job into the internal reader, the Platform Server can pass specific data associated with the file transfer request to the submitted job through substitutable parameters.

See the following table for supported substitutable parameters.

Parameter | Substituted Data
--- | ---
`&TYPE` | `SEND` or `RECEIVE`
`&SOURCE` | `INITIATOR` or `RESPONDER`
`&STATUS` | `SUCCESS` or `FAILURE`
`&RC` | Numeric return code (`0` if successful)
`&DSN` | Local dataset name
`&PROCESS` | Process name
`&NODE` | Node name (or `NODE` if no node is found.)
`&IPADDR` | IP address (or `IPADDR` if not IP)
`&TRN` | Transaction number

When a substitutable parameter is used, the parameter must terminate with one of these characters: period, space, null, comma, open parenthesis, close parenthesis, or single quotation mark. If the substitutable parameter is terminated by a period, the period is removed as a part of the parameter substitution.

See the following Platform Server script program as an example of how the parameter substitution works. The JCL defined is located in the Platform Server JCL library with a member name of `QSUBJCL`.

    //JOBCARD  JOB  ,'CFUSION',MSGCLASS=X,REGION=5M,CLASS=A
    //S1     EXEC PGM=OSIUC000,PARM='SERVER=FUSION'
    //STEPLIB  DD  DSN=FUSION.LOADLIB,DISP=SHR
    //SYSPRINT DD   SYSOUT=*
    //SYSTRACE DD   SYSOUT=*
    //SYSIN    DD   *
       WTO "TYPE=&TYPE."
       WTO "SOURCE=&SOURCE."
       WTO "STATUS=&STATUS."
       WTO "RC=&RC."
       WTO "TRN=&TRN."
       WTO "DSN=&DSN."
       WTO "NODE=&NODE."
       WTO "IPADDR=&IPADDR."
       WTO "PROCESS=&PROCESS."

If you have the following configuration entry:

    SUBMIT,JCL=FUSION.JCL(QSUBJCL),
           STATUS=SUCCESS,
           SOURCE=RESPONDER,
           TYPE=SEND,
           DSN=TECHSUP.TEST.DATA

When a send request for dataset `TECHSUP.TEST.DATA` is started by a remote system, the JCL contained in the `QSUBJCL` member of the Platform Server JCL library is submitted to the JES internal reader. When the job is executed, the following information is displayed on the z/OS console.

    TYPE=SEND
    SOURCE=RESPONDER
    STATUS=SUCCESS
    RC=0
    TRN=R125200000
    DSN=TECHSUP.TEST.DATA
    NODE=SUPPORT
    IPADDR=192.100.100.1
    PROCESS=CYBERFUS

Copyright © 2003-2021. TIBCO Software Inc. All Rights Reserved.