ADSO XREF Utility User's Guide
Copyright © 1985-2017 Laderman Associates


System Description

    Programs
    System Overview
    Operational Notes
      Executing in Local Mode
      Abnormal Termination
    Extract File Description

Programs


     LADAXU05     Extract for LADAXU06
     LADAXU06     DIME Cross Reference
     LADAXU10     Extract for LADAXU11 & LADAXU12
     LADAXU11     Individual Record Cross Reference
     LADAXU12     Combined Record Cross Reference
     LADAXU15     Extract for LADAXU16
     LADAXU16     Dialog Cross Reference
     LADAXU20     Extract for LADAXU21 & LADAXU22
     LADAXU21     Individual Element Cross Reference
     LADAXU22     Combined Element Cross Reference
     LADAXU25     Extract for LADAXU26 & LADAXU27
     LADAXU26     Application Cross Reference
     LADAXU27     Calling Dialog Cross Reference

All programs are written in COBOL and may be treated as standard batch application programs. LADAXU05, LADAXU10, LADAXU15, LADAXU20, and LADAXU25 are all retrieval run units, using IDMSNWKA, and may be executed in local mode or through the central version. The remainder of the programs are non-IDMS.

System Overview

The AXU can produce five different sets of reports with each set consisting of as many as nine different cross references.

The Dialog Cross Reference identifies the use of modules, called dialogs, records, elements, subroutines, sets, areas, edit/code tables, and messages within a single dialog. Optionally, it also lists all process code and record descriptions.

The Application Cross Reference identifies the use of modules, called dialogs, records, elements, subroutines, sets, areas, edit/code tables, and messages within an ADSA application or a grouping of dialogs.

The Element Cross Reference identifies all schemas, subschemas, records, programs, dialogs, maps, and modules in the IDD which reference a specific element or grouping of elements.

The Record Cross Reference identifies all schemas, subschemas, programs, dialogs, maps, and modules in the IDD which reference a specific record or grouping of records.

The DIME Cross Reference identifies all called Dialogs, Included modules, Messages, and Edit/code tables in the IDD.

Each job stream is comprised of three steps. An extract program reads the IDD and creates a sequential file containing the relational data. All relational data is retrieved from the DDLDML area except for the definition of an ADSA application, which is retrieved from DDLDCLOD. If set relationships have been broken, data may be lost. For example, if a module is deleted and re-added, its relation to dialogs is not re-established unless the dialogs are regenerated. The same holds true for all entity types where dictionary sets exist.

The extract program is followed by a sort and a print program. If you would like to see the data in a format other than that supplied, you may create your own print program. See Extract File Description for a layout of the EXTRACT file.

The AXU provides the capability to cross-reference multiple dictionaries within a single report. To accomplish this, simply execute the desired extract program against each IDD and then input all of the EXTRACT files into the sort preceding the print program. While the AXU does not list the dictionary DBNAME in any of the cross-references, this information is carried in the EXTRACT file and is available for any report you may wish to create.

To determine which set of reports will provide the answers to a specific question, use the following guidelines.

Operational Notes

Executing in Local Mode

DOS users: In the following, translate load library to core-image library.

It is recommended that the AMU be executed in local mode to achieve optimal performance.

If you are executing against a secondary dictionary, then ensure that the load library you have specified contains the appropriate database name table. This standardly resides in the DDLDCLOD area, but must be punched and linked to a load library for local mode execution.

Abnormal Termination

For most fatal errors, the AXU program will call ABORT to abort the program. Prior to aborting, the program will print an error message at the end of its listing indicating the cause. For DOS environments, this CSECT is not supplied with the AMU, but you may link the AMU programs with IDMSCANC which does include this CSECT. If you do not, the program will abort anyway, with a PROGRAM NOT FOUND message. See the DOS Installation section for more details.

Extract File Description

The intent of this section is to provide a description of the key fields in the EXTRACT file. You may use this information to create your own report program if you are not thrilled with the supplied formats.

The EXTRACT file (record length = 200) is created by each extract program and read by each report program. It contains fields which are described as entity code. The definitions of those fields are as follows:


 Figure 1. Definition of Entity Codes

160 - Dialog 	        280 - Program
170 - Edit Module 	300 - Record
180 - Element         	320 - Schema
220 - Map 	        340 - Subschema
240 - Message        	380 - Table
260 - Module 	        510 - Set or Area 
270 - Panel 	        520 - Subroutine


The key fields of the EXTRACT file are:


Figure 2. Layout of EXTRACT file 

Start 	Length 	Type 	Description

1 	   3	  N	Entity Code
4 	  32	 AN	Entity Name
36 	   4	  N	Entity Version
40 	   3	  N	Entity Code of Owning Entity ¹
43 	  32	 AN	Name of Owning Entity ¹
75 	   4	  N	Version of Owning Entity ¹
82 	  32	 AN	Program Name
114 	   4	  N	Program Version
118 	   8	 AN	DBNAME of IDD
132 	   5	  N	Module Text Sequence ²
137 	  20	 AN	Verb ²
157 	   6	  N	Page Number Reference ³
163 	   6      N	Line Number Reference ³
132 	  32	  N	Synonym Name ²
174 	   6	  N	Module Text Sequence ²

1. Usually the process or map which references the entity.
2. Not valid for LADAXU10 & LADAXU20
3. Only valid for LADAXU15