Administrative Information Services (AIS)
Information Technologies
STANDARDS FOR REPORT DEVELOPMENT
July 11, 2001
1. Purpose:
The purpose of this document is to specify standards to be used when creating and developing AIS Oracle reports.
ORACLE 6 reports can be stored either in the database or in the PC file system.
ORACLE Reports provides tables to store data about the reports that are created. From these tables,reports can be generated to provide detailed information about any
ORACLE 6 report.
2. Naming Standards:
The following chart indicates the naming conventions to be used when creating an ORACLE report:
| ORACLE Reports Usage |
Naming Standards for ORACLE Reports |
| Main Query |
Q_POP |
| Layout Fields |
F_ < Name to display on the document> |
| User Input Parameter Layout Fields |
PF_ < Name to display on the document> |
| Report File Name / Executable Name |
1. Must be descriptive and include the version number
(30 char limit v6.0, 60 char limit v6i)
2. Add "DD" as a suffix to the rpt name for "Drill Down" rpts.
3. Add "DT" as a suffix for a "Drill Target" rpt (is
produced when user clicks to drill down for details). (E.g., UnmetDemandDT.).
|
Note: The Executable Name for the report will be contained in
X_NAME(Parameter Form)
3. Formats available for ORACLE reports:
a. In general, reports need to be presented in each of the following formats:
1. On-Line (screen)
2. HTML
3. PDF
b. Reports also need to be
printed using Windows and UNIX.
4. Template for Oracle Reports:
Developers are to use the
USF ORACLE Reports template wherever possible.(\\atlantis\programs\programs\ffwrun\tdf\usf.tdf)
The
template will provide the following:
a. The Executable Name. (The value will be contained in X_NAME -user parameter).
b. The Bottom Margin which will contain:
(Left corner) Run date and time, X_NAME (Executable Name & Version Number)
(Center of page) Page Number
(Right corner) Hyperlink to source documentation
Note: The Hyperlink will be based on the report’s
X_NAME. (
http://usfweb.usf.edu/IT_Reports/doc/<X_NAME>.html)
5. No Records Returned?
Whenever a user inputs a parameter for which no records are returned, a message should be displayed to
let the user know that the report is not “in error.” The message statement should indicate clearly that no (or zero) records were returned from the query they executed (e.g., “Query retrieved 0
records.”).
6. ORACLE Reports Documentation:
The following table displays the relationship between the AIS current programmers’ documentation (created with input to an ORACLE form) and ORACLE Reports:
Programmers’ Documentation
(fields in AIS reports form)
|
Corresponding ORACLE Reports Source |
| Report Description |
Report Comment |
| Report Population |
Main Query Comment |
| Col/Display Name |
Any Layout Field Name prefixed by “F_”
(The ”F_” will be removed when it is displayed)
|
| Data Source |
Parsed from the Query(ies) of the Report |
| Col/Display Name Description |
Comment on Layout Field |
| Parameters |
Any Parameter Form Layout Field Name prefixed by “PF_”
(The ”PF_” will be removed when it is displayed)
|
Last Updated: 10-MAY-02
 |
|
Copyright © 2002, University of South Florida,
4202 E. Fowler Avenue, Tampa, FL 33620 -- (813) 974-2011
|
|
|
|
