Installation for z/OS

Be sure your system meets the requirements described in the section System Requirements above.

To install Adabas Auditing, complete the following steps:

Note:
The steps in this section will allow you to install Adabas Auditing, but they will not implement or start Auditing. How Auditing is implemented varies by site, but additional implementation and activation steps are described in the sections Activate Auditing for Application Files and Activating Auditing for TP Monitors.


Step 1. Install the Adabas Audit Load Modules

Install the Auditing load modules by concatenating the delivered load library in sequence or copying the modules to the library used for running the Adabas nucleus and utilities. The Adabas Audit load modules can be found in ALAvrs.LOAD.

Step 2. Apply Necessary Zaps

If they are provided, apply any necessary zaps, as described in the $README file on the ALAvrs.MVSZAPS library and in any subsequent ALAvrs.MVSZnnn data sets.

Step 3. Check, Prepare, and Install the Product License File

You must install a valid license file on all mainframe platforms in which your Software AG mainframe product is installed. The license file is provided as an XML document encoded in US-ASCII. It must remain in that format even on the mainframe and must not be modified. Any modification of the license file will invalidate the digital signature and the license check will fail. In the event of a check failure, please contact your Software AG technical support representative.

For a full product list of license file names, load modules and DD/Link names, refer to the Adabas Installation documentation.

Note:
Thirty days before the license expires, you will receive license check failure messages. Your software product will still function, but these messages warn you that it is time to obtain a new license.

In this step you will prepare the license file, and then install it:

Preparing the Product License File

The product license file is supplied on the individual customer installation tape or separately via an e-mail attachment. Before you can install the license, you must transfer it from e-mail or the installation tape and store it on a z/OS system. This section describes how to do this for a license distributed either by e-mail or on the installation tape.

Start of instruction setTo prepare the license file from an e-mail attachment, complete the following steps:

  1. Transfer the license to z/OS, as described in the Adabas for Mainframes documentation > Software AG Mainframe Product Licensing > Transferring a License File from PC to a z/OS Host Using FTP.

  2. Verify that the transferred license file is stored in an Adabas source library (with RECFM=F or RECFM=FB and LRECL=80), making sure to preserve its format as ASCII.

Start of instruction setTo prepare the license file from the installation tape, complete the following step:

  • Verify that the license file is stored in an Adabas source library (with RECFM=F or RECFM=FB and LRECL=80), making sure to preserve its format as ASCII.

Installing the Product License File

Once the license file has been prepared, you can install it in one of two ways:

  • Convert the license to a load module (ALALIC) that is then loaded by the Adabas Audit Server.

  • Reference the license file in the Adabas Audit Server start-up job by DD statement.

This section describes both methods.

Start of instruction setTo convert the license file to a load module, complete the following steps:

  1. Review and modify sample job ASMLICAM in the Adabas JOBS library, as follows:

    • Set the variable MLCLOAD to point to the license load library (MLCvrs.LOAD).

      Note:
      Version 136 or higher of the license load library is required for the Adabas Audit Server and Adabas nucleus to execute correctly.

    • Set the variable USRLOAD to point to an appropriate user load library.

      Note:
      This user load library must also be included in the STEPLIB concatenation for the Adabas Audit Server.

    • Set the LICFILE parameter to point to the data set containing the Adabas Audit Server license file you transferred to z/OS earlier.

    • Set the LMOD parameter to the load module name ALALIC.

  2. Submit the sample job ASMLICAM. This job runs the MAKE function of the LICUTIL utility to convert the license text file to an assembler source module. ASMLICAM then links and assembles the assembler source to generate a load module called ALALIC which is stored in the specified user load library (USRLOAD). For more information about the LICUTIL utility, read the Adabas for Mainframes documentation > Software AG Mainframe Product Licensing > Using The License Utility: LICUTIL.

  3. Update your Adabas Audit Server start-up job to reference the user load library so ALALIC will be loaded by the Adabas Audit Server, as described in Step 8: Set Up the Adabas Audit Server Start-up JCL.

Start of instruction setTo reference the license file in the Adabas Audit Server start-up job, complete the following steps:

  1. Make sure any previously created ALALIC load module is inaccessible to the Adabas load library being used by your Adabas Audit Server job. The Audit Server first tries to load ALALIC and, and if unsuccessful, it reads from a dataset defined to the DD statement DDLALA.

  2. Update your Adabas Audit Server start-up jobs to reference the license, as described in Step 8: Set Up the Adabas Audit Server JCL.

Step 4. Allocate and Format the Adabas Audit Server

Create a database to use as your Audit Server. Refer to Reference > Utilities Used with Adabas Auditing > ADADEF MODIFY AUDITSERVER Function or ADADEF DEFINE AUDITSERVER Function for an explanation of the parameters used for defining an Audit Server.

Note:
User application files should not be loaded on the Adabas Audit Server.

Step 5. Load the Auditing System File

To use Adabas Auditing and customize its processing, you must supply various Auditing definitions.

You maintain your Auditing definitions in the Auditing system file using the Adabas Auditing Configuration. The Adabas Auditing Configuration is an online interface that must be loaded into Natural before you can use it. Access to the Adabas Auditing Configuration is then available through Natural. For more information, refer to the Adabas Auditing Configuration chapter.

To maintain your Auditing definitions in the Auditing system file, you must first load the Auditing system file on the Adabas Audit Server.

Start of instruction setTo load an Auditing system file on the Adabas Audit Server:

  1. Use the ADALOD utility. A sample ADALOD utility job is provided in member ADALODSF of the ALAvrs.JOBS data set. Refer to Reference > Utilities Used with Adabas Auditing > ADALOD LOAD Parameters for the Adabas Audit Server for an explanation of the parameters used for loading the Auditing system file. You need to specify the AUDITING parameter on the ADALOD LOAD function:

    ADALOD LOAD FILE=nnnn,AUDITING

    where nnnn is the number of the Auditing system file.

    You have to also specify the supplied Auditing system file dataset ALAvrs.SYSF on the DDEBAND input DD name.

  2. Do either of the following in Natural to identify the physical database file to be associated with the system file:

    • Run a Natural NTLFILE macro for the file. For complete information, refer to Software AG's Empower web site > Natural for Mainframes > Natural LFILE parameter documentation.

    • When you start the Adabas Auditing Configuration ensure an LFILE parameter is specified either as a dynamic parameter or inside a Natural SYSPARM profile.

Regardless of which method you use, the LFILE setting should be:

LFILE=(89,dbid,file)

where dbid is the database ID of the Adabas Audit Server you created during installation and file is the Auditing system file you have loaded using ADALOD.

Step 6. (Optional) Load an SLOG System File

If you intend to use the subscription logging (SLOG) facility, you will need an Auditing SLOG system file which is an Adabas system file on the Adabas Audit Server. Refer to the Operations chapter > Using the Subscription Logging Facility > Setting up Subscription Logging for an explanation of how to set up the Auditing SLOG facility.

Step 7. Load the Adabas Auditing Configuration

Adabas Auditing Configuration is used to create and maintain Auditing definitions in the Auditing system file. You have to load it into Natural. To do this, use Natural's INPL utility to load the ALAvrs.INPL data set (and any supplied ALAvrs.IXnn updates) into the Natural system file libraries.

Step 8. Set Up the Adabas Audit Server Start-up JCL

Set up the start-up JCL and parameters for the Adabas Audit Server job. Use the JCL for an existing Adabas nucleus as a starting point for creating the Audit Server JCL. A sample Audit Server start-up job is provided in member ADANUC2 of the ALAvrs.JOBS data set.

Note the specification of the required Audit Log datasets DDALOGRn and the Audit Error dataset DDAUDERR as shown in the ADANUC2 member.

If the DDAUDERR file is directed to a dataset it will be given the DCB attributes RECFM=FB, LRECL=80. Messages on DDAUDERR are formatted similarly to a multi-line WTO: the message number and DBID appear on only the first line of the message. Each line is prefixed with the Julian date and local time.

Refer to the Reference chapter > Pertinent ADARUN Parameters for Auditing for an explanation of the ADARUN parameters necessary for successful operation of Adabas Audit Server. Recommended values for some ADARUN parameters are as follows:

  1. Set ADARUN parameter LAP to the size of the Auditing buffer. For performance reasons Software AG recommends setting LAP to a relatively large value (e.g. LAP=40M).

  2. Set ADARUN parameter LU to 167,000 or greater.

  3. Set ADARUN parameter NAB to a value greater than or equal to:

    41 * 10 * the-number-of-Adabas-nuclei-sending-data-to-the-Adabas-Audit-Server

    For example, if one Adabas nucleus will be sending data to the Adabas Audit Server, set the NAB parameter greater than or equal to 410 (for example NAB=420).

  4. Set ADARUN parameter NT to a value greater than or equal to 15.

You must also make the following license-related modifications:

  • Software AG licensing requires that the modules LICMAIN and LICUTIL be loaded when your Audit Server starts up. These modules are distributed in the MLCvrs.LOAD library. You must either:

    • Copy LICMAIN and LICUTIL into ALAvrs.LOAD or

    • Concatenate MLCvrs.LOAD with ALAvrs.LOAD.

  • Verify that the appropriate product license file is correctly referenced in the Audit Server job. Do either of the following:

    • Verify that the license load module installed in Step 3: Check, Prepare, and Install the Product License File is stored in a load library that is accessible to the Audit Server job. Add the user load library in which the license load module resides to the STEPLIB concatenation of the Audit Server job or copy the licensing module into ALAvrs.LOAD or

    • Verify that there is no ALALIC module accessible to the Audit server job and that the following DD statement is included in the Audit Server job:

      //DDLALA   DD  DISP=SHR,DSN=dsn

      where dsn is the data set name of the license file loaded from the tape in ASCII format. Note that dsn could reference a member in a partitioned data set.

    Note:
    Adabas first tries to load the license load module ALALIC and, and if unsuccessful, it reads from the DDLALA data set.

Step 9. Start the Adabas Audit Server

Run the Adabas Audit Server job you set up in the previous step. A sample Audit Server job is provided in member ADANUC2 of the ALAvrs.JOBS data set.