Search Results delete_doc

Overview

FND_HELP is the Oracle E-Business Suite foundation package that underpins the embedded help infrastructure. Its principal business function is to resolve and deliver context-sensitive and system-wide help content to the user interface, and to provide a programmatic search facility across help documents. The package is declared with AUTHID CURRENT_USER and exposes a small, stable public API that Forms, the Oracle Applications Framework (OAF), and custom components use to launch help without hard-coding file paths or repository locations. Within the 12.1.1 and 12.2.2 releases, FND_HELP abstracts two distinct help delivery models: the traditional HTML help system and the later help technologies used for the consolidated help repository. The package is classified as an OTHER API in the ETRM metadata, meaning it is a utility package rather than a business-entity API, and it is referenced by four other packages within the application schema.

Key Procedures and Functions

• GET_URL — Returns the URL for a help document based on a requested target. It accepts an application short name, a help target or file identifier, and switches controlling whether the full help system or an individual document is requested, whether the target is a target name or a filename, and whether context-sensitive content is displayed.
• GET — Resolves a help target path into a GFM-compliant file identifier. It returns a boolean success indicator and emits the file identifier through an OUT parameter.
• HELP_SEARCH — Implements the help document search and returns an array of matching links. It is intended for reuse by other components wishing to include help documents in their own search results.
• LOAD_DOC — Loads a help document into the repository or retrieval layer.
• LOAD_TARGET — Loads a help target definition used to resolve context-sensitive help requests.
• CULL_ROW — Removes obsolete or superseded help rows during maintenance of the help repository.
• DELETE_DOC — Deletes a help document and its associated records.

Tables Accessed

The package reads and maintains several foundation tables through APPS synonyms. FND_HELP_DOCUMENTS and FND_HELP_TARGETS store the help documents and the target-to-document mappings that drive context-sensitive resolution. FND_LANGUAGES provides the installed language definitions required to build language-specific URLs and paths. FND_LOBS stores large binary help artifacts, while UTL_I18N supports character-set and locale conversion. DBMS_SESSION and DBMS_SQL supply dynamic SQL and session-level context, and DUAL is used for trivial scalar queries.

Usage Notes

FND_HELP is normally invoked indirectly. Oracle Forms calls into it when a user requests window-level or field-level help, and OAF regions use it to render help links. Developers embedding help in custom forms, concurrent programs, or Java components call GET_URL to obtain a valid link rather than constructing paths manually. HELP_SEARCH may be called from custom search pages to fold help content into application-wide search. Because the package is not a business API and its functions depend on repository data, direct DML against the underlying help tables should be avoided in favor of the documented procedures such as LOAD_DOC, LOAD_TARGET, CULL_ROW, and DELETE_DOC.