B97DEONL: Online spool cleanup batch utility

Function

The online spool cleanup batch utility (B97DEONL) does the following:

  • It removes all indexes whose online retention period has expired from the Adabas Audit Data Retrieval index spool.
  • It removes all lists whose online retention period has expired from the Adabas Audit Data Retrieval online spool. The Adabas Audit Data Retrieval online spool contains:
    • Lists that have been read in by B97RDR00
    • Lists that have been reloaded from the archive

      The online retention period of these lists and their indexes is determined in the B97LSTxx member using the LST parameters B97_CLEANUP_RELOAD_LIST=n and B97_CLEANUP_RELOAD_INDEX=n, where n refers to a number of days (default: 5).

  • It updates the Adabas Audit Data Retrieval IGR (indexed list generation record) of each list whose online retention period has expired.
    The online status in the generation record of the indexed list is changed from online to offline.

Exception: Lists still waiting to be archived (archive status Pend) will not be processed, even if their Adabas Audit Data Retrieval online retention period has expired.

Note: Lists marked for deletion

If a list has been marked for deletion manually, the list and its indexes are processed by the online spool cleanup batch utility in the same manner as lists whose Adabas Audit Data Retrieval online retention period has expired.

However, a list marked for deletion manually will be deleted even if its archive status is Pend.

Running B97DEONL

You should run this utility on a daily basis to delete obsolete list data from the Adabas Audit Data Retrieval online spool.

Tailored JCL for this job can be found in member B97DEONL in the BETA97.CNTL and in the corresponding step of the B97DAILY job.

You can also submit this batch utility online via option S.3.3. This will generate JCL from member SE97OCLN of the BETA97.ISPSLIB (skeleton library).

JCL

+--------------------------------------------------------------------+
|jobcard |
|//B97DEONL EXEC PGM=BST01RFF,REGION=0M,PARM=('S=97', |
|// 'PGM=B97DEONL', |
|// 'B01LST=xx', |
|// 'B97LST=xx', |
|// 'SIGNON=YES') |
|//* |
|//STEPLIB DD DISP=SHR,DSN=BETA97.LOAD |
|// DD DISP=SHR,DSN=BSA.LOAD |
|//* |
|//SFFPARM DD DISP=SHR,DSN=BETA.PARMLIB |
|//B97DEF DD DISP=SHR,DSN=BETA97.DB.DEF |
|//* |
|//IRMLOG DD SYSOUT=* |
|//IRMERROR DD SYSOUT=* |
|//IRMPRINT DD SYSOUT=* |
|//SYSPRINT DD DUMMY |
|//SFFFDUMP DD SYSOUT=* |
|//SYSABEND DD SYSOUT=* |
|//* |
|//SYSIN DD * |
|parameters |
|/* |
+--------------------------------------------------------------------+

Return codes

0

The program terminated normally.

4

The program did not find any data to be removed;
the program terminated normally.

>4

One or several errors occurred during processing.
Please check the job log for details.

Some return codes are program-specific. Others are standard return codes which can also be modified. More information on standard return codes can be found in "Return codes".

SYSIN parameters

All SYSIN parameters are optional.

Parameter

Description

ANALYZE YES | NO

NO

The program deletes affected lists and indexes from the spools and logs the executed actions (default)

YES

The program runs in analyze mode (simulation); No data is deleted, only logs are created.

IRMLOG

DD IRMLOG contains a summary log listing the number of lists and indexes processed and deleted.

+-----------------------------------------------------------------------------------------------+
|IRM1561I PROGRAM: B97DEONL VERSION: V7R2M00 PTFLVL: ptflvl COMPILED: date, time |
|IRM2100I ONLINE CLEANUP PROCESSING STARTED - DATE: 13.03.2020, TIME: 09:43:53 |
|IRM2130I ************************************************************************************* |
|IRM2130I 0001228 LIST(S)/REPORT(S) PROCESSED (1)
|IRM2130I 0000234 LIST(S)/REPORT(S) ONLINE (2)
|IRM2130I 0000994 LIST(S)/REPORT(S) OFFLINE WITH ONLINE INDEX(ES) (3)
|IRM2130I INDEX(ES) OF 0000036 ONLINE LIST(S)/REPORT(S) DELETED (4)
|IRM2130I INDEX(ES) OF 0000002 OFFLINE LIST(S)/REPORT(S) DELETED (5)
|IRM2130I 0000137 LIST(S)/REPORT(S) DELETED (6)
|IRM2130I 0000007 RELOAD LIST(S)/REPORT(S) DELETED (7)
|IRM2130I ************************************************************************************* |
|IRM2199I ONLINE CLEANUP PROCESSING ENDED - DATE: 13.03.2020, TIME: 09:44:05, RC: 0881 |
+-----------------------------------------------------------------------------------------------+

The following comments refer to the line numbers inserted in the right border of the log:

(1) is the total number of list/report generations that are processed by B97DEONL in this run. This number can be divided into the following groups:

  • List/Report is online, but does not have the status Archive Pending (2)
  • List/Report is offline, but at least one index of this offline list/report is online (3)

This means: Lists/Reports where both the document and all indexes are offline are not included in (1). Neither are lists/reports with status Archive Pending.

The following lines (4-7) log the deletion of data from the corresponding spools.

IRMPRINT

DD IRMPRINT itemizes the lists released. The log contains the following:

  • DATE / TIME: Creation date and time of the list/report
  • FORM / EXTENSION / REPORT: Name of the list
  • PAGES: Number of pages
  • RETPD: Expiration date
  • STATUS: Status or internal return code

    For a list of internal return codes, see "Internal return codes" in Adabas Audit Data Retrieval Messages and Codes; status can be one of the following:

    • EXPIRED (list whose retention period has expired)
    • RELOAD (reloaded list whose retention period has expired; the retention period of reloaded lists is determined using the LST parameter B97_CLEANUP_RELOAD_LIST)
    • DELETE (list that has been marked manually for deletion)

+--------------------------------------------------------------------------------------------+
|Date: 13.03.2020 Product: Beta 97 ONLINE CLEANUP UTILITY Page: 1 |
|Time: 09:43:53 Version: V7R2 |
| |
| |
|Date Time Form Extension Report Pages Expired Status |
|---------- -------- -------- ---------------- ---------------- -------- ---------- ------- |
|10.03.2020 10:08:37 ARCH TAPE101 00000003 11.03.2020 EXPIRED |
|10.03.2020 10:08:37 ARCH TAPE9999 00000012 11.03.2020 EXPIRED |
|10.03.2020 10:08:38 ARCH DISK10000 00000012 11.03.2020 EXPIRED |
|10.03.2020 10:08:39 ARCH TAPE101 00000003 11.03.2020 EXPIRED |
|10.03.2020 10:08:39 ARCH TAPE9999 00000012 11.03.2020 EXPIRED |
|10.03.2020 10:08:40 ARCH DISK10000 00000012 11.03.2020 EXPIRED |
|10.03.2020 10:08:41 ARCH TAPE101 00000003 11.03.2020 EXPIRED |
|10.03.2020 10:08:41 ARCH TAPE9999 00000012 11.03.2020 EXPIRED |
|10.03.2020 10:08:42 ARCH DISK10000 00000012 11.03.2020 EXPIRED |
|10.03.2020 10:08:43 ARCH TAPE101 00000003 11.03.2020 EXPIRED |
|10.03.2020 10:08:44 ARCH TAPE9999 00000012 11.03.2020 EXPIRED |
|10.03.2020 10:08:44 ARCH DISK10000 00000012 11.03.2020 EXPIRED |
|10.03.2020 10:08:45 ARCH TAPE101 00000003 11.03.2020 EXPIRED |
|10.03.2020 10:08:46 ARCH TAPE9999 00000012 11.03.2020 EXPIRED |
|10.03.2020 10:08:46 ARCH DISK10000 00000012 11.03.2020 EXPIRED |
| ... |
+--------------------------------------------------------------------------------------------+

IRMERROR

DD IRMERROR itemizes the lists whose expiration date has been reached, but which were not deleted. The log contains the following:

  • DATE / TIME: Date and time of the list
  • FORM / EXTENSION / REPORT: Name of the list
  • SSID: always blank in Adabas Audit Data Retrieval
  • REASON: Reason (Archive pending or internal return code; for a list of internal return codes, see "Internal return codes" in Adabas Audit Data Retrieval Messages and Codes)

+-------------------------------------------------------------------------------------------+
|Date: 13.03.2020 Product: Beta 97 ONLINE CLEANUP UTILITY Page: 1 |
|Time: 09:43:53 Version: V7R2 ERROR LOG |
| |
| |
|Date Time Form Extension Report Ssid Reason |
|---------- -------- -------- ---------------- ---------------- ---- -------------------- |
|09.03.2020 08:38:19 - TC4180 HANDEL Archive pending |
|26.02.2020 10:03:44 - TC3980 RECHNUNGEN Archive pending |
|10.03.2020 10:31:28 - ARCH TAPE10 Archive pending |
+-------------------------------------------------------------------------------------------+

Note on RC=0881

This return code occurs if a reloaded list has not yet reached its retention period and can be ignored. The retention period of reloaded lists is specified via the LST parameter B97_CLEANUP_RELOAD_LIST.