Chapter 7: Statement Generator

Transcription

1 Chapter 7: Statement Generator CHAPTER 7: STATEMENT GENERATOR... 1 STATEMENT GENERATOR OVERVIEW... 1 PARAMETER FORMATS... 2 CONTROL (TYPE 3 PARAMETER)... 2 Type 3 Parameter Fields... 2 ADDITIONAL GROUPS (TYPE 1 PARAMETER)... 4 Type 1 Parameter Fields... 4 SELECTION (TYPE PARAMETER)... EDIT (TYPE 7 PARAMETER)... 7 Type 7 Parameter Fields USER EXITS Statement Generator Overview The Statement Generator enables you to create statements, forms, and letters that report data from the Master Database. You can create up to 99 unique statement formats, each one containing up to 999 lines of up to 132 characters each. You can control the contents of statements by specifying a series of input parameters. Note: Statements are produced through deferred processing. You create your statement parameters through a text editor available on your system. Consult your information systems personnel for assistance in using the text editor. You can specify both the content and format of the statement by using any information contained on the individual record, specific information on the group record, and alphanumeric literals. In addition to specifying the content and format of the statement, you also can select the individuals for whom you want to create a statement. The Statement Generator can produce a statement for the entire Master Database, for selected groups on the Master Database, or for particular individuals. This chapter describes the: Control (Type 3 Parameter) Additional Groups (Type 1 Parameter) Selection (Type Parameter) Edit (Type 7 Parameter) User Exits SearchAll Report Writer Chapter 7: Statement Generator 1

2 Parameter Formats The Statement Generator has four different parameters for producing statements. Types 3 and 7 are required to generate a statement. Parameter Types 1 and can be used to include more groups. All Statement Generator parameter transactions share the report number, group number, and transaction type information. The group number appears in positions 3-8 of every parameter. To produce a benefit statement for all groups on the Master Database, leave the group number blank. The Type 1 parameter enables you to add additional groups. You can produce the statement for all groups on the Master Database by leaving the group number blank on the Type 3 parameters and following parameters, and using the Type Parameter to select group records. Here are the four types of parameters used to produce a statement: Type Descriptions 3 Control. Specifies the sort sequence, the form number of the stock the statement is printed on, and the number of a user-coded subroutine that you can call to perform calculations or selections beyond the scope of the Statement Generator. You must submit one Type 3 Parameter for each statement. 1 Additional Groups. Adds additional groups to those already specified. Selection. Specifies the tests that an individual record must pass before the Statement Generator produces a statement. 7 Edit. Specifies the format of each statement. You must submit at least one Type 7 Parameter for each statement. Control (Type 3 Parameter) One Control Type 3 Parameter must be submitted for each statement. This parameter defines the report number. The Control Parameter also provides you with the option of specifying a sort sequence, a forms change, or a call to a user exit subroutine to perform calculations or selections outside the scope of the Statement Generator programs. A report number (01-99) in positions 1 and 2 of the parameter identifies each statement request. Sort Sequence The Type 3 Parameter lists up to seven sort fields for each report. You can specify individual record data elements only in the sort fields. Sort Field 1 indicates the most important field. The intermediate and minor sort fields follow in order of importance. These fields comprise the sort key. The combined length of the sort fields cannot exceed 48 characters. If the sort key length is less than 48 characters, the unused portion is filled with blanks. Each field indicated in the sort fields uses its entire Master Database length unless start/stop positions are indicated. A blank sort field indicates the end of the sort key. If all the sort fields are blank on the Type 3 Parameter, the Statement Generator sorts on the individual key sequence. Type 3 Parameter Fields Position Value Description 1-2 nn Report number. 3-8 CTRN Major key starting in position 1 and followed by blanks if fewer than six characters. 9 3 Parameter type XXXX Sort field 1. The name of the data element field that specifies the first sort field nn position. Indicates the first position within the data element field that is extracted 2 Chapter 7: Statement Generator SearchAll Report Writer

3 16-17 nn position. Indicates the last position within the data element field that is extracted for XXXX Sort field 2. The name of the data element field that specifies the second sort field nn position. Indicates the first position within the data element field that is extracted 24-2 nn position. Indicates the last position within the data element field that is extracted for XXXX Sort Field 3. The name of the data element field that specifies the third sort field nn position. Indicates the first position within the data element field that is extracted nn position. Indicates the last position within the data element field that is extracted for XXXX Sort Field 4. The name of the data element field that specifies the fourth sort field nn position. Indicates the first position within the data element field that is extracted nn position. Indicates the last position within the data element field that is extracted for 42-4 XXXX Sort Field. The name of the data element field that specifies the fifth sort field nn position. Indicates the first position within the data element field that is extracted nn position. Indicates the last position within the data element field that is extracted for 0-3 XXXX Sort Field 6. The name of the data element field that specifies the sixth sort field. 4- nn position. Indicates the first position within the data element field that is extracted 6-7 nn position. Indicates the last position within the data element field that is extracted for 8-61 XXXX Sort Field 7. The name of the data element field that specifies the seventh sort field nn position. Indicates the first position within the data element field that is extracted 64-6 nn position. Indicates the last position within the data element field that is extracted for Any Forms code for output. See your System Administrator nn User exit number. This is the number of the EX field that contains the user exit routine Blank Not used. Type 3 Parameter Rpt. # Group Control (Type 3 Parameter) TypeSort Field 1 Sort Field 2 Sort Field 3 Sort Field 4 Sort Field Sort Field 6 Sort Field Form Number Output User Exit EX If sorted fields are blank, TRAN Key sequence is assum ed SearchAll Report Writer Chapter 7: Statement Generator 3

4 Additional Groups (Type 1 Parameter) If you want to produce a statement for more than one group, but not for the entire Master Database, use the Type 1 Parameter. A Type 1 Parameter can produce statements for up to 0 additional groups. For Type 1 Parameters, the group keys should be in alphanumeric order. Do not duplicate group keys. If your group number is fewer than six positions, left-justify it and follow it with blanks. You can specify up to 11 groups on one Type 1 Parameter. Multiple Type 1 Parameters can be entered. The ability to specify fewer than 11 groups on a Type 1 Parameter allows you to add or delete a single parameter when a group is added or deleted, rather than rewrite a parameter with several entries in order to change just one. When specifying additional groups on a Type 1 Parameter, enter all group numbers consecutively. A blank additional group field signifies the last Type 1 Parameter for the run. Here's a description of the Type 1 Parameter fields: Type 1 Parameter Fields Position Value Description 1-2 nn Report number. 3-8 CTRN Major key starting in position 1 and followed by blanks if fewer than six characters. 9 1 Parameter type CTRN First additional group. The group key of the first additional group for which the parameters are to be processed CTRN Second additional group. The group key of the second additional group for which the parameters are to be processed CTRN Third additional group. The group key of the third additional group for which the parameters are to be processed CTRN Fourth additional group. The group key of the fourth additional group for which the parameters are to be processed CTRN Fifth additional group. The group key of the fifth additional group for which the parameters are to be processed CTRN Sixth additional group. The group key of the sixth additional group for which the parameters are to be processed CTRN Seventh additional group. The group key of the seventh additional group for which the parameters are to be processed. 2-7 CTRN Eighth additional group. The group key of the eighth additional group for which the parameters are to be processed CTRN Ninth additional group. The group key of the ninth additional group for which the parameters are to be processed CTRN Tenth additional group. The group key of the tenth additional group for which the parameters are to be processed CTRN Eleventh additional group. The group key of the eleventh additional group for which the parameters are to be processed Blank Not used. 4 Chapter 7: Statement Generator SearchAll Report Writer

5 Type 1 Parameter Additional Groups (Type 1 Parameters) Ty pe 1st Additional 2nd Additional 3rd Additional 4th Additional th Additional 6th Additional 7th Additional 8th Additional 9th Additional th Additional 11th Additional Selection (Type Parameter) The Selection Parameter defines tests that an individual record must pass to have a statement produced. If you do not submit any Type Parameters, a statement is produced for all individuals in all the groups specified. The Selection Parameter can test any data in the individual's record. The system makes comparisons between fields on the individual record (identified by system data elements or user-defined fields) and numeric values, alphanumeric literals (enclosed in apostrophes), other fields on the individual record, and any of the special (WA and WN) User Exit fields. For more information on User Exits, see the section titled User Exits. Each selection test begins with either ACCEPT or REJECT, which determines what happens to an individual's record when the system resolves the test with a true or false solution. The tests are English-like in structure, and are interpreted as they are read as follows: ACCEPT (REJECT) this record if an operand is equal to (greater than, less than, not equal to) another operand. Example: To select all individuals who make more than $1,00.00 per pay period. 010ACCEPT SALY G This example produces the same result: 010REJECT SALY L Note: The selection statement always assumes two decimal places. Each selection test can contain several clauses connected by either AND or OR. Each clause specifies a test. If the clauses are connected by OR, satisfying any one test satisfies the sentence. If the clauses are connected by AND, all tests must be satisfied. If AND and OR clauses are mixed in a test, AND clauses are evaluated before OR clauses. Example: Print a statement if SALY is less than $ and either FLAG is equal to 0 (permanent) or SCHD is equal to S (salaried). 010ACCEPT SALY L AND FLAG E '0' 030OR SHCD E 'S' The same result is achieved by: 010REJECT SALY G ACCEPT FLAG E '0' 030OR SHCD E 'S' In this case, the system skips all individuals with pay period salaries greater than $ without testing FLAG and SCHD. SearchAll Report Writer Chapter 7: Statement Generator

6 You must assign a sequence number to each Type Parameter to assure that the selection tests are made in the intended order. When you use a Type Parameter, consider these factors: Data that you're comparing should be compatible. For example, compare numeric fields only against other numeric fields or numeric literals. Numeric fields cannot be compared against alphanumeric fields (containing alpha characters) or literals. Alphanumeric literals should not exceed 24 characters and must be enclosed in apostrophes. All alphanumeric fields are compared on 24 characters. Shortened fields are space-filled on the right. DATE fields are eight-byte, alphanumeric. Therefore, you must specify start and stop positions for greater than or less than tests. Here's a description of the Type Parameter fields: Type Parameter Fields Position Value Description 1-2 nn Report number. 3-8 CTRN Major key starting in position 1 and followed by blanks if fewer than six characters. 9 Parameter type nnn Sequence number Condition to select which records to produce statements for. ACCEPT REJECT AND OR Selects the record if it meets the condition that was set. Bypasses the record if it meets the condition that was set. Selects or bypasses the record if it meets the previous and next conditions set. Selects or bypasses the record if it meets either the previous or the following conditions set First operand. The name of the data element field that represents the first value in the equation to select records. In the example A + B, A is the first operand nn position. The first position of the data element field (defined in positions 19-22) that is extracted nn position. The last position of the data element field (defined in positions 19-22) that is extracted. 27 CTRN Operation code that defines how the equation to select records is processed. E U G L 28-31, Numeric Value, or Literal The first operand is equal to the second operand. The first operand is unequal the second operand. The first operand is greater than the second operand. The first operand is less than the second operand. Second operand. The name of the data element field that represents the second value in the equation to select records. The second operand can also be a numeric value or the beginning of a literal nn The first position of the data element field (defined in positions 28-31) that is extracted. These positions can also include part of the literal that begins in position nn position. The last position of the data element field (defined in positions 28-31) that is extracted. These positions can also include part of the literal that begins in position Any Literal. Can contain part of a literal that begins in position Blank Not used. 6 Chapter 7: Statement Generator SearchAll Report Writer

7 Type Parameter Selection (Type Parameter) 'Literal' Ty pe Sequence No. ACCEPT/REJECT; AND/OR O P Value OP Codes E = Equal U = Unequal G = Greater L = Less Edit (Type 7 Parameter) The Edit Parameter specifies the data that prints on the statement and the print location on the output. At least one Edit Parameter is required to produce a statement. Edit Parameters come from four sources: 1. Individual record fields Referenced by either system-defined fields or user-defined fields. 2. Group record fields CEDT (processing period end date) CPPD (date of report (payment)) CNA1 (group name) CNA2 (group address) CN1S (shortened group name) CA1S-CA4S (shortened 4 lines of group address) CPER (current processing period number) CQAR (current calendar quarter number) CTRN (group key) CSSC (group social security number) CSTX (state tax reporting number) CSTT (group processing status) CPNO (number of cycles per year) CLCN (super group number) CRTE (UIC rate - Canadian only) CTYP (processing language) 3. WA and WN fields Provided by user exits. 4. Alphanumeric literals Must be enclosed in apostrophes and not exceed 24 characters. SearchAll Report Writer Chapter 7: Statement Generator 7

8 An additional option, referred to as a table look-up, gives you the ability to access table values. The Statement Generator can retrieve a field code or the English language description (from the Table File) and print it on a statement. To indicate a table look-up, enter T in position 28 of the Type 7 Parameter. In positions 29-31, enter the threeposition table code. The table code should be identical to a valid table code on the external Table File. In positions 32-3, enter the start and stop positions for the extraction of the data. and stop positions are identical to other Statement Generator start and stop functions and are optional. If they are not defined, the system retrieves and prints all 48 characters of the table description. The line number and start position on the Type 7 Parameter controls the placement of data on the statement. The line number controls the vertical position, and the start position controls the horizontal position. The line number value can be from 001 to 999, with line number 001 corresponding to the top of the form. The start position indicates the horizontal position of data printed. The maximum is 132 characters. The starting position value specifies the far left position of the data on the line and must not overlap with the field or literal to its left. If it overlaps, the first data specified will be overlaid. Two optional edit features, edit code and size, are available on the Type 7 Parameter. The edit code allows you to specify a smaller edit size for both alphanumeric and numeric fields. The size feature allows you to specify the print format of numeric fields. When you specify a smaller edit size, the system truncates alphanumeric fields on the right and truncates numeric fields on the left. The size of a numeric field includes the required edit characters and the minus sign. If the size field is blank, the entire field size is used. For numeric fields, the implied size depends on the edit code. Here is a list of the Edit Codes, including an illustratration of the formats, and the default size of the resulting numeric printed. When the Edit code is blank and the system-defined data element field is numeric, the system uses Edit code 01 (in the format 1, 234, 67.89). A user-defined data element field defaults to its Master Database format. An Edit code is invalid when specified for a field system-defined as alphanumeric. Edit Codes System Defined Fields Suppress Leading Zeroes; leave blank if all zero 01 1,234, Ignore Cents 04 1,234, , System Defined Fields Same as 01-0 except when all zero Chapter 7: Statement Generator SearchAll Report Writer

9 System Defined Fields Floating dollar; blank if zero 11 $1,234, $ $ $ $ System Defined Fields Same as 11-1 except when all zero 16 $ $ $ $ $0 9 System Defined Fields Fill leftmost zeroes 21 1,234, , User Defined Fields Leave blank if all zero , User Defined Fields If zero, see below 7 123,46, ,34, ,234, , SearchAll Report Writer Chapter 7: Statement Generator 9

10 79 12, User Defined Fields If 7-79 are all zero Table Blank -- No table look-up T -- Table look-up The following edit codes are available for date fields: Edit Code Description 82 Used on eight-character date fields (CCYYMMDD format) to print the date. Edit code 82 prints the date as MONTH DD, CCYY. The default size is 17 positions. 83 Used on eight-character date fields (CCYYMMDD format) to print the date. Edit code 83 prints the date as MONTH CCYY. The default size is 14 positions. 84 Used on six-character date fields (MMDDYY format) to print the date. Edit code 84 prints the date as MONTH DD, YY. The default size is 17 positions. 8 Used on six-character date fields (MMDDYY format) to print the date. Edit code 8 prints the date as MONTH YY. The default size is 14 positions. 86 Six-character date as MM-DD-YY 87 Six-character date as DD-MM-YY 88 Eight-character date as MM-DD-CCYY 89 Eight-character date as DD-MM-CCYY Here's a description of the Type 7 Parameter fields: Type 7 Parameter Fields Position Value Description 1-2 Nn Report number. 3-8 CTRN Group key of the group for which the parameters are to be processed. 9 7 Parameter type Nnn Line number of the line on which the data prints Nnn position. Indicates the first position on the line that the data prints Nn Size. The length of the field to be printed Nn Edit code. The format of the field to be printed Data Data element field from which the data to be printed is Element to be extracted. A literal also can be specified in these positions Nn position. The first position of the data element field (defined in positions 20-23) that the data is to be extracted from. A literal also can be specified in these positions. 10 Chapter 7: Statement Generator SearchAll Report Writer

11 26-27 Nn position. The last position of the data element field (defined in positions 20-23) that the data is to be extracted from. A literal can be specified in these positions. 28 T Table look-up. A value of T indicates that the data element value defined in positions is contained on a data table. This position also can be used as part of a a literal beginning in position Any Record code. This is the three-position code that specifies which data table the data element (defined in positions 20-23) is contained on. These positions also can be used as part of a literal beginning in position Nn position. Specifies the first position of the data element field on the table from which data will be extracted. These positions also can be used as part of a literal beginning in position Nn position. Specifies the last position of the data element field on the table from which data will be extracted. These positions also can be used as part of a literal beginning in position Any These positions can contain part of a literal beginning in position Blank Not used. Type 7 Parameter Report Group Number Ty pe Edit (Type 7 Parameter) 'Literal' Line Number Position Size Edit Code T B L Record Code 10 4 User Exits User Exits allow you to execute additional routines that you program. User Exits are named Program EX-- (-- is 01-2). This number is entered in positions 74 and 7 of the Type 3 Parameter. User Exits allow you to write special routines, perform calculations, or apply selection criteria outside of the Report Writer. Each Statement Generator format can call one routine, and the Type 3 Parameter contains the number of the specified routine. The system calls the routine each time it reads a Master Database record. The calling sequence provides pointers to both the input record and the work area. The user routine can call either group or individual records, so you can use both record types. The work area contains 20 WA fields, 20 WN fields, and an ACCEPT/REJECT switch. The WA fields are eight-byte alphanumeric fields. The WN fields are nine-byte packed numeric fields. The format of the work area is as follows: 01 USER-AREA SYNC. 0 WA-- FIELDS. 10 WA-- FIELD OCCURS 20 INDEXED BY WAX PIC X (8). 0 WN-- FIELDS. SearchAll Report Writer Chapter 7: Statement Generator 11

12 10 WN-- FIELD OCCURS 20 INDEXED BY WNX PIC S9 (7) V99 COMP-3 0 REJECT-SW PIC X VALUE ZERO. 88 RECORD-ACCEPTED VALUE ZERO. The numeric fields are fields WN01-WN20, and the alphanumeric fields are WA01-WA20. The system does not clear the fields during processing. When you produce multiple reports, the contents of the fields vary, and you should save the results from one record to the next in the user exit routine. The system sets the REJECT switch to zero before each call to the user exit. The user exit routine can set the switch to a non-zero value if the record is not to be used for a statement. 12 Chapter 7: Statement Generator SearchAll Report Writer