Reporting

This section describes the Reporting function which is used to generate reports to overview your Entire Operations environment.

This section covers the following topics:

Related Topic:

  • See also the cross reference reports described in the section Cross References.

Report Types

The report types available you can select from the Reporting dialog are described in the following table. Reports that require special user privileges are indicated in the table.

Report Type Description
Log - reports

(see below)

 The LOG - reports provide job or network processing information for a given date/time range, extracted from the Entire Operations log. The following applies to all job logs:

Only those networks are displayed for which the user has read access. The user has read access if:

Log - Terminated Jobs Lists all jobs that ended normally (OK).

See also Example of Log - Terminated Jobs.

Log - Abended Jobs Lists all jobs that ended abnormally (not OK).

See also Example of Log - Abended Jobs.

Log - Jobs not started Lists all jobs that were not started.

A job cannot start, for example, if its latest start time exceeded, or if it is waiting for an input condition or a resource.

See also Example of Log - Jobs not started.

Log - Jobs with permanent errors Lists all jobs that fail to run because of permanent errors.

See also Example of Log - Jobs with permanent errors.

Log - Networks not activated Lists all networks that could not be activated, because an extraction or activation error occurred.

See also Example of Log - Networks not activated.

Accounting Data Information on accounting data (for example, job elapsed times and CPU times) of previous network and job executions.

See also Example of Accounting Data.

Network Description (short) Displays information on networks and jobs as defined on the master database, including scheduling information, prerequisites and end-of-job checking and actions.

See also Example of Network Description (short).

Network Description (detailed) Displays the same information as the Network Description (short), but includes all prose descriptions defined at the network, job or event level using the Editor facility.

See also Example of Network Description (detailed).

Schedule of Jobs Displays a jobs schedule for a specific date range.

See also Example of Schedule of Jobs.

Network Start Summary Status report of all network starts for a given day, regardless of whether they:

  • are waiting for prerequisite resources;

  • have already been executed;

  • are currently being executed;

  • have already been completed.

See also Example of Network Start Summary.

Network Schedule Overview Overview of scheduled and/or not yet executed, system-wide network activations.

See also Example of Network Start Summary.

Activation Overview Overview of network activations.

See also Example of Activation Overview.

Compare Symbol Tables (Special user authorization required.)

Displays the results of the comparison of one or more symbol tables.

See also Example of Compare Symbol Tables.

Compare Networks (Special user authorization required.)

Displays the results of the comparison of one or more networks.

The report shows whether jobs defined in one network exist also in another network. Additionally the attributes of the networks and of all jobs having the same name are compared.

See also Example of Compare Networks.

Node Overview (Special user authorization required.)

Overview of available nodes.

See also Example of Node Overview.

Network/Job Usage (Special user authorization required.)

Lists networks and related subnetworks (jobs of the type NET) as well as jobs activated by an end-of-job action or a recovery job.

See also Example of Network/Job Usage.

Network Start Overview (Bar Chart) Displays the network start time and the end time of a previous network execution as a bar chart.

See also Network Start Overview (Bar Chart).

Network and Job Start Overview (Bar Chart) Displays the network and job start as a bar chart.

See also Example of Network and Job Start Overview (Bar Chart).

Network Schedule Overview (Bar Chart) Displays the schedule selection of a network as a bar chart.

See also Example of Network Schedule Overview (Bar Chart).

Viewing the Report Status List

Start of instruction setTo view all reports submitted for processing

  1. In the object workspace, select the General node and choose Reporting from the context menu.

    Or:
    In the Command box, type REPORTS (see Direct Commands) and press ENTER.

    A Reporting window similar to the example below opens:

    graphics/reporting_general.png

    A list of scheduled and ready reports appears.

    (If no reports exist, the table in the Reporting window is empty.)

    The reports listed in the table are used to manage and view all reports requested by the current user. Report generation is invoked within Entire Operations GUI Client whereas the reports themselves are generated asynchronously in the background via the Entire Operations monitor.

    The report list contains the following columns:

    Creation time Date and time when a report generation was initiated arranged in descending order (latest date first)
    Report type Report type requested
    Status
    Indicates the progress in generating the report:
       
    Queued Report is queued for processing.

    A report is queued, for example, if it must wait until the Entire Operations Monitor has finished another task before it can handle the report generation (asynchronous processing).

    This allows you to continue working while the report is processed in the background.

       
    Running Report is being generated.
       
    Completed Report has been generated successfully.
       
    Aborted Report has been aborted.

    A probable reason for abortion is:

    • No report data found for processing

    • An inactive Entire Operations Monitor

    • A system error

    Press F5 or choose Refresh or Auto Refresh (specifies an automatic refresh interval) from the context menu to refresh the processing status in the Status column.

  2. From the table in the Reporting window, you can select the report you want to generate by choosing Save as File from the context menu to determine the file to be created from the report: see Report Output Options.

Generating Online Reports

This section provides instructions for generating a report in online mode with the Reporting function.

Report data is evaluated for the current day by default. If you want to change the evaluation date, use the Determination Date function.

Note:
The selection options provided to generate a report allow extremely flexible reporting. On the other hand, it allows you to formulate requests that will cause very many Adabas calls. For this reason, it is possible to disallow asterisk/wildcard report selection for non-administrator users: see Range Specification and Usage Restrictions.

Start of instruction setTo generate a report

  1. From the table in the Reporting window, select Add from the context menu.

    A Reporting dialog opens where you choose a report from the drop-down list of the Report type box:

    graphics/reporting_types.png

  2. Select the required report type and choose OK.

    If you choose Cancel instead, the selected report type is retained in the Reporting dialog until you open it again and choose OK.

    Depending on the report type selected, the Reporting dialog provides appropriate input fields which are explained in Fields and Columns: Reports.

    The report of the specified type is added to the table in the Reporting window and queued for processing.

  3. Enter the required selection criteria and an e-mail address if you want to send a notification when the report generation has finished, and choose OK.

Viewing Report Properties and Deleting a Report

Start of instruction setTo display the properties of a report

  1. Select the required report from the table in the Reporting window and choose Properties from the context menu.

    A Reporting dialog similar to the example below appears where the properties (report type, owner, network and e-mail) are displayed:

    graphics/reporting_properties.png

Start of instruction setTo delete a report

  1. Select the required report type from the table in the Reporting window and choose Delete from the context menu or press DELETE.

    The report is removed from the table.

Fields and Columns: Reporting

The input fields for specifying selection criteria and output options for the report to be produced are explained in the following table. The input fields correspond to the columns contained in the report output file.

Depending on the report type (to be) produced, the following fields and columns are available:

Field/Column Description
Owner Name of an owner or a range of names.
Network Name of a network or a range of names.
Network version Name of a network version or a range of names.
Job (Applies to Log - reports and Job Schedule only)

Name of a job or a range of names.

If no job name is defined, the corresponding output column in the report file contains a dash (-).

Date/Time from/thru Start date/time and end date/time of the reporting period.

Valid number range: 1 through 31.

Default: current date and time range 00:00 - 23:59.

Note:
For Network Schedule Overview reports, the start and end dates can be in the past. In this case, only those network activations are logged, which have not yet been executed. These can be caused by symbol prompting, which has not been completed, or by an Entire Operations Monitor, that has not been active over an extended period of time.

Run from/thru Start and end run numbers for a range of active job networks.

Can be used only if owner and network have been selected.

Default range: 1 - 9999 (all)

Completed message to Email E-mail address of the user who receives an e-mail notification when the report generation completed successfully (Subject: EOR: OGC Report ended ok) or when the report generation was aborted (Subject: EOR: OGC Report ended not ok).
Save As File See Report Output Options.
Type
(Applies to Activation Overview only)

Type of network activation.
 
Valid selection options:
 
All types All types of activations.
   
Manual Activated manually.
   
Recovery Activated by End-of-Job recovery processing.
   
API Activated by the activation API. NOPUAC5N (see the section API Routines).
   
EOJ Activated by an End-of-Job action.
   
Scheduled Activated by a schedule.
Compare Networks/Symbol Tables reports only:
Show
Determines the amount of information to be shown for the compared networks.
 
Valid selection options:
   
ALL Shows all matching and differing objects and attributes.
   
Differences Shows only the differing objects with the differing attributes (default).
Accounting Data/Schedule of Jobs reports only:
Step (Applies to z/OS only)

Job step

.
JobID Job identifier as assigned by the operating system.
Start Start date/time of the job.
Stop End date/time of job.
Elapsed min

or

Elapsed Time

 Estimated run time (in minutes) of the job.
CPU Time sec Estimated CPU time (in seconds) of the job.
date to date are

Line below the report table indicating the average CPU consumption.

Average values of all elapsed and CPU times for all jobs in the network.

Network/Job Usage reports only:
Used Job Networks and jobs used by single or multiple jobs.
Using Job Networks and jobs using a job as a subnetwork (job type NET), an end-of-job (EOJ) action or a recovery job.
Usage Indicates the job use: Subnet, EOJ Activation or Recovery.
Activation Mode Activation mode defined for the subnetwork

See also Time of Activation of a Subnetwork in the System Overview.

Node Overview reports only:
Server Name For mainframe nodes: a descriptive name

For UNIX and Windows nodes: the name of the EntireX Broker service

Node Range A range of node numbers from 1 to 99900.
Short Short name of a node
AM
Access mode used:
 
N Mainframe nodes accessed through Entire Net-Work
B UNIX and Windows nodes accessed through EntireX Broker.
L Applies to UNIX and Windows only

Local node, invoked directly on the machine where Entire Operations is running.

Op. Sys. Operating system under which the node is running as received from the last SYSTEM-INFO call to Entire System Server or UNIX/Windows system information.
Wait a. Error Wait time after error. Time in minutes to wait until next node access after a temporary error.
VSE SysId The SYSID defined for a z/VSE node is added to the job card of jobs submitted on this node.
SSU Submit Security User Type. If empty, the system-wide default is in effect for this node.
Time Diff. Time difference between local time and GMT in hours if node is in a different time zone.
Valid
Indicates whether a node is available:
   
yes Node can be used
no Node has been disabled
NPR Version Current Entire System Server version of the node
OS Release Information about the operating system (where available)
Bar Chart reports only:
Run Run number of the job
Activation Time Date/time when the job is activated
Start time Date/time when the job started
Stop Time Date/time when the job stopped
Elapsed Time Elapsed time (between job start time and job stop)
Minimum/Maximum Elapsed Time Minimum or maximum elapsed time per job run
CPU Time CPU time in milliseconds (ms)
Stop Job Last executed job
Stop Message Message of the last executed job
Run OK? Is true if the networks finished without errors

Range Specification and Usage Restrictions

If indicated in the table above, you can use an asterisk (*) or a smaller/greater than (< or >) wildcard character to determine a start or an end value (see also Valid Name Specifications in Direct Commands) or open a selection list of names.

The use of asterisk/wildcard report selection can be disallowed for non-administrator users (see User Definitions and Profile Settings in the Administration documentation).

By default, users of type A (System-Administrator) and O (Operator) are allowed to use asterisk/wildcard selection; users of type G (regular user) are not. It is not possible to disallow it for users of type A.

Determination Date for Report Data

Report data is evaluated for the current day by default. This evaluation date needs to be considered, in particular, when you maintain different versions of networks and symbol tables with either fix versions or versions dynamically loaded on this date.

You can specify the date for which a report evaluates the data to be generated.

Start of instruction setTo set the determination date

  1. Select the General node.

  2. Open the context menu and select Determination Date.

    A Determination Date window similar to the example below opens:

    graphics/determ_date.png

  3. Open the drop-down list box and select the required date from a calendar.

    Or:
    Type the required date in the input box.

  4. Choose OK to save the date.

Report Output Options

The Save as File dialog specifies the format for the report and the location where the report is written.

Field Explanation
File type The format used for report generation:

  • HTML: a file in HTML (Hypertext Markup Language) format.

  • HTML5: a file in HTML5 format is required to display bar charts reports.

  • This only works if the Windows Open with function calls an HTML5-enabled browser by default.

  • CSV: a comma-separated value file for Excel.

  • XML: a file in XML (Extensible Markup Language) format without style sheet for HTML.

  • XML with style sheet for HTML: a file in XML format with a style sheet for HTML.

    If this option is selected, a processing instruction with a reference to an external style sheet is added to the generated XML file to transform the XML file into HTML.

File name The name to be used for the report file.

If no path is specified in the File name field, the file will be saved at: 

%LOCALAPPDATA%\Software AG\Natural\
Open with external application If this option is checked (default setting), the default Windows application associated with the specific file extension opens.

The settings in the Save as File dialog are stored between sessions in a client-specific XML profile and are used as the default value for the next Save as File operation on a report of the same report type.

Using Reports with Bar Charts

The report types Network Start Overview (Bar Chart), Network and Job Start Overview (Bar Chart) and Network Schedule Overview (Bar Chart) generate the usual report columns but additionally provide an interactive diagram with a bar chart for better data visualization.

Bar charts of the report types visualize report column data as an interactive diagram. Bar charts are useful for overviewing the job flow and finding out the peak and off-peak times to balance the workload (CPU load) among the different networks.

graphics/reports_ex_net_start_chart.png

Bar charts reports are not static but have interactive elements which are described in the following section:

Filter Setup

Filter Area:

graphics/bar_chart13.png

By clicking on the arrow you can collapse the filter area.

graphics/bar_chart14.png

Changing the selection changes the displayed columns of the report:

graphics/bar_chart15.png

Diagram Part:

Zoom into the diagram by selecting the time table of the diagram:

graphics/bar_chart16.png

You can zoom into the diagram to see the diagram in more detail.

graphics/bar_chart17.png

Symbol Explanation
+ / - You can zoom in clicking on + and zoom out clicking on -.

graphics/bar_chart18.png

 The arrows scroll the view to left or right.

graphics/bar_chart19.png

 You see the complete diagram again.

graphics/bar_chart20.png

 This will show you further information/explanations.

If you move the mouse over the marker, you will see further information such as start and/or end times:

graphics/bar_chart21.png

Moving the mouse over the bar you see additional information about the specific network:

graphics/bar_chart22.png

User Restrictions for Reports

Administrator users (and reports run in batch) may report on any network in any owner. Non-administrator users, however, will only receive information on networks to which they have read access. A user is considered to have read access if:

  1. The user is linked to owner SYSDBA.

  2. The user is linked to the Network owner.

  3. Access to the network has been explicitly granted to the user.

Examples of Reports

This section contains examples of all types of reports you can generate with the Reporting function:

Example of Log - Terminated Jobs

The following is an example of the report type Log - Terminated Jobs:

graphics/reports_ex_jobs_terminated.png

The columns contained in the report are described in Fields and Columns: Reports.

Example of Log - Abended Jobs

The following is an example of the report type Log - Abended Jobs:

graphics/reports_ex_jobs_abended.png

The columns contained in the report are described in Fields and Columns: Reports.

Example of Log - Jobs not started

The following is an example of the report type Log - Jobs not started:

graphics/reports_ex_jobs_not_started.png

The columns contained in the report are described in Fields and Columns: Reports.

Example of Log - Jobs with permanent errors

The following is an example of the report type Log - Jobs with permanent errors:

graphics/reports_ex_jobs_perm_error.png

The columns contained in the report are described in Fields and Columns: Reports.

Example of Log – Networks not activated

The following is an example of a Log – Networks not activated report:

graphics/reports_ex_net_not_activated.png

The columns contained in the report are described in Fields and Columns: Reports.

Example of Accounting Data

The following is an example of the report type Accounting Data:

graphics/reports_ex_accounting.png

The columns contained in the report are described under Accounting Data/Schedule of Jobs reports only in Fields and Columns: Reports.

Example of Network Description (short)

The following is an example of the report type Network Description (short):

graphics/reports_ex_net_short.png

The columns contained in the report are described in Fields and Columns: Reports.

Example of Network Description (detailed)

graphics/reports_ex_net_detailed.png

Example of Schedule of Jobs

The following is an example of the report type Schedule of Jobs:

graphics/reports_ex_job_schedule.png

The columns contained in the report are described under Accounting Data/Schedule of Jobs reports only in Fields and Columns: Reports.

Example of Network Start Summary

The following is an example of the report type Network Start Summary:

graphics/reports_ex_net_start.png

The columns contained in the report are described in Fields and Columns: Reports.

Example of Network Schedule Overview

The following is an example of the report type Network Schedule Overview:

graphics/reports_ex_net_schedule.png

The columns contained in the report are described in Fields and Columns: Reports.

Example of Activation Overview

The following is an example of the report type Activation Overview:

graphics/reports_ex_activation_overview.png

The columns contained in the report are described in Fields and Columns: Reports.

Example of Compare Symbol Tables

The following is an example of the report type Compare Symbol Tables:

graphics/reports_ex_compare_symbols.png

Columns: Compare Symbol Tables

The columns contained in the report are described under Compare Networks/Symbol Tables reports only in Fields and Columns: Reports.

Example of Compare Networks

The following is an example of the report type Compare Networks:

graphics/reports_ex_compare_network.png

Columns: Compare Networks

The columns contained in the report are described under Compare Networks/Symbol Tables reports only in Fields and Columns: Reports.

Example of Node Overview

The following is an example of the report type Node Overview:

graphics/reports_ex_node_overview.png

The columns contained in the report are described under Node Overview reports only in Fields and Columns: Reports.

Example of Network/Job Usage

The following is an example of the report type Network/Job Usage:

graphics/reports_ex_net_job_usage.png

The columns contained in the report are described under Network/Job Usage reports only in Fields and Columns: Reports.

Example of Network Start Overview (Bar Chart)

The following is an example of the report type Example of Network Start Overview (Bar Chart):

graphics/reports_ex_net_start_chart.png

The columns contained in the report are described under Bar Chart reports only in Fields and Columns: Reports.

See also the section Using Reports with Bar Charts for information on how to handle bar charts.

Example of Network and Job Start Overview (Bar Chart)

The following is an example of the report type Network and Job Start Overview (Bar Chart):

graphics/reports_ex_net_job_chart.png

The columns contained in the report are described under Bar Chart reports only in Fields and Columns: Reports.

See also the section Using Reports with Bar Charts for information on how to handle bar charts.

Example of Network Schedule Overview (Bar Chart)

The following is an example of the report type Network Schedule Overview (Bar Chart):

graphics/reports_ex_net_schedule_chart.png

The columns contained in the report are described under Bar Chart reports only in Fields and Columns: Reports.

See also the section Using Reports with Bar Charts for information on how to handle bar charts.

Generating Batch Reports

You can use the batch command client of Entire Systems Management to generate a report in batch mode: see Commands for the Batch Command Client in the section Using Entire Operations in Batch Mode.