DOC1 Programmer's Guide

Programming PCE
Support for AFPDS Indexing
Several commands allow the reading, writing and
manipulating of AFPDS Tag Logical Element (TLE)
structured fields. A TLE has a name by which it can
be identified and an index value.
TLEs can be stored either within individual pages or
within an AFP document header. When working
with document level TLEs you should normally read
the pages of a document into a PCE document group
structure to ensure the header is included. Any
number of TLEs can be present in pages or
document headers.
If you are using partial read/writes to create a new
document group (i.e. you are specifying the start,
middle and end keywords as part of add document
group) then you must ensure that the TLE
commands are used before the start portion is written
to the output file. See the example below for an
example of the required sequence of commands.
If required you can also extract from or add pages to
an existing document group by using the extract
document page and move page commands. You
may want to do this if you need to work with page
level TLEs in the original AFP pages that are to
make up the group.
Page level TLEs
To read the value of an existing page level TLEs use
the TLE command. Use the TLE add, TLE delete
or TLE replace commands with the page keyword to
adjust the index settings for a page.
Document level TLEs
Before you can use any command related to
document level TLEs you must first read the
appropriate pages into a PCE document group (see
“Document Groups” on page 21).
To read existing TLEs in the group use the
document TLE command. Use the TLE add, TLE
delete or TLE replace commands with the document
keyword to adjust the index settings within a
document header.
Example of sequencing TLE index commands for a document group
read 10 pages of document start from file into ;
add document name of "Big Group" to at start;
add document TLE of attrib "first_tle" value "Index1" to
write 1 item to from ;
read 10 pages of document middle from file into ;
write 1 item to from ;
read 10 pages of document end from file into ;
add document name of "Big Group" to at end;
write 1 item to from ;
22