Chapter 15: Reports - APS-Generated

This chapter contains information on APS reports.

Report Descriptions

Application Definition

Display and describe application components painted in the Application Painter. Each application produces a separate report.

Produce from:

Painter Menu, Application Painter, or Report Generator screens.

Selection criteria:

Current application from the Application Painter screen; specific application, all applications, or range of applications from the Report Generator screen.

Component List

Alphabetically list and total components for each painter.

Produce from:

Documentation Facility.

Selection criteria:

All painters, or specific painter.

Content Report

Summarize information for each component. Output can be sorted by component name or date.

Produce from:

Documentation Facility.

Selection criteria:

All painters, or specific painter, specific date or date range. Sort by painter Type, Update date, or Create date.

Data Structure Definition Report

Display and describe data structures from the Data Structure Painter. Each data structure is a separate report.

Produce from:

Painter Menu, Application Painter, or Report Generator screens.

Selection criteria:

Specific data structure or all data structures in current application from the Application Painter screen; specific data structure, all data structures, or range of data structures from the Report Generator screen.

DDIFILE Report

View contents of DDIFILE.

Produce from:

Documentation Facility.

Selection criteria:

None.

Entity Cross Reference

Cross reference components and their painters such as other application components that reference the component being cross-referenced.

Produce from:

Documentation Facility.

Selection criteria:

All, or specific component within a painter. For batch programs, type *BATCH in the Entity Name field and PG in the Entity Type field.

Entity Parts List

List selected parts (components) of a target component (or components).

Produce from:

Documentation Facility.

Selection criteria:

Component type, ALL or specific components, specific application for Entity Type PG; limit of how deep the list goes; APS or user-supplied source components, and/or informational references (default is ALL).

Entity Search Utility

List all occurrences in a component (or components) of a specified search expression.

Produce from:

Documentation Facility.

Selection criteria for components:

Component type, ALL or specific components, specific application for Entity Type PG.

Selection criteria for search expressions:

Text string of characters or regular expression of text characters and metacharacters, as follows:

Metachar	What it matches
.	Wildcard; matches any character.
( )	Denotes a character class containing a range or list of characters. The only metacharacters recognized in a class are ^ as the first character in the class, - to denote a range, and \ to quote a metacharacter.
*	Matches zero or more occurrences of the single character or character class immediately preceding the *.
+	Matches one or more occurrences of either the single character or character class, or any or all characters in the character class immediately preceding the +.
?	Matches zero or one occurrence of the single character or character class immediately preceding the ?.
^	Code as first character in a character class to indicate logical NOT. Code as first character in expression to match the expression if the match begins at the left margin of the file searched.
$	Matches the preceding character(s) or character class if match appears at end of line. Must be coded last in expression.
\	Indicates that the single metacharacter immediately following the \ is an ordinary text character, not a metacharacter.

Entity Use Report

List components that use the target component such as components that COPY or INCLUDE the target component.

Produce from:

Documentation Facility

Selection criteria:

Component type, ALL or specific components, specific application for Entity Type PG; limit of how deep the list goes; APS or user-supplied source components, or informational references (default is ALL).

Field Attributes Report

Summarize field attributes applied to each screen field.

Produce from:

Report Generator Options screen.

Selection criteria:

Determined by selection criteria of Screen Hardcopy Report.

Field Edit Report

Summarize field edits applied to each screen field.

Produce from:

Report Generator Options screen.

Selection criteria:

Determined by selection criteria of Screen Hardcopy Report.

Field/Screen Cross Reference

Cross reference screen I/O and text fields and the screens in which they occur.

Produce from:

Documentation Facility.

Selection criteria:

All fields (press Enter key), specific field, or range of fields.

Macro/Program Cross Reference

List the macros used in one or more applications, along with all of the programs that invoke the macros, and the macro libraries that the programs reside in.

Produce from:

Documentation Facility.

Selection criteria:

All, or specific application.

Program DB/DC Report

Document screens and PSB/subschemas used by a program. Report has three sections: database views, record I/O areas, and screen I/O areas.

Produce from:

Documentation Facility.

Selection criteria:

Specific program and subschema, and, optionally, specific screen name(s).

Program Definition Report

Display and describe components of the Program Painter.

Produce from:

Painter Menu, Application Painter, or Report Generator screens.

Selection criteria:

Specific program or all programs in current application from the Application Painter screen; specific program, all programs, or range of programs from the Report Generator screen.

Report Mock-Up Report

Display report mock-up as painted in the Report Mock-Up Painter.

Produce from:

Painter Menu, Application Painter, or Report Generator screens.

Selection criteria:

Specific report mock-up or all mock-ups in current application from the Application Painter screen; specific mock-up, all mock-ups, or range of mock-ups from the Report Generator screen. Specify the printing of line numbers on the Report Generator Options screen.

Scenario Definition Report

Display and describe the application scenario as painted in the Scenario Prototype Painter, followed by a display of each screen mock-up in the scenario. Each scenario produces a separate report.

Produce from:

Painter Menu, Application Painter, or Report Generator screens.

Selection criteria:

Specific scenario, all scenarios, or range of scenarios.

Screen Hardcopy Report

Display screen mock-ups as painted in the Screen Painter. Optionally select reports of attribute values and field edits for each I/O and text field.

Produce from:

Painter Menu, Application Painter, or Report Generator screens.

Selection criteria:

Specific screen or all screens in the current application from the Application Painter screen; specific screen, all screens, or range of screens from the Report Generator screen. Select Field Attributes Report, Screen Field Edits Report, and left justification for all three reports on the Report Generator Options screen.

Report Production

Application documentation reports may be produced in four ways; some reports can be produced in more than one way. Produce your report by the Produce from method noted previously -- the following describes the procedure for each method.

Report Generator

On the Painter Menu, enter in the Type field the component type that you want to report on--AP(plication), CN (scenario), DS (data structure), PG (program), RP (report mock-up), or SC(reen).
Leave the Member field blank.
Enter REPORT in the Command field and press Enter.
Enter selection criteria:
- To report on all members of all component types, type 1 in the Option field. Make sure that all entry fields are blank on the screen.
- To report on all members of the one component type, type 2 in the Option field. Leave the value that displays in the Library field.
- To report on a specific member of a component, select type 3 in the Option field. Leave the value that displays in the Library field, and enter the component member name in the Member Name field.
- To report on a range of members in a component, type 3 in the Option field. Enter the component type in the Library field and the value range of the members you want to report on in the Range Greater and Range Less fields.
Press Enter.

Painter Menu

In the Type field, enter the component type that you want to report on--AP(plication), CN (scenario), DS (data structure), PG (program), RP (report mock-up), or SC(reen).
In the Member field, enter the member name to report on.
Enter REPORT in the Command field.
Press Enter.

Application Painter

To report on all members of all components, or all members of a specific component, do one of the following:
- Type REPORT in the Command field to report on all members of all components of an application.
- Enter REPORT componenttype ALL in the Command field to report on all members of a specific component.
To report on a specific member of a component, do one of the following:
Enter REPORT componenttype componentname in the Command field.
Type R next to the component name in the Application Painter matrix.
Press Enter.

Documentation Facility

From the APS Main Menu screen, enter 2 in the Option field.
Enter option 2 in the Option field.
Enter the applicable option number in the Option field.
Enter any selection criteria.
Press Enter.