NSTAT - Query file transfer status

The macro NSTAT can be used to obtain information on the status of your file transfer request via an ASSEMBLER program. The functionality corresponds to the command SHOW-FILE-TRANSFER (NSTATUS).

Format of the macro NSTAT(LIST format/default format)

Name	Operation	Operand
[name]	NSTAT	[MF=L,] [TRANSID=adr] [,SOWNER=adr] [,PARTNER=adr] [{,LFILE=adr /   [,LLIB=adr][,LEL=adr][,LELVER=adr][,LLIBTYP=adr]}] [,JVNAME=adr] [,JVPASS=adr] [,INIT={BOTH / LOCAL / REMOTE}] [,STATE={ALL / SUSP / LOCK / WAIT / ACT / CAN / FIN /          HOLD}] [,INFO={STD / ALL / SUMMARY}] [,OUTPUT={SYSOUT / SYSLST}] [,LAYOUT={[*]STD / [*]CSV}] [,Version={1 / 2}]

Format of the macro NSTAT (DSECT format)

Name	Operation	Operand
[name]	NSTAT	MF=(D[,xxx])

The prefix xxx (default value YNS) may be up to 3 characters long. It must generate names which are permitted in ASSEMBLER. The following ASSEMBLER instructions are generated:

xxxNSTAT DSECT
xxxHSTA  FHDR  MF=(C,&P)
xxxTRID  DS    A                       A(TRANSFER-ID)
xxxTRIDL DS    XL2                     L(TRANSFER-ID)
xxxSOWNL DS    XL2                     L(OWNER-ID )
xxxSOWN  DS    AL4                     A(OWNER-ID )
xxxPART  DS    AL4                     A(PARTNER-SYSTEM)
xxxPARTL DS    XL2                     L(PARTNER-SYSTEM)
xxxLFILL DS    XL2                     L(FILE-NAME)
xxxLFIL  DS    AL4                     A(FILE-NAME)
xxxLLIB  DS    AL4                     A(LIBRARY-NAME)
xxxLLIBL DS    XL2                     L(LIBRARY-NAME)
xxxLELL  DS    XL2                     L(ELEMENT-NAME)
xxxLEL   DS    AL4                     A(ELEMENT-NAME)
xxxLEV   DS    AL4                     A(ELEMENT-VERSION)
xxxLEVL  DS    XL2                     L(ELEMENT-VERSION)
xxxLETYL DS    XL2                     L(ELEMENT-TYPE)
xxxLETY  DS    AL4                     A(ELEMENT-TYPE)
xxxJVNM  DS    AL4                     A(JV-NAME)
xxxJVNML DS    XL2                     L(JV-NAME)
xxxJVPSL DS    XL2                     L(JV-PASSWORD)
xxxJVPS  DS    AL4                     A(JV-PASSWORD)
xxxINIT  DS    XL1                     INITIATOR
xxxSTAT  DS    XL1                     TRANSFER-STATUS
xxxINFO  DS    XL1                     INFORMATION
xxxOUTPT DS    XL1                     OUTPUT /LAYOUT
xxxLNST  EQU   *-xxxNSTAT
*
xxxIBOTH EQU   0                       INITIATOR = BOTH
xxxILOC  EQU   192                     INITIATOR = LOCAL
xxxIREM  EQU   128                     INITIATOR = REMOTE
*
xxxSTAL  EQU   X'00'                   TRANSFER-STATUS = ALL
xxxSTSU  EQU   X'01'                   TRANSFER-STATUS = SUSP
xxxSTLO  EQU   X'02'                   TRANSFER-STATUS = LOCK
xxxSTWA  EQU   X'03'                   TRANSFER-STATUS = WAIT
xxxSTAC  EQU   X'04'                   TRANSFER-STATUS = ACT
xxxSTFI  EQU   X'05'                   TRANSFER-STATUS = FIN
xxxSTHO  EQU   X'06'                   TRANSFER-STATUS = HOLD
xxxSTCA  EQU   X'07'                   TRANSFER-STATUS = CANCELLED
*
xxxSTD   EQU   X'00'                   INFORMATION = STD
xxxSUM   EQU   X'01'                   INFORMATION = SUMMARY
xxxALL   EQU   X'02'                   INFORMATION = ALL
*
xxxSOUT  EQU   X'00'                   OUTPUT = SYSOUT
xxxSLST  EQU   X'02'                   OUTPUT = SYSLST
xxxSOUTC EQU   X'03'                   OUTPUT = SYSOUT LAYOUT=CSV
xxxSLSTC EQU   X'04'                   OUTPUT = SYSLST LAYOUT=CSV

Meaning of the fields

The macro NSTAT offers the same options as the command SHOW-FILE-TRANSFER (NSTATUS). Please refer to the command description in the manual "openFT (BS2000) - Command Interface ". In the OUTPT address field, SOUT stands for OUTPUT=*SYSOUT in the command and SLST stands for OUTPUT=*SYSLST. SOUTC and SLSTC stand for their respective output in CSV format (LAYOUT=*CSV). For the other two values, output is in standard format (LAYOUT=*STD). The following table shows the relation between the parameters in the macro NSTAT and the command operands:

Operand (L format)	Address field (D format)	Meaning in command
TRANSID	TRID	TRANSFER-ID
SOWNER	SOWN	OWNER-IDENTIFICATION
PARTNER	PART	PARTNER-NAME
LFILE	LFIL	FILE-NAME
LLIB	LLIB	LIBRARY
LEL	LEL	ELEMENT
LELVER	LEV	VERSION
LELTYP	LETY	TYPE
JVNAME	JVNM	MONJV
JVPASS	JVPS	JV-PASSWORD
INIT	INIT	INITIATOR
STATE	STAT	STATE
INFO	INFO	INFORMATION
OUTPUT	OUTPT	OUTPUT
LAYOUT	OUTPT	LAYOUT
VERSION	FCTV	(Type of return code output (old/new))1

¹Depending on the value of the VERSION operand, the FUNCTION INTERFACE VERSION NUMBER is set in the header FHDR.

If you do not enter anything in the fields for the OWNER-ID, your own user ID will be used as the value (this corresponds to the default entry *OWN at the command interface. If you intentionally fill the OWNER-ID field with blanks, then all user IDs will be used (this corresponds to the entry *ALL at the command interface).