CATALOG-UPDATE

#### Search Results

Search

# CATALOG-UPDATE

File | 10
Op-Sys | z/OS, 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 | `PROCESS`
Task | Perform catalog maintenance functions.

## 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 |  |  |
`DSNAME` | A54 |  | D | Required.

## Additional Fields Supported for z/OS

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`VOLUMES` | A240 |  | D |
`DEVICE` | A8 |  | D |
`FILE-SEQUENCE` | N3 |  | D |
`FUNCTION` | A8 |  | D | Required.

## Additional Fields Supported for BS2000

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`SYSTEM-CODE` | B2 |  |  |
`SHARE` | A3 |  | D |
`BACKUP-TYPE` | A1 |  | D |
`ACCESS-TYPE` | A5 |  | D |
`READ-PASSWORD` | A8 |  | D |
`WRITE-PASSWORD` | A8 |  | D |
`EXECUTION-PASSWORD` | A8 |  | D |
`AUDIT-TYPE` | A4 |  | D |
`RETPD` | N4 |  | D |
`ARCHIVE-OPTION` | A1 |  | D |
`DESTROY` | A3 |  | D |
`FGG-BASE` | B2 |  | D |
`FGG-GENERATIONS` | B2 |  | D |
`FGG-DISPOSITION` | A8 |  | D |
`PASSWORD` | A8 |  | D |
`NUM-OF-BACKUP-VERS` | N3 |  | D |

## Relevant Error Codes

Code | Text | z/OS | BS2000
--- | --- | --- | ---
530 | Access denied by Security Facility. |  | X
531 | Password missing or incorrect. |  | X
565 | Syntax error in dataset name. |  | X
571 | `DSNAME` operand missing. | X |
600 | Unknown operation. | X |
602 | Device is invalid. | X |
603 | Index/Alias missing. | X |
604 | No volumes specified. | X |
658 | Dataset is not catalogued. | X |
701 | `DSNAME` missing. |  | X
722 | Requested dataset not found. |  | X
733 | User ID does not exist. |  | X
750 | Invalid operand within operand list. |  | X
798 | Task was not started under TSOS. |  | X
799 | Entire System Server internal error. |  | X

## Field Descriptions

Field Name | Format/Length | Operating System
--- | --- | ---
`ACCESS-TYPE` | (A5) | BS2000

Specifies authorized access type. Possible options:

Option | Explanation
--- | ---
`READ` | Read-only access is authorized.
`WRITE` | Read and write accces is authorized.

Field Name | Format/Length | Operating System
--- | --- | ---
`ARCHIVE-OPTION` | (A1) | BS2000

Specifies the `ARCHIVE` options:

Option | Explanation
--- | ---
`L` | Long. This is the default. The whole file is saved.
`S` | Short. Only changed PAM blocks are saved.

Field Name | Format/Length | Operating System
--- | --- | ---
`AUDIT-TYPE` | (A4) | BS2000

Fixes the level of control of file access. Possible values:

Value | Explanation
--- | ---
`NONE` | Default. No accesses are monitored.
`ALL` | All accesses are monitored.
`FAIL` | Unsuccessful accesses are monitored.
`SUCC` | Successful accesses are monitored.

Field Name | Format/Length | Operating System
--- | --- | ---
`BACKUP-TYPE` | (A1) | BS2000

Specifies when a file is saved by `ARCHIVE`. Possible options:

Option | Explanation
--- | ---
`A` | Default. File is saved with every `ARCHIVE` run.
`B` | Saved with run for Level B, C and D.
`C` | Saved with runs for Level C and D.
`D` | Saved with runs for Level D.
`E` | Not automatically saved.

Field Name | Format/Length | Operating System
--- | --- | ---
`DESTROY` | (A3 | BS2000

Possible options:

Option | Explanation
--- | ---
`NO` | Default. The file is not automatically destroyed when erased.
`YES` | Space used for file is written with `X'00'` when the file is erased.

Field Name | Format/Length | Operating System
--- | --- | ---
`DEVICE` | (A8) | z/OS

Device code, for example, `3400-3`. For BS2000, this only applies to file generation groups (see the `STATE` field).

Field Name | Format/Length | Operating System
--- | --- | ---
`DSNAME` | (A54) | z/OS, BS2000

Fully qualified dataset name. BS2000: fully qualified file name.

Field Name | Format/Length | Operating System
--- | --- | ---
`EXECUTION-PASSWORD` | (A8) | BS2000

`EXECUTION` password to be defined for the file. Use `*NONE` to reset existing password. See also the `PASSWORD` field.

Field Name | Format/Length | Operating System
--- | --- | ---
`FGG-BASE` | (B2) | BS2000

File generation groups only: base for relative access to files of `FGG`.

Field Name | Format/Length | Operating System
--- | --- | ---
`FGG-DISPOSITION` | (A8) | BS2000

File generation groups only: describes what to do, if maximum number of generations is reached. Possible values:

Value | Explanation
--- | ---
`CYCLE` | (Default)
`DELETE` |
`KEEP` |
`REUSE` |

Field Name | Format/Length | Operating System
--- | --- | ---
`FGG-GENERATIONS` | (B2) | BS2000

File generation groups only: number of generations.

Field Name | Format/Length | Operating System
--- | --- | ---
`FILE-SEQUENCE` | (N3) | z/OS

Used for tape files. This value is used for the first volume only.

Field Name | Format/Length | Operating System
--- | --- | ---
`FUNCTION` | (A8) | z/OS

Function to be performed. Possible values:

Value | Explanation
--- | ---
`CATLG` | Catalog new entry.
`RECATLG` | Recatalog an existing entry.
`UNCATLG` | Remove a catalog entry.

Field Name | Format/Length | Operating System
--- | --- | ---
`PASSWORD` | (A8) | BS2000

If the file is already password-protected, the actual password needed for write access must be specified here.

Field Name | Format/Length | Operating System
--- | --- | ---
`READ-PASSWORD` | (A8) | BS2000

`READ` password (4 bytes) to be defined for the file. Use `*NONE` to reset existing password. See also the `PASSWORD` field.

Field Name | Format/Length | Operating System
--- | --- | ---
`RETPD` | (N4) | BS2000

Number of days the file must remain unchanged. Default is `0`.

Field Name | Format/Length | Operating System
--- | --- | ---
`SHARE` | (A3) | BS2000

Specifies whether other users can access files. Possible options:

Option | Explanation
--- | ---
`NO` | Other users are not authorized.
`YES` | Other users are authorized.

Field Name | Format/Length | Operating System
--- | --- | ---
`VOLUMES` | (A240) | z/OS

Volume list. The maximum is 40 entries of 6 bytes each.

Field Name | Format/Length | Operating System
--- | --- | ---
`WRITE-PASSWORD` | (A8) | BS2000

`WRITE` password to be defined for the file. Use `*NONE` to reset existing password. See also the `PASSWORD` field.

Field Name | Format/Length | Operating System
--- | --- | ---
`NUM-OF-BACKUP-VERS` | (N3) | BS2000

Number of versions of a file saved in a backup archive.

### On this page

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