Search Results wpg_docload




Overview
Explore in AI Chat

Overview

WPG_DOCLOAD is an Oracle-supplied PL/SQL package owned by SYS and exposed to the E-Business Suite runtime through a PUBLIC synonym and an APPS-side grant. It is a core component of the Oracle HTTP Server / PL/SQL Gateway document-handling stack (the "WPG" prefix denotes the Web PL/SQL Gateway), and it underpins the file download mechanism used throughout EBS 12.1.1 and 12.2.2. When an EBS page must return a binary artefact to the browser — an XML publisher report output, an attachment retrieved from the file system, a generated spreadsheet, or a BLOB held in the database — the gateway invokes WPG_DOCLOAD to stream that content back to the client outside the normal HTML page buffer.

The package is classified in ETRM metadata as an OTHER API rather than a business-facing EBS API, reflecting its role as infrastructure rather than application logic. In Release 12.2.2 the documented owner appears as SYSTEM, while the underlying object remains SYS-owned. The package is VALID in both 12.1.1 and 12.2.2 and depends only on the STANDARD package, HTP, and itself, which confirms its low-level, self-contained position in the dependency chain.

Key Procedures and Functions

ETRM documents eight callable entry points. Their purposes are:

  • DOWNLOAD_FILE — the principal entry point. It signals to the PL/SQL Gateway that the current request is a file download and routes the response accordingly, bypassing normal page rendering.
  • GET_DOWNLOAD_FILE — retrieves the file currently registered for download, returning its content for streaming to the client.
  • GET_DOWNLOAD_BLOB — returns the download payload when the source content is a BLOB (for example a document stored in an EBS attachment or LOB table).
  • GET_DOWNLOAD_BFILE — returns the download payload when the source content is a BFILE, i.e. a file residing on the database server file system outside the database.
  • IS_FILE_DOWNLOAD — a predicate used to determine whether the current request context is a file download, allowing calling code to branch its behaviour.
  • GET_CONTENT_LENGTH — supplies the byte length of the download payload so the gateway can emit a correct Content-Length HTTP header.
  • Two further documented functions complete the eight-member interface; in practice they support the same download bookkeeping and content retrieval operations.

Tables Accessed

WPG_DOCLOAD does not read or write EBS application tables. Its documented dependencies are the Oracle-supplied packages DBMS_LOB, DBMS_SQL, OWA_UTIL, and DBMS_SYS_SQL, resolved through APPS synonyms in the EBS database. DBMS_LOB supplies LOB read operations for BLOB and BFILE payloads, DBMS_SQL and DBMS_SYS_SQL support dynamic SQL used to validate and prepare download requests, and OWA_UTIL provides the HTTP-oriented helper routines that format the gateway response. No EBS transactional or setup tables are referenced, which is consistent with its position as web-tier infrastructure.

Usage Notes

WPG_DOCLOAD is invoked indirectly rather than by application code. Typical invocation paths include Oracle Forms when a user downloads an attachment or a report output from the Forms client through the web listener, concurrent program output retrieval when a completed request's log or report file is fetched through the EBS interface, and Oracle XML Publisher or BI Publisher output retrieval when generated documents are streamed to the browser. Custom PL/SQL that uses the PL/SQL Gateway (mod_plsql / ORDS in 12.2) can also call WPG_DOCLOAD directly to emit a download, but this should be treated as advanced practice, since the package is owned by SYS and is not supported for direct modification.

Because the package sits beneath the gateway rather than inside the applications schema, it is versioned by the database and Oracle HTTP Server components. When download behaviour fails in EBS — for example attachments or report outputs return zero bytes or an HTTP error — WPG_DOCLOAD and its dependent DBMS_LOB and OWA_UTIL packages are appropriate first points of investigation, alongside the gateway configuration. The package is referenced by PUBLIC via its synonym, by HTP, and by itself; ETRM records zero EBS packages depending on it directly, confirming that its consumers are gateway and web-tier processes rather than application APIs.