This section describes an alternative means of installing Adabas Auditing using z/OSMF workflows.
Before starting, be sure your system meets the requirements described in the section System Requirements.
To install Adabas Auditing using z/OSMF workflows, complete the following Preliminary Installation Steps and Workflow Installation Steps.
Note
The steps in these sections will allow you to install Adabas Auditing but how Auditing
is implemented varies by site. Additional implementation and activation steps are described
in the sections Activate Auditing for Application
Files and Activating Auditing for TP
Monitors.
Refer to About the Installation Tape for
information on the Adabas Auditing data sets delivered and a sample job to copy them to
disk. The Adabas Auditing load modules are delivered in
ALAvrs.LOAD.
If provided, apply any necessary zaps as described in the $README
file on the ALAvrs.ZAPS library and in any
subsequent
ALAvrs.Znnn data
sets.
Verify the availability of your Adabas Auditing license file and refer, as necessary,
to the Installation and License section of your current Adabas for Mainframes release
notes for information on how to prepare the license file in a sequential data set of
RECFM=FB and LRECL=80. The workflow installation will
require that the name of this sequential data set is defined to the
DSN-ALA-LICS variable in Workflow Step 2. Auditing.
The Adabas Audit Server requires an Adabas license. The workflow installation assumes
that an Adabas license load module ADALIC resides in the data set identified by the
DSN-ADA-USER-LOAD variable in Workflow Step 3. Adabas.
If this is not the case, the start-up procedure for the Adabas Audit Server (see Workflow Step 11. Setup nucleus) must be modified to make an ADALIC license module available via the STEPLIB concatenation or to specify the data set name of an XML license file using the DDLIC DD statement.
The Adabas Auditing z/OSMF workflow files can be downloaded from the Software Download Center in Empower. Log in to Empower, expand Products & Documentation on the left and select Download Products to access the Software Download Center.
The Adabas Auditing z/OSMF workflow files consist of:
| File Name | Contains |
|---|---|
| ALAvrs-install.xml | Workflow definition file |
| ALAvrs.install.properties | Workflow variable input file |
Transfer the workflow definition file
ALAvrs-install.xml and the workflow variable
input file ALAvrs-install.properties to the UNIX
System Services filesystem or a partitioned data set (RECFM=FB and
LRECL=1024), ensuring that the files are stored in EBCDIC (IBM-1047)
format.
Refer to the IBM z/OSMF documentation for information on how to use the z/OSMF Workflows task (not the Workflows Editor), available from the z/OSMF desktop, to create a workflow by importing the Adabas Auditing workflow files listed above.
By default, the name of the imported Workflow will be Adabas Auditing
v.r.s.
After successfully completing the Preliminary Installation Steps, use the z/OSMF Workflows page in the z/OSMF Workflows task to view and manage the imported Adabas Auditing workflow.
From the z/OSMF Workflows page, select and open the Adabas Auditing workflow to display the workflow Steps page. This page lists all the workflow steps necessary to install Adabas Auditing.
Each step is executed by clicking on the step name and selecting the tab. Depending on the step’s function, execution of the step may require values to be assigned to specific variables (for use by the current step and/or subsequent steps), and confirmation of correctly generated JCL.
Progress through the workflow steps by executing each step in order, detailed information regarding each of the workflow steps is provided below.
This step configures the default data set names for Adabas Auditing, Adabas, Mainframe License Check utility, and Natural.
Select the tab to define values for the following variables:
| Variable Name | Description | Default Value |
|---|---|---|
LIB-GROUP |
The High-Level Qualifier for the Adabas Auditing data sets created in Preliminary Installation Step 1. | SAGLIB |
VER-ADA |
The version of Adabas installed on your system in ADAvrs format. | ADAvrs |
VER-ALA |
The version of Adabas Auditing being installed in ALAvrs format. | ALAvrs |
VER-MLC |
The version of the Mainframe License Check utility installed on your system in MLCvrs format. | MLCvrs |
VER-NAT |
The version of Natural installed on your system in NATvrs format. | NATvrs |
On completion, this workflow step will generate the default data set names for the ADA, ALA, MLC and NAT product libraries installed on your system by concatenating LIB-GROUP with VER-ADA, VER-ALA, VER-MLC and VER-NAT respectively.
Note
If your site does not follow this naming convention, the generated product data set
names can be subsequently modified in Workflow Steps 2, 3 and 4.
This step enables you to confirm, and optionally modify, the names of the Adabas Auditing data sets generated by Workflow Step 1. Product data sets.
Select the tab to display the relevant variable names and their corresponding generated default data set names as described by the following table:
| Variable Name | Description | Generated Default Data Set Name |
|---|---|---|
DSN-ALA-SYSF |
The Adabas Auditing system file. | <LIB-GROUP>.<VER-ALA>.SYSF |
DSN-ALA-LOAD |
The Adabas Auditing LOAD library. | <LIB-GROUP>.<VER-ALA>.LOAD |
DSN-ALA-INPL |
The Adabas Auditing INPL. | <LIB-GROUP>.<VER-ALA>.INPL |
DSN-ALA-LICS |
The Adabas Auditing license file sequential data set. | <LIB-GROUP>.<VER-ALA>.LICS |
DSN-ALA-ISNN |
* Adabas Auditing INPL update, if any. | None |
* The DSN-ALA-ISNN variable is optional. If the installation media
contained INPL updates, specify the name of the highest numbered INPL update data set,
otherwise leave the field blank.
Before completing this workflow step, ensure the specified data set names are correct for your system, if not, modify them accordingly.
This step enables you to confirm, and optionally modify, the names of the Adabas data sets generated by Workflow Step 1. Product data sets.
Select the tab to display the relevant variable names and their corresponding generated default data set names as described by the following table:
| Variable Name | Description | Generated Default Data Set Name |
|---|---|---|
DSN-ADA-LOAD |
The Adabas LOAD library. | <LIB-GROUP>.<VER-ADA>.LOAD |
DSN-ADA-SRCE |
The Adabas SRCE library. | <LIB-GROUP>.<VER-ADA>.SRCE |
DSN-ADA-USER-LOAD |
The LOAD library where the Adabas license load module ADALIC resides. | <LIB-GROUP>.ADA.LOAD |
DSN-MLC-LOAD |
The Mainframe License Check load library. | <LIB-GROUP>.<VER-MLC>.LOAD |
Before completing this workflow step, ensure the specified data set names are correct for your system, if not, modify them accordingly.
This step enables you to confirm, and optionally modify, the name of the Natural data set generated by Workflow Step 1. Product data sets and, in addition, define the Natural environment for use by Workflow Step 16. Natural INPL.
Select the tab to display the relevant variable names and their corresponding values as described by the following table:
| Variable Name | Description | Default Value |
|---|---|---|
DSN-NAT-LOAD |
The Natural LOAD library. | <LIB-GROUP>.<VER-NAT>.LOAD |
NAT-PGM |
The batch Natural program name. | NATBAT |
NAT-PRM |
* The batch Natural parameters. | None |
* The NAT-PRM variable can be used to pass parameters to Natural. The
value specified will be passed instream as the CMPRMIN DD input. If no parameters are
required, leave the field blank.
Before completing this workflow step, ensure the specified values are correct for your system, if not, modify them accordingly.
This step enables you to define the necessary z/OS system libraries for use by subsequent workflow steps.
Select the tab to display the relevant variable names and their corresponding values as described by the following table:
| Variable Name | Description | Default Value |
|---|---|---|
DSN-USERPROCLIB |
Location for the Adabas Audit Server start-up procedure used by Workflow Step 11. Setup nucleus. | None |
DSN-SYSMACLIB |
System macro library. | SYS1.MACLIB |
DSN-SCEELKED |
Language edition routines. | SYS1.CEE.SCEELKED |
Before completing this workflow step, ensure the specified values are correct for your system, if not, modify them accordingly.
This step will create the Adabas Auditing user load and source libraries using variables defined in Workflow Step 1. Product data sets.
Select the tab to display the relevant variable names and their corresponding values as described by the following table:
| Variable Name | Description | Default Value |
|---|---|---|
LIB-GROUP-UNIT |
The device unit type to be used (UNIT=). | SYSALLDA |
LIB-GROUP-VOLSER |
(optional) The device name to be used (VOL=SER=). | None |
DSN-ALA-USER-LOAD |
The LOAD library to be used for storing the Adabas Auditing license load module ALALIC (Workflow Step 7. Prepare license key) and the audit-enabled Adabas link routines (Workflow Step 15. Assemble link routines). | <LIB-GROUP>.ALA.LOAD |
DSN-ALA-USER-SRCE |
The SRCE library to be used in the preparation of the license key (Workflow Step 7. Prepare license key), the storing of the LINKGBLS definitions (Workflow Step 15. Assemble link routines) and the location for the Adabas Audit Server configuration parameters (Workflow Step 11. Setup nucleus). | <LIB-GROUP>.ALA.SRCE |
Throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step will create the Adabas Auditing license load module ALALIC.
Select the tab to display the relevant variable names and their corresponding values as described by the following table:
| Variable Name | Description | Default Value |
|---|---|---|
DSN-ALA-LICS |
The Adabas Auditing license file sequential data set. | As defined in Workflow Step 2. Auditing. |
VER-ALA-LIC |
The Adabas Auditing license version. | ALAv.r |
The Mainframe License Check utility will be used to convert the license file defined to
the variable DSN-ALA-LICS in Workflow Step 2. Auditing to the load
module ALALIC stored in the library defined to the variable
DSN-ALA-USER-LOAD in Workflow Step 6. Create user
libraries.
Throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step will run the Adabas utilities ADAFRM and ADADEF to create the Adabas Auditing container files and define them as an Adabas Audit Server.
Select the tab to display the relevant variable names and their corresponding values as described by the following table:
| Variable Name | Description | Default Value |
|---|---|---|
DB-ID |
The Database ID to be defined to the Audit Server. | None |
DB-SVC |
The number of the Adabas SVC. | None |
DB-DSN-PREFIX |
The prefix to be used for the Audit Server container files. | SAG.ADABAS |
DB-DEVICE |
The device unit type to be used (UNIT=). | 3390 |
DB-VOL |
The device name to be used (VOL=SER=). | None |
The DB-DSN-PREFIX value will be combined with the DB-ID value
to provide the prefix used for the container file data sets. For example, the default
container file data set prefix will be
SAG.ADABAS.DBnnnnn where
nnnnn is the value defined to the variable
DB-ID.
Throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step will run the Adabas utility ADALOD to load the Adabas Auditing system file into the Audit Server container files created by Workflow Step 8. Define and format server.
Select the tab to display the relevant variable names and their corresponding values as described by the following table:
| Variable Name | Description | Default Value |
|---|---|---|
FNR-SYSF |
The File Number to be used for the Adabas Auditing system file in the Audit Server. | None |
DSN-ALA-SYSF |
The Adabas Auditing system file. | As defined in Workflow Step 2. Auditing. |
Throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step will run the Adabas utility ADALOD to load the SLOG system file into the Audit Server container files created by Workflow Step 8. Define and format server.
Select the tab to display the relevant variable names and their default values as described by the following table:
| Variable Name | Description | Default Value |
|---|---|---|
FNR-SLOG |
The File Number to be used for the SLOG file in the Audit Server. | None |
For information about the SLOG system file refer to Using the Auditing Subscription Logging (SLOG) Facility.
Throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step will establish a procedure for starting the Adabas Audit Server.
Select the tab to begin the setup process.
The setup of the Audit Server nucleus follows the conventions used by System Maintenance Aid. The configuration members for the Audit Server and the procedure for the started task are based on the same templates used for an Adabas nucleus.
The start-up procedure for the Audit Server will be placed in member
NUCnnnnn in the data set defined to the
variable DSN-USERPROCLIB in Workflow Step 5. System.
The Audit Server ADARUN parameters will be placed in member
PRnnnnn in the data set defined to the
variable DSN-ALA-USER-SRCE in Workflow Step 6. Create user libraries.
Where nnnnn is the value defined to the variable
DB-ID in Workflow Step 8.
Define and format server.
Throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step will APF authorize the load libraries used by the Adabas Audit Server.
Select the tab to begin the APF authorization process.
The table below identifies those libraries in the STEPLIB concatenation of the Audit Server start-up procedure which must be APF authorized:
| Variable Name | Description | Value |
|---|---|---|
DSN-ALA-USER-LOAD |
The LOAD library to be used for storing the Adabas Auditing license load module ALALIC. | As defined in Workflow Step 6. Create user libraries. |
DSN-ALA-LOAD |
The Adabas Auditing LOAD library. | As defined in Workflow Step 2. Auditing. |
DSN-ADA-USER-LOAD |
The LOAD library where the Adabas license load module ADALIC resides. | As defined in Workflow Step 3. Adabas. |
DSN-ADA-LOAD |
The Adabas LOAD library. | As defined in Workflow Step 3. Adabas. |
DSN-MLC-LOAD |
The Mainframe License Check load library. | As defined in Workflow Step 3. Adabas. |
This workflow step uses the SETPROG APF command to add the required libraries to your dynamic APF list.
If your site uses a static APF list, or you wish these libraries to maintain their AFP authorization across IPLs, we recommend you discuss these requirements with your systems programmer. Under these circumstances, after the libraries have been added, use the ‘Override Complete’ option to mark this step as complete.
Otherwise, throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step will start the Adabas Audit Server using the procedure established in Workflow Step 11. Setup nucleus.
Select the tab to begin the process of starting the Adabas Audit Server.
Throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step will check the Adabas Audit Server is active by using the Adabas utility
ADADBS to issue an OPERCOM DAUDPARM command to display the
audit parameters in use.
Select the tab to begin the process of checking the Adabas Audit Server is active.
Throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step uses instream LGBLSET parameters (including
AUDIT=YES) to assemble the Adabas link globals table and
re-link the Adabas link modules with the appropriate Adabas Auditing stub modules.
Select the tab to begin the process of building the audit-enabled Adabas link modules.
The following table describes the variables used in this step:
| Variable Name | Description | Value |
|---|---|---|
DSN-ALA-USER-SRCE |
The SRCE library used for storing the instream
LGBLSET parameters.
|
As defined in Workflow Step 6. Create user libraries. |
DSN-ALA-USER-LOAD |
The LOAD library used for storing assembled objects and linked load modules. | As defined in Workflow Step 6. Create user libraries. |
DSN-ALA-LOAD |
The Adabas Auditing LOAD library. | As defined in Workflow Step 2. Auditing. |
DSN-ADA-SRCE |
The Adabas SRCE library. | As defined in Workflow Step 3. Adabas. |
DSN-ADA-LOAD |
The Adabas LOAD library. | As defined in Workflow Step 3. Adabas. |
First, the instream LGBLSET parameters are copied to members
LNKGBLBA (for Batch), LNKGBLTS (for TSO) and LNKGBLCO (for Com-Plete) in the library
defined to the variable DSN-ALA-USER-SRCE.
Next, these parameter members are assembled to objects of the same name in the library
defined to the variable DSN-ALA-USER-LOAD. These objects
are then linked with the appropriate Adabas Auditing stub module EABXMVS (for Batch and
TSO) and EABXCOM (for Com-Plete).
Finally, these LNKGBL* load modules are linked again to create the Adabas link modules ADALNK (for batch), ADALNKTS (for TSO), ADALCO (for Com-Plete), and ADALNKR (for re-entrant Batch).
Note
The Adabas Auditing z/OSMF workflow does not currently support the installation of
Adabas Auditing under CICS.
Throughout the execution of this step, ensure any variable values are set appropriately
for your system, check the instream LGBLSET parameters and review
any generated JCL. If necessary, modify accordingly.
For additional information, including installing Adabas Auditing under CICS, refer to Activating Auditing for TP Monitors.
This step will load the Adabas Auditing INPL.
Select the tab to display the relevant variable names and their corresponding values as described by the following table:
| Variable Name | Description | Default Value |
|---|---|---|
DSN-ALA-INPL |
The Adabas Auditing INPL. | As defined in Workflow Step 2. Auditing. |
DSN-ALA-ISNN |
Adabas Auditing INPL update, if any. | As defined in Workflow Step 2. Auditing. |
In addition, the following variables are also used in this step:
| Variable Name | Description | Default Value |
|---|---|---|
DSN-NAT-LOAD |
The Natural LOAD library. | As defined in Workflow Step 4. Natural. |
NAT-PGM |
The batch Natural program name. | As defined in Workflow Step 4. Natural. |
NAT-PRM |
The batch Natural parameters, if any. | As defined in Workflow Step 4. Natural. |
DSN-ADA-LOAD |
The Adabas LOAD library. | As defined in Workflow Step 3. Adabas. |
Throughout the execution of this step, ensure any variable values are set appropriately for your system and review any generated JCL. If necessary, modify accordingly.
This step provides instructions to enable auditing in an Adabas database and activate auditing for an Adabas file.
Select the tab to display the relevant variable names and their default values as described by the following table:
| Variable Name | Description | Default Value |
|---|---|---|
ADA-DB-ID |
The Adabas database number where auditing is to be enabled. | None |
ADA-FNR |
The Adabas file number to be activated for auditing. | None |
ADA-AUDITNM |
The Audit name to be assigned to the Adabas file identified by variable
ADA-FNR.
|
None |
Modify these values accordingly and continue with the workflow step, following the instructions to enable and activate auditing for an Adabas file.
These instructions are applicable to an Adabas installation made with System
Maintenance Aid. If this is not applicable for your site, incorporate the changes listed
for the nucleus whose database number is defined by variable ADA-DB-ID.
For additional information, refer to the section Activating Auditing for Application Files.
