Search Results create_header

Overview

APPS.JTF_DIAG_REPORT_FACTORY is a PL/SQL factory package in the Oracle E-Business Suite diagnostic framework. It is declared with AUTHID CURRENT_USER, meaning that its SQL statements execute under the privileges of the invoking session rather than the definer, which is significant because the package is intended to be called both from Oracle's own diagnostics infrastructure and from customer-written diagnostic scripts and concurrent programs.

Its purpose is to construct the visual and structural building blocks of a diagnostic report. The package exposes a set of CREATE_* functions that each instantiate one element of the JTF_DIAG report object model — a header, footer, section, message, table, form, link, and so forth. These element objects are then assembled into a complete report by the calling code and rendered to the user. In this sense the package is a builder API: it hides the internal constructors and attribute-setting logic of the JTF diagnostic report classes behind a uniform interface that always accepts a JTF_DIAG_REPORT_CONTEXT parameter, which carries the report-level state (locale, formatting and output conventions) that each element needs in order to render itself consistently. The package therefore supports both internal Oracle diagnostic reports and extensibility by customers or integrators who need to author custom diagnostic output within the Oracle Application Framework diagnostic pages.

Key Procedures and Functions

• CREATE_FOOTER — Returns a JTF_DIAG_FOOTER object representing the closing footer region of a diagnostic report.
• CREATE_HEADER — Returns a JTF_DIAG_HEADER object representing the report's opening header region.
• CREATE_SECTION — Returns a JTF_DIAG_SECTION, a titled grouping used to organize report content.
• CREATE_MESSAGE — Returns a JTF_DIAG_MESSAGE carrying a message and a message type; an overload also accepts a JTF_DIAG_NOTE, allowing a note object to be converted or augmented into a report message.
• CREATE_HIDE_SHOW — Returns a JTF_DIAG_HIDE_SHOW element for collapsible content, so lengthy diagnostic detail can be hidden by default.
• CREATE_RAW_TEXT — Returns a JTF_DIAG_RAW_TEXT element for preformatted or unescaped textual output.
• CREATE_LINK — Returns a JTF_DIAG_LINK built from link text and a target URL, enabling navigation from the report.
• CREATE_FORM — Returns a JTF_DIAG_FORM defined by a heading plus parallel key and value collections (JTF_VARCHAR2_TABLE_4000), used to present name/value attribute data.
• CREATE_TABLE — Returns a JTF_DIAG_TABLE. Several overloads are provided: a table may be created from column headers alone, from headers plus an explicit SQL query, from a SQL query alone, or from headers with the query supplied separately. When a query is supplied, the package executes it and populates the table rows.
• CREATE_ROW — Returns a row object for populating a diagnostic table.
• CREATE_TREE and CREATE_TREE_NODE — Return hierarchical tree and tree-node objects for displaying nested diagnostic structures.
• CREATE_NOTE — Returns a JTF_DIAG_NOTE, a lightweight annotation element.
• CREATE_METALINK — Returns a link element for embedding metadata-oriented navigation in the report.

Tables Accessed

The package references its data dictionary objects through APPS synonyms. JTF_DIAGNOSTIC_REPORT and JTF_DIAGNOSTIC_REPORT_S are the base and translation-seed tables that store the definition and descriptive text of diagnostic reports, and the package reads them when resolving report context and report metadata. Query-based table creation relies on DBMS_SQL and DBMS_XMLGEN, with DUAL used for simple expression evaluation and XMLTYPE used to materialize and parse the generated result sets. PLITBLM is the PL/SQL internal table management package supporting the JTF_VARCHAR2_TABLE_4000 collection types passed to CREATE_FORM and CREATE_TABLE.

Usage Notes

JTF_DIAG_REPORT_FACTORY is normally invoked from within a diagnostic report's generation logic rather than directly by an end user. Typical call patterns are custom PL/SQL diagnostic scripts registered with the JTF diagnostics framework, concurrent programs that produce diagnostic output, and Oracle Forms or OA Framework diagnostic pages that build a report dynamically in response to a support or troubleshooting request. Because the package is AUTHID CURRENT_USER, a calling script must have execute privilege on the package and select privilege on the underlying JTF_DIAGNOSTIC_REPORT tables; the package is referenced by one other package within the framework. A common use of the CREATE_FOOTER function is to close a report after all sections, messages, tables, and trees have been added, ensuring the rendered output carries a consistent trailing region. The CREATE_TABLE overloads should be used with care in production, since any SQL query supplied is executed at report-generation time.