NATPROC-USERS

#### Search Results

Search

# NATPROC-USERS

File | 191
Op-Sys | z/OS, z/VSE, BS2000 Note Support for z/VSE is deprecated. Support for BS2000 is also deprecated, except in conjunction with the ESM adapter. Features that are z/VSE and BS2000 specific will be removed from future releases.
Statement | `FIND` / `PROCESS`
Task | Retrieve information about Entire System Server users and enable a user to be cancelled from the Entire System Server.

## Common Fields for all Operating Systems

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`ERROR-CODE` | N3 |  |  |
`ERROR-TEXT` | A58 |  |  |
`NODE` | N5 |  | D |
`NODE-NAME` | A16 |  | D |
`SYSTEM-MESSAGE-CODE` | A10 |  |  |
`USER-ID` | A8 |  | D |
`ADABAS-ID` | B4 |  | D |
`NATPROC-ID` | A10 |  | D |
`LAST-ACTIVITY` | N5 |  | D |
`CPU` | N5.2 |  | D |
`IO-COUNT` | N7 |  | D |
`ADABAS-EXTENDED-ID` | B28 |  | D |
`FULL-SCAN` | A3 |  | D |
`INTERNAL-TASK` | A3 |  | D |
`TASK-ID` | A16 |  | D |
`FUNCTION` | A8 |  | D |

## Additional Fields Supported for z/OS

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`ORIGIN-JOBNAME` | A8 |  | D |
`TCB-ADDRESS` | B4 |  | D |

## Additional Fields Supported for z/OS, z/VSE

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`CORE-USED` | N7 |  | D |
`CORE-FREE` | N7 |  | D |

## Additional Fields Supported for BS2000

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`JOB-ID` | A8 |  | D |
`SYSTEM-CODE` | B2 |  | D |

## Relevant Error Codes

Code | Text | z/OS | z/VSE | BS2000
--- | --- | --- | --- | ---
600 | Unknown function. | X | X | X
649 | Entire System Server User not found or cannot be cancelled. | X | X | X

## Field Descriptions

Field Name | Type/Length | Operating System
--- | --- | ---
`ADABAS-EXTENDED-ID` | (B28) | z/OS, z/VSE, BS2000

Extended Adabas user ID (28 bytes).

Field Name | Type/Length | Operating System
--- | --- | ---
`ADABAS-ID` | (B4) | z/OS, z/VSE, BS2000

The Adabas user ID.

Field Name | Type/Length | Operating System
--- | --- | ---
`CORE-FREE` | (N7) | z/OS, z/VSE

Amount of free storage in the address space (in Kbytes). This value is only returned for the `MAIN` entry.

Field Name | Type/Length | Operating System
--- | --- | ---
`CORE-USED` | (N7) | z/OS, z/VSE

Amount of storage used by task (in Kbytes).

Field Name | Type/Length | Operating System
--- | --- | ---
`CPU` | (N5.2) | z/OS, z/VSE, BS2000

Amount of CPU consumed (format: `SSSSS.HH`).

Field Name | Type/Length | Operating System
--- | --- | ---
`FUNCTION` | (A8) | z/OS, z/VSE, BS2000

Possible options:

Option | Explanation
--- | ---
`CANCEL` | Cancel user with the specified `NATPROC-ID`.
`LASTERR` | Get last error message.

If no function is specified, a list of Entire System Server users is given.

Field Name | Type/Length | Operating System
--- | --- | ---
`FULL-SCAN` | (A3) | z/OS, z/VSE, BS2000

`FULL-SCAN` is considered for `FUNCTION = ' '` only (display list of ESY users). If `FULL-SCAN` is set to `YES`, all internal Entire System Server tasks are returned additionally. If `NO` or blank is supplied, only ESY users are returned.

Field Name | Type/Length | Operating System
--- | --- | ---
`INTERNAL-TASK` | (A3) | z/OS, z/VSE, BS2000

Possible values:

- `YES` if data of internal ESY task is returned.

- `NO` if data of `NATPROC-USER` is returned.

Field Name | Type/Length | Operating System
--- | --- | ---
`IO-COUNT` | (N7) | z/OS, z/VSE, BS2000

Number of I/O operations so far. Under BS2000, this field always contains zero, if a Natural subtask is returned (see `FULL-SCAN='YES'`).

Field Name | Type/Length | Operating System
--- | --- | ---
`JOB-ID` | (A8) | BS2000

TSN of internal task in alpha format.

Field Name | Type/Length | Operating System
--- | --- | ---
`LAST-ACTIVITY` | (N5) | z/OS, z/VSE, BS2000

Time elapsed since last activity (in seconds). Under BS2000, this field always contains zero, if a Natural subtask is returned (see `FULL-SCAN='YES'`).

Field Name | Type/Length | Operating System
--- | --- | ---
`NATPROC-ID` | (A10) | z/OS, z/VSE, BS2000

The unique internal ID in the Entire System Server.

Value 'Task' is returned for an internal task, value `NAT` for a Natural subtask.

Field Name | Type/Length | Operating System
--- | --- | ---
`ORIGIN-JOBNAME` | (A8) | z/OS

Name of TP system or batch job from which the user calls originate.

Field Name | Type/Length | Operating System
--- | --- | ---
`TASK-ID` | (A16) | z/OS, z/VSE, BS2000

ID of the internal task is returned. This is usually the name of the load module or, if a `NATURAL-SUB-TASK` is returned, the `NAT-USER` data.

For z/VSE internal tasks, the phase name is returned in positions 1-8, and the task number is returned in positions 9-12.

Field Name | Type/Length | Operating System
--- | --- | ---
`TCB-ADDRESS` | (B4) | z/OS

TCB address of the subtask.

Field Name | Type/Length | Operating System
--- | --- | ---
`USER-ID` | (A8) | z/OS, z/VSE, BS2000

Possible values:

Value | Explanation
--- | ---
`userid` | The user ID.
`--------` | The user is not logged on.
`****main` | Entry for the Entire System Server main task.

#### Example:

      FIND NATPROC-USERS WITH NODE     = 199
                         AND FULL-SCAN = 'YES'
                         AND FUNCTION  = ' '
      *
       IF ERROR-CODE EQ 0
        IF #FIRST EQ 1
         WRITE 'LogonID  ESY  Task-ID          TSN   LastAct CPU used'
               'IO count INTERNAL'
         WRITE '________ ____ ________________ _____ _______ ________'
               ' ________ ________'
         ASSIGN #FIRST = 0
        END-IF
      *
        WRITE USER-ID NATPROC-ID TASK-ID JOB-ID LAST-ACTIVITY (NL=6)
              CPU (NL=4.2) IO-COUNT (NL=7) INTERNAL-TASK
      ...

The following output is created:

      LogonID  ESY  Task-ID          TSN   LastAct CPU used IO count INTERNAL
      ________ ____ ________________ _____ _______ ________ ________ ________
      TSOS     TASK ESYCONS          3UG0        6   481.37       51 YES
      TSOS     TASK ESYEVTM          3809        0    65.46       38 YES
      TSOS     TASK ESYMAIN          3807        0   185.95      230 YES
      TSOS     TASK ESYSERV          3808       27   203.93     2783 YES
      TSOS     TASK ESYSERV          381I        0   274.54      621 YES
      TSOS     NAT  NOMXTS0006300038 381E        0    67.31        0 YES
      TSOS     NAT  NOM02S0006300038 381G        0    24.32        0 YES
      TSOS     NAT  NOM03S0006300038 381H        0   162.89        0 YES
      TSOS     0010                             37    15.44        0 NO
      TSOS     0011                             11   241.62      208 NO
      DC1      0017                              0     0.02        0 NO
      WOS      0007                             27   137.48        0 NO

### On this page

- Common Fields for all Operating Systems
- Additional Fields Supported for z/OS
- Additional Fields Supported for z/OS, z/VSE
- Additional Fields Supported for BS2000
- Relevant Error Codes
- Field Descriptions