Adabas Nucleus Auditing Parameters (ADAANP)

#### Search Results

Search

# Adabas Nucleus Auditing Parameters (ADAANP)

When running an Adabas nucleus with `ADARUN AUDITING=YES`, the user must specify definitions for the auditing software.

These auditing definitions are read from the sequential file or PDS member allocated to the DD name ADAANP (Adabas Auditing Nucleus Parameters).

The definitions are provided as parameters in the input file, using the same syntax as Adabas utilities. Each input record must be prefixed with `ADAANP`.

For cluster or parallel services, the auditing parameters are local and fixed for each nucleus:

- 'Local' means that the parameters may be the same or different across the nuclei in the cluster or parallel service.

- 'Fixed' means that the parameters are read only during nucleus startup.

There are three groups of auditing parameters:

- Global parameters specific to a nucleus

- File parameters specific to one or more files

- Database auditing parameters specific to a nucleus

The term global here means the definitions are global for one nucleus. It does not mean the definitions apply across cluster nuclei.

- Global Auditing Parameters

- File Auditing Parameters

- Database Auditing Parameters

- Examples

## Global Auditing Parameters

Global auditing definitions are defined for one nucleus and are not associated with any specific file.

The GLOBAL parameter marks the beginning of a group of global auditing parameters and must be specified as a word standing by itself.

The global auditing parameters are listed in the table below.

Note
These input parameters must be prefixed with `ADAANP` and are read from the file allocated to the DD name ADAANP.

Parameter | Description | Valid Values | Default Value
--- | --- | --- | ---
`GSERVERID` | Specifies the Audit Server ID to be used when the server ID is not specified at the file level for a file where auditing data will be collected. | The valid values for this parameter are 1 – 65,535. The server ID may not be set to the database ID associated with the currently active nucleus. | -
`GCONNECTCOUNT` | Connect count – Specifies the number of connect attempts the nucleus should attempt for an Audit Server when the first attempt to connect to an Audit Server fails. | The valid values for this parameter are 0 – 2,147,483,647. | The default value for this parameter is zero (i.e. no subsequent connection attempts will be made after the first connection attempt fails).
`GCONNECTINTERVAL` | Connect interval – Specifies the interval in seconds between connection attempts when an attempt to connect to an Audit Server fails. | The valid values for this parameter are 0 – 2,147,483,647. | The default value for this parameter is zero (i.e. no subsequent connection attempts will be made after a connection attempt fails).
`GAPWARNINCREMENT` | Auditing pool warning increment – Specifies the percentage increment of auditing pool usage at which warning messages are issued. This definition is related to the next definition. | The valid values for this parameter will be 1 – 99. | The default value for this parameter is 10.
`GAPWARNPERCENT` | Auditing pool warning percent – Specifies the threshold percentage of auditing pool usage at which warning messages are issued. | The valid values for this definition are 1 - 99. | The default value for this parameter is zero (i.e. auditing pool warning messages will not be written).
`GAPWARNMESSAGELIMIT` | Auditing pool warning message limit – Specifies the number of auditing pool usage messages that may be written before these messages are suppressed. | The valid values for this parameter are 1 – 2,147,483,647. | The default value for this parameter is 5.
`GAPWARNINTERVAL` | Auditing pool warning message interval – Specifies the interval in seconds during which auditing pool usage warning messages are suppressed on the console. | The valid values for this parameter are 1 – 2,147,483,647. | The default value for this parameter is 60.
`SENDVIOLATION` | When the `SENDVIOLATION` parameter is set to `YES`, the ACBX and client info will be sent to the audit server when a response code in the range 200-203 is received. When it is set to `NO` or not specified (default = `NO`, no information is sent when a response code 200-203 is received. | YES or NO | NO

## File Auditing Parameters

The file auditing parameters are specified for one Adabas nucleus and are specific to one file or range of files.

The file auditing parameters are listed in the table below.

Note
These input parameters must be prefixed with `ADAANP` and are read from the file allocated to the DD name ADAANP.

Parameter | Description | Valid Values | Default
--- | --- | --- | ---
`FILE` | Denotes the start of a group of auditing parameters related to one or more files. This parameter is specified as a word standing by itself. | - | -
`FLIST` | Used to give the list of one or more files that relate to the current `FILE` definition. This parameter allows files to be listed individually or as a range. | - | -
`FSERVERID` | Server ID – Specifies the Audit Server ID to be used when data is collected for the file(s). If this parameter is not specified for the file, the global server ID is used. The server ID may not be set to the database ID associated with the currently active nucleus. | 1 - 65,535 | -
`FACCDS` | Controls the collection of the data storage image for an access command. | FIELDS|NO|YES | YES
`FACCFIELDS` | Controls the collection of auditing data for an access command based on one or more field names - This definition specifies one or more field names that control whether auditing data is collected for an access command issued for the file(s). The auditing data for an access command will only be collected if one or more of the specified fields are referenced by an access command issued for the file(s). | One or more two-character field names may be specified for this parameter. Each two-character value must be a valid Adabas field name. Field names are separated by a comma. There is no validation that the field name actually exists on the related file(s). | -
`FDELDS` | Controls the collection of the data storage image for a delete command. | FIELDS|NO|YES | YES
`FINSDS` | Controls the collection of the data storage image for an insert command. | FIELDS|NO|YES | YES
`FUPDAI` | Controls the collection of the data storage (after) image for an update command. | FIELDS|NO|YES | YES
`FUPDBI` | Collects the before image of data storage for an update command – This definition specifies whether the before image of data storage will be collected for an update command issued for the file(s). | FIELDS|NO|YES When `FIELDS` is set, the before image of data storage will be collected if one or more fields specified in the `FUPDFIELDS` parameter is referenced by an update command issued for the file(s). When `NO` is set, the before image of data storage will not be collected for an update command issued for the file(s). When `YES` is set, the before image of data storage will be collected for an update command issued for the file(s). | NO
`FUPDFIELDS` | Controls the collection of auditing data for an update command based on one or more field names – This definition specifies one or more fields that control whether auditing data will be collected for an update command issued for the file(s). The auditing data for an update command will only be collected if one or more of the specified fields are referenced by an update command issued for the file(s). | One or more two-character field names may be specified for this parameter. Each two-character value must be a valid Adabas field name. Field names are separated by a comma. There is no validation that the field name actually exists on the related file(s). | -

## Database Auditing Parameters

Database auditing definitions are defined for one nucleus and are not associated with any specific file.

The DATABASE parameter marks the beginning of a group of database auditing parameters and must be specified as a word standing by itself.

The database auditing parameters are listed in the table below.

Parameter | Description | Valid Values | Default Value
--- | --- | --- | ---
`DSERVERID` | Server ID – Specifies the Audit Server ID to be used when data is collected for Admin, DDL, and OPER functions. If this parameter is not specified for the file, the global server ID is used. The server ID may not be set to the database ID associated with the currently active nucleus. | 1 – 65,535 | -
`DADMPARM` | Controls the collection of auditing data for an administrative command or utility. | NO|YES | NO
`DDDLPARM` | Controls the collection of auditing data for an online command or utility that creates, changes, or deletes file or field structures. | NO|YES | NO
`DOPRPARM` | Controls the collection of auditing data for console operator commands. | NO|YES | NO

## Examples

This section gives an example of a set of auditing definitions.

    ADAANP GLOBAL
    ADAANP GAPWARNINCREMENT=5
    ADAANP GAPWARNINTERVAL=30
    ADAANP GAPWARNMESSAGELIMIT=50
    ADAANP GAPWARNPERCENT=75
    ADAANP GCONNECTCOUNT=10
    ADAANP GCONNECTINTERVAL=60
    ADAANP GSERVERID=2001
    *
    * A FILE example follows with every parameter specified
    *
    ADAANP FILE
    ADAANP FLIST=25
    ADAANP FACCFIELDS=’AA,AB’
    ADAANP FUPDBI=FIELDS
    ADAANP FUPDFIELDS=’BB,BC’
    *
    * A FILE example follows with a subset of parameters specified
    *
    ADAANP FILE
    ADAANP FLIST=26
    *
    ADAANP FILE
    ADAANP FLIST=20,22,300-309
    ADAANP FSERVERID=2002
    ADAANP FUPDFIELDS=’AA,BB,CC’
    ADAANP DATABASE
    ADAANP DADMPARM=YES,DDDLPARM=YES,DOPRPARM=YES

### On this page

- Global Auditing Parameters
- File Auditing Parameters
- Database Auditing Parameters
- Examples