EDBP - Software AG Editor Buffer Pool Definitions

#### Search Results

Search

# EDBP - Software AG Editor Buffer Pool Definitions

This Natural profile parameter controls the initialization and operation of the editor buffer pool and its work file. It corresponds to the `NTEDBP` macro in the Natural parameter module.

Possible settings | See EDBP Parameter Syntax.
Default setting | See Keyword Subparameters.
Dynamic specification | yes | This parameter can only be specified dynamically. In the Natural parameter module, the macro `NTEDBP` is used instead.
Specification within session | yes | Use the SYSEDT utility; see SYSEDT Utility - Editor Buffer Pool Administration.

Notes:

1. The editor buffer pool is defined for a session by profile parameter `BPI` with `TYPE``=EDIT` or by profile parameter `EDPSIZE` (editor auxiliary buffer pool).
2. Shared Editor Buffer Pool: If the editor buffer pool is shared between multiple Natural sessions, all subparameters (except `DDNAME`, `DSNAME` and `FMODE`) are honored by the very first session only, which initializes the editor buffer pool work file during a buffer pool cold start. During a buffer pool warm start, the editor buffer pool subparameters (except `DDNAME`, `DSNAME` and `FMODE`) are read from the buffer pool work file. With subparameter `COLD``=ON`, a buffer pool cold start can be forced during the initialization of the editor buffer pool.
3. Editor Auxiliary Buffer Pool: If an editor auxiliary buffer pool is used (see profile parameter `EDPSIZE`), only the following subparameters apply: `FTOUT` | `LRECL` | `MAXLF`
4. For further information on the editor buffer pool, refer to Editor Buffer Pool in the Operations documentation.
5. For information on buffer pool performance, refer to SYSEDT Utility - Editor Buffer Pool Administration in the Utilities documentation.

The following topics are covered below:

- EDBP Parameter Syntax

- NTEDBP Macro Syntax

- Keyword Subparameters

- Example of EDBP Parameter

- Example of NTEDBP Macro

## EDBP Parameter Syntax

The `EDBP` parameter is specified as follows:

EDBP=(keyword-subparameter=value, keyword-subparameter=value,...)

See Keyword Subparameters.

## NTEDBP Macro Syntax

The `NTEDBP` macro is specified as follows:

             NTEDBP CHECK=value,                                           *
                   COLD=value,                                             *
                   CTOUT=value,                                            *
                   DDNAME=value,                                           *
                   DSNAME=value,                                           *
                   DTOUT=value,                                            *
                   FMODE=value,                                            *
                   FTOUT=value,                                            *
                   IMSG=value,                                             *
                   ITOUT=value,                                            *
                   LRECL=value,                                            *
                   LTOUT=value,                                            *
                   MAXLF=value,                                            *
                   PWORK=value,                                            *
                   RECNUM=value,                                           *
                   RWORK=value,                                            *
                   UTOUT=value

See Keyword Subparameters.

## Keyword Subparameters

`CHECK` | `COLD` | `CTOUT` | `DDNAME` | `DSNAME` | `DTOUT` | `FMODE` | `FTOUT` | `IMSG` | `ITOUT` | `LRECL` | `LTOUT` | `MAXLF` | `PWORK` | `RECNUM` | `RWORK` | `UTOUT`

### CHECK – Check and Initialize the Software AG Editor at Session Start

`CHECK=value` specifies whether the Software AG Editor is checked and initialized already during the start of the Natural session rather than at the first call of the Software AG Editor.

Value | Explanation
--- | ---
`ON` | The Software AG Editor is initialized during the Natural session start if the following conditions are true: The Software AG Editor module `NATEDT` is linked to Natural. The profile parameter `SSIZE` is set to a nonzero value. During the Software AG Editor initialization, the `SSIZE` buffer is allocated, and the Software AG Editor buffer pool and (if `EDPSIZE=0`) its work file are accessed and checked for availability.
`OFF` | The check and the initialization are done during the first call of the Software AG Editor. This is the default value.

### COLD - Buffer Pool Cold Start

`COLD=value` specifies whether a buffer pool cold start is performed.

Value | Explanation
--- | ---
`ON` | Cold start is performed.
`OFF` | Cold start is not performed. This is the default value.

Note
A cold start means that the buffer pool work file is cleared and reinitialized during buffer pool initialization. Any editor recovery information and all buffer pool parameters stored in the work file are lost.

### CTOUT - Timeout for Changed Buffer Pool Blocks

`CTOUT=value` specifies the timeout value for changed buffer pool blocks.

Value | Explanation
--- | ---
`1 - 32767` | Timeout value (in seconds).
`120` | This is the default value.

Note
A changed buffer pool block is written to the work file after the specified time interval has been exceeded, and no unchanged or free block is available.

### DDNAME - Logical Work File Name of the JCL Definition

`DDNAME=value` specifies the logical work file name of the JCL definition.

Value | Explanation
--- | ---
1 - 8 bytes. | Name of the logical work file.
`CMEDIT` | This is the default value.

Notes:

1. Under CICS: A corresponding file control table entry must be defined for the editor work file.
2. Under Com-plete: The specified logical work file name is the name of the `SD` file.

### DSNAME - Work File Data Set Name

`DSNAME=value` specifies the work file data set name for batch and TSO.

Possible values:

Value | Explanation
--- | ---
`1 - 44` | Name of the work file data set (in bytes).
| There is no default value.

This subparameter applies under z/OS only.
If no DD JCL statement is supplied and no `ALLOC` statement is issued (under TSO only) for the editor work file, then `DSNAME` will be allocated dynamically.

### DTOUT - Logical File Timeout Check Value

`DTOUT=value` specifies the logical file timeout check value.

Value | Explanation
--- | ---
`1 - 32767` | Timeout check value (in seconds).
`300` | This is the default value.

Note
Logical files are checked for timeout each time the specified time interval has been exceeded.

### FMODE - Work File Mode

`FMODE=value` specifies the file mode for the work file.

Value | Explanation
--- | ---
1 - 2 characters | File mode. Under Com-plete/SMARTS, the value `SM` determines that a SMARTS work file is used. In this case, the SMARTS environment variable `$NAT_WORK_ROOT` determines the path. Under Com-plete/SMARTS, if a value other than `SM` is specified, a Com-plete SD file is used. In a SMARTS environment without Com-plete, `SM` must be specified.
`A1` | This is the default value.

Note
This subparameter applies under Com-plete/SMARTS only.

### FTOUT - Timeout Value for Logical Files

`FTOUT=value` specifies the timeout value for logical files.

Value | Explanation
--- | ---
`60 - 16777215` | Timeout value (in seconds).
`86400` | This is the default value.

Note
A logical file is deleted after the specified time interval has been exceeded and no access has occurred.

### IMSG - Buffer Pool Initialization and Termination Message

`IMSG=value` specifies whether a buffer pool initialization and termination message is issued on the operator console.

Value | Explanation
--- | ---
`ON` | A buffer pool initialization and termination message is issued.
`OFF` | No buffer pool initialization and termination message is issued. This is the default value.

### ITOUT - Buffer Pool Initialization Timeout Value

`ITOUT=value` specifies the buffer pool initialization timeout value for multi-user buffer pools only.

Value | Explanation
--- | ---
`1 - 32767` | Buffer pool initialization timeout value (in seconds).
`300` | This is the default value.

Note
The buffer pool is initialized by the first user by whom it is accessed. Other users have to wait until the first user finishes initialization. If the initialization is not finished after the specified time interval (for example, due to an abnormal termination of the first user), all other users receive an error message.

### LRECL - Work File Record Length

`LRECL=value` specifies the buffer pool block size and work file record length.

Value | Explanation
--- | ---
`800 - 16384` | Length (in bytes).
`4096` | This is the default value.

Notes:

1. This parameter is honored under Com-plete and for editor auxiliary buffer pools only.
2. For other environments, the work file record length is determined when the editor work file is created.

### LTOUT - Timeout Value for Locked Buffer Pool Blocks

`LTOUT=value` specifies the timeout value for locked buffer pool blocks.

Value | Explanation
--- | ---
`1 - 32767` | Timeout value (in seconds).
`20` | This is the default value.

Note
A buffer pool block that was locked during a read from the work file is freed after the specified time interval has been exceeded.

### MAXLF - Maximum Number of Logical Files

`MAXLF=value` specifies the maximum number of logical files.

Value | Explanation
--- | ---
`100 - 999999` | Maximum number of logical files.
`1000` | This is the default value.

### PWORK - Percentage of Work File Records Used as Work Records

`PWORK=value` specifies the percentage of work file records used as work records during an editor buffer pool cold start.

Value | Explanation
--- | ---
`0 - 100` | Work file records used (in percent).
`50` | This is the default value.

Note
The remaining records are used as recovery records.

### RECNUM - Number of Work File Records

`RECNUM=value` specifies the number of work file records (under Com-plete only) during an editor buffer pool cold start.

Value | Explanation
--- | ---
`100 - 65535` | Number of work file records.
`200` | This is the default value.

Notes:

1. This subparameter applies under Com-plete only.
2. This number determines the size of the work file.
3. The number of work file records is determined when the editor work file is created.

### RWORK - Percentage of Work Records Used for Regular Logical Files

`RWORK=value` specifies the percentage of work records that is used for regular logical files during an editor buffer pool cold start.

Value | Explanation
--- | ---
`51 - 100` | Work records used (in percent).
`90` | This is the default value.

Note
The remaining records are used internally to release blocks from the buffer pool.

### UTOUT - Timeout Value for Unchanged Buffer Pool Blocks

`UTOUT=value` specifies the timeout value for unchanged buffer pool blocks.

Value | Explanation
--- | ---
`1 - 32767` | Timeout value (in seconds).
`20` | This is the default value.

Note
An unchanged buffer pool block is written to the work file after the specified time interval has been exceeded and no free block is available.

## Example of EDBP Parameter

    EDBP=(DDNAME=EDFILE1,IMSG=ON,CHECK=ON)

## Example of NTEDBP Macro

             NTEDBP DDNAME=EDFILE1,IMSG=ON,CHECK=ON

### On this page

- EDBP Parameter Syntax
- NTEDBP Macro Syntax
- Keyword Subparameters
- Example of EDBP Parameter
- Example of NTEDBP Macro