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 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.
Note:
If you are trying to start a report in hub mode using batch
Natural , you must issued the MENU HUB=hubid command
prior to issuing the START command for the report.
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).
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, 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.
The List Started Reports (LS) function lists reports that have been started. 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.
15:36:34 A D A B A S - R E V I E W 2011-03-01
Started Reports LOCL=00559
Sum Strt Display
Sel Report Name Stat DBID Det Typ Hst Log Time Program
+-----------------------------------------------------------------------------+
! __ A STANDARD REPORT A 559 S D N 14:29 RD-00010 !
! !
! !
! !
! !
! !
! !
! !
! !
! !
! !
! !
+-----------------------------------------------------------------------------+
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit - + Menu
|
An explanation of the Started Reports screen is provided in the table below:
| Heading | Explanation |
|---|---|
| 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. |
| Report Name | Name of the report. |
| Stat | Report Status. Possible values are as follows:
|
| DBID | Database for which the report collects data. |
| Sum/Det |
|
| Typ | Indicates whether the report is a regular Adabas Review report ("D") or an Adabas Review client report ("C"). |
| Hst | Indicates whether the report writes history data. |
| Log | Indicates the number of the current log file for 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. |
| Display Program | Lists the name of the program generated to display report output online. |
PF7 and PF8 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.
To issue a command from the Started Reports screen:
Enter the command on the selection line preceding the report name.
From the Started 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:
19:47:09 A D A B A S - R E V I E W 2009-06-18
Started Reports HUB=15690
Sum/ Strt Display
Sel +----------------------------------------------------------+Program
+-------- | Active Report Information |--------+
! in APP | |R-00030 !
! __ BUF | Report name......... APPLICATION FILE FIELD USAGE |UFFPOOL !
! __ COM | Max storage avail... 8,192 |R-00025 !
! ? | Storage used........ 2,016 | !
! | Remaining storage... 6,176 | !
! | Records processed... 0 | !
! | Account entries..... 0 | !
! | Account record len.. 88 | !
! | ADT length.......... 16 | !
! | Number of levels.... 3 | !
! | Report saved by..... INSTALL | !
! | Report saved on..... 2009-06-18 | !
+-------- +----------------------------------------------------------+--------+
Press PF3 to exit
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit - + 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.
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.
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 report:
Enter the PS command on the selection line preceding the report name from the Started 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 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 screen.
The status of the report on the Started 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 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 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; 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 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 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.
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 screen.
