Operand Definitions

CA Ideal Commands › DISPLAY DATAVIEW Command › Operand Definitions

Operand Definitions

Operand	Description
*	Represents the current dataview. Can be substituted for the dataview identification phrase.
auth‑id	One‑ to eight‑character authorization ID required for SQL dataviews only.
dvw‑name	One‑ to 18‑character name of the dataview.
version	Version of the dataview. For modeled dataviews (CA Datacom native access or sequential), the specified version must be in test or production status. For information on valid versions to specify, see Using Version Clauses in CA Ideal Commands in the “Preliminary Concepts” chapter. If the version is not specified, the default version set in the SET VERSION command is used for both modeled and unmodeled dataviews.
IDENTIFICATION FIELDS PARAMETERS KEYS	Specify one of these keywords to display the indicated fill‑in panel of a VSAM or unmodeled sequential file dataview definition. If the dataview was cataloged, the catalog listing displays by default. If the dataview was not cataloged, the Field Definition displays by default. Note: KEYS is only valid for VSAM KSDS data sets

DISPLAY INDEX Command

The DISPLAY INDEX command lists the name and status of each occurrence of the specified entity type. Optionally, this list or 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). DISPLAY INDEX without an entity type calls up a prompter. In batch, CA Ideal processes DISPLAY commands as prints. This display is based on dictionary facility relationships.

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] {PANEL  } [ent-name] VERSION version}
                {PROGRAM}
                {REPORT }

Display Index for MEMBER Entity Type

DISPLAY INDEX MEMBER [ent-name] [VERSION version] [USER user-id]

  [RELATED [TO] {DATAVIEW} [ent-name] [VERSION version]]
                {PANEL   }
                {PROGRAM }
                {REPORT  }
                {SYSTEM  }  
                {USER    }

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, PANEL, PROGRAM, REPORT, SYSTEM, and USER Entity Types

DISPLAY INDEX ent-type [ent-name] [VERSION version] 

  [RELATED [TO] {DATAVIEW} [ent-name] [VERSION version]]
                {PANEL   }
                {PROGRAM }
                {REPORT  }
                {SYSTEM  }  
                {USER    }

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, 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, PAY1 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 PAY1 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 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 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.