Creating a custom report definition with condition entries
To define a custom report, you must create a report definition that specifies one or more condition entries (field-operator-value conditions).
You can specify either PAGE condition entries or BEGIN and END condition entries. The condition entries define the page or set of pages in a SYSOUT data set that comprise the custom report. The fields that you specify in the condition entries must be specified in the layout that is linked to the report definition.
To create a custom report definition based on condition entries:
- 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.Note: If the Report Definitions panel lists no report definitions, either none are defined on your Output Manager system or none matched your saved search criteria.
- Type ADD on the command line and
press Enter. The Report panel is displayed.Tip: Once a report definition has been defined, you can type
I(Insert) in the CMD column and press Enter to display the Report panel.
Define the custom report:
(Required) In the Report name field, type a logical name for the custom report. This
name can be up to 64 characters long.
You must specify a name before enabling the report definition.Note: It is not recommended to use special characters (asterisk (*), ampersand (&), percent sign (%), underscore (_), or space) in report names. These characters are all converted to an underscore when checked with RACF®. Using these characters in report names can cause problems with the RACF security profiles for report names.
- (Optional) In Description field, type an optional description for the report. This description can be up to 60 characters long.
- In the Status field, accept the default value of Enabled to make the 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.
In the Print Model field, specify the "model" for determining which set of printer
attributes to use for printing the report instances that are based on this report definition.
Type one of the following valid values:
- Classic - Use the sets of printer attributes that are linked to the recipient IDs on the distribution list that is assigned to this report definition.
- Report - Use the set of printer attributes that is linked to this report definition.
Output Manager takes the Class, Copies, and Dest values from
these sets of printer attributes (along with any other printing parameters that are specified). You
can override these Class, Copies, and Dest values for individual recipients on the distribution
list; to do so, specify the
C(set print Configuration) line command for a recipient on the Distribution List panel. This is the default value.
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.
Output Manager can capture values for these printing parameters from the SYSOUT data sets and from the set of printer attributes that is linked to one of the following objects (in order of priority): 1) the distribution list or 2) the report definition. The parameters from these two sources are stored in the BJTDAT table and are merged for use when a report is printed. If duplicate values exist for a parameter, the value in the applicable set of printer attributes takes precedence. Type one of the following valid values:
Note: If ARCHIVES, REPORTS, or ALL is specified in, the DYNAMIC_PRINTER_ATTRIBUTE_CAPTURE or the DYNAMIC_PRINTER_ATTRIBUTE_USE configuration parameters, Output Manager captures all of the dynamic printing parameters, (across all archives, all reports, or all archives and reports, respectively) even if the Dynamic Print field is set to No for that object type. These configuration parameters are specified in the Policy Administration panels (ISPF A.PA).
- No - Do not dynamically capture and use the "dynamic printing parameters." Instead, obtain all printing parameters, including the "dynamic printing parameters," from the printing-related definitions that you create, including the recipient IDs that are on the distribution list and any applicable set of printer attributes. (The Print Model setting affects which of these definitions are used.) This value is the default value.
- Report - Dynamically capture the values for the "dynamic printing parameters" and use them for printing reports. If the BJTDAT table does not contain values for some dynamic printing parameters, these values can be provided by the static, printing-related definitions (the recipient IDs or applicable set of printer attributes). If you specify Report, you should set the Combine Sysout field in the associated selector rule to No; otherwise, the dynamic printing parameters will be taken only from the first SYSOUT in an archive file.
For more information about dynamic printing, see Print configuration.
- (Required) In the Report name field, type a logical name for the custom report. This name can be up to 64 characters long.
Set up links to the custom report:
Link a report layout: From the Links pull-down menu, choose
option 1, Choose a Layout. In the CMD column, type
S(Select) next to the name of the layout that you want to use, and press Enter.
(Optional) Link a distribution list to the report definition. From the
Links pull-down menu, choose option 2, Choose a Distribution List, and
S(Select) line command next to the distribution list that you want to use.Tip: You must specify a distribution list if you want Output Manager to automatically distribute the report during the automatic printing of non-bundled report instances.
(Optional) Link a banner page: From the Links pull-down menu,
choose option 3, Choose a Banner Page, and specify
S(Select) line command next to the banner definition for the banner that you want to appear in printed report output.Note: (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.
(Optional) Link a PRSET member: From the Links pull-down menu,
choose option 4, Choose a PRSET Member, and type 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). You can leave this field blank to select one from a
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.
(Optional) Link printer attributes: From the Links pull-down
menu, choose option 5, Choose a Printer Attribute, 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.
Link a WTO context: From the Links pull-down
menu, choose option 16, WTO Context and select the contexts in which you want
Output Manager to issue a WTO message.
For more information, see Issuing a WTO message when a report is captured or printed.
- Required: Link a report layout: From the Links pull-down menu, choose option 1, Choose a Layout. In the CMD column, type
- To define report condition entries, type ADD on the command
line. The Report Condition Entry pop-up is displayed.
- In the Condition Type section,
select the condition type by typing the corresponding numbers in the
Select one of the following:
Select one of the following:
- (1) BEGIN - Defines a condition that identifies the beginning
of a set of pages within a SYSOUT data set. Usually, a BEGIN condition
entry is specified with an END condition entry; however, an END condition
entry is not required. There are three types of BEGIN conditions:
- Inclusive: When an inclusive BEGIN condition is matched on a page of the SYSOUT, the matched page is included in the report. Subsequent matches are also included in the report.
- Exclusive: When an exclusive BEGIN condition matches on a page of the SYSOUT, the first matching page is excluded. The report begins on the next page (the page following the matched page is included in the report).
- One: When this type of BEGIN condition matches a page of the SYSOUT, the first matched page is included in the report.
- (2) 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.
There are three types of END conditions:
- Inclusive: When an inclusive END condition is matched on a page of the SYSOUT, that page is included in the report. Processing continues, and all subsequent matches of the inclusive END condition are also included in the report.
- Exclusive: When an exclusive END condition is matched on a page of the SYSOUT, the first matched page is excluded from the report. The report ends on the previous page (the page preceding the matched page is included in the report, but the matched page is not).
- One: When this type of END condition matches a page of the SYSOUT, the first matched page is included in the report. Any subsequent matches are not included in the report.
- (3) EXCLUDE - Defines a condition against
which SYSOUT pages are matched to determine if they are eligible for
inclusion in the custom 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. Note: EXCLUDE conditions are processed last, regardless of the order they are listed in on the Report panel.
- 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.
- (1) BEGIN - Defines a condition that identifies the beginning of a set of pages within a SYSOUT data set. Usually, a BEGIN condition entry is specified with an END condition entry; however, an END condition entry is not required. There are three types of BEGIN conditions:
- Type S in the blank field next to the Field Name column to select the field to be used for the condition.
- 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:
- (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 custom 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).
- (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 custom report.
- 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.
- (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.
- When you are finished defining conditions, press F3 (Exit). If an exit confirmation prompt is displayed, press Enter. The Report panel is redisplayed. Your condition entries are listed at the bottom of the panel.
- 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.Note: If you specified multiple conditions on the Report Condition Entry panel, the new conditions are related to one another by the AND connector, but they are related to the previous set of condition entries by the OR connector (one set or the other must be true).Important:
The order that the BEGIN and END conditions are listed on the Report panel is significant. You can have several BEGIN conditions listed, followed by several END conditions, and this "group" of conditions will be associated with one another by means of an OR connector. However, if an additional BEGIN condition appears after the END conditions, that BEGIN condition starts a new "group". Multiple BEGIN/END groups are linked by means of an AND connector, and all groups are run in parallel. Within a BEGIN/END group, the condition that matches a page is the condition that determines whether or not that page is a included in the report. If a page is matched in more than one BEGIN/END group, it is included in the report.
- When you are finished, press F3 (Exit). If an exit confirmation pop-up window is displayed, press Enter to save the custom report definition.