Attributes of a Report

This section describes the attributes which are part of a report definition:

• General Attributes

• Identification Attributes

• Distribution Attributes

• Printing Attributes

• Separation Attributes

• Using a Standard Separation Routine

Default values for report attributes can be set by the system administrator in Report Defaults.

General Attributes

To define the general attributes of a report:

1. Press PF2 on the Report Maintenance screen.

   The Report Definition > General Attributes screen is displayed:

   16:19:06 **** ENTIRE OUTPUT MANAGEMENT **** 2019-01-03 User ID XYZ - Report Definition >General Attributes - Report Name .............. ZZ-UEX1__________________ Type .. S Description ....... must be suspended_________________________________ Node name ......... ________________ Node number .. 40 Ident. source ..... ________ Spool type ... JES2 Keywords ............. _______________ _______________ _______________ Master Owner ......... ________ Store in NOM DB ...... Y Archive directly ..... N Archive type ......... _ Retention Report Archive Revive Number ............ 2__ 10__ 1__ Unit .............. A Y A Calendar .......... ________ ________ Action ............ A Command => ___________________________________________________________________ Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help Add Exit Flip Ident Print Dist Separ Ext Menu

2. On this screen, you specify the general attributes of a report.

   Some fields are initialized with the values specified in the Report Defaults.

3. The following special PF keys are available:

   Key	Name	Function
   PF7	Ident	Define Identification Attributes, which determine how reports are identified in the spool (not possible for reports of Type "C"). .
   PF8	Print	Define Printing Attributes.
   PF9	Dist	Define Distribution Attributes.
   PF10	Separ	Define Separation Attributes, which determine how reports are separated with user routines or standard routines (not possible for reports of Type "C").
   PF21	Ext	Switch between the display of long and short report names.

   Note:
   Some of these PF-key assignments are displayed only after you have entered a report name.

General Attributes - Fields

Identification Attributes

A report can be identified by one of the following:

• Report Identification for POWER

• Report Identification for BS2000

• Report Identification for JES

• Report Identification for 3GL Interface

• Report Identification for CA Spool

• Report Identification for Natural

• Report Identification for UNIX/Windows Nodes

Depending on the setting of the general attribute Ident. source, one of these is invoked by pressing PF7 (Ident) on on the Report Definition > General Attributes screen.

Report Identification for POWER

On the Report Definition > POWER Identification screen, you define how a job is identified in the POWER spool.

POWER Identification Attributes

The following attributes determine how a job in the POWER spool is identified by the report definition.

NOM DSN=data-set-name VOL=volser
NOM RECFM=recform RECSIZE=record-length
NOM BLKSIZE=block-size CC=carriage-control

• data-set-name may have a maximum length of 22 characters.

• carriage-control may be ASA, MACHINE or NONE.

Before processing, the file name is extended with a time stamp to make it unique.

Report Identification for BS2000

On the Report Definition > BS2000 Identification screen, you define how a job is identified in the BS2000 spool.

BS2000 Identification Attributes

The following attributes determine how a job in the BS2000 spool is identified by the report definition.

Carriage Control Characters

The RECFORM parameter of the file allows you to determine whether the print file contains carriage control characters and which ones. It is specified as follows:

RECFORM=(x,y)

where:

• x = F for fixed record length, or V for variable record length.

• y determines the type of carriage control characters:

  • A = ASA carriage control characters,

  • M = machine-code carriage control characters,

  • N = no carriage control characters.

It is recommended that files with a fixed record length be used, because positioning within them is easier than within files with a variable record length.

Report Identification for JES

On the Report Definition > JES Identification screen, you define how a report is identified in the JES spool.

JES Identification Attributes

The following attributes determine how a job in the JES spool is identified by the report definition.

Spool Files

To specify the spool files in the selected jobs, you use one of the following three possibilities:

1. Specify: file-type file-sequence-number

   where file-type can be: JL = JCL statements, SI = system input, SM = system messages, SO = system output.

   Examples:

   • Specify SO 1 for the first SYSOUT file.

   • Specify SO 1:4 for the first to fourth SYSOUT files.

2. Specify a list of full DDNAME qualifiers in the format:

   proc-name.step-name.ddname

   proc-name and step-name are not mandatory, and if omitted are assumed to be * (any). You can use an asterisk (*) to enter selection criteria for the file names.

   Examples:

   • PROC1.STEP1.DDN1 is a full qualifier.

   • *.STEP1.DDN1 refers to a spool file with STEPNAME=STEP1, DDNAME=DDN1 and any procedure name.

   • *.*.DDN1 or *.DDN1 or DDN1 are equivalent and refer to a spool file with DDNAME=DDN1 in any step name or procedure name in the job.

3. Specify TYPE=AL to create an active report containing all System Message and SYSOUT files for a job matching the specified JES attributes. The job must have at least one spool file in one of Entire Output Management's managed classes. TYPE=AL must be the only file criterion.

PROCESS SPOOL-UPDATE
        USING  FUNCTION   = 'CHANGE'
        USING  JOB-NAME   = #JOB-NAME
        USING  JOB-NUMBER = #JOB-NUMBER
        USING  GROUP-ID   = #GROUP-ID
        USING  CLASS      = #NOM-CLASS
        USING  NODE       = #NODE
        GIVING ERROR-CODE
               ERROR-TEXT

Sequential Files

If the report data reside in a sequential file, enter the file name in the form DSN=file-name.

The following special characters can be used to create a file-name pattern:

• ? (question mark) or _ (underscore) to indicate a single position not to be checked.

• * (asterisk) to indicate any number of positions not to be checked.

Example: DSN=NATURAL.*EMPL_YEE*

NOM DSN=data-set-name

data-set-name may have a maximum length of 22 characters.

The STEPNAME to create the spool file must be NOMDSN.

Example:

//JOB 1         JOB...
......
//NOMDSN       EXEC       PGM=IEBGENER
//SYSPRINT      DD          SYSOUT=*
//SYSUT2         DD          SYSOUT=3
//SYSIN            DD          DUMMY
//SYSUT1         DD *
NOM  DSN=OUTPUT.LISTING
/*

Report Identification for 3GL Interface

On the Report Definition > 3GL Identification screen, you define a report that relies on a general, user-defined 3GL interface.

See also 3GL Interface Maintenance in the System Administration documentation.

Report Identification for CA Spool

On the Report Definition > CA Spool Identification screen, you define how a report is identified in the CA Spool.

CA Spool Identification Attributes

These attributes determine how a job in the CA spool is identified by the report definition. A job can be identified by one of the following four attributes. You have to specify a value for at least one of these fields. A job is considered identified if it matches at least one of the specified attributes.

You can use asterisk notation (*) for the file name. For example, to identify all files whose names begin with "ADA", enter ADA*. Or, to identify all files which were either created by the user "XYZ" or whose names begin with "ADA", enter ADA* for File name andXYZ for User ID.

Report Identification for Natural

   09:12:27             **** ENTIRE OUTPUT MANAGEMENT ****            2019-11-11
  User ID XYZ       - Report Definition >NATURAL Identification -
  Report
     Name .............. ADAREP-DEFAULT___________

  NATURAL Attributes
     *USER ............. ________  or
     *LIBRARY ID ....... ________  or
     Printer Profile ... ________

     and

     *PROGRAM .......... ________  and
     FORM .............. ________  and
     NAME .............. ________

 Command => ___________________________________________________________________
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
       Help        Exit  Flip  Do    Undo              Ext               Menu

On the Report Definition > Natural Identification screen, you define how a report is identified which is created by Natural or its related products like Natural Advanced Facilities or Open Print Option.

Natural Identification Attributes

Output from Natural is produced during the processing of a specific Natural program, which is stored in a Natural library and executed by a Natural user. The output can have various attributes defined in the program's DEFINE PRINTER statement. To identify this output, you specify one or more identification attributes:

A first selection is made by the primary identification attributes (Natural Attributes), considerably reducing the number of definitions. You have to specify at least one of these. A definition is applied to the print file, if at least one primary attribute is matched. All secondary attributes for which you have entered values must be matched.

You can use asterisk notation (*) for all attributes, except Printer Profile. For example, to select all programs executed by users whose IDs begin with "MRS", you specify MRS* as the user ID. Or, if you enter the user ID value ABC and the printer profile value NOMPRT, all print files are identified which were created either by the user "ABC" or with the printer profile "NOMPRT".

Report Identification for UNIX/Windows Nodes

11:37:40 ****             ENTIRE OUTPUT MANAGEMENT ****            2018-05-05
 User ID XYZ            - Report Definition >UNIX Identification -
 Report
    Name ................... Report________________

 UNIX Attributes
    Node Name .................. node_name_______ Read-binary... _
    Path:
    e:/Nomdir/
    and Files ......... file*_pattern_____________________________________
                        __________________________________________________
                        __________________________________________________
                        __________________________________________________
                        __________________________________________________
                        __________________________________________________
                        __________________________________________________
                        __________________________________________________
                        __________________________________________________

 Command => ___________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
      Help        Exit  Flip  Do    Undo              Ext         Node  Menu

On the Report Definition > UNIX Identification screen, you define how a report is identified on UNIX or Windows nodes.

UNIX/Windows Identification Attributes

The identification is done using the node name and path, and a file-name pattern. Entire Output Management will process any file found in this path, if it matches one of the specified file names or file-name patterns. Directories are not processed (no recursion).

For every matching file, an active report will be created. For this purpose, the file contents will be copied to the Entire Output Management container file. Then the file will be deleted from the path.

For any file not matching one of the criteria, Entire Output Management checks if an appropriate default report exists. If none exists, the file cannot be processed and will be moved to a temporary directory defined for this node in the Node Definitions instead.

ASCII files can contain line feeds, form feeds and tabulators; any other kind of control character will be ignored and set to blank.

Binary files can be of any format. They are stored in the container file in Base64 format. At the time of printing, they are re-converted to binary format.

In addition to the identified files, associated meta-data files can be processed. If a pair of files such as file-name.extension and file-name.extension.nomxml is found, the nomxml file is treated as a meta-data file in XML format.

Node names, path names and file names are case-sensitive. Node names and paths have to be defined in the Node Definitions first.

Distribution Attributes

To define or modify the distribution attributes:

1. Press PF9 on the Report Definition > General Attributes screen.

   The Report Definition > Distribution Attributes screen is displayed:

   15:36:54 **** ENTIRE OUTPUT MANAGEMENT **** 2018-05-05 User ID XYZ - Report Definition >Distribution Attributes - Report Name .............. FVSE-DB__________________ Distribution via NOM User/List ......... DC-GROUP ________ ________ ________ ________ ________ ________ ________ ________ ________ Command => ___________________________________________________________________ Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help Exit Flip Do Undo Ext Layot Menu

2. On this screen, you define the recipients of a report and the facilities used for distribution.

3. You can use PF10 to specify different Report Layout Attributes for different addresses of the report.

Distribution Attributes - Fields

Selecting Users to Receive a Report

To select a user or group of users on a distribution list:

1. On the Report Definition > Distribution Attributes screen, enter an asterisk (*), or a selection criterion ending in an asterisk, in a User/List field.

   The Member Name window is displayed.

2. Press:

   • PF4 to display a list of all users; or

   • PF5 to display a list of all distribution lists.

   A selection window is displayed, listing all users / distribution lists defined for your Entire Output Management system.

3. Enter any character in the field preceding the desired user / distribution list.

   The user ID / distribution list name is written to the User/List field.

   When the report is produced, it is distributed to the #Inbasket folder of the user; in the case of a distribution list all users on the list receive the report in their #Inbasket folders. The user(s) can then browse and print the report.

Report Layout Attributes

You can restrict a user's view of the report by defining a user-specific report layout. In this layout, you specify the parts of the layout which are to be visible to the user.

You can define a different layout for each addressee of the report. If the addressee is a distribution list, all members of the list will see the specified layout.

To define a layout for a user or distribution list:

1. On the Report Definition > Distribution Attributes screen, place the cursor on a User/List field containing a user ID or list name and press PF10 (Layot).

   The Report Definition > Layout Attributes screen is displayed:

   15:40:42 **** ENTIRE OUTPUT MANAGEMENT **** 2018-05-05 User ID XYZ - Report Definition >Layout Attributes - Report Name .............. FVSE-DB__________________ User/List ......... DC-GROUP From To Layout ............ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ Headerlines ....... ___ Command => ___________________________________________________________________ Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help Exit Flip Do Undo - + Ext Menu

2. You can define up to 10 different layouts for each report to be distributed to different addressees. A report layout consists of up to 10 pairs of offsets. The positions are counted from the beginning of a report line (not including ASA/machine codes).

   Field	Explanation
   From / To	For each column to be displayed, you the specify the first and last position to be displayed.
   Header Lines	Here you specify the number of lines - counting from the top of the page - which are to remain in their original format.

   For more information on layout, see the section Modifying the Layout of an Active Report.

Printing Attributes

To define or modify printing attributes:

1. Press PF8 (Print) on the Report Definition > General Attributes screen.

   The Report Definition > Printing Attributes screen is displayed:

   12:05:13 **** ENTIRE OUTPUT MANAGEMENT **** 2018-06-06 User ID XYZ - Report Definition >Printing Attributes - Report Name .............. XYZ-XML__________________ Hold Logic ........... _ Printers (1-5). ________ ________ ________ ________ ________ Copies (1-5). ___ ___ ___ ___ ___ with Sep. Pages (1-5). X X X X X Separator Pages Start ............. ________ End ............... ________ Copies ............ ___ Length ............ ___ Jobcards ________________________________________________________________________ ________________________________________________________________________ ________________________________________________________________________ Command => ___________________________________________________________________ Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help Exit Flip Do Undo Ext Edit Prtr Menu

   On this screen, you define how reports are printed automatically.

Printing Attributes - Fields

Additional Printers

To select additional printers:

1. Press PF11 (Prtr) on the Report Definition > Printing Attributes screen.

   The Report Definition > Additional Printers screen is displayed.

2. You can specify up to 15 additional printers. The printing attributes Printers, Copies and with Sep. Pages are the same as described above.

Separation Attributes

To define or modify separation attributes:

• Press PF10 (Separ) on the Report Definition > General Attributes screen.

  The Report Definition > Separation Attributes screen is displayed:

  15:41:21 **** ENTIRE OUTPUT MANAGEMENT **** 2018-06-06 User ID XYZ - Report Definition >Separation Attributes - Report Name .............. FVSE-DB__________________ Create Definition .... _ Standard Routine ..... __ User Routine NATURAL Member ..... ________ NATURAL Library .... ________ 3GL ................ ________ Command => ___________________________________________________________________ Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12--- Help Exit Flip Do Undo Param Edit Trace Menu

  On this screen, you define whether a user routine or a standard routine is to be used.

Special PF Keys

Separation Attributes - Fields

If no user routine or standard routine is specified, the whole identified spool file is contained in the report.

Defining User Routine Parameters

To define or modify parameters for a user routine:

1. Press PF9 (Param) on the Report Definition > Separation Attributes screen.

   The Report Definition > User Separation window is displayed.

2. In this window, you can specify up to 5 parameters which are passed to the user routine at the start of report processing.

Using a Standard Separation Routine

A Standard Separation Routine is a method supplied by Software AG for separating or filtering spool files. When you use such a routine, you have to supply parameters which tailor further processing.

Three standard separations are available:

• Standard Separation 1

• Standard Separation 2

• Standard Separation 3

Standard Separation 1

Standard Separation 1 separates spool data into several reports depending on the break of the specified suffix. The suffix need not appear in sorted order. This separation searches for a defined string in a defined line or anywhere on a page. If the string appears on a page, a suffix is evaluated (at break of the suffix value, a new report is opened). If the string is not found, the page is added to the currently open report. If no report is open, the page is rejected.

To define or modify the use of Standard Separation 1:

1. Enter "1" in the Standard Routine field on the Report Definition > Separation Attributes screen and press PF9 (Param).

   The Report Definition > Standard Separation 1 screen is displayed.

2. On this screen, you define the attributes described below.

Attributes of Standard Separation 1

*STRING1*STRING2*

*STRING1%STRING2*

Example of Standard Separation 1 - Salary Report:

We have a salary report sorted by department number and want to separate it into the various departments. A standard routine could be defined as follows to perform an automatic separation:

   15:43:45             **** ENTIRE OUTPUT MANAGEMENT ****            2018-06-06
  User ID XYZ       - Report Definition >Standard Separation 1 -
  Report
     Name .............. PWR-EMPL-STD1-S__________
  Search
     Line .............. 2__
     String ............ *Employee List sorted by Departments*______________
  Suffix
     Line .............. 3__
     Start Column ...... 55_
     End Column ........ 58_

  Prefix: Reports ...... DEPTS1-__________________
          Bundles(1-2).. DEP-_____________________ _________________________
                 (3-4).. _________________________ _________________________
                 (5).... _________________________

  Command => ___________________________________________________________________
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
       Help        Exit  Flip  Do    Undo              Ext               Menu

This standard routine separates the spool file on a page basis and creates reports whose names begin with DEPTS1-. The report name is created by adding the prefix DEPTS1- to the suffix found in the spool file in the positions defined in the example above, for example: DEPTS1-FINA.

Optionally, the report can be directed to a bundle with the prefix DEP-. The bundle name is created by adding the prefix DEP- to the suffix found in the spool file, for example: DEP-FINA.

Standard Separation 2

Standard Separation 2 separates spool data into several reports depending on up to 5 break conditions. It searches for a defined string in a defined line or anywhere on a page. If the string appears on a page, up to 5 suffixes are evaluated (at break of a suffix value, a new report is opened for that suffix). If no string is found, the page is added to the currently opened reports. If no report is opened, the page is rejected.

To define or modify the use of Standard Separation 2:

1. Enter "2" in the Standard Routine field on the Report Definition > Separation Attributes screen and press PF9 (Param).

   The Report Definition > Standard Separation 2 screen is displayed.

2. On this screen, you define the attributes described below.

Attributes of Standard Separation 2

*STRING1*STRING2*

*STRING1%STRING2*

Example of Standard Separation 2 - Salary Report:

We have a salary report sorted by department number and want to separate it into the various main departments and sub-departments. A standard routine could be defined as follows to perform an automatic separation:

  19:00:10             **** ENTIRE OUTPUT MANAGEMENT ****            2018-06-06
 User ID XYZ       - Report Definition >Standard Separation 2 -
 Report
    Name .............. PWR-EMPL-STD2-S__________
 Search
    Line .............. 2__
    String ............ *Employee List sorted by*_________________________

 SuffixLi/CF/CT  Report Prefix              Bundle Prefix 1
 ______________  _________________________  _________________________
  3__  55_  58_  STD21-___________________  DEP-_____________________
  3__  55_  60_  STD22-___________________  DEP-_____________________
  ___  ___  ___  _________________________  _________________________
  ___  ___  ___  _________________________  _________________________
  ___  ___  ___  _________________________  _________________________

  Command => ___________________________________________________________________
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
       Help        Exit  Flip  Do    Undo              Ext    <     >    Menu

This standard routine separates the spool file on a page basis and creates reports whose names begin with STD21- for the main departments and STD22- for the sub-departments. The report name is created by adding the prefix STD21- to the department name (Columns 55-58 in Line 3) or by adding the prefix STD22- to the sub-department name (Columns 55-60 in Line 3) found in the spool data.

Optionally, the report can be directed to a bundle with the prefix DEP-. The bundle name is created by adding the DEP- prefix to the department or sub-department name.

Standard Separation 3

Standard Separation 3 searches for a defined string in a defined line. If the string appears on a page, the lines of the page are analyzed regarding the defined logical expression. If not, the whole page is rejected.

From the Start Line until end of page, the lines are added to the report, if they match the defined logical expression. Lines before the Start Line are also rejected unless they are defined as Header Lines.

To define or modify the use of Standard Separation 3:

1. Enter "3" in the Standard Routine field on the Report Definition > Separation Attributes screen and press PF9 (Param).

   The Report Definition > Standard Separation 3 screen is displayed.

2. On this screen, you define the attributes described below.

Attributes of Standard Separation 3

*STRING1*STRING2*

*STRING1%STRING2*

Example 1 of Standard Separation 3 - Salary Report:

We have a salary report sorted by department number and want to extract all employees with sex = M, personnel ID number >= 6000000 and birthday <= 50/01/01 (sub-department COMP12):

   15:45:40             **** ENTIRE OUTPUT MANAGEMENT ****            2018-06-06
  User ID XYZ       - Report Definition >Standard Separation 3 -
  Report
     Name .............. PWR-EMPL-STD3-D3_________
  Search
     Line .............. 3__
     String ............ *COMP12*__________________________________________
  Header Lines ......... 8_
  Start Line ........... 9__
     and/or Col From/to F    Value
     ______ ___________ _ __ __________________________________________________
              55_ 62_   N GE 6000000___________________________________________
       AND    65_ 65_   A EQ M_________________________________________________
       AND    67_ 74_   A LE 50/01/01__________________________________________
       ___    ___ ___   _ __ __________________________________________________
       ___    ___ ___   _ __ __________________________________________________

  Command => ___________________________________________________________________
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
       Help        Exit  Flip  Do    Undo              Ext               Menu

The lines 1 to 8 are taken as header lines. The filter starts in Line 9.

Example 2 of Standard Separation 3 - Natural CATALL Report:

We have a CATALL list and want to extract all lines with error number unequal to 0:

   15:45:40             **** ENTIRE OUTPUT MANAGEMENT ****            2018-06-06
  User ID XYZ       - Report Definition >Standard Separation 3 -
  Report
     Name .............. NOM-CATALL-ERRORS________
  Search
     Line .............. 3__
     String ............ *- Error Report -*________________________________
  Header Lines ......... __
  Start Line ........... 6__
     and/or Col From/to F    Value
     ______ ___________ _ __ __________________________________________________
              16_ 19_   N NE 0_________________________________________________
       OR_    65_ 65_   N NE 0_________________________________________________
       ___    ___ ___   _ __ __________________________________________________
       ___    ___ ___   _ __ __________________________________________________
       ___    ___ ___   _ __ __________________________________________________
  Command => ___________________________________________________________________
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
       Help        Exit  Flip  Do    Undo              Ext               Menu

No header lines are added. The filter starts in Line 6 on pages with the string - Error Report - in Line 3.