DISPLAY INDEX Command

In relating dataviews to systems or relating programs to systems, authorization is required for the specified system.
cadts
In relating dataviews to systems or relating programs to systems, authorization is required for the specified system.
See also the DISPLAY INDEX OUTPUT command.
This command has the following format:
Display Index for All PROGRAM Parameter
DISPLAY INDEX ALL [PROGRAM] [
ent-name
] [VERSION
version
] [{RELATED [TO] {DATAVIEW} [
ent-name
] [VERSION
version
]] {DOCUMENT} {PANEL } {PROGRAM} {REPORT }
Display Index for MEMBER Entity Type
DISPLAY INDEX MEMBER [
ent-name
] [VERSION
version
] [USER
user-id
]
Display Index for PACKAGE and PLAN Entity Types
DISPLAY INDEX PACKAGE [
ent-name
] [VERSION
version
] DISPLAY INDEX PLAN [
ent-name
] [VERSION
version
]
Display Index for DATAVIEW, DOCUMENT, PANEL, PROGRAM, REPORT, SYSTEM, and USER Entity Types
DISPLAY INDEX
ent-type
[
ent-name
] [VERSION
version
]
Operand Definitions
Operand
Description
ALL [PROGRAM]
You can enter ALL only when
ent-type
is PROGRAM to display an index of all programs, regardless of system, related to a specified program.
When you specify ALL PROGRAM, you must specify the RELATED clause with a unique
ent-name
of a panel, report, or program that exists in the current system.
Because the ALL option displays 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
The class of entities you want to index. Entity types are SYSTEM, USER, DATAVIEW, DOCUMENT, PROGRAM, PANEL, REPORT, MEMBER, PACKAGE and PLAN.
Entity types PLAN and PACKAGE cannot be related to another entity type. In the RELATED TO clause, you cannot specify MEMBER, PLAN, and PACKAGE as an entity type.
If
ent-type
in the RELATED clause is PROGRAM, the specified resources of each program display across all systems. For example, the command DISPLAY INDEX PNL RELATED TO PGM displays an index of all panels each program uses, regardless of the system that contains the panels.
However, if the
ent-type
is PROGRAM for both clauses and ALL is not specified, such as DISPLAY INDEX PGM RELATED TO PGM, subprograms in other systems are listed for each program, but calling programs in other systems are not included.
ent
-
name
(Optional) The 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.
Important!
Mask characters do not work with members and plans, because members and plans are not Datadictionary controlled entities.
An asterisk (*) marks the position in the entity name of a single character to mask. For example, PAY*1 matches PAY01, PAY21, and so forth.
Note:
When you use an asterisk 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* match PAY011.
A plus sign (+) 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 asterisk mask character were substituted for the plus sign 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 plus sign 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.
VERSION
version
Version of the entity occurrence. For information on valid versions to specify, see Using Version Clauses in
CA Ideal for CA Datacom
Commands in the “Preliminary Concepts” chapter.
USER
user
-
id
The 1- to 15-character user name or the one- to three-character user ID.
Note:
The USER operand is used only when MEMBER is specified as the first clause
ent-type
. A user ID is required for an index of members belonging to another user.
RELATED TO
When used with DISPLAY INDEX ALL PROGRAM the RELATED TO entity types are limited to DOCUMENT, PROGRAM, PANEL and REPORT. The ALL operand requires that a version, where applicable, uniquely qualify the RELATED TO entity. It does not take a default.
The RELATED TO option is used to find the RESOURCEs (except dataviews) of programs. This information, as well as the dataview relationship, is also available from Datadictionary. DDUTILTY can be used to produce RELATIONSHIP reports in batch.
Displaying Related Programs
If you relate program entity type to program entity type, for example, DISPLAY INDEX PROGRAM MY-PROG RELATED TO PROGRAM, the index includes all subprograms called by the specified program (MY-PROG) and all programs that call the specified program. This applies to each program if more than one is indexed.
The following report illustrates the index of all programs in System DOC, produced by the command: DISPLAY INDEX PGM
IDEAL: DISPLAY INDEX PGM SYS: DOC DISPLAY Command Name Ver S R-S Sys Lang Description Created Updated ====== ================================ T O P================================= 000001 DEMO1 001 T PRV DOC IDEAL produce demrpt1 11/04/04 11/04/04 000002 DEMO2 001 T PRV DOC IDEAL produce mult dvw details 11/04/04 11/04/04 000003 DEMO3 001 T PRV DOC IDEAL produce demrpt3-xsys res 11/04/04 11/04/04 000004 DEMO4 001 T PRV DOC IDEAL produce demrpt4 11/04/04 11/04/04 000005 DEMO5 001 T PRV DOC IDEAL list for reporting 11/04/04 11/04/04 000006 DEMO6 001 T PRV DOC IDEAL produce dempgm6 fm dvw 11/04/04 11/04/04 000007 DEMO6 002 T PRV DOC IDEAL produce dempgm6 fm dvw 11/04/04 11/04/04 000008 TEST 001 T PRV DOC IDEAL test program for doc 10/05/04 10/05/04 ====== ============================= B O T T O M =============================
Field Definitions
Field
Description
Name
One- to eight-character entity name..
Ver
One- to three-digit number, QSAM or SAM identifier, or SQL label (DBSQL or DB2)
CA Ideal for CA Datacom
assigned when this version of the entity was created.
S
Status version of the entity:
T (test-status version)
P (production-status)
H (history-status version)
R-S
Run-status of the entity:
PRV (Private)
SHR (Shared)
RES (Resident)
Sys
System where the entity belongs.
Lang
Language that creates this entity. IDEAL is the default. The values ASM, COBOL, or PLI identify Assembler, COBOL, and PL/I respectively.
Description
One- to 32-character description of the entity.
Created
Date when the entity was created.
Updated
Date when the entity was last accessed in edit mode.
Displaying Related Dataviews
The following illustrates the index of dataviews related to all programs in system DOC, produced by the command: DISPLAY INDEX DATAVIEW RELATED TO PROGRAM
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+.... IDEAL: DISPLAY INDEX DVW SYS: DOC DISPLAY Command Name Ver S U Type Description Created Updated ====== ================================ T O P ============================== 000001 000002 =============> Related to PGM DEMO1 Version 001 Status TEST 000003 CUSTOMERS 001 P N ORDER ENTRY DATAVIEW 01/30/02 10/05/04 000004 000005 =============> Related to PGM DEMO2 Version 001 Status TEST 000006 CUSTOMERS 001 P N ORDER ENTRY DATAVIEW 01/30/02 10/05/04 000007 ORDERS 001 P Y ORDER ENTRY DATAVIEW 01/30/02 09/02/04 000008 000009 =============> Related to PGM DEMO3 Version 001 Status TEST 000010 CUSTOMERS 001 P N ORDER ENTRY DATAVIEW 01/30/02 10/05/04 000011 000012 =============> Related to PGM DEMO4 Version 001 Status TEST 000013 CUSTOMERS 001 P N ORDER ENTRY DATAVIEW 01/30/02 10/05/04 000014 000015 =============> Related to PGM DEMO5 Version 001 Status TEST
Field Definitions
Field
Description
Name
One- to eight-character entity name.
Ver
One- to three-digit number.
CA Ideal for CA Datacom
assigned when this version of the entity was created.
S
Status of the entity:
T (Test)
P (Production)
H (History)
U
Update the dataview records:
Y (Yes)
N (No)
Description
The 1- to 32-character description of the entity.
Created
Date when the entity was created.
Updated
Date when the entity was last accessed in edit mode.