A report must be started so that it can accumulate data. This document describes how to start and stop reports as well as how to manage running reports. It covers the following topics:
A report must be started and active so that it can accumulate data. After you have completed your report, you may start it immediately, or save it to be started at another time. For information about saving reports, read Saving Reports.
To start a new report:
Press PF6 or enter the START command on the command line.
The START command first executes the SAVE command to save the report definition and generate the display program. A message is then displayed, indicating that the online report has been started.
It is possible to specify a DBID after the START command using the following syntax options.
START report.name,[dbid | DBID=dbid ]
or
START report.name [dbid | DBID=dbid ]
For report.name,
specify the name of the report you want to start. Report names must contain
periods between the words of the names to allow Natural to pass the parameters
to START as a continuous string. Errors will result if the report name does not
contain periods between the words of the name.
For dbid, specify
the database ID or the value ALL for which you want the report started. The
report will then collect data from the specified DBID or ALL. The comma between
the report name and the DBID (as shown in the first of the above syntax
options) is not required.
Some examples of valid START commands:
START MY.REPORT START MY.REPORT,123 START MY.REPORT 123 START MY.REPORT,DBID=123 START MY.REPORT,ALL START MY.REPORT DBID=ALL
To start an existing (saved) report:
Enter the ST command on the selection line preceding the report name from the Report Definitions screen (LR function).
Adabas Review responds with a message indicating that the online report has been started.
Started reports may be suspended, reactivated, closed, or refreshed. These commands are issued from the Started Reports screen (LS function).
In order to have reports active only in predefined times and not permanently, a report may be scheduled instead of started. You need to define scheduling options and set the options to active. After you have completed your report, you may schedule it immediately, or save it to be scheduled at another time. For information about saving reports, read Saving Reports.
To schedule a new report:
Press PF9 or enter the SCHEDULE command on the command line.
The SCHEDULE command first executes the SAVE command to save the report definition and generate the display program. A message is then displayed, indicating that the online report has been scheduled.
It is possible to specify a DBID after the SCHEDULE command using the following syntax options.
SCHEDULE report.name,[dbid | DBID=dbid ]
or
SCHEDULE report.name [dbid | DBID=dbid ]
For report.name,
specify the name of the report you want to schedule. Report names must contain
periods between the words of the names to allow Natural to pass the parameters
to SCHEDULE as a continuous string. Errors will result if the report name does
not contain periods between the words of the name.
For dbid, specify
the database ID or the value ALL for which you want the report scheduled. The
report will then collect data from the specified DBID or ALL. The comma between
the report name and the DBID (as shown in the first of the above syntax
options) is not required.
Some examples of valid SCHEDULE commands:
SCHEDULE MY.REPORT SCHEDULE MY.REPORT,123 SCHEDULE MY.REPORT 123 SCHEDULE MY.REPORT,DBID=123 SCHEDULEMY.REPORT,ALL SCHEDULE MY.REPORT DBID=ALL
To schedule an existing (saved) report:
Enter the SC command on the selection line preceding the report name from the Report Definitions screen (LR function).
Adabas Review responds with a message indicating that the online report has been scheduled.
Like started reports, scheduled reports may be suspended, reactivated, closed, or refreshed. These commands are issued from the Scheduled Reports screen (LC function).
To start an edited report:
When you have finished editing the report, start the report by pressing PF6 or entering START on the command line from either the Edit Report screen or the Report Processing Rules screen.
If you make changes to a report that has already been started or scheduled, you will be prompted to "refresh" the report when you attempt to issue the START command or press PF6. This is because the name of a report that is accumulating data is the same as the report you are attempting to start. Reports with duplicate names are not permitted by Adabas Review. Refreshing the report will purge any accumulated data and will restart the report.
To "refresh" the report, answer "Y" to the prompt.
To schedule an edited report:
When you have finished editing the report, start the report by pressing PF9 or entering SCHEDULE on the command line from either the Edit Report screen or the Report Processing Rules screen.
If you make changes to a report that has already been started or scheduled, you will be prompted to "refresh" the report when you attempt to issue the SCHEDULE command or press PF9. This is because the name of a report that is accumulating data is the same as the report you are attempting to schedule. Reports with duplicate names are not permitted by Adabas Review. Refreshing the report will purge any accumulated data and will reschedule the report.
To "refresh" the report, answer "Y" to the prompt.
Listing started and scheduled reports can be done using the List Started Reports (LS) and the List Scheduled Reports (LC) commands.
This section covers the following topics:
The List Started Reports (LS) function lists reports that have been started and which are active. It provides commands to close, suspend, reactivate, and refresh started reports and view, download to a PC, print, and purge the report output. In addition, you may edit the report definition or its corresponding display program.
To access the List Started Reports function:
Enter LS on the command line.
Or:
You can specify the report name or partial report name in
the LS command. For example:
Specifying LS IO SUMMARY BY RABN* will display the list of all started reports, starting with the IO SUMMARY BY RABN report.
Specifying LS IO* will display the list of all started reports, starting with the first report with the name beginning with the word "IO". In this case, if both the IO COUNT BY HOUR and IO SUMMARY BY RABN reports are started, the list would start at the IO COUNT BY HOUR report.
Note:
You must specify an asterisk at the end of the full or
partial report name in the LS
command.
The Started Reports screen is displayed. In this example, no specific report name or partial report name was requested.
11:10:28 A D A B A S - R E V I E W 2020-02-10
REVIEW-DB (10,252) Started Reports (1/3) Hub Target: 296
Sum Strt Display
Sel Report Name Stat DBID Det Typ Hst Log Time Program
+-----------------------------------------------------------------------------+
| __ APPLICATION FILE FIELD USAGE A ALL S D N 12:53 SR-00030 |
| __ COMMANDS BY HOUR A ALL S D N 14:15 SR-00004 |
| __ EXCEPTIONAL RESPONSE CODES A ALL S D N SR-00002 |
| __ LAST 500 ADABAS CALLS A ALL S D N 14:14 SR-00038 |
| __ SAMPLE REPORT AS ALL S D N 14:15 RD-00001 |
| __ SUMMARY REPORT BY FILE A ALL S D N 09:30 SR-00001 |
| |
| |
| |
| |
| |
| |
+-----------------------------------------------------------------------------+
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit - + LC ===> Menu |
PF7 (-), PF8 (+) , PF10 (<===) and PF11 (===>) have been provided as scroll keys. If more than one screen of report names exists, PF8 or (+) scrolls the list forward and PF7 or (-) scrolls the list backward. In addition, the PF10 (<===) and PF11 (===>) keys scroll the list left or right to provide additional information about each started report. PF9 (LC) switches to the Scheduled Reports (LC) display.
Note:
If you are using an external application, such as a session
manager like Software AG's NETPASS, that assigns PF10 and
PF11 to functions of the external application, you may have problems
viewing report results (VW
command). If this is the case, you can use PF22 instead
to scroll the report results to the left and PF23 instead to scroll
the report results to the right.
The following shows a list scrolled to the right:
11:12:12 A D A B A S - R E V I E W 2020-02-10
REVIEW-DB (10,252) Started Reports (2/3) Hub Target: 296
Next Num Dura Interv
Sel Report Name Stat Wait-Time Waits (min/hour/day)
+------------------------------------------------------------------------------
| __ APPLICATION FILE FIELD USAGE A |
| __ COMMANDS BY HOUR A |
| __ EXCEPTIONAL RESPONSE CODES A |
| __ LAST 500 ADABAS CALLS A |
| __ SAMPLE REPORT AS 2017-09-29 14:23 5 5m 1h |
| __ SUMMARY REPORT BY FILE A |
| |
| |
| |
| |
| |
| |
+-----------------------------------------------------------------------------+
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit - + LC <=== ===> Menu |
11:12:41 A D A B A S - R E V I E W 2020-02-10
REVIEW-DB (10,252) Started Reports (3/3) Hub Target: 296
Started Storage(K) _____________ Recs in
Report Name By Max Used Avail Report
+-----------------------------------------------------------------------------+
| APPLICATION FILE FIELD USAGE DBA 8 3 5 2017 |
| COMMANDS BY HOUR AUTOSTRT 8 3 5 6 |
| EXCEPTIONAL RESPONSE CODES AUTOSTRT 8 1 7 |
| LAST 500 ADABAS CALLS DBA 48 27 21 286 |
| SAMPLE REPORT DBA 8 3 5 51 |
| SUMMARY REPORT BY FILE AUTOSTRT 8 3 5 3058 |
| |
| |
| |
| |
| |
| |
+-----------------------------------------------------------------------------+
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit - + LC <=== Menu |
The List Scheduled Reports (LC) function lists reports that have been scheduled and reside in the wait queue. It provides commands to close, suspend, reactivate, and refresh started reports and view, download to a PC, print, and purge the report output. In addition, you may edit the report definition or its corresponding display program.
To access the List Scheduled Reports function:
Enter LC on the command line.
Or:
You can specify the report name or partial report name in
the LC command. See
Listing Started Reports for
details.
The Scheduled Reports screen is displayed. In this example, no specific report name or partial report name was requested.
11:13:26 A D A B A S - R E V I E W 2020-02-10
REVIEW-DB (10,252) Scheduled Reports (1/3) Hub Target: 296
Next Num Dura Interv
Sel Report Name Stat Activation-Time Activ (min/hour/day)
+-----------------------------------------------------------------------------+
| __ SAMPLE REPORT AS 2018-04-24 11:57 5m 1h |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+-----------------------------------------------------------------------------+
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit - + LS ===> Menu |
PF7 (-), PF8 (+) , PF10 (<===) and PF11 (===>) have been provided as scroll keys. If more than one screen of report names exists, PF8 or (+) scrolls the list forward and PF7 or (-) scrolls the list backward. In addition, the PF10 (<===) and PF11 (===>) keys scroll the list left or right to provide additional information about each started report. PF9 (LS) switches to the Started Reports (LS) display.
Note:
If you are using an external application, such as a session
manager like Software AG's NETPASS, that assigns PF10 and
PF11 to functions of the external application, you may have problems
viewing report results (VW
command). If this is the case, you can use PF22 instead
to scroll the report results to the left and PF23 instead to scroll
the report results to the right.
The following shows a list scrolled to the right:
11:14:06 A D A B A S - R E V I E W 2020-02-10
REVIEW-DB (10,252) Scheduled Reports (2/3) Hub Target: 296
Sum Strt Display
Sel Report Name Stat DBID Det Typ Hst Log Time Program
+-----------------------------------------------------------------------------+
| __ SAMPLE REPORT AS ALL S D N 14:15 RD-00001 |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+-----------------------------------------------------------------------------+
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit - + LS <=== ===> Menu |
11:14:34 A D A B A S - R E V I E W 2020-02-10
REVIEW-DB (10,252) Scheduled Reports (3/3) Hub Target: 296
Started Storage(K) _____________ Recs in
Report Name By Max Used Avail Report
+-----------------------------------------------------------------------------+
| SAMPLE REPORT DBA 8 3 5 115 |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+-----------------------------------------------------------------------------+
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit - + LS <=== Menu |
An explanation of the fields on the Started Reports screen is provided in the table below:
| Heading | Explanation |
|---|---|
| Avail Stor (K) | The available amount of storage remaining for the report, in kilobytes (K). |
| DBID | Database for which the report collects data. |
| Display Program | Lists the name of the program generated to display report output online. |
| Dura (min/hour/day) |
Duration For scheduled reports, the time in minutes, hours or
days, the report will be in the started reports queue after it has been
(re-)activated. For example, 5m means it stays in the started reports queue for
5 minutes. If |
| Hst | Indicates whether the report writes history data. |
| Interv (min/hour/day) |
Interval For scheduled reports. the time in minutes, hours or
days after which the report will be moved to the started reports queue again.
Zero (0) means it is never reactivated again. For example, 1h means the report
will be reactivated every hour. If |
| Log | Indicates the number of the current log file for the report. For summary reports with a log file, this field will be empty until the report writes information the first time to the log files. A write to the log file is performed whenever a report is stopped. |
| Max Stor (K) | The total storage allocation for the report as
limited by the MAXSTORE report
parameter, in kilobytes (K).
When the total storage allocation for a report is equal to the MAXSTORE value, the report is marked as inactive and stops accumulating data. The report is automatically restarted if the RESTART report option is set to "Y". |
| Next Activation-Time | For scheduled reports. Indicates, when the report will be moved to the started reports queue the next time. |
| Next Wait-Time | For scheduled reports. Indicates, when the report will be moved to the wait queue and stops collecting data. |
| Num Activ | For scheduled reports, the number of times a report moved from the wait queue to the started reports queue since it was scheduled. |
| Num Waits | For scheduled reports, the number of times a report moved from the started reports queue to the wait queue since it was scheduled. |
| Recs in Rpt | The number of commands (records) processed by the report. |
| Report Name | Name of the report. |
| Sel | Selection line. Commands are entered on the selection line preceding the report name. For a list of available commands, enter a ? on the selection line. |
| Started By | The user ID of the user who started the report. |
| Strt Time | Indicates the time at which the report started accumulating data. A time of "0" indicates that no data has been accumulated for the report. |
| Stat |
Report Status. Possible values for the first character are as follows:
Possible values for the second character are as follows:
|
| Sum/Det |
|
| Typ | Indicates whether the report is a regular Adabas Review report ("D") or an Adabas Review client report ("C"). |
| Used Stor (K) | The amount of storage currently used for the report, in kilobytes (K). |
To issue a command from the Started Reports
screen:
Enter the command on the selection line preceding the report name.
| Cmd | Action |
|---|---|
| CL | Close the report |
| DL | Download report output |
| EB | Edit Buffer Pool Report |
| EP | Edit display program |
| ER | Edit report definition |
| HC | Print report output (hard copy) |
| IN | Display active report information |
| PS | Purge report output. When you issue this command, console message REV20257 is issued. |
| RA | Reactivate report |
| RF | Refresh report |
| SU | Suspend report |
| SW | Switch CLOG data set |
| VW | View report output in the traditional way |
| VX | View report output using Software AG Editor |
From the Started Reports or Scheduled Reports screen, the command IN displays the Active Report Information window that provides current accounting information for the report named. The values need to be interpreted based on limits set for the report in the Report Options.
To display information about an active report's use of
memory:
Enter the IN command on the selection line preceding the report name from the Started Reports screen.
The following window appears:
11:16:03 A D A B A S - R E V I E W 2020-02-10
REVIEW-DB (10,252) Started Reports (1/3) Hub Target: 296
Sum Strt Display
Sel Program
+--------- *============== Active Report Information ==============* ---------+
| in APPL | | -00030 |
| __ COMM | Report name......... APPLICATION FILE FIELD USAGE | -00004 |
| __ EXCE | Max storage avail... 8,192 | -00002 |
| __ HOUR | Storage used........ 6,112 | -00032 |
| __ LAST | Remaining storage... 2,080 | -00038 |
| __ SAMP | Records processed... 664 | -00057 |
| | Account entries..... 33 | |
| | Account record len.. 88 | |
| | ADT length.......... 16 | |
| | Number of levels.... 3 | |
| | Report saved by..... INSTALL | |
| | Report last saved .. 2017-04-10 | |
+--------- | Report started by... XYZMPC | ---------+
*=======================================================*
Command:_______________________________________________________________________
Press PF3 to exit
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit - + LC ===> Menu |
The example Active Report Information window represents a summary report and indicates:
The total storage allocation for the report as limited by the MAXSTORE report parameter, along with an indication of the amount of storage currently used and the amount remaining for use.
When the total storage allocation for a report is equal to the MAXSTORE value, the report is marked as inactive and stops accumulating data. The report is automatically restarted if the RESTART report option is set to "Y".
The number of commands (records) processed by the report.
The number of entries (that is, unique control breaks) that the report currently maintains. The maximum number is set by the ENTRIES report option and is used to restrict the amount of data collected.
The length of the control break record and the length of the Account Data Table (ADT), which is an internal Adabas Review control block.
The number of control break levels.
The user ID of the user who last saved the report.
The date on which the report was last saved.
The user ID of the user who started the report.
Note:
The user ID is the Natural *INIT-USER value, or INSTALL in case
the report was saved during installation, AUTOSTRT in case the report was
started during startup of UNKNOWN in case the value is zero.
When you purge a report, the report data is deleted and the accumulated data is not written to the output locations defined for the report. Data accumulated by the report before the PURGE command was issued may not be viewed online after the PURGE command completes. When you issue this command, console message REV20257 is issued.
Note:
The report definition is not deleted; only the report data is
deleted.
If the report option RESTART=Y is specified, the report is not restarted automatically after the PURGE command has been issued.
To purge a started or scheduled report:
Enter the PS command on the selection line preceding the report name from the Started Reports or Scheduled Reports screen.
Depending on the setting of your profile, you may be prompted to confirm the purge request.
If required, confirm the purge request.
The report is purged.
By suspending a started or scheduled report, you stop it from accumulating any further data; the data already accumulated is not purged.
To suspend a report:
Enter the SU command on the selection line preceding the report name from the Started Reports or Scheduled Reports screen.
The status of the report on the Started Reports or Scheduled Reports screen is changed from A(ctive) to S(uspended), no matter how the RESTART report option is set. A message indicating a change in report status is displayed.
You may reactivate a suspended report so that it resumes collecting data.
To reactivate a suspended report:
Enter the RA command on the selection line preceding the report name from the Started Reports or Scheduled Reports screen.
The status of the report on the Started Reports screen is changed from S(uspended) to A(ctive). A message indicating a change in report status is displayed.
When you refresh a report, you purge the accumulated data and restart the report.
You are prompted to refresh a report when you make changes to a started or scheduled report and attempt to restart it. This is because the name of the report currently accumulating data matches the name of the report you are attempting to start or schedule; Adabas Review does not permit reports with duplicate names.
To refresh a report:
Enter the command RF on the selection line preceding the report name.
Adabas Review then purges the accumulated data and restarts or reschedules the report, no matter how the RESTART report option is set; a message is displayed indicating that the report is refreshed.
Closing a report means that the report is suspended, and the accumulated data is written to the output locations defined to the report. Data accumulated by the report before the CLOSE command was issued may not be viewed online after the CLOSE command completes.
If the report option RESTART=Y is specified, the report is restarted automatically after the CLOSE command has been issued.
Reports in an Active, Inactive, or Suspended status may be closed.
To close a started report:
Enter the CL command on the selection line preceding the report name on the Started Reports or Scheduled Reports screen.
Depending on the setting of your profile, you may be prompted to confirm the purge request. This is because the CLOSE command writes the data accumulated by the report to the output device, then purges the data accumulated by the report.
Confirm the purge request, if required.
If the report option RESTART=Y is specified in the report definition, the report is restarted, and the status is set to A(ctive).
The SW command is used to switch to the next command (detailed reports) or summary (summary reports) log file that has been defined for a particular report, before the current file is filled. For summary reports, the switch is only executed after the first write on the file has occurred.
If the maximum number of log files designated for the report is exceeded by this request, Adabas Review will begin writing over the file that contains the oldest data.
Note:
This command does not switch the log file for any report other
than the one selected.
To switch to the next log file:
Enter the SW command on the selection line preceding the report name on the Started Reports or Scheduled Reports screen.