Group-Level Index Element IEL Structured Field | IBM S544-5285-01

Appendix C. Format of the Index Object File

General-use Programming Interface and Associated Guidance Information i contained in this appendix.

One of the optional files ACIF can produce contains indexing, offset, information. The purpose of this file is to enable applications such retrieval applications to selectively determine the location of a pag within the AFP data stream print file, based on its index (tag) valu

The following example shows the general internal format of this object

BDI

IEL GroupName=G1

TLE (INDEX1)

...

TLE (INDEXn)

IEL PageName=G1P1

TLE (INDEX1)

...

TLE (INDEXn)

...

IEL PageName=G1Pn

...

IEL GroupName=Gn

TLE (INDEX1)

...

TLE (INDEXn)

IEL PageName=GnP1

TLE (INDEX1)

...

TLE (INDEXn)

...

IEL PageName=GnPn

EDI

The example illustrates an index object file containing both page-level group-level Index Element (IEL) structured fields. Because ACIF can c structured fields only at the group level, the print file that was create this example of an index object file already contained page group-level TLE structured fields.

Group-Level Index Element (IEL) Structured Field

IfINDEXOBJ=GROUPis specified, ACIF creates an index object file following format:

 Copyright IBM Corp. 1993, 1999

191

Image 211

IBM S544-5285-01 manual Group-Level Index Element IEL Structured Field, 191

Contents

IBM Page IBM 1999 Edition Contents MVS VSE File Helpful Hints Glossary Print Services Facility PSF for . OS/390 VSE Vii Viii Acif User’s Guide Disclaimer Programming InterfacesTrademarks Unix SUN Userlib InsertimmIOB APK345I Apar AparAPK252I Apar APK343I Apar MVS VSE AIX Acif Why Should I Read This Publication?What Do I Need To Know? Xiii MVS AsciiMVS VSE Library AIX What Terms Are Used In This Publication? Member Related InformationUnderstanding Syntax Notation Highlighting Notational Conventions Examples Part 1. Information Common to AIX, OS/390, MVS VSE Acif User’s Guide What Can I Do with ACIF? How Acif Fits into Advanced Function Presentation Using Acif for Different Tasks AFP Using Acif to Prepare Files for Viewing Transfer Using Acif to Prepare Files for Distributed Printing Acif PSF Tasks You Can Do with Acif Content Architecture ReferenceBDT/EDT ForIBM AIX,Page referPrinter to Formatting PresentationProgramming Guide and Line Data Reference Line Data Reference Literal Values Indexing With Data Values Example Bank Statement Input File With Literal Acif Processing Parameters to Index the Bank Statement PDS Goca, ioca Orrestype=all Workbench Viewer What Other IBM Products are Related to ACIF? Operating Systems AFP Toolbox for Multiple PSF ForSystem Limitations Considerations Thepagedef Installpsf.baseSystem Prerequisites Theformdef VSE Prerequisites Acif User’s Guide Part 2. Using Acif in the AIX Environment Acif User’s Guide Ovlylib=pathlist PurposeSyntax Acif Isnot Description Font Collection OvlylibFont For To specify Job Script Wit You can use Acif to prepare S/370 line Data UnformattedFiles Flag Keyword-value Pair With One Flags and Values IBM AFP Chars= fontname1, fontname2, fontname3, fontname4 TRC Fontname2 Objconlib Comsetup= name Directory/usr/lpp/psf/reslib Fdeflib= pathlistField16 . Isanything Other Error Condition Terminates ProcessingRecord Specifies Relative Literal valueX literal value RDW As the defaultRecord Record, n Fontlib= pathlist Print Services Facility for AIX Print . AdministrationStream, newline=X nn Ifnewline Index 35in Name,field n ,field n Index1Imageout=asis Asis Field Field Field nFilename Specifies Name Full Path Name for Index ob When Name For Index Object f Variable You Not Specify Indexobj=group all noneIndexstartby=1 nn Input. I fileyou specify Usr/lpp/psf/bin/asciinpe Inputdd= filenameInsertimm=yes 39in Not Spe Filename SpecifiesProgramname Specifies Output File Into your Current Directory Pagedef= pdefname Print referServices to Facility For AIX Administration Pdeflib= pathlist Parmdd= Theacif SOSI1Chars Pseglib= pathlist Respath Reslib= pathlistPseglib Font FdefPseg Ovly Trigger1 Trc=yes noTrigger n = record Trigger Value X trigger value ‘PAGE Instructs Acif Scan Every RecordLooking ‘ACCOUNT’ Orpseglib Orfield nUserlib= pathlist Fontlib 370 Line IBM AFP Trc=yes Suggested Reading Implementation SpecificsFiles NLS Messages Acif User’s Guide AIX Example of a Customer’s Telephone Bill Line-Data Telephone Bill Input FileInput Specifying Acif Processing Example of a Parameter File for Ascii Input Data File WithData Parmdd To create the indexing tag for Specifying Acif Processing DataInput Data Parameters Trigger1 = \,1,XF1 Field2 Field1Field3 As axeb Oriconv ValuesLiteral Must Definition Running the Acif JobAcif Output Determining the Form Workstation Accessing the DocumentTransferring the Document Cd AIXdirectoryname WorkstationMounting User Programming Exits Attributes Work Bytes For AIX Print AdministrationExit Input Record Reserved2 Bytes Record BytesReserved1 Bytes Recordln Bytes Theasciinp Ifasciinpe Sample Index Record Exit C Language Header Index Record Exit Sample Output Record Exit C Language Header Byte Inserted eof whenis Sample Resource Exit C Language Header Resource ExitResname Bytes Restype Byte Ioca GocaIfMCF2REF=cf Sample Print File Attributes C Language Header Non-Zero Return CodesCc Bytes Chars Bytes ‘P1TEST’ Trc Bytes‘P1PROD’ Acif Acif User’s Guide Thechars FontsFor Data Size For Chars Type  Copyright IBM Corp Acif User’s Guide Explaining the JCL Statements MVS EnvironmentsAcif OS/390 Using Acif in the VM Environment Trace Explaining the VM CMS CommandsApkacif Sample VSE JCL to Invoke Acif Using Acif in the VSE Environment Prntout Explaining the VSE JCL StatementsAssgn Syslst Acif User’s Guide MVS Syntax Rules for OS/390Parameters OS/390 and MVS Acif Parameters, Tasks, and Operating Systems CHARS=XðGT1ð CCTYPE=A /\ This is not allowed =TAPE Disk CC=YES TheCHARS AfterFontname1 ,fontname2 Fontname3 ,fontname4 Fontname Example COMSETUP= YES DCFPAGENAMES=YES noFDEFLIB= Facility/VSE System CustomizationFiletype1,filetype2,filetype ...VM Fdeflib Dummy ‘literalUnbounded Value IfUSERLIB ExampleFontlib Facility/VSE System Programming Guide Doesnot Require A library referenced in the // Libdef PHASE,SEARCH=... DlblFdefname Specifies the complete file name Member Also Specified INDEXnIMAGEOUT=ASIS Ioca Treats Group Uses this information to index Document 16FIELDn Field n ,FIELDnFIELDn Ddname FileINDEXDD INDXEXIT= module nameINPEXIT= module =FFBVVB 100RECFM=FFBVVB OVLYLIB= OUTPUTDD=OUTPUTDDname OS/390, MVS, and VMIfUSERLIB Pdefname Specifies Complete file name in OS/390, MVS OvlylibFollowing Example Linect Jobparm Output JCL OS/390 PSEGLIB= PdeflibSOSI2 SOSI3 Pseglib Module NameRESEXIT= That Appears Dlbl Specifies FileStat ALL 108 TRC=YES no FontOvly Value value Value X valueTrigger Trigger Acif Trigg Racf 113 Example Acif Application in OS/390, MVS, VM, or VSE Example of a Customers Phone Bill Processing JCL, CMS CommandsParameters OS/390 or MVS JCL to Invoke Acif Space VSE JCL to Invoke Acif VM CMS Commands to Invoke Acif Exec PGM=APKACIF,SIZE=548K \ Data Characteristics CC = YES FIELD1 INDEX1INDEX2 City, State, Zip, index attribute Field4 Field3Field5 File MVS or OS/390 VM CMS CommandsConcatenating Files OS/390 or MVS JCL Acif User’s Guide 123 Input Record Exit Sample Input Record Exit Dsect PFATTR@ Bytes Sample Index Record Exit Dsect EOF Output Record Exit Sample Output Record Exit Dsect RECORD@ Bytes Sample Resource Exit Dsect Resexit Request Byte Or name.TEXTLIB User Exit Search OrderAttributes Input Print File Non-Zero Return Bytes 33-40 Cctype ByteOfCCTYPEthe Bytes 25-32 Acif User’s Guide Severe For OS/390Multiple Message Scenarios 133 General Messages Action NameWAS Field 136 Guide Line Data Length Padding For Error MayLogic Error You Document To create the structured fields For For UserIgnored Explanation Advanced Function Printing DiagnosisforGuide Document ContentDocument Content Architecture Referencefor more Objectto 140 Content ArchitectureMSU ProgrammerArchitecture Printing DiagnosisMMC MMO 142 ReferAdvancedto Function Printing Diagnosis SystemPresentation Programming Guide Line Data BIM Acif User’s Guide Error May be an Acif logic error Valid Issues Message IdentifyingMessage Identifying Positio Error Logic Error Response Identifier, is Invalid MMCUnit Guide for APK244IData Architecture Referencefor Maps Content Architecture Referencefor moreNot ANY Structured fieldDO not Match 150 IPO MCFAEG Function Printing Diagnosis Guide for 152Architecture RefeorAdvancedence Function Printing Diagnosis Presentation ToFunction Document Content Document Content Architecture ReferenceforProgramming Guide and Line Data Reference, PGP Structured Field Error Contained a Assistance Determining Source ProblemLogic Error You Structured Field Used Program Form Definition With Error Verify That Structured field numberISparameter Structured Field numberISLND Presentation Programming Guide and Line Data Referencefor IdentifierIS 156 LND Printing Diagnosis ForGuide PresentationISparameter Value Identifier2WAS 158Programming Guide Line Data Identifier1 Printing Diagnosis ForGuide Advanced IdentifierWAS Size 160 BMM Number, PresentationIdentifier Referencefor Structured field Advanced Function Presentation DirectionAre Guide be Set Issues Message Identifying Logic Error You UsedValue For Definition Correct Error Res With Error Verify That Inp System Programmer Response Module Name UsedStorage Request,requestsize Module Invalid Explanation OpenFile Have Processing WereRange Code = But ErrorAcif has Completed Processing During Token1 IndexXxxxxxxx Xxxxxxnn Trigger Not Supported for Field IndexValues Specified Function Specified Message APK476I Message Text not Available for Find APK905S Missing Font Metric Pointer CCMProgrammer Response DAT 174 Acif Messages for OS/390, MVS, VM, 175and VSE Acif User’s Guide 177 Acif User’s Guide Lines ThatPlacing TLEs in named 179 Ascii Working with file transfer and AIXVariable-length files Ebcdic Ansi carriage control characters Carriage controlsFixed-length files Understanding how Ansi IND$FILE SystemsPhysical media PC file transfer program NFS Invoke Medium Map IMM Structured FieldImage Binary Indexing Considerations Index DocumentSpecifying the Imageout Acif User’s Guide Tag Identifier Triplet 4-254 bytes Tag Logical Element187 Structured Field Introducer 8 bytes BPG Format of the Resources File Resource FieldStructured Resource Group BRG Acif User’s Guide 191 Group-Level Index Element IEL Structured Field Page-Level Index Element IEL Structured Field Structured Field BDI TagLogical Element Field 195 Appendix D. Format of the Output Document File BDT BPG TLE INDEX1 EDT GroupsBegin Document BDT Begin Named Group BNG IsINDEX2 EDTStructured Fields Begin Page BPG Structured Composed Text Output MODCA-P Data StreamDefinitions AIX Source Identifiers201 AFP 202 Goca Formdef PSF Tag SyntaxTypeface Acif User’s Guide 207 Bibliography Fonts AFP Architecture InfoPrint Manager for AIX Text Processing Printers EDMSuite OnDemand OS/390 Version 2 Release ESA Vtam and NCP TCP/IP for MVS AS/400 Systems Network ArchitectureInformation/System API 215See AFP Acif JCL See acif AIX BDI Ascii AIXAIX Ascii Asciinp See End CommandsDefined, OS/390, MVS, VM, VSE See AIX Index Variables ExitsEPG ERG AIX JCL GTFAIX Imageout AIX IMM AIX Inpexit IndexobjIndxexit AIX Indexdd See Map Parameter LibrarySee file Userlib Index JCL IMAGEOUT, OS/390, MVS, VM, VSE COMSETUP, OS/390, MVS, VM, VSE OvlylibFORMDEF, OS/390, MVS, VM, VSE AIX 41 GROUPNAME, OS/390, MVS, VM, VSE Trigger AIX ResexitRESEXIT, OS/390, MVS, VM, VSE Reslib AIX Reslib ExitAIX VSE AIX MVS TRC See TagTRC AIX Sysin JCL AIX 65 Userappl Acif VSE Communicating Your Comments IBM Comments Readers Comments Wed Like to Hear from You IBMPage IBM AFP Conversion and Indexing Facility User’s Guide