Store user alias catalog entries in file
Component: | ACS |
Functional area: | File processing |
Domain: | FILE |
Privileges: | STD-PROCESSING |
Function
The STORE-ALIAS-CATALOG command stores the user entries of the current alias catalog in an AC file. These stored user entries can be reloaded into the alias catalog by the user with the LOAD-ALIAS-CATALOG command.
The actual file name of the AC file must be specified by the user, since neither alias substitution nor prefix insertion is performed in this case.
Privileged functions
The privileged ACS administration can choose whether to store the system entries from its alias catalog, or the user entries, or all entries (SELECT operand). When each entry is saved, its type (USER or SYSTEM) is included with the copy. If the ACS administration then reloads the catalog entries, using LOAD-ALIAS-CATALOG, they retain their original type.
Format
STORE-ALIAS-CATALOG | Alias: STAC |
TO-FILE = <filename 1..54 without-gen-vers> ,USER-INFORMATION = *NONE / <name 1..8> ,DESCRIPTOR = *NONE / <alphanum-name 1..8> ,SELECT = *USER-ENTRIES / *ALL / *SYSTEM-ENTRIES | |
Operands
TO-FILE = <filename 1..54 without-gen-vers>
Actual name of the AC file in which the user entries of the current alias catalog are to be stored. If the specified file does not exist, a new file is created; otherwise, the existing file is overwritten, provided write access is permitted for it. AC files are created as SAM files.
USER-INFORMATION = *NONE / <name 1..8>
Enters a name into the AC file for documentation purposes. The name specified by the user here is displayed in the output of the SHOW-ACS-OPTIONS command and in the ACS0001 load message that is displayed after an AC file is loaded with the LOAD-ALIAS-CATALOG command.
USER-INFORMATION = *NONE
No name is defined.
USER-INFORMATION = <name 1..8>
Name to be entered into the AC file.
DESCRIPTOR = *NONE / <alphanum-name 1..8>
Allows the user to enter an additional descriptor into the AC file for documentation purposes; for example, a version ID to identify the current update. This descriptor is displayed along with the name specified for USER-INFORMATION in the output of the SHOW-ACS-OPTIONS command and in the load message that is issued after an AC file is loaded with the LOAD-ALIAS-CATALOG command.
DESCRIPTOR = *NONE
No descriptor is defined.
DESCRIPTOR = <alphanum-name 1..8>
Additional information (descriptor) to be entered into the AC file.
SELECT = *USER-ENTRIES / *SYSTEM-ENTRIES / *ALL
Only available to users with ACS-ADMINISTRATION privilege.
Specifies which entries from the administration’s current alias catalog are to be stored.
SELECT = *USER-ENTRIES
The only entries to be stored in the file specified by the TO-FILE operand are the user entries (type USER).
SELECT = *SYSTEM-ENTRIES
The only entries to be stored in the file specified by the TO-FILE operand are the system entries (type SYSTEM).
SELECT = *ALL
All the entries in the current catalog are to be stored in the file specified by the TO-FILE operand.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command executed normally | |
2 | 0 | ACS0006 | Warning: AC entries not found |
32 | CMD0221 | Internal error | |
64 | ACS0011 | Error when accessing file | |
64 | ACS0017 | Error: alias catalog is not active | |
128 | ACS0018 | ACS is not available |
Examples
For examples, see the ADD-ALIAS-CATALOG-ENTRY and LOAD-ALIAS-CATALOG commands.