For OS/390, VM, VSE Extended Reporting Facility Guide 6.2 SP3
Release 6.2, May 1996 Updated: April 1999 This documentation and related computer software program (hereinafter referred to as the Documentation ) is for the end user s informational purposes only and is subject to change or withdrawal by Computer Associates International, Inc. ( CA ) at any time. THIS DOCUMENTATION MAY NOT BE COPIED, TRANSFERRED, REPRODUCED, DISCLOSED OR DUPLICATED, IN WHOLE OR IN PART, WITHOUT THE PRIOR WRITTEN CONSENT OF CA. THIS DOCUMENTATION IS PROPRIETARY INFORMATION OF CA AND PROTECTED BY THE COPYRIGHT LAWS OF THE UNITED STATES AND INTERNATIONAL TREATIES. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE. THE USE OF ANY PRODUCT REFERENCED IN THIS DOCUMENTATION AND THIS DOCUMENTATION IS GOVERNED BY THE END USER S APPLICABLE LICENSE AGREEMENT. The manufacturer of this documentation is Computer Associates International, Inc. Provided with Restricted Rights as set forth in 48 C.F.R. Section 12.212, 48 C.F.R. Sections 52.227-19(c)(1) and (2) or DFARS Section 252.227.7013(c)(1)(ii) or applicable successor provisions. 1996-2000 Computer Associates International, Inc., One Computer Associates Plaza, Islandia, New York 11749. All rights reserved. All trademarks, trade names, service marks, or logos referenced herein belong to their respective companies.
Contents Chapter 1: About This Guide Purpose and Audience... 1 1 Organization... 1 1 Other CA-Easytrieve/Plus Publications... 1 2 Documentation Conventions... 1 3 Variable Parameters... 1 4 Chapter 2: Overview Introduction... 2 1 Extended Reporting Facilities... 2 1 Extended Reporting Sample... 2 2 System Overview... 2 4 Printer Support... 2 4 Printer Identification... 2 5 Font Identification... 2 6 Chapter 3: System Concepts Terminology... 3 1 Font... 3 1 Print Item... 3 1 Print Record... 3 2 Unit of Measure... 3 2 Font Sizes... 3 4 Character Cell... 3 5 Height... 3 5 Width... 3 6 CA-Easytrieve/Plus Reporting Characteristics... 3 7 Print Lines... 3 8 Print Records... 3 8 Contents iii
Printer Characteristics... 3 10 Printer Type... 3 11 Page Printers... 3 12 Line Mode... 3 14 Overprint Codes... 3 15 Function Codes... 3 16 Overprint and Function Codes... 3 16 Overprint Techniques... 3 17 Merge Overprint... 3 17 Print Overprint... 3 19 Supported Printers... 3 23 Paper Control Codes - Carriage Control... 3 24 Page Printers... 3 25 Start Page... 3 25 End Page... 3 26 Format Page... 3 26 Line Mode... 3 27 ANSI Carriage Control plus a Forms Control Block... 3 27 Machine Carriage Control Codes Plus a Forms Control Block... 3 28 ANSI Carriage Control with no Forms Control Block... 3 28 Point Skip Vertical Spacing Control... 3 29 File Type... 3 30 Record Format - Page Printers... 3 31 File Header Records... 3 31 Start Page Record(s)... 3 31 End Page Record(s)... 3 32 Format Page... 3 32 File Trailer Records... 3 33 Record Format - Line Mode... 3 33 File Header Records... 3 33 Print Records... 3 34 File Trailer Records... 3 34 File Format... 3 35 Blocked Records... 3 35 Unblocked Records... 3 36 Concatenated Records... 3 36 Concatenated Records - Structured Fields... 3 37 Concatenated Records - Line Mode... 3 38 iv CA-Easytrieve/Plus Extended Reporting Facility Guide
Font Characteristics... 3 39 Data Type... 3 39 Height and Width... 3 40 Overprint Code... 3 40 Function Header and Function Trailer... 3 40 Space Replacement... 3 40 Double Byte Alignment... 3 44 Line Complexes... 3 45 Report Layout Processing... 3 47 LINE Element Processing.... 3 47 MIXED Field Printing... 3 52 MIXED Field Font Selection... 3 56 MIXED Field Support of Merge Overprint... 3 58 Print Item Positioning Considerations... 3 58 Overprint Gap... 3 58 Item Placement Restrictions... 3 61 Chapter 4: Extended Reporting Options Module Introduction... 4 1 Installation Steps... 4 2 For OS/390:... 4 2 OS/390 Installation Notes:... 4 2 For VSE Pre SP2.1... 4 3 VSE Pre SP2.1 Notes:... 4 3 For VSE SP2.1:... 4 4 VSE SP2.1 Notes:... 4 4 XRPT Commands Overview... 4 5 XRPT COMMANDS - Syntax Overview... 4 5 Syntax Rules... 4 5 Example... 4 6 Printer Control Code Specification... 4 6 SYSPRINT Command... 4 9 Syntax... 4 9 Keywords... 4 10 PRINTER Command... 4 11 Syntax... 4 12 Keywords... 4 13 FONT Command... 4 29 Syntax... 4 30 Keywords... 4 30 Contents v
EZTPX04 Error Diagnostics... 4 36 Introduction... 4 36 Diagnostic Message Format... 4 36 Message ID... 4 36 Diagnostic Message... 4 36 Message Supplement... 4 36 Diagnostic Messages... 4 37 Chapter 5: Extended Reporting Introduction... 5 1 FILE Statement... 5 1 DEFINE Statement... 5 2 DISPLAY Statement... 5 3 Syntax... 5 3 Format 1... 5 3 Format 3... 5 4 Report Processing... 5 4 REPORT Statement... 5 5 Syntax... 5 5 Report Definition Statements... 5 8 TITLE Statement... 5 8 Syntax... 5 8 HEADING Statement... 5 9 Syntax... 5 10 Example... 5 10 LINE Statement... 5 10 Syntax... 5 10 Chapter 6: Extended Reporting Models Introduction... 6 1 IBM3800A Model... 6 3 IBM3800B Model... 6 5 IBM3800C Model... 6 8 IBM3800D Model... 6 9 IBM3800E Model... 6 10 IBM3800F Model... 6 11 SHOWA7 Model... 6 12 SHOWA8 Model... 6 16 M8250 Model... 6 21 vi CA-Easytrieve/Plus Extended Reporting Facility Guide
M8290 Model... 6 24 T8500 Model... 6 28 IBM3200 Model... 6 31 H8196 Model... 6 34 F6715D Model... 6 38 Chapter 7: Extended Reporting Usage Introduction... 7 1 Working with... 7 1 Page Mode... 7 2 Working with Line Compatibility Mode Printers... 7 7 Working with XEROX Printers... 7 9 Index Contents vii
Chapter 1 About This Guide Purpose and Audience The CA-Easytrieve/Plus Extended Reporting Facility Guide provides the technical details for generating the extended reporting options module. It also discusses concepts of extended reporting and how to create multiple font reports. The CA-Easytrieve/Plus Extended Reporting Facility Guide is intended primarily for technical personnel at your site. Organization This guide is divided into several chapters: Overview introduces the user to the use and intent of the documentation and the Extended Reporting Facility. System Concepts discusses concepts related to the use of Impact Dot, Ink Jet, and Electro-Photographic printers and how the Extended Reporting Facility deals with them. Extended Reporting Options Module discusses the procedures you must follow to generate your customized extended reporting options module. Extended Reporting includes the CA-Easytrieve/Plus syntax you must use to produce extended (multiple font) reports. Extended Reporting Modules contains a series of printer models for commonly used printers intended as examples for setting up the extended reporting options module. Extended Reporting Usage provides further explanation on printer definitions, JCL usage, and CA-Easytrieve/Plus program examples. The Index provide listings to facilitate references to terms and procedures. About This Guide 1 1
Other CA-Easytrieve/Plus Publications Chapters 2, 3, 5, 6, and 7 of the CA-Easytrieve/Plus Extended Reporting Facility Guide should be referenced only when generating the extended reporting options module or when changing extended reporting options. Chapter 5 contains CA-Easytrieve/Plus syntax for using extended reporting but this syntax is also included in the CA-Easytrieve/Plus Reference Guide. Other CA-Easytrieve/Plus Publications In addition to this CA-Easytrieve/Plus Extended Reporting Facility Guide, Computer Associates provides the following CA-Easytrieve/Plus documentation: Name CA-Easytrieve/Plus Reference Guide CA-Easytrieve/Plus Installation Guide CA-Easytrieve/Plus CA-Activator Supplement CA-Easytrieve/Plus User Guide CA-Easytrieve/Plus Application Guide CA-Easytrieve/Plus Interface Option Guides Contents Contains descriptions of all product features and functions as well as summaries of each CA-Easytrieve/Plus version. Describes the process of installing and tuning the CA-Easytrieve/Plus system. Explains how to install and maintain CA-Easytrieve/Plus on your OS/390 system, using the CA-Activator. Provides new users with the information they need to become productive quickly. It includes a six lesson tutorial and a format designed to make the material more interesting and easier to comprehend. Describes basic syntax (a subset of the syntax in the CA-Easytrieve/Plus Reference Guide) and operation, and provides a series of actual applications, from single examples to full systems. The Application Guide is an excellent tool for the business-oriented professional. Short guides available for users of various system options. These consist of manuals for IMS/DLI processing, CA-IDMS and IDD processing, TOTAL processing, SQL processing, CA-Datacom/DB processing, SUPRA processing, and other CA-Easytrieve/Plus options. 1 2 CA-Easytrieve/Plus Extended Reporting Facility Guide
Documentation Conventions Documentation Conventions The following conventions are used throughout this guide for illustrative purposes: Notation {braces} [brackets] Meaning Mandatory choice of one of these entries. Optional entry or choice of one of these entries. (OR bar) Choice of one of these entries. (parentheses) Multiple parameters must be enclosed in parentheses.... Ellipses indicate that you can code the immediately preceding parameters multiple times. CAPS lowercase All capital letters indicate a keyword, name, or field used in a program example. Lowercase letters represent variable information in statement syntax. If the same variable types recur within a statement, they are made unique by adding a numeric suffix, such as literal-2. About This Guide 1 3
Documentation Conventions Variable Parameters Parameter field-name file-name index name integer job-name letter literal proc-name program-name record-name report-name sort-name Meaning A data field defined in your program. A unique file name defined in the library section of your program. Name of an INDEX data item. A numeric literal (a whole number greater than zero). Name of a JOB activity. A single alphabetic character (such as an edit mask identifier). A text string enclosed in quotes or a numeric constant. Name of a procedure. Name of a program written in a language other than CA-Easytrieve/Plus (such as COBOL or Assembler). Name of an IMS/DLI or CA-IDMS entity. Name of a REPORT. Name of a SORT activity. 1 4 CA-Easytrieve/Plus Extended Reporting Facility Guide
Chapter 2 Overview Introduction A major function of CA-Easytrieve/Plus programs is to produce printed reports. To print reports, CA-Easytrieve/Plus uses a reporting mechanism that provides a number of automatic features. Many of these automatic features rely on assumptions that CA-Easytrieve/Plus makes about your printer. CA-Easytrieve/Plus assumes that: Printed data belongs to the EBCDIC character set. EBCDIC characters belong to the same FONT. This means that each character that CA-Easytrieve/Plus prints has one size, style, and design. The ANSI paper control codes are standard. Printer files are sequential with fixed length records that can be blocked or unblocked. Each record represents a logical print line that CA-Easytrieve/Plus builds during the generation of a report or through the execution of the DISPLAY statement. These assumptions restrict the use of Impact Dot, Ink-Jet, and Electro-Photographic printers that have extended reporting capabilities. Extended Reporting Facilities CA-Easytrieve/Plus Extended Reporting Facility provides support for Impact Dot, Ink-Jet, and Electro-Photographic printers. This facility interacts with the CA-Easytrieve/Plus reporting mechanism to provide support for additional features permitting CA-Easytrieve/Plus to: 1. Mix two different character sets on the same logical print line. For example, in the same report the extended reporting option can process EBCDIC fields and literals, and data containing DBCS (Double Byte Character Set) format codes. Double Byte Character sets represent writing systems that use more than 256 characters, such as Kanji (Japanese characters). 2. Process fields and literals belonging to different fonts. For example, in the same report you can use multiple fonts. Overview 2 1
Introduction A font is a complete set of images of characters and symbols having common characteristics (such as style, height, width, weight). In a CA-Easytrieve/Plus report, each character within a font must have the same amount of lateral space. That is, CA-Easytrieve/Plus supports only Fixed Pitch fonts. CA-Easytrieve/Plus automatically formats a report compensating for fields and literals that produce characters of different height and width. CA-Easytrieve/Plus automatically calculates the size of elements on Title, Heading, Detail, and Summary lines. You can use the CA-Easytrieve/Plus extended reporting options module EZTPXRPT to define the character widths that CA-Easytrieve/Plus uses. The module can define the widths as either characters per inch (pitch) or a point size where the term point defines the size of a character as a multiple of 1/72nd of an inch. For more information on the CA-Easytrieve/Plus extended reporting options module, refer to Chapter 4. 3. Support control codes in addition to the ANSI paper control codes. 4. Support printer files that use non-standard record formats, block sizes, and record lengths. Extended Reporting Sample With extended reporting, you can use multiple print fonts in a report. This enables you to highlight fields of special significance. For an example of what the Extended Reporting Facility can do, take a look at the sample report shown below. (The CA-Easytrieve/Plus program that produced the report is shown next.) 2 2 CA-Easytrieve/Plus Extended Reporting Facility Guide
Introduction Sample Report BRANCH DEPT EMPLOYEE NUMBER REGION PAY SCALE SUMMARY REGION: 1 GROSS PAY NET PAY DEDUCTIONS 01 903 12267 373.60 251.65 121.95 918 02200 804.64 554.31 250.33 1,178.24 805.96 372.28 02 943 11473 759.20 547.88 211.32 935 00370 554.40 340.59 213.81 1,313.60 888.47 425.13 03 915 02688 146.16 103.43 42.73 914 11602 344.80 250.89 93.91 490.96 354.32 136.64 04 917 11931 492.26 355.19 137.07 911 11357 283.92 215.47 68.45 932 11467 396.68 259.80 136.63 911 01963 445.50 356.87 88.63 1,618.36 1,187.33 431.03 END OF REGION 1 4,601.16 3,236.08 1,365.08 Overview 2 3
System Overview Sample Program The following CA-Easytrieve/Plus program created the report on the previous page. Note the fields and literals preceded by a pound sign (#) and integer. FILE FILEA REGION 1 1 N BRANCH 2 2 N HEADING ( #5 'BRANCH') < EMP# 9 5 N HEADING ('EMPLOYEE' 'NUMBER') NAME 17 20 A HEADING ('EMPLOYEE' 'NAME') STREET 37 20 A CITY 57 12 A STATE 69 2 A ZIP 71 5 N NET 90 4 P 2 HEADING ('NET' 'PAY') GROSS 94 4 P 2 HEADING ('GROSS' 'PAY') DEPT 98 3 N DEDUCT W 4 P 2 HEADING ('DEDUCTIONS') JOB INPUT FILEA NAME BASIC DEDUCT = GROSS - NET PRINT REPORT1 REPORT REPORT1 LINESIZE 130 PAGESIZE 45 SUMCTL NONE SEQUENCE REGION BRANCH CONTROL REGION NEWPAGE BRANCH TITLE 01 #3 'REGION PAY SCALE SUMMARY' < TITLE 02 #5 'REGION :' -2 #2 REGION < LINE 01 #5 BRANCH DEPT EMP# GROSS NET DEDUCT < AFTER-BREAK. PROC IF LEVEL = 2 DISPLAY SKIP 3 COL 20 #5 'END OF REGION ' #5 REGION < END-IF END-PROC System Overview Printer Support The Extended Reporting Facility supports a variety of printers. Each printer has its own characteristics, especially with respect to the identification of the font, the presentation of print records, and the distinction between character sets. To support each printer's characteristics, CA-Easytrieve/Plus uses an extended reporting options module. The extended reporting options module defines the type of printer that CA-Easytrieve/Plus supports, and the font codes that the CA-Easytrieve/Plus program supports. The extended reporting options module, called EZTPXRPT, is not provided as part of the normal installation of CA-Easytrieve/Plus. Therefore, the CA-Easytrieve/Plus reporting mechanism uses the default mode of operation. CA-Easytrieve/Plus programs can use the Extended Reporting Facility only after your systems programmer generates the extended reporting options module. For information on how to generate the module, see the CA-Easytrieve/Plus Installation Guide and Chapter 4 of this guide. 2 4 CA-Easytrieve/Plus Extended Reporting Facility Guide
System Overview The extended reporting options module can provide support for the following printers: IBM 3800-I, IBM 3800-II IBM 3800-III, IBM 3800-VIII IBM 3820 IBM 3200 XEROX 2700, XEROX 8700, XEROX 9700 FACOM 6715D, FACOM 6716D MELCOM 8250, MELCOM 8270, MELCOM 8290 HITAC 8196 TORAY 8500 SHOWA INFORMATION SYSTEM SP7, SP8 MEMOREX 1500/1520 Printer Identification The extended reporting options module identifies the type of printers that the CA-Easytrieve/Plus system use. A unique extended printer name (XRPT-name) identifies each printer in the module. This name not only identifies the characteristics of the printer but also enables you to define up to 256 different font codes for use in CA-Easytrieve/Plus programs. The font codes cause fields and literals to be correctly formatted into output lines so that the printer can print them using the correct font sets. The extended reporting printer name is an option on the FILE statement of the CA-Easytrieve/Plus program. Once you define an extended reporting printer name on a CA-Easytrieve/Plus FILE statement, any output, whether it is from a report or from the DISPLAY command, directed to that file, is formatted based on the characteristics defined for that extended reporting printer. The following exhibit illustrates the CA-Easytrieve/Plus syntax supported by the Extended Reporting Facility. Note: The EXTENDED keyword on the CA-Easytrieve/Plus FILE statement enables you to associate the extended reporting printer to a CA-Easytrieve/Plus printer file. Overview 2 5
System Overview Also, the following exhibit illustrates the use of the CA-Easytrieve/Plus DISPLAY statement within the processing logic of a program to direct print lines to that printer file, thereby taking advantage of the extended reporting facilities that the printer provides. Font Identification The final exhibit illustrates the definition of two extended reporting printer names in the extended reporting options module. Both printers are using the same MODEL definition while associated with each extended reporting printer is a different set of fonts. The FILE statement in the previous exhibit illustrated the association of an extended reporting printer named IBM38002 to a file called NEWPTR. The DISPLAY statement in the exhibit illustrates the use of different fonts on the same print line. The fonts used in the previous exhibit are defined for the extended reporting printer called IBM38002. This definition is illustrated in the next exhibit. As a result, FIELD1 is output at 10 characters per inch (the default, since no override was coded) and FIELD2 is output, using a font of 15 characters per inch. If a field or literal is to use a different font, then you must precede the field with the character '#' followed by an integer. This integer defines the number of the font in the font table of the extended reporting printer that you are using. 2 6 CA-Easytrieve/Plus Extended Reporting Facility Guide
System Overview The entry must exist for the data type of the field or literal, that is EBCDIC, DBCS, or MIXED. The DBCS data type defines data associated with a Double Byte Character Set (DBCS). Use this data type to output characters for languages such as Japanese, Chinese, Korean, and so on. Overview 2 7
Chapter 3 System Concepts Terminology This chapter defines terminology used throughout this guide. It is important that you thoroughly understand these terms before reading the later chapters in this guide. Font A font is an assortment of character images belonging to one data format (EBCDIC or DBCS). Fonts have one size, shape, style, and design. In CA-Easytrieve/Plus, a font defines all of the information necessary to create character images of that font on a specific extended reporting printer. This information includes the characteristics of the font that CA-Easytrieve/Plus requires to format a report (height, width, and so on). It also includes the printer control codes that specific extended reporting printers require for output records that use the font. If any of this information changes between two character images, CA-Easytrieve/Plus regards the two characters as belonging to different fonts. Print Item A print item defines a field or literal that you code on CA-Easytrieve/Plus statements that produce printed output (for example, the LINE, TITLE, and DISPLAY statements). CA-Easytrieve/Plus associates each print item with a font. CA-Easytrieve/Plus uses the height and width characteristics of the font to position a print item on a line. CA-Easytrieve/Plus merges the printer control codes of that font with the contents of a print item to form a print record. A print item can contain single byte character format data (EBCDIC), double byte character format data (DBCS), or a mixture of both (MIXED). System Concepts 3 1
Terminology Print Record A print record is a stream of data that CA-Easytrieve/Plus sends to the printer. This data consists of printer control codes and the contents of print items. Unit of Measure Prior to the Extended Reporting Facility, when processing printed text CA-Easytrieve/Plus assumed that each character was to be printed using the same font. This meant that each character had the same height and width. Furthermore, it meant that each print item (field or literal) on a print line occupied an amount of horizontal space that was directly proportional to the number of characters in that print item. In other words, all the calculations that determined the positioning of print items on a print line did not need to consider the size characteristic of the font being used to print that particular item. The size was assumed to be fixed. CA-Easytrieve/Plus still uses this methodology when using one font for a report. With the Extended Reporting Facility, you can use multiple fonts within the same report where each font can have a different height or width. As a result, a print item now occupies an amount of vertical space equal to the height characteristic of the font and an amount of horizontal space (equal to the number of characters in the item multiplied by the width characteristic of the font). Therefore, CA-Easytrieve/Plus must position items on a print line using both the size of the print item and the size of the font associated with that print item. To do this, you must define the size characteristic of each font as a multiple of a unit of measure that is standard for all the fonts within a given extended reporting printer. The specific unit of measure assigned to a particular extended reporting printer is of no consequence for the extended reporting mechanism. What is important is that the sizes of all fonts assigned to a particular extended reporting printer be defined in terms of the selected unit of measure. Sample units of measure include points, dots, and PELs. Points Points are a linear unit of measurement normally associated with the width (or height) of typefaces. A point is approximately equal to 72 dots per inch. 3 2 CA-Easytrieve/Plus Extended Reporting Facility Guide
Terminology Dots A dot is the fundamental unit of imaging and digitization for electro-photographic printers. The size of a dot varies depending upon the resolution of the printer. The resolution is normally expressed as the number of dots per inch. The larger the number of dots, the higher the resolution quality of the printer. For example, the Xerox 8700 and Xerox 9700 support 300 dots per inch; the MELCOM 8290, IBM 3200, and HITACHI 8196 support 240 dots per inch; the TORAY 8500 supports 140 dots per inch. PELs A PEL (Picture Element) is the IBM term used to refer to the fundamental unit of imaging on the IBM 3800 printing systems. A PEL is the same as a dot but it is also used as the addressable unit for All Points Addressable printing on the 3800 Model III and VIII, and the 3820. For these printers, 240 PELs per inch are supported. In the majority of cases, any one of the units of measure can give the same results. The following table illustrates this: There are certain characteristics regarding particular printers that you must consider when determining the unit of measure. These characteristics are: 1. The definition of the height and width characteristic of a font can only be accurate to two decimal positions. If a font requires greater accuracy than that, then you must re-evaluate the unit of measure. System Concepts 3 3
Terminology 2. For printers that are All Points Addressable (like the IBM 3800 Model III and VIII, and the IBM 3820), CA-Easytrieve/Plus must assign positions to print items in terms of the unit of measure known by that printer. These printers require control information (item positioning, item sizes, page sizes, line sizes) in one unit of measure (PEL's for example). For CA-Easytrieve/Plus to meet these requirements, you must use the same unit of measure to define the printer characteristics that the extended reporting options module identifies. For example, if you define all the fonts in terms of a number of points, then CA-Easytrieve/Plus cannot support a printer that supports PEL's as the unit of page addressing. In this case, CA-Easytrieve/Plus positions items on a page by using values that are multiples of points but the printer interprets these values as a number of PELs. This produces incorrect results. Therefore, for All Points Addressable printers, CA-Easytrieve/Plus restricts the selection of the unit of measure to the unit used to address positions on the page of a report. 3. Some printers require CA-Easytrieve/Plus to merge a value with the printer function code. These printers use this value for Paper Control Codes (Carriage Control) where the amount of vertical space to be skipped is defined as a multiple of a certain unit of measure. For example, the SHOWA SP-7, SP-8, and the MELCOM 8250 all require the skip amount be defined in terms of a number of points. For printers having this characteristic, the unit of measure selected to define the other characteristics of the printer must be the same. Using more than one unit of measure causes the printer to interpret the value CA-Easytrieve/Plus merges by a unit of measure different from the one with which it was defined. Font Sizes As illustrated earlier, a variety of units of measure can define a printer's characteristics. From the CA-Easytrieve/Plus view, any unit of measure is fine. To simplify the discussion of fonts, assume a standard unit defines a font's width (W-unit) and another defines a font's height (H-unit). Therefore, independent of the actual unit of measure selected (points, dots, pels, and so on), a number of H-units and a number of W-units define a font. Using these base units, this chapter discusses the meaning of the size of a font. CA-Easytrieve/Plus must know the characteristics of a font to accurately determine the positioning of print items on a line or page. The definition of the size of a font is expressed as the height and width of the character cell assigned to the font. 3 4 CA-Easytrieve/Plus Extended Reporting Facility Guide
Terminology Character Cell CA-Easytrieve/Plus associates each Fixed Pitch font with a character cell. The character cell defines the area required to encompass the images of the characters of a particular font. The following example illustrates that the height and width of a character cell is not always the same as the height and width of the actual character image. This is because the character cell includes any additional vertical and horizontal spacing required to encompass images of the font's characters. An important reference line in any font definition is the baseline. The definition of the baseline changes between extended reporting printers. The more commonly accepted definition of a baseline is an imaginary line supporting the bottom of capitals. In CA-Easytrieve/Plus, the baseline is an imaginary line supporting the bottom of character cells. The formatting of a print line containing a mixture of fonts is based on the positioning of the bottom of each character's cell on that baseline. The amount of vertical space between one print line and the next is the vertical distance between baselines. This distance is the height of a line. Height A font's height is the amount of vertical space (in H-units) that a printed character occupies. This means that the height of the font is the height (in H-units) of the character cell associated with the font. Some printers are able to adjust the vertical position of a font. These printers can move the base of the character cell up or down a number of H-units from the baseline. You can incorporate this adjustment into the printer control codes associated with a CA-Easytrieve/Plus font. CA-Easytrieve/Plus supports the definition of an adjust vertical position font, but you must make the appropriate adjustment to the height to compensate for the font's movement. System Concepts 3 5
Terminology Upward Adjustment For upward adjustment, the height of the font must include the adjustment amount. That is, the height of the font is equal to the height of the character cell plus the amount of vertical adjustment. Therefore, an upward adjustment is like extending the length of a character's cell. If the font's height is not adjusted up, there exists the possibility of generating a vertical line feed that is too small to include the upward adjustment. For example, assume that a font normally prints with a height of 12 points. If you defined this font to CA-Easytrieve/Plus so that the printer performed an upward adjustment of 4 points, you need to define the height of the font as 16. You define the height of the font on the FONT command. See Chapter 4 for information on the FONT command. Downward Adjustment For downward vertical adjustment, the bottom of the character cell is actually positioned below the baseline. To support this adjustment, you must calculate the height of the font as the character cell's height minus the vertical adjustment. This defines the correct height that CA-Easytrieve/Plus requires. It is then your responsibility to ensure that the next baseline is vertically displaced a sufficient amount to permit room for the portions of characters that CA-Easytrieve/Plus prints below the current baseline. For example, assume that a font normally prints with a height of 12 points. If you define this font to CA-Easytrieve/Plus in such a manner that the printer performs a downward adjustment of 4 points, then you have to define the height of the font as 8. You define the height of the font on the FONT command. See Chapter 4 for information on the FONT command. Width A font's width is the amount of horizontal space (in W-units) that a printed character occupies. This means that the width of the font (in W-units) is the width of the character cell associated with the font. The Extended Reporting Facility supports only fixed pitched fonts in which all of a font's character patterns occupy the same horizontal or lateral space. Some printers support special horizontal adjustment functions that you can use to expand the horizontal size of a character or squeeze the character. If you select either of these options, the width of the font that these function codes identify must incorporate the horizontal adjustment factors. For example, assume that a font normally prints with a width of 12 points. If you define this font to CA-Easytrieve/Plus in such a manner that the printer performs an expansion of 4 points, then you have to define the width of the font as 16. You define the width of the font on the FONT command. See Chapter 4 for information on the FONT command. 3 6 CA-Easytrieve/Plus Extended Reporting Facility Guide
Terminology CA-Easytrieve/Plus Reporting Characteristics CA-Easytrieve/Plus provides a non-procedural language for defining the sets of lines that form a report. The language consists of the TITLE, LINE, and DISPLAY statements. Each statement specifies the items that are to appear on the report. CA-Easytrieve/Plus must then process these items and automatically determine the layout of the report. Any one statement (for example, the LINE statement) can result in more than one set of print lines, as the following example shows. LINE STATEMENT DETAIL HEADING SUMMARY CA-Easytrieve/Plus uses the resultant layout to determine the correct set of print lines that produce the report. The set of print lines include title lines, heading lines, detail lines, and summary lines. The previous example illustrates CA-Easytrieve/Plus creating three sets of print lines from the one statement. In addition, the use of different fonts for the print items to be formatted on the report requires the generation of multiple print records that are combined by the extended reporting printer to form a print line. As the following example illustrates, to process the initial statement, CA-Easytrieve/Plus must create two detail records, four heading line records, and two summary line records. DETAIL (2) LINE STATEMENT HEADING (4) SUMMARY (2) CA-Easytrieve/Plus then determines the format of the print records required to generate these print lines on the appropriate extended reporting printer. The following example illustrates CA-Easytrieve/Plus determining the format of the print records. DETAIL (2) {PRINT RECORD { {PRINT RECORD {PRINT RECORD { {PRINT RECORD LINE { STATEMENT HEADING (4) {PRINT RECORD { {PRINT RECORD SUMMARY (2) {PRINT RECORD { {PRINT RECORD System Concepts 3 7
Terminology The following chart illustrates the relationships between these various components and the structure of print records that the Extended Reporting Facility supports. Print Lines In terms of CA-Easytrieve/Plus reporting, the statements that define printed output define that output as a series of print items (fields and literals) that are to appear on specific lines of a report. As a result, the CA-Easytrieve/Plus system produces printed output as a series of print lines. Print Records In terms of the CA-Easytrieve/Plus Extended Reporting Facility, a Print Record is the base unit for a print output request. After CA-Easytrieve/Plus builds the record, CA-Easytrieve/Plus outputs it to the print data set. 3 8 CA-Easytrieve/Plus Extended Reporting Facility Guide
Terminology Standard CA-Easytrieve/Plus reporting associates the production of one print line with the output of one print record. This is appropriate for non-extended reporting printers. With the Extended Reporting Facility, CA-Easytrieve/Plus no longer associates the production of one print line with the output of one print record. This is because some extended reporting printers do not permit you to mix print items from different fonts on the one print line. Multiple print records must be output by CA-Easytrieve/Plus and the printer combines these records to form a single print line. Print records that the Extended Reporting Facility builds have four components. They are: Paper Control Codes (PCC) Overprint Codes Function Codes Print Items. Paper Control Codes (PCC) - Carriage Control Overprint Codes At the start of each print record is a control field that defines the required vertical movement that occurs before printing the text that follows. If you are combining multiple print records to form a single print line, then the first print record contains the carriage control information that specifies the start of a new line. Additional print records for the same logical print line use a SKIP 0 carriage control. This control field follows the PCC. Printers that output multiple print records to form a single print line use this control field. It indicates the characteristics of the font(s) that this particular print record uses. Multiple print records destined for the same print line use different Overprint Codes to output text using different fonts. Not all printers require Overprint Codes. Therefore, they only incorporate into print records when the assigned extended reporting printer requires them. Overprint Codes are called TRC (Table Recognition Codes) on IBM printers that support multiple fonts while running in Line Compatibility mode. System Concepts 3 9
Printer Characteristics Function Codes Printers that require one print record to support the printing of multiple fonts on the same print line process print records as a combination of two data types: Text Control information. The text is that portion of the print record that is to actually appear on the printed page. Function Codes consist of control information that instructs the printer how to process the text. To do this, they define the type of font, size of the characters, data type (single or double byte data), and special operations such as repeating a character, and underlining text. CA-Easytrieve/Plus processes Function Codes before data (Header Function Codes), or after data (Trailer Function Codes). CA-Easytrieve/Plus assigns Function Codes to a font that the Extended Reporting Facility uses. When you use the font to which Function Codes are assigned, CA-Easytrieve/Plus combines the appropriate Function Codes with the item in the print data. Print Items This term refers to the actual text or data that appears on the report. In terms of CA-Easytrieve/Plus syntax, it is either a field or a literal. Printer Characteristics This section discusses the printer characteristics that CA-Easytrieve/Plus uses to generate the correct print data set for the appropriate extended reporting printer. There are three types of printer characteristics that CA-Easytrieve/Plus supports. They are: 1. Printer Type - defines the method CA-Easytrieve/Plus uses to build print records and how CA-Easytrieve/Plus combines different fonts onto the same print line. 2. Paper Control Code - identifies the method CA-Easytrieve/Plus uses to control vertical positioning on a page. 3. File Type - defines the attributes of the print data set that CA-Easytrieve/Plus creates as it outputs print records. 3 10 CA-Easytrieve/Plus Extended Reporting Facility Guide
Printer Characteristics Printer Type The printers that CA-Easytrieve/Plus supports use different techniques to identify fonts and print items within a print record. The seven categories of printers that CA-Easytrieve/Plus supports are shown in the following diagram. System Concepts 3 11
Printer Characteristics Page Printers In contrast to Line Mode devices, which associate one print record with one print line, Page Printers are devices that process a Data Stream containing printer commands and print data. Page Printers use Structured Fields and provide support for All Points Addressable printing. Print records contain structured fields. Structured fields are self-identifying strings of bytes containing control information, control information parameters, and a print item's data. Page printer's process data on a page basis (as opposed to line by line). Therefore, CA-Easytrieve/Plus positions a print item on the page by defining the coordinates of the start of the item. These coordinates consist of a vertical displacement from the top of the page (Y-direction) and a horizontal displacement from the left side of a page (X-direction). At compile time CA-Easytrieve/Plus assigns each print item its appropriate X-direction coordinate based on the coding of the CA-Easytrieve/Plus program. CA-Easytrieve/Plus cannot determine the Y-direction coordinate until execution time because the vertical displacement from the top of the page of a particular print line is dependent upon the vertical space already occupied by print lines printed before the current print line. As a result, CA-Easytrieve/Plus determines the appropriate X-direction coordinate at compile time and builds the appropriate print records leaving room for the insertion of the correct Y-direction coordinate during the execution of the user program. To perform this function, CA-Easytrieve/Plus uses a set of printer control codes that normal line mode printers do not support. These control codes are: Set Vertical Position This is a control code that defines the Y-direction coordinate for the data that follows in the current print record. CA-Easytrieve/Plus supports two ways of defining this coordinate. The first is to establish the Y-direction coordinate relative to the current Y-direction coordinate. This means that CA-Easytrieve/Plus must merge the control code with a value in H-units that specifies the distance that the new line is to be positioned relative to the current Y-direction coordinate. The second method of establishing the Y-direction coordinate is by setting an absolute Y-direction coordinate. In this case CA-Easytrieve/Plus merges the control code with the new Y-direction address on the page (in H-units) and adds this value to the print record prior to performing any horizontal (X-direction) positioning. 3 12 CA-Easytrieve/Plus Extended Reporting Facility Guide
Printer Characteristics Set Horizontal Position This is a control code that defines the X-direction coordinate for the data that immediately follows in the print record. This code precedes the data for each print item. Like the Set Vertical Position, the X-direction coordinate can be defined as either a relative offset from the current coordinate, or as an absolute address on the current line. In either case, the control code nullifies the need for blank spacing between print items. Line mode printers use this blank spacing to position one item to the right of another print item on a print line. This is no longer required as each item can be uniquely assigned its print position independent of any other print item. Function Codes These are additional, printer specific codes that can be added to the print records to identify the characteristics of the font to be used for a print item's data. Examples of the characteristics that such codes define include the character's height, width, style, shape, data format (EBCDIC or DBCS), and so on. CA-Easytrieve/Plus inserts these codes into print records after the Set Horizontal Position control code (for Function Header codes) and after the print item's data (for Function Trailer codes). Note: CA-Easytrieve/Plus only inserts the Function Trailer when the next print item's font is different from that of the current print item. Where the fonts are the same, CA-Easytrieve/Plus does not insert the Function Trailer code and the Function Header code (for the next print item). System Concepts 3 13
Printer Characteristics The following example illustrates the construction of print records for Page Printers. ----------------------------------------------------- S S F d S d S F d S F d F V H C a H a H C a H C a C P P t P t P t P t a a a a ----------------------------------------------------- --- Function Code(s). At this point, the font has changed so the Function Trailer code for the current font is inserted prior to the Function Header for the font of the third print item --- Set Horizontal Position code to set the X-direction coordinate for the next print item. Note that the lack of a Function Code indicates that the font is the same for the second print item. --- Header Function code for the font assigned to the first print item on this record. --- Set Horizontal Position code merged with the X-direction coordinate value. --- Set Vertical Position code merged with the Y-direction coordinate value. Line Mode Line Mode printers support print data sets whose print records contain data and control information particular to a line. Line Mode printers restrict control of mapping print items to a page permitting only the positioning of items along the current line. At the start of each print record carriage control codes control the vertical position on a page. Line printers can be further divided into six more finite classifications based on their ability to support Overprint and Function codes in the print record. 3 14 CA-Easytrieve/Plus Extended Reporting Facility Guide
Printer Characteristics Overprint Codes Printers that support only one font per print record use Overprint Codes. Therefore to combine more than one font on a print line CA-Easytrieve/Plus must build multiple print records. However, a print item is only output on the print record whose Overprint Code matches the Overprint Code of that print item's font. Line spacing occurs prior to the first print record. Each additional print record overprints the first. The printer then merges all these print records to form one print line. CA-Easytrieve/Plus uses two methods of merging print records depending on the extended reporting printer's characteristics. The two methods are Merge Overprint and Print Overprint. The following topics discuss both of these overprint methods. The overprint feature is a function of the printer hardware. For both overprint techniques, CA-Easytrieve/Plus generates multiple print records containing the required data and printer control codes. However, the layout of the data in the print records that CA-Easytrieve/Plus produces for each overprint technique must be different in order for the print items on the report to line up properly. This becomes evident upon examining the different techniques. The following example illustrates the overall structure of the print records built for printers that support Overprint Codes. System Concepts 3 15
Printer Characteristics Function Codes Printers that support both control and print data in the same print record use Function Codes. Printer manufacturers assign the control information special values (function codes) that identify it from the normal print data. The printer does not print function codes on the report but uses them to define the function that is to be performed. A function code defines the format of the data (EBCDIC or DBCS), the size of the characters, and so on. The following example illustrates the structure of print records supported by function code printers: Overprint and Function Codes The third major category of Line Mode printers are those that support both Overprint and Function Codes in the same print record. These printers use the Overprint Code to establish the font of the characters to be printed (size, style, shape, and design). They use Function Codes to distinguish one Data Type from another, that is, to distinguish EBCDIC from DBCS. Because these printers support an Overprint Code, the printer combines multiple print records to form a single print line when CA-Easytrieve/Plus requires a mixture of fonts on one line. As has already been mentioned, there are two techniques applicable to combining multiple print records: Merge Overprint and Print Overprint. These same two techniques are also applicable to this category of printer. The following section compares the two overprinting techniques. 3 16 CA-Easytrieve/Plus Extended Reporting Facility Guide
Printer Characteristics The following example illustrates the format of the print records built for this type of printer: Overprint Techniques The two techniques that CA-Easytrieve/Plus supports for overprinting multiple print records to form a single print line are Merge Overprint, and Print Overprint. The printer hardware defines the technique that CA-Easytrieve/Plus uses. CA-Easytrieve/Plus automatically compensates for the characteristics of the appropriate technique that the extended reporting printer uses. The first overprint technique, Merge Overprint, merges the print records by character position in the print record. The second technique, Print Overprint, combines the print records by their physical position in the final print line. The results of the Print Overprint technique are similar to those obtained when overprinting on an impact line printer. Merge Overprint When merging multiple print records into a single print line, the merge process combines the data on a character by character basis. The 12th character in a print record, for example, merges with the 12th character in another print record. This happens regardless of where those characters might otherwise appear (as a result of differences in character width) on the print line. The rules that the printer uses to merge print records (of the same or different font widths) into one print line are: A printable character in a following record replaces an identical character or a blank. A blank in a following record does not replace either a blank or a printable character. A printable character trying to replace a previous printable character different from itself results in a data check, and the character in the new record does not replace the character in the previous record. System Concepts 3 17
Printer Characteristics When merging blanks of different W-units, the resulting blank has the W-unit of the first one. When a printable character is merged with a blank, the resulting character has the W-units of the printable character. To illustrate this process, assume that three print records are being merged and the W-units are in points. The first record contains 7-point characters, the second contains 12-point characters, and the third contains 9-point characters. Each print record contains four characters (three blanks and one printable character in each case). The following example illustrates the three print records and the resulting print line. 3 18 CA-Easytrieve/Plus Extended Reporting Facility Guide