Search Results get_page_raw




Overview
Explore in AI Chat

Overview

SYS.OWA is the Oracle Web Agent (OWA) package, a foundational PL/SQL toolkit that provides the server-side runtime plumbing for Oracle's PL/SQL Web Toolkit. In Oracle EBS 12.1.1 and 12.2.2 it operates from the SYS schema and is classified under the ETRM API classification OTHER, reflecting its role as infrastructure rather than a functional business API. The package exposes the internals of the PL/SQL Agent (the mod_plsql-style gateway) that receives HTTP requests, invokes the appropriate stored procedure via a Database Access Descriptor (DCD), captures the generated HTML output, and returns it to the client.

The reference to "oas 10.9.10.82" in the source comments identifies the historical Oracle Application Server lineage of this code. The explicit comment blocks "Start of OAS specific helper procedures" and "End of OAS specific helper procedures" around GET_PAGE_CHARSET_CONVERT confirm that OWA carried forward OAS-era interfaces into subsequent EBS releases, providing backward compatibility for applications written against Oracle Application Server 10.9.x gateways. This is significant for EBS administrators diagnosing PL/SQL Web Toolkit behavior inherited from that platform generation.

The package declares PRAGMA RESTRICT_REFERENCES(owa, WNDS, RNDS, WNPS, RNPS), certifying that it writes no database state, reads no database state, writes no package state, and reads no package state, reinforcing its nature as a stateless request-processing layer. It also defines shared collection and scalar types (vc_arr, nc_arr, raw_arr) and constants such as NL_CHAR, SP_CHAR, BS_CHAR, HT_CHAR, and XP_CHAR used to normalize line and character handling.

Key Procedures and Functions

ETRM documents eleven callable units in this package:

  • INITIALIZE — Performs first-time setup when a DCD is invoked as the PL/SQL Agent starts, returning an integer status.
  • INIT_CGI_ENV — Populates the CGI environment variables and the cgi_var_name/cgi_var_val arrays (with num_cgi_vars) so the request context is available to the invoked procedure.
  • GET_LINE — Retrieves a single line of buffered output produced by the user's PL/SQL, returning the line and an out row count.
  • GET_PAGE — Returns the entire buffered page as an htp.htbuf_arr with an in-out row count.
  • GET_PAGE_CHARSET_CONVERT — An OAS-specific helper that returns the page buffer with character-set conversion applied, historically used by Oracle Application Server 10.9.x gateways.
  • GET_PAGE_RAW — The raw interface matching the HTP package, bypassing character-set conversion for byte-exact output.
  • RESET_GET_PAGE — Resets the page fetch buffer state between requests.
  • SET_USER_ID — Sets the agent's user_id value used for authentication context.
  • SET_PASSWORD — Sets the corresponding password credential for the agent session.
  • SET_TRANSFER_MODE — Establishes the transfer mode governing how output is passed back to the web listener.

These units are complemented by package-level variables for authentication scheme, protection realm, hostname, and IP address (owa_util.ip_address) that capture request-level security and client identity information.

Tables Accessed

ETRM records no tables referenced via APPS synonyms for SYS.OWA. This is consistent with the package's declared RESTRICT_REFERENCES pragmas and its architectural role: OWA manages in-memory CGI environment data, output buffers, and connection metadata rather than persistent application data. Any state it carries resides in package globals or in the arrays populated by INIT_CGI_ENV, not in database segments.

Usage Notes

SYS.OWA is invoked indirectly. When a browser request targets a DCD, the PL/SQL Agent calls INITIALIZE and INIT_CGI_ENV, executes the designated stored procedure, and then calls GET_LINE, GET_PAGE, or GET_PAGE_RAW to stream the generated response. EBS components that expose PL/SQL-based web pages—such as certain self-service interfaces, the Oracle Applications Framework (OAF) under specific listener configurations, and legacy HTML-based flows—rely on this mechanism. ETRM shows it referenced by two other packages, confirming it is consumed programmatically rather than called directly by forms or concurrent programs. Developers writing custom PL/SQL web code in EBS typically use HTP/HTF for markup and do not call OWA routines directly; OWA remains the underlying transport engine that administrators investigate when diagnosing output buffering, character-set conversion, or authentication-context issues, particularly where OAS 10.9.10.82-era behavior persists.