Transport case file format

Document created by Michael_A._Lowry on Apr 17, 2018Last modified by Michael_A._Lowry on Apr 17, 2018
Version 3Show Document
  • View in full screen mode

The transport case provides a way to move objects between AE systems. The transport case file format is not officially documented by CA, but it has been reverse-engineered and partly documented by MichaelLowry. This document is intended to build on that initial work, and expand it into a collaborative effort to more fully document the file format, filling in missing pieces and elaborating on important details. If you are interested in contributing, please contact one of the authorized editors.

 

Overall structure

The transport case file format consists of many records. Each record occupies a single line in the transport case file. The record type is indicated by  the first character of the line. There are seven different record types. Lines beginning with a semicolon (;) are comments, and are ignored.

 

Record types

Record typeDescription
VFile   & version information
TTable name
CTable   column definition
FTable field data
OObject   home folder path (or link path)
REnd of group of data fields
SEnd of   file
;Comment

Broadly speaking, a transport case file consists of two main parts: table descriptions at the top, and table content at the bottom.

 

Table descriptions

The table descriptions section contains a complete description of the structure of all of the tables in the AE schema that pertain to AE objects. Each table description consists of the table name (a T record) followed by descriptions of the columns in the table (C records).

;Table OCA was exported on: 2017-01-20 15:40:36
TOCA
C001OCA_OH_Idnr       300004
C002OCA_Name          700032
C003OCA_Value         700200

 

Table content

After the table descriptions comes the actual content of the tables. The table content section contains the actual data for the AE objects in the transport case. Only tables containing information relevant to the objects in the transport case are included. For each table, the table content consists of the table name (a T record) followed by the contents of the fields in the table (F records). Groups of fields are terminated by a single R record.

TJPP
F001+0001463068
F002+00001
F004CUC0.DEV.TEST#1_1.JOBP
F006C001135
F016001
F019+0000000001
F024C000000
F035+00001
R

 

For each object described in the transport case, the table data section begins with data for the OH table, followed by any O records, and then data for other tables related to the object.

 

The V record

All transport case files begin with a single V record. This record encodes basic information about the file and the system whence it originates.

V08 11.2      TRANSPORT            OH                 0000000056 018

Fields of record type V

DescriptionPositionLengthExample
Record   type11V
File version248
System version51011.2
File type1521TRANSPORT
Main table3520OH
Number of objects551056
Unknown66?18

T records

T records indicate the table to which a subsequent group of records pertains.

TABLOB

Fields of record type T

DescriptionPositionLengthExample
Record type11T
Table name2?ABLOB

C records

C records describe the columns in a particular table.

C001ABLOB_AH_Idnr     300004

 

Fields of record type C

DescriptionPositionLengthExample
Record type11C
Column number231
Column name515ABLOB_AH_Idnr
Column data type2313
Column data length2454

The column numbers correspond to the order of columns in the DB schema documentation. There are several column data types.

 

Column data types

Data typeDescription
AMemo,   CLOB
BMemo, ?
CLong   Integer
DXML
0Memo,   binary
1Byte
2Integer
3Long Integer
4Long   Integer, counter
5Date/Time
6Unknown   (not yet encountered)
7Text
8Memo, ?
9Byte

For the Memo data types, there is usually more information about the data type in the Description field of the DB schema documentation for the corresponding table.

 

F records

F records contain the data for each field in a particular table.

F004CUC0.DEV.TEST#1_1.JOBP

Fields of record type F

DescriptionPositionLengthExample
Record type11F
Field number234
Field data type51C
Field data61UC0.DEV.TEST#1_1.JOBP

The field numbers correspond to the column numbers of the corresponding tables, and the order of columns in the DB schema documentation.

There are several field data types.

 

Field data types

Data typeDescription
-Integer
+Integer
0Byte
2Date/Time
CString
MString with byte count. Can contain multiple parts.

There may be additional types too. The date/time values in F***2 fields begin with the numeral 2 in byte 5.

Some fields of type C can contain multiple labeled parts. E.g., JBA_Rest is used to store additional attributes for z/OS jobs.

 

F records (data type M)

F records with data type M have an additional data length field that indicates the length of the data to follow.

F005M000000010key1value1

Fields of record type F, data type M

DescriptionPositionLengthExample
Record type11F
Field number235
Field data type51M
Field data length6910
Field data15variable (10 in this case)key1value1

M fields often contain multiple parts separated by ^K (control-K) characters. These fields sometimes include embedded XML.

 

O records

O records encode folder paths of objects.

\APPS{}\UC0{}\TESTS{}\TEST1{This is a folder title}

Fields of record type O

DescriptionPositionLengthExample
Record type11O
Folder path2?\APPS{}\UC0{}\TESTS{}\TEST1{This is a folder title}

O records always appear right after the R record concluding the F records of the OH table. If there is no O record for an object, this means the object is in <No Folder>. If there is one O record, this record contains the home folder path of the object. If there is more than one O record, the second, third, and so on represent links to the object. Folder titles appear within curly braces ({,}) after each level in the folder hierarchy.

 

The S record

The transport case file is terminated by a single S record.

S END

 


This document is based on an earlier discussion, Transport case file format.

Attachments

    Outcomes