B97DEUGF: UGF table cleanup batch utility

Overview

Adabas Audit Data Retrieval saves search terms used in queries in the UGF table (Option C.U). The entries in the UGF table are used for prepopulating fields when the same user carries out a future search involving the same index. The batch utility B97DEUGF enables you to delete obsolete entries from the UGF table.

JCL

You can find sample JCL for this batch utility in the BETA97.CNTL in member B97DEUGF.

+-----------------------------------------------------------------------+
|jobcard |
|//B97BUGEN EXEC PGM=BST01RFF,REGION=0M,PARM=('S=97', |
|// 'PGM=B97DEUGF', |
|// '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 |
|//* |
|//SYSPRINT DD SYSOUT=* |
|//IRMLOG DD SYSOUT=* |
|//IRMPRINT DD SYSOUT=* |
|//* |
|//SFFFDUMP DD SYSOUT=* |
|//SYSABEND DD SYSOUT=* |
|//* |
|//SYSIN DD * |
|parameters |
|/* |
+-----------------------------------------------------------------------+

Return codes

0	The program terminated normally.
4	This return code can occur due to several reasons: No data found for at least one selection A warning was issued
12	Component error
16	Out of memory
20	This return code can occur due to several reasons: DD statement missing () Error when opening a log file () Error when initializing the database access () Database access error () Syntax error
24	Communication error
32	BQL abend
36	BQL command error

Note: (*) indicates standard return codes that can be modified.

Syntax DD SYSIN

DD SYSIN contains:

One statement block with general processing parameters like the amount of information to be printed in the log (FULLLISTINFO) and its page length (LINESPERPAGE); these specifications apply to the entire program run.
One or more selection blocks that are introduced by the following line:
DELETE = GENERATION

This line is followed by the statements that control the selection of entries for deletion.

Each statement is coded on a separate line and is structured as follows:

keyword = value

The equal sign ( = ) is optional in all statements. To mark a line as comment line, enter an asterisk ( * ) in the first column of the line. If a value is blank, enter a blank enclosed in single quotation marks, for example:

EXTENSION = ' '

Keywords for processing

Keyword	Parameter	Description	Option	Mask	Default	Length
ANALYZE	YES \| NO	Analyze mode	Optional	No	NO	3
FULLLISTINFO		Controls the amount of information	Optional	No
LINESPERPAGE	nn	Page length (number of lines) of the log	Optional	No	Value from option S.2	2
DATEMASK	date mask	Date format for date specification	Optional	No	System date mask (S.2)	10

FULLLISTINFO controls the amount of information logged for each list in DD IRMPRINT. If the keyword is present, the list/report/folder names are included in DD IRMPRINT together with the number of indexes . If the keyword is not coded, only the list/report/folder count is included.

Specify DATEMASK=datemask if your date specifications (SDATE/EDATE) are in a different format from the system date mask (option S.2).

Keywords for user-based selection

A selection block for user-based deletion begins with the instruction DELETE GENERATION (required), which is followed by the desired user-based selection criteria. Instead of a date, you can also use the keywords TODAY, YESTERDAY, and MONDAY through SUNDAY.

Keyword	Format/Length	Description	Default	Required	Masks
DELETE	GENERATION			Yes	No
USER	8 characters	User ID		Yes	Yes
SDATE	The date must be coded in accordance with DATEMASK (default: system date mask from option S.2)	Start date	*	No	No
EDATE	See SDATE	End date	TODAY	No	No

Keywords for list-based selection

A selection block for list-based deletion begins with the instruction DELETE GENERATION (required), which is followed by the desired list-based selection criteria. Instead of a date, you can also use the keywords TODAY, YESTERDAY, and MONDAY through SUNDAY.

Keyword	Format/Length	Description	Default	Required	Masks
DELETE	GENERATION			Yes	No
PROCESS	ALL \| REPORT \| LIST	Process lists, reports or both		Yes	No
FORM	8 characters	Form name	*	No	Yes
EXTENSION	16 characters	Extension name	*	No	Yes
REPORT	16 characters	Report name	*	No	Yes
SDATE	The date must be coded in accordance with DATEMASK (default: system date mask from option S.2)	Start date	*	No	No
EDATE	See SDATE	End date	TODAY	No	No

Keywords for folder-based selection

A selection block for folder-based deletion begins with the instruction DELETE GENERATION (required), which is followed by the desired folder-based selection criteria. Instead of a date, you can also use the keywords TODAY, YESTERDAY, and MONDAY through SUNDAY.

Keyword	Format/Length	Description	Default	Required	Masks
DELETE	GENERATION			Yes	No
FOLDER	32 characters	Folder name		Yes	Yes
OWNER	8 characters	Owner name	*	No	Yes
SDATE	The date must be coded in accordance with DATEMASK (default: system date mask from option S.2)	Start date	*	No	No
EDATE	See SDATE	End date	TODAY	No	No

Example

//SYSIN DD *
ANALYZE = YES
FULLLISTINFO
*
DELETE GENERATION
USER = REINH*
*
DELETE GENERATION
PROCESS = REPORT
FORM = REJ
EXTENSION = BALDESCOMPTES
*
DELETE GENERATION
FOLDER = *
OWNER = DOCU
/*

IRMPRINT

The log that is written to DD IRMPRINT contains information on the entries that were selected for deletion.

+-------------------------------------------------------------------------------------------------------------------+
|Date: date Product: beta docz plus PROFILE CLEANUP UTILITY Page: 1|
|Time: time Version: V7R2 USER PROCESSING |
| |
| |
|User Form Extension Report #Idx |
|-------- -------- ---------------- ---------------- ---- |
|REINH1 FNR102 TC4024-QASF102 FILE_102 0006 |
|REINH1 FNR103 TC4024-QASF103 FILE_103 0005 |
|REINH1 FNR104 TC4024-QASF104 FILE_104 0004 |
+-------------------------------------------------------------------------------------------------------------------+

IRMLOG

A processing log is written to DD IRMLOG.

+-----------------------------------------------------------------------------------------------+
| IRM1561I PROGRAM: B97DEUGF VERSION: V7R2M00 PTFLVL: ptflvl COMPILED: date, time |
| IRM2100I PROFILE CLEANUP PROCESSING STARTED - DATE: date, TIME: time |
| IRM2130I *************************************************************************************|
| IRM1901D FULLLISTINFO |
| IRM1901D DELETE GENERATION |
| IRM1901D USER REINH1 |
| IRM2210I -------------------------------------------------------------------------------------|
| IRM2130I User(s) processed: 1 |
| IRM2130I List(s) processed: 0 |
| IRM2130I Report(s) processed: 3 |
| IRM2130I Folder(s) processed: 0 |
| IRM2130I Index(es) processed: 15 |
| IRM2130I *************************************************************************************|
| IRM2199I PROFILE CLEANUP PROCESSING ENDED - DATE: date, TIME: time, RC: 0000 |
+-----------------------------------------------------------------------------------------------+