View Descriptions

#### Search Results

Search

# 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` | `READ-UNIX-FILE` | `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`
`UNIX-DIRECTORY` | `VTOC` | `VTOC-UPDATE` | `WRITE-FILE`
`WRITE-SPOOL` | `WRITE-UNIX-FILE` |  |

This document covers the following topics:

- General Information

- View Summary

## General Information

- Global Fields

- Global Error Codes

- Order of Information returned by Views

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

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 for view `COPY-FILE`:

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
Fields:
`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` | A32 |  | 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
--- | ---
`ERROR-CODE` | (N3)

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

Field Name | Type/Length
--- | ---
`ERROR-TEXT` | (A58)

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

Field Name | Type/Length
--- | ---
`NODE` | (N3)

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
--- | ---
`NODE-NAME` | (A16)

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
--- | ---
`SYSTEM-MESSAGE-CODE` | (A10)

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
--- | ---
0 | Request completed successfully
507 | Too many parallel ESY requests.
508 | Adabas response code xxx returned from ESY.
510 | Logon required.
520 | No core available (`ASIZE`).
521 | `NATPNI/NATPNIP` unresolved.
774 | No core available.
776 | Request was cancelled.
777 | Request has abended.
999 | Entire System Server node nnn not active.

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

- File and Catalog Management

- Spool / Job Management

- System Maintenance

- Miscellaneous

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 | Description | File No.
--- | --- | ---
`CATALOG` | List catalog information. | 8
`CATALOG-UPDATE` | Perform catalog maintenance. | 10
`COPY-FILE` | Copy files. Copying can be performed from node to node. | 37
`FILE-ALLOCATE` | Allocate dataset to disk. | 9
`FILE-ATTRIBUTES` | Display attributes of a dataset. | 1
`FILE-MAINTENANCE` | Compress dataset or release unused space. | 18
`IDCAMS` | Run `IDCAMS` utility. | 14
`IEBCOPY` | Run `IEBCOPY` utility. | 17
`LIB-DIRECTORY` | Read directory entries. | 3
`LIB-UPDATE` | Perform operations on directory. | 5
`LOAD-MODULE` | Read information on load module. | 44
`READ-FILE` | Read records from a dataset. | 2
`READ-UNIX-FILE` | This view makes it possible to read data from files in the z/OS UNIX file system. | 96
`UNIT-ATTRIBUTES` | Read information on I/O units. | 6
`UNIX-DIRECTORY` | This view makes it possible to display directory information related to a z/OS UNIX file system. | 97
`VTOC` | Read VTOC entries for a volume. | 4
`VTOC-UPDATE` | Maintain VTOC entries. | 7
`WRITE-FILE` | Write records to a dataset. | 204
`WRITE-UNIX-FILE` | This view makes it possible to write data to files in the z/OS UNIX file system. | 215

### Spool / Job Management

View Name | Description | File No.
--- | --- | ---
`ACTIVE-JOBS` | Read information on active jobs. | 29
`ALLOCATIONS` | Read allocations for a job. | 22
`READ-SPOOL` | Read spool records for a job. | 12
`SPOOL-FILES` | Read and maintain spool files for a given job. | 36
`SPOOL-QUEUE` | Read entire spool queue. | 11
`SPOOL-UPDATE` | Change status of job. | 13
`SUBMIT` | Submit job. | 200
`WRITE-SPOOL` | Write records to spool. | 203

### System Maintenance

View Name | Description | File No.
--- | --- | ---
`ACCOUNTING` | Read accounting information. | 34
`ADDRESS-SPACE` | Read address space information. | 21
`CONSOLE` | Perform operations on operator console. | 35
`CONSOLE-LOG` | Read console log. | 25
`DEVICE-NAMES` | Read generic device names. | 30
`LIB-ZAP` | Run superzap utility (`AMASPZAP`). | 16
`LOADED-MODULES` | Read modules loaded by a job. | 23
`MAIN-STORAGE` | Read main storage content for a job. | 20
`NET-OPER` | Execute VTAM operator commands and display results. | 15
`SYSTEM-INFO` | Read system information. | 26
`TCB` | Read task information for a job. | 24

### Miscellaneous

View Name | Description | File No.
--- | --- | ---
`AUTHORIZED-LIBRARIES` | Display a list of APF authorized data sets. | 50
`COMMON-DATA` | Perform operations on shared main storage data. | 33
`CHECK-SECURITY` | Query external security system as to whether user is allowed to access resource. | 45
`EVENTING` | Perform program-to-program communication. | 40
`NATPROC-LOGON` | Perform logon/logoff to Entire System Server. | 190
`NATPROC-USERS` | Read Entire System Server users currently active and optionally cancel users. | 191
`RECEIVE-EMAIL` | This view provides the support for receiving e-mails using IMAP protocol | 70
`RESOURCE-CONTROL` | Manage resources using ENQ/DEQ. | 32
`SEND-EMAIL` | This view provides the support for sending electronic mails. | 212
`SEND-MESSAGE` | Send message to console and/or Com-plete, TSO or TIAM user. | 19
`SYSTEM-COMMAND` | Execute TSO commands. | 46

### On this page

- General Information
- View Summary