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: printpub@us.ibm.com
| Fax: 1-800-524-1519 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
Notices
References in this publication to products, programs, or services of IBM do not
suggest or imply that IBM will make them available in all countries where IBM does
business, or that only products, programs, or services of IBM may be used.
Noninfringing equivalents may be substituted, but the user must verify that such
substitutes, unless expressly designated by IBM, work correctly. No license,
expressed or implied, to patents or copyrights of IBM is granted by furnishing this
document. You can send license inquiries, in writing, to the IBM Director of
Licensing, IBM Corporation, North Castle Drive, Armonk, NY 10504-1785, USA.
Programming Interfaces
This publication documents intended Programming Interfaces that allow the
customer to write programs to obtain the services of ACIF.
ACIF provides no macros that allow a customer installation to write programs that
use the services of ACIF.
Attention: Do not use any ACIF macros as programming interfaces.
Disclaimer
All examples are for illustration only. Any references to existing businesses or
individuals is unintentional and does not imply any connection or relationship of any
kind between the businesses, individuals, and IBM.
Trademarks
The following terms appear in this publication and are trademarks of the IBM Corporation:
Advanced Function Presentation
AFP
AIX
AIX/6000
AT
Bar Code Object Content Architecture
BCOCA
BookManager
IBM
| InfoColor
| InfoPrint
| Intelligent Printer data Stream
IPDS
MVS/DFP
MVS/ESA
MVS/SP
OnDemand for AIX
Operating System/2
Operating System/400
OS/2
| OS/390
OS/400
Personal System/2
Presentation Manager
Print Services Facility
PrintManager
Proprinter
PSF
PSF for AIX
Quietwriter
RACF
RS/6000
System/370
System/390
S/390
The IBM Printing Systems Company
VM/ESA
VM/XA
WIN-OS/2
Copyright IBM Corp. 1993, 1999 ix
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 User’s Guide
Summary Of Changes
|
| This publication contains additions and changes to the previous edition,
| S544-5285-00. The technical additions and changes are marked with a revision bar
| to the left of the changes.
| The following new function has been added:
| INSERTIMM=YES|NO (see APAR PN92597)
| FONTECH=UNBOUNDED (see APAR PN77365)
| MCF2REF={CPCS | CF } (see APAR PQ04391)
| PRMODE=SOSI3 (see APAR PQ07139)
| RESTYPE=...[,OBJCON][,BCOCA][,GOCA][,IOCA] (see APAR PQ02350)
| The APARs addressed in this publication include:
| PN77365
| You can use the FONTECH parameter to indicate to ACIF that the fonts are in
| the unbounded box format. The only valid value for FONTECH is
| other values will cause ACIF to terminate with an error. Unbounded box fonts
| are supported
only
by the IBM 3800 printer.
unbounded
;
| PN77694
| If you attempt to print the front and back sides of a sheet from different input
| bins, ACIF issues error message APK252I.
| PN84383
| You can use ACIF to create either a sequential data set or a partitioned data
| set. This publication describes the JCL parameters necessary to successfully
| create a resource data set as either partitioned or sequential.
| PN92597 and PN91755
| You can use an INSERTIMM parameter to view named page groups as
| stand-alone entities.
| PQ02350
| You can use additional values with the RESTYPE parameter: BCOCA, GOCA,
| and IOCA. ACIF searches the libraries specified by the PSEGLIB parameter
| and USERLIB parameter to find these objects. If BCOCA, GOCA, and/or IOCA
| is specified for RESTYPE, ACIF includes all of those types of objects required
| to print or view the output document in the resource object file. Note that page
| segments referenced by an IOB structured field cannot contain IM1 image or
| PTOCA data.
| PQ04391
| You can use a new conversion parameter and resource retrieval parameter to
| specify the way ACIF builds the MAP Coded Font 2 (MCF2) structured field in
| the output file and the resobj file.
| PQ07139
| ACIF supports a new PRMODE value. PRMODE=SOSI3 is supported in the
| same manner as by PSF/MVS, with each shift out character being converted to
Copyright IBM Corp. 1993, 1999 xi
| 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)
| APK278S (APAR PQ02350)
| APK343I (APAR PQ07139)
| APK345I (APAR PQ07139)
| APK441S (APAR PN84835 and PN89280)
| APK443S (APAR PN92597 and PN91755)
| APK444S (APAR PN92597 and PN91755)
| APK445S (APAR PN92597 and PN91755)
| APK446S (APAR PN92597 and PN91755)
| APK915S (APAR PN84835)
| APK916S (APAR PN84835)
| APK917S (APAR PN84835)
| APK918S (APAR PN84835)
| APK919S (APAR PN84835)
xii ACIF User’s Guide
About This Publication
This publication describes Advanced Function Presentation Conversion and
Indexing Facility (ACIF), which allows you to format and print System/390 line data
and unformatted ASCII files with IBM Print Services Facility in the following
environments:
OS/390
MVS
VM
VSE
AIX
ACIF also provides indexing and resource retrieval capabilities that allow you to
view, archive, and retrieve document files. ACIF is supported in the OS/390, AIX,
MVS, VM, and VSE environments by IBM Print Services Facility (PSF).
This section identifies who should use this publication, how it is organized, the
formatting conventions used, and a list of publications related to the product.
Why Should I Read This Publication?
Application programmers should use this publication as a guide and reference
when they are developing ACIF applications. ACIF is a batch application
development utility enabling creation of documents that can be printed, viewed,
distributed, archived, and retrieved with fidelity across systems and platforms.
Using ACIF, you can:
Convert line-format print files to MO:DCA-P documents
Add indexing tags to documents; create a separate index object file from the
indexing tags in a MO:DCA-P document
Retrieve and package AFP resources needed for printing or viewing a
MO:DCA-P document
What Do I Need To Know?
This publication assumes that you are familiar with Advanced Function Presentation
(AFP) concepts as well as the parameters that you specify when printing with Print
Services Facility (PSF). If you are not familiar with AFP concepts, refer to
Advanced Function Presentation
parameters, refer to either:
the PSF user's guide for your operating system, as listed in “Bibliography” on
page 207.
IBM Print Services Facility for AIX: Print Submission
Guide to
. If you are not familiar with the PSF print
or
The publication also assumes that you are somewhat familiar with the MO:DCA-P
architecture and structured fields. You may want to order
Content Architecture Reference
Guide and Line Data Reference
Note: This publication provides ACIF messages for the OS/390, MVS, VM, and
VSE environments, which contain instructions for the system programmers
responsible for maintaining the operating system and the PSF program
Copyright IBM Corp. 1993, 1999 xiii
and
Advanced Function Presentation: Programming
to read about these topics.
Mixed Object Document
running on it. You may need to show these messages to your system
programmer for assistance from time to time.
How This Publication Is Organized
This publication contains information pertaining to ACIF support for AIX, OS/390,
MVS, VM, and VSE operating environments supported by PSF. However, because
AIX users can invoke the PSF MSG command to view AIX messages on-line or
print them, the AIX messages have not been duplicated in this publication.
Part one contains information common to AIX, OS/390, MVS, VM, and VSE.
– Chapter 1, Planning Your AFP Conversion and Indexing Facility (ACIF)
Application presents an overview of tasks you can do with the ACIF
product, describes several related products, and describes system
considerations for using ACIF.
Part two contains information specific to AIX.
– Chapter 2, Using ACIF Parameters in AIX describes the acif command,
including syntax rules, parameters, and their values.
– Chapter 3, Example of an ACIF Application in AIX describes the steps for
developing an ACIF application for AIX.
– Chapter 4, User Exits and Attributes of the Input Print File in AIX describes
the exits available in AIX for customizing ACIF.
– Chapter 5, IBM AFP Fonts for ASCII Data provides a list of the fonts for
use with unformatted ASCII input data in AIX.
Part three contains information specific to OS/390, MVS, VM, and VSE.
– Chapter 6, Using ACIF in OS/390, MVS, VM, and VSE provides sample
code for invoking ACIF in the OS/390, MVS, VM, and VSE environments.
– Chapter 7, Using ACIF Parameters in OS/390, MVS, VM, and VSE
describes the parameters used for ACIF processing in the OS/390, MVS,
VM, and VSE environments.
– Chapter 8, Example: ACIF Application in OS/390, MVS, VM, or VSE
describes the steps for developing an ACIF application.
– Chapter 9, User Exits and Attributes of the Input Print File in OS/390,
MVS, VM, and VSE describes the exits available for customizing ACIF.
– Chapter 10, ACIF Messages for OS/390, MVS, VM, and VSE provides the
ACIF messages, with suggestions for responding to the errors.
The appendix section through the end of this publication contains more
information common to AIX, OS/390, MVS, VM, and VSE.
– Appendix A, Helpful Hints describes some considerations of using ACIF as
a front-end preprocessor for viewing, archiving, and retrieving information.
– 36 describes the structured-field information for indexing.
– Appendix C, Format of the Index Object File describes the file that enables
applications to determine the location of a page group or page within the
MO:DCA-P print file, based on the indexing tags.
– Appendix D, Format of the Output Document File shows the three separate
output files that ACIF can produce.
xiv ACIF User’s Guide
To order additional printed copies of this publication, use order number
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 are terms this publication uses, plus a description of how those terms
apply to your system:
Document In all systems:
A file that contains AFP structured fields in Mixed Object:
Document Content Architecture - Presentation (MO:DCA-P) format
File In AIX and OS/2:
A collection of related data
In OS/390 and MVS:
A sequential data set
A member of a partitioned data set
A name of a DD card
S544-5285
In VM:
A CMS file (filename filetype filemode)
In VSE:
A sequential (SAM) file
Library In AIX:
A directory in which AFP resources are stored
In OS/2:
A directory
A list of files stored on a disk or diskette
In OS/390 or MVS:
A partitioned data set
A series of concatenated data sets
In VM:
A collection of CMS files, generally with the same file type
In VSE:
A library.sublibrary
About This Publication xv
Related Information
Publications that are referred to in this book or that contain additional information
about Advanced Function Presentation (AFP), the MVS operating system, PSF, and
related products are listed in the “Bibliography” on page 207.
For additional information about OS/390 and PSF for OS/390, refer to these Web
pages:
http://www.ibm.com/s39/os39
http://www.printers.ibm.com/pbin-id/go?/pdocs/psf39/home.html
To obtain the latest documentation updates for OS/390 base elements and optional
features that result from DOC APARs and PTFs, refer to the DOC APARs and
++HOLD DOC Web page:
http://www.s39.ibm.com/os39/bkserv/new_tech_info.html
To obtain the latest documentation updates for PSF for OS/390, refer to these
members in SYS1.SAMPLIB:
Member Publication
APSGCUSU
APSGDGNU
APSGDLGU
APSGMACU
APSGSECU
APSGUSRU
Understanding Syntax Notation
This publication uses consistent conventions for the following:
Highlighting
Notational conventions
Highlighting
This publication uses the following highlighting conventions:
Bold Identifies commands, keywords, files, directories, and other items,
whose names are predefined by the system or must be entered as is,
such as acif.
PSF for OS/390: Customization
PSF for OS/390: Diagnosis
PSF for OS/390: Download for OS/390
PSF for OS/390: Messages and Codes
PSF: Security Guide
PSF for OS/390: User’s Guide
, S544-3291
, S544-5622
, G544-5623
, S544-5630
, G544-5624
, G544-5627
Italic
Identifies parameters whose actual names or values you supply.
Italics also identify the names of publications.
Monospace Identifies examples of specific data values, examples of text similar to
what you might see displayed, examples of portions of program code
similar to what you might write as a programmer, messages from the
system, or information you should actually type.
xvi ACIF User’s Guide
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=
means that you enter cpgid= as shown and then replace the variable
page identifier
three-character decimal value (for example, 395) that defines an IBM-registered
code page.
Do not enter the following symbols as part of the command:
Bar |
Braces { }
Brackets [ ]
Underscore _
These symbols have the following meanings:
A vertical bar, |, between values indicates that you can only enter one of the
values with the command. For example:
cc={yes | no}
means that when you enter cc=, you can specify either yes or no as the value,
but not both.
Note: In AIX, sometimes the vertical bar, |, acts as a pipe. When the pipe
code page identifier
code
with a value that represents any valid code page, which is
symbol appears between commands, it indicates that the output from
the first command becomes the input to the second command. For
example:
acif inputdd=myfile | enq -P3825A
means that the output generated by the acif command is the input to the AIX
enq command, which prints the file.
Braces, { }, around values indicate a required value. For example:
cc={yes | no}
means that when you enter cc=, you must also enter yes or no.
Brackets, [ ], around parameters indicate that they are optional. For example:
[cc=
means that you do not have to enter either cc=
An underscore, _, indicates the default value, which ACIF uses if you do not
specify the parameter with a non-default value. For example:
means that if the cc parameter is not entered, ACIF uses the default value of
yes for the cc parameter.
value
][cctype=
cc={yes | no}
value
]
value
or cctype=
value
.
About This Publication xvii
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 (ACIF) is a batch application development
utility you can use to:
Convert line data or mixed data into MO:DCA-P data, which is an architected,
device-independent data stream used for interchanging documents between
different platforms
Index a document to enhance your ability to view, archive, or retrieve individual
pages or groups of pages from large documents; create a separate
object file
from the indexing tags
index
Retrieve and package AFP resources needed for printing or viewing a
document and place them in a separate file, so that you can print and view the
exact document, possibly years after its creation
Figure 1 on page 4 shows a high-level overview of how the ACIF application
development utility fits into an installation's AFP process for creating, indexing,
viewing, and printing documents.
Copyright IBM Corp. 1993, 1999 3
Figure 1. How ACIF Fits into Advanced Function Presentation
The figure shows the resources and the text data, which can be provided and used
by various AFP and AFP-compatible products. With ACIF, data and resources can
feed into ACIF for processing and can be sent to a customer-supplied archival and
retrieval system, to the spool, or to the Viewer application of AFP Workbench for
viewing.
ACIF accepts data from your application in the following formats:
AFP data
MO:DCA-P data
S/370 line-mode data
Mixed-mode data
Unformatted ASCII data (AIX only)
Put simply, ACIF can process application print data and AFP resources to produce
three types of files:
1. An AFP document file
2. An AFP resource file
3. An AFP index object file
4 ACIF User’s Guide
With the files that ACIF creates, you can do the following:
Use PSF to print the AFP document file. If you have specified resources in the
AFP document file, PSF for AIX references the AFP resource file for the names
and locations of the resources. The AFP document file must be concatenated
to the end of the resource file before the file is printed.
Use the Viewer application of AFP Workbench (hereafter referred to as
“Workbench Viewer”) to view the AFP document file. Workbench Viewer takes
MO:DCA-P data and resources as input to produce output that can be viewed.
Store report files and the index file entries created by ACIF in a document
archival system, such as IBM OnDemand for AIX. OnDemand operates in a
client/server environment and supports small office environments as well as
large enterprise installations with hundreds of system users. OnDemand
provides a server to store report files and other types of business documents.
End-users can search for and retrieve files from the server with client programs
that run under Microsoft Windows and MVS CICS/ESA. OnDemand supports
full fidelity viewing and reprinting of report files on local and remote printers.
Use your own archive system to store the ACIF-created files.
Use your own retrieval system to access information in the ACIF files, using
retrieval information in the index object file.
Using ACIF for Different Tasks
ACIF can process your files to allow:
Viewing with Workbench Viewer
Printing locally and on other systems
Selective archiving and retrieval
Chapter 1. Planning Your AFP Conversion and Indexing Facility (ACIF) Application 5
Figure 2. Using ACIF to Prepare Files for Viewing
Figure 2 shows the path your data takes when you are preparing files for viewing
with the Workbench Viewer.
1. The process begins with your application (1), which is the program that
processes your print data.
2. Your application creates your print data (2a) and optionally creates ACIF
processing parameters (2b). Resources are stored in the PSF resource
libraries (2c).
3. You run ACIF (3), specifying that it create the index object file (3a), the AFP
document (3b), and the resource file (3c).
4. For optimal performance in locating pages in a file, you concatenate (4) the
index object file (3a) to the AFP document (3b). If the resources used by the
6 ACIF User’s Guide
document are not present on the workstation where the Workbench Viewer is
installed, you concatenate the resource file (3c) to the AFP document file. The
order of concatenation must be as shown in Figure 2, with the document file
concatenated last.
5. Transfer the needed files in binary format to the workstation.
6. Using the Workbench Viewer, view your indexed document. You can also print
the document from the Workbench Viewer.
Figure 3. Using ACIF to Prepare Files for Distributed Printing
Figure 3 shows the steps to perform to prepare your files for printing:
Chapter 1. Planning Your AFP Conversion and Indexing Facility (ACIF) Application 7
1. Run ACIF, specifying that the resource file (1b) be created along with the AFP
document file (1a).
If you are using ACIF on AIX and your resources reside on another operating
system, you can use the AIX Network File System (NFS) to mount them to the
AIX system where you are running ACIF.
2. If the print driver program (PSF) that manages jobs for your target printer runs
on a different operating system than the one you run ACIF on, transfer the files
in binary format to the system where PSF runs.
If your resources are not present on the remote PSF platform, concatenate the
AFP document file to the end of the resource file before submitting the file to
PSF. If your resources are already present on the remote PSF platform, you do
not have to concatenate or transmit them.
3. Submit your MO:DCA-P print job to PSF.
Figure 4. Using ACIF to Prepare Files for Archiving and Retrieving
Figure 4 shows numbered steps you can use to archive your files:
1. Run ACIF, specifying that both the index object file (1a) and the resource file
(1c) be created.
2. Run your archival application to archive (3) all three files (1a, 1b, 1c), so that
the document can later be retrieved (4) and viewed or printed with fidelity.
8 ACIF User’s Guide
Tasks You Can Do with ACIF
This section describes the three tasks for which you can use ACIF. The tasks are
listed in the order in which they are described, not in any order in which they
should be done.
Converting data streams
Indexing documents
Retrieving resources
Converting Data Streams
ACIF processes the following input data streams to create a MO:DCA-P document.
AFP data
MO:DCA-P data
S/370 line-mode data
Line-mode data
Mixed-mode data
Unformatted ASCII (AIX only)
The following sections describe each type of data and refer you to additional
publications, if you need to better understand them:
AFP Data:
supports the following objects:
Graphics (GOCA)
Presentation text (PTOCA)
Image (IOCA and IM)
Bar-code (BCOCA)
The AFP data stream also supports print resources such as fonts, overlays, page
segments, form definitions, and page definitions. For more information on this data
stream format, refer to
which points to publications describing the other types of data objects.
Mixed Object Document Content Architecture Data:
data as a valid input data stream, with the following restrictions:
Every structured field must appear in one record and cannot span multiple
records.
Each record (structured field) must contain a X'5A' character before the first
byte of the structured field introducer.
ACIF does not change the MO:DCA-P structured fields it processes, because they
are already in the correct format. However, although the MO:DCA-P input data
stream may contain multiple Begin Document (BDT) and End Document (EDT)
structured fields, the ACIF output contains only one BDT/EDT structured-field pair.
The AFP data stream is a superset of the MO:DCA-P data stream and
Mixed Object Document Content Architecture Reference
ACIF supports MO:DCA-P
,
For more information about this data stream, refer to
Content Architecture Reference
S/370 Line-Mode Data:
that may begin with a single carriage control character, which may be followed by a
single table reference character (TRC). After these characters, zero or more bytes
of EBCDIC data may follow. ACIF formats S/370 line-mode data into pages by
Chapter 1. Planning Your AFP Conversion and Indexing Facility (ACIF) Application 9
.
S/370 line-mode data is characterized by records of data
Mixed Object Document
using a page-definition (PAGEDEF) resource, in the same way as does PSF. For
more information about line data, refer to
Programming Guide and Line Data Reference
Advanced Function Presentation:
.
Mixed-Mode Data:
inclusion of some AFP structured fields, composed-text pages, and resource
objects such as image, graphics, bar code, and text. For more information about
this data stream, refer to
Line Data Reference
Unformatted ASCII Data:
workstation environment and has not been formatted for printing. Unformatted
ASCII data is formatted by ACIF using a page definition resource. Unformatted
ASCII data is contrasted with the type of ASCII data that contains control
characters (or, escape sequences) for the IBM Proprinter and Quietwriter, and does
not need to be formatted by ACIF before printing with PSF for AIX. Unformatted
ASCII can also be submitted for printing with PSF for AIX without being converted
by ACIF, but the output format is predetermined (using a Proprinter emulation font
and 60 lines per page, for example).
A page definition can be created for use in an unformatted ASCII file to allow the
use of AFP functions such as varied print directions, multiple-up printing, and
different fonts in the output format. You can use IBM Page Printer Formatting Aid
for AIX (PPFA for AIX) to create your own page definitions. PPFA for AIX is a
separate feature of PSF for AIX that you can order. For information on how to
create page definitions using PPFA for AIX, refer to
Aid: User's Guide
Mixed-mode data is a mixture of line-mode data, with the
Advanced Function Presentation: Programming Guide and
.
Unformatted ASCII data is data that is generated in the
IBM Page Printer Formatting
.
Indexing Documents
One of the principal tasks you can do with ACIF is indexing print files, which are
also known as documents. When indexing with ACIF, you can divide (segment) a
large print file into smaller, uniquely identifiable units, called
the MO:DCA-named group structured fields. Using ACIF, you can divide the large
bank-statement application into the individual groups by inserting in the file
structured fields that define the group boundaries. A group is a named collection of
sequential pages, which, in this application, consists of the pages describing a
single customer's account. For example, when you print a bank-statement
application, you probably produce a large printout consisting of thousands of
individual customer statements. You can think of each of these statements as a
smaller, separate unit, each of which is uniquely identified by an account number or
other attributes such as date and Social Security number.
Using ACIF, you can also create an index object file, which enables you to:
Retrieve individual statements from storage, based on an account number or
any other attribute
More rapidly access the statements for viewing by, for example, the Workbench
Viewer.
Archive individual statements or the entire indexed print file for long-term
storage and subsequent data management and reprinting, even years after its
creation
groups
, as defined by
In addition to building an index-information file containing structured fields (the
index object file
), ACIF also inserts strings of character data called
tags
in the print
10 ACIF User’s Guide
Loading...