IBM S544-5285-01 User 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 2.2.0 (program number 5695-040), Print Services Facility/VM 2.1.1 (program number
|5684-141), Print Services Facility/VSE 2.2.1 (program number 5686-040), IBM Print Services Facility for AIX 2.1.0 (program number
|5765-505), and IBM InfoPrint Manager for AIX 3.1.0 (program number 5648-B34). This edition applies to all subsequent releases and
|modifications until otherwise indicated in new editions or Technical Newsletters. Be sure to use the correct edition for the level of the
|product.
|Order publications through your IBM representative or the IBM branch office serving your locality. Publications are not stocked at the
|address given below.
|The IBM Printing Systems Company welcomes your comments. A form for reader's comments is provided at the back of this
|publication. If the form has been removed, you may send your comments to the following address:
|INFORMATION DEVELOPMENT
|THE IBM PRINTING SYSTEMS COMPANY
|DEPARTMENT H7FE, BUILDING 003G
|PO BOX 1900
|BOULDER, COLORADO 80301-9191
| If you prefer to send comments electronically, use one of the following methods:
| Internet: [email protected]
|Fax: [phone] or 1-303-924-6873
| Internet
|Visit our home page at http://www.printers.ibm.com
|When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it believes
|appropriate without incurring any obligation to you.
| Copyright International Business Machines Corporation 1993, 1999. All rights reserved.
|Note to U.S. Government Users — Documentation related to restricted rights — Use, duplication or disclosure is subject to
|restrictions set forth in GSA ADP Schedule Contract with IBM Corp.

Contents
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Programming Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Disclaimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
|Summary Of Changes ................................. xi
About This Publication ................................ xiii
Why Should I Read This Publication? ........................ xiii
What Do I Need To Know? .............................. xiii
How This Publication Is Organized .......................... xiv
What Terms Are Used In This Publication? ..................... xv
Related Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
Understanding Syntax Notation ........................... xvi
Highlighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
Notational Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
Part 1. Information Common to AIX, OS/390, MVS, VM, and VSE Environments 1
Chapter 1. Planning Your AFP Conversion and Indexing Facility (ACIF)
Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
What Can I Do with ACIF? ............................... 3
Using ACIF for Different Tasks ............................. 5
Tasks You Can Do with ACIF ............................ 9
What Other IBM Products are Related to ACIF? .................. 15
The Workbench Viewer ............................... 15
AFP Toolbox for Multiple Operating Systems .................. 16
Document Composition Facility (DCF) ...................... 17
What are the Systems Considerations for ACIF? ................. 17
System Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
System Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Part 2. Using ACIF in the AIX Environment ........................... 21
Chapter 2. Using ACIF Parameters in AIX .................... 23
Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Flags and Values .................................... 27
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Implementation Specifics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
NLS Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Suggested Reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapter 3. Example of an ACIF Application in AIX .............. 53
The Input File ...................................... 55
Specifying ACIF Processing Parameters for ASCII Input Data .......... 55
 Copyright IBM Corp. 1993, 1999 iii

Using a Parameter File with ASCII Input Data ................. 56
Specifying ACIF Processing Parameters for EBCDIC Input Data ........ 58
Using a Parameter File with EBCDIC Input Data ................ 58
Using the Shell with EBCDIC Literal Values ................... 61
Identifying the Locations of the Resources ..................... 61
Determining the Form Definition and the Page Definition ............. 62
Running the ACIF Job ................................. 62
ACIF Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Concatenating ACIF Output Files .......................... 62
Accessing the Document File from the Workstation ................ 63
Transferring the Document File to the Workstation ............... 63
Mounting the AIX Directory on the Workstation ................. 64
Chapter 4. User Exits and Attributes of the Input Print File in AIX .... 65
User Programming Exits ................................ 65
Input Record Exit .................................... 66
Using the ACIF User Input Record Exits ..................... 68
Index Record Exit ................................... 69
Output Record Exit ................................... 70
Resource Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Non-Zero Return Codes ................................ 74
Attributes of the Input Print File ............................ 74
Chapter 5. IBM AFP Fonts for ASCII Data .................... 77
Part 3. Using ACIF in the OS/390, MVS, VM, and VSE Environments ........ 79
Chapter 6. Using ACIF in OS/390, MVS, VM, and VSE ............ 81
Using ACIF in the OS/390 and MVS Environments ................ 81
Explaining the JCL Statements .......................... 81
Using ACIF in the VM Environment ......................... 82
Explaining the VM CMS Commands ....................... 83
Using ACIF in the VSE Environment ......................... 84
Explaining the VSE JCL Statements ....................... 85
|Chapter 7. Using ACIF Parameters in OS/390, MVS, VM, and VSE ..... 87
| Syntax Rules for OS/390, MVS, VM, and VSE Parameters ........... 87
Chapter 8. Example: ACIF Application in OS/390, MVS, VM, or VSE .. 113
Input File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
JCL, CMS Commands, and ACIF Processing Parameters ........... 115
OS/390 or MVS JCL to Invoke ACIF ...................... 115
VM CMS Commands to Invoke ACIF ...................... 117
VSE JCL to Invoke ACIF ............................. 117
ACIF Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Concatenating Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
OS/390 or MVS JCL ............................... 121
VM CMS Commands ............................... 121
Chapter 9. User Exits and Attributes of the Input Print File in OS/390,
MVS, VM, and VSE ................................ 123
User Programming Exits ............................... 123
Input Record Exit ................................. 123
iv ACIF User’s Guide

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 ........................... 130
Chapter 10. ACIF Messages for OS/390, MVS, VM, and VSE ....... 133
Multiple Message Scenarios ............................ 133
General Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Part 4. Appendixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Appendix A. Helpful Hints . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Working with control statements that contain numbered lines ......... 179
Placing TLEs in named groups ........................... 179
Working with file transfer and AIX ......................... 180
Understanding how ANSI and machine carriage controls are used ...... 181
Understanding common methods of transferring files to AIX from other
systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Physical media . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
PC file transfer program ............................. 182
FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Other Considerations for Transferring Files to AIX .............. 183
Invoke Medium Map (IMM) Structured Field ................... 183
Indexing Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Concatenating the Resource Group to the Document .............. 185
Specifying the IMAGEOUT Parameter ....................... 185
Appendix B. Data Stream Information ..................... 187
Tag Logical Element (TLE) Structured Field ................... 187
Format of the Resources File ............................ 188
Begin Resource Group (BRG) Structured Field ................. 189
Begin Resource (BR) Structured Field ....................... 189
End Resource (ER) and End Resource Group (ERG) Structured Fields ... 189
Appendix C. Format of the Index Object File ................. 191
Group-Level Index Element (IEL) Structured Field ................ 191
Page-Level Index Element (IEL) Structured Field ................ 192
Begin Document Index (BDI) Structured Field .................. 193
Index Element (IEL) Structured Field ....................... 193
Tag Logical Element (TLE) Structured Field ................... 194
End Document Index (EDI) Structured Field ................... 194
Appendix D. Format of the Output Document File ............. 195
Page Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Begin Document (BDT) Structured Field ..................... 198
Begin Named Group (BNG) Structured Field ................... 198
Tag Logical Element (TLE) Structured Field ................... 199
Begin Page (BPG) Structured Field ........................ 199
End Named Group (ENG), End Document (EDT), and End Page (EPG)
Structured Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Output MO:DCA-P Data Stream .......................... 200
Contents v

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Page Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Source Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Bibliography . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Print Services Facility (PSF) for OS/390 ..................... 207
Advanced Function Presentation (AFP) ...................... 207
Advanced Function Presentation (AFP) Architecture .............. 208
Advanced Function Presentation for Microfilm .................. 208
Fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Text Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
InfoPrint Manager for AIX .............................. 209
Print Services Facility (PSF) for AIX ........................ 209
Print Services Facility for OS/2 (PSF/2) ...................... 209
EDMSuite OnDemand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
i-data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
OS/390 Version 2 Release 6 ............................ 211
eNetwork Communications Server ......................... 212
MVS/Enterprise Systems Architecture (ESA) Version 5 ............. 212
TCP/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
TCP/IP for MVS ................................... 213
VTAM and NCP ................................... 213
Systems Network Architecture ........................... 214
AS/400 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Information/System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
vi ACIF User’s Guide

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 ........ 11
6. Example Bank Statement Input File ...................... 12
7. ACIF Processing Parameters to Index the Bank Statement ........ 13
8. Workbench Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
9. File Extensions for Resources ......................... 26
10. Example of a Customer’s Telephone Bill ................... 54
11. Line-Data Telephone Bill ............................ 55
12. Example of a Parameter File for ASCII Input Data ............. 56
13. Example of a Parameter File for EBCDIC Input Data ............ 59
14. Sample Input Record Exit C Language Header ............... 66
15. Sample Index Record Exit C Language Header ............... 69
16. Sample Output Record Exit C Language Header .............. 70
17. Sample Resource Exit C Language Header ................. 72
18. Sample Print File Attributes C Language Header .............. 74
19. Font Mapping Table for Use with the chars Parameter ........... 77
20. Sample OS/390 and MVS JCL to Invoke ACIF ............... 81
21. Sample VM CMS Commands to Invoke ACIF ................ 83
22. Sample VSE JCL to Invoke ACIF ....................... 84
| 23. ACIF Parameters, Tasks, and Operating Systems ............. 88
24. Example of a Customer's Phone Bill .................... 114
25. Line-Data Phone Bill .............................. 115
26. Example of a Telephone Bill for an OS/390 or MVS ACIF Application . 116
27. Example of a Telephone Bill for a VM ACIF Application ......... 117
28. Example of a Telephone Bill for a VSE ACIF Application ........ 118
29. Library Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
30. Sample Input Record Exit DSECT ...................... 124
31. Sample Index Record Exit DSECT ..................... 125
32. Sample Output Record Exit DSECT ..................... 127
33. Sample Resource Exit DSECT ........................ 128
34. Sample Print File Attributes DSECT ..................... 131
35. Example of Code Containing Group-Level Indexing ............ 196
36. Example of Code Containing Group- and Page-Level Indexing ..... 197
 Copyright IBM Corp. 1993, 1999 vii

viii ACIF User’s Guide