Load entries from file into alias catalog
Component: | ACS |
Functional area: | File processing |
Domain: | FILE |
Privileges: | STD-PROCESSING |
Function
The LOAD-ALIAS-CATALOG command enables the user to load an alias catalog file (also called an AC file) into the task-local alias catalog. If no alias catalog exists for the task, an alias catalog is created for it automatically the first time an AC file is loaded.
The AC file contains the assignments of aliases to actual file or job variable names. When the alias substitution function is active, ACS substitutes the actual file or job variable name for the aliases that are specified by the user in commands. The alias substitution function has priority over the prefix insertion function and prevents the insertion of prefixes.
The ACS administrator can provide the user with one or more AC system files containing predefined alias definitions for specific software configurations (e.g. compilers, utilities, etc.). The names of the available AC system files can be displayed by means of the SHOW-ACS-SYSTEM-FILES command. The name of the default AC system file is identified by the character “>” in the output of this command.
If desired, the user may also load a personally created AC file containing user-specific alias definitions (see also the STORE-ALIAS-CATALOG command).
The alias catalog that is local to the task can be extended by loading additional AC files (see the MODE=*MERGE operand) or by adding individual alias definitions to it with the ADD-ALIAS-CATALOG-ENTRY command.
Entries in the alias catalog that is local to the task can be displayed by the user with the SHOW-ALIAS-CATALOG-ENTRY command.
The commands HOLD-ALIAS-CATALOG and RESUME-ALIAS-CATALOG can be used to halt and resume alias substitution, respectively.
The user can save the current alias catalog in an AC file by using the STORE-ALIAS-CATALOG command (only the user entries are saved), or delete it with the PURGE-ALIAS-CATALOG command.
The alias catalog is automatically deleted at the end of the task.
Loading errors
Syntactically incorrect or invalid AC entries cannot be loaded into the alias catalog and are not logged, but message ACS0003 is output. Five such errors will cause the load operation to abort.
The existing alias catalog, if any, will be restored to its original state if loading is aborted.
Format
LOAD-ALIAS-CATALOG | Alias: LDAC | ||||||||||||||||||||||||||||||||
|
Operands
ALIAS-CATALOG-ID =*STD / <composed-name 1..20> / *OWN(...)
Names the AC file from which the alias catalog is to be loaded. The user must have execution rights for the AC file.
ALIAS-CATALOG-ID = *STD
The alias catalog is loaded from the default AC system file. This file is identified in the output of the SHOW-AC-SYSTEM-FILES command by the character “>”.
ALIAS-CATALOG-ID = <composed-name 1..20>
Identification of an AC system file. The available AC system files can be determined by the user with the SHOW-AC-SYSTEM-FILES command.
ALIAS-CATALOG-ID = *OWN(...)
The alias catalog is loaded from the AC file that is specified by the user.
FROM-FILE = <filename 1..54 without-gen-vers>
File name of the AC file.
MODE = *MERGE / *REPLACE
Specifies whether the alias catalog to be generated is to overwrite or extend an existing alias catalog.
MODE = *MERGE
The existing alias catalog, if any, is retained, and entries from the specified AC system file or the user-specific AC file are appended to it. Existing entries with the same alias are overwritten.
MODE = *REPLACE
Previous entries in the alias catalog are deleted. The new alias catalog will only have the entries contained in the AC system file or AC file.
SELECT = *ALL-ENTRIES / *BY-ALIAS-NAME(...)
Determines whether all entries in the specified AC system file or AC file are to be loaded into the task-specific alias catalog.
SELECT = *ALL-ENTRIES
All entries are loaded into the alias catalog of the task.
SELECT = *BY-ALIAS-NAME(...)
Only the entries specified in the selection which follows are loaded into the task-local alias catalog. The selection criterion used is the name of the alias.
USER-IDENTIFICATION =
The entries to be loaded are selected on the basis of the user ID that was specified in the alias.
USER-IDENTIFICATION = *ANY
The user ID does not serve as a selection criterion (equivalent to SELECT=*ALL-ENTRIES).
USER-IDENTIFICATION = *OWN
Only the entries which have the user’s own user ID in the alias are loaded.
USER-IDENTIFICATION = *NONE
Only the entries without a user ID in the alias are loaded.
USER-IDENTIFICATION = *DEFAULT-USERID
Only the entries with the system default ID in the alias are loaded. The alias $file is equivalent to $.file if file does not contain a period.
SUCCESS-MSG = *STD / *YES / *NO
Specifies whether a message is to be output after the AC system file or AC file is successfully loaded.
SUCCESS-MSG = *STD
The success message depends on the global settings or the setting which are local to the task (see the MODIFY-ACS-OPTIONS command). The currently applicable settings can be determined from the output of the SHOW-ACS-OPTIONS command.
SUCCESS-MSG = *YES
Message ACS0001 is output after successful loading.
SUCCESS-MSG = *NO
Message ACS0001 is suppressed.
Return codes
(SC2) | SC1 | Maincode | Meaning/Guaranteed messages |
---|---|---|---|
0 | CMD0001 | Command executed normally | |
1 | 0 | CMD0001 | No action (e.g. no default ACSF) |
2 | 0 | ACS0003 | Warning: invalid record in ACF ignored |
32 | CMD0221 | Internal error | |
64 | ACS0004 | Aborted due to invalid records in ACF | |
64 | ACS0011 | Error when accessing file | |
64 | ACS0012 | ACSF not found | |
64 | ACS0029 | Command not permitted | |
128 | ACS0018 | ACS is not available | |
130 | ACS0036 | Resource bottleneck |
Example
Creating the alias catalog and loading entries from the AC file
/add-alias-cat alias=bsp,file=max.file.3 ——————————————————————————————— (1)
% ACS0020 ALIAS CATALOG ACTIVATED
/add-alias-cat alias=max,file=max.file.3 ———————————————————— (2)
/add-alias-cat alias=sf.sdf,file=$tsos.sys.sdf.system.syntax,range=*file — (3)
/show-alias ————————————————————— (4)
% ALIAS FILE NAME -> FILE NAME %UB : BSP -> MAX.FILE.3 %UB : MAX -> MAX.FILE.3 %UF : SF.SDF -> $TSOS.SYS.SDF.SYSTEM.SYNTAX % ACS0037 NUMBER OF ALIAS CATALOG ENTRIES: 3 (FOR SYSTEM: 0, FOR USER: 3)
/load-alias-cat alias-cat=*own(acs.a1),mode=*replace———————————————————— (5)
% ACS0001 ALIAS CATALOG 'USER1AC' LOADED (DESCRIPTOR='V0001A', DATE=2014-02-11, NUMBER OF ENTRIES=3)
/show-alias ——————————————————————————— (6)
% ALIAS FILE NAME -> FILE NAME %UF : ASS -> $.ASSEMBH %UB : BSP -> LST.BSP.2 %UF : SF.SDF -> $TSOS.SYS.SDF.SYSTEM.SYNTAX % ACS0037 NUMBER OF ALIAS CATALOG ENTRIES: 3 (FOR SYSTEM: 0, FOR USER: 3)
/>rem-alias alias=ass ——————————————————— (7)
/add-alias alias=max,file=max.file.3 ———————————————————— (8)
/show-alias ———————————————————— (9)
% ALIAS FILE NAME -> FILE NAME %UB : BSP -> LST.BSP.2 %UB : MAX -> MAX.FILE.3 %UF : SF.SDF -> $TSOS.SYS.SDF.SYSTEM.SYNTAX % ACS0037 NUMBER OF ALIAS CATALOG ENTRIES: 3 (FOR SYSTEM: 0, FOR USER: 3)
/load-alias-cat alias=*own(acs.a1),mode=*merge ———————————————————— (10)
% ACS0001 ALIAS CATALOG 'USER1AC' LOADED (DESCRIPTOR='V0001A', DATE=2014-02-11, NUMBER OF ENTRIES=3)
/show-alias ——————————————————————— (11)
% ALIAS FILE NAME -> FILE NAME %UF : ASS -> $.ASSEMBH %UB : BSP -> LST.BSP.2 %UB : MAX -> MAX.FILE.3 %UF : SF.SDF -> $TSOS.SYS.SDF.SYSTEM.SYNTAX % ACS0037 NUMBER OF ALIAS CATALOG ENTRIES: 4 (FOR SYSTEM: 0, FOR USER: 4)
/purge-alias-cat ——————————————————————— (12)
/show-alias ——————————————————————— (13)
% ACS0017 ALIAS CATALOG NOT AVAILABLE. COMMAND REJECTED
(1) | The command ADD-ALIAS-CATALOG-ENTRY creates an entry in the task-local alias catalog to define the alias EXP for the file MAX.FILE.3. Since no alias catalog had been activated for the task, the alias catalog in question is activated in the process. |
(2) | The command ADD-ALIAS-CATALOG-ENTRY creates an entry in the task-local alias catalog to define the alias MAX for the file MAX.FILE.3 (thus defining a second alias). |
(3) | The command ADD-ALIAS-CATALOG-ENTRY creates an entry in the task-local alias catalog to define the alias SF.SDF for the file $TSOS.SYS.SDF.SYSTEM.SYNTAX (because RANGE=*FILE the entry here applies only for files). |
(4) | Output of the entries contained in the alias catalog. |
(5) | The entries of the AC file ACS.A1 are loaded into the alias catalog, and all previously existing entries are removed ( |
(6) | The output of the SHOW-ALIAS-CATALOG-ENTRY command shows the three user entries that were saved in the AC file ACS.A1 by means of the STORE-ALIAS-CATALOG-ENTRY command. All entries made earlier were removed or replaced by new entries for the same alias. For example, the alias EXP now addresses the file LST.EXP.2. |
(7) | Deletes the entry with the alias ASS. |
(8) | Adds an entry with the alias MAX for the file MAX.FILE.3. |
(9) | Output of the current entries in the alias catalog. |
(10) | The entries of the AC file ACS.A1 are loaded into the alias catalog. All previously made entries are to be retained in this case ( |
(11) | Output of the current entries in the alias catalog. |
(12) | The task-local alias catalog is deleted by using the PURGE-ALIAS-CATALOG command. This also ends the ACS substitution function. |
(13) | The command SHOW-ALIAS-CATALOG-ENTY indicates that no task-local alias catalog is loaded. |
For further examples, see the ADD-ALIAS-CATALOG-ENTRY and HOLD-ALIAS-SUBSTITUTION commands.