Search Results construct_get_url

Overview

FND_GFM is the Generic File Manager (GFM) PL/SQL package in the Oracle E-Business Suite Applications schema (APPS). It provides the server-side foundation for uploading, storing, retrieving, authorizing, and purging large binary objects (LOBs) managed by the GFM cartridge and exposed through Oracle EBS Forms and web-based interfaces. The package abstracts the mechanics of the underlying LOB storage so that callers do not need to interact directly with FND_LOBS or the HTTP cartridge protocol. It is classified in ETRM as an OTHER API, reflecting its role as an internal infrastructure service rather than a business-flow public API.

The package header carries the revision identifier $Header: AFGFMS.pls 120.10.12000000.1 2007/01/18, indicating a long-lived, stable module within the Applications Technology stack. Its central concern is the generation and validation of short-lived access keys that authorize a browser session to invoke the GFM cartridge against a specific file, combined with helper routines for constructing the URLs that carry those keys.

Key Procedures and Functions

ETRM documents 36 procedures and functions. The core authorization and URL-building routines include:

• AUTHENTICATE — Validates a previously issued access key, optionally scoped to a specific file identifier, and returns a Boolean result.
• AUTHORIZE — Generates an authorized access key valid for approximately one day. The key is accepted by the GFM cartridge as proof of authorization for the indicated operation; for downloads the file identifier is supplied, and for uploads it is passed as NULL.
• CONSTRUCT_DOWNLOAD_URL2 — Builds the download URL presented to a client browser. It depends on the caller supplying the GFM agent value (the agent name with a trailing slash) and the file identifier, and optionally supports purging the LOB once it has been viewed.
• CONSTRUCT_DOWNLOAD_URL, CONSTRUCT_UPLOAD_URL, CONSTRUCT_GET_URL, CONSTRUCT_RELATIVE_GET — Variants that construct the respective download, upload, and GET-style URLs, including relative forms.
• DISPATCH — Entry point used by the cartridge or PL/SQL agent to route an incoming request to the appropriate GFM operation.

File manipulation and lifecycle routines include FILE_CREATE, FILE_CLOSE, FILE_WRITE, and FILE_WRITE_LINE for assembling LOB content, together with GET_FILE_ID, CONFIRM_UPLOAD, and WAIT_FOR_UPLOAD for coordinating asynchronous upload completion. The DOWNLOAD routine performs the retrieval operation. Housekeeping functions include PURGE, PURGE_SET, and PURGE_EXPIRED, which remove expired LOB records and their access keys, and a TEST routine used for diagnostic verification.

Tables Accessed

Through APPS synonyms, FND_GFM reads and writes the GFM repository tables. FND_LOBS, FND_LOBS_DOCUMENT, FND_LOBS_DOCUMENTPART, and FND_LOBS_S hold the LOB data, its document metadata, its partitioned segments, and its sequence values. FND_LOB_ACCESS stores the generated access keys and their expiry information, supporting the AUTHENTICATE and AUTHORIZE operations. FND_MIME_TYPES supplies the media type of each stored file. FND_USER identifies the application user associated with an upload or download, and FND_FORM_FUNCTIONS links GFM operations to the function security model. The package also depends on the standard server-side utilities DBMS_ALERT, DBMS_LOB, UTL_RAW, OWA_UTIL, HTP, and PLITBLM for alerting, LOB manipulation, raw conversion, and HTML output generation.

Usage Notes

FND_GFM is not typically called directly from end-user forms; it is invoked by Oracle EBS Forms-based attachments and file-upload features, by concurrent programs that process LOB content, and by the GFM cartridge through the DISPATCH entry point. Custom code that needs to offer a file download or upload to a browser should call the CONSTRUCT_*_URL routines rather than assembling URLs manually, because those routines embed the AUTHORIZE-generated access key and enforce the cartridge URL syntax. The caller must still know the web server location and PL/SQL agent name, and must pass the gfm_agent value with a trailing slash. The user is referenced by 15 other packages, confirming its role as shared infrastructure. When implementing download features, ensure the purge_on_view behavior is chosen deliberately, as it marks the LOB expiration for near-term purge after the transfer.