This section gives a detailed description of every view available through Entire Systems Management Adapter. 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).
Alphabetical List of Specific View Descriptions:
| ACTIVE-JOBS | ARCHIVE | CATALOG | CATALOG-UPDATE |
| COMMON-DATA | CONSOLE | COPY-FILE | ENTER-PROCEDURE |
| EVENTING | FILE-ALLOCATE | FILE-ATTRIBUTES | FILE-MAINTENANCE |
| HELP-INFO | JOB-SWITCHES | JOB-VARIABLES | LIB-DIRECTORY |
| LIB-UPDATE | MAIN-STORAGE | NATPROC-LOGON | NATPROC-USERS |
| PRINT-DOCUMENT | READ-FILE | SEND-EMAIL | SEND-MESSAGE |
| SPOOL-FILES | SPOOL-QUEUE | SUBMIT | SYSTEM-COMMAND |
| SYSTEM-INFO | TASK-INFO | USER-ATTRIBUTES | VTOC |
| VTOC-UPDATE | WRITE-FILE | WRITE-SPOOL |
This document covers the following topics:
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 Systems Management Adapter. This number must not be changed. |
| 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). |
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. | |
| D | Descriptor.
D in this column means that this field name can be
specified in the |
|
| Remarks | General remarks concerning the field, for example, whether it is required, or whether it is dependent on a particular function. | |
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. The global fields are:
| Field Name | Type/Length |
|---|---|
ERROR-CODE
|
(N3) |
Message code returned. For the meaning of message codes, see the Entire Systems Management Adapter Messages and Codes documentation.
| Field Name | Type/Length |
|---|---|
ERROR-TEXT
|
(A58) |
Message text. For the meaning of message, see the Entire Systems Management Adapter Messages and Codes documentation. .
| Field Name | Type/Length |
|---|---|
NODE
|
(N5) |
Number of the Entire Systems Management Adapter node to be addressed. This number is mapped to a host and a port. See also Enable mapping of NODE ID’s to host names and port numbers.
| Field Name | Type/Length |
|---|---|
SYSTEM-CODE
|
(B2) |
Original system error code.
| 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 Systems Management Adapter 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.
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
LIB-DIRECTORY
READ-FILE
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.