Accounting records

Structure of openFT accounting records

An openFT accounting record is divided into the following parts:

• SMF header

• record definition

• product information

• FT administrator area

• user information

• basic information

• file information

The following description of these record sections includes the absolute and relative offsets (relative to the start of the SMF record or the start of the record section being described), the length (in bytes) and the format of the data field. The following abbreviations are used when specifying the formats:

A: alphanumeric

B: binary

C: printable character

F: file name for z/OS

P: packed decimal number

Z: unpacked decimal number

Layout of the SMF header

Offsets (hex.)		Length (dec.)	Format	Description
abs	rel
00	00	2	B	Length of the SMF record (including the length field) (1)
02	02	2	B	Segment descriptor (1)
04	04	1	B	System indicator "0xxxxx10" = OS/VS2 (2)
05	05	1	B	Record type (128, ..., 255)
06	06	4	B	Record storage time in hundredths of seconds since 0:00 local time
0A	0A	4	P	Record storage date in the format 0CYYDDDF (3)
0E	0E	4	C	System ID (from the SID parameter)

(1)	The fields "length of the SMF record" and "segment descriptor" together form the record descriptor word (RDW). Depending on the reading method used, the RDW may be missing from the SMF records read out. The segment descriptor is set to "0000", i.e. only non-spanned records are written.
(2)	Bits specified with "x" are reserved by IBM and are set by SMF under certain circumstances.
(3)	C: centuries later than the 20th century YY: year DDD: days in year F: sign (= X'F')

Layout of the record definition section

Offsets (hex.)		Length (dec.)	Format	Description
abs	rel
12	00	4	A	Record ID ("FTR0")
16	04	2	C	Record version ("1A") (4)
18	06	2	B	Offset for product information (5)
1A	08	2	B	Offset for FT administrator area (5)
1C	0A	2	B	Offset for user information (5)
1E	0C	2	B	Offset for basic information (5)
20	0E	2	B	Offset for file information (5)

(4)

An analysis program can recognize the structure of the accounting record from the record version. The structure described here corresponds to version "1A"; accounting records with a different structure (subsequent versions) are identified where appropriate by the corresponding record versions. The following is guaranteed for record versions "1A", "1B" etc.: The order in which the offset information is described here is retained in the record definition section. The structure of the record sections described here (product information, FT administrator area, etc.) is retained; if necessary, additional information is appended at the end of the relevant record section.

(5)

These offsets are given in relation to the start of the SMF record. If, after the SMF record has been read, the record descriptor word (see above) is missing, 4 bytes must be subtracted from the specified offsets.

Layout of the product information

Offsets (hex.)		Length (dec.)	Format	Description
abs	rel
22	00	6	C	Product name ("openFT")
28	06	4	C	Product version ("120A0")

Layout of the FT administrator area

Offsets (hex.)		Length (dec.)	Format	Description
abs	rel
2C	00	40	C	FT administrator area (data from SMF_ADM_AREA; see the section “Setting up the FT parameter library”)

Layout of the user information

Offsets (hex.)		Length (dec.)	Format	Description
abs	rel
54	00	8	A	User ID from the TRANSFER-ADMISSION
5C	08	40	C	"accounting information" from the TRANSFER-ADMISSION
84	30	8	A	User ID of the user who submitted the request (only for transfer requests submitted in the local system)

Layout of the basic information

Offsets (hex.)		Length (dec.)	Format	Description
abs	rel
8C	00	12	Z	Time when the file transfer request was stored, in the format YYMMDDhhmmss (applies only to requests issued in the local system)
98	0C	12	Z	Time when the transfer ended, format YYMMDDhhmmss
A4	18	1	C	Result of the transfer: + : successful transfer, - : unsuccessful transfer
A5	19	1	C	Follow-up processing in the local system + : was started - : was not started 0 : was not specified
A6	1A	8	A	Name of the remote system
AE	22	1	A	Transfer request was submitted L : in the local system, R : in the remote system
AF	23	11	Z	Transfer ID
BA	2E	2	-	Reserved
BC	30	4	B	Number of disk accesses (6)
C0	34	4	B	Number of bytes on disk (7)
C4	38	4	B	Number of bytes in network (8)

(6)	Restrictions: For VSAM files, the number of control intervals is specified instead of the number of times the disk is accessed. When PO members are written with *EXTEND, a copy is first made of the old member. This counts as 1 disk access only. If restarts take place during file transfer, slight inaccuracies may occur in determining the number of times the disk is accessed.
(7)	For files with record format V (or, in the case of VSAM files, where MAXLRECL is not equal to the AVGLRECL), the number of data bytes plus four times the number of records is specified. For VSAM files, the bytes reserved for the control interval definition fields and record definition fields are not taken into account.

(8)

In the openFT protocol approximately the number of data bytes plus six times the number of records for variable record length files, else (fixed or undiefined record length) the number of data bytes. In practise, this value will slightly differ due to protocol data exchange, tabulator expansion, code conversion and so on. The use of data compression normally leads to lower values.

Layout of the file information

Offsets (hex.)		Length (dec.)	Format	Description
abs	rel
C8	00	2	B	Length of the file name
CA	02	2	-	Reserved
CC	04	See below	F	File name (9)

(9)	The length of this data field is specified in the data field "length of the file name" (maximum length: 56).