Creating a template report

To define a template report, you must link it to a layout and specify one or more dynamic fields (report name, dynamic distribution, or both). If you do not know in advance what the values of the fields that you want to capture will be, create Template reports.

Template reports automatically create content-defined report definitions (derived reports) with report names or distribution lists that are derived from values specified in the template report fields. When you define a template report definition, you construct the dynamic fields (report name, dynamic distribution, or both) out of static text, layout field names, and Output Manager variable names (such as Job Name or User ID). You can also specify additional field condition criteria, just as you do in custom reports. Report definitions that are automatically created by a template report are displayed as custom report definitions in the Report Definitions panel (ISPF A.C), with YES in the Derived column.

To create a template report definition:

From the Output Manager main menu, choose option A, Administrative Functions, and press Enter.
From the Administrative Functions menu, choose option C, Custom Reports, and press Enter.
Specify search criteria, or leave the fields blank, and press Enter.
The resulting list is filtered by your search criteria.
Type ADDT on the command line and press Enter to add a template report.
The Search for Layouts panel is displayed.
Select a layout to link template report to.
1. Specify search criteria to locate the layout, and press Enter.
2. In the CMD column, type S (Select) next to the name of the layout that you want to use, and press Enter.
  The layout name is displayed in the Layout field.
Specify one or both dynamic fields.
A template report must have at least one dynamic template value. You must specify an Output Manager variable, or a layout field name in the Report name field, (the report name that will be automatically created for each derived report definition), the Dynamic dist field (the distribution list that will be automatically created or matched for each derived report definition and used in lieu of the distribution list linked in the Default Dist field), or both.
For more information on constructing values in these dynamic template fields, see Syntax and rules for constructing dynamic values in template reports

Note: The dynamic fields of a template report can be used in conjunction with Output Manager translations to substitute source values in the sysout with specified translation values. You can use translations to exert control over your dynamically created derived report names and distribution lists. For more information, see Translating data with substituted values using Output Manager translations.
Specify additional report definition fields:
1. In the Status field, accept the initial value of Enabled to make the template report definition available for use by Output Manager, or type Disabled if you do not want to the report definition to be available for use yet.
  
  Important: If a template report is disabled, its associated derived report definitions will not be captured. It is not recommended to disable template reports.
2. In Description field, type an optional description for the template report. This description will be used for all reports derived from this template, and can be up to 60 characters long.
3. Optional: In the Print Model field, type Classic or Report to specify the "model" for determining which set of printer attributes to use for printing the report instances that are based on this report definition.
  For more information on Print Model, refer to the help panel.
4. In the Dynamic Print field, indicate whether you want to capture and use the "dynamic printing parameters" (CLASS, DEST, FCB, FORMDEF, FORMS, OPTCD=J, PAGEDEF, PRMODE, TRC, and UCS) for printing the report instances that are based on this report definition. Valid values include No and Report. For more information on Dynamic Print values, refer to the help panel.
5. Optional: The Default dist field displays the name of the linked distribution list to use when a dynamic distribution list is not used (either no field content matched a distribution list name, or no fields were specified in the Dynamic Dist field). To link a default distribution list to the template report:
  1. From the Link pull-down menu, choose option 2, Choose a Distribution List.
  2. In the Distribution List Selection window, specify the S (Select) line command next to the distribution list that you want to use as a default
6. Optional: To link a banner page definition to the template report, choose option 3, Choose a Banner Page, from the Link pull-down menu. Then, in the Banners window, specify the S (Select) line command next to the banner definition for the banner that you want to appear in printed report output.
7. Optional: If you selected a banner page, you can specify special instructions to be inserted into the banner during print processing. Choose option 1, Edit Instructions, from the Special Instructions pull-down menu. Then type the instructions that you want to include in the banner (for example, special routing instructions). Press Enter and then press F3.
8. Optional: To specify a PRSET member, choose option 4, Choose a PRSET member, from the Link pull-down menu.
  Specify search criteria in the Search for PRSET panel and press Enter. Then, in the PRSET Member Selection panel, specify the S (Select) line command next to the name of the existing PRSET member that contains the binary characters that you want to use to control the physical printing of this report (for example, AFP structured fields). Press Enter to return to the Report panel. The member name is displayed in the PRSET member field.
  Tip: You can type ADD in the command line to add a PRSET member that is not listed. You will be prompted to enter an existing member name, and the data set where the member is located.
9. Optional: To link a set of printer attributes to the template report, choose option 5, Choose a Printer Attribute, from the Links pull-down menu. Specify search criteria, and then select the printer attribute by typing S (select) in the CMD column and pressing Enter.
  Tip: You can add a new printer attribute by typing ADD on the command line or an I (Insert) in the CMD column to open a new Printer Attribute panel.
Define report condition entries for the template report. Any report condition entries specified will be used to derive custom reports; derived reports are only created when the conditions are met.
1. To define report condition entries for the template report, type ADD on the command line.
  The Report Condition Entry pop-up is displayed.
2. In the Condition Type section, select the condition type by typing the corresponding numbers in the type fields:
  In the Condition type field, select one of the following:
  - (1) Include - If the field condition is matched, include it in the derived report.
  - (2) Exclude - Defines a condition against which SYSOUT pages are matched to determine if they are eligible for inclusion in the derived report. Pages that satisfy this condition will NOT be included in the report. Any page of the SYSOUT that matches this condition is removed from the report.
  - (3) Condition - Defines a condition against which SYSOUT pages are matched to determine if they are eligible for inclusion in the derived report.
  - (4) Begin - Defines a condition that identifies the beginning of a set of pages within a SYSOUT data set to include in the derived reports. Usually, a BEGIN condition entry is specified with an END condition entry; however, an END condition entry is not required.
  - (5) End - Defines a condition that identifies the end of a set of pages within a SYSOUT data set. You cannot specify an END condition entry until you first specify a BEGIN condition entry.
  Select one of the following:
  - Include: Include the matched page of the report.
  - Exclude: Exclude the matched page of the report. For BEGIN conditions, the report will start on the next page. For END conditions, the report will end on the previous page.
  - One: Include the first matched page in the report, and exclude any subsequent matches.
3. Type S in the blank field next to the Field Name column to select the field to be used for the condition.
4. You can define from one to eight conditions that must be met for a page to be included in the report. Specify one condition per line. You can expand a field by pressing F4.
  Note: If you specify more than on condition on this panel, the conditions will be related to one another by means of the AND connector (all must be true).
  For each condition, complete the following fields:
  Field
  
  (Required) Type an S (select) and press Enter in the blank field to select the name of a field that you want to include in the derived report. This field must be defined in the layout that is linked to this report definition and must occur in the SYSOUT.
  
  Op (operator)
  
  (Required) Type a comparative operator that will qualify any match between the "value" that you specify in the condition entry and the actual value for the specified field in the SYSOUT. Valid operators are: EQ (equal to), GT (greater than), GE (greater than or equal to), LT (less than), LE (less than or equal to), and NE (not equal to).
  
  Value
  
  (Required) Type a value for the specified field to be matched against the actual values for the field in the SYSOUT by using the designated operator. This matching selects the pages to include in the derived report.
  
  Case
  
  Indicate whether or not the specified "Value" string is case-sensitive. When Y (YES) is specified, the string must match Report content exactly. If N (NO) is specified, Output Manager will convert the Report content to uppercase before the value string comparison is tested. The default is Y.
  
  Var
  (Optional) If the location of the field within the SYSOUT can vary horizontally from the location that is defined in the layout, you can specify a horizontal variance. In general, this variance is the number of columns to the right of the defined starting column in which the field begins. Valid values are from 0 through 99.
  
  If you accept the default value of 0, Output Manager will look for the beginning of the field only at the starting column that is defined in the layout.
  
  If you specify a number from 1 through 98, Output Manager will look for the field at the defined starting column and in each column to the right of the defined starting column (within the same row), up to the number of columns that you specify. For example, if you specify 5, Output Manager looks for the field at the defined starting column and in the five columns to the right of that starting column.
  
  If you specify 99, Output Manager will look for the field at the defined starting column and in all columns to the right, up to the end of the row.
5. When you are finished defining conditions, press F3 (Exit). If an exit confirmation prompt is displayed, press Enter. The Template Report panel is redisplayed. Your condition entries are listed at the bottom of the panel.
6. To add another condition entry, type I (Insert) in the CMD column, and press Enter.
  
  The Report Condition Entry pop-up window is redisplayed. Specify the additional condition or conditions and press F3 (Exit) to return to the Report panel.
When you are finished, press F3 (Exit). If an exit confirmation pop-up window is displayed, press Enter to save the template report definition.
Important: Once a derived report has been captured for a template, the template cannot be edited. Template reports must be unaltered and enabled in order continue capturing existing derived reports. If you need to modify an existing template report, you can copy the template and modify the copy. To suppress a derived report from creating new instances of a custom report, disable the derived report. It is highly recommended to test template reports before putting them into production.