IBM S544-5285-01 manual

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 [...]

Contents Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix Programming Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix Disclaimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix Trademarks . . . . . . . . . . . . . . . . . . . . . . . .[...]

Using a Parameter File with ASCII Input Data ................. 5 6 Specifying ACIF Processing Parameters for EBCDIC Input Data ........ 5 8 Using a Parameter File with EBCDIC Input Data ................ 5 8 Using the Shell with EBCDIC Literal Values ................... 6 1 Identifying the Locations of the Resources ..................... 6 1 Determi[...]

Index Record Exit ................................. 125 Output Record Exit ................................ 126 Resource Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 User Exit Search Order .............................. 130 Non-Zero Return Codes ............................. 130 Attributes of the Input Print File .[...]

Composed Text Control (CTC) Structured Field ............... 200 Map Coded Font (MCF) Format 1 Structured Field .............. 200 Map Coded Font (MCF) Format 2 Structured Field .............. 200 Presentation Text Data Descriptor (PTD) Format 1 Structured Field .... 200 Inline Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .[...]

Figures 1. How ACIF Fits into Advanced Function Presentation ............. 4 2. Using ACIF to Prepare Files for Viewing .................... 6 3. Using ACIF to Prepare Files for Distributed Printing ............. 7 4. Using ACIF to Prepare Files for Archiving and Retrieving .......... 8 5. AFP Document with Index Tags and the Index Object File ....[...]

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 exp[...]

The following terms appear in this publication and are trademarks of other companies:  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. x ACIF[...]

| 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) |  M[...]

| a Set Coded Font Local Text control. Each shift in character is converted to a | Set Coded Font Local Text control and two blanks. | New or changed messages include: |  APK246S (APAR PQ02350) |  APK247S (APAR PQ02350) |  APK248S (APAR PQ02350) |  APK252I (APAR PN77694) |  APK255S (APAR PQ09450) |  APK256S (APAR PQ09450) |  AP[...]

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 reso[...]

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[...]

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. What Terms Are Used In This Publication? The following [...]

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.i[...]

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, whic[...]

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. 1993, 1999 1[...]

2 ACIF User’s Guide[...]

Chapter 1. Planning Your AFP Conversion and Indexing Facility (ACIF) Application This chapter provides:  A description of ACIF and the tasks you can perform with it  A brief description of related products you can use with ACIF  A list of system prerequisites for using ACIF What Can I Do with ACIF? AFP Conversion and Indexing Facility (ACI[...]

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 [...]

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 pri[...]

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 pa[...]

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[...]

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[...]

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 stream[...]

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 objec[...]

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. 1 Figure 5 shows the relationship betwee[...]

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 [...]

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 n[...]

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 [...]

specific typeface be included in the resource file. The only way to accomplish this is by using the resource exit.  Includes the name of the output document in the resource file and the name of the resource file in the output document, which provides a method of correlating resource files with the appropriate output document An example of specif[...]

| 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[...]

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 pa[...]

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[...]

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 additio[...]

20 ACIF User’s Guide[...]

Part 2. Using ACIF in the AIX Environment  Copyright IBM Corp. 1993, 1999 21[...]

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. Syntax | acif [ cc= value ] [ cctype= value ] [ chars= fontnames ] [ comsetup= n[...]

 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 nam[...]

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 w[...]

You can use ACIF to prepare S/370 line data or unformatted ASCII files. At print submission time, to automatically invoke the acif command for the purpose of preparing S/370 line data or unformatted ASCII files for printing with PSF for AIX, use the -odatatype=line flag and keyword-value pair with one of the AIX print commands ( enq , lp , or qprt [...]

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 , insertim[...]

(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 [...]

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, a[...]

 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 d[...]

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[...]

record Specifies the relative record number from the indexing anchor record. When ACIF is indexing the file, it uses the information specified in the trigger n parameters to determine a page group boundary. When all of the specified trigger n values are true, ACIF defines the indexing anchor record as the record where trigger1 i s located. trigger1[...]

 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 locat[...]

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, ACI[...]

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 examp[...]

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 . index n ACIF uses the value of the specified index ( index1 , index2 , [...]

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. field n [,field n ...] Specifies one o[...]

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[...]

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 Conver[...]

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[...]

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 [...]

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 comm[...]

| 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 S[...]

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 director[...]

| 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[...]

| 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 [...]

condition and terminates processing if an ‘*’ is specified with any trigger n 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 ‘*?[...]

Notes: 1. ACIF requires that at least one trigger n o r field n value appear within the page range specified by the indexstartby parameter. If no trigger n o r field n parameter is satisfied within the indexstartby page range, ACIF stops processing. 2. At least one trigger n or field n must exist on the first page of every unique page group. ACIF c[...]

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. For examples of how to use ACIF or the line2afp command t[...]

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 nee[...]

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.c Sample ACIF user exits /usr/lpp/psf/bin/apka2e, apkinp, apkind, apkres, apkout, a[...]

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 [...]

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. Example of a Customer’s Telephone Bill 54 ACIF User’s Guide[...]

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 [...]

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. For example, to use a parameter file named PARMFILE , specify: acif parmdd=PARMFILE / example phone bill / / DATA CHA[...]

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 trigger n parameters are defined relative to the indexing anchor record. In this example, you wa[...]

- 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[...]

/ example phone bill / / DATA CHARACTERISTICS / cc=yes / carriage control used / cctype=a / EBCDIC ANSI carriage controls / chars=GT15 / coded font / cpgid=37 / code page identifier / / FIELD AND INDEX DEFINITION / field1=13,66,15 / Account Number data field / field2=,5,3 / Name data fi[...]

Subsequent trigger n 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. To[...]

 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 [...]

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 example, the following resources are used: formdef F1A10110, a standard form definition, provided with PSF for AIX pagedef P1A08682, a standard page definition, provided with PSF for AIX Runn[...]

 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 >[...]

 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 vie[...]

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 i[...]

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 indexi[...]

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 th[...]

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. To execute the apka2e input record exit program, set[...]

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 defi[...]

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 ' Specifies that the record be processed by ACIF. 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 requi[...]

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 goin[...]

| X ' 03 ' Specifies a GOCA (graphics) object | X ' 05 ' Specifies a BCOCA (barcode) object | X ' 06 ' Specifies an 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[...]

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 comman[...]

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 fon[...]

| If you are using an IBM 3800 printer, which needs fonts in the unbounded box | format, you can use the FONTECH parameter. The only valid value for FONTECH | is UNBOUNDED; any other value will cause ACIF to issue an error message and | terminate. | If you specify FONTECH=UNBOUNDED and RESTYPE=FONT o r RESTYPE=ALL , | ACIF reads unbounded box fonts[...]

Part 3. Using ACIF in the OS/390, MVS, VM, and VSE Environments  Copyright IBM Corp. 1993, 1999 79[...]

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=[...]

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, [...]

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 DI[...]

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 MSG[...]

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 do[...]

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 v[...]

 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 followi[...]

| 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... ] | R | OS/390, MVS | OUTEXIT= module name | G | OS/390, MVS, VM, VSE | OUTPUTDD = OUTPUT | ddname [...]

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 &apos[...]

| 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 dir[...]

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, [...]

| 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 . |[...]

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 TRIGGER n parameters. The supported range of values for column are 1–32 756. If the specified value exceeds the physical length of the record, ACIF repo[...]

| 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 FONTLI[...]

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 can[...]

| – 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[...]

Note: If one or more TRIGGER n 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’ Spec[...]

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[...]

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. INPU[...]

( 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 [...]

| 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 . |[...]

| 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 M[...]

| 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 pr[...]

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 [...]

| 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 spec[...]

RESFILE=SEQ | P D S | 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 | specif[...]

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][, | [...]

| 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. | RESTYPE=FDEF,PSEG,OVLY,OBJCON,BCOCA,GOCA,IOCA / Don't want any fonts saved | Because the Viewer applicati[...]

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 a[...]

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' / Look for Skip-to-Channel 1 TRIGGER2=,5,'ACCOUNT:' / Find account number TRIGGER3=3,75,'PAGE 1' /[...]

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[...]

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 rep[...]

Figure 24. Example of a Customer's Phone Bill 114 ACIF User’s Guide[...]

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 ..........[...]

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 de[...]

VM CMS Commands to Invoke ACIF FILEDEF INPUT DISK ACIFEX2 SYSIN A FILEDEF OUTPUT DISK APKACIF OUTPUT A (LRECL 32756 BLKSIZE 3276 RECFM VB FILEDEF INDEX DISK APKACIF INDEX A (LRECL 32756 BLKSIZE 3276 RECFM VB FILEDEF RESLIB DISK APKACIF RESLIB A (LRECL 32756 BLKSIZE 3276 RECFM VB FILEDEF SYSPRINT DISK APKACIF SYSPRINT A APKACIF Where file A[...]

// JOB // LIBDEF PHASE,SEARCH=(PRD2.AFP) // ASSGN SYSLST,X'FEE' // ASSGN SYS6,21 // DLBL INPUT,'APKACIF.INPUT',,SD // EXTENT SYS6,SYSWK1,1,1,92,13 // ASSGN SYS7,21 // DLBL OUTPUT,'APKACIF.OUTPUT',,SD // EXTENT SYS7,SYSWK1,1,1,9213,45 // ASSGN SYS8,21 // DLBL RESOBJ,&ap[...]

 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. Because the da[...]

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'[...]

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:  ACIF paramete[...]

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 fi[...]

PARMLIST DSECT Parameters for the input record exit WORK@ DS A Address of 16-byte static work area PFATTR@ DS A Address of print-file-attribute information RECORD@ DS A Address of the input record DS A Reserved for future use RECORDLN DS H Length of the input record DS H Reserved for future use REQUEST DS X Add, delete, or process the record EOF DS[...]

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 [...]

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 t[...]

PARMLIST DSECT Parameters for the output record exit WORK@ DS A Address of 16-byte static work area PFATTR@ DS A Address of print-file-attribute information RECORD@ DS A Address of the record to be written RECORDLN DS H Length of the output record REQUEST DS X Delete or process the record EOF DS C Last call indicator Figure 32. Sample Output Record[...]

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 p[...]

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 (barcod[...]

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.[...]

PFATTR DSECT Print File Attributes CC DS CL3 Carriage controls? - 'YES' or 'NO ' CCTYPE DS CL1 Carriage control type - A (ANSI) or M (Machine) CHARS DS CL2 CHARS values, including commas (eg. GT12, GT15) FORMDEF DS CL8 Form Definition (FORMDEF) PAGEDEF DS CL8 Page Definition (PAGEDEF) PRMODE DS CL8 Processing mode TRC DS CL3 [...]

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. 132 ACIF User’s Guide[...]

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 me[...]

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 a[...]

APK104S DATA IN AN INPUT RECORD OR RESOURCE IS INVALID: structured field STRUCTURED FIELD IS NOT ALLOWED OR FORMS AN INVALID SEQUENCE. Explanation: The structured field identified in this message is either out of sequence or invalid in an object. The record may be line data. If inline resources are used with data-set header pages, multiple resource[...]

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 p[...]

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 print data set or the resource, contact your system programmer. System Programmer Response: If an IBM licensed program was used to create the struct[...]

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. APK118W UNSUPPOR[...]

APK135I DATA IN A FORMDEF RESOURCE IS INVALID: DUPLICATE OVERLAY LOCAL IDENTIFIER WAS FOUND IN THE structured field STRUCTURED FIELD. Explanation: The same local identifier was found assigned to more than one Overlay Local Identifier parameter in the Map Medium Overlay (MMO) or Map Page Overlay (MPO) structured field repeating groups. The MMO struc[...]

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. APK141S DATA IN A FORMDEF RESOU[...]

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 th[...]

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 i[...]

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[...]

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 paramete[...]

Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. APK171S DATA IN AN INPUT RECORD OR RESOURCE IS INVALID: FONT LOCAL IDENTIFIER VALUE IS NOT ACCEPTABLE IN THE structured field STRUCTURED FIELD. Explanation: The Map Coded Font (MCF) structured field consists of repeating groups. In one of the groups[...]

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 f[...]

APK191S DATA IN A FORMDEF RESOURCE IS INVALID: THE SUPPRESSION LOCAL IDENTIFIER VALUE IN MMC STRUCTURED FIELD, ID identifier , IS NOT ACCEPTABLE. Explanation: The Medium Modification Control Identifier parameter in a Medium Modification Control (MMC) structured field is invalid. The MMC structured field is contained in the form definition. System A[...]

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 Programmer Response: If an IBM licensed program was used to create the structured fields for the image object with the error, verify that the input to that program was valid. If the input was valid, re[...]

| APK247S DATA IN AN INPUT RECORD IS INVALID: | A PARAMETER IN AN IOB STRUCTURED | FIELD CONTAINS UNACCEPTABLE | DATA. | Explanation: One of the parameters in the Include | Object (IOB) structured field is invalid. The object type | specified is not supported or is invalid OR the x or y | offset of the object area or the rotation value are not | ex[...]

| duplex. This is an attempt to print the front and back | sides of a sheet from different input bins. | System Action: ACIF stops processing the input file. | User Response: Correct the process used to create | the form definition. If you used an IBM licensed program | to create the form definition with the error, use local | problem-reporting pro[...]

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 reso[...]

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 [...]

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. Refer to Mixed Object Document Content Architecture [...]

APK273S DATA IN A FORMDEF RESOURCE IS INVALID: THE CONSTANT FORMS CONTROL VALUE IN THE MMC STRUCTURED FIELD ID identifier , IS NOT ACCEPTABLE. Explanation: The Constant Forms Control modification in the Medium Modification Control (MMC) structured field contained an unsupported value. The MMC structured field is contained in the form definition. Sy[...]

| 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 [...]

APK309S DATA IN A PAGEDEF RESOURCE IS INVALID: THE REPEATING GROUP LENGTH PARAMETER VALUE IN CCP STRUCTURED FIELD CCP identifier I S 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 multipl[...]

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 contr[...]

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 [...]

Advanced Function Printing: Diagnosis Guide for assistance in determining the source of the problem. APK323S DATA IN A PAGEDEF RESOURCE IS INVALID: THE DATA MAP ACTION PARAMETER VALUE value IN CCP STRUCTURED FIELD CCP identifier I S INVALID. Explanation: The Conditional Processing Control (CCP) structured field has an invalid value. The Data Map Ac[...]

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 p[...]

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 p[...]

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 r[...]

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: < prior LND number > and < current LND number > . Explanation: When relative positioning is being used on an[...]

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[...]

APK402S THE PARAMETER 'xxxxxxxx' IS INVALID. Explanation: A parameter that is not valid for ACIF was specified. System Action: ACIF terminates. User Response: Correct the parameter and resubmit the job. System Programmer Response: No response is necessary. APK403S THE REQUESTED RESOURCE number I S UNKNOWN. Explanation: A resource I/O has [...]

APK409S A DDNAME FOR {MSGDD ¦ PARMDD} WAS NOT SUPPLIED. {SYSPRINT ¦ SYSIN} WAS USED. Explanation: No DDname was specified for either the MSGDD or the PARMDD parameter. 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. User Response: [...]

APK413S ATTEMPTED { OPEN ¦ CLOSE ¦ READ ¦ WRITE} OF RESOURCE FILE 'ddname' , RESOURCE MEMBER NAME 'member name' FAILED. RETURN CODE nnnn . 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. This message is informati[...]

System Programmer Response: No response is necessary. APK424I 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. User Response: No response[...]

APK441I ACIF HAS COMPLETED PROCESSING ABNORMALLY WITH RETURN CODE nn. Explanation: ACIF processing has completed with the return code shown. System Action: This message is for information only. User Response: See any accompanying messages to determine a response. System Programmer Response: No response is necessary. APK448S INDEXING WAS REQUESTED, [...]

APK455S FIELDnn USED BY INDEXnn WAS NOT DEFINED. Explanation: An INDEXn parameter referred to a FIELDn that was not defined in the parameter file. System Action: ACIF terminates. User Response: Correct the parameters and resubmit the job. System Programmer Response: No response is necessary. APK456S THE TRIGGER1 RELATIVE RECORD NUMBER IS NOT EQUAL [...]

APK465S INVALID TOKEN ' token ' RECEIVED Explanation: The token identified in the message was not expected in the parameter listed above the message. System Action: ACIF continues processing the parameter file, but does not process the report file. User Response: Correct the value of the parameter and rerun ACIF. APK466S A SUB-PARAMETER O[...]

APK476I MESSAGE TEXT NOT AVAILABLE FOR MESSAGE NUMBER: nnnnnnnn Explanation: ACIF attempted to write a message that is not defined in the message catalog. System Action: ACIF processing continues depending upon the significance of undefined message. User Response: Contact IBM service and inform them that ACIF attempted to write an undefined message[...]

APK610I GTF RETURN CODE = rc . 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. The return codes and error text are: RC Error Text 04 inactive OS/390 or MVS GTF 08 invalid length = xxxx 0C invalid data address = xxxx 10 invalid FID = xx 14 [...]

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[...]

| 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. ACIF Messages for OS/390, MVS, VM, and VSE 175[...]

176 ACIF User’s Guide[...]

Part 4. Appendixes  Copyright IBM Corp. 1993, 1999 177[...]

178 ACIF User’s Guide[...]

Appendix A. Helpful Hints When using ACIF, the following topics may prove to be helpful to you:  Working with control statements that contain numbered lines (OS/390 or MVS, VM, VSE environments only)  Understanding how ACIF processes fonts  Placing TLEs in named groups  Working with file transfer and AIX (AIX environment only)  Under[...]

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 cont[...]

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[...]

Note that machine controls print before performing any required spacing. There are many more machine control commands than ANSI. Carriage controls may be present in a print file or not, but every record in the file must contain a carriage control if the controls are to be used. If the file contains carriage controls, but CC =NO is specified to ACIF[...]

 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 ' [...]

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 fil[...]

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, a[...]

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 strea[...]

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 Pag[...]

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 B R AFP Resource 1 E R B R AFP Resource 2 E R . . B R AFP Resource n E R ERG ACIF does not limit the number of resources that can be included in this object,[...]

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 det[...]

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 fiel[...]

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 containin[...]

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 struct[...]

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. In doing so, ACIF may create the following structured fields[...]

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 [...]

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 grou[...]

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 [...]

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 con[...]

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 T[...]

Glossary Source Identifiers This glossary includes definitions from the following sources:  Definitions reprinted from the American National Dictionary for Information Processing Systems are identified by the symbol (A) following the definition. Definitions reprinted from a published section of the International Organization for Standardization&[...]

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. ASCII . American National Standard Code for Information Interchange data encoding, which is the normal (default) type of data encoding in an AIX environment. Contrast wi[...]

F font . (1) A family of characters of a given size and style. For example, 9-point Helvetica. (T) (2) See font character set. font character set . Part of an AFP font that contains the raster patterns, identifiers, and descriptions of characters. Often synonymous with character set. See also coded-font. form definition (FORMDEF) . A resource that [...]

and the MVS/390 Data Facility Product operating on a System/390 processor. MVS . Multiple Virtual Storage. O offset . The number of measuring units from an arbitrary starting point in a record, area, or control block to some other point. object . (1) A collection of structured fields. The first structured field provides a begin-object function, and[...]

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 p[...]

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. Pr[...]

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 Arc[...]

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[...]

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 Printers Publi[...]

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 GC[...]

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&ap[...]

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 G[...]

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.2 GC30-3084 Systems Network Architecture Formats GA27-3136 AS/400 Publication Order[...]

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 [...]

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[...]

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 step[...]

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 [...]

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 charac[...]

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 li[...]

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[...]

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 conca[...]

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 64 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 in[...]

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 attri[...]

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[...]

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 def[...]

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 convertin[...]

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 [...]

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 Workben[...]

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 [...]

Readers' Comments — We'd Like to Hear from You IBM Print Services Facility AFP Conversion and Indexing Facility: User’s Guide Publication No. S544-5285-01 Overall, how satisfied are you with the information in this book? How satisfied are you that the information in this book is: Please tell us how we can improve this book: Thank you [...]

Cut or Fold Along Line Cut or Fold Along Line Readers' Comments — We'd Like to Hear from You S544-5285-01 IBM  Fold and Tape Please do not staple Fold and Tape NO POSTAGE NECESSARY IF MAILED IN THE UNITED STATES BUSINESS REPLY MAIL FIRST-CLASS MAIL PERMIT NO. 40 ARMONK, NEW YORK POSTAGE WILL BE PAID BY ADDRESSEE IBM Corporation Infor[...]

[...]

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. S544-5285-1[...]

Spine information: IBM IBM Print Services Facility User’s Guide AFP Conversion and Indexing Facility:[...]