B97AXPDT: Archive expiration date batch utility

Overview

The archive expiration date utility (B97AXPDT) must run for modifications to a list's archive expiration date to take effect. If the archive expiration date is to be extended, this modification can be done manually (line command E under option 1) or with the batch utility B97BUGEN. If the archive expiration date is to be reduced, this modification can only be done with the batch utility B97BUGEN.

Which archive datasets are affected

If the archive expiration date is to be extended

B97AXPDT changes the generation records and the archive datasets of the affected lists.

Modifying the archive expiration date of a list affects not only the archive dataset containing the list, but an entire group of archive datasets generated during the corresponding archive run.

By default, the program modifies all archive datasets that were generated for the corresponding archive pool.
If you specify the parameter ORDER = nn, the program modifies all archive datasets that were generated for the corresponding archive subpool.

If the archive expiration date is to be reduced

B97AXPDT only changes the generation records of the affected lists. The archive datasets of the affected lists will not be changed.

Important: Updating TMS/SMS/HSM when increasing the archive retention period

The batch utility B97AXPDT only carries out the changes that are required in the Adabas Audit Data Retrieval database. In addition, you must ensure that these changes take effect in the corresponding management system (TMS, SMS, HSM). Therefore you must check (and if necessary change) the expiration date of these datasets and volumes in the corresponding management system. The batch utility B97AXPDT prints a list of the affected datasets and volumes in DD IRMPRINT.

JCL

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

Return codes

The program terminated normally.

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

Note: In analyze mode, RC=4 can also mean the following:

The program has found data to be modified. But if the program was running in normal mode and tried to carry out these changes, they would lead to an error. You can find more information in the job log.

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 modifies the archive expiration date and logs the actions that it carries out. (Default) YES The program runs in analyze mode; it writes the reports, but it does not actually change any data.
DATEMASK = mask	Date format to be used in reports (Default: Date mask of system options record)
ORDER = nn	The program modifies only the archive datasets having the specified value in the Order for Reload field. You can specify ORDER = nn up to five times. If you don't specify this parameter, the expiration dates of all archive datasets of the archive pool are modified.

Parameter

Description

ANALYZE = YES | NO

The program modifies the archive expiration date and logs the actions that it carries out. (Default)

YES

The program runs in analyze mode; it writes the reports, but it does not actually change any data.

DATEMASK = mask

Date format to be used in reports
(Default: Date mask of system options record)

ORDER = nn

The program modifies only the archive datasets having the specified value in the Order for Reload field.

You can specify ORDER = nn up to five times. If you don't specify this parameter, the expiration dates of all archive datasets of the archive pool are modified.

IRMPRINT

The following log is written to DD IRMPRINT. It contains a list of all lists/reports whose archive retention period was changed.

+------------------------------------------------------------------------------------------------------------------------------------+
|Date: date Product: Beta 97 ARCHIVE EXPIRATION UTILITY Page: 1 |
|Time: time Version: V7R2 |
| |
| |
|Date Time Form Extension Report Old_ArcExpdt New_ArcExpdt Request Pool Owner Archive Pointer |
|---------- ----------- ----- ---------- -------- ------------- ------------ -------- ------- ------- ---------------------- |
|10.07.2018 14:12:46:99 REJ TRADE 20.12.2025 05.08.2040 EXTEND DISK10 CUST001 D47BA607FE12250A00000... |
|10.07.2018 14:12:55:14 REJ TRADE 15.11.2023 05.08.2040 EXTEND TAPE02 CUST001 D47BA607FE12250A00000... |
|17.07.2018 09:54:31:18 REJ TRADE01 15.06.2054 31.12.2013 REDUCE DISK02 CUST001 D476CC31C643B60800000... |
+------------------------------------------------------------------------------------------------------------------------------------+

If the archive retention period is to be extended, the protocoll contains a second part. This part contains a list of datasets and media, whose retention period you must change, for example in the Tape Management System, after the archive retention period was changed in the Adabas Audit Data Retrieval database.

+--------------------------------------------------------------------------------------------------------------+
|Date: date Product: Beta 97 ARCHIVE EXPIRATION UTILITY Page: 1 |
|Time: time Version: V7R2 ARCHIVE MEDIA/DATASETS |
| |
|====================================================================== |
|The expiration date for the following datasets or media must be |
|updated in the corresponding management system: |
|====================================================================== |
| |
|Medium Volume Archive Dataset Name New Expdt |
|------ ------ -------------------------------------------- --------- |
|DISK BETA97.SYS1.DISK.E09069.C001 05.08.2040 |
|DISK BETA97.SYS1.DISK.E09069.C002 05.08.2040 |
|TAPE BETA97.SYS1.DISK.E09069.C003 05.08.2040 |
| |
+--------------------------------------------------------------------------------------------------------------+

IRMLOG

A processing log is written to DD IRMLOG. It contains the SYSIN parameters and an overview of the records processed.

+-----------------------------------------------------------------------------------------------+
|IRM1561I PROGRAM: B97AXPDT VERSION: V7R2M00 PTFLVL: ptflvl COMPILED: date, time |
|IRM1800I AEXPDT PROCESSING STARTED - DATE: 10.07.2018, TIME: 16:42:52 |
|IRM2210I ************************************************************************************* |
|IRM1901D ANALYZE NO |
|IRM2210I ------------------------------------------------------------------------------------- |
|IRM2201I Processed dataset(s) ... |
|IRM2201I BETA97.SYS1.DISK.E09069.C001 05.08.2040 DISK |
|IRM2201I BETA97.SYS1.DISK.E09069.C002 05.08.2040 DISK |
|IRM2201I BETA97.SYS1.TAPE.E09069.C003 05.08.2040 TAPE |
|IRM2201I ------------------------------------------------------------------------------------- |
|IRM2210I IGR(S) READ : 000001 |
|IRM2210I IGR(S) UPDATED : 000001 |
|IRM2210I AGR(S) UPDATED : 000003 |
|IRM2210I REQUEST(S) FAILED/IN ERROR : 000000 |
|IRM2210I ************************************************************************************* |
|IRM1899I AEXPDT PROCESSING ENDED - DATE: 10.07.2018, TIME: 16:42:52, RC: 0000 |
+-----------------------------------------------------------------------------------------------+