Show entries in alias catalog
Component: | ACS |
Functional area: | File processing |
Domain: | FILE |
Privileges: | STD-PROCESSING |
Function
The SHOW-ALIAS-CATALOG-ENTRY command outputs AC entries to SYSOUT. Entries with the attribute INVISIBLE are shown to the ACS administrator only. The user selects the entries to be displayed by specifying the defined aliases. If all entries are selected, the scope of the output information can be restricted as follows:
output of a totals line for all AC entries
selection based on the scope of entries (user or system entries).
selection based on the range of the entries (for files and/or job variables)
The command supports structured output in S variables (see "Output in S variables").
Format
SHOW-ALIAS-CATALOG-ENTRY | ||||||||||||||||||||||||||||||
|
Operands
ALIAS-FILE-NAME = *ALL / <filename 1..80 with-wild>
Selects the AC entries to be output on the basis of the associated alias contained in the entry. Entries with the INVISIBLE
attribute are shown only to the ACS administration.
ALIAS-FILE-NAME = *ALL
Selects the AC entries for all aliases. The scope of the information to be shown can be restricted.
ALIAS-FILE-NAME = <filename 1..80 with-wild>
Specification of a defined alias or a wildcard sequence to select a set of aliases for which AC entries are to be shown.
SELECT = *ALL / *BY-ATTRIBUTES(...)
The AC entry selection criteria.
SELECT = *ALL
Returns information on all AC entries.
SELECT = *BY-ATTRIBUTES(...)
Restricts the AC entries selected from the set to those which satisfy the following specifications.
TYPE = *ALL / *USER-ENTRIES / *SYSTEM-ENTRIES
Returns information on AC entries depending on the entry type (user or system entries).
TYPE = *ALL
The entry type is not to be used as a selection criterion. Both user and system entries (*ALL) are to be shown.
TYPE = *USER-ENTRIES
Returns information on user entries.
TYPE = *SYSTEM-ENTRIES
Returns information on system entries.
RANGE = *ANY / *FILE / *JV
Returns information on AC entries depending on the range (for files or job variables).
RANGE = *ANY
The range is not to be used as a selection criterion.
RANGE = *FILE
Provides information on all AC entries which are valid for files (i.e. all entries which are set up with the range RANGE=*FILE or *BOTH).
RANGE = *JV
Provides information on all AC entries which are valid for job variables (i.e. all entries which are set up with the range RANGE=*JV or *BOTH).
INFORMATION = *STD / *SUMMARY
Defines the scope of the output.
INFORMATION = *STD
For each ACS entry, the alias and the actual file or job variable name are shown with preceding signs, which meaning are explained in the example below.
The output ends with a totals line containing the total number of aliases selected in the ALIAS-FILE-NAME operand and a breakdown of system and user entries.
INFORMATION = *SUMMARY
Only the totals line is to be shown.
Return codes
(SC2) | SC1 | Maincode | Meaning |
---|---|---|---|
0 | CMD0001 | Command executed normally | |
2 | 0 | ACS0006 | Warning: AC entry not found |
32 | CMD0221 | Internal error | |
64 | ACS0017 | Error: alias catalog not available | |
64 | ACS0024 | Invalid alias catalog entry | |
128 | ACS0018 | ACS is not available |
Output in S variables
The INFORMATION operand identifies the S variables which are to be created. The possible values for INFORMATION are *STD and *SUMMARY.
Output information | Name of the S variable | T | Contents | Condition |
---|---|---|---|---|
File or job variable name alias | var(*LIST).ACS(*LIST).ALIAS-F-NAME | S | <filename 1..54> | INF=*STD |
Actual file or job variable name | var(*LIST).ACS(*LIST).F-NAME | S | <filename 1..54> | INF=*STD |
Logging enabled | var(*LIST).ACS(*LIST).LOG | S | *NO | INF=*STD |
Alias catalog entry protection enabled | var(*LIST).ACS(*LIST).PROT | S | *NO | INF=*STD |
Range of the alias catalog entry (for files and/or job variables) | var(*LIST).ACS(*LIST).RANGE | S | *FILE | INF=*STD |
Type of alias catalog entry | var(*LIST).ACS(*LIST).TYPE | S | *SYS | INF=*STD |
AC entry visible | var(*LIST).ACS(*LIST).VISIBLE | S | *NO | INF=*STD |
Number of system entries | var(*LIST).NUM-OF-ENTRY.SYS | I | <integer 0...65535> | INF=*STD/ |
Total number of AC entries | var(*LIST).NUM-OF-ENTRY.TOTAL | I | <integer 1...65535> | INF=*STD/ |
Number of user entries | var(*LIST).NUM-OF-ENTRY.USER | I | <integer 0...65535> | INF=*STD/ |
Examples
/SHOW-ALIAS-CATALOG-ENTRY (Output with the privilege ACS-ADMINISTRATION)
% ALIAS FILE NAME -> FILE NAME
%UB : BOTH -> FILE-OR-JV-NAME
%UF : FILE -> FILE-NAME
%UJ : JV -> JV-NAME
%UJI : JV.INV -> JV-ALIAS.BLIND
%SB : LOAD-BIND -> $.BINDER
%SB : LOAD-PAMCONV -> $.PAMCONV
%UJIP+ SF -> FILE-ALL
% ACS0037 NUMBER OF ALIAS CATALOG ENTRIES: 7 (FOR SYSTEM: 2, FOR USER: 5)
Output of an entry has the following format:EXAMPLE: %SB : LOAD-BIND -> $.BINDER (Example of a line)
FORMAT: %abcde alias-name -> Job variable or file name
The first 5 characters mean the following:
%abcde possible meaning of the
||||| content possible contents
||||e : Alias replacement not logged
||||e + Alias replacement logged
|||d ' ' Entry not protected
|||d P Protected
||c ' ' Entry shown by SHOW-ALIAS-CATALOG-ENTRY command
||c I Invisible, entry only shown to the administrator
|b F File Entry
|b J JV Entry
|b B Both (File or JV)
a S System Entry
a U User Entry
For detailed description see the ADD-ALIAS-CATALOG-ENTRY command.
For further examples, please refer to ADD-ALIAS-CATALOG-ENTRY, LOAD-ALIAS-CATALOG and SET-FILE-NAME-PREFIX commands.