General-use Programming Interface and Associated Guidance Information is
contained in this appendix.
This appendix describes the Tag Logical Element (TLE) structured field and the
formats of the resource data sets.
Tag Logical Element (TLE) Structured Field
TLE structured fields are allowed only in AFP data stream (MO:DCA-P) documents.
AFP Application Programming Interface (AFP API) supports the TLE structured field
and can be used from host COBOL and PL/I applications to create indexed AFP
data stream (MO:DCA-P) documents. Document Composition Facility (DCF), with
APAR PN36437, can also be used to insert TLE structured fields in an output
document.
The format of the TLE structured field that ACIF supports and generates is as
follows:
Carriage Control Character (X'5A')
Specifies the carriage control character, which is required in the first position of
the input record to denote a structured field.
Structured Field Introducer (8 bytes)
Specifies the standard structured-field header containing the structured field
identifier and the length of the entire structured field, including all of the data.
Tag Identifier Triplet (4–254 bytes)
Specifies the application-defined identifier or attribute name associated with the
tag value. An example is 'Customer Name'. This is a Fully Qualified Name
triplet (X'02') with a type value of X'0B' (Attribute Name). For more
information, refer to
Mixed Object Document Content Architecture Reference
.
Tag Value Triplet (4–254 bytes)
Specifies the actual value of the index attribute. If the attribute is 'Customer
Name', the actual tag value might be 'Bob Smith'. This triplet contains a length
in byte 1, a type value of X'36' (Attribute Value) in byte 2, and 2 reserved
bytes (X'0000').
The following is an example of a 39-byte TLE structured field containing two index
values. For the purposes of illustration, each field within the structured field is listed
on a separate line. X'' denotes hexadecimal data, and "" denotes EBCDIC or
character data.
X'5Aðð26D3Að9ððððððð'
X'11ð2ðBðð'
"Customer Name"
X'ðD36ðððð'
"Bob Smith"
TLE structured fields can be associated with a group of pages or with individual
pages. Consider a bank statement application. Each bank statement is a group of
pages, and you may want to associate specific indexing information at the
statement level (for example, account number, date, customer name, and so on).
Copyright IBM Corp. 1993, 1999 187