Search Results fnd_help_documents




Overview

The FND_HELP_DOCUMENTS table is a core repository within the Oracle E-Business Suite (EBS) Application Object Library (FND) module. It serves as the master registry for all online help documents, including help topics, tutorials, and other user assistance content deployed across the application. Its primary role is to store metadata and references for help files, enabling the EBS help system to locate and serve the appropriate content to users based on context, language, and application. This table is owned by the APPLSYS schema and is a critical component for the proper functioning of the integrated Oracle Applications Help system in both EBS 12.1.1 and 12.2.2.

Key Information Stored

The table's structure is designed to manage help document metadata. Its primary key is the FILE_ID column, which uniquely identifies each help document record. A crucial aspect of its design is the foreign key relationship to the FND_LOBS table via this FILE_ID column. This relationship indicates that the actual binary content of the help document (e.g., HTML, text) is stored in a LOB (Large Object) within FND_LOBS, while FND_HELP_DOCUMENTS holds the descriptive and administrative attributes. While the specific column list is not detailed in the provided metadata, typical columns in such a registry would include the document's title, the application it belongs to, the language (to support NLS), creation dates, and potentially a status flag.

Common Use Cases and Queries

This table is primarily accessed by the EBS help engine and is less frequently queried directly by developers or administrators. Common use cases include troubleshooting help system issues, auditing deployed help content, or performing data fixes. For instance, to identify all help documents for a specific product or to find documents that may be orphaned from their LOB content. A sample query pattern to list help documents with their related LOB information would leverage the foreign key to FND_LOBS:

  • SELECT hd.file_id, hd.other_columns, lb.file_name FROM apps.fnd_help_documents hd, apps.fnd_lobs lb WHERE hd.file_id = lb.file_id;

Direct manipulation of data in this table is not standard practice and should be approached with extreme caution, as it can directly impact the user help experience.

Related Objects

As defined in the metadata, FND_HELP_DOCUMENTS has key relationships with several other FND tables. The FND_LOBS table is its most direct dependency, storing the physical document data. Conversely, the FND_HELP_TARGETS table holds a foreign key (FND_HELP_TARGETS.FILE_ID) referencing FND_HELP_DOCUMENTS. This relationship suggests that FND_HELP_TARGETS is used to map help documents to specific targets or contexts within the application, such as forms, functions, or descriptive flexfields. Therefore, the primary key of FND_HELP_DOCUMENTS (FILE_ID) is essential for maintaining referential integrity across the help subsystem.