ADARUN Parameters

#### Search Results

Search

# ADARUN Parameters

The ADARUN function is used to invoke Entire Net-Work. ADARUN invokes the Entire Net-Work control program and:

- loads the module ADAIOR, which performs all operating system-dependent functions;

- reads and interprets all ADARUN parameter statements;

- loads the modules needed to execute the functions specified by the ADARUN parameters;

- performs any necessary modifications to those load modules, based on the specified parameters;

- passes control to Entire Net-Work.

ADARUN parameters are fully described in the Operations section of your Adabas documentation.

This section covers the following topics:

- Specifying ADARUN Parameters

- CT Parameter: Command Timeout Limit

- FORCE Parameter: Allow Nucleus Database ID or Review Hub Table Entry Overwrite

- LU Parameter: Length of Intermediate User Buffer Area

- NAB Parameter: Number of Attached Buffers

- NC Parameter: Number of Command Queue Elements

- PROGRAM Parameter: Program to Run

- SVC Parameter: SVC Number

- TARGETID Parameter: Entire Net-Work Target ID

- TCPURL Parameter: TCP/IP Universal Resource Locator

- ZIIP Parameter: Activate Usage of Adabas for zIIP

- Example

## Specifying ADARUN Parameters

When specifying ADARUN parameters:

- Ensure that the correct program to be executed is specified (see the PROGRAM parameter);

- Ensure that the correct target ID is specified (see the TARGETID parameter); and

- Determine which settings for the following parameters are applicable for the session:

  - FORCE (overwrite active target ID)

  - SVC (Adabas SVC number)

Each ADARUN parameter has a default value that ADARUN uses if the parameter is not explicitly specified. Parameters can be abbreviated, but the abbreviation must be unique; that is, not the same as those of other ADARUN parameters.

The Entire Net-Work session statistics can be used to determine the best settings for each parameter. The statistics can be displayed using Entire Net-Work operator commands during the session; they are also printed automatically at the end of a session.

The syntax of ADARUN parameters is:

ADARUN parameters must:

- Contain the word "ADARUN" in positions 1-6, followed by `parameter=value` strings of one or more entries;

- Have one or more blanks, beginning in position 7, between "ADARUN" and the first `parameter=value` string; and

- Not extend beyond position 72 of a line.

ADARUN parameters may contain multiple lines. Each line must be specified as a separate parameter according to the rules above.

ADARUN parameters are fully described in your Adabas operations documentation.

## CT Parameter: Command Timeout Limit

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
CT | the maximum time (seconds) for interregion communication of results from Adabas to the user. | 1 | 2147483647 | 60

For Adabas Review, this is the maximum number of seconds (more precisely, units of 1.048576 seconds) that can elapse from the time an Adabas Review hub 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

- user region is swapped out or cannot be dispatched;

- user is canceled;

- user has low priority in high activity system.

If the CT limit is exceeded,

- the command queue element and attached buffer are released;

- a message ADAM93 is printed; and

- if the user has not terminated, response code 254 (ADARSP254) is returned to the user program.

#### Example

The following example permits about 30 seconds to obtain a result through interregion communication from the Adabas Review hub

    ADARUN PROG=ADAREV,CT=30

## FORCE Parameter: Allow Nucleus Database ID or Review Hub Table Entry Overwrite

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
FORCE | whether the nucleus or Adabas Review hub can overwrite an existing ID table entry. | YES | NO | NO

If running Adabas Review, this indicates whether the Adabas Review hub can overwrite an existing ID table entry. When a Review hub starts up, ADARUN scans the ID table to ensure that no entry exists for the Review hub. You can use the FORCE parameter to indicate whether the Review hub can overwrite an existing ID table entry.

The ID table entry is derived from the database ID and the job name. For Adabas Review, the ID table entry is derived from the Review hub ID (REVIEW=). The ID table entry is deleted when the nucleus terminates normally.

The FORCE parameter allows the nucleus or Adabas Review hub to overwrite the existing ID table entry and access the database.

| Warning: Do not use the FORCE parameter unless absolutely necessary, or the integrity of the database could be lost. Ensure that no nucleus or Review hub is active for the ID table entry being overwritten.

Value | Meaning
--- | ---
YES | The nucleus or Adabas Review hub that is starting can overwrite an existing ID table entry. 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 nucleus or Review hub. Overwriting the existing entry by specifying FORCE=YES prevents further communication to the overwritten nucleus or hub and causes loss of cross-memory environment resources, which cannot be restored until the next IPL.
NO | (default) If the ID table contains an entry for the nucleus or Adabas Review hub that is starting, the nucleus is denied access to the database or the Review hub is not permitted to start.

Note
In an Adabas Cluster Services or Adabas Parallel Services environment, the FORCE parameter applies to the NUCID, rather than the database ID, because a cluster nucleus builds an ID table entry for the NUCID.

A data integrity block (DIB) entry will only be removed once the ID Table initialization has been successful. Therefore, you must set IGNDIB and FORCE both to "YES" if either of the following occur:

- You receive a PARM ERROR 26 after parameter settings IGNDIB=NO and FORCE=YES were applied;

- You receive a PARM ERROR 23 after parameter settings IGNDIB=YES and FORCE=NO were applied.

#### Examples

The following example specifies that if the ID table contains an active entry for DBID 7, overwrite the entry.

    ADARUN PROG=ADANUC,FORCE=YES,DBID=7

The following example specifies that if the ID table contains an active entry for the Adabas Review hub, overwrite the entry.

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

## LU Parameter: Length of Intermediate User Buffer Area

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
LU | the size of the intermediate user buffer area. | none | none (see note 1) | 65535 (see note 2)

The LU parameter is optional. The size specified must be large enough to accommodate all Adabas control information (204 bytes), all user buffers (format, record, search, value, ISN) that may be required for any given Adabas command, plus any user information passed from Adabas link routines to nucleus user exits. If the ADALNK has user exits, the addresses of the ACB and each buffer passed will be stored in this space. Also, if the ADALNK has declared LUSIZE and has user exits, this buffer size plus 64 bytes will also be stored in this space.

If the multifetch/prefetch option or a utility that needs large record/ISN buffers is to be used during the session, the setting of LU must be large enough to contain the buffers needed.

If you are using the ADARPD IQETBBROKERID NET communication (used with Event Replicator for Adabas), make sure that the webMethods EntireX Broker NET definition parameter IUBL is set to a value as large as the setting of this LU ADARUN parameter.

Notes:

1. An error occurs if the LU parameter specifies a value greater than the byte count implied by the NAB (number of attached buffers) parameter. LU cannot exceed a value greater than that produced by the following calculation: `(NABvalue x 4096)`. For more information about the NAB parameter, read NAB: Number of Attached Buffers, in Adabas Operations Manual.
2. Due to the length of the record buffer of the utilities that need the nucleus, e.g., ADAULD, the default value is set to 65,535. If the value of LU is less than 65,535 for an Adabas session, a response code will occur when such a utility is running.

The LU parameter syntax is:

    LU={ n | 65535 }

#### Specific Product Recommendations

- For Event Replicator Server databases running with Adabas 8, the LU parameter must be greater than or equal to 167,000.

  In addition, if data is sent through Entire Net-Work from one or more Adabas nuclei to an Event Replicator Server, the Entire Net-Work LU parameter must be greater than or equal to the LU parameter setting for the Event Replicator Server itself (greater than or equal to 167,000).

- The ADACHK utility can use large record buffer lengths when making nucleus calls to verify spanned Data Storage records or an index structure with many levels. If this is the case, the settings of your LU and NAB ADARUN parameters may need to be increased.

- For an Adabas nucleus running with the ADARUN REPLICATION=YES parameter, ensure the LU ADARUN parameter is set to a value greater than or equal to 70000.

- For an Adabas Audit Server, the LU parameter must be greater than or equal to 167,000.

  In addition, if audit data is sent through Entire Net-Work from one or more Adabas nuclei to an Adabas Audit Server, the Entire Net-Work LU parameter must be greater than or equal to the LU parameter setting for the Adabas Audit Server itself (greater than or equal to 167,000).

#### Example

The following example runs the Adabas nucleus with an Adabas intermediate user buffer area of 20,000 bytes.

    ADARUN PROG=ADANUC,LU=20000

## NAB Parameter: Number of Attached Buffers

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
NAB | the number of attached buffers to be used. | 1 | varies, depending on the amount of available virtual storage | 16

The NAB parameter defines the number of attached buffers to be used during the session. An attached buffer is an internal buffer used for interregion communication. It is required in all environments. Adabas allocates an attached buffer pool with a size equal to the value of NAB multiplied by 4096 bytes.

Note
The allocation for buffers in the attached buffer pool is done in 256 byte slots; this means that each allocation is rounded to a multiple of 256. For example, if a size of 300 bytes is needed, the allocated space is 512 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.

The NAB parameter syntax is:

    NAB={ n | 16 }

#### Specific Product Recommendations

- For Event Replicator Server databases, set parameter NAB to a value greater than or equal to: `41 * 10 * the-number-of-Adabas-nuclei-sending-data-to-the-Event-Replicator-Server`.

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

- If the Event Replicator Server is set to support updates by multiple concurrent users to Adabas targets (when the NPADACALLS initialization parameter is set to any value greater than "1"), consider adjusting the value of this parameter in the target Adabas nucleus to ensure the target nucleus can handle updates from multiple concurrent users.

- If data is sent through Entire Net-Work from one or more Adabas nuclei to an Event Replicator Server, the Entire Net-Work NAB parameter must also be set to a value greater than or equal to: `41 * 10 * the-number-of-Adabas-nuclei-sending-data-to-the-Event-Replicator-Server`.

- Users of the Adabas Review hub should read Storage Requirements in the Adabas Review Concepts Manual for more information about the space requirements of the Command Queue for Adabas Review.

- The ADACHK utility can use large record buffer lengths when making nucleus calls to verify spanned Data Storage records or an index structure with many levels. If this is the case, the settings of your LU and NAB ADARUN parameters may need to be increased.

- For an Adabas Audit Server, set 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 (e.g. `NAB=420`).

  If data is sent through Entire Net-Work from one or more Adabas nuclei to an Adabas Audit Server, the Entire Net-Work NAB parameter must also be set to a value greater than or equal to:

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

#### Example

The following example runs the Adabas Review hub nucleus with 50 attached buffers.

    ADARUN PROG=ADAREV,NAB=50

## NC Parameter: Number of Command Queue Elements

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
NC | the maximum number of command queue elements. | 20 | 32767 | 200

The number of command queue elements (CQEs) established for the Adabas or Review hub session determines the maximum number of Adabas commands that may be queued or be in process at any one time during the session.

Each call from the Adabas nucleus is assigned a CQE. The CQE is released when the user receives the results of the command, the Adabas Review hub has processed the command, or the user has been timed out..

192 bytes are required for each CQE.

Software AG recommends that you set NC high enough to allow one command per active user for possible synchronization during execution of the online SAVE database function of the ADASAV utility.

The Adabas session statistics or Adabas Online System can be used to tune this parameter for the next session.

For more information about the space requirements of the Command Queue for Adabas Review, refer to .

#### Specific Product Recommendations

- For Event Replicator Server databases, set parameter NC to a value greater than or equal to: `10 * the-number-of-Adabas-nuclei-sending-data-to-the-Event-Replicator-Server`. For example, if one Adabas nucleus will be sending data to the Event Replicator Server, set the NC parameter greater than or equal to 10 (for example NC=20).

- If data is sent through Entire Net-Work from one or more Adabas nuclei to an Event Replicator Server, the Entire Net-Work NC parameter must also be set to a value greater than or equal to: `10 * the-number-of-Adabas-nuclei-sending-data-to-the-Event-Replicator-Server`.

- If the Event Replicator Server is set to support updates by multiple concurrent users to Adabas targets (when the NPADACALLS initialization parameter is set to any value greater than "1"), consider adjusting the value of this parameter in the target Adabas nucleus to ensure the target nucleus can handle updates from multiple concurrent users.

- For an Adabas Audit Server, set parameter NC to a value greater than or equal to:

      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 NC parameter greater than or equal to 10 (e.g. `NC=20`).

  If data is sent through Entire Net-Work from one or more Adabas nuclei to an Adabas Audit Server, the Entire Net-Work NC parameter must also be set to a value greater than or equal to:

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

#### Example:

Run the Adabas nucleus with a maximum of 500 elements in the command queue.

    ADARUN PROG=ADANUC,NC=500

The following example runs the Adabas Review hub nucleus with a maximum of 500 elements in the command queue.

    ADARUN PROG=ADAREV,NC=500

## PROGRAM Parameter: Program to Run

Parameter | Specify: | Possible Values | Default
--- | --- | --- | ---
PROGRAM | the program to be executed. | see table below | USER

This parameter specifies what to execute. The possible values are described in the following table:

Specify: | To start:
--- | ---
ADACOM | an ADACOM task (used in Adabas Cluster Services and Adabas Parallel Services environments) For more information, refer to your Adabas Cluster Services and Adabas Parallel Services documentation.
ADANUC | an Adabas nucleus For more information about executing an Adabas nucleus, read Adabas Session Execution, in the Adabas Operations Manual.
ADAREV | an Adabas Review hub. Specify this in conjunction with the ADARUN REVIEW parameter. For more information, refer to your Adabas Review documentation.
NETWRK | an Entire Net-Work node For more information, refer to your Entire Net-Work documentation.
RENTUSER | a user program to be run using a reentrant Adabas batch/TSO link routine. For more information, refer to description of the Adabas TP monitor installation in your Adabas installation documentation.
USER | a user program to be run using a non-reentrant Adabas batch/TSO link routine. For more information, read Linking Applications to Adabas, in the Adabas Operations Manual
utility-name | an Adabas utility Specify an Adabas utility for utility-name. For more information, refer to the Adabas Utilities Manual.

#### Examples

The following example specifies that an Adabas nucleus is running.

    ADARUN PROGRAM=ADANUC

The following example specifies that an Adabas Review hub is running.

    ADARUN PROGRAM=ADAREV, REVIEW=202

The following example specifies that an Entire Net-Work node is running.

    ADARUN PROGRAM=NETWRK

## SVC Parameter: SVC Number

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
SVC | the Adabas SVC number or Adabas Review hub SVC number to be used for the session. | see text | 249

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

The Adabas SVC or Adabas Review hub SVC are used to perform various Adabas internal functions under z/OS.

Valid SVC values are between 200 and 255.

#### Example

The following example runs an Adabas session using SVC 202 for the Adabas SVC.

    ADARUN PROG=ADANUC,SVC=202

## TARGETID Parameter: Entire Net-Work Target ID

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
TARGETID | the unique Entire Net-Work target ID for this node. | 1 | 65535 | 1

The TARGETID parameter is an optional ADARUN parameter that specifies the unique Entire Net-Work target ID of a node. It is synonymous with the Adabas ADARUN DBID parameter.

All target IDs used by Entire Net-Work, Adabas (database IDs), Natural global buffer pools, etc., must be unique throughout all Entire Net-Work nodes. In particular, the Entire Net-Work target ID must not coincide with any database ID used in the network, with the exception of isolated databases that are defined for local availability only and are therefore unknown to Entire Net-Work. For more information about global target IDs, read .

#### Example

The following example specifies an Entire Net-Work target ID of 12 for a node.

    ADARUN TARGETID=12

## TCPURL Parameter: TCP/IP Universal Resource Locator

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
TCPURL | the universal resource locator (URL) for the TCP/IP link. | (see text) | none

If TCPIP=YES, you can specify the information required to activate the direct TCP/IP link to the Adabas nucleus. The parameter value is a 20-byte address that conforms to the RFC specification for universal resource locators (URLs):

    TCPURL=api-name:[//]stackid:port-number[:logging-setting[:allowipv6-setting]]

where:

api-name | A required three-character value identifying the application programming interface (API) to use. The APIs HPS and OES are currently supported.
stackid | A one to eight-character value identifying the stack to use: For HPS, specify the name of the TCP/IP started task or job. For OES on systems running a single TCP/IP stack, no value is needed. On systems running multiple TCP/IP stacks, specify the name of the TCP/IP started task or job. (No value is needed on systems with only one TCP/IP stack.)
port-number | A one to five-digit number in decimal notation.
logging-setting | A one-character setting indicating whether or not logging should be performed. Valid values are "Y" or "N"; a setting of "Y" turns logging on.
allowipv6-setting | A one-character setting indicating whether or not IPv6 addresses can be used. Valid values are "Y" or "N"; a setting of "Y" indicates that IPv6 addresses can be used.

Note
The forward slashes ("//") are optional.

#### Example 1

The following examples run Adabas with a direct TCP/IP link to the nucleus.

    ADARUN PROG=ADANUC,TCPIP=YES,TCPURL=OES://:12216
    ADARUN PROG=ADANUC,TCPIP=YES,TCPURL=HPS://TCPLPAR1:12213

#### Example 2

The following example runs Adabas with a direct TCP/IP link to the nucleus and with logging turned on.

    ADARUN PROG=ADANUC,TCPIP=YES,TCPURL=OES://:12216:Y

#### Example 3

The following example runs Adabas with a direct TCP/IP link to the nucleus and with logging turned on for a system with multiple TCP/IP stacks. In this example, the TCP/IP stack with the started task or job name of TCPIPMVS is requested.

    ADARUN PROG=ADANUC,TCPIP=YES,TCPURL=OES://TCPIPMVS:12216

#### Example 4

The following example runs Adabas with a direct TCP/IP link to the nucleus and allows IPv6 addresses to be used.

Note
Note if you choose not to specify the logging setting (logging-setting), but to specify the IPv6 setting (allowipv6-setting), you must still specify the colons for both the logging and IPv6 settings. This is why there are two colons between "12216" and "Y" in the following example.

     ADARUN PROG=ADANUC,TCPIP=YES,TCPURL=OES://:12216::Y

## ZIIP Parameter: Activate Usage of Adabas for zIIP

The ZIIP parameter controls whether Adabas activates Adabas for zIIP (AZPAD).

Note
Adabas for zIIP requires its own license file (AZPAD), in addition to the standard Adabas license file. If the AZPAD license file is missing or found invalid, Adabas will start but will run as if ZIIP=NO had been specified.

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
ZIIP | whether or not to activate Adabas for zIIP. | YES | NO | NO

Value | Meaning
--- | ---
YES | Usage of Adabas for zIIP is enabled. Adabas offloads CPU time from the general processors to System z Integrated Information Processors (zIIP). The purpose of this configuration is to reduce the CPU consumption on the general processors.
NO | The default setting. Usage of Adabas for zIIP is disabled. Adabas runs without the option to offload CPU time to zIIPs.

#### Dynamic Modification

If Adabas was started with ZIIP=YES, the setting of the ZIIP parameter can be changed at runtime - that is, set to NO and subsequently back to YES - using the from the operator console, the ZIIP function, or the Modify Parameters menu of Adabas Online System.

If Adabas was started with ZIIP=NO, the setting of the ZIIP parameter cannot be changed to YES later in this session.

ZIIP may be set differently for different nuclei in a cluster (it is a local, modifiable parameter).

#### Specific Product Recommendations

- Event Replicator Server databases and Adabas nuclei running with ADARUN `REPLICATION=YES` support the use of Adabas for zIIP subject to the availability of the appropriate license file (AZPAD).

- The Adabas Audit Server and Adabas nuclei running with `ADARUN AUDITING=YES` support the use of Adabas for zIIP subject to the availability of the appropriate license file (AZPAD).

#### Example

The following example activates the use of Adabas for zIIP.

    ADARUN PROG=ADANUC,ZIIP=YES

## Example

The following is an example of an Entire Net-Work specification of ADARUN parameters:

    ADARUN PROG=NETWRK,TARGETID=3333,NAB=20,NC=50,LU=65535,SVC=251

For this node, Entire Net-Work:

- runs with a target ID of 3333;

- allocates an attached buffer pool for 20 interregion communication buffers;

- processes as many as 50 requests simultaneously;

- uses the SVC 251; and

- ensures adequate buffer size for Adabas compatibility by setting the value of the LU parameter to 65535. For more information about the LU parameter, read about it in the Adabas Operations documentation.

### On this page

- Specifying ADARUN Parameters
- CT Parameter: Command Timeout Limit
- FORCE Parameter: Allow Nucleus Database ID or Review Hub Table Entry Overwrite
- LU Parameter: Length of Intermediate User Buffer Area
- NAB Parameter: Number of Attached Buffers
- NC Parameter: Number of Command Queue Elements
- PROGRAM Parameter: Program to Run
- SVC Parameter: SVC Number
- TARGETID Parameter: Entire Net-Work Target ID
- TCPURL Parameter: TCP/IP Universal Resource Locator
- ZIIP Parameter: Activate Usage of Adabas for zIIP
- Example