Attributes, User Programming Exits | IBM S544-5285-01 manual

Chapter	4. User Exits and	Attributes of	the Input	Print File in
AIX
	This chapter	contains programming	interface	information.

A user exit is a point during ACIF processing that enables you to r program and return control of processing to ACIF after your user-writt ends. ACIF provides data at each exit that can serve as input to program.

This section describes the following topics:

User programming exits

Non-zero return codes

Attributes of the input print file

User Programming Exits

ACIF provides several sample programming exits to assist you in customi product. Use of the programming exits is optional. You specify the exit programs withinpexithe,indxexit , outexit , andresexit parameters. Each of these parameters is described in Chapter 2, Using ACIF Parameters in

ACIF provides the following sample exits:

/usr/lpp/psf/acif/apkinp.c	Input	record	exit
/usr/lpp/psf/acif/apkind.c	Index	record	exit
/usr/lpp/psf/acif/apkout.c	Output	record	exit
/usr/lpp/psf/acif/apkres.c	Resource exit

In addition, ACIF provides the following user input record exits to data streams:

/usr/lpp/psf/acif/apka2e.c

Converts ASCII stream data to EBCDIC stream data.
/usr/lpp/psf/acif/asciinp.c
Converts	unformatted ASCII data that	contains carriage	returns and
into a	record format that contains	an American National	Standards In

(ANSI) carriage control character. This exit encodes the ANSI carr character in byte 0 of every record.

/usr/lpp/psf/acif/asciinpe.c

Converts unformatted ASCII data into a record asciinpformat.c , ands does then converts the ASCII stream data to EBCDIC stream data.

The C language header file for all ACIF exit programs is also provid

/usr/lpp/psf/acif/apkexits.h

along with the build rules for the ACIF user exits:

/usr/lpp/psf/acif/Makefile

 Copyright IBM Corp. 1993, 1999

65

Image 85

IBM S544-5285-01 manual Attributes, User Programming Exits

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 APK252I Apar AparAPK343I Apar APK345I Apar What Do I Need To Know? Why Should I Read This Publication?Xiii MVS VSE AIX Acif MVS AsciiMVS VSE Library AIX What Terms Are Used In This Publication? Understanding Syntax Notation Related InformationHighlighting Member 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 Programming Guide and Line Data Reference PresentationLine Data Reference ForIBM AIX,Page referPrinter to Formatting 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 System Limitations ForConsiderations PSF System Prerequisites Installpsf.baseTheformdef Thepagedef VSE Prerequisites Acif User’s Guide Part 2. Using Acif in the AIX Environment Acif User’s Guide Syntax PurposeAcif Ovlylib=pathlist Isnot Description Font OvlylibFor Font Collection Files You can use Acif to prepare S/370 line Data UnformattedFlag Keyword-value Pair With One To specify Job Script Wit Flags and Values IBM AFP Chars= fontname1, fontname2, fontname3, fontname4 TRC Fontname2 Objconlib Comsetup= name Directory/usr/lpp/psf/reslib Fdeflib= pathlistField16 . Record Specifies Relative Error Condition Terminates ProcessingLiteral valueX literal value Isanything Other Record As the defaultRecord, n RDW Stream, newline=X nn Print Services Facility for AIX Print . AdministrationIfnewline Fontlib= pathlist Index 35in Imageout=asis Index1Asis Name,field n ,field n Filename Specifies Name Full Path Name for Index ob When Field Field nName For Index Object f Field Indexstartby=1 nn Indexobj=group all noneInput. I fileyou specify Variable You Not Specify Insertimm=yes Inputdd= filename39in Usr/lpp/psf/bin/asciinpe Programname Specifies Filename SpecifiesOutput File Into your Current Directory Not Spe Pagedef= pdefname Print referServices to Facility For AIX Administration Pdeflib= pathlist Parmdd= Chars SOSI1Pseglib= pathlist Theacif Respath Reslib= pathlistPseglib Pseg FdefOvly Font Trigger n = record Trc=yes noTrigger Value X trigger value Trigger1 Looking Instructs Acif Scan Every Record‘ACCOUNT’ ‘PAGE Userlib= pathlist Orfield nFontlib Orpseglib 370 Line IBM AFP Trc=yes Files Implementation SpecificsNLS Messages Suggested Reading Acif User’s Guide AIX Example of a Customer’s Telephone Bill Input Input FileSpecifying Acif Processing Line-Data Telephone Bill Data File WithParmdd Example of a Parameter File for Ascii Input Data To create the indexing tag for Input Data DataParameters Specifying Acif Processing Trigger1 = \,1,XF1 Field2 Field1Field3 Literal ValuesMust As axeb Oriconv Acif Output Running the Acif JobDetermining the Form Definition Workstation Accessing the DocumentTransferring the Document Cd AIXdirectoryname WorkstationMounting User Programming Exits Attributes Exit For AIX Print AdministrationInput Record Work Bytes Reserved1 Bytes Record BytesRecordln Bytes Reserved2 Bytes Theasciinp Ifasciinpe Sample Index Record Exit C Language Header Index Record Exit Sample Output Record Exit C Language Header Byte Inserted eof whenis Resname Bytes Resource ExitRestype Byte Sample Resource Exit C Language Header Ioca GocaIfMCF2REF=cf Cc Bytes Non-Zero Return CodesChars Bytes Sample Print File Attributes C Language Header ‘P1TEST’ Trc Bytes‘P1PROD’ Acif Acif User’s Guide For FontsData Thechars 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 Parameters Syntax Rules for OS/390OS/390 and MVS MVS Acif Parameters, Tasks, and Operating Systems CHARS=XðGT1ð CCTYPE=A /\ This is not allowed =TAPE Disk CC=YES Fontname1 ,fontname2 Fontname3 ,fontname4 AfterFontname TheCHARS Example COMSETUP= YES DCFPAGENAMES=YES noFDEFLIB= Filetype1,filetype2,filetype ...VM CustomizationFdeflib Facility/VSE System Unbounded ‘literalValue Dummy Fontlib ExampleFacility/VSE System Programming Guide IfUSERLIB Fdefname Specifies the complete file name A library referenced in the // Libdef PHASE,SEARCH=... DlblMember Doesnot Require IMAGEOUT=ASIS Ioca INDEXnTreats Group Uses this information to index Document Also Specified FIELDn Field n ,FIELDnDdname 16FIELDn 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 SOSI2 PdeflibSOSI3 PSEGLIB= Pseglib Module NameRESEXIT= That Appears Dlbl Specifies FileStat ALL 108 TRC=YES no FontOvly Trigger Value X valueTrigger Acif Value value Trigg Racf 113 Example Acif Application in OS/390, MVS, VM, or VSE Example of a Customers Phone Bill Parameters JCL, CMS CommandsOS/390 or MVS JCL to Invoke Acif Processing 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 Concatenating Files VM CMS CommandsOS/390 or MVS JCL File MVS or OS/390 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 Attributes Input Print File User Exit Search OrderNon-Zero Return Or name.TEXTLIB OfCCTYPEthe Cctype ByteBytes 25-32 Bytes 33-40 Acif User’s Guide Multiple Message Scenarios For OS/390133 Severe General Messages Action NameWAS Field 136 Logic Error You Length Padding For Error MayDocument To create the structured fields For Guide Line Data Ignored UserExplanation For Document Content Architecture Referencefor more Document ContentObjectto Advanced Function Printing DiagnosisforGuide 140 Content ArchitectureMSU MMC Printing DiagnosisMMO ProgrammerArchitecture 142 Presentation Programming Guide Line Data SystemBIM ReferAdvancedto Function Printing Diagnosis Acif User’s Guide Message Identifying Positio Error Issues Message IdentifyingLogic Error Error May be an Acif logic error Valid Response Identifier, is Invalid MMCUnit Data APK244IArchitecture Referencefor Guide for Not Content Architecture Referencefor moreANY Maps Structured fieldDO not Match 150 IPO MCFAEG Architecture RefeorAdvancedence 152Function Printing Diagnosis Presentation Function Printing Diagnosis Guide for Programming Guide and Line Data Reference, Document Content Document Content Architecture ReferenceforPGP ToFunction Logic Error You Structured Field Used Program Assistance Determining Source ProblemForm Definition With Error Verify That Structured Field Error Contained a LND Structured Field numberISPresentation Programming Guide and Line Data Referencefor Structured field numberISparameter IdentifierIS 156 LND Printing Diagnosis ForGuide PresentationISparameter Value Programming Guide Line Data 158Identifier1 Identifier2WAS Printing Diagnosis ForGuide Advanced IdentifierWAS Size 160 BMM Number, PresentationIdentifier Referencefor Structured field Are DirectionGuide be Advanced Function Presentation Value For Definition Correct Error Res Logic Error You UsedWith Error Verify That Inp Set Issues Message Identifying System Programmer Response Storage Request,requestsize UsedModule Module Name File OpenHave Invalid Explanation Range WereCode = Processing Acif has Completed Processing ErrorDuring But Xxxxxxxx IndexXxxxxxnn Token1 Trigger Not Supported for Field IndexValues Specified Function Specified Message APK476I Message Text not Available for Programmer Response APK905S Missing Font Metric Pointer CCMDAT Find 174 Acif Messages for OS/390, MVS, VM, 175and VSE Acif User’s Guide 177 Acif User’s Guide Placing TLEs in named That179 Lines Variable-length files Working with file transfer and AIXEbcdic Ascii Fixed-length files Carriage controlsUnderstanding how Ansi Ansi carriage control characters Physical media SystemsPC file transfer program IND$FILE Image Invoke Medium Map IMM Structured FieldBinary NFS Indexing Considerations Index DocumentSpecifying the Imageout Acif User’s Guide 187 Tag Logical ElementStructured Field Introducer 8 bytes Tag Identifier Triplet 4-254 bytes BPG Format of the Resources File Structured FieldResource Group BRG Resource Acif User’s Guide 191 Group-Level Index Element IEL Structured Field Page-Level Index Element IEL Structured Field Structured Field Logical Element TagField BDI 195 Appendix D. Format of the Output Document File BDT BPG TLE INDEX1 Begin Document BDT GroupsBegin Named Group BNG EDT Structured Fields EDTBegin Page BPG Structured IsINDEX2 Composed Text Output MODCA-P Data StreamDefinitions 201 Source IdentifiersAFP AIX 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 See AFP 215Acif JCL API See acif AIX AIX Ascii Ascii AIXAsciinp BDI Defined, OS/390, MVS, VM, VSE CommandsSee See End EPG Variables ExitsERG AIX Index AIX Imageout GTFAIX IMM AIX JCL Indxexit IndexobjAIX Indexdd AIX Inpexit See Map Parameter LibrarySee file Userlib Index JCL FORMDEF, OS/390, MVS, VM, VSE COMSETUP, OS/390, MVS, VM, VSE OvlylibAIX 41 GROUPNAME, OS/390, MVS, VM, VSE IMAGEOUT, OS/390, MVS, VM, VSE RESEXIT, OS/390, MVS, VM, VSE ResexitReslib AIX Trigger AIX Reslib ExitAIX VSE TRC See TagAIX Sysin JCL AIX MVS TRC 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