IBM Print Services Facility IBM AFP Conversion and Indexing Facility: User’s Guide S544-5285-01
IBM Print Services Facility IBM AFP Conversion and Indexing Facility: User’s Guide S544-5285-01
Note Before using this information and the product it supports, be sure to read the general information in “Notices” on page ix . | Second Edition (January 1999) | | | | | | This edition applies to AFP Conversion and Indexing Facility, which is shipped with Print Services Facility 3.1.0 for OS/390 (program number 5655-B17), Print Services Facility/MVS 2.2.0 (program number 5695-040), Print Services Facility/VM 2.1.1 (program number 5684-141), Print Services Facility/VSE 2.2.
Contents Notices . . . . . . . . Programming Interfaces Disclaimer . . . . . . . Trademarks . . . . . . | Summary Of Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix ix ix ix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About This Publication . . .
Using a Parameter File with ASCII Input Data . . . . . . . . Specifying ACIF Processing Parameters for EBCDIC Input Data Using a Parameter File with EBCDIC Input Data . . . . . . . Using the Shell with EBCDIC Literal Values . . . . . . . . . . Identifying the Locations of the Resources . . . . . . . . . . . . Determining the Form Definition and the Page Definition . . . . Running the ACIF Job . . . . . . . . . . . . . . . . . . . . . . . . ACIF Output . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Index Record Exit . . . . . . Output Record Exit . . . . . Resource Exit . . . . . . . . User Exit Search Order . . . Non-Zero Return Codes . . Attributes of the Input Print File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Composed Text Control (CTC) Structured Field . . . . . . . . . . . Map Coded Font (MCF) Format 1 Structured Field . . . . . . . . . . Map Coded Font (MCF) Format 2 Structured Field . . . . . . . . . . Presentation Text Data Descriptor (PTD) Format 1 Structured Field Inline Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Page Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Glossary . . . . Source Identifiers References . . . vi ACIF User’s Guide . . . . . . .
Figures | 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22. 23. 24. 25. 26. 27. 28. 29. 30. 31. 32. 33. 34. 35. 36. Copyright IBM Corp. 1993, 1999 How ACIF Fits into Advanced Function Presentation . . . . . . . . . Using ACIF to Prepare Files for Viewing . . . . . . . . . . . . . . . . Using ACIF to Prepare Files for Distributed Printing . . . . . . . . . Using ACIF to Prepare Files for Archiving and Retrieving . . . . . .
viii ACIF User’s Guide
Notices References in this publication to products, programs, or services of IBM do not suggest or imply that IBM will make them available in all countries where IBM does business, or that only products, programs, or services of IBM may be used. Noninfringing equivalents may be substituted, but the user must verify that such substitutes, unless expressly designated by IBM, work correctly. No license, expressed or implied, to patents or copyrights of IBM is granted by furnishing this document.
The following terms appear in this publication and are trademarks of other companies: x Adobe, ATM-1, and PostScript are trademarks of Adobe Systems, Inc. Microsoft, Microsoft Windows, and Windows are trademarks of Microsoft, Inc. NFS is a trademark of SUN Microsystems, Inc. UNIX is a trademark of UNIX System Laboratories, Inc.
| Summary Of Changes | | | This publication contains additions and changes to the previous edition, S544-5285-00. The technical additions and changes are marked with a revision bar to the left of the changes. | The following new function has been added: | INSERTIMM=YES|NO (see APAR PN92597) | FONTECH=UNBOUNDED (see APAR PN77365) | MCF2REF={CPCS | CF } (see APAR PQ04391) | PRMODE=SOSI3 (see APAR PQ07139) | RESTYPE=...
| | a Set Coded Font Local Text control. Each shift in character is converted to a Set Coded Font Local Text control and two blanks.
About This Publication This publication describes Advanced Function Presentation Conversion and Indexing Facility (ACIF), which allows you to format and print System/390 line data and unformatted ASCII files with IBM Print Services Facility in the following environments: OS/390 MVS VM VSE AIX ACIF also provides indexing and resource retrieval capabilities that allow you to view, archive, and retrieve document files.
running on it. You may need to show these messages to your system programmer for assistance from time to time. How This Publication Is Organized This publication contains information pertaining to ACIF support for AIX, OS/390, MVS, VM, and VSE operating environments supported by PSF. However, because AIX users can invoke the PSF MSG command to view AIX messages on-line or print them, the AIX messages have not been duplicated in this publication.
To order additional printed copies of this publication, use order number S544-5285 Note: Publications that are referred to in this book or that contain additional information about AFP, the OS/390 or MVS operating systems, PSF, and related products are listed in “Bibliography” on page 207.
Related Information Publications that are referred to in this book or that contain additional information about Advanced Function Presentation (AFP), the MVS operating system, PSF, and related products are listed in the “Bibliography” on page 207. For additional information about OS/390 and PSF for OS/390, refer to these Web pages: http://www.ibm.com/s39ð/os39ð http://www.printers.ibm.com/pbin-id/go?/pdocs/psf39ð/home.
Notational Conventions This publication uses the following notational conventions: Italics within a command represent variables for which you must supply a value. For example: cpgid=code page identifier means that you enter cpgid= as shown and then replace the variable code page identifier with a value that represents any valid code page, which is three-character decimal value (for example, 395) that defines an IBM-registered code page.
Examples PSF for AIX must be installed if you want to use examples documented in this publication that contain pathnames indicating PSF; for example: “inpexit=/usr/lpp/psf/bin/asciinpe” xviii ACIF User’s Guide
Part 1. Information Common to AIX, OS/390, MVS, VM, and VSE Environments Copyright IBM Corp.
2 ACIF User’s Guide
Chapter 1.
Figure 1. How ACIF Fits into Advanced Function Presentation The figure shows the resources and the text data, which can be provided and used by various AFP and AFP-compatible products. With ACIF, data and resources can feed into ACIF for processing and can be sent to a customer-supplied archival and retrieval system, to the spool, or to the Viewer application of AFP Workbench for viewing.
With the files that ACIF creates, you can do the following: Use PSF to print the AFP document file. If you have specified resources in the AFP document file, PSF for AIX references the AFP resource file for the names and locations of the resources. The AFP document file must be concatenated to the end of the resource file before the file is printed. Use the Viewer application of AFP Workbench (hereafter referred to as “Workbench Viewer”) to view the AFP document file.
Figure 2. Using ACIF to Prepare Files for Viewing Figure 2 shows the path your data takes when you are preparing files for viewing with the Workbench Viewer. 1. The process begins with your application (1), which is the program that processes your print data. 2. Your application creates your print data (2a) and optionally creates ACIF processing parameters (2b). Resources are stored in the PSF resource libraries (2c). 3.
document are not present on the workstation where the Workbench Viewer is installed, you concatenate the resource file (3c) to the AFP document file. The order of concatenation must be as shown in Figure 2, with the document file concatenated last. 5. Transfer the needed files in binary format to the workstation. 6. Using the Workbench Viewer, view your indexed document. You can also print the document from the Workbench Viewer. Figure 3.
1. Run ACIF, specifying that the resource file (1b) be created along with the AFP document file (1a). If you are using ACIF on AIX and your resources reside on another operating system, you can use the AIX Network File System (NFS) to mount them to the AIX system where you are running ACIF. 2. If the print driver program (PSF) that manages jobs for your target printer runs on a different operating system than the one you run ACIF on, transfer the files in binary format to the system where PSF runs.
Tasks You Can Do with ACIF This section describes the three tasks for which you can use ACIF. The tasks are listed in the order in which they are described, not in any order in which they should be done. Converting data streams Indexing documents Retrieving resources Converting Data Streams ACIF processes the following input data streams to create a MO:DCA-P document.
using a page-definition (PAGEDEF) resource, in the same way as does PSF. For more information about line data, refer to Advanced Function Presentation: Programming Guide and Line Data Reference. Mixed-Mode Data: Mixed-mode data is a mixture of line-mode data, with the inclusion of some AFP structured fields, composed-text pages, and resource objects such as image, graphics, bar code, and text.
file in structured-field format. ACIF inserts these same structured fields in the index object file. (The tags are contained in Tagged Logical Element [TLE] structured fields, which are described in Appendix A, Helpful Hints and 36) You can use the indexing-tag structured fields to identify a group of pages.1Figure 5 shows the relationship between the group-level tags and the entries in the index object file. Figure 5.
account number, and you can retrieve and view the same statement using the account number. If the data value you want to use in an indexing tag is consistently located in the same place for each statement, you can specify ACIF parameters that create a separate group of pages for each statement. The ACIF parameters that you use in this case are the TRIGGERn, FIELDn, and INDEXn parameters.
Because ACIF can process different data streams with various file formats (carriage control characters, no carriage control characters, table-reference characters, and so on), it requires triggers to determine an anchor point from which it can locate the necessary index values. You may require multiple triggers to uniquely identify the start of a new statement.
location is the record containing the new-page carriage control character (for example, a skip-to-channel 1). The application would need to add the indexing trigger and attribute value to this record at a specified location on each statement in the print file. This allows ACIF to retrieve this information at processing time. (For information about different types of carriage control characters, see the description of the cctype parameter on 27 for AIX, or 89 for OS/390 or MVS, VM, and VSE.
specific typeface be included in the resource file. The only way to accomplish this is by using the resource exit.
| | | | | | | | | Workbench Viewer uses Adobe Type 1 or true type outline fonts when displaying documents. If the document references a font for which no Type 1 font is available at the workstation, Workbench Viewer can substitute an outline font for the requested font. Workbench Viewer matches the requested point size and attempts to match the typeface as closely as possible.
Document Composition Facility (DCF) Document Composition Facility (DCF) is a program used primarily to prepare and format documents for printing. It is another product that can be used with ACIF to index your data in the OS/390, MVS, VM, or VSE environments. Along with its many other features, DCF provides the ability to add both group-level and page-level indexing tags; whereas, with ACIF, you can add only group-level indexing tags. Only ACIF generates the index object file.
System Prerequisites The following section describes system prerequisites necessary to use ACIF in the AIX, OS/390, MVS, VM, and VSE environments. AIX Prerequisites Either one of the following AIX software products is required to use ACIF: | | | PSF for AIX Version 2.1 (program number 5765-505) with, minimally, the psf.acif option installed. This version of PSF for AIX requires IBM AIX for RISC System/6000 Version 3.2.5 (program number 5756-030) or higher. | Notes: 1. Installation of only psf.
VSE Prerequisites The following VSE software products are required to use ACIF: VSE/SP 4.1.2 or above VSE/ESA 1.1.0 or above PSF/VSE 2.2.0 (with APAR DY42845 for printing files that contain indexing tags) or PSF/VSE 2.2.1 or above. Note: You can use later versions or releases of these products. Each of the above products may require additional software products. Refer to their respective publications for the current list of system requirements. Chapter 1.
20 ACIF User’s Guide
Part 2. Using ACIF in the AIX Environment Copyright IBM Corp.
22 ACIF User’s Guide
Chapter 2. Using ACIF Parameters in AIX This section describes the acif command for AIX, including syntax rules, parameters, and values. Purpose Transforms S/370 line data and unformatted ASCII files into MO:DCA-P files for printing, viewing, archiving, and retrieving.
When the acif command processes any unrecognized or unsupported parameter, acif issues a message, ignores the parameter, and continues processing any remaining parameters. The acif command then stops processing. Though the parameters themselves are not case-sensitive, associated values, such as file names, attribute names, and directory names are case-sensitive.
Note: If the page definition does not specify fonts, and you have not specified any TRCs, your job will print, although the output may not be formatted correctly. If the page definition does not name any fonts, and you want the whole file to print with only one font, then you must: Specify trc=no. Use chars to indicate the single font in which the file should be printed. The acif command searches for resources in the following order: 1. Paths specified by the userlib parameter 2.
Figure 9. File Extensions for Resources Type of Resource File Extensions Searched (see note) Form definitions 1. 2. 3. 4. No file extension FDEF3820 FDEF38PP FDE Page definitions 1. 2. 3. 4. No file extension PDEF3820 PDEF38PP PDE Fonts, 240-pel resolution 1. 2. 3. 4. No file extension 240 FONT3820 FONT38PP Fonts, 300-pel resolution 1. No file extension 2. 300 2. FONT300 Page segments 1. 2. 3. 4. No file extension PSEG3820 PSEG38PP PSG Overlays 1. 2. 3. 4.
functions for viewing. The line2afp command is described in IBM Print Services Facility for AIX: Print Submission. The following parameters are used for just the conversion function of ACIF, with either the acif command or the line2afp command: cc, cctype, chars, fdeflib, fileformat, fontlib, formdef, imageout, inpexit, inputdd, insertimm, mcf2ref, msgdd, outexit, outputdd, ovlylib, pagedef, parmdd, pdeflib, prmode, pseglib, resexit, reslib, trc, and userlib.
(X'F0'), which represents double spacing, the double spacing will occur before the line is printed. m The file contains machine code carriage-control characters that are encoded in hexadecimal format. The use of machine code carriage-control characters cause the action of the carriage-control character to occur after the line of data is printed.
with more than one font, then the input file must contain table reference characters, and you must: Specify trc=yes. Use chars to indicate the fonts to be associated with each Table Reference Character (TRC). fontname1 is associated with TRC 0, fontname2 is associated with TRC 1, and so on. If the page definition does not name any fonts, and you want the whole file to print with only one font, then you must: Specify trc=no. Use chars to indicate the single font in which the file should be printed.
If you do not specify a chars parameter, and if no fonts are contained in the page definition you specified, the acif command uses the default font that is set in the printer’s hardware. comsetup=name Specifies the name of a COM setup file. A COM setup file is an AFP resource that contains instructions required when printing on a microfilm device. The value is: name Any valid COM setup file name.
code page identifier Any valid code page, which is a three-character decimal value (for example, 395) that defines an IBM-registered code page ACIF uses this code page identifier value when it creates a Coded Graphic Character Set Global Identifier Triplet X'01' in the Begin Document (BDT) structured field for the output file. For more information on this triplet, refer to Mixed Object Document Content Architecture Reference.
record Specifies the relative record number from the indexing anchor record. When ACIF is indexing the file, it uses the information specified in the triggern parameters to determine a page group boundary. When all of the specified triggern values are true, ACIF defines the indexing anchor record as the record where trigger1 is located. trigger1 becomes the reference point from which all indexing information is located. The supported range of values for record are ±0 to 255.
The first field in the example is located in the indexing anchor record (trigger1). The field is 20 bytes in length starting at the second byte of the record. The second field is located five records down from the indexing anchor record. The field is 10 bytes in length starting at the fifth byte of the record. The third field is located 15 records before the indexing anchor record. It is 5 bytes in length starting at byte 30. The fourth and fifth fields are literal (constant) values.
The acif command examines the first six bytes of the first line data record of the input file, to determine whether the input file is ASCII or EBCDIC. If ACIF determines that the input file is ASCII, ACIF looks for the ASCII newline character (X'0A') to delimit the end of a record. If ACIF determines that the input file is EBCDIC, ACIF looks for the EBCDIC newline character (X'25') to delimit the end of a record. If the input record is MO:DCA-P, no newline character is required.
fdefname Any valid form definition file name. The fdefname can be one to eight alphanumeric or national characters, including the two-character prefix, if there is one. The fdefname is case-sensitive. Note: If the file name of the form definition includes a file extension, do not use the file extension when specifying the form definition. For example, to use a form definition named memo.Fdef38PP, specify formdef=memo.
the attribute name. ACIF uses this parameter only when the file is indexed. Workbench Viewer displays this value along with the attribute name and index value. You can use the group name to select a group of pages to be viewed. Values are: index1 ACIF uses the value of index1. indexn ACIF uses the value of the specified index (index1, index2, index3,...index8). imageout={asis | ioca} Specifies the format of the image data produced by the acif command in the output document.
can be specified either as character data or hexadecimal data. (If the input file is anything other than ASCII, then the value must be specified as hexadecimal data.) The attribute name is a string from 1 to 250 bytes in length. ACIF does not perform any validity checking on the contents of the attribute name. fieldn[,fieldn...] Specifies one or more fieldn parameters that compose the index value. A maximum of 16 fieldn parameters can be specified.
filename A character string containing only those alphanumeric characters supported in AIX file names. indexobj={group | all | none} Specifies the type of information ACIF puts in the index object file. Values are: group Places only group-level entries into the index object file, which saves space. all Places both page-level and group-level entries into the index object file. Select all if you are indexing a file for use with the Workbench Viewer.
programname Any valid input record exit program name. The exit program name is case-sensitive. If the input file is unformatted ASCII, but the fonts you are using contain EBCDIC, not ASCII, code points (for example, you specify chars=GT15), you can specify one of the following exit programs supplied with PSF for AIX: /usr/lpp/psf/bin/apka2e Converts ASCII stream data to EBCDIC stream data.
msgdd=filename Specifies the name or the full path name of the file where the acif command writes error messages. If you specify the file name without a path, the acif command puts the error file into your current directory. If you do not specify msgdd, the acif command uses standard error for its message output. objconlib=pathlist Specifies the directories in which setup files are stored. A COM setup file consists of a MO:DCA structure called an object container.
You should specify the same value for the ovlylib parameter to the acif command as specified to PSF for AIX. In this way, the search paths and resources used at transform time are identical to the search paths and resources used at print time. For information on how PSF for AIX selects resources, refer to IBM Print Services Facility for AIX: Print Administration. pagedef=pdefname Specifies the file name of the page definition.
If you use pagedef to specify an inline page definition that is different than the actual page definition used inline, the acif command looks for the page definition in the page definition search path instead of the inline page definition. An input file can contain multiple page definitions, but only one page definition can be used by the acif command. If a file contains more than one inline page definition, and you specify pagedef=pdefname, ACIF uses the first inline page definition named pdefname.
| | | prmode={SOSI1 | SOSI2 | SOSI3 | aaaaaaaa} Specifies the type of data in the input file and whether the acif command must perform optional processing of that data. Values are: | | | | | SOSI1 Specifies that each shift-out, shift-in code be converted to a blank and a Set Coded Font Local text control. The SOSI1 data conversion is the same as the SOSI1 data conversion performed by PSF for OS/390, PSF/MVS, PSF/VM, and PSF/VSE.
the paths specified by the PATH environment variable. If you do not specify this parameter, the acif command does not use a resource exit program. The exit program name is case-sensitive. The value is: programname Any valid resource exit program name. reslib=pathlist Specifies the paths for the system resource directories. System resource directories typically contain resources that are shared by many users.
| | fdef Specifies that the form definition (formdef) used in processing the file will be included in the resource file. | | pseg Specifies that all page segments required to print or view the output document file will be included in the resource file. | | ovly Specifies that all overlays required to print or view the output document file will be included in the resource file.
| | | | | | type, you must specify both resource types. For example, if you request that just page segments be saved in a resource file, and the page segments are included in overlays, the page segments will not be saved in the resource file, because the overlays will not be searched. In this case, you would have to request that both page segments and overlays be saved. trc={yes | no} Specifies whether the input file contains Table Reference Characters (TRCs).
condition and terminates processing if an ‘*’ is specified with any triggern parameter other than trigger1. The supported range of values for record is 0 to 255. column | * Specifies the byte offset from the beginning of the record where the trigger value is located. This value can be specified in absolute terms (for example, 10) or as ‘*’, which results in ACIF scanning the record from left to right looking for the trigger value. A value of 1 refers to the first byte in the record.
Notes: 1. ACIF requires that at least one triggern or fieldn value appear within the page range specified by the indexstartby parameter. If no triggern or fieldn parameter is satisfied within the indexstartby page range, ACIF stops processing. 2. At least one triggern or fieldn must exist on the first page of every unique page group. ACIF cannot detect an error condition if triggern or fieldn is missing, but the output may be incorrectly indexed. 3.
Examples The examples contained in this section show how to use ACIF processing parameters for conversion, resource retrieval, specifying fonts, and identifying the location of resource directories. For indexing examples, see Chapter 3, “Example of an ACIF Application in AIX” on page 53.
are using a page definition supplied with PSF for AIX (P1A6462), and the page definition does not name any fonts. To use the three fonts, specify the following: acif inputdd=MYFILE.asc outputdd=MYFILE.afp chars=H2B2,N2ð2,N292 \ trc=yes pagedef=P1Að6462 formdef=F1A1ð11ð You specified the font names with the chars parameter. Because you need to use fonts with the appropriate ASCII code points for your unformatted ASCII input, you referred to Chapter 5, “IBM AFP Fonts for ASCII Data” on page 77.
Implementation Specifics The acif command is part of PSF for AIX, and is installed with the psf.acif option. Files /usr/lpp/psf/bin/acif The executable program (the acif command) /usr/lpp/psf/acif/apkinp.c, apkind.c, apkres.c, apkout.c, apka2e.c, asciinp.c, asciinpe.
52 ACIF User’s Guide
Chapter 3. Example of an ACIF Application in AIX The line-data application used as the example in this section is shown in Figure 10 on page 54. The application generates telephone bills. The objective is to make the billing application output available on customer service representatives’ workstations. Then, when a customer calls with a billing inquiry, the representative can view the bill in the same format as the customer’s printed copy.
For an explanation of any parameter not specifically described in this section, see the description for that parameter in Chapter 2, “Using ACIF Parameters in AIX” on page 23. Figure 10.
The Input File Figure 11 shows the line data file currently used to print the telephone bills. Carriage Control ¦ Line ----+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8 ð 1 WILLIAM R. SMITH 528ð SUNSHINE CANYON DR BOULDER CO 8ðððð-ðððð TOTAL AMOUNT DUE: $56.97 DATE DUE: JAN 29, 1993 5 ð 1 BASIC SERVICE. . . . . . . . . . . . . .$3ð.56 2 LONG DISTANCE CHARGES . . . . . . . . .$26.41 1ð ð TOTAL . . . .$56.97 ð BILL DATE: JAN 11, 1993 ACCOUNT NUMBER: 3ð3-222-3456-6B 15 $66.
Using a Parameter File with ASCII Input Data A parameter file created for use with ASCII input data is shown in Figure 12. To use a parameter file, you specify the parameter file name with the acif command parmdd parameter.
every record in the file for a trigger value of ‘1’ in column 1 of the data. To do this, specify: trigger1 = \,1,'1' When ACIF finds a record that contains a ‘1’ in column 1, that record becomes the indexing anchor record. Subsequent triggern parameters are defined relative to the indexing anchor record.
- 2 lines down from the indexing anchor record, 50 columns across, 30 bytes in length index5='Date Due',field5 – 'Date Due' is the 5th index attribute – field5 maps to the field5 index value, which is: - 4 lines down from the indexing anchor record, 60 columns across, 12 bytes in length The result of using these indexing parameters is that the first page of each bill in the ACIF output file will contain indexing tags for each of the five indexing attributes.
/\ example phone bill \/ /\ DATA CHARACTERISTICS \/ /\ carriage control used \/ /\ EBCDIC ANSI carriage controls \/ /\ coded font \/ /\ code page identifier \/ /\ FIELD AND INDEX DEFINITION \/ field1=13,66,15 /\ Account Number data field \/ field2=ð,5ð,3ð /\ Name data field \/ field3=1,5ð,3ð /\ Address data field \/ field4=2,5ð,3ð /\ City, State, Zip data field \/ field5=4,6ð,12 /\ Date Due data field \/ index1=X'C1838396A495A34ðD5A494828599',field1 /\ 1st index attr (Account Number) \/ index2=X'D5819485',
Subsequent triggern parameters are defined relative to the indexing anchor record. In this example, you want to ensure that the page being indexed is the first page of the bill, which is the only page in the bill that has the hexadecimal string for the text ‘ACCOUNT NUMBER’ starting at byte 50 in the 13th record following the anchor record.
index5=X'C481A3854ðC4A485',field5 – X'C481A3854ðC4A485' is ‘Date Due’, the 5th index attribute – field5 maps to the field5 index value, which is: - 4 lines down from the indexing anchor record, 60 columns across, 12 bytes in length The result of using these indexing parameters is that the first page of each bill in the ACIF output file will contain indexing tags for each of the five indexing attributes.
Determining the Form Definition and the Page Definition To format and print the job, you need to specify page definition and form definition resources.
In the following example, the index object file, the resource file, and the document file are combined to create a new file that contains all three files: cat INDXOBJ RESDATA OUTDOC > NEWFILE In the following example, the resource file and the document file are added on to the end of the existing index object file: cat RESDATA OUTDOC >> INDXOBJ You may use whichever method you prefer to concatenate the files. You do not need to do both.
Access the AIX directory where the concatenated document file currently resides. Enter: cd AIXdirectoryname The file must be transferred in binary format, so you must now enter: bin To transfer a concatenated document file named NEWFILE, enter: get NEWFILE The file will now be copied to the workstation, where you may open it for viewing with Workbench Viewer.
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 run a user-written program and return control of processing to ACIF after your user-written program ends. ACIF provides data at each exit that can serve as input to the user-written program.
For more information about compiling user exit programs, refer to IBM InfoPrint Manager for AIX Administrator's Guide, S544-5595, or IBM Print Services Facility for AIX: Print Administration. Input Record Exit ACIF provides an exit that enables you to add, delete, or modify records in the input file. You can also use the exit to insert indexing information. The program invoked at this exit is defined in the ACIF inpexit parameter. This exit is called after each record is read from the input file.
record (Bytes 9–12) A pointer to the first byte of the input record including the carriage control character. The record resides in a buffer that resides in storage allocated by ACIF, but the exit program is allowed to modify the input record. reserved1 (Bytes 13–16) These bytes are reserved for future use. recordln (Bytes 17–18) Specifies the number of bytes (length) of the input record. If the input record is modified, this parameter must also be updated to reflect the actual length of the record.
Using the ACIF User Input Record Exits The apka2e input record exit program translates data that is encoded in ASCII (code set IBM-850) into EBCDIC (code set IBM-037) encoded data. You should use this exit when your print job requires fonts such as GT12, which has only EBCDIC code points defined.
For more information on using and modifying these programs, refer to the prolog of the asciinp.c source file that is provided with PSF for AIX in the /usr/lpp/psf/acif directory. Index Record Exit ACIF provides an exit that allows you to modify or ignore the records that ACIF writes in the index object file. The program invoked at this exit is defined by the ACIF indxexit parameter. This exit receives control before a record (structured field) is written to the index object file.
request (Byte 15) Specifies how the record is to be processed by ACIF. On entry to the exit program, this parameter is X'00'. When the exit program returns control to ACIF, this parameter must have the value X'00' or X'01' where: X'00' X'01' Specifies that the record be processed by ACIF. Specifies that the record not be processed by ACIF. A value of X'00' on entry to the exit program specifies that the record be processed. If you want to ignore the record, change the request byte value to X'01'.
work (Bytes 1–4) A pointer to a static, 16-byte memory block. The exit program can use this parameter to save information across calls (for example, pointers to work areas). The 16-byte work area is aligned on a full word boundary and is initialized to binary zeros prior to the first call. The user-written exit program must provide the code required to manage this work area. pfattr (Bytes 5–8) A pointer to the print file attribute data structure.
Resource Exit ACIF provides an exit that enables you to “filter” resources from being included in the resource file. If you want to exclude a specific type of resource (for example, an overlay), you can control this with the restype parameter. This exit is useful in controlling resources at the file name level. For example, assume you were going to send the output of ACIF to PSF for AIX and you only wanted to send those fonts that were not shipped with the PSF for AIX product.
| | | | X'03' X'05' X'06' X'40' X'41' X'42' X'FB' X'FC' Specifies Specifies Specifies Specifies Specifies Specifies Specifies Specifies a GOCA (graphics) object a BCOCA (barcode) object an IOCA (IO image) object a font character set. a code page. a coded font. a page segment. an overlay. ACIF does not call this exit for the following resource types: Page definition The page definition (pagedef) is a required resource for processing line-mode application output.
Non-Zero Return Codes If ACIF receives a non-zero return code from any exit program, ACIF issues message 0425-412 and terminates processing. Attributes of the Input Print File ACIF provides information about the attributes of the input print file in a data structure available to ACIF’s user exits. Figure 18 shows the format of this data structure.
trc (Bytes 49–51) The value of the trc parameter as specified on the acif command. ACIF uses the default value if this parameter is not explicitly specified. Notes: 1. Each of the previous character values is left-justified; that is, padding blanks are added to the end of the string. For example, if pagedef=P1TEST is specified on the acif command, the page definition value in the above data structure is ‘P1TEST’. 2. Exit programs cannot change the values supplied in this data structure.
76 ACIF User’s Guide
Chapter 5. IBM AFP Fonts for ASCII Data When you specify a coded font name with the chars parameter of the acif command or the line2afp command, the font name is limited to four characters, excluding the two-character prefix. | | | | | | | | | | | Figure 19 provides a list of the IBM Core Interchange Fonts for use with unformatted ASCII input data. Because these fonts have eight-character names, the table also provides a list of six-character short names.
Figure 19 (Page 2 of 2).
Part 3. Using ACIF in the OS/390, MVS, VM, and VSE Environments Copyright IBM Corp.
80 ACIF User’s Guide
Chapter 6. Using ACIF in OS/390, MVS, VM, and VSE This chapter describes how to invoke ACIF in the OS/390, MVS, VM, and VSE environments. Using ACIF in the OS/390 and MVS Environments Figure 20 contains sample JCL to invoke ACIF to process print output from an application. //USERAPPL EXEC PGM=user application //PRINTOUT DD DSN=print file,DISP=(NEW,CATLG) //\ //ACIF EXEC=APKACIF,PARM=[[ 'PARMDD=ddname ][,MSGDD=ddname']],REGION=3M //INPUT DD DSN=\.USERAPPL.
MSGDD Defines the DDname for the message data set. When ACIF processes a print data set, it can issue a variety of informational or error messages. If MSGDD is not specified as an invocation parameter, ACIF uses SYSPRINT as the default DDname and stops processing if SYSPRINT is not defined. Although the sample shows a specified REGION size of 3MB, this value can vary, depending on the complexity of the input data and the conversion and indexing options requested.
USERAPPL FILEDEF INPUT DISK filename filetype filemode FILEDEF OUTPUT DISK filename filetype filemode (LRECL 32756 BLKSIZE 3276ð FILEDEF RESOBJ DISK filename filetype filemode (LRECL 32756 BLKSIZE 3276ð FILEDEF INDEX DISK filename filetype filemode (LRECL 32756 BLKSIZE 3276ð FILEDEF SYSIN DISK filename filetype filemode FILEDEF SYSPRINT DISK filename filetype filemode FILEDEF TRACE DISK filename filetype filemode APKACIF (PARMDD ddname MSGDD ddname Figure 21.
PARMDD Defines the DDname for the file containing the ACIF processing parameters. If PARMDD is not specified, ACIF uses SYSIN as the default DDname and terminates processing if SYSIN is not defined. MSGDD Defines the DDname type for the message file. When ACIF processes a print file, it can issue a variety of informational or error messages. If MSGDD is not specified as an invocation parameter, ACIF uses SYSPRINT as the default DDname and terminates processing if SYSPRINT is not defined.
Explaining the VSE JCL Statements The statements in Figure 22 on page 84 are explained as follows. For more information about programming JCL for VSE, refer to Print Services Facility/VSE: Application Programming Guide. PRNTOUT Defines the output file produced from the application. The application output cannot be spooled to POWER, because ACIF does not read data from the spool. The user print file is the name of the print data set created by your application.
86 ACIF User’s Guide
| | Chapter 7. Using ACIF Parameters in OS/390, MVS, VM, and VSE This chapter describes ACIF syntax rules and parameters for OS/390, MVS, VM, and VSE. Many of the parameters specified to ACIF are the same as the parameters specified to PSF when you print a job. For those parameters that are common to both PSF and ACIF, you should specify the same value to ACIF as specified to PSF. Notes: 1.
When ACIF processes any unrecognized or unsupported parameter, it issues a message, ignores the parameter, and continues processing any remaining parameters until the end of the file, at which time it terminates processing. If the same parameter is specified more than one time, ACIF uses the last value specified. For example, if the following is specified: CPGID=ð37 CPGID=395 ACIF uses code page 395. Comments must be specified using “/*” as the beginning delimiter.
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Figure 23 (Page 2 of 2). ACIF Parameters, Tasks, and Operating Systems ACIF Parameters Task Usage Key Operating System MCF2REF={CPCS | CF} C,R OS/390, MVS, VM, VSE OBJCONLIB=data set name1[,data set name2][,data set name...
Z The file contains ANSI carriage-control characters that are encoded in ASCII. The carriage-control characters are the ASCII hexadecimal values that directly relate to ANSI carriage-controls, which cause the action of the carriage-control character to occur before the line is printed. For example, if the carriage-control character is zero (X'30'), which represents double spacing, double spacing will occur before the line is printed.
| EXAMPLE | | In the following example, two fonts are specified: X0GT10 (Gothic 10 pitch) and X0GT12 (Gothic 12 pitch): | CHARS=GT1ð,GT12 | Notes: | | | | | 1. You can specify fonts in the CHARS parameter only if you want the entire file printed in a single printing direction. ACIF uses the fonts that have 0° character rotation for the specified direction. When a file requires fonts with more than one printing direction or character rotation, you must specify the fonts in the page definition.
If you specify COMSETUP=DUMMY but the file does not include an inline COM setup file, ACIF looks for the COM setup file named DUMMY. If the name specified in the COMSETUP parameter does not match the name of an inline COM setup file, ACIF looks for the COM setup file in the COMSETUP search path. An input file can contain multiple COM setup files, but only one COM setup file can be used for printing.
| Notes: | | 1. Data sets must be specified as fully-qualified names without quotation marks. | | | | 2. If the libraries specified for FORMDEF are not specified in the same order used by the PSF start-up procedure, the printed and converted results may differ. For information on how PSF selects resources, refer to PSF for OS/390: Customization . | | 3. For systems before MVS/DFP Version 2.3, data sets must be concatenated with the largest block size first. | | 4.
applications that use a specific carriage control character to define page boundaries (for example, skip to channel 1), consider defining the value of the carriage control character as one of the TRIGGERn parameters. The supported range of values for column are 1–32 756. If the specified value exceeds the physical length of the record, ACIF reports an error condition and terminates processing. length Specifies the number of contiguous bytes (characters) starting at column that compose this field.
| | continues the search with data set name2, and so on, until it either locates the requested resource or exhausts the list of specified data sets. | EXAMPLE | FONTLIB=SYS1.FONTLIB,USER.FONTLIB | | If USERLIB is also specified, ACIF searches for the resource in the data sets specified in USERLIB before searching the data sets identified in FONTLIB. | Notes: | | 1. Data sets must be specified as fully-qualified names without quotation marks. | | | | 2.
| | | | | FORMDEF=fdefname Specifies the complete file name (in OS/390, MVS and VSE, the member name) of the form definition. The fdefname can be from 1 to 8 alphanumeric or national characters. Unlike PSF for OS/390, PSF/MVS, PSF/VM, and PSF/VSE, ACIF does not require the name to begin with a F1 prefix, but if the name does begin with F1, you cannot omit it.
| | | – In VSE, specify variable length records for the record format (variable blocked with ANSI carriage control characters [VBA] or variable blocked with machine carriage control characters [VBM]). | | | You can include more than one inline form definition in an input file, and you can change the form definition name in the FORMDEF parameter on different printing jobs to test different form definitions. | Notes: | | | 1.
Note: If one or more TRIGGERn parameters is specified (that is, ACIF will index the file), at least one INDEXn parameter must be specified, and that index must be comprised of at least one FIELDn parameter value that is not a literal. ACIF reports an error condition and terminates processing if this rule is not satisfied. ‘attribute name’ Specifies a user-defined attribute name to be associated with the actual index value. For example, assume INDEX1 is a person's bank account number.
DD statement. The result of such an occurrence is that ACIF will terminate abnormally. Variable blocked format Physical sequential format INDEXDD=INDEX | filename (DEVT=TAPE | DISK) (VSE) Specifies the file name that appears on the DLBL or TLBL JCL statement, a 1–7 character string containing only those alphanumeric characters supported in the operating environment.
INPUTDD=INPUT | DDname (OS/390, MVS and VM) Specifies the DDname for the file ACIF will process. ddname is a 1–8 byte character string containing only those alphanumeric characters supported in the operating environment. When ACIF processes a file, it reads from this DDname. If INPUTDD is not specified, ACIF uses INPUT as the default DDname.
(OUTPUTDD). If this parameter is not specified, no output record exit is used. See “Output Record Exit” on page 126 for more detailed information. OUTPUTDD=OUTPUT | DDname (OS/390, MVS, and VM) Specifies the DDname for the output document file ACIF produces when it processes a file. The DDname is a 1–8 byte character string containing only those alphanumeric characters supported in the operating environment. When ACIF processes a print file, it writes the resultant converted print data to this DDname.
| Notes: | | 1. Data sets must be specified as fully-qualified names without quotation marks. | | | | 2. If the libraries specified for OVLYLIB are not specified in the same order used by the PSF start-up procedure, the printed and converted results may differ. For information on how PSF selects resources, refer to PSF for OS/390: Customization . | | 3. For systems before MVS/DFP Version 2.3, data sets must be concatenated with the largest block size first. | | | | | 4.
| | | | ACIF does not support a parameter equivalent to the LINECT parameter on the /*JOBPARM, /*OUTPUT, and OUTPUT JCL statements. The maximum number of lines processed on a page is defined in the page definition. The page definition can be located: | | | | | | Inline in the file In a user library referenced in the USERLIB parameter (OS/390 and MVS only) In a library referenced in the PDEFLIB parameter In a library referenced in the // LIBDEF PHASE,SEARCH=(...
| Notes: | | 1. If the PAGEDEF parameter is not specified, and the print file contains line-mode data, ACIF reports an error condition and terminates processing. | | 2. If you specify PAGEDEF=DUMMY, and you do not include an inline page definition, ACIF reports an error condition and terminates processing. | | | 3. A page definition is required for processing line-mode data.
Notes: 1. The file types must conform to CMS naming conventions. | | | | 2. This is a required parameter if the print file contains any line-mode data and USERLIB is not specified. If this parameter is not specified, and the print file contains any line-mode data, ACIF reports an error condition and terminates processing. PDEFLIB This parameter is not used for VSE. Page-definition resources are located in the library defined by the // LIBDEF PHASE,SEARCH=(...) JCL statement.
| EXAMPLE | PSEGLIB=SYS1.PSEGLIB,USER.PSEGLIB | | If USERLIB is also specified, ACIF searches for the resource in the files specified in USERLIB before searching the files identified in PSEGLIB. | Notes: | | 1. The data sets must be specified as fully-qualified names without quotation marks. | | | | 2. If the libraries specified for PSEGLIB are not specified in the same order used by the PSF start-up procedure, the printed and converted results may differ.
| | | | | | | RESFILE=SEQ | PDS Specifies the format of the resource file (OS/390 and MVS only) created by ACIF. ACIF can create either a sequential data set (SEQ) or a partitioned data set (PDS) from the resources it retrieves from the PSF for OS/390 or PSF/MVS resource libraries. If this parameter is not specified, ACIF writes to the DDname specified in the RESOBJDD parameter, assuming a sequential format.
If a record length other than 32756 is specified, it is possible that ACIF will produce a record of length greater than that which is allowed by the DLBL or TLBL JCL statement. The result of such an occurrence is that ACIF will terminate abnormally. Assigned to programmer logical unit 008 | | | | | RESTYPE=NONE | ALL | [FDEF][, PSEG][,OVLY][,FONT][, COCA][.GOCA][,IOCA] Specifies the type of AFP print resources ACIF should retrieve from the resource libraries for inclusion in the resource file (RESOBJDD).
| | | | | | B1 for BCOCA objects G1 for GOCA objects I1 for IOCA objects S1 for page segments ACIF supports the specification of FDEF, FONT, OVLY, BCOCA, GOCA, IOCA, and PSEG in any combination. The following example illustrates this.
Notes: 1. The order in which the fonts are specified in the CHARS parameter establishes which number is assigned to each associated TRC. For example, the first font specified is assigned 0, the second font 1, and so on. 2. If TRC=YES is specified, but no TRCs are contained in the file, the first character (or second if carriage control characters are used) of each line is interpreted as the font identifier.
length of the record, ACIF considers the comparison “false” and continues processing. EXAMPLE The following example illustrates the use of a carriage control character as a trigger. TRIGGER1=\,1,X'F1' TRIGGER2=ð,5ð,'ACCOUNT:' TRIGGER3=3,75,'PAGE 1' /\ Look for Skip-to-Channel 1 /\ Find account number /\ Find page 1 In this example, TRIGGER1 instructs ACIF to scan every record, looking for the occurrence of X'F1' in the first byte.
libraries defined for that resource type (for example, PDEFLIB for page definitions). The libraries you specify can contain any AFP resources (fonts, page segments, overlays, page definitions, or form definitions). If Resource Access Control Facility (RACF) is installed on your system, RACF checks the authority of the USER ID requesting access to a user library (data set). If ACIF is not authorized to allocate the data set, it reports an error condition and terminates processing. EXAMPLE USERLIB=USER.
Chapter 8. Example: ACIF Application in OS/390, MVS, VM, or VSE In this example, a line-data application generates telephone bills, as shown in Figure 24 on page 114. The objective is to make the billing application output available on customer service representatives' workstations, so that when a customer calls with a billing inquiry, the representative can view the bill in the same format as the customer's printed copy.
Figure 24.
Input File Figure 25 shows the file currently used to print the bills. Carriage Control ¦ Line ----+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8 ð 1 WILLIAM R. SMITH 528ð SUNSHINE CANYON DR BOULDER CO 8ðððð-ðððð TOTAL AMOUNT DUE: $56.97 DATE DUE: JAN 29, 1993 5 ð 1 BASIC SERVICE. . . . . . . . . . . . . .$3ð.56 2 LONG DISTANCE CHARGES . . . . . . . . .$26.41 1ð ð TOTAL . . . .$56.97 ð BILL DATE: JAN 11, 1993 ACCOUNT NUMBER: 3ð3-222-3456-6B 15 $66.79 $66.79 $ð.ðð $ð.ðð $56.
Note: The example in Figure 26 on page 116 creates a sequential data set. If you need a partitioned data set, change the parameters as follows: set RESFILE=PDS and set the SPACE and DSORG parameters in the DD statement of the data set named by the RESOBJDD parameter to SPACE=(12288,(150,15,15)),DSORG=PO. Failure to set these parameters as described may produce a RESOBJDD data set that is unusable. //job... JOB ...
VM CMS Commands to Invoke ACIF FILEDEF FILEDEF FILEDEF FILEDEF FILEDEF APKACIF INPUT DISK ACIFEX2 SYSIN A OUTPUT DISK APKACIF OUTPUT A (LRECL 32756 BLKSIZE 3276ð RECFM VB INDEX DISK APKACIF INDEX A (LRECL 32756 BLKSIZE 3276ð RECFM VB RESLIB DISK APKACIF RESLIB A (LRECL 32756 BLKSIZE 3276ð RECFM VB SYSPRINT DISK APKACIF SYSPRINT A Where file ACIFEX2 SYSIN A contains the following: /\ Pubs example phone bill /\ DATA CHARACTERISTICS CC = YES /\ carriage control used CCTYPE = A /\ carriage control type CHARS
// // // // // // // // // // // // // // // // JOB LIBDEF ASSGN ASSGN DLBL EXTENT ASSGN DLBL EXTENT ASSGN DLBL EXTENT ASSGN DLBL EXTENT EXEC PHASE,SEARCH=(PRD2.AFP) SYSLST,X'FEE' SYSðð6,2ð1 INPUT,'APKACIF.INPUT',ð,SD SYSðð6,SYSWK1,1,1,92ðð,13 SYSðð7,2ð1 OUTPUT,'APKACIF.OUTPUT',ð,SD SYSðð7,SYSWK1,1,1,9213,45 SYSðð8,2ð1 RESOBJ,'APKACIF.RESLIB',ð,SD SYSðð8,SYSWK1,1,1,9258,15 SYSðð9,2ð1 INDEX,'APKACIF.
Date due The task is to specify the ACIF indexing parameters so that the first page of each bill includes group-level indexing tags containing the values of all five of these attributes. To generate these indexing attributes, specify the TRIGGER1 parameter first, because ACIF always scans for the data specified in TRIGGER1 first.
FIELD2 0 lines down (in indexing anchor record), 50 columns across, 30 bytes in length INDEX3 'Address', field3 'Address' index attribute field3 maps to FIELD3 index value FIELD3 1 line down from indexing anchor record, 50 columns across, 30 bytes in length INDEX4 'City, State, Zip', field4 'City, State, Zip', index attribute field4 maps to FIELD4 index value FIELD4 2 lines down from indexing anchor record, 50 columns across, 30 bytes in length INDEX5 'Date Due',field5 'Date Due' index attribute fiel
ACIF Output The ACIF job creates the following output files: Type of File MVS or OS/390 VM VSE Document file, including indexing structured fields APKACIF.OUTPUT APKACIF OUTPUT APKACIF.OUTPUT Index object file APKACIF.INDEX APKACIF INDEX APKACIF.INDEX Resource file APKACIF.RESLIB APKACIF RESLIB APKACIF.RESLIB Message file listing: APKACIF.SYSPRINT APKACIF SYSPRINT APKACIF.
122 ACIF User’s Guide
Chapter 9. User Exits and Attributes of the Input Print File in OS/390, MVS, VM, and VSE This appendix contains Product-sensitive Programming Interface and Associated Guidance Information. The appendix describes the four user exits provided with ACIF and describes the information ACIF provides to the exits about the attributes of the input print file. User Programming Exits ACIF provides four programming exits, so that an installation can customize the program.
PARMLIST WORK@ PFATTR@ RECORD@ DSECT DS DS DS DS RECORDLN DS DS REQUEST DS EOF DS A A A A H H X C Parameters for the input record exit Address of 16-byte static work area Address of print-file-attribute information Address of the input record Reserved for future use Length of the input record Reserved for future use Add, delete, or process the record EOF indicator Figure 30.
Note: Only one record can reside in the buffer at any time. EOF (Byte 22) Specifies an end-of-file (EOF) indicator. This indicator is a 1-byte character code that specifies whether an EOF condition has been encountered. When EOF is signalled (EOF value = “Y”), the last record has already been presented to the input exit, and the input file has been closed. The pointer RECORD@ is no longer valid. Records cannot be inserted when EOF is signalled.
RECORD@ (Bytes 9–12) A pointer to the first byte of the index record, including the carriage control character. The record resides in a 32KB buffer (where KB equals 1024 bytes). The buffer resides in storage allocated by ACIF, but the exit program is allowed to modify the index record. RECORDLN (Bytes 13–14) Specifies the length, in bytes, of the index record. If the index record is modified, this parameter must also be updated to reflect the actual length of the record.
PARMLIST WORK@ PFATTR@ RECORD@ RECORDLN REQUEST EOF DSECT DS DS DS DS DS DS A A A H X C Parameters for the output record exit Address of 16-byte static work area Address of print-file-attribute information Address of the record to be written Length of the output record Delete or process the record Last call indicator Figure 32.
Records cannot be inserted when EOF is signalled. The following are the only valid values for this parameter: Y Specifies that the last record has been written. N Specifies that the last record has not been written. This end-of-file flag, used as a last-call indicator, allows the exit program to return to ACIF. The exit program cannot change this parameter. Resource Exit ACIF provides an exit that enables you to “filter” resources from being included in the resource file.
RESNAME (Bytes 9–16) Specifies the name of the requested resource. This value cannot be modified (changed) by the exit program. RESTYPE (Byte 17) Specifies the type of resource to which the name refers. This is a 1-byte hexadecimal value, where: | X'03' Specifies a GOCA (graphics) object | X'05' Specifies a BCOCA (barcode) object | X'06' Specifies a IOCA (IO image) object X'40' Specifies a font character set. X'41' Specifies a code page. X'42' Specifies a coded font. X'FB' Specifies a page segment.
EOF (Byte 19) An end-of-file (EOF) indicator. This indicator is a 1-byte character code that signals when ACIF has finished writing the resource file. When EOF is signalled (EOF value = “Y”), the last record has already been presented to the resource exit. The pointer RECORD@ is no longer valid. Records cannot be inserted when EOF is signalled. The following are the only valid values for this parameter: Y Specifies that the last record has been written.
PFATTR CC CCTYPE CHARS FORMDEF PAGEDEF PRMODE TRC DSECT DS DS DS DS DS DS DS CL3 CL1 CL2ð CL8 CL8 CL8 CL3 Print File Attributes Carriage controls? - 'YES' or 'NO ' Carriage control type - A (ANSI) or M (Machine) CHARS values, including commas (eg. GT12, GT15) Form Definition (FORMDEF) Page Definition (PAGEDEF) Processing mode Table Reference Characters - 'YES' or 'NO ' Figure 34.
example, if 'P1TEST␣␣' is the page definition value, and an exit program changes the value to 'P1PROD␣␣', ACIF still uses 'P1TEST␣␣'. 3. This data structure showing the attributes of the print file is provided for informational purposes only.
Chapter 10. ACIF Messages for OS/390, MVS, VM, and VSE ACIF prints a message list at the end of each compilation. A return code of 0 means that ACIF completed processing without any errors. ACIF supports the standard return codes. Notes: 1. ACIF messages contain instructions for the PSF system programmer. Please show your system programmer these messages, because they are not contained in the PSF messages publication. | | | 2.
provide additional information. Additional error messages may not always be accurate. Message 101 may occur after many error conditions, because ACIF attempts to locate the end of the resource containing the error as part of its recovery procedure. General Messages General error messages are not limited to a particular resource, which is why they are considered general error conditions. Some general errors are limited to a few resources, while others may occur in any resource. .
System Programmer Response: See the specific error conditions described in the accompanying messages to determine an appropriate response. APK104S DATA IN AN INPUT RECORD OR RESOURCE IS INVALID: structured field STRUCTURED FIELD IS NOT ALLOWED OR FORMS AN INVALID SEQUENCE. APK106I Explanation: The structured field identified in this message is either out of sequence or invalid in an object. The record may be line data.
APK109I THE ERROR REPORTED ABOVE WAS CAUSED BY THE RESOURCE resource name IN AN EXTERNAL LIBRARY OR AN INLINE RESOURCE. Explanation: This message is issued in addition to the message that describes the error. The object identified in the accompanying message was either a resource being processed from an external library or an inline resource. The previous error message, APK108I, identified the member as a page definition, form definition, font, code page, font character set, page segment, or an overlay.
Data Referencefor more information about the structured field. If the structured field has no error, the error may be an ACIF logic error. If you used a program to create the structured fields for the print data set or the resource, contact your system programmer. System Programmer Response: If an IBM licensed program was used to create the structured fields for the print data set or the resource with the error, verify that the input to that program was valid.
System Programmer Response: If an IBM licensed program was used to create the structured fields for the print data set or the resource with the error, verify that the input to that program was valid. If the input was valid, refer to Advanced Function Printing: Diagnosis Guidefor assistance in determining the source of the problem. APK118W UNSUPPORTED STRUCTURED FIELD structured field code WAS IGNORED, AND, IF IT BEGAN AN OBJECT, THE OBJECT WAS IGNORED.
APK135I System Programmer Response: If an IBM licensed program was used to create the structured fields for the print data set or the resource with the error, verify that the input to that program was valid. If the input was valid, refer to Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. DATA IN A FORMDEF RESOURCE IS INVALID: DUPLICATE OVERLAY LOCAL IDENTIFIER WAS FOUND IN THE structured field STRUCTURED FIELD.
System Programmer Response: If an IBM licensed program was used to create the structured fields for the form definition with the error, verify that the input to that program was valid. If the input was valid, refer to Advanced Function Printing: Diagnosis Guidefor assistance in determining the source of the problem. APK141S DATA IN A FORMDEF RESOURCE IS INVALID: MEDIUM SUPPRESSION TOKEN NAME IS REPEATED IN MSU STRUCTURED FIELD.
no errors, the error may be an ACIF logic error. If you used a program to create the structured fields for the form definition, contact your system programmer. System Programmer Response: If an IBM licensed program was used to create the structured fields for the form definition with the error, verify that the input to that program was valid. If the input was valid, refer to Advanced Function Printing: Diagnosis Guidefor assistance in determining the source of the problem.
User Response: If you created the structured fields for the form definition, either reduce the number of copy groups in the Medium Copy Count (MCC) structured field or reduce the number of modifications specified in the Medium Modification Control (MMC) structured field. Otherwise, split these functions between two or more form environment groups in two or more medium maps.
If you did not intend to print line data, and you used a program to create the structured fields for the print data set, ensure that all composed-text data records begin with the X'5A' control character. If you did not intend to print line data, and you used a program to create the structured fields for the print data set, contact your system programmer. System Programmer Response: No response is necessary.
APK166S DATA IN AN INPUT RECORD OR RESOURCE IS INVALID: AN ENTRY IN A MCF STRUCTURED FIELD CONTAINS AMBIGUOUS IDENTIFICATION. Explanation: Two ways to identify a font in the Map Coded Font (MCF) structured field are either with a Coded Font Name parameter or with a combination of the Font Character Set Name parameter and the Code Page Name parameter.
Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. about the structured field. If the MCC and MMC have no errors, the error may be an ACIF logic error. If you used a program to create the structured fields for the form definition, contact your system programmer. APK171S DATA IN AN INPUT RECORD OR RESOURCE IS INVALID: FONT LOCAL IDENTIFIER VALUE IS NOT ACCEPTABLE IN THE structured field STRUCTURED FIELD.
User Response: If you created the structured fields for the form definition, correct the MCC or MMC structured field. Refer to Mixed Object Document Content Architecture Reference for more information about the structured field. If the MCC and MMC have no errors, the error may be an ACIF logic error. If you used a program to create the structured fields for the form definition, contact your system programmer.
program was valid. If the input was valid, refer to Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. APK191S DATA IN A FORMDEF RESOURCE IS INVALID: THE SUPPRESSION LOCAL IDENTIFIER VALUE IN MMC STRUCTURED FIELD, ID identifier, IS NOT ACCEPTABLE. APK212S DATA IN AN INPUT RECORD OR RESOURCE IS INVALID: THE UNIT BASE PARAMETER IN THE structured field name STRUCTURED FIELD IS INVALID.
System Programmer Response: If an IBM licensed program was used to create the structured fields for the form definition with the error, verify that the input to that program was valid. If the input was valid, refer to Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. error may be an ACIF logic error. If you used a program to create the structured fields for the image object, contact your system programmer.
System Action: ACIF stops processing the print data set. ACIF issues a message identifying the position of the structured field in the data stream or resource. | APK247S DATA IN AN INPUT RECORD IS INVALID: | A PARAMETER IN AN IOB STRUCTURED | FIELD CONTAINS UNACCEPTABLE | DATA. | | | | | | | User Response: If you created the structured fields for the print data set or the resource, correct the error and resubmit the print request.
| duplex. This is an attempt to print the front and back | sides of a sheet from different input bins. used a program to create the structured fields for the form definition, contact your system programmer. | System Action: ACIF stops processing the input file. System Programmer Response: If an IBM licensed program was used to create the structured fields for the form definition with the error, verify that the input to that program was valid.
structured field. If the structured field has no error, the error may be an ACIF logic error. If you used a program to create the structured fields for the print data set or the resource, contact your system programmer. System Programmer Response: If an IBM licensed program was used to create the structured fields for the print data set or the resource with the error, verify that the input to that program was valid.
System Programmer Response: If an IBM licensed program was used to create the structured fields for the print data set or the resource with the error, verify that the input to that program was valid. If the input was valid, refer to Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. APK264S DATA IN AN INPUT RECORD OR RESOURCE IS INVALID: A CODED FONT NAMED IN AN OBJECT ENVIRONMENT GROUP IS NOT NAMED IN THE ACTIVE ENVIRONMENT GROUP OF THE PAGE OR RESOURCE.
System Action: ACIF stops processing the print data set. ACIF issues a message identifying the position of the structured field in the data stream or resource. System Action: ACIF stops processing the print data set. ACIF issues a message identifying the position of the structured field in the data stream or resource. User Response: If you created the structured fields for the print data set or resource, correct the error and resubmit the print request.
Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. APK273S DATA IN A FORMDEF RESOURCE IS INVALID: THE CONSTANT FORMS CONTROL VALUE IN THE MMC STRUCTURED FIELD ID identifier, IS NOT ACCEPTABLE. APK275S DATA IN A FORMDEF RESOURCE IS INVALID: A MEDIUM MAP SPECIFIES ONLY CONSTANT DATA FOR A PAGE. Explanation: The Constant Forms Control modification in the Medium Modification Control (MMC) structured field contained an unsupported value.
| | | | request. If the structured field has no error, the error may be an ACIF logic error. If you used a program to create the structured fields for the object, contact your system programmer. | | | | | | System Programmer Response: If an IBM licensed program was used to create the structured fields for the object with the error, verify that the input to that program was valid.
APK309S DATA IN A PAGEDEF RESOURCE IS INVALID: THE REPEATING GROUP LENGTH PARAMETER VALUE IN CCP STRUCTURED FIELD CCP identifier IS INVALID. Explanation: The Conditional Processing Control (CCP) structured field has an invalid value. Either the Length of Repeating Groups parameter is zero, or the length of the repeating group data is not a multiple of the size specified in that parameter. The CCP structured field is contained in the page definition.
program was valid. If the input was valid, refer to Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. APK315S DATA IN A PAGEDEF RESOURCE IS INVALID: THE NEXT LINE DESCRIPTOR IF SPACING PARAMETER VALUE IN LND STRUCTURED FIELD NUMBER structured field number IS 0. Explanation: The logical-record control character indicates that the Next Line Descriptor If Spacing parameter should be followed.
System Action: ACIF stops processing the print data set. ACIF issues a message identifying the position of the structured field in the data stream or resource. User Response: If you created the structured fields for the page definition, correct the error and resubmit the print request. Refer to Advanced Function Presentation: Programming Guide and Line Data Reference for more information about the structured field. If the structured field has no error, the error may be an ACIF logic error.
Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. System Programmer Response: If an IBM licensed program was used to create the structured fields for the page definition with the error, verify that the input to that program was valid. If the input was valid, refer to Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem.
User Response: If you created the structured fields for the page definition, correct the error and resubmit the print request. Refer to Advanced Function Presentation: Programming Guide and Line Data Reference for more information about the structured field. If the structured field has no error, the error may be an ACIF logic error. If you used a program to create the structured fields for the page definition, contact your system programmer.
User Response: If you created the structured fields for the page definition, correct the error and resubmit the print request. Refer to Advanced Function Presentation: Programming Guide and Line Data Reference for more information about the structured field. If the structured field has no error, the error may be an ACIF logic error. If you used a program to create the structured fields for the page definition, contact your system programmer.
The LND and CCP structured fields are contained in the page definition. System Action: ACIF stops processing the print data set, and issues a message identifying the position of the structured field in the data stream or resource. User Response: If you created the structured fields for the page definition, correct the error and resubmit the print request. Refer to Advanced Function Presentation: Programming Guide and Line Data Reference for more information about the structured field.
APK343I DATA IN AN INPUT RECORD OR PAGEDEF RESOURCE IS INVALID: AN LND STRUCTURED FIELD THAT USES RELATIVE POSITIONING ATTEMPTED TO PLACE DATA OUTSIDE OF THE LOGICAL PAGE IN THE Y DIRECTION. THE PRIOR AND CURRENT LND NUMBERS ARE: and . APK344S DATA IN A PAGEDEF RESOURCE IS INVALID: THE NUMBER OF LND STRUCTURED FIELDS DOES NOT MATCH THE VALUE SPECIFIED IN THE LNC STRUCTURED FIELD.
Presentation: Programming Guide and Line Data Reference for more information about the structured field. If the structured field has no error, the error may be an ACIF logic error. If you used a program to create the structured fields for the page definition, contact your system programmer. System Programmer Response: If an IBM licensed program was used to create the structured fields for the page definition with the error, verify that the input to that program was valid.
APK402S THE PARAMETER 'xxxxxxxx' IS INVALID. APK405S A VALUE OF 'xxxxxxxx' IS INVALID FOR PARAMETER 'xxxxxxxx'. Explanation: A parameter that is not valid for ACIF was specified. Explanation: The value supplied for a parameter is invalid. System Action: ACIF terminates. System Action: ACIF terminates. User Response: Correct the parameter and resubmit the job. User Response: Correct the parameter value and resubmit the job. System Programmer Response: No response is necessary.
APK409S A DDNAME FOR {MSGDD ¦ PARMDD} WAS NOT SUPPLIED. {SYSPRINT ¦ SYSIN} WAS USED. Return Codes 0 1 - Explanation: No DDname was specified for either the MSGDD or the PARMDD parameter. 2 - System Action: If the missing DDname was MSGDD, the DDname assigned to SYSPRINT was used. If the missing DDname was PARMDD, the DDname assigned to SYSIN was used.
System Programmer Response: No response is necessary. APK413S ATTEMPTED { OPEN¦CLOSE¦READ¦WRITE} OF RESOURCE FILE 'ddname', RESOURCE MEMBER NAME 'member name' FAILED. RETURN CODE nnnn. APK415I Explanation: For this run, the parameter listed has been used with the associated value. Explanation: An attempt to open, close, read, or write a resource failed. This message indicates that an abnormal occurrence has taken place in the called module.
System Programmer Response: No response is necessary. System Programmer Response: No response is necessary. APK424I APK428S A 'resource' HAS BEEN REQUESTED, BUT NO NAME WAS GIVEN. PARAMETER 'RESFILE=PDS' IS VALID ONLY IN OS/390 or MVS, DEFAULTING TO 'RESFILE=SEQ'. Explanation: The supplied value for the RESFILE parameter is incorrect for the VM operating system. System Action: ACIF produces a sequential resource file.
APK441I ACIF HAS COMPLETED PROCESSING ABNORMALLY WITH RETURN CODE nn. APK451S FILE { ALLOCATION | CONCATENATION | OUTADD } ERROR DURING ddname PROCESSING. SVC 99 ERROR nnnn INFORMATION CODE nnnn. Explanation: ACIF processing has completed with the return code shown. System Action: This message is for information only. Explanation: An error occurred during the allocation, concatenation, or outadd of AFP resource libraries. User Response: See any accompanying messages to determine a response.
APK455S FIELDnn USED BY INDEXnn WAS NOT DEFINED. System Programmer Response: No response is necessary. Explanation: An INDEXn parameter referred to a FIELDn that was not defined in the parameter file. APK461S TRIGGER SUPPLIED, BUT ALL INDEX VALUES WERE LITERALS. System Action: ACIF terminates. Explanation: A value for TRIGGER has been supplied, but all INDEXn values were literals. User Response: Correct the parameters and resubmit the job. System Programmer Response: No response is necessary.
APK465S INVALID TOKEN 'token' RECEIVED User Response: Correct the value so that its length is within the maximum for that parameter and rerun ACIF. Explanation: The token identified in the message was not expected in the parameter listed above the message. APK470S WHICH BEGINS AT OFFSET offset FOR A LENGTH OF length. System Action: ACIF continues processing the parameter file, but does not process the report file.
APK476I MESSAGE TEXT NOT AVAILABLE FOR MESSAGE NUMBER: nnnnnnnn Return Codes 0 1 - Explanation: ACIF attempted to write a message that is not defined in the message catalog. 2 - System Action: ACIF processing continues depending upon the significance of undefined message. 3 - 4 - 6 7 - 8 - 9 - User Response: Contact IBM Service and inform them that you have received this message. Make note of the module and function specified in the message.
APK610I GTF RETURN CODE = rc. APK903S MISSING OBJECT STACK POINTER IN CCM. Explanation: Generalized Trace Facility (GTF) has returned a nonzero return code from the GTRACE request. The return code rc and error text explain the error.
APK909S CCM CANNOT FIND REQUESTED MEG. Explanation: An internal error has occurred in ACIF. System Action: ACIF terminates. User Response: Contact IBM Service and inform them that you have received this message indicating an internal error. APK910S INPUT BIN LIST CHANGED DURING PROCESSING. Explanation: An internal error has occurred in ACIF. System Action: ACIF terminates. User Response: Contact IBM Service and inform them that you have received this message indicating an internal error.
| data stream and resubmit the job to ACIF. If the data | stream meets the begin structured field requirement, | this message indicates an internal logic error. Contact | IBM Service and inform them that you have received | this message indicating an internal error. Chapter 10.
176 ACIF User’s Guide
Part 4. Appendixes Copyright IBM Corp.
178 ACIF User’s Guide
Appendix A.
Working with file transfer and AIX (If you work outside the AIX environment, you may skip this section, as the information about working with file transfer does not pertain to the OS/390 or MVS, VM, or VSE environments.) ACIF needs to know two things about a file in order to print it: How long is each print record What kind of carriage control is used As simple as this sounds, it is the source of most of the difficulty people have printing with ACIF in an AIX environment. ACIF processes print records.
Note 1: These combinations are possible only if a file contains a prefix with a string that indicates a different code set than actually exists. For EBCDIC data with ASCII newlines, use X'0320202020200A'. For ASCII data with EBCDIC newlines, use X'03404040404025'. Fixed-length files Fixed-length files contain records that are all the same length. No other separators or prefixes or self-identifying information exists that indicates the record length.
Machine X'09' X'11' X'19' X'01' X'0B' X'89' X'8B' Command Print the line and single space Print the line and double space Print the line and triple space Print the line and don't space Space one line immediately (don't print) Print the line, then skip to channel 1 (top of form, by convention) Skip to channel 1 immediately (don't print) Note that machine controls print before performing any required spacing. There are many more machine control commands than ANSI.
For VSE files, additional file transfer parameters are available. For files with machine carriage control, you can specify BINARY, CRLF and CC. This provides an EBCDIC file with correct carriage controls separated by ASCII newlines and carriage returns. You must, however, “trick” ACIF by using a prefix of X'0320202020200A'. FTP From most systems, FTP works similarly to PC file transfer, and most of the same options are provided.
Indexing Considerations The index object file contains Index Element (IEL) structured fields that identify the location of the tagged groups in the print file. The tags are contained in the Tagged Logical Element (TLE) structured fields. The structured field offset and byte offset values are accurate at the time ACIF creates the output document file.
INDEX parameter, the tag generated by any INDEX parameter will be placed on the first page. Concatenating the Resource Group to the Document You can create a print file containing all the required print resources by concatenating the output document file to the end of the resource file. Do, however, remember two things when doing this: First, although Workbench Viewer and the other PSF products support all types of inline resources, PSF/VSE supports only inline page definitions and form definitions.
186 ACIF User’s Guide
Appendix B. Data Stream Information 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.
You may also want to index (tag) a specific page within the statement, such as the summary page. The following is an example of a print file that contains TLEs at the group level as well as at the page level: BDT BNG TLE Account #, 1ð1ð3ð TLE Customer Name, Mike Smith BPG Page 1 data EPG BPG Page 2 data EPG ... ... BPG TLE Summary Page, n Page n data EPG ENG ... EDT ACIF can accept as input files that contain both group-level and page-level indexing tags.
ACIF can retrieve all the resources used by the print file and can place them in a separate resource file. The resource file contains a resource group structure whose syntax is as follows: BRG BR AFP Resource 1 ER BR AFP Resource 2 ER .. BR AFP Resource n ER ERG ACIF does not limit the number of resources that can be included in this object, but available storage is certainly a limiting factor.
190 ACIF User’s Guide
Appendix C. Format of the Index Object File General-use Programming Interface and Associated Guidance Information is contained in this appendix. One of the optional files ACIF can produce contains indexing, offset, and size information. The purpose of this file is to enable applications such as archival and retrieval applications to selectively determine the location of a page group or page within the AFP data stream print file, based on its index (tag) values.
BDI IEL Groupname=G1 TLE ... TLE ... IEL Groupname=Gn TLE ... TLE EDI This format is useful to reduce the size of the index object file, but it allows manipulation only at the group level; that is, you cannot obtain the offset and size information for individual pages. You also lose any indexing information (TLEs) for pages; the TLE structured fields for the pages still exist in the output print file, however.
Begin Document Index (BDI) Structured Field ACIF assigns a null token name (X'FFFF') and an FQN type X'01' triplet to this structured field. The FQN type X'01' value is the file name identified by the DDname specified in the INDEXDD parameter. ACIF also creates an FQN type X'83' triplet containing the name of the AFP output print file, identified by the DDname specified in the OUTPUTDD parameter.
This triplet contains the name of the page with which this IEL structured field is associated. The name is the same as the FQN type X'01' on the BPG structured field. This triplet applies only to page-level IEL structured fields. FQN Type X'0D' This triplet contains the name of the page group with which this IEL structured field is associated. The name is the same as the FQN type X'01' on the BNG structured field. This triplet applies only to group-level IEL structured fields.
Appendix D. Format of the Output Document File This appendix contains General-use Programming Interface and Associated Guidance Information. Although ACIF can create three separate output files, only one of the files is required. ACIF always creates a print file in AFP data stream format.
BDT BNG Groupname=(index value + sequence number) TLE (INDEX1) TLE (INDEX2) ... TLE (INDEXn) BPG Page 1 of group 1 EPG BPG Page 2 of group 1 EPG ... BPG Page n of group 1 EPG ENG ... BNG Groupname=(index value + sequence number) TLE (INDEX1) TLE (INDEX2) ... TLE (INDEXn) BPG Page 1 of group n EPG BPG Page 2 of group n EPG ... BPG Page n of group n EPG ENG EDT Figure 35.
BDT BNG Groupname=(index value + sequence number) TLE (INDEX1) TLE (INDEX2) ... TLE (INDEXn) BPG TLE (INDEX1) ... TLE (INDEXn) Page 1 of group 1 EPG BPG Page 2 of group 1 EPG ... BPG TLE (INDEX1) ... TLE (INDEXn) Page n of group 1 EPG ENG ... BNG Groupname=(index value + sequence number) TLE (INDEX1) TLE (INDEX2) ... TLE (INDEXn) BPG Page 1 of group n EPG BPG TLE (INDEX1) ... TLE (INDEXn) Page 2 of group n EPG ... BPG Page n of group n EPG ENG EDT Figure 36.
Page Groups Page groups are architected groups of one or more pages to which some action or meaning is assigned. Consider the example of the bank statement application. Each bank statement in the print file comprises one or more pages. By grouping each statement in a logical manner, you can assign specific indexing or tag information to each group (statement). You can then use this grouping to perform actions such as archival, retrieval, viewing, preprocessing, postprocessing, and so on.
When ACIF indexes a print file, it creates the BNG structured fields. It assigns a rolling 8-byte EBCDIC sequence number to the token name (for example, 00000001 where 1=X'F1'). The sequence number begins with 00000001 and is incremented by 1 each time a group is created. ACIF also creates an FQN type X'01' triplet by concatenating the specified index value (GROUPNAME) with the same sequence number used in the token name.
Output MO:DCA-P Data Stream Regardless of the input data stream, ACIF always produces output files in the MO:DCA-P format. Each structured field in the file is a single record preceded by a X'5A' carriage control character. The following sections describe the required changes ACIF must make to support MO:DCA-P output format. Composed Text Control (CTC) Structured Field Because this structured field has been declared obsolete, ACIF ignores it and does not pass it to the output file.
Glossary Source Identifiers A This glossary includes definitions from the following sources: ACIF. See Advanced Function Presentation Conversion and Indexing Facility. Definitions reprinted from the American National Dictionary for Information Processing Systems are identified by the symbol (A) following the definition.
architecture. The set of rules and conventions that govern the creation and control of data types such as text, image, graphics, font, fax, color, audio, bar code, and multimedia. document. A file containing an AFP data stream document. An AFP data stream document is bounded by Begin Document and End Document structured fields and can be created using a text formatter such as Document Composition Facility (DCF). ASCII.
F indexing tags are contained in the Tagged Logical Element (TLE) structured fields. font. (1) A family of characters of a given size and style. For example, 9-point Helvetica. (T) (2) See font character set. indexing with data values. Adding indexing tags to a MO:DCA-P document using data that is already in the document and that is consistently located in the same place in each group of pages. font character set.
and the MVS/390 Data Facility Product operating on a System/390 processor. parameter. A variable that is given a constant value for a specified application and that may denote the application. MVS. Multiple Virtual Storage. pitch. A unit of width of type, based on the number of characters that can be placed in a linear inch. For example, 10-pitch type has ten characters per inch. O offset.
S structured field. A self-identifying, variable-length, bounded record that can have a content portion that provides control information, data, or both. syntax. The rules and keywords that govern the use of a programming language. T tag. A type of structured field used for indexing in an AFP document. Tags associate an index attribute value pair with a specific page or group of pages in a document. trigger. Data values for which ACIF searches, to delineate the beginning of a new group of pages.
206 ACIF User’s Guide
Bibliography This bibliography lists the titles of publications containing additional information about PSF, Advanced Function Presentation, the MVS and OS/390 operating systems, and related products. The titles and order numbers may change from time to time. To verify the current title or order number, consult your IBM marketing representative.
Advanced Function Presentation (AFP) Architecture Publication Order Number Advanced Function Presentation: Programming Guide and Line Data Reference S544-3884 Bar Code Object Content Architecture Reference S544-3766 Font Object Content Architecture Reference S544-3285 Graphics Object Content Architecture Reference SC31-6804 Image Object Content Architecture Reference SC31-6805 Intelligent Printer Data Stream Reference S544-3417 Mixed Object Document Content Architecture Reference SC31-6802 P
Text Processing Publication Order number DCF/DLF General Information GH20-9158 Document Composition Facility: Bar Code User's Guide S544-3115 Document Composition Facility: SCRIPT/VS Text Programmer's Guide SH35-0069 Publishing Systems BookMaster General Information GC34-5006 Publishing Systems BookMaster User's Guide SC34-5009 Using DisplayWrite/370 SH12-5172 InfoPrint Manager for AIX Publication Order Number IBM InfoPrint Manager for AIX: Administrator’s Guide S544-5595 IBM InfoPrint Man
EDMSuite OnDemand Publication Order Number EDMSuite OnDemand: Administrator's Reference G544-5293 EDMSuite OnDemand: Installation and Configuration Guide for UNIX Servers G544-5598 EDMSuite OnDemand: Installation and Configuration Guide for Windows NT Servers G544-5526 EDMSuite OnDemand: Introduction and Planning Guide G544-5281 Publication Order Number Reference Manual for the IBM 3800 Printing Subsystem Models 3 and 6 GA32-0050 IBM PagePrinter 3812 Introduction and Planning Guide G544-3265
OS/390 Version 2 Release 6 Publication Order Number IBM Online Library Omnibus Edition OS/390 Collection SK2T-6700 OS/390 HCD Planning GC28-1750 OS/390 HCD User's Guide SC28-1848 OS/390 JES2 Commands GC28-1790 OS/390 JES2 Initialization and Tuning Guide SC28-1791 OS/390 JES2 Initialization and Tuning Reference SC28-1792 OS/390 JES2 Messages GC28-1796 OS/390 JES3 Commands GC28-1798 OS/390 JES3 Initialization and Tuning Guide SC28-1802 OS/390 JES3 Initialization and Tuning Reference SC28-
eNetwork Communications Server Publication Order Number OS/390 eNetwork Communications Server: IP Application Programming Interface Guide SC31-8516 OS/390 eNetwork Communications Server: IP Configuration Guide SC31-8513 OS/390 eNetwork Communications Server: IP Network Print Facility SC31-8522 OS/390 eNetwork Communications Server: IP Programmer's Reference SC31-8515 OS/390 eNetwork Communications Server: SNA Resource Definition Reference SC31-8565 MVS/Enterprise Systems Architecture (ESA) Versi
Publication Order Number MVS/ESA SP V5 System Messages, Volume 4 GC28-1483 MVS/ESA SP V5 System Messages, Volume 5 GC28-1484 MVS/ESA SP V5 Using the Functional Subsystem Interface SC28-1505 RACF V2 General User’s Guide SC23-3728 RACF V2 Security Administrator’s Guide SC23-3726 RACF V2 System Programmer’s Guide SC23-3725 SMP/E R8 User's Guide SC28-1302 System Display and Search Facility Guide and Reference SC23-0408 Publication Order Number Internetworking with TCP/IP, Principles, Protoco
Systems Network Architecture Publication Order Number SNA Customization LY43-0110 SNA Formats (SNA Reference Summary) GA27-3136 SNA Resource Definition Reference SC31-8565 SNA Technical Overview GC30-3073 SNA Transaction Programmer’s Reference Manual for LU Type 6.
Index A ACIF See AFP Conversion and Indexing Facility (ACIF) ACIF command See also acif command, AIX notational conventions xvii acif command, AIX automatically invoking 26 defined, AIX 27 flags, AIX 27 format 23 line2afp 26 notational conventions 23 parameters 23 running, AIX 62 syntax rules 23 using 23 ACIF exit See exits ACIF input record exits See input record exit ACIF JCL statement defined 81 Adobe Type 1 outline fonts 16 AFP API See AFP Application Programming Interface AFP Application Programming In
AIX (continued) EBCDIC literal values 61 example, ACIF application 53 example, ASCII input data 56 example, input file 55 example, triggers for indexing 56, 59 exit, index 69 exit, input file 66 exit, output record 70 exit, resource retrieval 72 exit, user programming 65 file provided with ACIF 51 font names, linking 77 font names, mapping 77 fonts, ASCII 77 fonts, specifying 50 FORMDEF parameter 74 GROUPNAME parameter 36 index exits 69 index object file 37 INDEX parameter 36 index, exit 66 indexing 66 inde
application programmer (continued) tasks, ACIF 3 application programming publication, ACIF audience xiii operating systems supported xi order number xiv organization, overview xiv terms used xv users xiii who should use this xiii archiving, ACIF how to prepare files 8 indexing considerations 184 indexing data for 10 retrieving resources for 14 steps to perform 8 ASCII fonts, AIX 77 input data specifying parameters for, AIX 56 input data to ACIF 10 ASCIINP exit input record, AIX 68 ASCIINPE exit input record
commands (continued) converting literal values, AIX 61 format xvii notation xvii shell, AIX 61 shell, concatenation, AIX 62 comments in parameter file 88 comments in parameter file, AIX 42 Composed Text Control (CTC) structured field obsolete 200 concatenation AIX 62 files, output, AIX 62 OS/390 or MVS files 121 output files, AIX 62 resource group to document 185 VM files 121 conventions highlighting xvi notational xvii, 23 converting AFP data 9 AIX file, example 49 example, AIX file 49 files, ASCII data 10
environment variables (continued) PSFPATH, AIX 29 EPG See End Page structured field ER See End Resource structured field ERG See End Resource Group structured field examples 116 ACIF application, AIX 53 ACIF output for indexed input file 197 ACIF processing parameters, AIX 56, 59 AFP document output formats 195 ASCII input data, AIX 56 blank characters in parameter file 87 CMS commands 117 CMS commands to invoke ACIF, VM 83 conversion, AIX 49 disclaimer ix EBCDIC input data, AIX 59 indexing using data value
FONTECH parameter 94 FONTLIB parameter AIX 34 defined 94, 95 defined, AIX 34 OS/390 or MVS 94 VM 95 VSE 95 fonts 3800 94 converting ASCII to EBCDIC, AIX 39 directory, AIX 34 double-byte 105 double-byte requirements, AIX 43 example of specifying, AIX 50 for line data, AIX 28 library, AIX 34 library, OS/390 or MVS 94 library, VM 95 library, VSE 95 linking names, AIX 77 mapping font names, AIX 77 order specified, CHARS parameter 110 specifying with CHARS 90 specifying with chars, AIX 28 to print ASCII or S/370
index object file (continued) used by the Viewer application of AFP Workbench 16 index record exit INDEXOBJ parameter 99 INDXEXIT parameter 99, 125 INDEXDD parameter AIX 37 defined 98 defined, AIX 37 OS/390, MVS 98 VM 98 indexing anchor point 13 anchor record 93, 110 anchor record, AIX 31, 46 description 10 effect on document 195 example of 12, 117 example, ASCII input data, AIX 56 example, EBCDIC input data, AIX 59 field parameter, AIX 31 FIELDn parameter, VSE 93 files with acif command, AIX 51 functions 1
INPUTDD parameter (continued) VM 100 VSE, equivalence of 100 Invoke Medium Map (IMM) 183 Invoke Medium Map structured field 183 J JCL ACIF JCL statement defined 81 example, MVS or OS/390 116 example, OS/390 or MVS 116 example, VSE 117 for ACIF job, MVS or OS/390 116 for ACIF job, OS/390 or MVS 116 for ACIF MVS jobs 81 for ACIF VSE jobs 84 for concatenating OS/390 or MVS files 121 in the VSE environment 84 invoking ACIF program to index input file 115 MVS or OS/390 example 116 OS/390 or MVS example 116 OUT
messages OS/390 or MVS, VM, VSE 132 system programmer instructions xiii mixed-mode data as input to ACIF 10 MO:DCA-P data as input to ACIF 9 mounting AIX directories on the workstation MSGDD parameter AIX 40 defined, AIX 40 multiple=up output page definition 184 MVS DD statement for document file 81 INDEX JCL statement 82 index object file 82 input 82 invoking ACIF 81 JCL example 116 JCL for ACIF job 81 JCL statement 81 JCL to invoke ACIF 81 message file, ACIF 81 OUTPUT JCL statement 82 partitioned data set
page definition (continued) library, VSE 105 multiple-up output 184 specified with PAGEDEF parameter 102 specified with pagedef parameter, AIX 41 page segment directory, AIX 43 library, AIX 43 library, OS/390 or MVS 105 library, VM 106 library, VSE 106 page-level IELs 192 PAGEDEF parameter AIX 41, 74, 75 defined 102 defined, AIX 41 print file attributes, AIX 74, 75 PAGEDEF print file attribute blanks or specified value 131 parameter file 83 ASCII input data, AIX 56 comments 88 comments, AIX 42 DD statement
parameters (continued) RESEXIT 14 RESEXIT, AIX 43 RESEXIT, OS/390, MVS, VM, VSE 106 RESFILE, OS/390, MVS 107 RESLIB, AIX 44 RESOBDD, AIX 44 RESOBJDD, OS/390 or MVS 107 RESOBJDD, VM 107 RESOBJDD, VSE 107 RESTYPE 14, 128 RESTYPE, OS/390, MVS, VM, VSE 108 TRACE, OS/390, MVS, VM, VSE 109 TRACEDD, VM 109 TRACEDD, VSE 109 TRC, AIX 46 TRC, OS/390, MVS, VM, VSE 109 TRIGGER, AIX 46 TRIGGER, OS/390, MVS, VM, VSE 110 UNIQUEBNGS, AIX 48 UNIQUEBNGS, OS/390, MVS, VM, VSE 111 USERLIB, AIX 48 USERLIB, OS/390 or MVS 111 PAR
processing parameter (continued) ASCII input data, AIX 55 EBCDIC input data, AIX 58, 59 example, AIX 56 programming interface information AFP Toolbox C Library 16 AFP Toolbox C++ Object Library 16 overview ix PSEG resource requirements for resource file 108 PSEGLIB parameter AIX 43, 48 defined, AIX 43 defined, OS/390 or MVS 105 defined, VM 106 defined, VSE equivalent 106 OS/390 or MVS 105 VM 106 VSE equivalent 106 PSF/VSE limitations 17 PSFPATH environment variable, AIX 29 publications, related 207 R REGIO
search order for resources, AIX (continued) user library, AIX 48 separator pages application-generated 184 removal from output 184 sequential data set See file setup file directory, AIX 40 directory, OS/390, MVS 100 library, AIX 40 library, OS/390, MVS 100 name, AIX 30 shell commands concatenation, AIX 62 EBCDIC literal values, AIX 61 for converting literal values, AIX 61 shift-out, shift-in AIX 43 storage problem See Tag Logical Element structured field structured fields Begin Document 185, 198 Begin Docum
triggers for indexing (continued) set by TRIGGER parameter 110 set by trigger parameter, AIX 46 used with field parameter, AIX 31 used with FIELDn parameter 93 used with INDEX parameter 97 used with index parameter, AIX 36 U underscore in commands xvii unformatted ASCII input to ACIF 10 search path for resources AFP resources, AIX 48 fonts, AIX 34 overlays, AIX 40 page definitions, AIX 42 page segments, AIX 43 setup files, AIX 40 setup files, OS/390, MVS 100 system resources, AIX 44 search paths for resour
VM (continued) CMS commands in example 117 INDEX CMS statement 83 input 83 OUTPUT CMS statement 83 RESOBJ CMS statement 83 system prerequisites 18 user exit load modules 130 USERAPPL CMS command 83 using ACIF 82 VSE JCL example 117 JCL for ACIF job 81 system prerequisites 19 user exit load modules 130 W Workbench, Viewer application See AFP Workbench workstation mounting AIX directories on 64 transferring files to, AIX 63 Index 229
Communicating Your Comments to IBM IBM Print Services Facility AFP Conversion and Indexing Facility: User’s Guide Publication No. S544-5285-01 If you especially like or dislike anything about this book, please use one of the methods listed below to send your comments to IBM. Whichever method you choose, make sure you send your name, address, and telephone number if you would like a reply.
Readers' Comments — We'd Like to Hear from You IBM Print Services Facility AFP Conversion and Indexing Facility: User’s Guide Publication No.
Readers' Comments — We'd Like to Hear from You S544-5285-01 Fold and Tape Please do not staple IBM Cut or Fold Along Line Fold and Tape NO POSTAGE NECESSARY IF MAILED IN THE UNITED STATES BUSINESS REPLY MAIL FIRST-CLASS MAIL PERMIT NO.
IBM Program Number: 5655-B17 5695-040 5684-141 5686-040 5765-505 5648-B34 Printed in the United States of America on recycled paper containing 10% recovered post-consumer fiber.
Spine information: IBM IBM Print Services Facility AFP Conversion and Indexing Facility: User’s Guide
