Quick Reference

Startup Parameters in Alphabetical Order

The startup parameter descriptions are listed in alphabetical order by their names.

Note:
Elements in italics (e.g. name) denotes a variable that must be replaced by a real value, for example, a name.

This document covers the following startup parameters:


ACCOUNT-NATSUB

Operating System Type Default Maximum Value Length
BS2000 Optional There is no default. 8 bytes

The ACCOUNT-NATSUB value specifies an account number used for all Natural subtasks running under control of the Entire System Server. Do not specify any user information in startup parameter PRMNATSUB, if ACCOUNT-NATSUB is supplied.

ADA5SVC

Operating System Type Default
z/OS, z/VSE Required. None

The Adabas SVC number to be used. The Adabas SVC is used to perform various internal functions, including communication between the Natural program and the Entire System Server nucleus in multi-user mode.

Note:
This parameter is also valid for all Adabas versions.

APPC-LUNAME

Operating System Type Default Maximum Value Length
z/OS Optional NPRLU01 8 bytes

The name of the APPC/MVS LU to be used for the transaction program invoked by the SYSTEM-COMMAND view processor to execute TSO/E commands.

APPC-MODENAME

Operating System Type Default Maximum Value Length
z/OS Optional APPCHOST 8 bytes

The name of the default logon mode name to be used with the APPC/MVS transaction program invoked by the SYSTEM-COMMAND view processor to execute TSO/E commands.

APPC-TPNAME

Operating System Type Default Maximum Value Length
z/OS Optional SAG.NPRvrs.XCOMTP46 64 bytes

The name of the APPC/MVS transaction program to be invoked by the SYSTEM-COMMAND view processor to execute TSO/E commands.

AUTOLOG

Operating System Type Default
z/OS, z/VSE, BS2000 Optional YES

Specifies automatic logon to the Entire System Server at the start of the Natural session. Possible options:

Option Explanation
YES No password check is done as part of the Entire System Server logon, as long as the specified user ID matches the internal Natural user ID. An implicit logon is performed if the first user request is not a logon call.
NO No logon to the Entire System Server is performed at the start of the Natural session, but note that if an external security system is installed, a logon to the Entire System Server including user ID and password is always required.

The usage of the AUTOLOG parameter depends on the network environment. If there is no Net-Work installed, the autolog feature should be used to avoid additional logon procedures if the password check has already been done as part of the TP or Natural logon.

In a Net-Work environment, the usage of AUTOLOG depends on the defined Net-Work nodes. If only mainframes are connected, we recommend using the autolog feature. In environments with PCs connected to Net-Work, Entire System Server should run without autolog (AUTOLOG=NO).

CDATALEN

Operating System Type Default
z/OS, z/VSE, BS2000 Optional 0

The maximum size (in K bytes) of the common data pool. A value greater than 0 must be specified if the view COMMON-DATA is to be used.

COMPLETE

Operating System Type Default
z/OS, z/VSE Optional NO

Specifies whether Com-plete is installed on the system.

CONACCESS

Operating System Type Default
BS2000 Optional NONE

Specifies the access capability of the Entire System Server node to the Console Task. Possible options:

Option Explanation
NONE Default. Console Task will not be activated. The view CONSOLE can, therefore, only be used for the functions WTO and WTOR.
READ Console Task will be activated if the parameter JOBCONS is specified. All retrieval functions of the view CONSOLE can be used.
WRITE Same as for READ option, but operator commands can also be issued by using the view CONSOLE.

Write access can be restricted to certain users and commands, using the exit USERCSEC. For more information, see BS2000 Security Considerations in the Section BS2000 Considerations of the Entire System Server Administration documentation.

CONSNAME

Operating System Type Default
z/OS, z/VSE Optional is the string ESYnnnnn, where nnnnn is the node number of this Entire System Server.

This parameter indicates the name for your logical console in an MCS environment. If you have 2 different Entire System Servers running on the same SYSPLEX system with the same node number, you may choose your own name for your console in this case.

CONSTAB

Operating System Type Default
z/OS, z/VSE Optional 1000 messages.

nnn is the number of messages to be kept. This parameter has been valid since MVS/ESA 5.1. and z/VSE 2.1. A wraparound table for z/OS or z/VSE console messages is generated. The number of slots for this table can be defined here.

CONSTAB=0 will switch off the reading of console messages which is done in the background.

DEFNATSEC

Operating System Type Default
z/OS Optional ADDRSP

This parameter controls if a Natural subtask for an Entire System Management (ESM) product is to run in the security environment of the Entire System Server’s address space or in a separate subtask security environment with a RACF protected user ID.

Possible options:

Option Explanation
ADDRSP Natural subtasks are run in the security environment of the address space.
TASK Natural subtasks are run in the security environment of the task with the user ID specified in the DEFNATUSER startup parameter. This user ID must be defined in RACF as a protected user ID.

DEFNATUSER

Operating System Type Default
z/OS Optional None

This parameter indicates a default z/OS Natural user which can be used to run Natural in Entire System Server's address space (for example: NCL, NOM, NOP).

DYNAMPOOL

Operating System Type Default
z/VSE Optional None

This parameter indicates the name of the CA-Dynam/D 'virtual' volume.

The DYNAM pool name is supported in READ-FILE, WRITE-FILE and LIB-DIRECTORY for referencing single volume data sets and libraries. It is not currently supported for FILE-ALLOCATE.

EDIT-TIMEOUT

Operating System Type Default
z/OS Optional 600 (=10 hours)

An EDIT session using Natural ISPF will stay active nnn minutes for Entire System Server, until it erases all resources for this user. You should adjust this value to timeout values for your TP system (Com-plete, CICS, TSO, etc.).

EOR-JOBNAME-WITH-NODE

Operating System Type Default
BS2000 Optional NO

This parameter allows you to manipulate the composition of job names for Entire Operations tasks managed as NATURAL-SUB-TASKS. If multiple Entire Operations monitors are running on the same machine, you may define this parameter value to YES. However, please consult Software AG support staff before adding or changing this parameter. Possible options:

Option Explanation
YES The NODE parameter value is used to replace the rightmost three bytes of the EOR job names. If the value of NODE is greater than 999, the rightmost five bytes of the job names are used for the NODE value.
NO The job names supplied by EOR are used without any modification.

ESYTRACE

Operating System Type Default
z/OS, z/VSE Optional NO

This parameter allows you to switch on the internal tracing facility of Entire System Server.

Important:
It should only be used upon request of Software AG support staff.

Option Explanation
YES Activate internal tracing facility.
NO Default. Deactivate internal tracing facility.

In the JCL of Entire System Server, the following card is required:

//ESYTRACE DD SYSOUT=X for z/OS

Note:
In z/VSE, ESYTRACE output is written to SYSLST.

EVENTLEN

Operating System Type Default
BS2000 Optional 0

Size of eventing memory pool in Kbytes. If the view EVENTING is to be used, you must specify a value of 3 or greater.

FILETABLE

Operating System Type Default
z/VSE Optional DYNAMIC

Defines whether files not specified in STD, PARSTD, TEMP or CLASSSTD labels at Entire System Server initialization time can later be accessed. Possible options:

Option Explanation
DYNAMIC Default. Files can be accessed.
STATIC Files cannot be accessed. File ID table is frozen.

FORCE

Operating System Type Default
z/OS, z/VSE, BS2000 Optional NO

Allows or disallows DBID table entry overwrite. Meaning of the options:

Option Explanation
YES Only required when the DBID table entry is not deleted after an abnormal termination. Note that overwriting an existing entry prevents any further communication with the overwritten node. Use FORCE=YES only when you are absolutely sure that no target node with that node ID is active.
NO Protects the node table entry from being overwritten.

HOST-CODE-PAGE

Operating System Type Default
z/OS, z/VSE, BS2000 Optional None

This parameter is used to define the default host codepage used for any input data in view SEND-EMAIL.

Possible options for BS2000:

Option Explanation
EDF03DRV Coded character set (CCS) EBCDIC.DF.03 ISO-7-bit German
EDF03IRV Coded character set (CCS) EBCDIC.DF.03 ISO-7-bit International
EDF041 Coded character set (CCS) EBCDIC.DF.04 ISO-8-bit International
EDF04DRV Coded character set (CCS) EBCDIC.DF.04 ISO-8-bit German

Possible options for z/OS, z/VSE:

Option Explanation
1140 Brazil, Canada, Netherlands, Portugal, U.S.
1141 Austria, Germany
1142 Denmark, Norway
1143 Finland, Sweden
1144 Italy
1145 Latin America, Spain
1146 United Kingdom
1147 France
1148 International
1149 Iceland
114A Israel Hebrew code page 424, z/OS only

IDENTIFIER

Operating System Type Default
z/OS, z/VSE, BS2000 Optional None

String to identify the node. Maximum length is 50 bytes. This string can be retrieved from the field NODE-ID in the view SYSTEM-INFO.

Using this identifier, you can see the machine on which this Entire System Server is running in an Entire Net-Work environment.

IDTNAME

Operating System Type Default
BS2000 Optional ADABAS5A for Adabas 5.1,
ADABAS5B for Adabas 5.2 and above.

If an ID table name is specified with the appropriate ADARUN parameter for your Entire Net-Work or Adabas and Natural, the same name must be specified here.

IMAP-HOST

Operating System Type Default Maximum Value Length
z/OS Optional None 64 bytes

The name of the IMAP server, from which e-mails are received. IP notation is not supported. There is no default. If this parameter remains unspecified, view RECEIVE-EMAIL cannot be used.

IMAP-PORT

Operating System Type Default Maximum Value Length
z/OS Optional None 5 bytes

The port number by which the IMAP-HOST is accessed. This is usually port 993 for a connection secured by SSL. There is no default.

IUBL

Operating System Type Default
z/OS, BS2000 Optional 32767
z/VSE Optional 16384

Maximum length of the buffer that can be passed from the caller to the Entire System Server.

Note:
When using the remote PDSE program object-copying feature under z/OS, we recommend not reducing this value, otherwise NAT3152 or Adabas response code 152 errors may occur.

JOB-CLASS

Operating System Type Default Maximum Value Length
BS2000 Optional TSOSBAT 8 bytes

Specifies the job class for the ESY tasks if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

JOBCONS

Operating System Type Default Maximum Value Length
BS2000 Optional None 120 bytes

Specifies the location of the job control to start the Console Task. For details, see BS2000 UCON Interface in the Section BS2000 Considerations of the Entire System Server Administration documentation.

Possible options:

Option Explanation
filename  Enter job is saved as file. The startup parameter SDF is omitted or set to NO to use ISP format or set to YES to use SDF format.
library(element) Enter job is saved as LMS element. The startup parameter SDF is omitted or set to NO to use ISP format.
*LIBRARY-ELEMENT(LIBRARY=library, ELEMENT=element) Enter job is saved as LMS element. The startup parameter SDF is set to YES.

JOB-ELEM

Operating System Type Default Maximum Value Length
BS2000 Optional None 64 bytes

Specifies the LMS element name of type J to run the ESY tasks if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

JOBEMAIL

Operating System Type Default Maximum Value Length
BS2000 Optional None 120 bytes

Specifies the location of the job control to start the E-Mail Manager Task.

For more information about E-Mail administration, see Run E-Mail Client in Common Entire System Server Features in the Entire System Server Administration documentation.

Possible options:

Option Explanation
filename Enter job is saved as file. The startup parameter SDF is omitted or set to NO to use ISP format or set to YES to use SDF format.
library(element) Enter job is saved as LMS element. The startup parameter SDF is omitted or set to NO to use ISP format.
*LIBRARY-ELEMENT(LIBRARY=library, ELEMENT=element) Enter job is saved as LMS element. The startup parameter SDF is set to YES.

JOBENT

Operating System Type Default
BS2000 Optional None

This parameter is used to control the usage of privileged code for submitting jobs by Entire System Server.

Possible options:

Option Explanation
YES Entire System Server will execute privileged code to submit jobs.
NO Entire System Server will not execute privileged code to submit jobs.
Not specified Entire System Server will execute privileged code for submitting jobs on systems with encrypted passwords.

JOBEVENT

Operating System Type Default Maximum Value Length
BS2000 Optional None 120 bytes

Specifies the location of the job control to start the Eventing Task. The view EVENTING is only available if this task is running.

Possible options:

Option Explanation
filename Enter job is saved as file. The startup parameter SDF is omitted or set to NO to use ISP format or set to YES to use SDF format.
library(element) Enter job is saved as LMS element. The startup parameter SDF is omitted or set to NO to use ISP format.
*LIBRARY-ELEMENT(LIBRARY=library, ELEMENT=element) Enter job is saved as LMS element. The startup parameter SDF is set to YES.

JOB-LIB

Operating System Type Default Maximum Value Length
BS2000 Optional None 54 bytes

Specifies the LMS library to find the SDF-P procedure (defined by JOB-ELEM) to run the ESY tasks if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

JOB-NAME-CONS

Operating System Type Default Maximum Value Length
BS2000 Optional XCON199 8 bytes

Specifies the job name of the Console Task if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

JOB-NAME-EMAIL

Operating System Type Default Maximum Value Length
BS2000 Optional XEML199 8 bytes

Specifies the job name of the E-Mail Manager Task if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

JOB-NAME-EVENT

Operating System Type Default Maximum Value Length
BS2000 Optional XEVT199 8 bytes

Specifies the job name of the Eventing Task if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

JOB-NAME-SERVER

Operating System Type Default Maximum Value Length
BS2000 Optional XSRV199 8 bytes

Specifies the job name of the Server Task if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

JOB-RUN-PRIORITY

Operating System Type Default Maximum Value Length
BS2000 Optional STD 3 bytes

Specifies the run priority of the ESY tasks if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

For details, refer to operand RESOURCES=*PARAMETERS(RUN-PRIORITY=value) of command ENTER-PROCEDURE.

JOB-START-OPTION

Operating System Type Default Maximum Value Length
BS2000 Optional IMMEDIATELY 17 bytes

Specifies the start option of the ESY tasks if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

JOB-START-OPTION

Specifies the start option of the ESY tasks if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

Operating System Type Default Maximum Value Length
BS2000 Optional IMMEDIATELY 17 bytes

For details, refer to operand SCHEDULING-TIME=*PARAMETERS(START=value) of command ENTER-PROCEDURE.

JOB-TIME

Operating System Type Default Maximum Value Length
BS2000 Optional NO 5 bytes

Specifies the CPU limit of the ESY tasks if Entire System Server is using the SDF-P startup method activated by parameter SDF-P=YES.

For details, refer to operand RESOURCES=*PARAMETERS(CPU-LIMIT=value) of command ENTER-PROCEDURE.

JOBNATSUB

Operating System Type Default Maximum Value Length
BS2000 Optional None 120 bytes

Specifies the location of the job control to start the initial task for Natural subtasks. Possible options:

Option Explanation
filename  Enter job is saved as file. The startup parameter SDF is omitted or set to NO to use ISP format or set to YES to use SDF format.
library(element)  Enter job is saved as LMS element. The startup parameter SDF is omitted or set to NO to use ISP format.
*LIBRARY-ELEMENT(LIBRARY=library, ELEMENT=element) Enter job is saved as LMS element. The startup parameter SDF is set to YES.

For more information about Natural subtasks, see Aspects of Running System Automation Tools in Entire System Server on BS2000 in the Entire System Server Administration documentation.

JOBSERVER

Operating System Type Default Maximum Value Length
BS2000 Required None 120 bytes

 needs at least one Server Task to handle user requests. If this parameter is omitted, the Entire System Server terminates with an error message. Possible options:

Option Explanation
filename Enter job is saved as file. The startup parameter SDF is omitted or set to NO to use ISP format or set to YES to use SDF format.
library(element)  Enter job is saved as LMS element. The startup parameter SDF is omitted or set to NO to use ISP format.
*LIBRARY-ELEMENT(LIBRARY=library, ELEMENT=element) Enter job is saved as LMS element. The startup parameter SDF is set to YES.

LANGUAGE

Operating System Type Default
BS2000 Optional E

Specifies the language for console messages. Possible options:

Option Explanation
E Default. Console messages appear in English.
G Console messages appear in German.

LIST-NUM-MAILS

Operating System Type Default Maximum Value Length
z/OS Optional None 3 bytes

The default number of mails to be received by function LIST in view RECEIVE-EMAIL. Default is 20. You can specify a different value in the Natural programme. The maximum value is specified by LIST-NUM-MAILS-MAX.

LIST-NUM-MAILS-MAX

Operating System Type Default Maximum Value Length
z/OS Optional 100 3 bytes

The maximum value for field LIST-NUM-EMAILS in view RECEIVE-EMAIL. Default is 100, maximum is 999.

LOCAL

Operating System Type Default
z/OS, z/VSE, BS2000 Optional NO

Specifies whether the node (specified by the NODE parameter) is accessible in a network from remote nodes.

Option Explanation
YES Node is accessible locally only (not from remote nodes).
NO Node is accessible globally.

LOCAL-HOST

Operating System Type Default Maximum Value Length
z/OS, z/VSE, BS2000 Optional None 63 bytes for z/OS and z/VSE, 160 bytes for BS2000

Specifies the domain name. In combination with the LOGON-ID, the parameter is used as sender address in SEND-EMAIL requests. It should be used only if there are difficulties in using the existing host name setting of the local machine.

LOGCB

Operating System Type Default
z/OS, z/VSE, BS2000 Optional NO

Specifies Adabas control block logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGCB=YES (on z/OS).

see Operator Commands.

See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Adabas control block is logged.
NO Adabas control block is not logged.

LOGFB

Operating System Type Default
z/OS, z/VSE, BS2000 Optional NO

Specifies format buffer logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGFB=YES (on z/OS).

See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Format buffer is logged.
NO Format buffer is not logged.

LOGGING

Operating System Type Default
z/OS, z/VSE, BS2000 Optional NO

Specifies command logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGGING=YES (on z/OS). See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

This allows logging of data for a certain amount of time only and without restarting Entire System Server.

Possible options:

Option Explanation
YES Command logging is activated.
NO No command logging.

LOGRB

Operating System Type Default
z/OS, z/VSE, BS2000 Optional NO

Specifies record buffer logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGRB=YES (on z/OS).

See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Record buffer is logged.
NO Record buffer is not logged.

LOGSB

Operating System Type Default
z/OS, z/VSE, BS2000 Optional NO

Specifies search buffer logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGSB=YES (on z/OS).

See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Search buffer is logged.
NO Search buffer is not logged.

LOGVB

Operating System Type Default
z/OS, z/VSE, BS2000 Optional NO

Specifies value buffer logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGVB=YES (on z/OS).

See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Value buffer is logged.
NO Value buffer is not logged.

LOOP

Operating System Type Default
z/OS, z/VSE, BS2000 Optional 0

Determines the amount of CPU time (in seconds) which can be used by Entire System Server servers. The default value of zero (0) means there is no limit and no CPU time is recorded for display using the NATPROC-USER view.

We recommend setting this parameter to 200 to allow CPU times to be collected without interfering with long-running programs. If you receive the 5537 time limit error, you can increase this value.

MONITOR-CANCEL

Operating System Type Default
BS2000 Optional NO

This parameter provides additional control for Natural subtasks. If Entire System Server is shutting down, it cancels active Natural subtasks after elapsing SHUTDOWN-MAX-DELAY if MONITOR-CANCEL=YES is supplied.

The options on BS2000 are:

Option Explanation
NO Natural subtask shutdown is not enforced by Entire System Server.
YES Natural subtask shutdown is enforced by Entire System Server. Tasks are cancelled after elapsing SHUTDOWN-MAX-DELAY.

MONJV-PREFIX-NATSUB

Operating System Type Default Maximum Value Length
BS2000 Optional There is no default. 28 bytes

The prefix for the monitor job variables (MONJVs) used for Natural subtasks running under control of the Entire System Server. The value must contain a user ID.

MSGLEVEL

Operating System Type Default
z/OS, z/VSE, BS2000 Optional I

Specifies which message is to be written to the system messages protocol. Possible options:

Option Explanation
E | 3 Error. Available in BS2000 only. Only error messages are written. Information and warnings are suppressed.
W | 2 Warning. Suppresses the logging of startup parameters, as well as the messages indicating a user non-activity time-out.
I | 1 Info. All messages are written.

Note:
The values E, W, I are currently supported under BS2000 only.

NABS

Operating System Type Default
z/OS, z/VSE, BS2000 Optional 10

The number of attached buffers to be used. An attached buffer is an internal buffer used for interregion communication. An attached buffer pool will be allocated of a size equal to the value specified here multiplied by 4112.

NATDYNPAR

Operating System Type Default
BS2000 Optional SYSDTA

On BS2000, Natural subtasking is starting a batch task running a Natural nucleus. The Natural batch driver can be configured to read dynamic startup parameters from FILE, SYSIPT or SYSDTA. The NATDYNPAR value must be set to the same value as the parameter DYNPAR in the NAMBS2 macro of your Natural batch driver to read the dynamic parameters for the Natural subtask from the correct input unit.

Please use the new Natural subtask skeletons to benefit from this startup setting. Possible values:

Value Explanation
FILE Dynamic parameters are read from a sequential file temporarily created in the Natural subtask JCL skeleton. It will be assigned with a FILE command by using the LINK name CMPRMIN.
SYSDTA Dynamic parameters are read from SYSDTA.
SYSIPT Dynamic parameters are read from SYSIPT. Please check your environment if data input by means of the system file SYSIPT is supported.

For more information about Natural subtasks, see Aspects of Running System Automation Tools in Entire System Server on BS2000 in the Section BS2000 Considerations of the Entire System Server Administration documentation.

NATMOD

Operating System Type Default
z/OS, z/VSE Optional None

Name of the linked Natural used for subtasking. Refer to the Entire System Server Installation and Customization documentation for details on how to create this module.

If NATMOD was specified, it is recommended to set also parameter SHUTDOWN-MAX-DELAY.

NATNUMSUB

Operating System Type Default
z/OS, z/VSE, BS2000 Optional 0

Number of Natural subtasks.

If NATNUMSUB was specified, it is recommended to set also parameter SHUTDOWN-MAX-DELAY.

NATSYSOUT

Operating System Type Default
z/OS Optional Z

This parameter indicates a SYSOUT class to which the output of Natural subtasks running in Entire System Server's address space can be written (for example: NCL, NOM, NOP).

If NATSYSOUT was specified, it is recommended to set also parameter SHUTDOWN-MAX-DELAY.

NCQE

Operating System Type Default
z/OS, z/VSE, BS2000 Optional 10

The number of command queue elements to be established. This value determines the maximum number of Entire System Server commands which can be queued and/or be in progress at any one time when the Entire System Server is in use. Each Entire System Server command is assigned a command queue element. This element is released when the user has received the results of the command or when the user has been timed out. 192 bytes are required for each command queue element.

NODE

Operating System Type Default
z/OS, z/VSE, BS2000 Required There is no default. n must be a value greater than or equal to 1 and less than or equal to 65535.

The Entire System Server DBID. It must be unique for each Entire System Server node.

If you set the parameter LOCAL=YES, you can use the same node number for different installations of Entire System Server in an Entire Net-Work environment.

NONACT

Operating System Type Default
z/OS, z/VSE, BS2000 Optional 60

The non-activity time (in minutes). If a user has not issued a request to the Entire System Server during this time interval, the user is logged off, and the resources of the user will be freed.

NONACT=0 is rejected as invalid parameter value.

NUMCONSMSG

Operating System Type Default
BS2000 Optional 1024

This parameter defines the size of the table collecting console messages in number of messages. The value must be between 0 and 65535.

NUMFAT

Operating System Type Default
BS2000 Optional 128

Number of Fast Access Tables (minimum 0, maximum 256, size per table 8K). These tables are used for READ-FILE requests to cache the number of records per block for SAM files. Once a Fast Access Table is created for a SAM file, it improves the performance of accessing this file directly per RECORD-NUMBER.

NUMFAT=0 is used to disable this feature of READ-FILE.

NUMLIBS

Operating System Type Default
z/VSE Optional 300

Maximum number of entries in the file ID table.

NUMMAIL

Operating System Type Default
BS2000 Optional 0

Number of E-Mail control and data entries temporarily saved in E-Mail memory pool. This storage is needed for Interprocess Communication between ESYSERV and ESYMAIL tasks of Entire System Server. The size of the E-Mail memory pool is defined by 32 bytes for one control block entry plus 1024 bytes for one data block entry multiplied by the NUMMAIL value. Maximum is 4096 entries.

For more information about E-Mail administration, see Run E-Mail Client in Common Entire System Server Features in the Entire System Server Administration documentation.

NUMTASK

Operating System Type Default
z/VSE, BS2000 Optional z/VSE: 15, BS2000: 4

Number of tasks to be started for user requests as part of the Entire System Server initialization.

If Dynamic Server Management is enabled, NUMTASK specifies the number of Server Tasks started during initialization of Entire System Server.

For detailed information, see Dynamic Server Management for Entire System Server in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

NUMUSER

Operating System Type Default
BS2000 Optional 128

Number of ESY users (minimum 10, maximum 512). This value specifies the maximum number of users working in parallel. Please note that the length of a user session is fixed by the NONACT parameter.

PRMCONS

Operating System Type Default Maximum Value Length
BS2000 Optional None 120 bytes

Parameters for Enter of Console Task. If startup parameter SDF is set to YES, values must be specified in SDF syntax.

PRMEMAIL

Operating System Type Default Maximum Value Length
BS2000 Optional None 120 bytes

Parameter for /ENTER of E-Mail Manager Task. If startup parameter SDF is set to YES, values must be specified in SDF syntax.

PRMEVENT

Operating System Type Default Maximum Value Length
BS2000 Optional None 120 bytes

Parameters for Enter of Eventing Task. If startup parameter SDF is set to YES, values must be specified in SDF syntax.

PRMNATSUB

Operating System Type Default Maximum Value Length
BS2000 Optional None 120 bytes

Parameters for Enter of initial task for Natural subtask. If startup parameter SDF is set to YES, values must be specified in SDF syntax.

PRMSERVER

Operating System Type Default Maximum Value Length
BS2000 Optional None 120 bytes

Parameters for Enter of Server Task(s). If startup parameter SDF is set to YES, values must be specified in SDF syntax.

READ-LOCKED-FILE

Operating System Type Default
BS2000 Optional None

This parameter is used to control the usage of privileged code for opening locked SAM files by the Entire System Server. Possible options:

Option Explanation
YES The Entire System Server will execute privileged code to open locked SAM files for reading records.
NO The Entire System Server will not execute privileged code to open locked SAM files for reading records.
Not specified The Entire System Server will execute privileged code for opening locked SAM files.

PRODUCT

Operating System Type Default
z/OS, BS2000 Optional None

Name of additional library management systems. You must specify the parameter for each supported subsystem. Possible options:

Option Explanation
L CA-Librarian
M LMS
P CA-Panvalet

RECALL

Operating System Type Default
z/OS, BS2000 Optional. YES

Specifies whether migrated datasets can be recalled. Possible options:

Option Explanation
YES Default. Migrated datasets can be recalled automatically.
NO Migrated datasets cannot be recalled automatically.

If you are using Natural ISPF Version 2.1.1 or above, set RECALL=YES.

This parameter is used for products such as IBM's DFSMShsm or FDR which uses the SVC 109 for migration, or Siemens' HSMS.

z/OS only: if RECALL=NO, you must start the recall using the view FILE-MAINTENANCE, FUNCTION='RECALL'.

REVIEW

Operating System Type Default
z/OS Optional NO

Specifies whether Adabas Review is to be used with Entire System Server to collect performance data in local mode for requests originating from Natural. For other required steps, see Using Adabas Review with Entire System Server in the Section z/OS Considerations of the Entire System Server Administration documentation.

Option Explanation
NO Default. Adabas Review is not to be used.
YES Adabas Review is to be used.

SATSKEL-BEGIN

Operating System Type Default
BS2000 Optional None

This keyword is used without any value. It indicates the beginning of the job control skeleton for the System Automation Tools (Natural subtasks) starting on the next line. As long as the parser does not find SATSKEL-END, it will interpret everything as job control skeleton. See also the SATSKEL-END parameter.

For more information about Natural subtasks, see Aspects of Running System Automation Tools in Entire System Server on BS2000 in the Section BS2000 Considerations of the Entire System Server Administration documentation.

SATSKEL-END

Operating System Type Default
BS2000 Optional None

This keyword is used without any value. It indicates the end of the job control skeleton for the System Automation Tools (Natural subtasks). See also the SATSKEL-BEGIN parameter.

For more information about Natural subtasks, see Aspects of Running System Automation Tools in Entire System Server on BS2000 in the Section BS2000 Considerations of the Entire System Server Administration documentation.

SDF

Operating System Type Default
BS2000 Optional NO

Specifies if SDF syntax is to be used for internal commands. If YES is specified, all JCL-related startup parameters must contain SDF syntax.

Possible options:

Option Explanation
YES SDF syntax is to be used.
NO Default. ISP syntax is to be used.

SDF-P

Operating System Type Default
BS2000 Optional NO

This parameter is used to control the startup method of Entire System Server. Possible options:

Option Explanation
YES

To run the various ESY tasks, Entire System Server is using the SDF-P procedure specified by the following parameters:

  • JOB-ELEM

  • JOB-LIB

For the definition of more task specific attributes, the following parameters are available:

  • JOB-CLASS

  • JOB-NAME-CONS

  • JOB-NAME-EMAIL

  • JOB-NAME-EVENT

  • JOB-NAME-SERVER

  • JOB-RUN-PRIORITY

  • JOB-START-OPTION

  • JOB-TIME

NO

To run the various ESY tasks, Entire System Server is using the job control specified by parameters:

  • OBCONS

  • JOBEMAIL

  • JOBEVENT

  • JOBSERVER

SECURITY

Operating System Type Default
z/OS, z/VSE, BS2000 Optional None

The security system in use. The options are:

Option Explanation
NONE No security system is used.
BS2 User ID, password are checked against TIAM user ID definitions in BS2000 (TSOSJOIN).
RACF RACF, ACF2 or TOP-SECRET security is used. For details, see Setting Up RACF Security for Operator Commands on z/OS in the Section z/OS Considerations.
RACX RACF is installed but no logon is done. Normal security exits are invoked.
USER Available in BS2000 only: Example exit USERLSEC must be modified to solve security considerations at your site.

SERVER-DYN

Operating System Type Default
z/VSE, BS2000 Optional NO

Specifies if Dynamic Server Management has to be activated. This value can be changed dynamically via operator command.

For further information, see Dynamic Server Management for Entire System Server in the Section Common Entire System Server Features.

Option Explanation
YES Dynamic Server Management is enabled at startup time.
NO Dynamic Server Management is disabled at startup time.

SERVER-MAX

Operating System Type Default
BS2000 Optional 16
z/VSE Optional n

Specifies the maximum number of server tasks/subtasks running in Entire System Server. This value is considered by the Dynamic Server Management as maximum capacity for a high workload. For further information, see Dynamic Server Management for Entire System Server in the Section Common Entire System Server Features.

For BS2000, the following rule applies:

          

1 <= SERVER-MAX <= 16

SERVER-MIN <= NUMTASK <= SERVER-MAX

For z/VSE, the following rule applies:

          

1 <= SERVER-MAX <= n

SERVER-MIN <= NUMTASK <= SERVER-MAX

For z/VSE, n is calculated as follows:

 29 - 1 if VTAMACB=YES - 1 if SPOOLACB=YES - NATNUMSUB.

SERVER-MIN

Operating System Type Default
BS2000 Optional 1
z/VSE Optional 1

Specifies the minimum number of server tasks/subtasks running in Entire System Server. This value is considered by the Dynamic Server Management as minimum capacity for a low workload. For further information, see Dynamic Server Management for Entire System Server in the Section Common Entire System Server Features.

For BS2000, the following rule applies:

1 <= SERVER-MIN  <= 16

SERVER-MIN <= NUMTASK <= SERVER-MAX

SERVER-NONACT

Operating System Type Default
BS2000 Optional 10
z/VSE Optional 10

Server non-activity time (in minutes). This value is considered by the Dynamic Server Management only. If a server has not been dispatched during this time interval, and no active request is assigned to that server, and SERVER-MIN is lower than the number of servers currently active, this server  will be stopped.

This value must be greater than zero.

For further information, see Dynamic Server Management for Entire System Server in the Section Common Entire System Server Features.

SERVER-PER-USER

Operating System Type Default
BS2000 Optional NO

This parameter is used to control the startup of the ESYSERV tasks. Possible options:

Option Explanation
YES Entire System Server (NPR) will enter the job control of the ESYSERV task with the user-ID of the requesting user. The module libraries assigned in the job control have to reside in a pubset accessible by all ESY users and have to be shareable.
NO Entire System Server (NPR) will enter the job control of the ESYSERV task with the same user-ID as the ESYMAIN task. This is the default value.

SERVER-QUEUE-DEPTH

Operating System Type Default
BS2000 Optional 5
z/VSE Optional 5

Server queue depth. This value is considered by the Dynamic Server Management only. If a new request (user command) arrives, and the number of assigned requests to the server with the lowest workload is greater or equal this value, and SERVER-MAX is higher than the number of servers currently active, a new server will be started to handle that request.

This value must be greater than zero.

For further information, see Dynamic Server Management for Entire System Server in the Section Common Entire System Server Features.

Note:
This parameter is not currently used under z/VSE but will be in a future release.

SHUTDOWN-MAX-DELAY

Operating System Type Default
BS2000 Optional 0
z/OS Optional 0
z/VSE Optional 0

Maximum wait time after issuing ESY shutdown until a smooth stop of running Natural subtasks (in seconds) occurs. This value is considered only if Natural subtasks are running at shutdown time.

If Entire Operations (EOR) or Entire Output Management (EOM) are installed, it is recommended to set this parameter to 90.

This value must not be greater than 600 seconds.

For more information about Natural subtasks, see Aspects of Running System Automation Tools in Entire System Server on BS2000 in the Section BS2000 Considerations.

SMFREC

Operating System Type Default
z/OS Optional 0

The record type of the SMF record to be written when a user logs off. This record contains the number of I/O operations performed, and the amount of CPU consumed by the user. See also z/OS Accounting in the Section z/OS Considerationss. Possible options:

Option Explanation
type Record type of the SMF record to be written when a user logs off.
0 No SMF records are written.

SMFTIME

Operating System Type Default
z/OS, z/VSE Optional 2

Value is in minutes. Under z/OS, controls the interval in which SMF records are written. Under z/VSE, controls the interval in which the Dynamic Server Management checks for server non-activity.

SMTP-HOST

Operating System Type Default Maximum Value Length
z/OS, z/VSE Optional There is no default. 63 bytes
BS2000 Optional There is no default. 120 bytes

Specifies the host name used as mail gateway. This is a DNS name. SEND-EMAIL view cannot work without specifying a valid value for this startup parameter. Contact your mail administrator to determine this host name.

For more information about E-Mail administration, see Run E-Mail Client in Common Entire System Server Features in the Entire System Server Administration documentation.

SMTP-PORT

Operating System Type Default
z/OS, z/VSE, BS2000 Optional 25

The SMTP port number used on the mail gateway. SEND-EMAIL view cannot work without specifying a valid value for this startup parameter. Contact your mail administrator to determine this port number.

For more information about E-Mail administration, see Run E-Mail Client in Common Entire System Server Features in the Entire System Server Administration documentation.

SPOOL

Operating System Type Default
z/OS, z/VSE Optional NONE
BS2000 Optional BS2

Specifies the spooling system in use. The possible values are:

Option Explanation
NONE No SPOOL interface (default on z/OS, z/VSE)
JES2 z/OS JES2 all versions.
JES3 z/OS JES3 all versions. See also Common JES Interface for z/OS in the Section z/OS Considerations.
POWR POWER (z/VSE only)
BS2 BS2000 Spool (BS2000 only)

SPOOLACB

Operating System Type Default
z/OS, z/VSE Optional NONE

This parameter must be set if you are using Entire Output Management and want to print from Entire Output Management to a VTAM printer.

Possible options:

Option Explanation
name Name of the VTAMACB.
NONE The Entire Output Management printing facility is not activated

STDUSER

Operating System Type Default
z/OS, z/VSE, BS2000 Optional There is no default.

System Server who are calling from a non-mainframe Natural (VMS, UNIX, Windows, OS/2).

SUBSYS

Operating System Type Default
z/OS, z/VSE Optional There is no default.

This parameter is used internally and specifies the name of any subsystem. For the value of name, see the installation instructions of the relevant subsystem.

SWAP

Operating System Type Default
z/OS Optional NO

Specifies whether Entire System Server address space is swappable. The default value (NO) is recommended. Possible options:

Option Explanation
YES Address space is swappable.
NO Address space is marked non-swappable during initialization.

SYNCDB

Operating System Type Default
z/OS, z/VSE, BS2000 Optional None (no synchronization)

This parameter synchronizes the start of Entire System Server with databases. You can specify the DBIDs of databases, which must be ready if you want to start Entire System Server. This is important for products such as NOP, NOM, NCL . n, m, ..., k are DBIDs. If the database not ready, there is a wait of nnn seconds to synchronize start. See also description of startup parameter SYNCTIME, below.

SYNCTIME

Operating System Type Default
z/OS, z/VSE, BS2000 Optional 0

If you have specified DBIDs with the parameter SYNCDB, the parameter SYNCTIME gives the time in seconds to wait between synchronization retries. If the fifth retry still does not succeed, Entire System Server comes down. If SYNCDB=NONE, SYNCTIME parameter is ignored. See also description of startup parameter SYNCDB, above.

SYSTEM-COMMAND-USER

Operating System Type Default Maximum Value Length
BS2000 Optional There is no default. 160 bytes

This parameter specifies a list of user IDs authorized to use view SYSTEM-COMMAND.

User exit USERSSEC is called during execution of view SYSTEM-COMMAND only if parameter SYSTEM-COMMAND-USER was NOT specified. Otherwise, USERSSEC is ignored.

Possible options:

Option Explanation
userID1[,userID2[,userIDn]] List of authorized user IDs.
NONE No userID is authorized.

SYSTEMCONS

Operating System Type Default
z/OS Optional NONE

This parameter indicates the system names where Entire System Server should collect console messages (for example, SYSTEMCONS=DAEF, DA2F, ABCD). In this case, we collect console messages from the 3 systems indicated.

The default value NONE means that no z/OS System limitation has been provided.

In other words, if you are running in a Sysplex environment, Entire System Server will read all messages from all z/OS consoles defined in the Sysplex. This may lead to an unwanted CPU power consumption if other products are producing much output on the related consoles.

Therefore we recommend to carefully check which console messages your programs want to see by using view CONSOLE. and to set this parameter to the system ID of your locals z/OS, if you only want to read the console messages from your local z/OS.

TAPES

Operating System Type Default
z/OS, z/VSE, BS2000 Optional NO

Specifies whether your site allows access to mounted tapes from any Natural session.

Option Explanation
YES Access to mounted tapes allowed.
NO Access to mounted tapes not allowed.

TCP-STACK

Operating System Type Default Maximum Value Length
z/OS, z/VSE Optional There is no default. 8 bytes

This parameter specifies the name of the started task or job in which the TCP/IP protocol stack is running. SEND-EMAIL view cannot work without specifying a valid value for this startup parameter. Contact your network administrator to determine this name.

Note for z/OS:
If an invalid value has been specified as TCP-STACK, the SEND-EMAIL requests produce error message ESY5897 Mailer response: errno 1011 in EZASMI INITAPI as ERROR-TEXT reporting errno 1011 (EIBMBADTCPNAME).

Note for z/VSE:

  • The parameter TCP-STACK is supported at version 4.2 or above. It is ignored in earlier versions.

  • The parameter must contain the ID of the corresponding stack, that is you need to set TCP-STACK = SOCKETnn, where nn is the ID of the VSE TCP stack.

For more information about E-Mail administration, see Run E-Mail Client in Common Entire System Server Features in the Entire System Server Administration documentation.

TEMPUNIT

Operating System Type Default
z/OS Optional VIO

The unit name to be used when an Entire System Server request for allocation of a temporary data set is made (for example, SYSDA).

TIME

Operating System Type Default
z/OS, z/VSE, BS2000 Optional 30

Timeout value for Entire System Server calls in seconds. This parameter is used to prevent a command queue element and attached buffer from being held for a long period for a user who has terminated abnormally.

This parameter is the equivalent to the Adabas CT parameter.

TRACE

Operating System Type Default
BS2000, z/OS, z/VSE Optional PREP

Specifies how to set up the TRACE environment.

Option Explanation
NO TRACE environment is completely deactivated.
PREP TRACE environment will be initialized, but not started yet.
YES TRACE environment will be activated at ESY startup.

If the YES or PREP option is specified, the TRACE activity can be manipulated via operator command to start or stop traces dynamically.

For further information, see Creating Trace Data in the Entire System Server in the Section Common Entire System Server Features.

TRACE-LEN

Operating System Type Default
BS2000, z/OS, z/VSE Optional 8

Specifies the size of the trace memory pool (in Kbytes). This value is considered only if TRACE=YES or TRACE=PREP has been defined.

For further information, see Creating Trace Data in the Entire System Server in the Section Common Entire System Server Features.

TRACE-SAV

Operating System Type Default
BS2000, z/OS, z/VSE Optional YES

TRACE-SAV controls the trace save routine at exit.

Option Explanation
YES Trace data buffers will be saved.
NO Trace data buffers will not be saved.

For further information, see Creating Trace Data in the Entire System Server in the Section Common Entire System Server Features.

VIEWSEC

Operating System Type Default
BS2000 Optional NONE

The name of the view security exit to limit usage of views to a list of user IDs. A sample exit named USERVSEC is supplied as source member on the installation tape. Possible options:

Option Explanation
name Name of the view security exit. Example exit USERVSEC must be modified to solve the security considerations at your site.
NONE Default. View security exit is not activated.

VSAMLABELS

Operating System Type Default
z/VSE Optional YES

This parameter controls processing of VSAM files at Entire System Server initialization time in combination with the parameter NUMLIBS.

VTAMACB

Operating System Type Default
z/OS, z/VSE Optional NONE

The name of the VTAM application to be used for the VTAM operator interface as it appears in the ACBNAME parameter in the VTAM APPL statement.

Possible options:

Option Explanation
name Name of the VTAM application in the ACBNAME parameter.
NONE The VTAM interface is not activated.

VTAMQLEN

Operating System Type Default
z/OS, z/VSE Optional 100

The maximum size (in Kbytes) of the in-core queue for pending VTAM messages. If this queue size is exceeded, the oldest half of the queue is deleted.

Option Explanation
L CA-Librarian
M LMS
P CA-Panvalet