File Transfer Variables › Variables

Variables

File transfer variables enable you to extract information about file transfer events.You can use the variables to pass values to the following:

• Email trouble ticket interface
• FT schedules
• A failure event exit
• Automated actions in a file transfer rule
• Customizing alerts

Example: Use File Transfer Variable

The following example shows the use of variables in the text to be sent to the user, USER01, in response to an event that satisfies the file transfer rule.

PROD------------ File Transfer : User Notification Details --------------------
Command ===>                                                                   
Short Description .. File transfer status and source                           
Notify ............. USER01                                                    
Text ............... &ZRFPRODUCT,&ZRFSRCADDR,&ZRFSTATUS,&ZRFSRCNAME,&ZRFSRCTYPE

File Transfer Variables

&ZRFABENDCODE

Contains the abend code.

&ZRFBLKIN

Contains the number of blocks read during the transfer.

&ZRFBLKOUT

Contains the number of blocks written during the transfer.

&ZRFCMPRPCT

Contains the compression percentage of the file transfer.

&ZRFDATATYPE

Contains the type of data set transferred by an IBM CS FTP server or FTP client (for example, ASCII, EBCDIC, IMAGE, DOUBLEBYTE, or UCS2).

&ZRFDSTYPE

Contains the data type transferred by an IBM CS FTP server or FTP client (for example, SEQ, PDS, or HFS).

&ZRFEDATE

Contains the date when the transfer ended in yyyymmdd format. See also &ZRFENDDATE.

&ZRFENDDATE

Contains the date when the transfer ended in dd-mmm-yyyy format. See also &ZRFEDATE.

&ZRFENDTIME

Contains the time when the transfer ended in hh.mm.ss format. See also &ZRFETIME.

&ZRFETIME

Contains the time when the transfer ended in hhmmss format. See also &ZRFENDTIME.

&ZRFFAILCODE

Contains the failure code.

&ZRFFAILDESC

Contains the failure description.

&ZRFFTPOPER

Contains the type of data transfer operation (command) handled by an IBM CS server or FTP client (for example, RETRIEVE, APPEND, STORE, or STOREUNIQUE).

&ZRFJOBNAME

Contains the name of the file transfer application.

&ZRFLATENCY

Contains the time between the CA XCOM Data Transport for z/OS transfer request and the start of the actual transfer.

&ZRFNETTYPE

Contains the type of protocol used for a CA XCOM Data Transport for z/OS transfer.

&ZRFPRODUCT

Contains the type of file transfer product.

&ZRFRECIN

Contains the number of records read during the transfer.

&ZRFRECOUT

Contains the number of records written during the transfer.

&ZRFRETRIES

Contains the number of times an alert has been raised for a file transfer event.

&ZRFSDATE

Contains the date when the transfer started in yyyymmdd format. See also &ZRFSTARTDATE.

&ZRFSRCADDR

Contains the address or node name of the source of the transfer.

&ZRFSRCFNAME

Contains the name of the source file.

&ZRFSTARTDATE

Contains the date when the transfer started in dd-mmm-yyyy format. See also &ZRFSDATE.

&ZRFSTARTTIME

Contains the time when the transfer started in hh.mm.ss format. See also &ZRFSTIME.

&ZRFSTATUS

Contains the monitored transfer status: START, END, or FAILURE.

&ZRFSTCJOBID

Contains the ID of the CA TCPaccess FTP Server for z/OS started task or job.

&ZRFSTIME

Contains the time when the transfer started in hhmmss format. See also &ZRFSTARTTIME.

&ZRFSTKNAME

Contains the TCP/IP stack name used by an IBM CS FTP server or FTP client.

&ZRFTGTADDR

Contains the address or node name of the target of the transfer.

&ZRFTGTFNAME

Contains the name of the target file.

&ZRFUSER

Contains the ID of the user that performs the transfer.

&ZRFXFRAMT

Contains the number of bytes transferred. See also &ZRFXFRDBYTES.

&ZRFXFRDBYTES

Contains the number of bytes transferred but converted to kilobytes, megabytes, gigabytes, or terabytes. See also &ZRFXFRAMT.

&ZRFXFRDRATE

Contains the transfer rate in kilobytes, megabytes, gigabytes, or terabytes per second. See also &ZRFXFRRATE.

&ZRFXFRDUR

Contains the time, in seconds, taken for the transfer.

&ZRFXFRID

Contains one of the following values:

• CA XCOM Data Transport for z/OS transfer ID
• CONNECT:Direct process name
• CONNECT:Mailbox ID and batch number
• FTP ID if specified in the FTPCNTL parameter group
• Generic data transfer ID
• CA SOLVE:FTS transmission definition name

&ZRFXFRRATE

Contains the transfer rate in bytes per second. See also &ZRFXFRDRATE.

&ZRFXFRTYPE

Contains the CA XCOM Data Transport for z/OS transfer type (EXECUTE or SCHEDULE).

&ZRFXMITMODE

Contains the transmission mode for a transfer handled by an IBM CS FTP server or FTP client (for example, BLOCKED, COMPRESSED, or STREAM.

Note: The &ZRFBLKIN and &ZRFRECIN variables are applicable to CONNECT:Direct transfers only. The &ZRFBLKOUT and &ZRFRECOUT variables are applicable to CONNECT:Direct and CONNECT:Mailbox transfers only. Whether the amount of data read or written is in blocks or records depends on the file format.