Version 4.3.2
 —  Installation and Operations for VSE/ESA  —

ADARUN Parameters

The ADARUN control statement defines and starts the Adabas operating environment. The ADARUN control statement also starts Adabas utilities.

The ADARUN parameters described in this section of the documentation apply to Adabas Review.

This document covers the following topics:


ADARUN Functions

ADARUN performs the following functions:

The ADARUN statement, normally a series of entries each specifying one or more ADARUN parameter settings, is specified in the VSE CARD dataset. For more specific job information, refer to the appropriate section of this documentation.

Top of page

ADARUN Parameter Syntax

The syntax for the ADARUN statement and parameters is:

ADARUN parameter=value,...

where parameter=value is one or more of the ADARUN parameters described in this section.

Any number of blanks is permitted between "ADARUN" and the first parameter, but no blanks are permitted within the parameter=value string. Commas (,) must be used as separators. A blank following a parameter=value entry indicates the end of the statement.

The literal "ADARUN" must be entered in positions 1-6 of each ADARUN statement. All parameter=value entries must end before position 73. Any parameter=value entries that would extend beyond position 72 must be coded on a new statement as shown below. The comma following the last parameter=value entry of a statement is optional, and is not interpreted as a continuation character. Positions 73-80 are ignored. An asterisk (*) in position 1 indicates a user comment line.

The following example summarizes the ADARUN statement format. The first statement cannot continue beyond position 72. The second statement represents a continuation of the first statement. All ADARUN continuation statements have the same format and restrictions as the first statement.

Positions 1-6 Positions 8-72
"ADARUN" parameter=value,parameter=value,...
"ADARUN" parameter=value,...

The ADARUN parameters are summarized in the following table, and described in detail in the section following the table.

Unless noted otherwise, each parameter has a default value that ADARUN uses if the parameter is not specified.

Some parameter names can be abbreviated. The minimum acceptable abbreviation for a given parameter is shown in the following table by the underlined part of the parameter name. Parameter names shown without underlining cannot be abbreviated.

Top of page

ADARUN Parameters

PROGRAM: Program to Be Executed

Parameter Use Possible Values Default
PRO GRAM Specify the program to be executed. ADANUC | ADAREV USER

This parameter specifies the program to execute: the Adabas nucleus (ADANUC) for the interface installation or Adabas Review (ADAREV) for the hub installation.

REVIEW: Adabas Review Hub ID

Parameter Use Possible Values Default
REV IEW Enable Adabas Review in local or hub mode specifying the hub ID, if applicable. NO | LOCA L | dbid NO

Note:
REVIEW replaces the ADARUN parameter REVIEWHUBID introduced in Adabas version 6; however, REVIEWHUBID remains a synonym for REVIEW.

REVIEW controls the use of the Adabas Review product:

Value Meaning
NO The default setting. Adabas Review is not started.
LOCA L Adabas Review is started in local mode running in the Adabas address space as an extension of ADALOG.

Note:
Adabas Review no longer runs as a user exit 4.

dbid Adabas Review is started in hub mode. The physical database ID that you specify for the hub identifies
  • the hub (server) itself (with PROGRAM=ADAREV) that is being started; or

  • from an Adabas nucleus (client), the hub that is the target for Adabas Review processing for that nucleus (with PROGRAM=ADANUC).

Note:
Adabas Review version 4.3 supports 2-byte DBIDs for databases being monitored and for the hub ID itself.

Example

For the Adabas Review hub (server) installation, start hub 202.

ADARUN PROGRAM=ADAREV,REVIEW=202

For the Adabas Review (client) installation, start the Adabas nucleus that will log to Adabas Review hub 202.

ADARUN PROGRAM=ADANUC,REVIEW=202

CT: Command Timeout Limit

When you are running Adabas Review in hub mode, Software AG recommends that you set the ADARUN CT parameter as low as possible.

Parameter Use Minimum Maximum Default
CT Set the maximum time for interregion communication of results from Adabas to user. 1 16 777 215 60

The maximum number of seconds (more precisely, units of 1.048576 seconds) that can elapse from the time an Adabas command has been completed until the results are returned to the user through the interregion communication (operating-system-dependent).

This parameter is used to prevent a command queue element and attached buffer from being held for a long period of time for a user who has terminated abnormally.

Possible causes of a command timeout are:

If the CT limit is exceeded:

Note:
This parameter should not be confused with the non-activity (TNAA, TNAE, TNAX) and transaction time limit (TT) parameters, which are based on user activity.

Example

Permit about 5 seconds to obtain a result through interregion communication.

ADARUN PROG=ADAREV,CT=5

FORCE: Allow Database ID Table Entry Overwrite

Parameter Use Possible Values Default
FO RCE Specify whether an Adabas Review hub can overwrite an existing ID table entry. YES | NO NO

A hub is not allowed to start if an ID table entry already exists for it. When an Adabas Review hub starts up, ADARUN scans the ID table to ensure that no entry exists.

The ID table entry is derived from the Review hub ID and the job name. Normally, the ID table entry is deleted when the hub terminates.

The FORCE parameter allows the hub to overwrite the existing ID table entry and start. FORCE=YES is required when restarting a session that terminated abnormally with an ADAM98 message. In this case, the ID table still contains an active entry for the hub.

Value Meaning
YES The hub that is starting can overwrite an existing ID table entry.
NO The default setting. If the ID table contains an entry for the hub that is starting, the hub is not allowed to start.

Overwriting the existing entry by specifying FORCE=YES

Warning:
Do not use the FORCE parameter unless absolutely necessary. Ensure that no hub is active for the ID table entry being overwritten.

Example

If the ID table contains an active entry for Review hub 27, overwrite the entry.

ADARUN PROG=ADAREV,FORCE=YES,REVIEW=27

NAB: Number of Attached Buffers

Parameter Use Minimum Maximum Default
NA B Specify the number of attached buffers to be used. 0 500,000 16

An attached buffer is an internal buffer used for interregion communication. An attached buffer is required in all Adabas Review hub environments.

The Adabas Review hub allocates an attached buffer pool with a size equal to the value of NAB multiplied by 4096 bytes. You may specify as many attached buffers as fit into the available virtual storage.

In environments running in 31-bit addressing mode, the attached buffer pool space is allocated above the 16-MB line.

Example

Run the Adabas Review hub with 10,000 attached buffers.

ADARUN PROG=ADAREV,NAB=10000

NC: Number of Command Queue Elements

Parameter Use Minimum Maximum Default
NC Set the maximum number of command queue elements. 20 32 767 200

The number of command queue elements to be established for the Adabas Review hub. This number determines the maximum number of command logs that may be queued and/or be in process at any one time in the Adabas Review hub.

Each command log is assigned a command queue element. The command queue element is released when the log record has been processed.

192 bytes are required for each command queue element.

Example

Run the Adabas Review hub with a maximum of 5000 elements in the command queue.

ADARUN PROG=ADAREV,NC=5000

SVC: Supervisory Call Number

Parameter Use Possible Values Default
S VC Specify the Adabas SVC number to be used for the Adabas Review hub. see text 45

The SVC number is specified as an integer. It must correspond to the number used for the Adabas SVC at your installation.

If the SVC parameter is not specified, the default value is taken from the Adalink being used. The Adalink is delivered with the value 45.

The Adabas SVC is used to perform various Adabas internal functions under VSE/ESA. It is also used to connect the Adabas Review hub to the client Adabas nuclei.

For VSE/ESA, any free SVC value can be used. See the Adabas Installation Documentation (VSE/ESA) for information about finding free VSE/ESA Adabas SVC values.

Example

Execute an Adabas Review hub under VSE/ESA using SVC 46 for the Adabas SVC.

ADARUN PROG=ADAREV,SVC=46

Top of page