Search Results create_page

Overview

OKI_ALERT_UTIL_PUB is the public interface package for the OKI Alert Utilities component of Oracle E-Business Suite. Declared with AUTHID CURRENT_USER, it executes with the privileges of the invoking schema rather than its owner, which is consistent with its role as a shared, cross-module utility layer. The package is an API-classified (PUB) wrapper that exposes a set of HTML-generation primitives used to render alert and notification output in the Oracle Contracts (OKI) module family. Its constituent procedures emit markup fragments — rows, cells, tables, headers, breadcrumbs, and pagination — allowing callers to construct structured, printable alert pages without hand-coding HTML. The package also manages the output stream itself, providing explicit open and close operations around a named file, which indicates that alert output is written to disk rather than streamed directly to a browser session. The documented procedures number thirteen, and no other package references OKI_ALERT_UTIL_PUB, placing it at the leaf of the dependency graph: it is consumed directly by forms, concurrent programs, or custom code rather than by peer APIs. The header comment identifies it as the "Piblic [sic] interface for OKI ALERT UTILITIES," and the revision history shows an initial version by brrao in December 2001 and a subsequent header and dbdrv correction in April 2002, reflecting the package's long stability across the 11i and R12 releases, including 12.1.1 and 12.2.2.

Key Procedures and Functions

• MYPRINT — Writes a string to the current output stream; the low-level emission primitive used by the other procedures.
• REPORTHEADERCELL — Emits a header cell for a report table, taking a string and a reference value.
• POPULATECELL — Emits a data cell with alignment, hyperlink, CSS class, and width attributes.
• SPACECELL — Emits a spacer or padded cell, accepting spacing, string, alignment, link, class, and width arguments.
• START_ROW / END_ROW — Open and close a table row element, bracketing one or more cell calls.
• START_TABLE / END_TABLE — Open and close a table element; START_TABLE accepts alignment, cellpadding, and border defaults, and END_TABLE accepts a run date.
• CREATE_CRUMB — Generates a breadcrumb navigation element from a title, link, and flag.
• CREATE_MAINHEADER — Generates the main page header block from a title and run date.
• CREATE_PAGE — Initialises a new output page given a title; this is the entry point most commonly associated with the search term "create_page."
• SET_OUTPUT_STREAM — Opens an output stream against a supplied file name, returning a Boolean success indicator (documented as 1 for success, 0 for failure).
• END_OUTPUT_STREAM — Closes the output stream opened by SET_OUTPUT_STREAM.

Tables Accessed

The ETRM metadata documents no table references for OKI_ALERT_UTIL_PUB through APPS synonyms. This is consistent with the package's design: it is a pure presentation utility that formats strings supplied by its callers and writes them to a file-based output stream. It neither reads nor writes application data directly, and therefore requires no DML privileges or table dependencies. Any data appearing in the generated alert pages is retrieved by the calling program and passed into the cell and header procedures as bind arguments.

Usage Notes

Typical invocation follows a strict sequence. The caller first invokes SET_OUTPUT_STREAM to establish a target file, then CREATE_PAGE to begin the document, followed by CREATE_MAINHEADER and CREATE_CRUMB for the page furniture. The body of the alert is assembled with START_TABLE, START_ROW, REPORTHEADERCELL, POPULATECELL, SPACECELL, END_ROW, and END_TABLE in nested order. The document is finalised with END_TABLE (passing the run date) and END_OUTPUT_STREAM. Because the package is AUTHID CURRENT_USER, the invoking schema must hold the necessary filesystem directory privileges, which in R12 is normally granted through a database DIRECTORY object and UTL_FILE. In EBS 12.1.1 and 12.2.2 the package is generally called from concurrent programs and server-side PL/SQL in the Contracts and Alerts flows rather than from client-side forms code, since output is written to the middle tier or database server filesystem. Custom code should call only the documented PUB procedures and should not reference the underlying private utilities package directly.