View Descriptions

This section gives a detailed description of every view available through Entire System Server. The section is structured as follows:

  • The selection box below lists all view descriptions in alphabetical order. Each view description subsection gives a full description of the view, listing first all field names according to operating system. An overview of error messages relevant to the view is given, followed by a detailed description of each field in alphabetical order.

  • The subsection General Information  explains how the description of each view is organized, and describes global fields (that is, fields relevant to each view).

  • The subsection View Summary provides an overview of available views, listing them according to their functional area.

Alphabetical List of Specific View Descriptions

ACCOUNTING ACTIVE-JOBS ADDRESS-SPACE ALLOCATIONS
ARCHIVE AUTHORIZED-LIBRARIES CATALOG CATALOG-UPDATE
CHECK-SECURITY COMMON-DATA CONSOLE CONSOLE-LOG
COPY-FILE DEVICE-NAMES ENTER-PROCEDURE EVENTING
FILE-ALLOCATE FILE-ATTRIBUTES FILE-MAINTENANCE HELP-INFO
IDCAMS IEBCOPY ITC JOB-SWITCHES
JOB-VARIABLES LIB-DIRECTORY LIB-UPDATE LIB-ZAP
LOADED-MODULES LOAD-MODULE MAIN-STORAGE NATPROC-LOGON
NATPROC-USERS NET-OPER PRINT-DOCUMENT READ-FILE
READ-SPOOL RECEIVE-EMAIL RESOURCE-CONTROL SEND-EMAIL
SEND-MESSAGE SPOOL-FILES SPOOL-QUEUE SPOOL-UPDATE
SUBMIT SYSTEM-COMMAND SYSTEM-INFO TASK-INFO
TCB UNIT-ATTRIBUTES USER-ATTRIBUTES VTOC
VTOC-UPDATE WRITE-FILE WRITE-SPOOL

This document covers the following topics:

General Information

The description of each view in this section begins with a header subsection containing the following general information about the view:

Item Meaning
File   The file number assigned to the view within Entire System Server. This number must not be changed.
Opsys  Operating system(s) to which the view applies.
Statement  The statement you must use in your Natural programs to access the view. This is either FIND or PROCESS, depending on the view and the required function.
Task  A short description of the purpose of the view. This description is based on the online help text provided for each view in the online tutorial (see Online Tutorial).

Note:
The view name may be changed by the Entire System Server Administrator. The file number and access statement cannot be changed.

Example:

You will find this header subsection for the view ACTIVE-JOBS:

Item Meaning
File 29
Opsys  z/OS, z/VSE, BS2000
Statement  FIND
Task Retrieve the tasks that are currently active in the system and get information about them (for example, the amount of CPU time already used by the tasks).

BS2000: corresponds to BS2000 command /sta p: retrieve tasks of Type 2 or 3.

Each view description contains the following information for fields defined to the view:

Item Meaning
Dictionary Field Name The name of the field in Natural.
F/L  Field format and length:
A Alphanumeric
B Binary
D Date
N Numeric
T Time
Mu  For fields that can be specified more than once, this column gives the maximum number of occurrences.
DE  Descriptor.

D in this column means that this field name can be specified in the WITH clause of the FIND statement or the USING clause of the PROCESS statement. These fields support the search criteria available for the FIND statement (see Getting Started) where this is appropriate.

Remarks  General remarks concerning the field, for example, whether it is required, or whether it is dependent on a particular function.

Example:

The following table is the overview of some fields common to all operating systems for the view COPY-FILE:

Dictionary Field Name F/L Mu DE Remarks
Common Fields for all Operating Systems:
ERROR-CODE N3      
ERROR-TEXT A58      
NODE N3   D  
NODE-NAME A16   D  
SYSTEM-MESSAGE-CODE A10      
FROM-DSNAME A54   D Required
FROM-PRODUCT A1   D  
FROM-PASSWORD A8   D  
TO-DSNAME A54   D Required

Global Fields

Certain fields are common to all views. These are known as global fields and do not appear in the full description of each field in this section (though they are included in the field overview for each view). The global fields are:

Field Name Type/Length Operating System
ERROR-CODE (N3) z/OS, z/VSE, BS2000

Message code returned. For the meaning of message codes, see the Entire System Server Messages and Codes documentation.

Field Name Type/Length Operating System
ERROR-TEXT (A58) z/OS, z/VSE, BS2000

Message text. For the meaning of message, see the Entire System Server Messages and Codes documentation. .

Field Name Type/Length Operating System
NODE (N3) z/OS, z/VSE, BS2000

Number of the Entire System Server node to be addressed. Typically, the node number is required if you are working in a distributed environment and you wish to perform a function on a different computer in the network (see also Using the Entire System Server in the Entire System Server Installation and Customization documentation).

Field Name Type/Length Operating System
NODE-NAME (A16) z/OS, z/VSE, BS2000

Name of the Entire System Server node to be addressed. This field is optional. For further information, see Using Entire System Server in a Multi-Computer Environment in the section Getting Started.

Field Name Type/Length Operating System
SYSTEM-CODE (B2) BS2000

Original system error code.

Field Name Type/Length Operating System
SYSTEM-MESSAGE-CODE (A10) BS2000, z/OS, z/VSE

System error code specific to the operating system. A code returned in the ERROR-CODE field can translate to any of a number of operating-system-specific system codes.

If any call to Entire System Server gets an error code of 508 with the error text ESY5508 ADABAS response code :1: returned from ESY, then the field SYSTEM-MESSAGE-CODE is filled with the appropriate Adabas response code in the form ADAnnn, where nnn is the Adabas response code.

Global Error Codes

Certain error codes may be returned with any view. These are known as Global Error Codes. Each view description in this section contains a table with possible error codes relevant to the view. The table below contains a list of global error codes. A full explanation of error codes is given in the Entire System Server Messages and Codes documentation.

Code Text z/OS z/VSE BS2000
0 Request completed successfully X X X
507 Too many parallel ESY requests. X X X
508 Adabas response code xxx returned from ESY. X X X
510 Logon required. X X X
520 No core available (ASIZE). X X X
521 NATPNI/NATPNIP unresolved. X X X
530 Access denied by Security Facility.     X*
774 No core available. X X X
776 Request was cancelled. X X X
777 Request has abended. X X X
999 Entire System Server node nnn not active. X X X

*

Note:
In BS2000, if error code 799 (Entire System Server internal error) is returned, check the field SYSTEM-MESSAGE-CODE for additional information.

Order of Information returned by Views

Unless otherwise noted, the default return order of information returned by view processors accessed by FIND (but not FIND (1) for reading views) is not guaranteed to be in any specific order. The views that have a guarantee of default order are:

  • CONSOLE

  • CONSOLE-LOG

  • IDCAMS

  • IEBCOPY

  • LIB-DIRECTORY

  • LIB-ZAP

  • NET-OPER

  • READ-FILE

  • READ-SPOOL

  • SYSTEM-COMMAND

More information regarding a specific order of returned information can be found in the appropriate view description.

If information needs to be returned in a specific order, the Natural SORT statement can be used. See the Natural Statements manual for more information.

All views accessed by PROCESS or FIND (1) (update views) will deliver data in the order received by the program.

View Summary

This subsection summarizes Entire System Server views according to their functional area. Together with the view name, the operating systems to which the view applies is given. The third column gives a short description of the view's function.

File and Catalog Management

View Name Supported Operating Systems Description File No.
ARCHIVE BS2000 Run ARCHIVE utility. 211
CATALOG z/OS, z/VSE, BS2000 List catalog information. 8
CATALOG-UPDATE z/OS, BS2000 Perform catalog maintenance.

Under BS2000: modify file attributes.

10
COPY-FILE z/OS, z/VSE, BS2000 Copy files.

Under z/OS and z/VSE, copying can be performed from node to node.

37
FILE-ALLOCATE z/OS, z/VSE, BS2000 Allocate dataset to disk. 9
FILE-ATTRIBUTES z/OS, z/VSE, BS2000 Display attributes of a dataset. 1
FILE-MAINTENANCE z/OS, BS2000 Compress dataset or release unused space. 18
IDCAMS z/OS Run IDCAMS utility. 14
IEBCOPY z/OS Run IEBCOPY utility. 17
LIB-DIRECTORY z/OS, z/VSE, BS2000 Read directory entries. 3
LIB-UPDATE z/OS, z/VSE, BS2000 Perform operations on directory. 5
READ-FILE z/OS, z/VSE, BS2000 Read records from a dataset. 2
UNIT-ATTRIBUTES z/OS, z/VSE Read information on I/O units. 6
VTOC z/OS, z/VSE, BS2000 Read VTOC entries for a volume. 4
VTOC-UPDATE z/OS, z/VSE, BS2000 Maintain VTOC entries.

Under BS2000: erase or rename file.

7
WRITE-FILE z/OS, z/VSE, BS2000 Write records to a dataset. 204

Spool / Job Management

View Name Supported Operating Systems Description File No.
ACTIVE-JOBS z/OS, z/VSE, BS2000 Read information on active jobs. 29
JOB-SWITCHES BS2000 Perform operations on user and process switches. 81
JOB-VARIABLES BS2000 Perform operations on job variables. 82
READ-SPOOL z/OS, z/VSE Read spool records for a job. 12
SPOOL-FILES z/OS, BS2000 Read and maintain spool files for a given job. 36
SPOOL-QUEUE z/OS, z/VSE, BS2000 Read entire spool queue.

Under BS2000: Read all jobs in any system queue.

11
SPOOL-UPDATE z/OS, z/VSE Change status of job. 13
SUBMIT z/OS, z/VSE, BS2000 Submit job. 200
TASK-INFO BS2000 Read information for a task. 113
WRITE-SPOOL z/OS, z/VSE, BS2000 Write records to spool.

Under BS2000: Print records or dataset.

203

System Maintenance

View Name Supported Operating Systems Description File No.
ACCOUNTING z/OS Read accounting information. 34
ADDRESS-SPACE z/OS Read address space information. 21
ALLOCATIONS z/OS Read allocations for a job. 22
CONSOLE z/OS, z/VSE, BS2000 Perform operations on operator console. 35
CONSOLE-LOG z/OS, z/VSE Read console log. 25
DEVICE-NAMES z/OS Read generic device names. 30
LIB-ZAP z/OS Run superzap utility (AMASPZAP). 16
LOADED-MODULES z/OS Read modules loaded by a job. 23
MAIN-STORAGE z/OS, z/VSE, BS2000 z/OS: Read main storage content for a job. 20
z/VSE : Read storage of the ADDRESS-SPACE in which the Entire System Server partition is defined.
BS2000: Read content of common memory pool.
NET-OPER z/OS, z/VSE Execute VTAM operator commands and display results. 15
SYSTEM-INFO z/OS, z/VSE, BS2000 Read system information. 26
TCB z/OS Read task information for a job. 24
USER-ATTRIBUTES BS2000 Read user information. 86

Miscellaneous

View Name Supported Operating Systems Description File No.
COMMON-DATA z/OS, z/VSE, BS2000 Perform operations on shared main storage data. 33
CHECK-SECURITY z/OS Query external security system as to whether user is allowed to access resource. 45
EVENTING z/OS, z/VSE, BS2000 Perform program-to-program communication. 40
HELP-INFO BS2000 Display help text for an error message. 84
ITC BS2000 Execute INTERTASK COMMUNICATION macros. 80
LOAD-MODULE z/OS Read information on load module. 44
NATPROC-LOGON z/OS, z/VSE, BS2000 Perform logon/logoff to Entire System Server. 190
NATPROC-USERS z/OS, z/VSE, BS2000 Read Entire System Server users currently active and optionally cancel users. 191
RESOURCE-CONTROL z/OS Manage resources using ENQ/DEQ. 32
SEND-MESSAGE z/OS, z/VSE, BS2000 Send message to console and/or Com-plete, TSO or TIAM user. 19
SYSTEM-COMMAND z/OS Execute TSO commands. 46