HCHECK input

Run the Health Checker function by running HCHECK.

HCHECK function syntax

Parameter reference

hcheck-option: Use this positional parameter to specify the HCHECK option to be processed. The list of valid options is described in the following table. This parameter must be the first parameter that you specify on the HCHECK keyword.

Use the following HCHECK parameters to specify the time frame range, or number that HCHECK uses for various options. Not all HCHECK options allow these parameters. Also, these parameters are mutually exclusive.

The valid list of HCHECK options and the parameters that are allowed is shown in the following section (HCHECK options reference).

HOURS(nnn)

Use the HOURS parameter to specify the number of hours to be used to limit the HCHECK option.

HOURS allows an integer between 1 and 999.

There is no default for the HOURS parameter.

DAYS(nnn)

Use the DAYS parameter to specify the number of days to be used to limit the HCHECK option.

DAYS allows an integer between 1 and 999.

There is no default for the DAYS parameter.

RANGE(range-specification)

Use the RANGE parameter is used to specify the beginning and ending time frame (or range) to be used to limit the HCHECK option.

There is no default for the RANGE parameter.

For more detailed information about the format of the RANGE specification, see TIME and RANGE parameter processing.

NUMBER(nnn)

Use the NUMBER parameter to specify the number to be used to limit the HCHECK option.

NUMBER allows an integer between 1 and 999.

There is no default for the NUMBER parameter.

OLR(partition-report-limit)

Use the OLR parameter to limit which partitions are reported on.

The following values are valid for partition-report-limit:

BOTH: Reports on all partitions, whether active or inactive. This is the default value.
ACTIVE: Reports only the currently active partitions.
INACTIVE: Reports only the currently inactive partitions.

Options reference

The following table shows all of the valid HCHECK options, their abbreviations, acceptable parameters, and a brief description of each option. A more detailed description of each option appears after this table.

Table 1. The valid HCHECK options, abbreviations, parameters, and descriptions
Option	Abbreviations	Parameters	Description
ICALL	IA, ICA	N/A	Produces the ICNONE, ICNEED, and ICREC reports.
ICNONE	IO, ICNO	N/A	DBs for which no ICs or SLBs exist.
ICNEED	IE, ICNE	N/A	DBs for which ICs are needed.
ICREC	IR, ICR	N/A	DBs for which ICs are recommended.
ICFREQ	IF, ICF	HOURS() DAYS() RANGE()	DBs for which no ICs or SLBs exist within the specified time.
MINBAT	MB, MINB	HOURS() DAYS() RANGE()	DBs for which no batch ICs or SLBs exist within the specified time.
MINONL	MO, MINO	HOURS() DAYS() RANGE()	DBs for which no online ICs or SLBs exist within the specified time.
EEQE	EQ, E	N/A	DBs that have error queue elements (EEQEs).
DBNOTCA	DC	N/A	DBs that are not in a CA group.
HALDBDISABLEDPART	HD, HALDBD	N/A	HALDBs that have disabled partitions.
HALDBNOTINIT	HN, HALDBN	N/A	HALDBs that are not initialized.
NOADS	NA	N/A	Produces the NOADSDEFINE and NOADSAVAIL reports.
NOADSDEFINE	ND, NOADSD	N/A	DEDBs that have no area data sets defined.
NOADSAVAIL	NV, NOADSA	N/A	DEDBs that have no area data sets available.
BACKOUT	BO, B	N/A	DBs that show backout needed.
MINCARECS	MC. MINC	NUMBER()	DBs that do not have the minimum number of CA records available.
SECLOG	SL, SECL	N/A - global	No valid corresponding SECLOG entry for a PRILOG entry.
SECSLD	SS, SECS	N/A - global	No valid corresponding SECSLDS entry for a PRISLDS entry.
CARUN	CR, CAR,CARU	HOURS() DAYS() RANGE()	CA group does not have a valid CARUN within specified time.
PROAUTH	PA, PR	N/A	DBs that indicate that prohibit authorization is on.
PISEC	PS, PI	HOURS() DAYS() RANGE()	Primary IC with no corresponding valid secondary IC within that specified time.
VERIFY	VF, VER, VFY	N/A	Ensures that all recovery assets are cataloged.

You can specify just one of the HCHECK options within each HCHECK command. However, you can specify the HCHECK command any number of times within a single JCL input stream.

Also, you can specify the HCHECK option using the fully-qualified option, or any of the acceptable abbreviations that are displayed in the previous table.

For those options that require additional parameters, the HCHECK command is marked in error and is not processed if you do not specify the required additional parameters.

The following sections describe the HCHECK options and their relationships in more detail.

Image copy needed or recommended

Syntax for the ICALL, ICNONE, ICNEED, and ICREC options:

ICALL: Use this option to specify that the ICNONE, ICNEED. and ICREC options are to be processed.
ICNONE: Use this option to check for database data sets for which no image copy or System Level Backup has been taken.
ICNEED: Use this option to check for database data sets for which an image copy is needed.
ICREC: Use this option to check for database data sets for which an image copy is recommended.

No Batch or Online Image Copy within Specified Time Frame

ICFREQ: Use this option to specify that a check is performed for valid Image Copies or SLBs within the specified time frame.
MINBAT: Use this option to specify that a check is performed for valid batch image copies or System Level Backups within the specified time frame.
MINONL: Use this option to specify to check for valid online image copies or System Level Backups within the specified time frame.

Databases that have extended error queue elements (EEQEs)

Syntax for the EEQE option:

EEQE: Use this option to check for databases that have EEQEs, indicating that recovery might be needed.

Databases not in a change accumulation group

Syntax for the DBNOTCA option:

DBNOTCA: Use this option to check for databases that are not included in any change accumulation group. Databases that are not in change accumulation groups might adversely affect database recovery.

HALDB not initialized

Syntax for the HALDBNOTINIT option:

HALDBNOTINIT: Use this option to check for High Availability Large Databases (HALDBs) that have not been initialized. These databases are currently unusable.

No area data set defined, no area data set available

Syntax for the NOADS, NOADSDEFINE, and NOADSAVAIL options:

NOADS: Use this option to specify that the NOADSDEFINE and NOADSAVAIL options are processed. Use the NOADSDEFINE option to check for fast path databases that have no area data sets defined.
NOADSDEFINE: Use this option to check for fast path databases that have no area data sets defined.
NOADSAVAIL: Use this option to check for fast path databases that have no currently available area data sets.

Backout needed

Syntax for the BACKOUT option:

BACKOUT: Use this option to check for databases marked as backout needed.

Minimum change accumulation records not available

Syntax for the MINCARECS option:

MINCARECS: Use this option to check for databases that do not have the specified number of change accumulation data sets available.
NUMBER(number): Use this option keyword to specify the minimum acceptable available change accumulation data sets.

No valid corresponding SECLOG entry for the PRILOG record

Syntax for the SECLOG option:

SECLOG: Use this option to check for databases that have a valid PRILOG entry, but no corresponding SECLOG record.

No valid corresponding SECSLDS entry for PRISLDS record

Syntax for the SECSLD option:

SECSLD: Use this option to check for databases that have a valid PRISLDS entry, but no corresponding SECSLDS record.

Change accumulation (CA) group does not have a valid CA run within the specified time range

Syntax for the CARUN option:

CARUN: Use this option to check for databases that do not have a valid change accumulation within the specified time frame.
time-specification: Use this required option keyword to specify the time frame to check. Specify the time-specification with either the HOURS(), DAYS(), or RANGE() keyword. You must specify one of the HOURS(), DAYS(), or RANGE() keywords or the HCHECK CARUN function will be rejected. For a description of HOURS(), DAYS(), or RANGE(), see TIME and RANGE parameter processing.

Database is in prohibit authorization state

Syntax for the PROAUTH option:

PROAUTH: Use the PROAUTH option to check for databases that are in prohibit authorization state.

Primary image copy with no corresponding valid secondary image copy within the specified time range

Syntax for the PISEC option:

PISEC: Use this option to check for databases that have a valid primary image copy, but no valid secondary image copy within the specified time frame.
time-specification: Use this required option keyword to specify the time frame to check.
Specify the time-specification with either the HOURS(), DAYS(), or RANGE() keyword. You must specify one of the HOURS(), DAYS(), or RANGE() keywords or the HCHECK CARUN function will be rejected. For a description of HOURS(), DAYS(), or RANGE(), see TIME and RANGE parameter processing.

Disabled HALDB partition

Syntax for the HALDBDISABLEDPART option:

HALDBDISABLEDPART: Use this option to check for High Availability Large Databases (HALDBs) that have disabled partitions.

Verify that recovery assets are cataloged

Syntax for the VERIFY option:

VERIFY

Use this option to verify that the recovery assets associated with the selected databases are cataloged. All of the following recovery assets that are registered with DBRC or are in the IMS Recovery Expert repository are verified:

Database data set names
Image copy data set names
System Level Backup data set names
Log data set names
Change accumulation data set names

HCHECK(VERIFY) has no time oriented parameter. It verifies only whether the latest Image Copy is in the catalog or not.

In the case of SLBs, the data set name in the Image Copy record is symbolic only. Therefore, it is the offload data set names that are being verified.

Non-cataloged offload data sets are not listed on the HCHECK(VERIFY) report. Only the fact that they are not cataloged is indicated. In order to determine which specific offload data set is not cataloged, use the VERIFY(ALLOC) or VERIFY(OPEN) function.