The PRINT INDEX command lists the name and status of each occurrence of the specified entity type.
Optionally, the index can include occurrences of entity types that are related to a given entity type or occurrence (for example, each panel related to a given program). This display is based on dictionary facility relationships. Authorization in the specified system is required when relating dataviews or programs to systems. PRINT INDEX without an entity type calls up a prompter.
See also the PRINT INDEX OUTPUT command.
This command has the following format:
PRINT INDEX [ALL] [ent‑type] [ent‑name] [VERSION version]
[USER user‑name]
[RELATED [TO] ent‑type [ent‑name] VERSION version]
[ {MAIL 'email‑id' }]
[ {LIB }]
[DESTINATION {{SYS name} }]
[ {{NET name} COPIES nn }]
[DESCRIPTION 'string']
|
Operand |
Description |
|
|---|---|---|
|
ALL |
You can enter this parameter only when ent‑type is PROGRAM. It prints an index of all programs, regardless of system, related to a specified program. When ALL is specified, the RELATED clause must be specified with a unique ent‑name. Because the ALL option prints a cross‑system program index, you must have an authorization of ADMIN to use this option. Note: The ALL operand requires that a version, where applicable, uniquely qualify the RELATED TO entity. It does not take a default. |
|
|
ent‑type |
Classification of entities to index: that is, SYSTEM, USER, DATAVIEW, PROGRAM, PANEL, REPORT, MEMBER, PACKAGE, or PLAN. Printing the index of outputs is described under PRINT INDEX OUTPUT. PACKAGE and PLAN entities cannot be related to another entity type. In the RELATED TO clause, you cannot specify MEMBER, PACKAGE, and PLAN as an entity type. If ent‑type in the RELATED clause is PROGRAM, the specified resources of each program are printed across all systems. For example, the command PRINT INDEX PNL RELATED TO PGM prints an index of all panels used by each program, regardless of the system that contains the panels. Note: If the ent‑type is PROGRAM for both clauses and ALL is not specified, subprograms in other systems are listed for each program, but calling programs in other systems are not included. |
|
|
ent‑name
|
(Optional) Specific name of an entity occurrence to index. SQL dataview names must include the authorization ID (for example, AUTHID1.PAY). You can use the following characters in an entity name to mask characters in the name during the index search. * Marks the position in the entity name of a single character to mask. For example, PAY*1 matches PAY01, PAY21, and so on. Note: When you use * in a string, you must know the length of the string to match. If the name being tested has more characters than the masked value, the name does not match. For example, neither PAY*1 nor PAY* matches PAY011. + Marks the position in the entity name beyond which all characters are masked. For example, DISPLAY INDEX PROGRAM IDE+ matches all names starting with IDE of any length. This command locates both PROGRAM IDE1 and IDE11. However, if the * mask character were substituted for the + mask character, the program IDE1 is located, but not the program IDE11. You can use the mask characters in any position except the first position. The + mask character must be in the last position specified. When you use mask characters to search for systems or users, use the full entity name, not the short ID. |
|
|
|
||
|
user‑id |
One‑ to three‑character user‑id required for an index of members belonging to another user. |
|
|
version |
Version of the entity occurrence. For information on valid versions to specify, see Using Version Clauses in CA Ideal Commands in the “Preliminary Concepts” chapter. Note: Unmodeled dataviews are all in DD test status, regardless of whether they are PROD or HIST to CA Ideal. For example, if you specify PRINT INDEX DVW VER T001, the resulting output contains both HIST and PROD status entries that are version 1. |
|
|
DESTINATION dest |
Specifies the output destination. MAIL 'email‑id' A delimited 1‑ to 60‑character name of a [assign the value for emailp in your book] destination. LIBRARY Output library. SYSTEM name System printer name. NETWORK name Network printer (not available in batch). |
|
|
COPIES nn |
Number of copies to print on a system or network printer. This option is ignored in batch. |
|
|
DESCRIPTION 'string' |
A 1‑ to 32‑character description of the output. |
|
Copyright © 2015 CA Technologies.
All rights reserved.
|
|