The user needs to specify definitions for the auditing software in an
Adabas nucleus running with ADARUN AUDITING=YES
.
The auditing definitions are read from the sequential file or PDS member allocated to the DD name ADAANP (i.e. ADAbas Auditing Nucleus Parameter).
The auditing definitions are specified via parameters in the input file. The parameter syntax is the same as the parameter syntax for Adabas utilities. Input records are prefixed with 'ADAANP'.
For cluster or parallel services the auditing parameters are local and fixed for each nucleus.
The term 'local' means the parameters may be the same or different in different cluster or parallel services nuclei. The term 'fixed' means the parameters will only be read in during nucleus start-up.
There are two groups of auditing parameters:
global parameters specific to a nucleus
file parameters specific to one or more files
The term global here means the definitions are global for one nucleus. The term global here does not mean the definitions apply across cluster nuclei.
Global auditing definitions are definitions defined for one nucleus that are not specific to a file.
The parameter GLOBAL denotes the start of a group of global auditing parameters. The GLOBAL parameter is 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 – This definition 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 – This definition 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 be zero (i.e. no subsequent connection attempts will be made after a connection attempt fails). |
GAPWARNINCREMENT |
Auditing pool warning increment – This definition specifies the increment, in percent of auditing pool usage, at which auditing pool warning messages should be written. 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 – This definition specifies the threshold, in percent of auditing pool usage, at which auditing pool warning messages should be written. |
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 – This definition 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 – This definition 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. |
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 | Values | Default |
---|---|---|---|
FILE |
The |
- |
- |
FLIST |
The parameter |
- |
- |
FSERVERID |
Server ID – This definition 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 |
- |
FACCACBX |
Collect ACBX data for an access command – This definition specifies whether the ACBX data should be collected for an access command issued for the file(s). |
FIELDS|NO|YES When value 'FIELDS' is set, the ACBX will be collected if
one or more fields specified in the |
NO |
FACCINFO |
Collect client info for an access command – This definition specifies whether client info should be collected for an access command issued for the file(s). |
FIELDS|NO|YES When value 'FIELDS' is set, the client info, when
available, will be collected if one or more fields specified in the
|
NO |
FACCDS |
Collect the data storage image for an access command – This definition specifies whether a data storage image should be collected for an access command issued for the file(s). |
FIELDS|NO|YES When value 'FIELDS' is set, the data storage image will be
collected if one or more fields specified in the
|
NO |
FACCFIELDS |
Control 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) and the related parameter (i.e.
|
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). |
- |
FDELACBX |
Collect ACBX data for a delete command – This definition specifies whether the ACBX data should be collected for a delete command issued for the file(s). |
NO|YES |
NO |
FDELINFO |
Collect client info for a delete command – This definition specifies whether client info should be collected for a delete command issued for the file(s). |
NO|YES |
NO |
FDELDS |
Collect the data storage image for a delete command – This definition specifies whether the data storage image should be collected for a delete command issued for the file(s). |
NO|YES |
NO |
FINSACBX |
Collect ACBX data for an insert command – This definition specifies whether the ACBX data should be collected for an insert command issued for the file(s). |
NO|YES |
NO |
FINSINFO |
Collect client info for an insert command – This definition specifies whether client info should be collected for an insert command issued for the file(s). |
NO|YES |
NO |
FINSDS |
Collect the data storage image for an insert command – This definition specifies whether the data storage image should be collected for an insert command for the file(s). |
NO|YES |
NO |
FUPDACBX |
Collect ACBX data for an update command – This definition specifies whether the ACBX data should be collected for an update command issued for the file(s). |
FIELDS|NO|YES When value 'FIELDS' is set, the ACBX will be collected if
one or more fields specified in the |
NO |
FUPDINFO |
Collect client info for an update command – This definition specifies whether client info should be collected for an update command issued for the file(s). |
FIELDS|NO|YES When value 'FIELDS' is set, the client info, when
available, will be collected if one or more fields specified in the
|
NO |
FUPDBI |
Collect 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 value 'FIELDS' is set, the before image of data
storage will be collected if one or more fields specified in the
|
NO |
FUPDAI |
Collect the after image of data storage for an update command – This definition specifies whether the after image of data storage will be collected for an update command issued for the file(s). |
FIELDS|NO|YES When value 'FIELDS' is set, the after image of data
storage will be collected if one or more fields specified in the
|
NO |
FUPDFIELDS |
Control 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) and the related parameter (i.e.
|
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). |
- |
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 FACCACBX=YES ADAANP FACCDS=FIELDS ADAANP FACCFIELDS=’AA,AB’ ADAANP FACCINFO=NO ADAANP FDELACBX=YES ADAANP FDELINFO=YES ADAANP FDELDS=NO ADAANP FINSACBX=NO ADAANP FINSINFO=NO ADAANP FINSDS=NO ADAANP FUPDACBX=FIELDS ADAANP FUPDAI=FIELDS ADAANP FUPDBI=FIELDS ADAANP FUPDFIELDS=’BB,BC’ ADAANP FUPDINFO=FIELDS * * A FILE example follows with a subset of parameters specified * ADAANP FILE ADAANP FLIST=26 FDELACBX=YES FINSACBX=YES * ADAANP FILE ADAANP FLIST=20,22,300-309 ADAANP FSERVERID=2002 ADAANP FACCACBX=YES ADAANP FACCDS=NO ADAANP FACCINFO=NO ADAANP FUPDACBX=YES ADAANP FUPDAI=YES ADAANP FUPDFIELDS=’AA,BB,CC’