IBM S544-5285-01, User Manual

Page 1: ...IBM Print Services Facility IBM AFP Conversion and Indexing Facility User s Guide S544 5285 01...

Page 2: ......

Page 3: ...IBM Print Services Facility IBM AFP Conversion and Indexing Facility User s Guide S544 5285 01...

Page 4: ...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 thi...

Page 5: ...tion 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...

Page 6: ...s 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...

Page 7: ...e 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 Gr...

Page 8: ...ion 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...

Page 9: ...er 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...

Page 10: ...viii ACIF User s Guide...

Page 11: ...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...

Page 12: ...f 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...

Page 13: ...uential 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 Yo...

Page 14: ...50 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 APK44...

Page 15: ...O 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 M...

Page 16: ...e 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...

Page 17: ...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 dat...

Page 18: ...4 5622 APSGDGNU PSF for OS 390 Diagnosis G544 5623 APSGDLGU PSF for OS 390 Download for OS 390 G544 5624 APSGMACU PSF for OS 390 Messages and Codes G544 5627 APSGSECU PSF Security Guide S544 3291 APSG...

Page 19: ...s or no as the value but not both Note In AIX sometimes the vertical bar acts as a pipe When the pipe symbol appears between commands it indicates that the output from the first command becomes the in...

Page 20: ...amples 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 Gui...

Page 21: ...Part 1 Information Common to AIX OS 390 MVS VM and VSE Environments Copyright IBM Corp 1993 1999 1...

Page 22: ...2 ACIF User s Guide...

Page 23: ...endent 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 docu...

Page 24: ...stomer 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...

Page 25: ...es 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 ot...

Page 26: ...int 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 cr...

Page 27: ...nt 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 Vie...

Page 28: ...sources 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 remo...

Page 29: ...which points to publications describing the other types of data objects Mixed Object Document Content Architecture Data ACIF supports MO DCA P data as a valid input data stream with the following rest...

Page 30: ...of PSF for AIX that you can order For information on how to create page definitions using PPFA for AIX refer to IBM Page Printer Formatting Aid User s Guide Indexing Documents One of the principal ta...

Page 31: ...on ACIF provides the following ways for you to generate the indexing tags placed in the print file Using values present in the input data itself when the data has been formatted so that ACIF can relia...

Page 32: ...without specifying any indexing parameters 2 ACIF includes the name of the output document in the index object file and includes the name of the index object file in the output document which provides...

Page 33: ...g trigger1 as the anchor point The field definitions are relative to this anchor point In the example Figure 7 the account number has four fields These fields can be defined as one field if the dashes...

Page 34: ...ibraries is based on the value of the restype parameter When ACIF processes a print file it Identifies the resources requested by the print file While ACIF converts the input file into an AFP document...

Page 35: ...er 3 Example of an ACIF Application in AIX on page 53 What Other IBM Products are Related to ACIF Although ACIF is a stand alone utility it has been designed for use with other programs These programs...

Page 36: ...ormation to 64 bytes When indexing data for viewing make your attribute names unique within the first 64 bytes ACIF allows up to 250 bytes for attribute names Workbench Viewer supports a subset of MO...

Page 37: ...onment What are the Systems Considerations for ACIF You must consider the following when using ACIF System limitations System prerequisites System Limitations If you are using ACIF to build applicatio...

Page 38: ...The pagedef parameter is required for running ACIF if the input file contains S 370 line data mixed mode data or unformatted ASCII data Though you may use page definitions from other sources several p...

Page 39: ...rinting files that contain indexing tags or PSF VSE 2 2 1 or above Note You can use later versions or releases of these products Each of the above products may require additional software products Ref...

Page 40: ...20 ACIF User s Guide...

Page 41: ...Part 2 Using ACIF in the AIX Environment Copyright IBM Corp 1993 1999 21...

Page 42: ...22 ACIF User s Guide...

Page 43: ...ers In order for ACIF to receive these single quote characters you must escape the quote characters so that your shell will not parse them The way you escape quote characters depends on the shell you...

Page 44: ...n do the following Print the file on a printer defined to PSF for AIX or to other PSF products View the file using a viewer product such as AFP Workbench Archive and retrieve the file using your own a...

Page 45: ...4 Paths specified by the PSFPATH environment variable 5 The directory usr lpp psf reslib 6 The directory usr lpp afpfonts For InfoPrint Manager for the AIX environment the fonts are included in the A...

Page 46: ...mmand you will be able to transform and print files but you will not be able to take advantage of the indexing and resource retrieval Figure 9 File Extensions for Resources Type of Resource File Exten...

Page 47: ...ne will be formatted single space double space triple space and so forth In addition other carriage controls can be used to position the line anywhere on the page If there are no carriage controls sin...

Page 48: ...age control characters are in your input file consult your system support group chars fontname1 fontname2 fontname3 fontname4 Specifies the file name of from one to four coded fonts to be used in proc...

Page 49: ...apka2e or asciinpe input record exit programs to convert the ASCII code points in the input file into EBCDIC and use EBCDIC fonts To do this use the inpexit parameter specifying inpexit usr lpp psf bi...

Page 50: ...example comsetup mysetup userlib usr afp resources or comsetup mysetup objconlib usr lib setups If the COM setup file is an inline resource you must do the following Specify comsetup name where name i...

Page 51: ...th FQNs ACIF does not generate page names yes ACIF uses structured field tokens in the input data stream to generate page names no The default ACIF generates page names using an 8 byte counter fdeflib...

Page 52: ...tes processing length Specifies the number of contiguous bytes characters starting at column that compose this field The supported range of values for length are 1 to 250 The field can extend outside...

Page 53: ...the input file If you do not specify fileformat the acif command uses stream as the default The fileformat parameter does not apply to input files that are resources Resource files are in MO DCA P or...

Page 54: ...t For example you could use newline as follows fileformat stream newline X D If newline is not specified ACIF uses the algorithm specified under fileformat stream fontlib pathlist Specifies the direct...

Page 55: ...cc yes to indicate that the file contains carriage control characters Specify formdef fdefname where fdefname is the name of the inline form definition or specify formdef dummy If you specify formdef...

Page 56: ...fied for all indexn parameters and if any triggern parameters are also specified For field parameters that specify data values within the file ACIF determines the actual location of the indexing infor...

Page 57: ...field2 field3 The example above specifies that the first index tag is made up of the literal character string 1234567 while the other two index tags are made up of fields within the file records field...

Page 58: ...age number one greater than the number of header pages indexstartby 3 If ACIF does not find an indexing field before the page number specified in the indexstartby parameter it issues a message and sto...

Page 59: ...ms However if your unformatted ASCII file contains carriage returns and form feeds you may want to specify the following exit program supplied with PSF for AIX inputdd filename Specifies the full path...

Page 60: ...command calls this program for every output record every line it writes to the output document file outputdd If you specify the file name without a path the acif command searches for the file name in...

Page 61: ...cify pagedef memo The acif command does not require a page definition when indexing an AFP data stream file However ACIF does require a page definition to transform an input file that contains S 370 l...

Page 62: ...into a file so that you do not have to type all of them on the command line whenever you use ACIF Values are filename The name of the file containing acif command parameters and values Notes 1 The be...

Page 63: ...n must be a single byte font and the second font must be a double byte font pseglib pathlist Specifies the directories in which page segments BCOCA GOCA and IOCA objects are stored The value is pathli...

Page 64: ...for specific types of resources 3 Paths specified by the reslib parameter 4 Paths specified by the PSFPATH environment variable 5 The directory usr lpp psf reslib 6 The directory usr lpp afpfonts 7 T...

Page 65: ...le ioca Specifies that all IOCA objects included by an IOB structured field required to print or view the output document file be included in the resource file See the reslib parameter for a descripti...

Page 66: ...and one byte of data will be lost from each line If you specify trc no or you do not specify trc at all but your data contains a TRC as the first character or second if carriage control characters are...

Page 67: ...value can be 1 253 bytes in length If the combined values of column and the trigger length exceed the physical length of the record ACIF considers the comparison false and continues processing For ex...

Page 68: ...te the string No is the default if you specify dcfpagenames yes Specify no if you use the AFP API to generate your own group names userlib pathlist Specifies the names of user directories containing A...

Page 69: ...ontrol characters This particular input file is in S 370 variable length record format so you indicated this by specifying fileformat record The pagedef and formdef parameters are required with your l...

Page 70: ...use a form definition FORMD1A and an overlay that are stored in the general resource directory at your location usr site resdir To be sure that ACIF finds the resources you want to use specify the fo...

Page 71: ...Traditional Chinese English French French Canadian German or Japanese The message files can be found in usr lib nls msg country of choice Consult the description of the NLSPATH and LANG environment v...

Page 72: ...52 ACIF User s Guide...

Page 73: ...en the bills are printed 4 Determining the form definition and page definition used to print the bills 5 Running the ACIF job 6 Concatenating the index object file the resource file and the document f...

Page 74: ...f 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...

Page 75: ...DATE TIME TO PLACE TO AREA NUMBER MINUTES AMOUNT 3 1 DEC 11 7 15P LOVELAND CO 3 3 666 7777 6 82 2 DEC 15 9 16A NIWOT CO 3 3 555 6666 12 1 56 3 DEC 24 9 32P SANTA BARBARA CA 8 5 999 6666 32 15 8 4 DEC...

Page 76: ...fontlib usr res fontlib1 usr res fontlib2 font directories ovlylib usr res ovlylib1 usr res ovlylib2 overlay directories pdeflib usr res pdeflib1 usr res pdeflib2 pagedef directories pseglib usr res p...

Page 77: ...index anchor record starting in byte 66 and extending for 15 bytes specify field1 13 66 15 index1 Account Number field1 To create the indexing tag for the Name attribute define Name as the indexing at...

Page 78: ...le that can be used to process ACIF parameters when the input file is in EBCDIC For the sake of this example assume that the data was generated on a S 370 and is accessed via NFS The disk where the in...

Page 79: ...s restype fdef pseg ovly resource type selection FILE INFORMATION indexdd INDXOBJ index file name inputdd usr data INFILE input path file name msgdd acif msg error message file name outputdd OUTDOC ou...

Page 80: ...the hexadecimal string for Name as the indexing attribute Locate the value for Name in the anchor record in the data starting at byte 50 and extending for 30 bytes The ACIF parameters to specify this...

Page 81: ...2nd index attribute index2 do the following 1 Create a shell environment variable to hold the EBCDIC literal To do this using the AIX axeb command enter attr2 echo n Name axeb To do this using the AI...

Page 82: ...running shell scripts refer to IBM Print Services Facility for AIX AIX for Users of Print Services Facility The acif command then processes the parameters that you have specified on the command line i...

Page 83: ...le to the workstation or you mount your AIX directory on the workstation system you must have TCP IP installed on both the AIX system and on the workstation system where Workbench Viewer is installed...

Page 84: ...get NEWFILE The file will now be copied to the workstation where you may open it for viewing with Workbench Viewer Mounting the AIX Directory on the Workstation You can mount your AIX directory on th...

Page 85: ...rovides the following sample exits usr lpp psf acif apkinp c Input record exit usr lpp psf acif apkind c Index record exit usr lpp psf acif apkout c Output record exit usr lpp psf acif apkres c Resour...

Page 86: ...t Note TLEs are not supported in line mode or mixed mode data Figure 14 contains a sample C language header that describes the control block that is passed to the exit program typedef struct _INPEXIT_...

Page 87: ...then supply the saved record at the next call After the exit inserts the last record the exit program must reset the request byte to X 00 A value of X 00 on entry to the exit program specifies that t...

Page 88: ...ter X 0C byte 0 is transformed into an ANSI skip to channel 1 command X 31 that serves as a form feed in the carriage control byte To execute the asciinp input record exit program set the following pa...

Page 89: ...all indicator to ACIF INDXEXIT_PARMS Figure 15 Sample Index Record Exit C Language Header The address of the control block containing the following parameters is passed to the index record exit work B...

Page 90: ...n This end of file flag used as a last call indicator allows the exit program to return control to ACIF The exit program cannot change this parameter Output Record Exit Using the output record exit yo...

Page 91: ...ssed 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 p...

Page 92: ...ple C language header that describes the control block that is passed to the exit program typedef struct _RESEXIT_PARMS Parameters for the resource record exit char work Address of 16 byte static work...

Page 93: ...te 18 Specifies how the resource 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...

Page 94: ...r as specified on the acif command ACIF uses the default value if this parameter is not explicitly specified cctype Byte 4 The value of the cctype parameter as specified on the acif command ACIF uses...

Page 95: ...e string For example if pagedef P1TEST is specified on the acif command the page definition value in the above data structure is P1TEST 2 Exit programs cannot change the values supplied in this data s...

Page 96: ...76 ACIF User s Guide...

Page 97: ...he eight character names that correspond to the six character names You may use these short names without the X prefix to satisfy the four character limitation for specifying font names with the chars...

Page 98: ...the IBM 3800 printer They are not supported by any other printer or the Viewer Any resource object file archived will have very limited use Unbounded box fonts cannot be used by PSF for AIX or by Inf...

Page 99: ...Part 3 Using ACIF in the OS 390 MVS VM and VSE Environments Copyright IBM Corp 1993 1999 79...

Page 100: ...80 ACIF User s Guide...

Page 101: ...Sample OS 390 and MVS JCL to Invoke ACIF Explaining the JCL Statements The JCL statements in Figure 20 are explained as follows For more information about programming JCL refer to OS 390 MVS JCL Refe...

Page 102: ...This statement is not required if RESTYPE NONE is specified in the processing parameter data set See page INDEX This DD statement defines the name of the index object file that ACIF creates as a resu...

Page 103: ...Figure 21 this is the same print file that is created by USERAPPL OUTPUT Defines the DDname for the file that ACIF creates as a result of processing the application s print file RESOBJ Defines the DDn...

Page 104: ...virtual memory to convert and index files The amount of memory can vary depending on the complexity of the input data and the conversion and indexing options requested Using ACIF in the VSE Environme...

Page 105: ...e processed by ACIF In the sample in Figure 22 on page 84 this is the same data set as defined by the PRNTOUT file ASSGN SYS007 DLBL OUTPUT EXTENT SYS007 Defines the document file that ACIF creates as...

Page 106: ...86 ACIF User s Guide...

Page 107: ...meter files Each parameter with its associated values can span multiple records but the parameter and the first value must be specified in the same record If additional values need to be specified in...

Page 108: ...g System CC YES NO A OS 390 MVS VM VSE CCTYPE A M Z C OS 390 MVS VM VSE CHARS fontname1 fontname2 fontname3 fontname4 C R OS 390 MVS VM VSE COMSETUP name R OS 390 MVS CPGID 500 code page identifier I...

Page 109: ...N BCOCA GOCA ICOA R OS 390 MVS VM VSE TRACE YES NO G OS 390 MVS VM VSE TRACEDD ddname G VM TRACEDD TRACE filename DEVT TAPE DISK G VSE TRC YES NO C OS 390 MVS VM VSE TRIGGERn record column value X val...

Page 110: ...er is a X 13 which also represents double spacing the print position will be moved down two lines but the line that contains the X 13 carriage control character will not be printed The next line in th...

Page 111: ...g the PAGEDEF parameter that specifies fonts for your file the CHARS parameter is ignored 5 If you do not specify a CHARS parameter and if no fonts are contained in the page definition you specified A...

Page 112: ...ranslation tables to represent the information If this parameter is not specified ACIF uses code page 500 as the default For code page numbers less than 100 add leading zeros for example 037 If a non...

Page 113: ...specified If FDEFLIB is not specified ACIF reports an error condition and terminates processing FDEFLIB This parameter is not used for VSE Form definition resources are located in the library defined...

Page 114: ...ord TRIGGER1 It 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 It is 10 bytes in length starting at the f...

Page 115: ...rror condition and terminates processing FONTLIB filetype1 filetype2 filetype VM Specifies the file types that define the font libraries A maximum of 8 file types can be specified This parameter also...

Page 116: ...m definition from your user library instead of from a library specified in the FDEFLIB parameter To use a form definition from a user library you must Reference the user library containing the form de...

Page 117: ...ter only when the file is indexed The Viewer application of AFP Workbench 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...

Page 118: ...250 bytes the total of all specified FIELDn parameters for a single index cannot exceed this length ACIF reports an error condition and terminates processing if this occurs EXAMPLE FIELD1 1234567 FIEL...

Page 119: ...ied ACIF uses GROUP as the default Choose NONE if you do not require an external index file Choosing NONE will also reduce ACIF storage requirements INDEXSTARTBY 1 nn Specifies the output page number...

Page 120: ...format of the input data set VSE only F Fixed FB Fixed Block V Variable VB Variable Block DEVT TAPE DISK Note ACIF does not support VSAM input Specifies the device type either TAPE or DISK OBJCONLIB d...

Page 121: ...racter string containing only those alphanumeric characters supported in the operating environment Characteristics of the file are A block size of 32760 A maximum record length of 32756 If a record le...

Page 122: ...e1 it continues the search with filetype2 and so on until it either locates the requested resource or exhausts the list of specified files EXAMPLE OVLYLIB OVLY38PP TEMPOVLY Notes 1 File types must con...

Page 123: ...ied If a page definition resource is included inline with the data the file must be identified as containing carriage control characters If the length of the records in the page definition is less tha...

Page 124: ...source in the files specified in USERLIB before searching the files identified in PDEFLIB Notes 1 The files must be specified as fully qualified names without quotation marks 2 If the libraries specif...

Page 125: ...MVS PSF VM and PSF VSE SOSI3 Specifies that each shift out character be converted to a Set Coded Font Local text control Each shift in is converted to a Set Coded Font Local Text control and two blan...

Page 126: ...particular page segment resource ACIF first looks for the resource with a file type of filetype1 If it cannot find the resource with a file type of filetype1 it continues the search with filetype2 and...

Page 127: ...he SPACE parameter must not include a directory value as in SPACE 12288 150 15 in the DD statement of the data set named by the RESOBJDD parameter Failure to allocate the data set named by the RESOBJD...

Page 128: ...ent file be included in the resource file FONT Specifies that all font character sets and code pages required to print or view the output file be included in the resource file If MCF2REF CF is specifi...

Page 129: ...To activate tracing GTF must be started contact your systems programmer for information on starting GTF and TRACE YES must be specified in the ACIF processing parameter file To activate tracing TRACE...

Page 130: ...sence of a TRIGGER parameter causes ACIF to index the input file Each TRIGGERn parameter comprises three values record Specifies the relative record number from the indexing anchor record that is TRIG...

Page 131: ...ameter If no TRIGGERn or FIELDn parameter is satisfied within the INDEXSTARTBY page range ACIF stops processing 2 At least one TRIGGER or FIELDn must exist on the first page of every unique group ACIF...

Page 132: ...f ACIF is not authorized to allocate the data set it reports an error condition and terminates processing EXAMPLE USERLIB USER IMAGES USER AFP RESOURCES Notes 1 Because AFP resources except page segme...

Page 133: ...h Viewer To ensure that all resources used in the bills are available at the workstation you need to use the resource retrieval function of ACIF The tasks are Examine the input file to determine how t...

Page 134: ...Figure 24 Example of a Customer s Phone Bill 114 ACIF User s Guide...

Page 135: ...O 3 3 666 7777 6 82 2 DEC 15 9 16A NIWOT CO 3 3 555 6666 12 1 56 3 DEC 24 9 32P SANTA BARBARA CA 8 5 999 6666 32 15 8 4 DEC 25 2 18P LAS VEGAS NV 7 2 888 7654 15 8 23 TOTAL 26 41 35 PAGE 1 Figure 25 L...

Page 136: ...4 4th INDEX attribute INDEX5 Date Due field5 5th INDEX attribute INDEXING INFORMATION INDEXOBJ ALL RESOURCE INFORMATION FORMDEF F1A1 11 formdef name PAGEDEF P1A 8682 pagedef name FDEFLIB SYS1 FDEFLIB...

Page 137: ...e Zip FIELD5 4 6 12 Date Due INDEX1 Account Number field1 1st INDEX INDEX2 Name field2 2nd INDEX INDEX3 Address field3 3rd INDEX INDEX4 City State Zip field4 4th INDEX INDEX5 Date Due field5 5th INDEX...

Page 138: ...5 3 City State Zip FIELD5 4 6 12 Date Due INDEX1 Account Number field1 1st INDEX INDEX2 Name field2 2nd INDEX INDEX3 Address field3 3rd INDEX INDEX4 City State Zip field4 4th INDEX INDEX5 Date Due fie...

Page 139: ...o index specify TRIGGER2 13 5 ACCOUNT NUMBER ACIF uses both trigger values to locate a place in the file to begin searching for the data supplied in the INDEX parameters Next specify the attribute nam...

Page 140: ...e ACIF output file will contain indexing tags for each of the five indexing attributes Using Viewer customer service representatives can locate a single customer bill in the ACIF document using any co...

Page 141: ...The following is an example of OS 390 or MVS JCL you can use to perform the concatenation PRINT EXEC PGM IEBGENER SYSPRINT DD SYSOUT SYSIN DD DUMMY SYSUT1 DD DSN APKACIF INDEX DISP SHR DD DSN APKACIF...

Page 142: ...122 ACIF User s Guide...

Page 143: ...tion The program invoked at this exit is defined in the ACIF INPEXIT parameter This exit is called after each record is read from the input file The exit program can request that the record be discard...

Page 144: ...the carriage control character The record is in a buffer that resides in storage allocated by ACIF but the exit program is allowed to modify the input record RECORDLN Bytes 17 18 Specifies the number...

Page 145: ...32752 bytes this does not include the record descriptor word Figure 31 contains a sample DSECT that describes the control block that is passed to the exit program PARMLIST DSECT Parameters for the ou...

Page 146: ...Specifies an end of file EOF indicator This indicator is a 1 byte character code that signals when ACIF has finished processing the index object file When EOF is signalled EOF value Y the last record...

Page 147: ...utput record 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 output record RECORDLN Bytes 1...

Page 148: ...cessed or ignored skipped but it cannot substitute another resource name in place of the requested one If the exit requests that any overlay be ignored ACIF automatically ignores any resources the ove...

Page 149: ...YPE NONE or explicitly exclude it from the RESTYPE list Coded fonts If MCF2REF cf is specified coded fonts are included in the resource file Otherwise ACIF does not include any referenced coded fonts...

Page 150: ...ines the search order and method used to locate these load modules OS 390 or MVS Exit load modules can reside in a load library used as STEPLIB JOBLIB or in a system library ACIF uses the standard OS...

Page 151: ...value this field contains blanks if no values are specified FORMDEF Bytes 25 32 The value of the FORMDEF parameter as specified in the ACIF processing parameter file Because the FORMDEF parameter has...

Page 152: ...e 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 onl...

Page 153: ...ile specified when you invoked ACIF Most error conditions detected by ACIF fall into this category Severe errors have an S suffix Warning ACIF issues warning messages when the fidelity of the document...

Page 154: ...orrect the error and resubmit the request spresp If an IBM licensed program was used to create the structured fields for the resource with the error verify that the input to that program was valid If...

Page 155: ...appropriate response System Programmer Response See the specific error conditions described in the accompanying messages to determine an appropriate response APK106I DATA IN AN INPUT RECORD OR RESOUR...

Page 156: ...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...

Page 157: ...tension Indicator flag is set correctly and that the Length parameter in the structured field introducer specifies the actual length of padding for the invalid structured field Refer to Mixed Object D...

Page 158: ...d name2 Either the value specified in structured field name1 for the size of the repeating group is too small or the actual length of the repeating group data is not a multiple of the size specified S...

Page 159: ...he 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...

Page 160: ...ine two or more MCC structured fields Refer to Mixed Object Document Content Architecture Referencefor more information on the MCC structured field If the MCC has no errors the error may be an ACIF lo...

Page 161: ...ctured 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 a...

Page 162: ...was valid refer to Advanced Function Printing Diagnosis Guide for assistance in determining the source of the problem APK157S MISMATCH BETWEEN PRINT DATA SET AND FORMDEF RESOURCE MEDIUM MAP medium ma...

Page 163: ...IDM structured field is contained in the print data set System Action ACIF stops processing the print data set ACIF issues a message identifying the position of the structured field in the data stream...

Page 164: ...dentifying 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 the resource correct the error and resubmit...

Page 165: ...re Reference for more information about the structured field If the MCC and MMC have no errors the error may be an ACIF logic error If you used a program to create the structured fields for the form d...

Page 166: ...ield refers to one or more Medium Modification Control MMC structured fields which include requests for the primary input source and the alternate source You cannot specify both the primary input sour...

Page 167: ...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 refer to Advanced Function Printing Diagnosis Guide for assistan...

Page 168: ...uctured field has no error 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...

Page 169: ...tream or resource User Response If you created the structured fields for the print data set or the resource correct the error and resubmit the print request Refer to Mixed Object Document Content Arch...

Page 170: ...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 license...

Page 171: ...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 dete...

Page 172: ...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 the re...

Page 173: ...lex specification value in the Page Position PGP structured field is not acceptable The PGP structured field is contained in the form definition System Action ACIF stops processing the print data set...

Page 174: ...nput was valid refer to Advanced Function Printing Diagnosis Guide for assistance in determining the source of the problem APK275S DATA IN A FORMDEF RESOURCE IS INVALID A MEDIUM MAP SPECIFIES ONLY CON...

Page 175: ...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...

Page 176: ...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 APK312S DATA IN A PAGEDEF RESOURCE IS INVALID...

Page 177: ...he 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...

Page 178: ...ting Diagnosis Guide for assistance in determining the source of the problem APK321S DATA IN A PAGEDEF RESOURCE IS INVALID THE TIMING OF ACTION PARAMETER VALUE value IN CCP STRUCTURED FIELD CCP identi...

Page 179: ...he page definition contact your system programmer System Programmer Response If an IBM licensed program was used to create the structured fields for the page definition with the error verify that the...

Page 180: ...S INVALID THE DATA START POSITION PARAMETER VALUE WHEN ADDED TO THE DATA LENGTH PARAMETER VALUE IN LND STRUCTURED FIELD NUMBER structured field number EXCEEDS THE FDS STRUCTURED FIELD SIZE PARAMETER V...

Page 181: ...problem APK337S DATA IN A PAGEDEF RESOURCE IS INVALID IN LND STRUCTURED FIELD NUMBER structured field number THE CONDITIONAL PROCESSING FLAG WAS SET BUT THE CONDITIONAL PROCESSING CONTROL IDENTIFIER P...

Page 182: ...uctured fields for the page definition with the error verify that the input to that program was valid If the input was valid refer to Advanced Function Printing Diagnosis Guide for assistance in deter...

Page 183: ...or LND structured fields found in a page definition is either greater than or less than the value specified in the Line Descriptor Count LNC structured field The LND and LNC structured fields are cont...

Page 184: ...AGEDEF RESOURCE IS INVALID THE DATA LENGTH PARAMETER VALUE IN LND STRUCTURED FIELD NUMBER structured field number DOES NOT MATCH THE LENGTH OF COMPARISON STRING PARAMETER VALUE IN CCP STRUCTURED FIELD...

Page 185: ...F terminates User Response Correct the number of data sets and resubmit the job System Programmer Response No response is necessary APK407S A RESTYPE PARAMETER OF xxxx IS NOT VALID Explanation A resou...

Page 186: ...tion The file I O macro made an unsuccessful attempt to write to the named DD The return codes are listed below System Action ACIF terminates User Response Use the information provided in the return c...

Page 187: ...rce type contained in the ACIF parameter file System Action None User Response No response is necessary System Programmer Response No response is necessary APK417I DATASETNAME FILETYPE name Explanatio...

Page 188: ...r Response No response is necessary System Programmer Response No response is necessary APK428S A resource HAS BEEN REQUESTED BUT NO NAME WAS GIVEN Explanation The resource listed in the message was r...

Page 189: ...necessary APK451S FILE ALLOCATION CONCATENATION OUTADD ERROR DURING ddname PROCESSING SVC 99 ERROR nnnn INFORMATION CODE nnnn Explanation An error occurred during the allocation concatenation or outad...

Page 190: ...d of the file was reached before the INDEXn parameters were located System Action ACIF terminates User Response Correct the parameters and resubmit the job System Programmer Response No response is ne...

Page 191: ...t process the report file User Response Correct the value so that its length is within the maximum for that parameter and rerun ACIF APK470S WHICH BEGINS AT OFFSET offset FOR A LENGTH OF length Explan...

Page 192: ...TURN CODE nn REASON CODE nn Explanation The requested form definition page definition page segment medium overlay or setup file does not exist in any of the available paths System Action ACIF terminat...

Page 193: ...ACIF System Action ACIF terminates User Response Contact IBM Service and inform them that you have received this message indicating an internal error APK903S MISSING OBJECT STACK POINTER IN CCM Expla...

Page 194: ...APK915S ACIF REQUESTED CODE PAGE DEALLOCATION AS WELL AS CODE PAGE PROCESSING Explanation An internal error has occurred in ACIF System Action ACIF terminates User Response Contact IBM Service and inf...

Page 195: ...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...

Page 196: ...176 ACIF User s Guide...

Page 197: ...Part 4 Appendixes Copyright IBM Corp 1993 1999 177...

Page 198: ...178 ACIF User s Guide...

Page 199: ...a data set name and issues MSGAPK451S and MSGAPK417I with a numeric value To resolve this problem remove any line numbers from the control statements and rerun the job or use a comment indicator befor...

Page 200: ...for each record and it must be a 16 bit binary number that includes the length of the 2 byte length prefix Use the FILEFORMAT RECORD control statement to identify files with length prefixes Variable...

Page 201: ...riage control character acts as a vertical tab command to position the paper at the start of a new page at a specified line on the page or to control skipping to the next line The characters can be on...

Page 202: ...t cannot be used by ACIF Methods commonly used to transfer files from other systems to AIX and produce output that ACIF can use are Physical media such as tape PC file transfer program FTP Physical me...

Page 203: ...ngth records Check your NFS implementation you may have to use special parameters Note Some NFS systems do not supply the binary record length for fixed length files ACIF treats a file that contains o...

Page 204: ...ore than one of the multiple up subpages ACIF may produce two indexing tags for the same physical page of output In this situation only the first index attribute name will appear as a group name when...

Page 205: ...es to the resultant file that is you cannot use this information to randomly access a given page or page group without first determining the location of the BDT structured field This is not a problem...

Page 206: ...186 ACIF User s Guide...

Page 207: ...ructured field including all of the data Tag Identifier Triplet 4 254 bytes Specifies the application defined identifier or attribute name associated with the tag value An example is Customer Name Thi...

Page 208: ...med Group BNG structured field and the first page BPG structured field in the group In the case of composed text pages the TLE structured field can appear anywhere following the Active Environment Gro...

Page 209: ...d time information from the operating system on which ACIF runs The date and time values reflect when ACIF was invoked to process the print file The FQN type X 83 triplet contains the AFPDS output pri...

Page 210: ...190 ACIF User s Guide...

Page 211: ...ct BDI IEL GroupName G1 TLE INDEX1 TLE INDEXn IEL PageName G1P1 TLE INDEX1 TLE INDEXn IEL PageName G1Pn IEL GroupName Gn TLE INDEX1 TLE INDEXn IEL PageName GnP1 TLE INDEX1 TLE INDEXn IEL PageName GnPn...

Page 212: ...and groups Notice that TLE structured fields are associated with both pages and groups When ACIF performs the actual indexing function it does not support page level indexing therefore it cannot creat...

Page 213: ...r medium maps can be referenced after subsequent pages in the group If no medium map is explicitly invoked with an Invoke Medium Map IMM structured field ACIF uses a null name 8 bytes of X FF to ident...

Page 214: ...he first page in the group The value begins at 1 and is incremented for each page Tag Logical Element TLE Structured Field ACIF creates TLE structured fields as part of its indexing process or it can...

Page 215: ...ile in AFP data stream format In doing so ACIF may create the following structured fields Tag Logical Element TLE Begin Named Group BNG End Named Group ENG The TLE was described in Appendix C Format o...

Page 216: ...dex value sequence number TLE INDEX1 TLE INDEX2 TLE INDEXn BPG Page 1 of group n EPG BPG Page 2 of group n EPG BPG Page n of group n EPG ENG EDT Figure 35 Example of Code Containing Group Level Indexi...

Page 217: ...DEX2 TLE INDEXn BPG Page 1 of group n EPG BPG TLE INDEX1 TLE INDEXn Page 2 of group n EPG BPG Page n of group n EPG ENG EDT Figure 36 Example of Code Containing Group and Page Level Indexing Figure 36...

Page 218: ...he index object file and on the Begin Resource Group BRG structured field in the resource file Although the input file may contain multiple BDT structured fields the ACIF output will contain only one...

Page 219: ...file it checks for an FQN type X 01 triplet on every page If the FQN triplet exists ACIF uses the value when it creates an FQN type X 87 triplet on the corresponding Index Element IEL structured field...

Page 220: ...MCF Format 2 Structured Field ACIF does not modify this structured field and it does not map any referenced GRID values to the appropriate font character set and code page pairs This may affect docum...

Page 221: ...same meaning A ACIF See Advanced Function Presentation Conversion and Indexing Facility Advanced Function Presentation AFP A set of licensed programs that use the all points addressable concept to pr...

Page 222: ...stream document An AFP data stream document is bounded by Begin Document and End Document structured fields and can be created using a text formatter such as Document Composition Facility DCF downloa...

Page 223: ...tion of the tagged groups in the AFP file The indexing tags are contained in the Tagged Logical Element TLE structured fields indexing with data values Adding indexing tags to a MO DCA P document usin...

Page 224: ...t of the object in which is it included See also image parameter A variable that is given a constant value for a specified application and that may denote the application pitch A unit of width of type...

Page 225: ...etica or Times New Roman 2 One of the many attributes of a font others for example being size and weight 3 A collection of fonts each having a different height or size of character sets See also fonts...

Page 226: ...206 ACIF User s Guide...

Page 227: ...m Specifications G544 5626 PSF for OS 390 Messages and Codes G544 5627 PSF for OS 390 Program Directory None PSF for OS 390 User s Guide S544 5630 AFP Conversion and Indexing Facility User s Guide S54...

Page 228: ...e DMIIR21 XFP2000 Bit Mapped Imaging User s Guide NW 04 9403 XFP2000 COM System Operator Guide 8000R21 XFP2000 Message Guide 8KMSGR11 XFP2000 Reference XF 07 9201 XF 07 9302 XFP2000 Software Release N...

Page 229: ...y for AIX AFP Conversion and Indexing Facility Version 2 1 G544 3930 IBM Print Services Facility for AIX Guide for Printer and COM Operators S544 5286 IBM Print Services Facility for AIX Licensed Prog...

Page 230: ...d Planning Guide S544 4258 User s Guide for the IBM LaserPrinter 4029 Series ZA40 0542 IBM 4224 Printer Models 1xx and 2xx Product and Programming Description Manual GC31 2551 IBM 4230 Printer Product...

Page 231: ...Aids SY28 1085 OS 390 MVS Initialization and Tuning Reference SC28 1752 OS 390 MVS IPCS User s Guide GC28 1756 OS 390 MVS IPCS Commands GC28 1754 OS 390 MVS JCL Reference GC28 1757 OS 390 MVS JCL Use...

Page 232: ...23 1443 MVS ESA SP V5 JES2 Initialization and Tuning Guide SC23 1453 MVS ESA SP V5 JES2 Initialization and Tuning Reference SC23 1454 MVS ESA SP V5 JES2 Messages GC28 1488 MVS ESA SP V5 JES3 Commands...

Page 233: ...SC31 7187 TCP IP for MVS Programmer s Reference SC31 7135 VTAM and NCP Publication Order Number ACF INCP SSP Version 3 Resource Definition Reference SC30 3254 Advanced Communications Function for VTAM...

Page 234: ...73 SNA Transaction Programmer s Reference Manual for LU Type 6 2 GC30 3084 Systems Network Architecture Formats GA27 3136 AS 400 Publication Order Number AS 400 Data Description Specifications SC41 96...

Page 235: ...arameters AIX 56 59 exit AIX 68 functions of 3 indexing functions 10 AFP Conversion and Indexing Facility ACIF continued input record exit AIX 68 input record exits AIX 68 invoking program to index in...

Page 236: ...ile attributes PAGEDEF parameter 74 75 print file attributes PRMODE parameter 74 print file attributes TRC parameter 75 AIX continued PRMODE parameter 43 74 processing parameter 55 56 PSEGLIB paramete...

Page 237: ...xvii brackets in commands xvii BTD See Begin Document structured field C carriage control characters AIX 28 90 encoded in ASCII AIX 27 90 encoded in EBCDIC AIX 27 90 indexing considerations 184 machin...

Page 238: ...AMES parameter continued defined OS 390 MVS VM VSE 92 directory See library disclaimer about examples ix distributed printing See printing ACIF document DD statement for MVS 81 DD statement for OS 390...

Page 239: ...8 input AIX 38 66 load modules OS 390 or MVS 130 load modules VM 130 load modules VSE 130 non zero return codes 130 non zero return codes AIX 74 output record 100 output AIX 40 70 print file attribute...

Page 240: ...cts ignored by the Viewer application of AFP Workbench 16 group level IEL structured field 191 GROUPNAME parameter defined 97 defined AIX 35 defined AIX index 36 index values AIX 36 groups for indexin...

Page 241: ...of 119 example AIX 56 59 INDEX parameter 97 INDEX parameter AIX 36 structured fields 189 INDEXn parameter defined 97 INDEXOBJ parameter defined 16 INDEXOBJ parameter continued defined AIX 38 informati...

Page 242: ...ion VM 104 page definition VSE 105 page segment AIX 43 page segment OS 390 or MVS 105 page segment VM 106 page segment VSE 106 library continued resource 50 example of locating AIX 50 setup file AIX 4...

Page 243: ...supported by ACIF xi organization publication overview xiv OS 390 or MVS 116 out of storage problem See Tag Logical Element structured field OUTEXIT parameter AIX 40 defined 100 OUTEXIT parameter cont...

Page 244: ...VSE 93 FIELD AIX 31 FIELDn 98 FIELDn multiple 98 FIELDn OS 390 MVS VM VSE 93 FONTECH OS 390 or MVS VM VSE 94 FONTLIB OS 390 or MVS 94 FONTLIB VM 95 parameters continued FONTLIB VSE 95 FORMDEF OS 390 M...

Page 245: ...defined OS 390 and MVS 104 defined VM 104 defined VSE equivalent 105 OS 390 and MVS 104 VM 104 VSE equivalent 105 piping symbols bars in commands xvii prefix reserved AFP resources 112 prerequisites 1...

Page 246: ...t continued resexit parameter AIX 43 RESTYPE parameter 128 resource file AFP data stream resource group 14 contents set with RESTYPE parameter 108 contents set with restype parameter AIX 44 DCB charac...

Page 247: ...199 syntax rules AIX 23 SYSIN JCL statement MVS 82 SYSPRINT JCL statement MVS 82 system resource directories example of locating AIX 50 paths AIX 44 T table reference characters 109 AIX 46 Tag Logical...

Page 248: ...n codes non zero 130 search order 130 user library AIX 48 fonts 91 form definitions 96 MVS or OS 390 14 user library continued overlays 101 page definitions 103 page segments OS 390 or MVS 105 request...

Page 249: ...t 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 Vie...

Page 250: ...tions or make comments about the functions of IBM products or systems you should talk to your IBM representative or to your IBM authorized remarketer When you send comments to IBM you grant IBM a none...

Page 251: ...Thank you for your responses May we contact you Yes No When you send comments to IBM you grant IBM a nonexclusive right to use or distribute your comments in any way it believes appropriate without i...

Page 252: ...d 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 Information Developme...

Page 253: ......

Page 254: ...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...

Page 255: ...Spine information IBM IBM Print Services Facility User s Guide AFP Conversion and Indexing Facility...