Version 8.1.4	SEARCH   INDEX   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT

This document describes all of the ADARUN parameters available for Adabas.

CFILE=({fnr | fnr1-fnrx}[,class][,scope][,cachetype])

nnn[K | M | G]

CXFILE=({fnr | fnr1-fnrx}[,,scope])

HEXnn=user-routine-name

AOSLOG : Log Active Nucleus Update Commands

Example

In the following example, Adabas calls that modify the nucleus are logged.

ADARUN PROG=ADANUC,AOSLOG=YES

AREXCLUDE : Exclude Files from Autorestart Processing

The AREXCLUDE parameter is intended for use only when autorestart processing fails (abends) due to response codes on one or more Adabas files. In this case, excluding the problem file(s) from autorestart might allow for successful autorestart processing on the other files.

Excluded files are marked as "utility use only". Software AG recommends that you restore excluded files from the latest save tape and regenerate them.

Multiple file numbers can be specified on the same parameter if separated by commas.

Example

The following example excludes files 199 and 231 from autorestart processing.

ADARUN PROG=ADANUC,AREXCLUDE=199,231

ARMNAME : Activate Automatic Restart Management (ARM) Program

Automatic restart management (ARM) is used to automatically restart a nucleus when it abends. It is suppressed when the abend is intentional; for example, when it results from a parameter error.

ARM can be used in both cluster and noncluster nucleus environments.

ARM programs ('elements') are defined by the system programmer in the ARM 'policy'. They specify when, where, and how often a restart is to be attempted.

The ARMNAME parameter has no effect if an ARM policy has not been defined.

The name can be 1-16 characters long. In a cluster environment, the name must be unique across the cluster. Uppercase alphabetic characters, the numbers 0-9, and the special characters $, @, and #, and the underscore (_) may be used. The first character may not be numeric. Names that start with A through I and with SYS are reserved for use by IBM.

Example

The following example activates the automatic restart management program RESTART002.

ADARUN PROG=ADANUC,ARMNAME=RESTART002

ASSOCACHE : Associator Controller Caching

This parameter applies to the operating systems z/OS and z/VM only.

Notes:

1. If ASSO blocks are highly scattered or the update frequency is low, controller caching can cause longer I/O response times.
2. ADARUN caching control parameters also exist for Data Storage (DATACACHE), the work area (WORKCACHE), the sort area (SORTCACHE), and the temp area (TEMPCACHE).

Example

The following example runs the nucleus without controller caching for the ASSO data set.

ADARUN PROG=ADANUC,ASSOCACHE=NO

ASYTVS : Asynchronous Bufferflush

Note:
When an SLOG file is defined for use on the Event Replicator Server, replication data may be written and read from the SLOG file. With this in mind, consider the values set for the following ADARUN performance and tuning parameters: ASYTVS, FMXIO, LBP, LDEUQP, LFIOP, LP, NH, NISNHQ.

Example

The following example disables the asynchronous buffer flush based on volume.

ADARUN PROG=ADANUC,ASYTVS=NO

CACHE : Adabas Caching Facility Control

CACHE (or CACH) specifies whether or not ADACSH is to be loaded during Adabas session initialization.

Example

ADARUN CACHE=YES

ADACSH is loaded during the Adabas session initialization. ADACSH operator commands are accepted and caching is in effect.

CACTIVATE : Adabas Caching Facility RABN Activation

CACTIVATE (or CACT) specifies whether or not all RABN ranges are to be activated at session open.

Example

ADARUN CACTIVATE=YES

All RABN ranges are made available for immediate use; that is, as soon as the Adabas nucleus needs to move a block from the Adabas buffer pool into a RABN range, the RABN range is allocated.

CASSODSP / CASSOEXT / CASSOHSP / CASSOL64 / CASSOV64 : Adabas Caching Facility Associator RABN Cache Space Control

Note:
CASSOxxx parameters are mutually exclusive with the CFILE and CXFILE parameters.

The CASSOxxx parameters identify one or more Associator RABNs to be cached where xxx indicates the type of cache space:

• CASSODSP (or CASSOD) for data space

• CASSOEXT (or CASSOE) for extended memory

• CASSOHSP (or CASSOH) for hiperspace

• CASSOL64 (or CASSOL) for virtual 64 backed by large pages

• CASSOV64 (or CASSOV) for virtual 64

Note:
Virtual 64 storage is only available in z/OS environments.

If CASSOxxx is specified, only the specified RABNs are cached. Unspecified RABNs are not cached and are subject to normal Adabas I/O operations.

Associator RABNs 1 through 30 are not cached; they are ignored if specified by the user.

Notes:

1. If an invalid RABN range is specified in the CASSOxxx parameter, subsequent RABN ranges for the CASSOxxx parameter are ignored. The ignored parameters can be added after initialization by using an operator command.
2. The CSTORAGE parameter overrides any CASSOxxx parameter and ADACSH will cache all Associator RABNs as defined for the database.

RABNs for the ranges specified are cached in the cache space indicated by the parameter suffix. RABN ranges defined with this parameter must therefore compete for the space available in a given cache space. When the maximum is allocated, RABNs are purged from the cache space based on a first-in-first-out (FIFO) mechanism and are reused to accommodate the latest RABNs being purged from the Adabas buffer pool.

Example

 ADARUN
CASSODSP=1330-2349,126-187,124-125,205-216 ADARUN
CASSOHSP=218-252,203-204,260-275,277-335

ADACSH caches the specified RABN ranges. No other Associator RABNs are cached.

The first four RABN ranges defined are cached in the Associator cache space allocated in data space (suffix DSP). The second four RABN ranges defined are cached in the Associator cache space allocated in hiperspace (suffix HSP).

CASSOMAXS : Associator Cache Space Unit Size

The CASSOMAXS (or CASSOM) parameter specifies the unit size in which areas are allocated for Associator cache space.

The total space available is equal to:

Maximum
ASSO cache space size = CASSOMAXS · CMAXCSPS

Storage areas for a cache space are allocated when required. The Adabas nucleus informs ADACSH when a RABN is about to be purged from the buffer pool. If ADACSH determines that this RABN is being cached, it attempts to allocate space in the appropriate cache space.

When no space is available in the currently allocated areas for a cache space, or no areas are allocated, a new area of storage is allocated with the size specified by the CASSOMAXS parameter. For cache storage in

• extended memory, additional storage is requested in this area;

• data space, an additional data space is allocated;

• hiperspace, an additional hiperspace is built; and

• virtual 64 memory backed by large pages, an additional memory object is allocated; and

• virtual 64 memory, an additional memory object is allocated.

This occurs until the maximum number of areas as determined by the CMAXCSPS parameter is reached. At this point, space is made for the latest RABNs to be purged from the Adabas buffer pool based on the aging algorithms.

The CASSOMAXS limit used for the allocation of new areas in a cache space is based on the last specification for this value. If no operator or Adabas Online System command is issued, this is the value specified in the startup parameters. If this value is specified by an operator command or through Adabas Online System, it takes effect the next time an additional area is allocated in an ASSO cache space.

Example

ADARUN
CASSOMAXS=15000000

Cache space areas for ASSO RABNs are allocated in units of 15003648 bytes (or 14652K; or 14M).

CBUFNO: Number of Read-Ahead Buffers for Concurrent I/O Processing

CBUFNO specifies the number of read-ahead buffers available for concurrent I/O processing.

CBUFNO is one of two parameters (CBUFNO and CEXCLUDE) used for read-ahead caching. Read-ahead caching performs a read-ahead of consecutive Associator and/or Data Storage blocks when processing serial Adabas commands (Read Logical, Read Physical, Histogram), and when searching using nondescriptors.

The read-ahead is performed by issuing a single EXCP to read all the consecutive Associator or Data Storage blocks that reside on a single track of the disk device. The blocks are kept in cache and are immediately available when the nucleus requests the next block in a sequence.

This feature may enhance performance by reducing the number of physical read I/Os. For example, for a 3380 Associator, a reduction factor of 18:1 may be achieved.

During normal cache processing, if a read I/O request qualifies for read-ahead processing but no read-ahead buffer is available, the read I/O is satisfied with a single block EXCP. In other words, no optimization is done to issue an EXCP to read the entire track.

Note:
Read-end-of-track processing is not available in Cluster and SMP environments.

Example

ADARUN CBUFNO=5,CEXCLUDE=FIND/HIST

Five buffers are available for read-ahead caching. No read-ahead processing is performed for S1 (nondescriptor search) and L9 (histogram) commands.

CCTIMEOUT : Cache Space Area or RABN Inactivity Time

The CCTIMEOUT (or CC) parameter specifies the amount of time (in seconds) a cache space area can remain inactive before it is released back to the system.

If demand caching (CDEMAND) is in effect, CCTIMEOUT specifies the number of seconds a RABN range, file, or file range can remain inactive before it is disabled.

If a cache space area has not been accessed for the specified period of time, ADACSH releases the storage associated with the area back to the operating system. A message is displayed on the operator console indicating that the cache space area was timed out. The cache space area can be re-allocated immediately by the caching system when required.

If a RABN range, file, or file range is not referenced for the specified period of time, and demand caching is in effect, the RABN range, file, or file range is disabled. A message is displayed on the operator console informing the user that the RABN range, file, or file range was timed out. No further caching occurs for that RABN range, file, or file range until the Adabas buffer efficiency goes below the level specified by CDEMAND. Once this occurs, the RABN range, file, or file range is enabled again and begins caching its associated RABNs.

Activity is checked at an interval of one half of the CCTIMEOUT value. For example, if CCTIMEOUT=3600 is specified, the allocated cache space areas, RABN ranges, files, or file ranges are checked every 1800 seconds (30 minutes).

A change to CCTIMEOUT using an operator command causes the check to be performed immediately, and subsequently at intervals of one half of the new CCTIMEOUT value.

Example

ADARUN CCTIMEOUT=3600

A cache space area is released (or a RABN range/file/file range is disabled if demand caching is in effect) if there is no activity associated with it for a continuous period of 1 hour (3600 seconds).

CDATADSP / CDATAEXT / CDATAHSP / CDATAL64 / CDATAV64 : Adabas Caching Facility Data Storage RABN Cache Space Control

Note:
CDATAxxx parameters are mutually exclusive with the CFILE and CXFILE parameters.

The CDATAxxx parameters identify one or more Data Storage RABNs to be cached where xxx indicates the type of cache space:

• CDATADSP (or CDATAD) for data space

• CDATAEXT (or CDATAE) for extended memory

• CDATAHSP (or CDATAH) for hiperspace

• CDATAL64 (or CDATAL) for virtual 64 backed by large pages

• CDATAV64 (or CDATAV) for virtual 64

Note:
Only extended memory is available for BS2000 RISC machines. Hiperspace is an option only in z/OS environments. Virtual 64 storage is available only in z/OS environments.

If CDATAxxx is specified, only the specified RABNs are cached. Unspecified RABNs are not cached and are subject to normal Adabas I/O operations.

Notes:

1. If an invalid RABN range is specified in the CDATAxxx parameters, subsequent RABN ranges for the CDATAxxx parameters will be ignored. The ignored parameters can be added after initialization by using an operator command.
2. The CSTORAGE parameter overrides any CDATAxxx parameter and ADACSH will cache all Data Storage RABNs as defined for the database.

RABNs for the ranges specified are cached in the cache space indicated by the parameter suffix. RABN ranges defined with this parameter must therefore compete for the space available in a given cache space. When the maximum is allocated, RABNs are purged from the cache space based on a first-in-first-out (FIFO) mechanism and are reused to accommodate the latest RABNs being purged from the Adabas buffer pool.

Example

 ADARUN
CDATADSP=1-4900,6523-7853 ADARUN CDATAHSP=5032-6204,8123-10382

ADACSH caches the specified RABN ranges. No other DATA RABNs are cached.

The first two RABN ranges defined are cached in the Data Storage cache space allocated in data space (suffix DSP). The second two RABN ranges defined are cached in the Data Storage cache space allocated in hiperspace (suffix HSP).

CDATAMAXS : Data Storage Cache Space Unit Size

The CDATAMAXS (or CDATAM) parameter specifies the unit size in which areas are allocated for Data Storage cache space.

The total space available is equal to:

Maximum
DATA cache space size = CDATAMAXS · CMAXCSPS

Storage areas for a cache space are allocated when required. The Adabas nucleus informs ADACSH when a RABN is about to be purged from its buffer pool. If ADACSH determines that this RABN is being cached, it attempts to allocate space in the appropriate cache space.

When no space is available in the currently allocated areas for a cache space, or no areas are allocated, a new area of storage is allocated with the size specified by the CASSOMAXS parameter. For cache storage in

• extended memory, additional storage is requested in this area;

• data space, an additional data space is allocated;

• hiperspace, an additional hiperspace is built; and

• virtual 64 memory backed by large pages, an additional memory object is allocated; and

• virtual 64 memory, an additional memory object is allocated.

This occurs until the maximum number of areas as determined by the CMAXCSPS parameter is reached. At this point, space is made for the latest RABNs to be purged from the Adabas buffer pool based on the aging algorithms.

The CDATAMAXS limit used for the allocation of new areas in a cache space is based on the last specification for this value. If no operator or Adabas Online System command is issued, this is the value specified in the startup parameters. If this value is specified by an operator command or through Adabas Online System, it takes effect the next time an additional area is allocated in a Data Storage cache space.

Example

ADARUN
CDATAMAXS=15000000

Cache space areas for Data Storage RABNs are allocated in units of 15003648 bytes (or 14652K; or 14M).

CDEMAND : Lowest Adabas Buffer Efficiency for Caching

The CDEMAND (or CDE) parameter specifies the lowest Adabas buffer efficiency level accepted before caching is activated.

Calculated by the nucleus, Adabas buffer efficiency is the number of read requests divided by the actual number of reads to storage. If the Adabas buffer efficiency level drops below the specified CDEMAND level, ADACSH activates all disabled RABN ranges. In this way, RABN ranges are dynamically activated as demand on the Adabas buffer pool increases.

The CDEMAND parameter should be used in conjunction with the CCTIMEOUT parameter to establish resource usage boundaries that permit the timely acquisition and release of system resources. In other words, CDEMAND may be used to activate RABN ranges when the demand load on Adabas is high, and CCTIMEOUT may be used to deactivate RABN ranges when Adabas is idle.

If CDEMAND is not zero, the Adabas buffer efficiency is first checked approximately 30 minutes after the Adabas nucleus is initialized. Thereafter, the Adabas buffer efficiency is checked at intervals of approximately 15 minutes.

CDEMAND does not affect the activation of caching for Work parts 2 and 3 because these areas do not influence the Adabas buffer efficiency. Only Associator and Data Storage blocks reside in the Adabas buffer pool and, consequently, only the cache spaces for the Associator and Data Storage serve to increase the Adabas buffer efficiency level.

Example

ADARUN CDEMAND=7

ADACSH activates the RABN ranges if the Adabas buffer efficiency level drops below 7.

CDISPSTAT : Adabas Caching Facility RABN Range Statistics Display Control

The CDISPSTAT (or CDI) parameter specifies whether the RABN range statistics are to be displayed on both the operator console and DDPRINT, or only on DDPRINT.

The individual RABN range statistics are displayed whenever a RABN range is released due to a parallel utility operation or an inactivity timeout, or when a RABN range is dynamically added or deleted.

Example

ADARUN CDISPSTAT=NO

When the status of a RABN range is changed due to a parallel utility operation, a timeout, or an operator command to add or delete, the individual RABN range statistics are to be displayed on DDPRINT only.

CDXnn : Collation Descriptor User Exit

Used in conjunction with the universal encoding subsystem (UES), the format of the collation descriptor user exit parameter is

CDXnn=exit-name

where

Only one program may be specified for each collation descriptor exit. Up to 8 collation descriptor exits may be specified (in any order). See the User Exits documentation for more information.

Example

The following example runs the Adabas nucleus using collation descriptor exits 1 and 2. It also gives control to the user routine UCOLDE1 at collation descriptor exit 1 and gives control to the user routine UCOLDE2 at collation descriptor exit 2.

ADARUN PROG=ADANUC,CDX01=UCOLDE1,CDX02=UCOLDE2

CEXCLUDE : Adabas Caching Facility Excluded Command Types

CEXCLUDE specifies the command types to be excluded from read-ahead caching.

CEXCLUDE is one of two parameters (CBUFNO and CEXCLUDE) used for read-ahead caching. Read-ahead caching performs a read-ahead of consecutive Associator and/or Data Storage blocks when processing serial Adabas commands (Read Logical, Read Physical, Histogram), and when searching using nondescriptors.

The read-ahead is performed by issuing a single EXCP to read all the consecutive Associator or Data Storage blocks that reside on a single track of the disk device. The blocks are kept in cache and are immediately available when the nucleus requests the next block in a sequence.

This feature may enhance performance by reducing the number of physical read I/Os. For example, for a 3380 Associator, a reduction factor of 18:1 may be achieved.

The exclusion list must be specified with each four-byte name separated by a slash ( / ). No intervening spaces or special characters, such as commas, are permitted.

The exclusion is made globally; for example, if CEXCLUDE=PHYS is specified, all L2 and L5 commands are excluded from read-ahead processing, regardless of the file to which the command was directed.

The exclusion list may be changed during the nucleus session using the CEXCLUDE and CINCLUDE operator commands.

Example

ADARUN CBUFNO=5,CEXCLUDE=FIND/HIST

Five buffers are available for read-ahead caching. No read-ahead processing is performed for S1 (nondescriptor search) and L9 (histogram) commands.

CFILE : Adabas Caching Facility File Range

Note:
CFILE is mutually exclusive with the CASSOxxx, CDATAxxx, and CSTORAGE parameters. If any of these parameters is used with CFILE, they will be ignored.

The CFILE parameter defines a file or file range to be cached. It is also used to provide the settings used to control how caching is to be implemented for the file or file range.

Within the parentheses, the value terms are positional. This means that you can omit a term if you want to accept the default value for it, but you must enter a comma to identify the position if you are specifying a subsequent term within the parentheses.

Multiple CFILE parameters may be specified.

CFILE and CXFILE parameters together are processed in order from left to right (or top to bottom if different ADARUN statements are used). Parameters or statements that specify file ranges are processed before those that specify specific files.

Examples

ADARUN CACHE=YES,CFILE=(7,2)

File-level caching is active for file number 7. The file is permitted to use up to 75% of the maximum total available cache space (class of service 2). Both Associator and Data Storage RABNS are cached (the default) and the type of cache space used is data space (the default).

ADARUN
CACHE=YES,CFILE=(3-6,,DATA,HIPERSPACE)

File-level caching is active for file numbers 3 through 6. The files are permitted to use up to 50% of the maximum total available cache space (class of service 3, the default). Only Data Storage RABNS are cached, and the type of cache space used is hiperspace.

ADARUN
CACHE=YES,CFILE=(14-17,,,HIPERSPACE)

File-level caching is active for file numbers 14 through 17. The files are permitted to use up to 50% of the maximum total available cache space (class of service 3, the default). Both Associator and Data Storage RABNs are cached (the default), and the type of cache space used is hiperspace.

CLOGBMAX: Logged Buffer Size Limit

If a buffer is longer than this value, the logged buffer is truncated from the point at which its size exceeds the setting of the CLOGBMAX parameter. The CLOGBMAX setting affects the ADARUN LOGGING parameter specifications for both CLOGLAYOUT=5 and CLOGLAYOUT=8. The minimum value (368) is the size of the length of the CLOGLAYOUT=8 basic record plus the length of the extended Adabas control block (ACBX).

Example

The following example runs the Adabas nucleus using a logged buffer size limit of 512. Individual logged buffers for an Adabas command cannot exceed 512 bytes.

ADARUN PROG=ADANUC,CLOGB=512

CLOGDEV : Multiple Command Log Device Type
CLOGSIZE : Multiple Command Log Size

The CLOGDEV and CLOGSIZE parameters specify the type of external storage device used for multiple command logs and the number of blocks available for each command log data set. These parameters must be used together; if you specify one parameter, you must also specify the other parameter.

You must also specify the NCLOG parameter to use multiple command logs. If you specify a user exit, it must be UEX12.

The section Adabas Device Types and Blocks Sizes in the Adabas Installation documentation specifies the device types that Adabas supports.

All command logging data sets must be formatted using the ADAFRM utility before they are used.

The maximum size of the data set depends on the limits of the operating system and on the requirements of the user.

Example

The following example runs the Adabas nucleus with command logging. It uses six command log data sets and a model 3380 device for command logging. The size of each command log data set is 1350 blocks, based on an allocation of 10 cylinders. (Each cylinder of a 3380 device has 15 tracks, and each track can contain 9 blocks of command log data. Thus, 10 cylinders = 10 x 15 x 9 = 1350 blocks).

ADARUN PROG=ADANUC,LOGGING=YES,NCLOG=6,CLOGDEV=3380,CLOGSIZE=1350

CLOGLAYOUT : Command Logging Format

This parameter specifies the format of the Adabas command log.

Notes:

1. Timestamps in an Adabas 8 command log created using CLOGLAYOUT=8 are stored in machine time (GMT), whereas CLOGLAYOUT=5 timestamps are stored, as always, in local time. The LORECX record layout that describes the CLOGLAYOUT=8 command log includes a differential time field that stores the difference between machine time and local time at the time the CLOG record is written. This field allows you to calculate the local time of a command log record.
2. Because of the different timestamp formats used in CLOGLAYOUT=5 and CLOGLAYOUT=8 command logs, we do not recommend that you mix or merge command logs created using different CLOGLAYOUT settings (and, in fact, Adabas does not allow this in cluster or parallel services environments). If you do, your results will be unpredictable.

Example

The following example uses the Adabas 8 format of the command log.

ADARUN PROG=ADANUC,CLOGLAYOUT=8

CLOGMAX: Total Logged Buffer Size Limit for a Command

When the sum of sizes of the logged buffers for an Adabas command reaches the value of the CLOGMAX parameter, the buffer exceeding the limit is truncated and all following buffers are omitted. The size of CLOGMAX must at least be as large as the CLOGBMAX parameter setting in order to accommodate the largest buffer of the Adabas command. The minimum value (368) is the size of the length of the CLOGLAYOUT=8 basic record plus the length of the extended Adabas control block (ACBX).

The CLOGMAX setting affects the ADARUN LOGGING parameter specifications for both CLOGLAYOUT=5 and CLOGLAYOUT=8.

Example

The following example runs the Adabas nucleus using a command logged buffer size limit of 32K. The sum of all logged buffers for an Adabas command to this nucleus cannot exceed 32K.

ADARUN PROG=ADANUC,CLOGMAX=32768

CLOGMRG : Cluster Command Log Merge

An automatic CLOG merge process provides a single cluster-wide command log containing, in chronological order, all Adabas commands executed by any of the cluster nuclei in the time period covered by the log.

CLOGMRG specifies whether the Adabas cluster is to run with the automatic CLOG merge:

CLOGMRG is a global (that is, a cluster-wide) parameter, which means that the setting of this parameter in the first cluster nucleus to become active is propagated to all nuclei that subsequently become active.

Parameter Dependencies

It is possible to specify both LOGGING=NO and CLOGMRG=YES. In a cluster environment, it is also possible that a CLOG will be written to even if LOGGING=NO. As long as CLOGMRG=NO, nothing will be written to the CLOG if LOGGING=NO. However, if LOGGING=NO and CLOGMRG=YES, control records necessary for ADARES CLCOPY will be written to the CLOG.

CLOGMRG is effective only in an Adabas cluster environment; that is, when CLUSTER is specified with a value other than NO and NUCID is specified with a nonzero value.

Dynamic Modification

The setting of the CLOGMRG parameter can be changed dynamically using the CLOGMRG command from the operator console, the ADADBS OPERCOM CLOGMRG function, or the Modify Parameter function of Adabas Online System.

Because CLOGMRG is a global parameter, the change request to one nucleus is automatically propagated to all nuclei in the cluster.

CLUCACHENAME : Cluster Cache Structure/Area Name

For Adabus Cluster Services, the CLUCACHENAME identifies the particular sysplex cache structure (defined in the CFRM policy) associated with a particular Adabas sysplex nucleus cluster. The same name must be set in each nucleus in the cluster. CLUCACHENAME must be unique for each cluster; that is, each database.

Adabas Parallel Services automatically creates a default name for each global cache area allocated by ADACOM. However, if you wish to control the name of the global cache area, you can set this parameter.

Note:
Software AG recommends that you allow the system to build the default name.

For Adabas Parallel Services, the CLUCACHENAME identifies a particular global cache area associated with all cluster nuclei that have the same SVC/DBID set as the current nucleus. The same name must be set in each cluster nucleus that has the same SVC/DBID set. CLUCACHENAME must be unique for each SVC/DBID set.

In all cases, the name can be 1-16 characters long. Valid characters are numeric, uppercase alphabetic, the special characters $, @, and #. The name must begin with an alphabetic character (A-Z). IBM names begin with SYS, UNDESIG, or the characters A through I (these characters are not reserved).

Note:
Additionally, the special character underscore (_) is allowed in Adabus Cluster Services; that is, sysplex environments.

Example

In the following example, the sysplex cache structure name is defined as "SAG1SMP#CACHE1".

ADARUN PROG=ADANUC, CLUCACHENAME=SAG1SMP#CACHE1

CLUCACHESIZE : Size of the Global Cache Area

The CLUCACHESIZE parameter specifies the amount of storage to be allocated for the global cache area which all nuclei in the Adabas Parallel Services cluster use to share Associator and Data blocks from the database. It has an effect only if CLUSTER=LOCAL is also specified.

The location and maximum size of the global cache area depends on the CLUCACHETYPE parameter. If CLUCACHETYPE=DSP, the global cache is kept in a dataspace shared between the Adabas Parallel Services nuclei. Otherwise, the cache is kept in shared 64-bit virtual storage (z/OS systems only).

CLUCACHESIZE must be specified for Adabas Parallel Services nuclei; there is no default.

Each Adabas Parallel Services nucleus has its own buffer pool sized by the ADARUN parameter LBP . Optionally, it may also have one or more local cache spaces administered by the Adabas Caching Facility (refer to the description of the ADARUN parameter CACHE). In addition, Adabas Parallel Services uses a global cache area to ensure that current images of Associator and Data blocks from the database are available to all Adabas Parallel Services cluster nuclei.

The global cache area must be large enough to retain:

• directory elements for all blocks that reside in all buffer pools and the global cache itself; and

• enough data elements to keep changed blocks between buffer flushes (cast-outs).

The ADARUN parameters DIRRATIO and ELEMENTRATIO determine the ratio between the number of directory and data elements.

CLUCACHESIZE may be specified in bytes, in kilobytes followed by a "K", in megabytes followed by an "M", or in gigabytes followed by a "G":

• the minimum size is 131072 bytes (or 128K);

• for CLUCACHETYPE=DSP, the maximum size is 2147483147 bytes (or 2097152K; or 2048M; or 2G); and

• the maximum allowed numeral is 2147483147; for CLUCACHETYPE=V64, use the K, M or G suffix (for example, 10G or 10240M or 10485760K for a global cache of 10 gigabytes size).

The value is rounded up to the nearest 4-kilobate boundary.

Appropriate sizes for the global cache area depend very much on the application load in the cluster. For more details about these calculations, read Global Cache Area Size. You can use the Adabas Online System cache structure size calculator described in Estimating Sizes for the Cache Structure in a Cluster Environment in Adabas Parallel Services Operations documentation to determine appropriate global cache area sizes.

Example

In the following example, the global cache area allocated is 500 M.

ADARUN PROG=ADANUC,CLUCACHESIZE=500M

CLUCACHETYPE: Global Cache Area Storage Type Option

The CLUCACHETYPE parameter specifies the type of virtual storage to be used for the global cache of an Adabas Parallel Services cluster. It has an effect only if CLUSTER=LOCAL is also specified. Valid values are "DSP" (available on all supported operating systems) and "V64" or "L64" (available only on z/OS systems).

The size of the global cache is specified in the CLUCACHESIZE parameter.

The default value is "DSP", indicating that a shared dataspace will be used for the global cache. In this case, the maximum cache size is 2 GB.

If "V64" is specified (on z/OS systems), a shared storage area in 64-bit virtual storage will be used for the global cache. In this case, the cache can be made much larger than 2 GB, but is still subject to the MEMLIMIT value in effect for the ADACOM job for the Adabas Parallel Services database.

If "L64" is specified (on z/OS 1.9 or later systems running on IBM z10 machines), the global cache space shared by the cluster nuclei will reside in 64-bit virtual storage that is backed by large pages (provided the large page pool has been configured to a sufficient size and is available in the system).

Notes:

1. If one ADACOM job is used to hold the shared cache and lock spaces for multiple Adabas Parallel Services clusters, L64 cache spaces of different clusters are slightly less isolated from one another than DSP or V64 cache spaces, creating a marginally higher risk that a cache-related error in one cluster might induce an error in a different cluster. This very small risk can be avoided altogether by using different ADACOM jobs for different L64 cache spaces, but this is not mandatory.
2. Virtual 64-bit storage backed by large pages can only be used on IBM z10 mainframes running z/OS Version 1.9 or above and for which IBM large page support has been enabled via IBM APAR OA20902. You must also allocate the size of the large page pool (use the LFAREA parameter in the IEASYSxx member of SYS1.PARMLIB). The LFAREA parameter allows you to specify the amount of real storage to be used for large pages; this parameter cannot be changed dynamically and, if it is not set, page frames will remain allocated at a size of 4K.

Example

In the following example, the type of virtual storage used for the global cache area is specified as "V64".

ADARUN PROG=ADANUC,CLUCACHETYPE=V64

CLUCACHEUNCHANGED : Global Cache Unchanged Block Option

The CLUCACHEUNCHANGED parameter specifies whether an Adabas Parallel Services nucleus should write unchanged blocks to the global cache. It has an effect only if CLUSTER=LOCAL is also specified. Valid values are "YES" and "NO".

• The default value is "NO", which indicates that the nucleus will write only changed (updated) Associator and Data blocks from the database to the global cache.

• If "YES" is specified, the nucleus will write changed and unchanged Associator and Data blocks to the global cache.

Recommendation

If a lot of virtual storage can be made available for local and global caching by the Adabas Parallel Services cluster (where local caching is controlled by the ADARUN LBP parameter and possibly the Adabas Caching Facility add-on product), assigning the bulk of the available storage to the global cache (ADARUN CLUCACHESIZE parameter), which is shared by all Adabas Parallel Services nuclei for the database, provides for more economic use of the storage than assigning it to the local caches of the individual cluster nuclei (ADARUN LBP parameter and the Adabas Caching Facility ADARUN CASSOMAXS and CDATAMAXS parameters), which are private to each nucleus. However, each cluster nucleus requires sufficient local buffer pool space (LBP parameter) to hold the entire working set of Associator and Data blocks needed for parallel command processing.

In cases where the global cache size (CLUCACHESIZE parameter) is set to a large value, CLUCACHEUNCHANGED should be set to "YES", so that the global cache achieves a better hit rate (efficiency).

Example

In the following example, the CLUCACHEUNCHANGED parameter is set to that both changed and unchanged Associator and Data blocks are written to the global cache.

ADARUN PROG=ADANUC, CLUCACHEUNCHANGED=YES

CLUGROUPNAME : Cluster Group Name

The CLUGROUPNAME parameter provides:

• the XCF group name to be used by the sysplex cluster nuclei for their communication using XCF.

• the name to be used by the cluster nuclei for their communication.

All nuclei in the same cluster must have the same CLUGROUPNAME. Nuclei belonging to different clusters must have different CLUGROUPNAMEs.

In addition, the CLUGROUPNAME must be different from the XCF group names used by other subsystems that communicate using XCF.

The name can be 1-8 characters long. Valid characters are numeric, uppercase alphabetic, and the special characters $, @, and #. The name must begin with an alphabetic character (A-Z). IBM names begin with SYS, UNDESIG, or the characters A through I (these characters are not reserved).

Example

The following examples specifies the name of the XCF messaging group as "SAG1CLU".

ADARUN PROG=ADANUC,CLUGROUPNAME=SAG1CLU

CLULOCKNAME : Cluster Lock Structure/Area Name

For Adabus Cluster Services, CLULOCKNAM identifies a particular sysplex lock structure (defined in the CFRM policy) associated with a particular Adabas nucleus cluster. The same name must be set in each nucleus in the cluster. CLULOCKNAME must be unique for each cluster; that is, each database.

Adabas Parallel Services automatically creates a default name for each global lock area allocated by ADACOM. However, if you wish to control the name of the global lock area, you can set this parameter.

Note:
Software AG recommends that you allow the system to build the default name.

For Adabas Parallel Services, the CLULOCKNAME identifies a particular global lock area associated with all Adabas Parallel Services cluster nuclei that have the same SVC/DBID set as the current nucleus. The same name must be set in each cluster nucleus that has the same SVC/DBID set. CLULOCKNAME must be unique for each SVC/DBID set.

In all cases, the name can be 1-16 characters long. Valid characters are numeric, uppercase alphabetic, the special characters $, @, and #. The name must begin with an alphabetic character (A-Z). IBM names begin with SYS, UNDESIG, or the characters A through I (these characters are not reserved).

Note:
Additionally, the special character underscore (_) is allowed in Adabus Cluster Services; that is, sysplex environments.

Example

The following example set the name of the lock structure or global lock area as "SAG1SMP#LOCK1".

ADARUN PROG=ADANUC,CLULOCKNAME=SAG1SMP#LOCK1

CLULOCKSIZE : Size of the Global Lock Area

The CLULOCKSIZE parameter specifies the amount of storage to be allocated for the global lock area which all nuclei in the Adabas Parallel Services cluster use to synchronize their processing. It has an effect only if CLUSTER=LOCAL is also specified.

CLULOCKSIZE must be specified for Adabas Parallel Services nuclei; there is no default.

CLULOCKSIZE may be specified in bytes, in kilobytes followed by a "K", in megabytes followed by an "M", or in gigabytes followed by a "G".

• The minimum size is 131072 bytes (or 128K)

• The maximum size is 2147483147 bytes (or 2097152K, 2048M, or 2G).

The value is rounded up to the nearest 4-kilobyte boundary.

Appropriate sizes for the global lock area depend on the expected amount of parallel command processing in the cluster. For more details about these calculations, read Global Cache Area Size. You can use the Adabas Online System lock structure size calculator described in Estimating Sizes for the Lock Structure in a Cluster Environment to determine appropriate global lock area sizes.

CLUSTER : Adabas Nucleus Cluster Session Control

The CLUSTER parameter specifies whether the Adabas nucleus will participate in a cluster of nuclei working on the same Adabas database, and if so, which type of cluster:

• If CLUSTER=NO (the default), the nucleus will not participate in an Adabas cluster. If CLUSTER=NO, the NUCID parameter must be set (or default) to 0.

• If CLUSTER=LOCAL, the nucleus will participate in a cluster where all nuclei run on the same operating system image. The add-on product Adabas Parallel Services is required to run in this mode.

• If CLUSTER=SYSPLEX, the nucleus will participate in a cluster where the nuclei may run on different systems within a parallel sysplex. This is supported only for z/OS systems. The add-on product Adabas Cluster Services is required to run in this mode.

If CLUSTER=LOCAL or SYSPLEX, the NUCID parameter must be set to a nonzero value that identifies the individual cluster nucleus. Also, the parameter settings MODE=SINGLE, READONLY=YES, LFIOP=0 and DTP=TM, and the use of sequential protection log datasets (DD-name/link name DDSIBA) are not allowed for cluster nuclei.

Example

The following example includes the nucleus in a cluster run with Adabas Cluster Services:

ADARUN DBID=53,CLUSTER=SYSPLEX,NUCID=5301

CMADDR and CMLADDR : GETMAIN Memory Pool Start Address

These parameters apply only to BS2000 environments running Sockets versions less than 2.2.

Note:
These parameters should only be used if required by an installation site, in which case the site will provide the needed value.

These parameters are involved with setting all required memory into a common memory pool for use by associated tasks on BS2000 above (CMADDR) or below (CMLADDR) the 16 megabyte line. They set the start address of this memory pool.

If the default value ("0") is used for a CMADDR or CMLADDR parameter, the start address depends on the value of the corresponding CMSIZE or CMLSIZE parameter:

• If the CMADDR or CMLADDR parameter value is "0" and the corresponding CMSIZE or CMLSIZE parameter is not "0", the operating system will set the start address at the next available megabyte boundary.

• If the CMADDR or CMLADDR parameter value is "0" and the corresponding CMSIZE or CMLSIZE parameter is also "0", required memory will not be obtained in a common memory pool but rather in class 6 memory.

Specific Product Recommendations

For Entire Net-Work 6 (mainframe), Software AG recommends setting the value of the CMADDR parameter to X'01200000'.

Examples

The following example allows for three (3) megabytes of user storage in the address range X'2000000' to X'4FFFFFF':

ADARUN PROG=ADANUC,CMADDR=2000000,CMSIZE=2500000

The following example allows for three (3) megabytes of user storage below 16 megabytes in the address range X'200000 to X'4FFFFF:

ADARUN PROG=ADANUC,CMLADDR=200000,CMLSIZE=25000000

CMAXCSPS : Adabas Caching Facility Storage Area Quantities

The CMAXCSPS (or CM) parameter specifies the number of storage areas that can be allocated for an ADACSH cache space in data spaces, hiperspaces, or memory objects (64-bit virtual storage). It has no effect on a cache space in extended memory, where only one Associator and one Data Storage area are allowed.

In conjunction with the CASSOMAXS and CDATAMAXS parameters, this parameter is used to control both the total amount of space that can be allocated for a cache space and the granularity with which it is allocated.

Example

ADARUN CMAXCSPS=6

Up to six Associator cache space areas of size CASSOMAXS and up to six Data Storage cache space areas of size CDATAMAXS can be allocated for a particular type of cache space.

CMDQMODE : Command Queue Mode

This parameter applies to the BS2000 operating system only.

CMDQMODE specifies whether to allocate the BS2000 memory pool for the Adabas command queue below or above the 16-MB line.

Example

The following example, places the Adabas command queue memory pool above the 16-MB line in 1-MB segments.

ADARUN PROG=ADANUC,CMDQMODE=ABOVE

CMFIX or CMLFIX : GETMAIN Memory Pool Fixed Location

These parameters apply only to BS2000 environments running Sockets versions less than 2.2.

Note:
Use these parameters only if required by an installation site, in which case the site will provide the needed value.

The ..FIX parameter is ignored if the corresponding ..SIZE parameter value is 0.

These parameters are involved with setting all required memory into a common memory pool for use by associated tasks on BS2000 above (CMFIX) or below (CMLFIX) the 16 megabyte line. This parameter specifies whether the memory pool is at a fixed location or not:

Note:
A subtask depends on the application. An example of this is Adabas Review in local mode.

Specific Product Recommendations

For Entire Net-Work 6 (mainframe), Software AG recommends setting the values of both the CMFIX and CMLFIX parameters to "YES".

Examples

The following example allows for three (3) megabytes of user storage above 16 megabytes in the address range X'2000000' to X'4FFFFFF'. This address range will also be used by the subtask:

ADARUN PROG=ADANUC,CMADDR=2000000,CMSIZE=2500000,CMFIX=YES

The following example allows for three (3) megabytes of user storage below 16 megabytes in the address range X'200000' to X'4FFFFF'. This address range will also be used by the subtask:

ADARUN PROG=ADANUC,CMLADDR=200000,CMSIZE=2500000,CMFIX=YES

CMLxxxxx Parameters

The discussion of these parameters is paired with related Adabas parameters as follows:

CMLADDR
CMLFIX
CMLSCOPE
CMLSIZE

CMSCOPE or CMLSCOPE : GETMAIN Memory Pool Scope

These parameters apply only to BS2000 environments running Sockets versions less than 2.2.

Note:
These parameters should only be used if required by an installation site, in which case the site will provide the needed value.

The ..SCOPE parameter is ignored if the corresponding ..SIZE parameter value is 0.

These parameters are involved with setting all required memory into a common memory pool for use by associated tasks on BS2000 above (CMSCOPE) or below (CMLSCOPE) the 16 megabyte line. This parameter specifies accessibility to the memory pool:

Specific Product Recommendations

For Entire Net-Work 6 (mainframe), Software AG recommends setting the values of the CMSCOPE and CMLSCOPE parameters to "GROUP".

Examples

The following example allows for three (3) megabytes of user storage at the next available megabyte boundary above the 16MB line accessible to tasks with the same user ID.

ADARUN PROG=ADANUC,CMSIZE=2500000,CMSCOPE=GROUP

The following example allows for three (3) megabytes of user storage at the next available megabyte boundary below the 16MB line accessible to tasks with the same user ID.

ADARUN PROG=ADANUC,CMLSIZE=2500000,CMLSCOPE=GROUP

CMSIZE or CMLSIZE : GETMAIN Memory Pool Use and Size

These parameters apply only to BS2000 environments running Sockets versions less than 2.2.

Note:
These parameters should only be used if required by an installation site, in which case the site will provide the needed value.

These parameters are involved with setting all required memory into a common memory pool for use by associated tasks on BS2000 above (CMSIZE) or below (CMLSIZE) the 16 megabyte line. These parameters determine whether a common memory pool is used and if so, its size:

• If the ..SIZE parameter value is 0, the default, the required application memory is obtained in the class 6 memory of the system.

• If the ..SIZE parameter value is not 0, the required application memory is obtained in a common memory pool of the specified size rounded up to the next megabyte.

Specific Product Recommendations

For Entire Net-Work 6 (mainframe), Software AG recommends setting the CMSIZE parameter to "32000000" and the CMLSIZE parameter to "4096000".

Examples

The following example allows for three (3) megabytes of user storage at the next available megabyte boundary above the 16 megabyte line accessible to tasks with the same user ID.

ADARUN PROG=ADANUC,CMSIZE=2500000

The following example allows for three (3) megabytes of user storage at the next available megabyte boundary below the 16 megabyte line accessible to tasks with the same user ID.

ADARUN PROG=ADANUC,CMLSIZE=2500000

CRETRY : Adabas Caching Facility Retry Time

The CRETRY (or CR) parameter specifies the amount of time (in seconds) between attempts to acquire an area of cache space if the previous GETMAIN or space allocation failed.

If an area of cache space cannot be allocated, ADACSH waits for the specified number of seconds before attempting to allocate the area of cache space again. During this period of time, caching continues in the other areas of the cache space already allocated, but the maximum allowed cache space is not available. If, after the time period has elapsed, there is a request to cache a RABN and no space is available in the current allocation, ADACSH attempts to allocate the area of cache space again. These attempts continue until the cache space is successfully allocated.

Note:
CRETRY does not apply to an area of cache space that was released due to a timeout (see CCTIMEOUT).

Example

ADARUN CRETRY=500

If an attempt to allocate an additional area of a cache space fails, another attempt to cache a RABN in the cache space in question is made after 500 seconds. If the currently allocated space is still full, the attempt is again made to allocate an additional area of cache space.

CSTORAGE : Adabas Caching Facility Override Cache Type

The CSTORAGE parameter can be used to indicate that all RABNs for the database are to be cached using the system defaults and the type of cache specified by this parameter.

The CSTORAGE (or CS) parameter overrides any CASSOxxx and/or CDATAxxx parameter that may be specified. If the CSTORAGE parameter is specified, all RABNs for the database are cached using the system defaults and the type of cache space specified by CSTORAGE.

Note:
This parameter is mutually exclusive with the CFILE and CXFILE parameters.

Extended memory is the only option available on BS2000 RISC machines. Hiperspace is an option only in z/OS environments. Virtual 64 storage is available only in z/OS environments.

Example

ADARUN CASSOHSP=1-1795
ADARUN CDATAHSP=81-135,1140-1298,136-170,181-230 ADARUN
CSTORAGE=EXTENDED

ADACSH caches all Associator and Data Storage RABNs in extended memory (above the 16 megabyte line). All CASSOHSP and CDATAHSP RABN ranges are ignored.

CT : Command Timeout Limit

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 cancelled;

• 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 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

CWORKSTORAGE : Adabas Caching Facility Work Area Cache Type

The CWORKSTORAGE (or CWORKS) parameter specifies the type of cache space to use for the CWORK2FAC and/or CWORK3FAC areas.

Extended memory is the only option available on BS2000 RISC machines. Hiperspace is an option only in z/OS environments. Virtual 64 storage is available only in z/OS environments.

If CWORKSTORAGE is not specified, but the CWORK2FAC and/or CWORK3FAC parameters are specified, then the default CWORKSTORAGE is as follows:

• DATASPACE for BS2000 (except RISC machines), z/OS, z/VSE, z/VM

• EXTENDED for BS2000 RISC machines

Example

ADARUN CWORKSTORAGE=HIPERSPACE

For Work parts 2 and/or 3, cache space is allocated in hiperspace.

CWORK2FAC : Adabas Caching Facility Work Part 2 Percentage

The CWORK2FAC (or CWORK2) parameter specifies the percentage of Work part 2 to be cached.

The number of Work part 2 RABNs to be cached is computed by multiplying the specified percentage factor by the number of RABNs allocated for Work part 2.

Each cache space allocation is based on the number of RABNs and the device block size, rounded up to the nearest 4-kilobyte boundary.

cache size = int ( ( ( #RABNs · blksize ) + 4095 ) · 4096 ) + 4096

- where

#RABNs = int ( WORK part 2 size · CWORK2FAC )

If the specified CWORK2FAC cannot accommodate the working set of Work part 2 RABNs, the RABNs beyond the computed CWORK2FAC are not cached. Normal I/O operations are performed for the non-cached Work part 2 RABNs.

For any percentage less than 100, the writes to Work are still done; however, RABNs read from Work will be obtained from the cache if the RABN is available.

Example

ADARUN CWORK2FAC=50

ADACSH caches 50 percent of Work part 2, beginning from the first block. If Work part 2 contains 1000 blocks, a cache space is allocated for 500 blocks. If the Work device type is a 3380, the cache space size required is

cache size = int ( ( ( #RABNs · blksize ) + 4095 ) ÷ 4096 ) · 4096 
               = int ( ( ( 500 · 5492 ) + 4095 ) ÷ 4096) · 4096 
               = 2,750,095

CWORK3FAC : Adabas Caching Facility Work Part 3 Percentage

The CWORK3FAC (or CWORK3) parameter specifies the percentage of Work part 3 to be cached.

The number of Work part 3 RABNs to be cached is computed by multiplying the specified percentage factor by the number of RABNs allocated for Work part 3.

Each cache space allocation is based on the number of RABNs and the device block size, rounded up to the nearest 4-kilobyte boundary.

cache size = int ( ( ( #RABNs · blksize ) + 4095 ) ÷ 4096 ) · 4096

- where

#RABNs = int ( WORK part 3 size · CWORK3FAC )

If the specified CWORK3FAC cannot accommodate the working set of Work part 3 RABNs, the RABNs beyond the computed CWORK3FAC are not cached. Normal I/O operations are performed for the non-cached Work part 3 RABNs.

For any percentage less than 100, the writes to Work are still done; however, RABNs read from Work will be obtained from the cache if the RABN is available.

Example

ADARUN CWORK3FAC=50

ADACSH caches 50 percent of Work part 3, beginning from the first block of Work part 3. If Work part 3 contains 1000 blocks, a cache space is allocated for 500 blocks. If the Work device type is a 3380, the cache space size required is

cache size = int ( ( ( #RABNs · blksize ) + 4095 ) ÷ 4096 ) · 4096 
               = int ( ( ( 500  5492 ) + 4095 ) ÷ 4096 ) · 4096 
               = 2,750,095

CXFILE : Adabas Caching Facility Excluded Files

The CXFILE parameter is used to exclude files from caching.

Note:
CXFILE is mutually exclusive with CASSOxxx, CDATAxxx, and CSTORAGE parameters. If any of these parameters is used with CXFILE, they will be ignored.

Multiple CXFILE parameters may be specified.

CFILE and CXFILE parameters together are processed in order from left to right (or top to bottom if different ADARUN statements are used).

Examples

ADARUN CACHE=YES,CFILE=(13-19),CXFILE=(17)

Files 13 through 19 are cached using the standard defaults for class of service (3), scope (BOTH), and cache (DATASPACE) with the exception of file 17, which is not cached.

ADARUN CACHE=YES,CFILE=(13-19),CXFILE=(17),CXFILE=(16,,DATA)

Files 13 through 19 are cached using the standard defaults; however, file 17 is not cached and only the associated Associator RABNs are cached for file 16 since the Data Storage RABNs are excluded.

DATACACHE : Data Storage Controller Caching

This parameter applies to the operating systems z/OS and z/VM only.

Notes:

1. If Data Storage blocks are highly scattered or the update frequency is low, controller caching can cause longer I/O response times.
2. ADARUN caching control parameters also exist for the Associator (ASSOCACHE), the work area (WORKCACHE), the sort area (SORTCACHE), and the temp area (TEMPCACHE).

Example

The following example runs the nucleus without controller caching for the Data Storage data set.

ADARUN PROG=ADANUC,DATACACHE=NO

DBID : Database Identification

Note:
If you specify the DBID parameter, you must also specify the ADARUN SVC parameter.

Example

The following example runs the ADAINV utility against physical database 2 using SVC 241.

ADARUN PROG=ADAINV,DBID=2,SVC=241

DEVICE : Device Type

The device type of the external storage device on which the first block of the Associator is stored.

This device type is also used as default for most device type parameters.

The Adabas Installation documentation specifies the device types supported by Adabas.

Some device type designations have been reserved for special use such as VSAM data set support on z/OS systems. The following is a partial list of reserved device types and their uses:

For more information about VSAM device usage, see Device and File Considerations in the Adabas Installation documentation.

Example

The following example runs the ADALOD utility and stores the first block of the Associator on a 3390 device.

ADARUN PROG=ADALOD,DEVICE=3390

DIRRATIO / ELEMENTRATIO : Cluster Cache Directory-to-Data Elements Ratio

The DIRRATIO and ELEMENTRATIO parameters together define the ratio of directory elements to data elements in the Adabus Cluster Services coupling facility cache structure or the Adabas Parallel Services global cache area.

This ratio influences the allocation of the cache structure/area when the first cluster nucleus starts. It has no influence on the cache structure/area when a subsequent nucleus starts.

The DIRRATIO / ELEMENTRATIO ratio is optionally used in Adabas cluster environments to tune the cache structure/area for better performance.

Directory elements are used to keep track of the cluster members that have individual blocks in their local caches (buffer pool and Adabas Caching Facility caches), so that the blocks can be invalidated should other members modify them.

Data elements are used to hold the contents of Associator and Data blocks from the database.

If the number of directory elements is insufficient, existing directory elements are reused and the blocks associated with those directory elements are invalidated and can then no longer be reused. When blocks become invalid even though they have not been modified, they must be reread and registered again the next time they are referenced and validated.

It is generally better to reassign storage for data elements to keep more Associator and Data blocks in the cache structure/area than to define too many directory elements in the cache. More data elements than necessary can be used to keep additional blocks to improve the cache efficiency.

The number of directory elements need not be greater than the sum of the sizes of all buffer pools plus the amount of space represented by data elements (number of data elements times data element size), divided by the smallest Associator block size.

You can use the Adabas Online System cache structure size calculator described in Estimating Sizes for the Cache Structure in a Cluster Environment in Adabas Parallel Services Operations or Adabas Cluster Services Operations documentation to determine appropriate global cache area sizes and DIRRATIO/ELEMENRATIO parameter values.

When connecting to the cache structure/area during startup, the ADAX57 message reports the number of directory and data elements allocated and the size of a data element.

DSF : Adabas Delta Save Facility Control

The DSF parameter controls the Adabas Delta Save Facility for an Adabas nucleus or utility. If Adabas Delta Save is not installed on your system, specifying this parameter may cause an error.

Example

The following example runs the Adabas nucleus in DSF mode; performing Adabas Delta Save functions is possible for this nucleus.

ADARUN PROG=ADANUC,DSF=YES

DSFEX1 : Delta Save Facility Exit

Used in conjunction with the Adabas Delta Save Facility, the format of the user exit parameter is

DSFEX1=exit-name

where

Only one program may be specified for the DSF user exit. Only one DSF user exit may be specified. See the Adabas Delta Save Facility documentation for more information.

Example

This example indicates that the Adabas nucleus should use the Delta Save Facility with the user exit routine DSAVEPGM.

ADARUN PROG=ADANUC,DSF=YES,DSFEX1=DSAVEPGM

DTP : Distributed Transaction Processing Control

The DTP parameter controls the distributed transaction processing status of the Adabas nucleus. If Adabas Transaction Manager is not installed on a separate nucleus in your system, specifying this parameter may cause an error.

Example

The following example indicates that the nucleus will participate as a resource manager in a distributed transaction processing system coordinated by a transaction manager.

ADARUN PROG=ADANUC,DTP=RM

DUALCLD : Dual Command Log Device Type
DUALCLS : Dual Command Log Size

The DUALCLD and DUALCLS parameters specify the type of external storage device used for dual command logging and the number of blocks available for each dual command log data set. These parameters must be used together; if you specify one parameter, you must also specify the other parameter. If you specify a user exit, it must be UEX2.

The Adabas Installation documentation specifies the device types that Adabas supports.

Both dual command logging data sets must be formatted using the ADAFRM utility before they are used.

The maximum size of the data set depends on the limits of the operating system and on the requirements of the user.

Example

The following example runs the Adabas nucleus with command logging and uses a model 3380 device for dual command logging. The size of each command log data set is 1350 blocks, based on an allocation of 10 cylinders. (Each cylinder of a 3380 device has 15 tracks, and each track can contain 9 blocks of command log data. Thus, 10 cylinders = 10 x 15 x 9 = 1350 blocks).

ADARUN PROG=ADANUC,LOGGING=YES,DUALCLD=3380,DUALCLS=1350

DUALPLD : Dual Protection Log Device Type
DUALPLS : Dual Protection Log Size

The DUALPLD and DUALPLS parameters specify the type of external storage device used for dual data protection logging and the number of blocks available for each log data set. These parameters must be used together; if you specify one parameter, you must also specify the other parameter. If you specify a user exit, it must be UEX2.

When these parameters are specified, dual protection logging is activated for the session. See Adabas Restart and Recovery for information about dual protection logging.

The Adabas Installation documentation specifies the device types that Adabas supports.

Both dual protection log data sets must be formatted using the ADAFRM utility before they are used. The appropriate JCL for the data sets is required.

Example

The following example runs the Adabas nucleus with dual data protection logging and uses a model 3380 device; the size of each dual log data set is 1200 blocks, based on an allocation of 10 cylinders. (Each cylinder of a 3380 device has 15 tracks, and each track contains 8 blocks of protection log data. Thus, 10 cylinders = 10 * 15 * 8 = 1200 blocks).

ADARUN PROG=ADANUC,DUALPLD=3380,DUALPLS=1200

EXCPVR : Control EXCP or EXCPVR Use

The EXCPVR parameter controls whether EXCP or EXCPVR should be used when from an APF-authorized load library in z/OS environments. If, EXCPVR=YES is specified, EXCPVR is used; if EXCPVR=NO is specified, EXCP is used.

Note:
If EXCPVR=YES is specified when running from a non-APF-authorized load library, this parameter is ignored.

Example

The following example runs Adabas APF-authorized using EXCP.

ADARUN PROG=ADANUC,EXCPVR=NO

FASTPATH : Adabas Fastpath Control

The FASTPATH parameter controls the optional Adabas Fastpath product. If Adabas Fastpath is installed on your system, FASTPATH=YES enables the full functionality of the product.

If Adabas Fastpath is not installed on your system, FASTPATH=YES invokes the Adabas Fastpath command analysis sampler AFPLOOK that is provided with Adabas.

The demo version of Adabas Online System that is supplied with Adabas provides access to the Adabas Fastpath online system SYSAFP so that the AFPLOOK sample can be viewed online exactly as it would appear if Adabas Fastpath were installed. For complete information about AFPLOOK, read AFPLOOK.

Example

The following example runs Adabas Fastpath with Adabas.

ADARUN PROG=ADANUC,FASTPATH=YES

FMXIO : Parallel LFIOP I/O Operations

The LFIOP parameter enables asynchronous buffer flush operation and sets the I/O pool size. The FMXIO parameter sets the limit on the number of I/O operations that can be started in parallel by LFIOP flush processing.

Note:
When an SLOG file is defined for use on the Event Replicator Server, replication data may be written and read from the SLOG file. With this in mind, consider the values set for the following ADARUN performance and tuning parameters: ASYTVS, FMXIO, LBP, LDEUQP, LFIOP, LP, NH, NISNHQ.

Parameter Dependencies

The precise meaning of the FMXIO parameter depends on the setting of the ASYTVS parameter):

• When ASYTVS=YES (perform buffer flushes by volume), FMXIO specifies the number of I/Os to be started in parallel on each volume. The minimum and default number is 1; the maximum number is 16. If the specified number exceeds that, it is automatically reduced to 16.

• When ASYTVS=NO (perform buffer flushes in ascending RABN sequence, without regard to the distribution of the blocks over volumes), FMXIO specifies the number of I/Os to be started in parallel overall. The minimum number is 1; the maximum value is 100; and the default is 60.

Dynamic Modification

The setting of FMXIO can be modified dynamically using the command FMXIO=nnn from the operator console or the Modify Parameter function of Adabas Online System.

Example

The following example specifies that a maximum of 30 I/O operations for asynchronous buffer flushes can be started in parallel:

ADARUN PROG=ADANUC,ASYTVS=NO,FMXIO=30

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

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.

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.

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

GROUPS : User Group Interprocess Communication

This parameter applies to the BS2000 operating system only.

This parameter limits the accessibility of ADARER and its ID table (IDT) to a group of users with the same logon ID.

Note:
More than one IDT with the same name can be used if one is set to GROUPS=NO (the default) and the rest specify GROUPS=YES.

Example

The following example allows BS2000 users access to the IDT that starts under the same logon ID as this Adabas nucleus.

ADARUN PROG=ADANUC,DBID=11,GROUPS=YES

HEXnn :Hyperdescriptor User Exit

Used in conjunction with the hyperdescriptor facility, the format of the parameter is

HEXnn=exit-name

where

Only one program may be specified for each hyperdescriptor exit. Up to 31 hyperdescriptor exits may be specified (in any order). See the User Exits documentation for more information.

Example

The following example runs the Adabas nucleus using hyperdescriptor exits 1 and 2. It also gives control to the user routine UHYPER1 at hyperdescriptor exit 1 and gives control to the user routine UHYPER2 at hyperdescriptor exit 2.

ADARUN PROG=ADANUC,HEX01=UHYPER1,HEX02=UHYPER2

IDTNAME : Define ID Table Name

This parameter applies to the BS2000 operating system only.

Defines a name for an (alternate) Adabas environment. The name must be eight characters long and must begin with the characters "ADA".

Note:
All users of the new ID table must include the IDTNAME in either the ADARUN statement or ADALNK parameters.

Specific Product Recommendations

For Entire Net-Work 6 (mainframe), Software AG recommends setting the value of the IDTNAME parameter to "ADABAS5B".

Example

The following example defines the name ADAOURDB for the second Adabas environment.

ADARUN PROG=ADANUC,IDTN=ADAOURDB

IDTPSUP : Suppress IDTNAME in Adabas Output Messages

This parameter applies to the BS2000 operating system only.

This parameter allows you to suppress the IDTNAME in Adabas messages such as:

ADAM83 dbid NEW IDT CREATED, NAME=idtname, GROUPS=NO

Example

The following specification produces output messages with X's replacing the IDT name.

ADARUN IDTPSUP=YES

For example, the ADAM83 message would print as:

ADAM83 dbid NEW IDT CREATED, NAME=XXXXXXXX, GROUPS=NO

IGNDIB : Ignore DIB Entry for Adabas Nucleus

The DIB is the data integrity block in the Associator. The DIB contains an entry that indicates whether an Adabas session is active for the database. This feature prevents an update nucleus session from being started while another one is running on the same database; it is especially important when several CPUs share the same database DASD devices. The DIB entry is automatically released when the Adabas session is terminated normally.

This parameter indicates whether this update nucleus session should ignore and delete the entry in the data integrity block (DIB) in the Associator.

Note:
Software AG recommends that you use IGNDIB=YES only once and immediately remove it from the JCL. If no DIB entry exists when IGNDIB=YES is specified, the nucleus terminates abnormally.

Example

The following example runs an Adabas update session and ignores and deletes the DIB entry for an active Adabas update nucleus.

ADARUN PROG=ADANUC,IGNDIB=YES

IGNDTP : Ignore Two-Phase Commit Area (Work Part 4)

Warning: This parameter is for emergency use only; contact your Software AG technical support representative before using it. Whenever the information on Work part 4 is ignored, the integrity of the incomplete global transactions that are related to that information cannot be guaranteed.

IGNDTP=YES can be specified with DTP=NO or DTP=RM.

When DTP=NO, the nucleus will not start if there is data in Work part 4 related to the recovery of previously incomplete global transactions. In this situation, specifying IGNDTP=YES forces the nucleus to ignore the data in Work part 4 and start anyway.

When DTP=RM, the nucleus also ignores any data on Work part 4 and reinitializes the area. This can be useful during a recovery when the state and correctness of the incomplete global transactions that are stored on Work part 4 has already been established.

Example

The following example runs an Adabas update session without support for distributed transactions; it ignores data in the Work part 4 area left over from the previous session with support for distributed transaction processing.

ADARUN PROGRAM=ADANUC,DTP=NO,LDTP=8,IGNDTP=YES

INTNAS : Time Interval Between SYNS 60 Checkpoints

The SYNS 60 statistic checkpoint is generated by the Adabas nucleus and written to the Adabas Checkpoint system file. It may be displayed using the CPLIST function of the ADAREP utility or Adabas Online System. For more information about checkpoints see the ADAREP utility discussion in the Adabas Utilities documentation.

INTNAS allows you to set the time interval (in units of 1.048576 seconds) between SYNS 60 checkpoints. The default (3600) is approximately 1 hour meaning that nucleus statistics will be recorded once each hour.

Example

The following example sets Adabas so that nucleus statistics are recorded every 30 minutes.

ADARUN PROGRAM=ADANUC,INTNAS=1800

LBP : Length of Buffer Pool

The maximum number of bytes to be used for the Adabas buffer pool during a session.

Adabas allocates the number of bytes specified to the Adabas buffer pool if sufficient memory is available. A minimum of 80000 bytes must be available to successfully initiate a session. For performance reasons, however, Software AG recommends that you specify at least 50000 bytes per thread. Ensure that sufficient memory is available to accommodate the LBP size specified. If asynchronous buffer flush management is used (that is, the LFIOP parameter specifies a nonzero value), the LBP value must be greater than that specified by LFIOP.

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

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

The buffer efficiency statistic can be used to determine the optimal size of the parameter.

Note:
When an SLOG file is defined for use on the Event Replicator Server, replication data may be written and read from the SLOG file. With this in mind, consider the values set for the following ADARUN performance and tuning parameters: ASYTVS, FMXIO, LBP, LDEUQP, LFIOP, LP, NH, NISNHQ.

Example

The following example allocates a maximum of 800,000 bytes to the Adabas buffer pool for this session.

ADARUN PROG=ADANUC,LBP=800000

LCP : Length of Security Pool

The maximum number of bytes to be used for the Adabas security pool during a session. The pool is used to keep security information in memory in order to optimize performance.

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

Example

The following example allocates a maximum of 50,000 bytes to the Adabas security pool for this session.

ADARUN PROG=ADANUC,LCP=50000

LDEUQP : Length of Unique Descriptor Pool

The unique (UQ) descriptor pool comprises elements that are the length of a unique descriptor value plus 11 bytes. The UQ descriptor pool should be large enough to hold all unique descriptors that are being changed by all transactions at any point in time.

In environments running in 31-bit adressing mode, the LDEUQP pool is allocated above the 16-megabyte line.

Note:
When an SLOG file is defined for use on the Event Replicator Server, replication data may be written and read from the SLOG file. With this in mind, consider the values set for the following ADARUN performance and tuning parameters: ASYTVS, FMXIO, LBP, LDEUQP, LFIOP, LP, NH, NISNHQ.

Example

For example, assuming that the average length of unique descriptor values is about 9 bytes, the following Adabas session can process a maximum of about 50 unique descriptors at one time.

ADARUN PROG=ADANUC,LDEUQP=1000

LDTP : Length of Distributed Transaction Processing Area (Work Part 4)

If you have Adabas Transaction Manager Version 7.4 or earlier installed, this parameter specifies the length of the distributed transaction processing area, Work part 4:

• If DTP=RM and LDTP is either unspecified or specified as `0', the length of Work part 4 is equivalent to that specified for Work part 1 in the ADARUN LP parameter.

• If specified, the ADARUN LDTP must be at least 200 blocks. A safe size of LP/4 is a good value to start with. If you do not specify an LDTP value, it is set to the value of the LP parameter.

• When Work part 4 contains data about incomplete transactions, it may be increased in size but not decreased. Work part 4 must be empty before it can be made smaller.

If you have Adabas Transaction Manager Version 7.5 or later installed, this parameter specifies the size (in blocks) of the WORK4 index which is used to administer the data on DDWORKR4:

• If DTP=RM and LDTP is either unspecified or specified as "0", a default of 8 blocks is used.

• If specified, the ADARUN LDTP must be at least 8 blocks. The maximum size that can be specified is the size of the DDWORK4 data set divided by 8.

DDWORKR4 is a container data set used for the same purpose as Work part 4 of DDWORKR1 was used previously, with the difference that DDWORKR4 can be used in parallel by all members in a cluster. The DDWORKR4 data set should be allocated and formatted in the normal way, using a block size greater than or equal to DDWORKR1. It should be at least as large as the cluster’s LP parameter of the database or cluster.

Example

In the following example, the LP parameter specifies 2000 blocks for the data protection area (Work part 1). This example also uses 2500 blocks for the distributed transaction processing area on the Adabas Work data set (part 4).

ADARUN PROG=ADANUC,DTP=RM,LP=2000,LDTP=2500

LFIOP : Asynchronous Buffer Pool Control

The asynchronous buffer flush I/O pool enables asynchronous Adabas buffer flush operation and defines the size of the related buffer. Specifying a non-zero value for LFIOP enables asynchronous buffer flush operation; the value specified determines the buffer size, in bytes.

If LFIOP is not specified or zero is specified (the default), synchronous buffer flushing is performed. Note that flushing is always synchronous in single-user mode (MODE=SINGLE).

When LFIOP=1 or LFIOP=n and the specified or calculated flush pool size is less than 80000 bytes, Adabas uses a size of 80000 bytes.

In environments running in 31-bit addressing mode, the I/O pool is allocated above the 16-megabyte line.

Note:
When an SLOG file is defined for use on the Event Replicator Server, replication data may be written and read from the SLOG file. With this in mind, consider the values set for the following ADARUN performance and tuning parameters: ASYTVS, FMXIO, LBP, LDEUQP, LFIOP, LP, NH, NISNHQ.

Example

The following example enables asynchronous buffer flush operation for this session and allocates an I/O pool of 200,000 bytes (25% of the LBP size).

ADARUN PROG=ADANUC,LFIOP=1,LBP=800000

LFP : Length of Internal Format Buffer Pool

This pool stores internal format buffers used with Adabas read and update commands as described in the Adabas Command Reference documentation.

Each internal format buffer pool entry requires approximately 60 + (64 * n) bytes, where n equals the number of fields referenced in the command.

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

In environments running in 31-bit addressing mode, the LFP pool is allocated above the 16-megabyte line.

Example

The following example allocates 8,000 bytes for the Adabas internal format buffer pool for this session.

ADARUN PROG=ADANUC,LFP=8000

LI : Length of Table of ISNs (TBI)

LI specifies the number of bytes allocated for the table of ISNs (TBI), which is used to store ISN lists (overflow ISNs or saved ISN lists). Each ISN list is identified by a command ID (CID) and stored in a TBI element.

You must also specify a value for the NSISN parameter, which sets the maximum number of ISNs per TBI element. Each TBI element has a length of 64 + ( NSISN * 4 ) bytes.

The number of TBI elements required determines the length of the TBI. For complex searches, the Adabas nucleus builds temporary TBI elements in addition to the permanent TBI element; for example, for holding the results of descriptor searches, for reading the result records in Data Storage and collecting matches, or for holding the results of the partial criteria associated with the R operator. Although the temporary TBI elements are deleted at the end of a search, the TBI must be large enough to hold all of the temporary and permanent TBI elements in parallel during search processing.

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

When running with Adabas expanded files, a larger-than-normal LI value is recommended.

In environments running in 31-bit adressing mode, the LI pool is allocated above the 16-megabyte line.

Example

The following example allocates 30,000 bytes for the table of ISN list IDs for this session.

ADARUN PROG=ADANUC,LI=30000

LNKGNAME: Link Globals Table Name

The parameter name LNKGNAME may be abbreviated to LGN.

Notes:

1. If you specify the LNKGNAME parameter, you must also specify the ADARUN DBID and SVC parameters.
2. To use this and other keywords for a batch or TSO job step, the application must be linked with the ADAUSER load module and call Adabas to invoke the ADAUSER load module.
3. If the job step specifies PROG=USER or PROG=RENTUSER with no LNKGNAME keyword, either the ADALNK or ADALNKR module will be loaded by ADARUN. This is intended to allow the Adabas 7 batch/TSO link routines to be loaded and executed for the job step. Take care to ensure the proper load library concatenation is provided on the job step so the Adabas 7 ADALNK or ADALNKR module will be loaded. This should allow gradual migration of job steps from Adabas 7 to Adabas 8 as required.

Example:

In the following example, the link globals table in module MYGBLS is used.

ADARUN PROG=USER,LNKGNAME=MYGBLS

LOCAL : Local Nucleus or Adabas Review Hub

Defines an isolated Adabas nucleus or Adabas Review hub that is only available locally. The nucleus or hub is unknown to Entire Net-Work. A nucleus or Adabas Review hub specifying LOCAL=YES (the default) can have the same database ID or hub ID as another database nucleus or Review hub on another network node.

Example

In the following example, the Adabas nucleus is isolated and cannot be addressed by other Entire Net-Work nodes.

ADARUN PROG=ADANUC,LOCAL=YES

LOGGING / LOGxxxx : Command Logging Control

The LOGGING parameter specifies whether to use command logging for the Adabas session. The LOGxxxx parameters specify the type of information to be logged. Valid values are YES and NO for all of these parameters.

Note:
User exit 4 is still called even if LOGGING=NO. The only way to disable user exit 4 is to remove the ADARUN UEX4 parameter from the Adabas run.

If you specify LOGGING=YES, you must also specify YES for one or more of the following ADARUN LOGxxxx parameters. By default, each type of information is not logged.

Note:
Some parameters are only valid when CLOGLAYOUT=5; other parameters are only valid when CLOGLAYOUT=8.

¹ LOGABDX=YES can only be used if CLOGLAYOUT=8 is used and if LOGUX=YES.

² You can specify the LOGCB parameter with CLOGLAYOUT=5, however its value will be ignored because when CLOGLAYOUT=5 is specified, the Adabas control block is always written to the command log file.

³ LOGCLEX=YES requires REVIEW=NO although the Adabas Review modules must be available. Command log records with CLEX can be viewed using the batch program REVIEWB.

⁴ LOGMB=YES can only be used if CLOGLAYOUT=8 is used and if LOGRB=YES.

You can use Adabas operator commands or Adabas Online System to modify logging parameters during session execution.

Example

The following example runs the Adabas nucleus with command logging and logs the Adabas control block.

ADARUN PROG=ADANUC,LOGGING=YES,LOGCB=YES

LOGSIZE : Maximum Command Log Size

This parameter controls the maximum block size for the sequential command log DD/LOG. The default value is identical to the value of the QBLKSIZE parameter. If dual or multiple command logging is used, this parameter is ignored.

Example

In the following example, the blocksize of the command log is set as 2,000 bytes.

ADARUN PROG=ADANUC,LOGSIZE=2000

LP : Length of Data Protection Area (Work Part 1)

The LP parameter specifies the number of blocks to allocate to the Work data protection area, which is part 1 of the Work data set. This area must be large enough to accommodate the data protection information for the current transaction for all ET logic users. Details can be found in Adabas Restart and Recovery.

The LP parameter is no longer limited to 65535 blocks; however, it is still limited by the size of the Work data set and the sizes of Work parts 2, 3, and 4.

Notes:

1. For any pending autorestart processing, Adabas retains and uses the value of the LP parameter from the previous session. If the LP parameter for the new session is specified with a different value than in the previous session, the nucleus will process any autorestart using the old value of LP, and establish the new LP size at the end of the autorestart.
2. When an SLOG file is defined for use on the Event Replicator Server, replication data may be written and read from the SLOG file. With this in mind, consider the values set for the following ADARUN performance and tuning parameters: ASYTVS, FMXIO, LBP, LDEUQP, LFIOP, LP, NH, NISNHQ.

Example

The following example uses 2,000 blocks to store data protection information on the Adabas Work data set.

ADARUN PROG=ADANUC,LP=2000

LQ : Length of Sequential Command Table

The table of sequential commands contains internal entries required during the processing of the Adabas read sequential (L2/L5, L3/L6, and L9) commands.

Each sequential pass of an Adabas file requires one entry in this table. Each table entry requires approximately 60-100 bytes, depending on the command type. Additionally, a variable portion (descriptor value) is required in the table entry for the L3/L6/L9 commands. An entry is deleted when an end-of-file condition is detected during sequential processing or when an RC or CL command is issued.

The Adabas session statistics or Adabas Online System can be used to tune this parameter for the next session. If using expanded files, the LQ value may need to be set to a higher-than-normal value.

The LQ value also determines the maximum number of command IDs that each user can specify. See the NQCID parameter description, later in this chapter, for more information.

In environments running in 31-bit adressing mode, the LQ pool is allocated above the 16-megabyte line.

Example

The following example allocates 30,000 bytes for the table of sequential commands for this session.

ADARUN PROG=ADANUC,LQ=30000

LRDP : Length of the Redo Pool

The LRDP parameter specifies the size of the redo pool in an Adabas Cluster Services or Adabas Parallel Services nucleus. It has an effect only when CLUSTER=SYSPLEX or LOCAL has also been specified. Its default is the size of the flush I/O pool (LFIOP parameter) of the cluster nucleus.

• If LRDP is set to zero, the cluster nucleus performs immediate publishing: Updated database blocks are always written to the global cache at the time each update takes place.

• If LRDP is set to (or defaults to) a nonzero value, the cluster nucleus performs deferred publishing: The writing of updated database blocks to the global cache is deferred until later. However, updates are always published in the global cache before the transactions they belong to are committed (by ET commands). The redo pool is used to maintain descriptions of all unpublished updates, in case they need to be redone due to concurrent updates to the same blocks by other nuclei in the cluster.

By combining multiple updates to the same block into a single write-to-cache operation, deferred publishing tends to result in fewer read and write operations from and to the global cache than immediate publishing. Depending on the type of application workload, this may have a large positive effect on performance. This is especially the case for Adabas Cluster Services, where frequent communication with the cache in the coupling facility may cause a high overhead.

Recommendation: For Adabas Cluster Services, specify a nonzero LRDP parameter (or use the default).

Different nuclei in the same cluster can have different settings of LRDP. It is also possible, although not recommended, to run one nucleus with LRDP=0 and another one with LRDP>0.

If the redo pool specification is too small and the pool runs full, the nucleus will write additional updated blocks to the global cache before the surrounding transactions end. Such additional cache writes may hurt system performance.

The nucleus reports on the usage (high watermark) of the redo pool in a shutdown statistic and in the response to the DRES operator command or the corresponding AOS or ADADBS OPERCOM functions.

LRPL :Adabas or Event Replicator Replication Pool Size

Example:

ADARUN PROG=ADANUC,REPLICATION=YES,LRPL=50000

Notes:

1. The LRPL parameter should be specified for an Adabas nucleus running with parameter REPLICATION=YES.
2. The LRPL parameter should be specified for a Event Replicator database.
3. The LRPL parameter values in the Adabas nucleus and the Event Replicator Server may be different.
4. Software AG recommends setting LRPL to a relatively large value (e.g. LRPL=40M or greater). To determine what this setting should be for your site, you could run Adabas in a test environment with replication turned on, simulate the activity in the production environment on this test system, and use the Adabas DRES operator command to view the current and high-water mark of replication pool usage.

LS : Length of Internal Sort Area

Note:
To ensure that a single search command does not use too much of the work pool space, the maximum LS value must be less than or equal to the LWP (work pool length) minus the minimum LS value (19968) divided by two (LS = LWP/2 - 19968). See the LWP parameter.

The LS parameter specifies the maximum number of bytes within the Work pool to be used for sort work space during the processing of a single command of the following type:

• S2 and S9 commands;

• complex search commands, which require the storage of bit strings.

The following formula may be used to estimate the number of Adabas ISNs that may be sorted in the work space provided (S2 or S9 commands):

Notes:

1. TOPISN is the highest ISN currently in use for the file, less (MINISN - 1). TOPISN is not controlled by a parameter.
2. 4-byte ISNs are used for the internal sort area, regardless of the ISNSIZE specified for the file.

If the TOPISN in the file is less than 65536:

If the TOPISN in the file is greater than 65536:

For complex searches, it is desirable for performance reasons to set LS to the next integer multiple of 256 bytes greater than TOPISN / 8.

For example, if TOPISN = 480000, then TOPISN / 8 = 60000, so LS should be set to the next higher multiple of 256, namely 60160.

Example

In the following example, the maximum amount of internal sort space during this session is set at 60,160 bytes.

ADARUN PROG=ADANUC,LS=60160

LU : Length of Intermediate User Buffer Area

The LU parameter is optional. The size specified must be large enough to accommodate all Adabas control information (108 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 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.

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. On z/OS and VM systems, LU cannot exceed a value greater than that produced by the following calculation: (NABvalue x 4096); on z/VSE and BS2000 systems, LU cannot exceed a value greater than that produced by the following calculation: (NABvalue x 4096) – 256. For more information about the NAB parameter, read NAB: Number of Attached Buffers.
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 7.4, the LU parameter must be greater than or equal to 164,000. 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.

• 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 setting must be greater than or equal to 164,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

LWKP2 : Length of ISN List Processing Area (Work Part 2)

This parameter specifies the size (in blocks) of the Adabas Work part 2, which holds intermediate ISN lists during Sx commands.

If LWKP2=0 (the default), Adabas calculates the Work part 2 size automatically using the following formula:

WORK2 = 22 + 2 * (4 * RECORDS / (BLKSIZE - 16))

where

If you choose not to use LWKP2=0, the minimum value is LWKP2=20 blocks.

Note:
An Adabas internal table requires one byte of storage for each Work part 2 block.

Exampl:

For example, for the following Adabas session, the size of the Adabas Work part 2 is 50,000 blocks.

ADARUN PROG=ADANUC,LWKP2=50000

LWP : Length of Adabas Work Pool

Note:
The LWP (work pool length) parameter value must be equal to or greater than the LS (internal sort area length) value plus its minimum value (19968) multiplied by 2; that is, (LS + 19968) * 2.

The Adabas work pool area is used to store the following:

• descriptor value tables (DVT);

• intermediate user buffer areas (see parameter LU);

• sort work space areas (see parameter LS);

• work space during session and command execution.

In environments running in 31-bit addressing mode, the work pool space is allocated above the 16-megabyte line.

The Adabas session statistics or Adabas Online System can be used to tune this parameter for the next session. If expanded files are being used, the LWP value may need to be increased above the normal setting.

Example

The following example runs the Adabas nucleus with a work pool of 900,000 bytes.

ADARUN PROG=ADANUC,LWP=900000

MODE : Mode of Operation

Note the following:

1. The MODE parameter does not affect parallel utility execution.

2. The nucleus cannot run in single-user mode (MODE=SINGLE cannot be specified) if it is to run

   • with Adabas Parallel Services or Adabus Cluster Services (NUCID 1)

   • with support for distributed transactions (DTP=RM)

   • as an Adabas Transaction Manager (DTP=TM)

   In addition, a valid Adabas SVC should be specified when running in single-user (MODE=SINGLE) mode.

3. When running several nuclei against the same database, only one update nucleus can be used.

Example

The following example runs the ADAINV utility in single-user mode.

ADARUN PROG=ADAINV,MODE=SINGLE,SVC=234

MSGBUF : Size of Message Buffer

MSGBUF specifies the size (in kilobytes) of the area used to buffer messages for use for performance and tuning and problem analysis. Adabas messages buffered in this area can be reviewed even when online access to the console or DDPRINT messages is unavailable. While the buffer is intended for messages written to the system log or DDPRINT, it can be used for any purpose by any caller.

MSGBUF presupposes that ADARUN SMGT=YES.

MSGBUF=0 (the default) means that message buffering is not active for the session.

To activate message buffering, set MSGBUF to a value greater than 0. Software AG recommends setting MSGBUF to 10 (kilobytes).

Message buffering can be temporarily disabled and subsequently reactivated using the SMGT operator command.

See the Adabas DBA Tasks documentation for more information about message buffering.

Example

The following example activates message buffering when the Adabas nucleus is initialized with a message buffer size of 10 KB.

ADARUN PROGRAM=ADANUC
  ADARUN SMGT=YES
  ADARUN MSGBUF=10

MSGCONSL : Case of Messages Sent to the Console
MSGDRUCK : Case of Messages Sent to DD/DRUCK
MSGPRINT : Case of Messages Sent to DD/PRINT

Adabas messages are displayed in mixed upper and lowercase. You can use one or more of these ADARUN parameters to display different message types in all uppercase.

Note:
The first message line in DDPRINT will not be influenced by the value of parameter MSGPRINT.

Example

The following example will display messages in the DDDRUCK and DDPRINT data sets in all uppercase:

ADARUN MSGDRUCK=U,MSGPRINT=U

MXCANCEL: Timeout Threshold for Canceled Peer Nucleus

The optional MXCANCEL parameter specifies the maximum number of seconds for which one cluster nucleus (the sending nucleus) waits for the termination of another nucleus (the peer nucleus) in the cluster that it has canceled for not responding to an internal, intracluster command. If a value for MXCANCEL is not specified, the value specified for the ADARUN MXMSG parameter is used. Values from zero through 14 are not valid MXCANCEL values.

If the sending nucleus does not receive notification that the canceled nucleus has terminated within the MXCANCEL timeout period, it does one of the following things:

• It returns response 124, subcode 28 (no reply) to the user on whose behalf the intracluster command was issued.

• It terminates itself abnormally if the communication occurred on behalf of an internal process that must not fail.

When a cluster nucleus fails, the other nuclei in the cluster can recover from the failure only once they know for sure that the first nucleus has disconnected from the shared structures and is no longer writing to the database. When an unresponsive cluster nucleus has been canceled, it is important that it terminate quickly, so that it does not hold up the recovery process performed by the other nuclei in the cluster.

Note:
Do not specify an MPMDUMP JCL statement for a cluster nucleus. An MPMDUMP is written before the failing nucleus disconnects from the shared structures and may significantly delay the start of the online recovery process performed by the other nuclei in the cluster. Instead, on z/OS systems, consider specifying a //SVCDUMP DD DUMMY statement, which usually produces a very quick dump prior to disconnecting. On other systems, and as a backup method on z/OS, specify a regular system dump statement (e.g., SYSUDUMP on z/OS) for a dump that is produced after disconnecting.

The value for MXCANCEL can be changed dynamically (for the time the Adabas nucleus is running) using the MXCANCEL operator command.

MXCANCELWARN : Timeout Threshold for Canceled Peer Nucleus Warning

The optional MXCANCELWARN parameter specifies the number of seconds after an intracluster cancellation request is made when the cluster nucleus requesting the cancellation should issue warnings about the inability of the canceled peer nucleus to terminate. If no value is specified for the MXCANCELWARN parameter, the value used is calculated as the value of the ADARUN MXCANCEL parameter divided by four. When dividing by four to determine the default value, the quotient is rounded up to the next integer value.

The value of MXCANCELWARN must be less than the value of MXCANCEL. If MXCANCELWARN is set to a value greater than or equal to the value specified for MXCANCEL, the value is rejected. If MXCANCELWARN is set to a value of zero (0), no warnings are issued about canceled cluster nuclei that are slow to terminate.

If the target nucleus does not terminate within the time period set by MXCANCELWARN, the nucleus that issued the cancellation request writes message ADAX9G to the operator console, identifying the target nucleus by its nucleus ID, job name, and system name. This message indicates that the nucleus writing the message may be in danger of terminating itself if the canceled peer nucleus does not terminate within the timeout period defined by the MXCANCEL parameter. You can use the ADAX9G message to trigger an alert or take other appropriate action before the MXCANCEL timeout period expires.

If the peer nucleus targeted for cancellation terminates after the ADAX9G message is written, the nucleus that issued the cancellation request writes message ADAX9K to the operator console, indicating that the cancellation occurred and the requesting nucleus is no longer in danger of terminating itself as a result of this particular incident.

The value for MXCANCELWARN can be changed dynamically (for the time the Adabas nucleus is running) using the MXCANCELWARN operator command.

Note:
If the value of the MXCANCEL parameter is dynamically changed using the MXCANCEL operator command while the nucleus is running, but its new value is less than or equal to the current MXCANCELWARN setting, the value of MXCANCELWARN is automatically set to zero. You can then use the MXCANCELWARN operator command to dynamically set the MXCANCELWARN parameter to a new value that is less than the new MXCANCEL value.

MXMSG: Timeout Threshold for Internucleus Command Processing

The optional MXMSG parameter specifies the maximum number of seconds in which one cluster nucleus waits for the response of another nucleus in the cluster to an internal, intracluster command. If a value for MXMSG is not specified, a value of 300 seconds (5 minutes) is used.

If the receiving nucleus does not respond to the intracluster command within the time period set by the MXMSG parameter, the requesting cluster nucleus issues a cancellation request for the unresponsive nucleus. The cancellation is requested to preserve the ability of all of the other active nuclei in the cluster to process user commands.

Adabas nuclei working on the same cluster database must collaborate to keep the database physically and logically consistent while processing user commands. To do this, they intermittently submit internal, intracluster commands to one another. If a nucleus in the cluster does not respond to these intracluster requests in a timely manner, the other nuclei in the cluster may quickly or gradually become unable to continue processing user commands.

Problems that may prevent a cluster nucleus from responding to intracluster commands fall into two broad categories:

• Problems have occurred in the cluster nucleus, such as a CPU loop or a resource deadlock. In such cases, the nucleus experiencing the problem must be terminated to resolve the problem and the sooner this happens, the sooner the other cluster nuclei can recover from the failure and get back to normal processing.

• Problems have occurred outside the cluster nucleus, such as CPU starvation or a problem in the host system. In such cases, the cause of the delayed response might possibly be removed by system measures unrelated to the cluster database, and letting the other cluster nuclei wait some time for a resolution might prevent an unnecessary abnormal termination of a cluster member.

The value of MXMSG should strike a balance between these two categories, so that faulty cluster nuclei that cannot possibly stay active are canceled reasonably quickly while cluster nuclei that are victims of temporary system problems are not unnecessarily terminated. For assistance in setting the value of the MXMSG parameter, review the statistics provided on the messaging performance reports produced at termination or by the DXMSG operator command.

The value for MXMSG can be changed dynamically (for the time the Adabas nucleus is running) using the MXMSG operator command.

MXMSGWARN : Timeout Threshold for Internucleus Command Processing Warning

The optional MXMSGWARN parameter specifies the number of seconds after an intracluster request is made when the cluster nucleus issuing the intracluster request should issue warnings about the failure of the target cluster nucleus to respond. If no value is specified for the MXMSGWARN parameter, the value used is calculated as the value of MXMSG divided by four. When dividing by four to determine the default value, the quotient is rounded up to the next integer value.

The value of MXMSGWARN must be less than the value of MXMSG. If MXMSGWARN is set to a value greater than or equal to the value specified for MXMSG, the value is rejected. If MXMSGWARN is set to zero, no warnings are issued about cluster nuclei that are slow to respond.

If the target nucleus does not respond within the time period set by MXMSGWARN, the nucleus that issued the request writes message ADAX9C to the operator console, identifying the target nucleus by its nucleus ID, job name, and system name. This message indicates that the target nucleus may be in danger of being canceled by the nucleus that issued the request if it does not respond within the timeout period defined by the MXMSG parameter. You can use the ADAX9C message to trigger an alert or take other appropriate action before the MXMSG timeout period expires.

If the target nucleus responds to the intracluster command after the ADAX9C message is written, the nucleus that issued the intracluster-command writes message ADAX9D to the operator console, indicating that a response was given and the target nucleus is no longer in danger of being canceled as a result of this particular incident.

The value for MXMSGWARN can be changed dynamically (for the time the Adabas nucleus is running) using the MXMSGWARN operator command.

Note:
If the value of the MXMSG parameter is dynamically changed using the MXMSG operator command while the nucleus is running, but its new value is less than or equal to the current MXMSGWARN setting, the value of MXMSGWARN is automatically set to zero. You can then use the MXMSGWARN operator command to dynamically set the MXMSGWARN parameter to a new value that is less than the new MXMSG value.

MXSTATUS : Member-Level XCF Status Monitoring Heartbeat Interval

The optional MXSTATUS parameter specifies the number of seconds between member-level XCF status monitoring heartbeats. If no value is specified for the MXSTATUS parameter, a value of "15" is used.

Note:
Note: The MXSTATUS parameter is only used by Adabas Cluster Services and not by Adabas Parallel Services. Adabas Parallel Services does not use XCF and ignores this parameter when it is set.

If MXSTATUS is set to zero, member-level status monitoring will not occur. However, system-level status monitoring always occurs.

The value for MXSTATUS can be changed dynamically (for the time the Adabas nucleus is running) using the MXSTATUS operator command.

XCF status monitoring provides a second method by which Adabas Cluster Services can warn you that a cluster nucleus might be unable to respond in a timely way to intracluster commands. The first method is, of course, via the normal intracluster communication that occurs between cluster members. If a nucleus has heartbeat exceptions (as determined by XCF status monitoring), it most likely will be unable to process and respond to an intracluster command; if a nucleus is slow to respond to an intracluster command, it might or might not have a heartbeat monitor exception (a nucleus may appear to be active to XCF but be unable to respond to an intracluster command). If the ADARUN MXMSGWARN parameter for a cluster nucleus is nonzero, it produces warning messages (ADAX9B or ADAX9C) when intracluster communication with other nuclei in the cluster is too slow; likewise, when XCF status monitoring determines that a nucleus is missing its heartbeat updates, it produces warning messages (ADAX22 and ADAX04). You can use an automated mechanism set up at installation to raise an alert or take other appropriate action based on the existence of these messages, as they identify existing or potential problems in the cluster.

MXTNA : Maximum Non-activity Time

The TNAx parameter specifies the maximum elapsed time (in units of 1.048576 seconds) that users may be considered active without issuing an Adabas command. Limits may be set for three types of user:

• the TNAA parameter for access-only users

• the TNAE parameter for ET logic users

• the TNAX parameter for exclusive control users

You can override these parameter settings for an individual user by specifying a different value in the Adabas control block of an OP command. See the discussion of the OP command in the Adabas Command Reference documentation.

For these parameters, the MXTNA parameter sets a limit on the amount of time that can be specified in the OP command for an individual user.

If the nonactivity time limit is exceeded, action is taken as described in Adabas Timeout Feature.

The value of the MXTNA parameter can only be set when the nucleus is started. It cannot be changed using operator commands or the ADADBS OPERCOM utility function.

Example

For example, during the following Adabas session, the nonactivity time limit for exclusive control users is about 5 minutes (300 seconds). This limit cannot be extended for an individual user beyond 8 minutes (480 seconds).

ADARUN PROG=ADANUC,TNAX=300,MXTNA=480

MXTSX : Maximum Sx Command Execution Time

The TLSCMD parameter specifies the maximum time (in units of 1.048576 seconds) to be used to process a single Adabas S1, S2, or S4 command with a complex search criterion.

If the estimated time to process a command exceeds the TLSCMD time limit, the command is not processed and the user who issued the command receives a nonzero response code.

If the estimated time to process a command does not exceed the time limit, the command is processed to completion, whether the actual time required exceeds the time limit specified by the TLSCMD or not.

You can override the TLSCMD parameter setting for an individual user by specifying a different value in the Adabas control block for an OP command. See the discussion of the OP command in the Adabas Command Reference documentation.

The MXTSX parameter sets the maximum time that can be specified for the TLSCMD parameter, including any override execution time setting specified in the Adabas control block of an OP command.

The value of the MXTSX parameter can only be set when the nucleus is started. It cannot be changed using operator commands or the ADADBS OPERCOM utility function.

Example

For example, during the following Adabas session, the Sx command execution time limit is about 1 hour 20 minutes (4800 seconds). This limit cannot be extended for an individual user beyond 2 hours (7200 seconds).

ADARUN PROG=ADANUC,TLSCMD=4800,MXTSX=7200

MXTT : Maximum Transaction Time

The TT parameter specifies the maximum elapsed time (in units of 1.048576 seconds) permitted for a logical transaction issued by an ET logic user. See ADARUN parameter TT for more information.

You can override this parameter setting for an individual user by specifying a different value in the Adabas control block of an OP command. See the discussion of the OP command in the Adabas Command Reference documentation.

The MXTT parameter sets a limit on the amount of time that can be specified in the OP command for an individual user.

The time measurement for a logical transaction starts when the first command that results in a record being placed in hold status is issued. It ends when an ET, BT, or CL command is issued.

If the transaction time limit is exceeded, action is taken as described in Adabas Timeout Feature.

The value specified for MXTT directly influences the required size of the Adabas parameter LP (length of the data protection area).

Software AG recommends that you set the MXTT parameter lower than the MXTNA parameter.

The value of the MXTT parameter can only be set when the nucleus is started. It cannot be changed using operator commands or the ADADBS OPERCOM utility function.

Example

For example, during the following Adabas session, the transaction time limit for ET logic users is about 3 minutes (180 seconds) and cannot be extended for an individual user beyond 5 minutes (300 seconds).

ADARUN PROG=ADANUC,TT=180,MXTT=300

MXWTOR : Self-Termination Operator Query Interval

The optional MXWTOR parameter specifies the maximum number of seconds that a cluster nucleus should wait for an operator response to a self-terminating operator query. If no value is specified for the MXWTOR parameter, a value of zero is used. Values from 1 through 14 are not valid MXWTOR values.

A cluster nucleus issues a self-terminating operator query to the console via message ADAX9J if a canceled peer nucleus remains active after the time period defined by the MXCANCEL parameter. The MXWTOR parameter specifies how long the nucleus should wait for a response to this query.

One way that the operator may reply to the ADAX9J message is to make sure that the canceled cluster nucleus mentioned in the message actually terminates; once this happens, the ADAX9J message is retracted automatically, an online recovery process is performed, and the nucleus that issued the ADAX9J message remains active.

If the operator does not respond to the ADAX9J message within the time period set by the MXWTOR parameter and the canceled peer nucleus has not terminated in the meantime, the nucleus that requested the operator response and printed message ADAX9J terminates itself with message ADAX99.

If MXWTOR is set to zero (the default), the operator query does not occur (no ADAX9J messages are written) and no operator intervention is expected. Instead, the nucleus terminates itself immediately with the ADAX99 message and user abend code 79.

Some installations may want to specify MXWTOR value long enough to allow the operator a good opportunity to bring down the canceled peer nucleus. Other installations may prefer not to get such operator queries at all.

The value for MXWTOR can be changed dynamically (for the time the Adabas nucleus is running) using the MXWTOR operator command.

NAB : Number of Attached Buffers

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.

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.

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

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 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

Example

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

ADARUN PROG=ADAREV,NAB=50

NC : Number of Command Queue Elements

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 Storage Requirements in Adabas Review Concepts and Facilities documentation.

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

NCLOG : Number of Command Log Data Sets

This parameter specifies the maximum number of command log data sets to be opened and logged in the parallel participant table (PPT) for the current nucleus. Valid values are 0 (the default) and 2-8. Other values produce a parameter error. A zero value disables the parameter.

If more than the number of log data sets specified in the NCLOG parameter are allocated in the startup JCL, only the number specified in the NCLOG parameter are opened and logged; any additional allocated data sets are activated using the dynamic allocation process.

NCLOG must be specified with a nonzero value in conjunction with the CLOGDEV, CLOGSIZE, and UEX12 parameters.

NCLOG is not valid if DUALCLD, DUALCLS, DUALPLD, DUALPLS, or UEX2 are specified.

UEX2 and UEX12 are mutually exclusive.

If a nonzero NCLOG, CLOGDEV, and CLOGSIZE are specified, but LOGGING=NO, Adabas attempts to open and log the number of data sets specified by NCLOG; however, no logging occurs until the LOGGING parameter has been set to YES using either an operator command or Adabas Online System.

Example

The following example runs the Adabas nucleus with command logging, uses six command log data sets, and uses a model 3380 device for command logging. The size of each command log data set is 1350 blocks, based on an allocation of 10 cylinders. (Each cylinder of a 3380 device has 15 tracks, and each track can contain 9 blocks of command log data. Thus, 10 cylinders = 10 15 9 = 1350 blocks).

ADARUN PROG=ADANUC,LOGGING=YES,NCLOG=6,CLOGDEV=3380,CLOGSIZE=1350

NH : Number of Hold Queue Elements

One hold queue element (HQE) is required for each record (ISN) placed in hold status. An HQE is released when the record is released from hold status.

The hold queue is normally used to hold ISNs for the duration of a transaction. Therefore NH should be large enough to contain at least the average number of ISNs held per transaction multiplied by the maximum number of transactions running in parallel.

Each HQE requires 28 bytes.

In environments running in 31-bit addressing mode, the hold queue is allocated above the 16-megabyte line.

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

Note:
When an SLOG file is defined for use on the Event Replicator Server, replication data may be written and read from the SLOG file. With this in mind, consider the values set for the following ADARUN performance and tuning parameters: ASYTVS, FMXIO, LBP, LDEUQP, LFIOP, LP, NH, NISNHQ.

Example

The following example runs the Adabas nucleus with a maximum of 2000 elements in the hold queue.

ADARUN PROG=ADANUC,NH=2000

NISNHQ : Number of ISNs in Hold Queue per User

NISNHQ determines the maximum number of held ISNs the hold queue (see the NH parameter description) can contain from one user. The most ISNs allowed on hold for a single user is 1/4 of the hold queue size, but not more than 65,535 ISNs. The default is the greater of either 20 or the number of ISNs the hold queue can contain divided by the number of users, multiplied by two.

If a user attempts to place more records in hold status than permitted, the user receives a nonzero response code even though there may still be space in the hold queue.

Note:
When an SLOG file is defined for use on the Event Replicator Server, replication data may be written and read from the SLOG file. With this in mind, consider the values set for the following ADARUN performance and tuning parameters: ASYTVS, FMXIO, LBP, LDEUQP, LFIOP, LP, NH, NISNHQ.

Overriding the Parameter Setting

You can override this parameter setting for an individual user by specifying a different value in the Adabas control block for an OP command. See the discussion of the OP command in the Adabas Command Reference documentation.

Examples

In the following example, the maximum number of records that may be in hold status for a single user is set at 100.

ADARUN PROG=ADANUC,NISNHQ=100,NH=450...

In the following example, NISNHQ is not specified. The maximum number of records that may be in hold status for a single user is 40 (the NISNHQ default of (NH / NU) * 2, which is greater than the alternative default of 20).

ADARUN PROG=ADANUC,NU=50,NH=2000...

NONDES : Nondescriptor Searches

By default, you can perform searches on Adabas fields that have not been defined as descriptors. However, nondescriptor searches carry significant overhead.

NONDES=NO prevents searches on nondescriptors. An attempt to search on a nondescriptor field produces response code 68.

Note:
The behavior of nondescriptor searches in Adabas databases differs between mainframe and open systems in regards to null suppression in the fields. In open systems, nondescriptor searches do not return records with null values in a field if the field is null-suppressed (NU); on mainframe systems, the null-suppression (NU) of fields is ignored during nondescriptor searches. At this time, to resolve this problem, we recommend that you remove the null suppression option (NU) for open systems fields, if the fields must be used for a nondescriptor search.

Example

The following example disallows searches using nondescriptors.

ADARUN PROG=ADANUC,NONDES=NO

NPLOG : Number of Protection Log Data Sets

This parameter specifies the maximum number of protection log data sets to be opened and logged in the parallel participant table (PPT) for the current nucleus. Valid values are 0 (the default) and 2-8. Other values produce a parameter error. A zero value disables the parameter.

If more than the number of log data sets specified in the NPLOG parameter are allocated in the startup JCL, only the number specified in the NPLOG parameter are opened and logged; any additional allocated data sets are activated using the dynamic allocation process.

NPLOG must be specified with a nonzero value in conjunction with the PLOGDEV, PLOGSIZE, and UEX12 parameters.

NPLOG is not valid if DUALCLD, DUALCLS, DUALPLD, DUALPLS, or UEX2 are specified.

UEX2 and UEX12 are mutually exclusive.

Example

The following example runs the Adabas nucleus with six data protection log data sets and uses a model 3380 device. The size of each log data set is 1200 blocks, based on an allocation of 10 cylinders. (Each cylinder of a 3380 device has 15 tracks, and each track contains 8 blocks of protection log data. Thus, 10 cylinders = 10 * 15 * 8 = 1200 blocks).

ADARUN PROG=ADANUC,NPLOG=6,PLOGDEV=3380,PLOGSIZE=1200

NQCID : Number of Active Command IDs per User

The table of sequential commands contains the control blocks for sequential read operations. Each operation is identified by a command ID (CID). NQCID defines the total number of CIDs allowed per user, and therefore the maximum number of table elements the user has available at any point in time.

Note:
The NQCID value specified does not ensure that all users have the specified count of CIDs available at all times. The actual number of CIDs available to a single user depends on the totals of table elements available and sequential operations active at a given time.

Overriding the Parameter Setting

You can override this parameter setting for an individual user by specifying a different value in the Adabas control block for an OP command. See the discussion of the OP command in the Adabas Command Reference documentation.

Example

The following example sets the maximum number of parallel sequential processes per user to 25.

ADARUN PROG=ADANUC,NQCID=25,NU=200,LQ=3000

Since one element in the sequential command table occupies approximately 100 bytes (varies depending on the command type; see the description of the LQ parameter), NQCID=25 limits each user to approximately 2500 bytes of the table.

NSISN : Number of ISNs per ISN Table Element

The parameter NSISN specifies the maximum number of ISNs kept in a TBI element in memory (list of resulting ISN lists). The more ISNs that are kept in memory, the fewer the Work I/Os needed to read additional resulting ISN lists from the Work data set. This parameter influences the performance of the L1/4 command with the N (GET NEXT) option.

The highest value that can be specified for NSISN depends on the Work device. For Adabas-specified Work block sizes, the maximum values are shown in the device tables provided later in this section. However, the tables do not apply to user-defined Work block sizes; in this case, the maximum is determined as follows, where WORK is the block size of the Work data set:

• (WORK - 6) / 4

• The TBI element has a length of 64 + (NSISN * 4) bytes in the TBI pool (see the LI parameter).

Although supported, the BS2000 device type 2007 is not recommended for use with Adabas. Support for the 2007 will be removed in a later Adabas release.

IBM and Compatible Devices

BS2000 Devices

Overriding the Parameter Setting

You can override this parameter setting for an individual user by specifying a different value in the Adabas control block for an OP command. See the discussion of the OP command in the Adabas Command Reference documentation.

Example

In the following example, the maximum number of ISNs per TBI element during the Adabas session is set to 400.

ADARUN PROG=ADANUC,NSISN=400

NT : Number of Threads

A thread is used to execute a single command for any user (access or update). Each thread requires 8192 bytes.

In environments running in 31-bit addressing mode, the threads are allocated above the 16-megabyte line.

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

For Event Replicator Server databases, this parameter must be greater than or equal to 15.

Example

The following example runs the Adabas nucleus with six (6) user threads.

ADARUN PROG=ADANUC,NT=6

NU : Number of User Queue Elements

Adabas assigns a user queue element (UQE) to each active user when the user issues an OP command or (if the user did not issue an OP command) the first Adabas command.

Adabas releases the UQE when the user issues a CL command or when there is a timeout for an ET logic user who did not specify a restart ID in the control block (Additions 1 field) for the OP command.

Currently, 272 * (NU + 4) bytes are allocated to the user queue. The length of each UQE is 288 bytes.

In environments running in 31-bit addressing mode, the user queue is allocated above the 16-megabyte line.

Because each user's file list can be a different size, the number of users who can be active at the same time may be less than the NU value. Therefore, you may need to specify an NU value that is greater than the maximum number of users desired.

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

Example

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

ADARUN PROG=ADANUC,NU=500

NUCID : Adabas Cluster Nucleus ID

Note:
The NUCID parameter replaces the earlier parameters PLXID and SMPID.

NUCID identifies an Adabas cluster nucleus. The cluster may span operating system images under Adabus Cluster Services, or it may be confined to a single operating system image under Adabas Parallel Services. A value greater than 0 (the default) identifies this nucleus as an Adabas cluster nucleus.

Guidelines

• Each nucleus being run must have its own Work data set.

• All nuclei in a cluster must be run against the same database.

• Software AG strongly recommends that you run utilities or user applications against a nucleus in the local z/OS image. Although a remote open nucleus may be used, performance degradation due to network overhead is likely.

Example

The following example starts an Adabas cluster session with the specified cluster nuclei:

ADARUN PROG=ADANUC,NUCID=1, ...

OPENRQ : Open Command Required

This parameter may be used to indicate whether an open (OP) command must be issued as the first command of a user session.

Example

The following example specifies that the first session command issued by users does not have to be an OP command.

ADARUN PROG=ADANUC,OPENRQ=NO

PGFIX: EXCPVR Page Fixing Control

This parameter is only valid for z/OS users using EXCPVR (for example, when running the Adabas nucleus or utility jobs APF-authorized). It allows you to control how page-fixing occurs when EXCPVR is in use. When PGFIX=NO is specified, pages containing the I/O control blocks are fixed only for the duration of the I/O processing. When PGFIX=YES is specified, pages containing the I/O control blocks are fixed for the duration of the job.

PLOGDEV: Multiple Protection Log Device Type
PLOGSIZE: Multiple Protection Log Size

The PLOGDEV and PLOGSIZE parameters specify the type of external storage device used for multiple data protection log data sets and the number of blocks available for each log data set. These parameters must be used together; if you specify one parameter, you must also specify the other parameter.

You must also specify the NPLOG parameter to use multiple protection logs. If you specify a user exit, it must by UEX12. See Adabas Restart and Recovery, for information about multiple data set protection logging.

The Adabas Installation documentation specifies the device types that Adabas supports.

All protection log data sets must be formatted using the ADAFRM utility before they are used. The appropriate JCL for the data sets is required.

Example

The following example runs the Adabas nucleus with six (6) data protection log data sets and uses a model 3380 device. The size of each log data set is 1200 blocks, based on an allocation of 10 cylinders. (Each cylinder of a 3380 device has 15 tracks, and each track contains 8 blocks of protection log data. Thus, 10 cylinders = 10 * 15 * 8 = 1200 blocks).

ADARUN PROG=ADANUC,NPLOG=6,PLOGDEV=3380,PLOGSIZE=1200

PLOGSEGSDS: Spanned Record PLOG Control

When this value is set to NO (the default), only some portions of a modified spanned data record are written to the PLOG; all portions are not written. This optimizes Adabas I/O performance, however it prevents the ADACDC and ADASEL utilities from parsing the records. Set this value to YES if you want the ADACDC or ADASEL utilities to parse modified spanned data records, bearing in mind that I/O performance may be slower. When set to YES, all portions of a modified spanned data record are written to the PLOG.

PLOGRQ : Protection Log Required

The valid values are as follows:

Example

The following example indicates that a data protection log (SIBA or PLOG) is not mandatory during the Adabas session but will be used if provided.

ADARUN PROG=ADANUC,PLOGRQ=NO

PREFETCH : Activate Prefetch Feature

This parameter determines whether the Adabas prefetch feature is enabled automatically; if it is, execution is transparent to the user program.

There are two Adabas prefetch options: the multifetch option is supported across Adabas platforms; the prefetch option is available only on mainframe Adabas. For information about these two options, see the Adabas Command Reference documentation.

Records can be prefetched and stored in a prefetch buffer for the following commands:

• L1/L4 with I or N option (read by ISN, find with GETNEXT)

• L2/L5 (read physical)

• L3/L6 (read logical by descriptor)

• L9 (histogram)

Sequential commands of the types listed above can retrieve the next record from the prefetch buffer, which saves cross-region/cross-network calls to the nucleus.

The PREFETCH parameter has the following values:

Note:
Specify PREFETCH=YES or PREFETCH=OLD only when MODE=MULTI (multiuser mode). Do not specify these settings when running Adabas utilities. Dynamic reversal of read direction for L3/L6/L9 is not supported with these settings.

Examples

The following example runs a user program using multifetch.

ADARUN PROG=USER,PREFETCH=YES

The following example runs a user program using prefetch.

ADARUN PROG=USER,PREFETCH=OLD

PREFICMD : Include Commands in Prefetch/Multifetch Processing
PREFIFIL : Include Files in Prefetch/Multifetch Processing

Together, PREFIFIL and PREFICMD specify one or more files to be included in prefetch/multifetch processing. PREFIFIL specifies one or more files by file number; PREFICMD specifies a command for each file number.

You can either include list of files using PREFIFIL/PREFICMD or exclude lists of files using the parameters PREFXFIL/PREFXCMD), depending on which list is shorter. You cannot both include and exclude files at the same time.

If prefetching/multifetching has been specified and

• files/commands have been neither included nor excluded, the prefetching/multifetching applies to all files by default.

• files/commands have been included using the ADARUN parameters PREFIFIL/PREFICMD, the prefetching/multifetching applies only to the files on the inclusion list.

• both PREFIFIL/PREFICMD and PREFXFIL/PREFXCMD are specified, Adabas recognizes the exclusion parameters PREFXFIL/PREFXCMD and ignores the inclusion parameters PREFIFIL/PREFICMD.

Multiple Inclusions

Specify multiple file numbers in multiple PREFIFIL statements or in a list, separated by commas. Specify multiple commands in multiple PREFICMD statements or in a list, separated by slashes (/). The maximum number of entries for each is 50.

If you use lists, they must have the same number of entries. There is a one-to-one correspondence, by position, between a file number in the PREFIFIL list and a command in the PREFICMD list.

Eligible Commands and Command Pairs

The following commands can be included in prefetch/multifetch processing for a file:

• L1/L4

• L2/L5

• L3/L6

• L9

If either command in one of the pairs above is specified in a PREFICMD statement, both commands are included. For example, if PREFICMD=L1 is specified, both L1 and L4 are included.

Examples

The following example includes the L3 command for file 8 in prefetch processing.

ADARUN PREFIFIL=8,PREFICMD=L3

The following example includes the L3 command for file 8 and the L3 and L9 commands for file 12 in prefetch/multifetch processing. As this example shows, you can specify the same file number several times, with a different command each time. Likewise, you can specify the same command code several times, with a different file number each time.

ADARUN PREFIFIL=8,12,12,PREFICMD=L3/L3/L9

or

ADARUN PREFIFIL=8,PREFICMD=L3
  ADARUN PREFIFIL=12,PREFICMD=L3
  ADARUN PREFIFIL=12,PREFICMD=L9

The following example executes a user program with multifetch and allocates 20,000 bytes for the total prefetch buffer area. It includes the L3 and L6 commands for files 8 and 12 in multifetch processing and it includes all commands for file 7. No PREFSBL value is specified, so the buffer length for a single prefetch sequence defaults to 3,000 bytes; up to 6 prefetch sequences can be handled.

ADARUN PROG=USER,PREFETCH=YES,PREFTBL=20000
  ADARUN PREFIFIL=8,12,PREFICMD=L3/L3
  ADARUN PREFIFIL=7,7,7,7,PREFICMD=L1/L2/L3/L9

PREFNREC : Multifetch Record Count

This parameter specifies the maximum number of records that the multifetch feature (specified by the PREFETCH=YES parameter) obtains.

The maximum that can be specified depends on the maximum that can be held by the record and ISN buffers, each of which is assumed to be less than 32 kilobytes.

If no value or zero (the default) is specified, the sizes of the ISN and record buffers determine the number of records that are prefetched. Specifying zero (0) does not disable multifetch operation.

Example

The following example enables the multifetch feature and allows a maximum of 32 records to be prefetched.

ADARUN PROG=USER,PREFETCH=YES,PREFNREC=32

PREFSBL : Prefetch Buffer Length per Call

The PREFSBL parameter specifies the size of the buffer for a single prefetch, which determines how much record data is prefetched. See also the description of the PREFTBL parameter, which specifies the total buffer space used by prefetch/multifetch.

When prefetch or multifetch is active, Adabas makes a buffer available to the user program for storing prefetched records. If a required record is already in a prefetch buffer, the record is taken directly from the buffer. PREFSBL specifies the size of this buffer.

Note:
Do not specify this operand unless PREFETCH=YES or PREFETCH=OLD also is specified.

The following formula can be used to estimate the initial size of PREFSBL:

300 + FBL + 2 * (16 + RBL) + 2 * ((16 + RBL) * recs) = PREFSBL

In this calculation, FBL is the length of the format buffer, RBL is the length of the record buffer, and recs is the number of records per call.

For long sequential processes, this parameter should be as large as possible unless the sequential processes are frequently interrupted with value start (L3/L6) or RC commands; in that case, a large value often causes records to be prefetched needlessly.

Example

The following example executes a user program using multifetch and uses a 15,000-byte prefetch buffer.

ADARUN PROG=USER,PREFETCH=YES,PREFSBL=15000

PREFTBL : Total Size of Prefetch Buffer

PREFTBL specifies the size of the total prefetch buffer area for this operation. This buffer length should be large enough to hold the PREFSBL-specified value, multiplied by the number of command-ID-controlled sequential prefetches for this operation. This allows a user program to perform multiple sequential operations requiring prefetches, each with a prefetch buffer of the size specified in the PREFSBL parameter.

If this user program has a single prefetch sequence only, the PREFTBL value must be equal to or greater than the PREFSBL value. The PREFTBL-specified space is always allocated to the program.

Note:
Do not specify this operand unless PREFETCH=YES or PREFETCH=OLD is also specified.

Example

The following example executes a user program using multifetch. No PREFSBL value is specified, so this example uses the default buffer length for a single prefetch (3,000 bytes). It also allocates 30,000 bytes for the total prefetch buffer area; this size provides buffer space for up to 10 prefetch sequences.

ADARUN PROG=USER,PREFETCH=YES,PREFTBL=30000

PREFXCMD (PREFXFIL) : Exclude Commands (Files) from Prefetch/Multifetch Processing

Together, PREFXFIL and PREFXCMD specify one or more files to be excluded from prefetch/multifetch processing. PREFXFIL specifies one or more files by file number; PREFXCMD specifies a command for each file number.

You can either include list of files using PREFIFIL/PREFICMD ) or exclude lists of files using the parameters PREFXFIL/PREFXCMD, depending on which list is shorter. You cannot both include and exclude files at the same time.

If prefetching/multifetching has been specified and

• files/commands have been neither included nor excluded, the prefetching/multifetching applies to all files by default.

• files/commands have been exncluded using PREFXFIL/PREFXCMD, the prefetching/ multifetching applies only to the files on the exclusion list.

• both PREFIFIL/PREFICMD and PREFXFIL/PREFXCMD are specified, Adabas recognizes the exclusion parameters PREFXFIL/PREFXCMD and ignores the inclusion parameters PREFIFIL/PREFICMD.

Multiple Exclusions

Specify multiple file numbers in multiple PREFXFIL statements or in a list, separated by commas. Specify multiple commands in multiple PREFXCMD statements or in a list, separated by slashes (/). The maximum number of entries for each is 50.

If you use lists, they must have the same number of entries. There is a one-to-one correspondence, by position, between a file number in the PREFXFIL list and a command in the PREFXCMD list.

Eligible Commands and Command Pairs

The following commands can be excluded from prefetch/multifetch processing for a file:

• L1/L4

• L2/L5

• L3/L6

• L9

If either command in one of the pairs above is specified in a PREFXCMD statement, both commands are excluded. For example, if PREFXCMD=L1 is specified, both L1 and L4 are excluded.

Examples

The following example excludes the L3 command for file 8 from prefetch processing.

ADARUN PREFXFIL=8,PREFXCMD=L3

The following example excludes the L3 command for file 8 and the L3 and L9 commands for file 12 from prefetch/multifetch processing. As this example shows, you can specify the same file number several times, with a different command each time. Likewise, you can specify the same command code several times, with a different file number each time.

ADARUN PREFXFIL=8,12,12,PREFXCMD=L3/L3/L9

or

ADARUN PREFXFIL=8,PREFXCMD=L3
  ADARUN PREFXFIL=12,PREFXCMD=L3
  ADARUN PREFXFIL=12,PREFXCMD=L9

The following example executes a user program with multifetch and allocates 20,000 bytes for the total prefetch buffer area. It excludes the L3 and L6 commands for files 8 and 12 from multifetch processing and it excludes all commands for file 7. No PREFSBL value is specified, so the buffer length for a single prefetch sequence defaults to 3,000 bytes; up to 6 prefetch sequences can be handled.

ADARUN PROG=USER,PREFETCH=YES,PREFTBL=20000
  ADARUN PREFXFIL=8,12,PREFXCMD=L3/L3
  ADARUN PREFXFIL=7,7,7,7,PREFXCMD=L1/L2/L3/L9

PROGRAM : Program to Run

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

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

QBLKSIZE : Block Size for Sequential Data Sets

QBLKSIZE specifies the block size, in bytes, for the sequential data sets used by ADAIOR, the Adabas I/O component. Use this parameter to override the default block sizes. For more information about sequential files used by Adabas utilities and their operating system dependencies, read Adabas Sequential Files.

Warning: If you choose to write tape files with large block sizes, for example for database backups, these files will not be transportable to systems where support for large blocks is not available. This might include a site being used as a backup facility for disaster recovery.

If QBLKSIZE=0 (the default), the following default block sizes are used:

Under all operating systems except z/VSE, this block size may be provided in the JCL or data set label.

Under BS2000, disk block sizes are always rounded up to the next integer multiple of 2048 bytes.

Examples

For example, a block size of 65,536 bytes for the Adabas sequential data sets is used by the ADAULD utility:

ADARUN PROG=ADAULD,QBLKSIZE=65536

In the following example, a block size of 32,760 bytes for the Adabas sequential data sets is used by the ADAORD utility:

ADARUN PROG=ADAORD,QBLKSIZE=32760

READONLY : Read-Only Session Control

READONLY determines whether the Adabas session is a read-only or a read/write session.

Guidelines

• When executing the ADAREP (database report) utility, you can specify READONLY=YES to issue an access OPEN instead of an update OPEN.

• When using READONLY=YES, ensure that the Work data set does not contain a pending autorestart; otherwise, the nucleus cannot start.

• Each nucleus being run must have its own Work data set.

• When a nucleus is started with READONLY=YES, it is not possible to switch the nucleus to READONLY=NO mode later in the session. When a nucleus is started with READONLY=NO, it can be switched back and forth between the READONLY=YES and READONLY=NO modes.

• A database save performed while the nucleus is in read-only mode is equivalent to an offline save (which is taken while the nucleus is down). You can avoid shutting down the nucleus for an offline save by switching the nucleus into read-only mode before the save and back to update mode after the save.

Example

The following example starts an Adabas session as read-only.

ADARUN PROG=ADANUC,READONLY=YES

REPLICATION Parameter

Valid values are described in the following table.

The REPLICATION parameter should not be specified for the Event Replicator Server. REPLICATION=NO must be explicitly specified if:

• You want to start the Adabas nucleus without replication active, and

• REPLICATION=YES was specified in the previous Adabas nucleus session, and

• Replication has been defined for one or more files on the database.

REPLICATION=NO must be explicitly specified for utility execution if:

• A utility requiring an active nucleus is executed with MODE=SINGLE, and

• REPLICATION=YES was specified in the previous Adabas nucleus session, and

• Replication has been defined for one or more files on the database.

Example

The following example activates replication for an Adabas session.

ADARUN PROG=ADANUC,REPLICATION=YES

REVFILTER : Review Record Filtering Control

REVFILTER determines whether command log record filtering may be activated. Filtering can decrease the number of command log records passed to Review for report processing.

Examples

In the following example, Adabas Review's record filtering may be activated during the Adabas nucleus session.

ADARUN PROG=ADANUC,REVFILTER=YES

In the following example, Adabas Review's record filtering will not be in effect for the Adabas nucleus session.

ADARUN PROG=ADANUC,REVFILTER=NO

REVIEW : Adabas Review Control

Note:
The parameter name REVIEWHUBID is a synonym for REVIEW, provided to ensure downward compatibility with past Adabas releases. We recommend that you use the parameter name REVIEW instead, wherever possible.

REVIEW controls the use of the Adabas Review product:

Dynamic Modification

The setting of the ADARUN PROG=ADANUC,REVIEW=dbid parameter can be changed dynamically using the REVIEWHUBID command from the operator console, the ADADBS OPERCOM REVIEWHUBID function, or the Modify Parameter function of Adabas Online System.

Examples

The following example starts hub 202 for the Adabas Review hub (server) installation.

ADARUN PROGRAM=ADAREV,REVIEW=202

The following example starts the Adabas nucleus that will log to Adabas Review hub 202 for the Adabas Review (client) installation.

ADARUN PROGRAM=ADANUC,REVIEW=202

REVLOGBMAX: Logged Buffer Size Limit for Review

If a buffer is longer than this value, the logged buffer is truncated from the point at which its size exceeds the setting of the REVLOGBMAX parameter. The REVLOGBMAX setting affects the ADARUN LOGGING parameter specifications only for both CLOGLAYOUT=8. The minimum value (368) is the size of the length of the CLOGLAYOUT=8 basic record plus the length of the extended Adabas control block (ACBX).

Example

The following example runs the Adabas nucleus using a logged buffer size limit of 512. Individual logged buffers, such as the format buffer for an Adabas command, will be truncated if they exceed 512 bytes.

ADARUN PROG=ADAREV,LOGBMAX=512

REVLOGMAX: Total Logged Buffer Size Limit for a Review Command

When the sum of sizes of the logged buffers for an Adabas Review command reaches the value of the REVLOGMAX parameter, the buffer exceeding the limit is truncated and all following buffers are omitted. The size of REVLOGMAX must at least be as large as the REVLOGBMAX + 2000 in order to accommodate the largest buffer of the Adabas command. The minimum value (2000) is the size of the length of the CLOGLAYOUT=8 basic record plus the length of the extended Adabas control block (ACBX) and the CLEX information.

The CLOGMAX setting affects the ADARUN LOGGING parameter specifications only for CLOGLAYOUT=8.

Example

The following example runs the Adabas nucleus using a command logged buffer size limit of 32000 bytes. The sum of all logged buffers for an Adabas Review command to this nucleus cannot exceed 10000 bytes.

ADARUN PROG=ADAREV,REVLOGMAX=10000

RPLCONNECTCOUNT Parameter

A value of zero indicates that no connection attempts should occur; a value of zero makes the most sense in situations where the Adabas database and the Event Replicator Server execute together on the same logical partition (LPAR). If the Adabas database and the Event Replicator Server execute on different LPARs, however, setting a real value using this command helps avoid errors that might arise if network problems occur because the network is not started or a network connection between the Adabas database and the Event Replicator Server is lost.

RPLCONNECTINTERVAL Parameter

A value of zero indicates that no connection attempts should occur; a value of zero makes the most sense in situations where the Adabas database and the Event Replicator Server execute together on the same logical partition (LPAR). If the Adabas database and the Event Replicator Server execute on different LPARs, however, setting a real value using this command helps avoid errors that might arise if network problems occur because the network is not started or a network connection between the Adabas database and the Event Replicator Server is lost.

RPLPARMS Parameter

This parameter is only used when starting the Event Replicator database.

If the RPLPARMS parameter is not specified, the following logic is used to determine where to read the replication definitions:

• If the Replicator system file is loaded on the Event Replicator database, the replication definitions are read from that file.

• If the Replicator system file is not loaded on the Event Replicator database, the replication definitions are read from DDKARTE.

Valid values are described in the following table.

RPLSORT Parameter

This parameter is only used for the Adabas database from which transactions will be replicated. It should not be used for the Event Replicator Server database.

By default (RPLSORT=YES), Event Replicator for Adabas sorts transaction data by a key consisting of the file number, ISN, and relative update number. If you do not want this sort to occur, specify RPLSORT=NO.

It is important to note that the RPLSORT setting will affect how the Event Replicator consolidates transaction modifications and the order in which they are replicated. When RPLSORT=YES, all modifications for a given ISN in a file are consolidated before replication occurs. For complete information on regular modification consolidation, read Detailed Adabas Nucleus Processing in Event Replicator for Adabas Concepts. When RPLSORT=NO is specified, the modifications are still consolidated, but their referential integrity is maintained. In other words, the chronological order of the updates is maintained for each ISN in a file.