LST parameters in B97LSTxx

B97_ALWAYS_INSERT_ NOTE

YES | NO

Determines whether it is possible to modify or delete browser notes

If YES, it is not possible to change or delete an existing browser note. When a user changes a note, the original note is preserved and a new note with the changed text and attributes is inserted instead.

Optional

NO

B97_ARC_MAX_NUMBER_ OF_OBJECTS

numeric

Limits the size of archive datasets by specifying the maximum number of 4-MB objects to be stored in a dataset. When reaching this limit, the archive job finishes archiving the current list and then opens a new archive dataset.

0 means no limit.

Optional

0

B97_AUTORLD_ENABLED

YES | NO

Activates or deactivates automatic reloading

Optional

NO

B97_AUTORLD_INTERVAL

0..1440

Interval in minutes after which the automatic reload function checks how many requests are waiting in the reload queue; 0 (default) disables the automatic reload function.

Optional

0

B97_AUTORLD_ PROCEDURE

name

Name of the RFF procedure that starts the reload job (required if autoreload is enabled)

The procedure (default name: B97RLDA) is tailored during installation and then copied to the specified procedure library. Automatic reloading is deactivated if no name is specified.

Required: APF authorization

The steplibs of the reload procedure must be APF-authorized to enable the initialization of the new address space.

Instead of using a reload procedure, the STC can submit the reload jobs directly in its own address space. If you want this, code:

B97_AUTORLD_PROCEDURE = ##NONE##

see description

see description

B97_AUTORLD_REQUEST_ LIMIT_LOW

1..99

Automatic reload is triggered when the number of reload requests with status WAITING has exceeded this limit.

Optional

1

B97_AUTORLD_SETTLE_ COUNT

0..99

Specify the maximum number of repeats of the interval before an automatic reload must be triggered at the latest, provided any reload requests with status WAITING are present; 0 (default) disables this feature.

Optional

0

B97_BAT_ERR_error

0..4095

Sets the program return code of batch utilities for the corresponding error case to the specified value

Optional

B97_BAT_ERR_NODATA

B97_BAT_ERR_ERRLIMIT

B97_BAT_ERR_DDMISSING

B97_BAT_ERR_QSAMOPEN

B97_BAT_ERR_BQLOPEN

B97_BAT_ERR_BQLEXEC

B97_BAT_ERR_SYNTAX

B97_BAT_ERR_SECURITY

4

8

20

20

20

20

20

32

B97_BAT_RET_OKAY

0..4095

Sets the program return code of batch utilities for non-error to the specified value

Optional

0

B97_BAT_RET_MAXCC

0..4095

Sets the program return code of batch utilities to the specified value (works like SET MAXCC)

Optional

0

B97_BAT_SEARCH_ SARGTYPE

ISPF | BETA

Specifies which type of picture string is used by B97BSRCH by default

Optional

ISPF

B97_TRACE_BAT_RC

YES | NO

YES causes the logging of the current values of all modifiable program return codes in the IRMLOG

Optional

NO

B97_BROWSE_MODE_IF_ NO_INDEX

YES | NO

Determines the system's reaction when the line command IX is entered in front of a list for which no index was created

NO

An error message is displayed

YES

The list is opened in normal page browse mode (same as line command S or B)

Optional

NO

B97_BUILD_ITEM_INDEX

YES | NO

Controls the creation of the internal index §§§BETAINTERN§§§, which is required for item-based browsing

YES

It is automatically created for all lists with item-based processing (list definition specifies Item Processing Mode = Yes)

NO

It is only created if the list definition explicitly specifies Item Display Mode = Yes

Optional

NO

B97_CENTERA_TASKS

numeric

Maximum number of parallel activities when archiving in a Centera Archive

Optional

5

B97_CONNECT_TO_ CENTERA_suffix

string

Required for archiving on a Centera Archive

Use this parameter to define one or more connection strings ( max. of 256 bytes each) (see Centera API Reference Guide). suffix is variable and establishes the connection to the archive subpool definition for which this connection string is used.

see description

none

B97_CLEANUP_CACHE

1..9999

Determines the retention period of data in the cache spool; the batch utility B97DECCH deletes all data that has not been accessed for n days.

Optional

5

B97_CLEANUP_RELOAD_ LIST

B97_CLEANUP_RELOAD_ INDEX

1..9999

Determines the retention period of reloaded lists and indexes in the online spool; the batch utility B97DEONL deletes all lists and indexes that have been on the online spool for the specified number of days.

Optional

5

B97_CLIENT_GROUPS

Obsolete (replaced by B97_ROUTER_INDEX_GROUPS)

B97_COMMENT

string

Start-up message

The start-up message is written to the console when the Adabas Audit Data Retrieval started task has completed the initialization process. The default message is:

IRM9190I BETA 97 IS NOW ACTIVE

Optional

see description

B97_DEARC_SORT

YES | NO

If NO, the archive cleanup job does not sort the report which itemizes the lists deleted from the archive, which reduces the run time of the job.

Optional

NO

B97_DISPLAY_LIMIT_ VALUE

0..999999

Specifies the selection limit for online tables. When a selection reaches this limit, the user is prompted to decide whether to stop or continue the selection. The following two keywords control how the user can continue the selection:

B97_DISPLAY_LIMIT_BYPASS

B97_DISPLAY_LIMIT_OVERWRITE

0 means no limit.

Optional

1000

B97_DISPLAY_LIMIT_ BYPASS

YES | NO

NO

The user is prompted each time the limit is reached.

YES

The user is prompted only the first time the limit is reached.

Optional

NO

B97_DISPLAY_LIMIT_ OVERWRITE

YES | NO

YES

The user can change the limit for the current selection when prompted whether to continue.

Optional

NO

B97_FOLDER_SELECTION_ GENERIC

YES | NO

Determines whether it is possible to select lists via generic folder names under option 1 (BROWSE) and option I (INDEX)

If YES, it is allowed to specify a mask in the Folder field.

Optional

NO

B97_FOLDER_SELECTION_ MULTISELIGR

YES | NO

Controls how the matching lists are found when a folder name is specified as selection criterion under option 1 (BROWSE) and option I (INDEX)

NO

1st processing step:
A selection is carried out irrespective of the specified folder, which returns all lists matching the remaining selection criteria.

2nd processing step:
For each list found, a check is carried out whether this list is also contained in the specified folder.

YES

1st processing step:
This step returns all list names (form and extension) contained in the folder.

2nd processing step:
For each list name (form and extension), a selection with the remaining selection criteria is carried out.

The default processing method "retrieve lists first, then check against folder" is inefficient, if the selection returns a large number of lists, e.g. because the time range is very large.

If you specify the processing method "process folder first, then select lists" (B97_FOLDER_SELECTION_MULTISELIGR
=YES), you can use the parameter B97_FOLDER_ SELECTION_MAXNRSELIGR to limit the number of selections: When the number of lists contained in the folder exceeds this limit, the standard processing method ("retrieve lists first, then check against folder") is used.

Optional

NO

B97_FOLDER_SELECTION_ MAXNRSELIGR

numeric

Only if B97_FOLDER_SELECTION_ MULTISELIGR=YES:

Maximum number of selections that are to be carried out (0 means no limit)

Optional

0

B97_INDEX_INTERFACE_ MODULE

module

This parameter is required for an Adabas Audit Data Retrieval installation:

B97_INDEX_INTERFACE_ MODULE=B97ALOGX

The specified module is called during indexing and retrieval to convert the records of an ALOG dataset into a readable format.

Required

B97_INDEX_LAYOUT

SINGLE | MULTI

Controls the handling of layout groups (Option 2.6):

If MULTI, it is possible to create definitions that group multiple layouts under one layout group.

If SINGLE, the layout name and layout group name are always identical.

Optional

SINGLE

B97_LICX_DSNAME

name

Name of the dataset that contains the license keys (required if DD B97LICX is not available

For more information, see "License check handling" in BSA Installation and System Guide.

see description

none

B97_LICX_CHECK_TIME

hh

The time as a full hour at which a cyclical check is made on licenses in the license file. For more information, see "License check handling" in BSA Installation and System Guide.

Optional

00

B97_LIMIT_FX_COMMAND

YES | NO

If YES, the FINDINDEX(FX) command honors the Find line limit specified in the user profile (Browser options). This is only meaningful if the search term is found within this limit.

Optional

NO

B97_LIST_SELECT_LIMIT=n

numeric

Determines the maximum number of lists that can be selected under option 1 (BROWSE) and option I (INDEX) (0 means no limit)

Whether it is possible to select more lists than this limit is determined by the LST parameter B97_LST_SELECT_CONFIRM.

Optional

0

B97_LIST_SELECT_ CONFIRM

YES | NO

If YES, the application displays a confirmation message when the limit is reached and the user can either continue or end the selection

If NO, the application displays a message when the limit is reached, which informs the user that not all matching lists are displayed.

Optional

NO

B97_LIST_SELECT_ ORDER_BY_KEY

NONE | key

A customer-specific key may be defined in your database in order to accelerate the selection of lists under option1 - BROWSE. The name of this key is then specified with the help of this parameter. If this parameter has the value NONE, no key is specified in the generated select statements. Instead the database decides automatically whether to use a key (and if so, which one).

Important: Do not use or change this parameter without consulting support first.

Optional

IGRI00

B97_MAXIMUM_HITS_ ALLOWED

numeric

Maximum number of hits for a query.

If a query returns more hits, an error message will be displayed. Users can browser the hits that have been returned so far.

The started task currently requires 18 bytes of memory for each hit. Limiting the maximum number of hits per query ensures that memory can be made available for all users.

Optional

5000

B97_MAXIMUM_ OPERATIONS_ ALLOWED

Max. 99999

Maximum number of IO operations in the index file per query.

If a query has reached the maximum number of IOs, an error message will be displayed. Users can browser the hits that have been returned so far.

Adabas Audit Data Retrieval sets an automatic limit to the number of IOs allowed per query in order to automatically terminate long-running queries.

Optional

5000

B97_NUMBER_OF_ MSG1718W

numeric

The warning message IRM1718W is issued during scanning if the specified line and column offsets of an index definition point to a location outside the page of the list. Use this parameter if you want to limit the number of times that this message is issued for each index generation. 0 means no limit, i.e. message IRM1718W is output each time that this occurs.

Optional

0

B97_PROCESSING_OPTION

STD | AAR

STD refers to an installation with _beta doc|z.

Set this parameter to AAR in case of an Adabas Audit Data Retrieval installation.

This parameter is evaluated by the health checker function.

Optional

STD

B97_RC_MAXIMUM

Max. 99999

Maximum number of entries in the resource control table, which is used by the spool access management (SAM) function; each entry in the RC table represents a unique document

This parameter sets a limit to the number of documents that can be open at the same time. A realistic value at a large installation may be something between 5000 and 10000. At STC startup, the table is initialized with about 250 bytes for each possible entry.

Note: Warning message IRM1513W is written when the RC table is getting full (85%). Instead of increasing the value of B97_RC_MAXIMUM, you can also decrease the value of B97_RC_TIMEOUT. Documents that have not been accessed during the specified amount of time are released automatically.

Optional

5000

B97_RC_TIMEOUT

Max. 999

Determines how long Adabas Audit Data Retrieval holds in memory the resources that are required when opening a document (in minutes).

If B97_RC_ATTACH_SPOOLFILES=NO, you should set the parameter B97_RC_TIMEOUT=15.

If there is no activity during the specified amount of time, the document will be closed. It will be reopened when the document is accessed again by the same or by a different user. (The user will not notice that a document is closed and reopened.)

Optional

45

B97_ROUTER_INDEX_ GROUPS

1..9

Number of TCBs for concurrent queries
(determines how many queries can be processed concurrently)

Optional

1

B97_SEARCH_TITLE_AT_ POSITION

YES | NO

Controls whether the field From Column in the List/Report Selection panel specifies a starting position (NO) or a fixed position (YES) when searching the specified string in the title.

Optional

NO

B97_SMFREC

128..255 (If version 1: 128..1151)

SMF record number

This type number is used for the enabled subtypes when writing SMF records.

Optional

197

B97_SMFREC_SUBTYP_nn

WRITE | NOWRITE

Enables you to turn the writing of individual SMF record subtypes on or off. nn refers to the subtype.

For a description of the individual subtypes, see "SMF records".

Optional

NOWRITE

B97_SMFREC_VERSION

0 | 1

Optional

0

B97_SSID

ssid

ssid is the subsystem ID that identifies the Adabas Audit Data Retrieval started task via the subsystem interface. For a batch job, this value is the subsystem ID of the started task to which the batch job will sign on during program startup.

Required

none

B97_TC_MAXIMUM

Max. 99999

Maximum number of entries in the task control table, which is used by the spool access management (SAM) function; each entry in the TC table represents a unique task (AAV user, TSO user, etc.)

This parameter sets a limit to the number of users that can be active in the system at the same time. A realistic value at a large installation may be something between 1000 and 5000 users. At STC startup, the table is initialized with about 100 bytes for each possible entry.

Note: The minimum value for an Adabas Audit Data Retrieval installation is 500.

Optional

5000

B97_TC_TIMEOUT

Max. 999

User inactivity timeout in minutes (0 means no timeout)

When a user holding resources in Adabas Audit Data Retrieval has been inactive for the specified amount of time, his Adabas Audit Data Retrieval resources are released automatically. When the user tries to access these resources, an error message will be displayed.

Optional

60

B97_TCPIP_ PORT

B97_TCPIP_ PORT_app

B97_TCPIP_ xxxxxx

B97_TCPIP_ xxxxxx_app

see description

LST parameters of the BSA TCP/IP server

The BSA TCP/IP server enables cross-platform communication with product add-ons. Code these LST parameters in the B97LSTxx member when the BSA TCP/IP server is to run within the product STC.

The BSA TCP/IP server supports global ports and application ports. Application port definitions use the suffix _app in the keyword to identify the application, for example _AAV:

B97_TCPIP_PORT_AAV=(port,ipa,tcpname)

For more information on the BSA TCP/IP server, see "BSA TCP/IP server" in BSA Installation and System Guide.

For a description of the LST parameters, see "LST parameters for the BSA TCP/IP server" in BSA Installation and System Guide.

Optional

none

B97_TRACE_IDX

B97_TRACE_SEC

B97_TRACE_NTE

B97_TRACE_LST

YES | NO

Turns the corresponding trace function on or off:

IDX

Index creation

SEC

Security

NTE

Browser notes

LST

Dynamic modification of LST parameters using the BSA Service Manager

Set these parameters to YES only if asked to do so by support.

Optional

NO

B97_TRACE_SEC_LOGON_ ERROR

YES | NO

YES causes the output of more detailed trace messages with forced dump in case of logon failure. Set to YES only if asked to do so by support.

Optional

NO

B97_TRANSLATION_TABLE

1..6

Controls which translation table is used by the index program for lowercase to uppercase conversion in conjunction with search arguments. The following translation tables are present:

X'00' is converted to X'40' (space) by tables 1 through 5. The source code with the translation tables can be found in member B97TR720 in the BETA97.SAMPLIB.

Optional

1

BQL_MASTER_SSID

ssid

If there is only one Adabas Audit Data Retrieval subsystem or if each subsystem has its own database, the subsystem ssid defined using the keywords B97_SSID and BQL_MASTER_SSID is identical.

If several subsystems access one database in an OCF complex and this database is:

• not shared (BQL_SHARE_OPTION=NO), BQL_MASTER_SSID defines the subsystem ssid that controls the database (master subsystem) and B97_SSID defines the subsystem ssid (slave subsystem) that accesses the database via the master subsystem.
• shared (BQL_SHARE_OPTION=ALL | SPOOL), then BQL_MASTER_SSID defines the master subsystem ssid, which enables database sharing by making the required entries in the SYNC file.

For more information on BQL_SHARE_OPTION, see "Sharing databases with the BQL share option" in BSA Installation and System Guide.

Required

none

BQL_SPOOLCHECK_ MODEL

1..9

Minimum number of spool models

Warning message IRM9546W is written if the number of spool models is lower.

Optional

1

BQL_STATISTIC

YES | NO

Set this parameter to YES to log statistical data. This data is written to the Syslog when you stop the started task.

Optional

NO

BQL_TRACE

YES | NO

Turns the BQL trace function on or off

Set this parameter to YES only if asked to do so by support.

Optional

NO

OBJ_CENTERA_TRACE

YES | NO

Turns the trace function on/off when archiving on Centera

Set this parameter to YES only if asked to do so by support.

Optional

NO

OBJ_RELOAD_CATALOG_ unit

YES | NO

By default, Adabas Audit Data Retrieval uses the system catalog to locate archive datasets during reloading, which is okay in most cases. You can prevent using the system catalog for reloading from specific units by specifying the following keyword: OBJ_RELOAD_CATALOG_unit=NO
where unit refers to the corresponding unit name as defined in the archive subpool.

Optional

YES

OBJ_RETRIEVAL_DEVICES

numeric

Determines the number of units that can be simultaneously used for retrieving information

Optional

3

OBJ_RETRIEVAL_ORDER

numeric

Lowest value for reload order

When the reload order for an archive pool is ASIS, Adabas Audit Data Retrieval tries to reload from the subpool with this order; if there is no subpool with this order or if reloading fails, it tries to reload from the subpool with reload order n+1, then n+2, etc.

Optional

1

OBJ_RETRIEVAL_TIMEOUT

numeric

Amount of time (in seconds) that a tape or optical disk remains mounted after access (Adabas Audit Data Retrieval does not honor this timeout value when it needs the unit for other requests)

Optional

60

OBJ_TRACE_ALLOC

YES | NO

Turns the trace function on or off which traces alloc commands that are sent to the object server (for internal use only)

Optional

NO

OBJ_TRACE_COMMAND

YES | NO

Turns the trace function on or off which traces commands that are sent to the object server (for internal use only)

Optional

NO

B08_RELOAD_SEPARATE_ SPOOL

YES | NO

Specify YES if you want Adabas Audit Data Retrieval to use separate spool datasets for reloaded lists and reports.

The first spool reload dataset is allocated during installation or update. Define model definitions for additional spool reload datasets online (Option D.1) to enable Adabas Audit Data Retrieval to allocate and format additional spool reload datasets when needed.

NO is the default. Reloaded lists and reports are stored in the standard spool datasets.

Optional

NO