Modify entry in alias catalog
Component: | ACS |
Functional area: | File processing |
Domain: | FILE |
Privileges: | STD-PROCESSING |
Function
The MODIFY-ALIAS-CATALOG-ENTRY command is used to change an existing entry in the current alias catalog. The following attributes can be redefined by the user for the existing entry:
actual file or job variable name to be substituted for the alias
whether the alias substitution is to be logged
whether the entry is displayed in the output of the SHOW-ALIAS-CATALOG-ENTRY command
whether the entry is protected against changes or deletion by the MODIFY-ALIAS-CATALOG-ENTRY or REMOVE-ALIAS-CATALOG-ENTRY command
range of the substitution: the entry applies only for files, only for job variables, or for both (RANGE operand)
The command is rejected if there is no existing entry for the specified alias or if an existing entry is protected against changes by the PROTECTED attribute.
Modified entries are only temporarily present in the task-local alias catalog, which means they are discarded when the alias catalog is deleted (explicitly with the PURGE-ALIAS-CATALOG command or implicitly when the task is terminated). If desired, however, the current entries can be saved in a file by using the STORE-ALIAS-CATALOG command.
Privileged functions
When an individual catalog entry is modified, the ACS administration can convert the entry to a system entry. In this case, the alias name is subjected to a less rigorous check; it is then always permissible to specify a catalog ID and a user ID (other than $SYS*. or $TSOS.).
Format
MODIFY-ALIAS-CATALOG-ENTRY | ||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||
Operands
ALIAS-FILE-NAME = <filename 1..54>
Alias for which the actual file or job variable name is to be substituted by ACS.
FILE-NAME = *UNCHANGED
The associated actual file or job variable name is not changed.
FILE-NAME = <filename 1..54>
Actual file or job variable name to be substituted by ACS for the alias. The name of a temporary file or job variable is not allowed.
If the actual name is identical to the alias, the entry is treated as a normal alias definition (in contrast to *SAME). The substitution of the file name is logged as ACS0000. The substitution of the job variable name is logged with ACS0049.
FILE-NAME = *SAME
The original specification can only be changed if the entry does not have the PROTECTED attribute.
The actual file or job variable name is the same as the alias, so no substitution and logging take place in this case; however, the entry prevents the insertion of the defined prefix.
ATTRIBUTES = *UNCHANGED / *STD / *PARAMETERS(...)
Changes the attributes of the existing entry created in the alias catalog. Several attributes may be specified together in a list.
ATTRIBUTES = *UNCHANGED
No attributes are changed.
ATTRIBUTES = *STD
The entry in the alias catalog is to have none of the attributes below.
ATTRIBUTES = *PARAMETERS(...)
The new entry is to have the following attributes:
LOGGING = *UNCHANGED / *YES / *NO
Substitution of the alias is to be logged. This attribute is independent of the corresponding ACS setting which applies to the task.
VISIBILITY = *UNCHANGED / *YES / *NO
Prevents the entry for non-privileged users in the alias catalog from appearing in the output of the SHOW-ALIAS-CATALOG-ENTRY command.
PROTECTION = *UNCHANGED / *YES / *NO
Protects the entry in the alias catalog against modification and deletion with the MODIFY-ALIAS-CATALOG-ENTRY and REMOVE-ALIAS-CATALOG-ENTRY commands respectively.
TYPE = *UNCHANGED / *USER / *SYSTEM
Only for users with ACS-ADMINISTRATION privilege:
Specifies whether the type of the entry which is being modified is to be USER or SYSTEM.
TYPE = *UNCHANGED
Preset value: the previous declaration continues to apply.
TYPE = *USER
The catalog entry in the alias catalog is to be held as a user entry. Such entries are included when the virtual catalog is saved into a file.
TYPE = *SYSTEM
The catalog entry in the alias catalog is to be held as a system entry. When the virtual catalog is saved into the AC file of a nonprivileged user, such entries are not included.
RANGE = *UNCHANGED / *FILE / *JV / *BOTH
Determines the range of the entry. Alias substitution can be defined for files and/or job variables.
RANGE = *UNCHANGED
Preset value: the previous declaration continues to apply.
RANGE = *FILE
Alias substitution is only effective for files.
RANGE = *JV
Alias substitution is only effective for job variables.
RANGE = *BOTH
Alias substitution is effective for both files and job variables.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command executed normally | |
32 | CMD0221 | Internal error | |
64 | ACS0006 | Error: ACE entry not found | |
64 | ACS0017 | Error: alias catalog not available | |
64 | ACS0024 | Invalid alias catalog entry | |
64 | ACS0029 | Command not permitted | |
128 | ACS0018 | ACS is not available |
Examples
For examples, see the ADD-ALIAS-CATALOG-ENTRY, LOAD-ALIAS-CATALOG, and SET-FILE-NAME-PREFIX commands.