Search Results hr_adi_document_api




Overview
Explore in AI Chat

Overview

The APPS.HR_ADI_DOCUMENT_API package body provides the programmatic interface for managing documents attached to Oracle Human Resources (HRMS) entities within Oracle E-Business Suite. "ADI" refers to the Advanced Data Interchange/document attachment subsystem used by Oracle HRMS to store and retrieve external files, correspondence, and supporting documentation linked to business objects. The package encapsulates the create, update, delete, search, and text-extraction operations that surround the underlying LOB (Large Object) storage facility, shielding callers from the low-level mechanics of writing binary content into the database.

The package carries the standard Oracle HR API conventions, including a p_validate parameter that permits callers to exercise the business logic without committing changes, and hr_utility.set_location instrumentation for traceability. Its embedded header string (hrlobapi.pkb 115.3) indicates a long-standing, stable component of the HRMS stack that has been maintained across multiple releases, including 12.1.1 and 12.2.2.

Key Procedures and Functions

The ETRM metadata documents five public program units:

  • CREATE_DOCUMENT — Creates a new document record and returns the generated file identifier. It accepts an effective date, MIME type, file name, and document type, and passes this information to the underlying insert routine. The procedure issues a savepoint at entry and rolls back to it when validation-only mode is requested, ensuring no persistent data is written during a dry run.
  • UPDATE_DOCUMENT — Modifies the attributes of an existing document, such as its file name, content type, or type classification, while preserving the associated LOB content and identifier.
  • DELETE_DOCUMENT — Removes a document record and its associated content from the repository, subject to the same validation semantics as the other maintenance procedures.
  • SEARCH_FOR_TERM — Searches document content or metadata for a specified term, supporting retrieval and lookup scenarios where users need to locate attachments by keyword.
  • DOCUMENT_TO_TEXT — Extracts textual content from a stored LOB document, enabling downstream processing, indexing, or display of document contents in text form.

All maintenance procedures follow a consistent pattern: savepoint, core DML delegation, optional hr_api.validate_enabled exception to trigger rollback and null out output arguments, and location-based tracing.

Tables Accessed

The package operates against the FND_LOBS table through an APPS synonym. FND_LOBS is the Oracle Application Object Library repository for large object data, storing the actual binary file content, the file name, and the MIME/content type associated with each uploaded document. The API writes new LOB rows on CREATE_DOCUMENT, updates metadata on UPDATE_DOCUMENT, and removes rows on DELETE_DOCUMENT. The package also references DBMS_LOB, the Oracle-supplied PL/SQL package used to manipulate LOB locators, read content in chunks, and support the text-extraction logic behind DOCUMENT_TO_TEXT and SEARCH_FOR_TERM. Document type and effective date values are validated against HRMS reference data as part of the standard API validation sequence.

Usage Notes

HR_ADI_DOCUMENT_API is classified as an API and is invoked primarily from Oracle HRMS forms and self-service pages when users attach documentation to person, assignment, or applicant records. It is also called from custom PL/SQL when developers need to programmatically register documents — for example, loading scanned correspondence or importing external files during data migration. Because the package is a documented API, direct DML against FND_LOBS is discouraged; all access should route through these procedures to preserve validation, auditing, and rollback behavior. The metadata indicates the package is referenced by one other package, confirming its role as a reusable service layer rather than an entry point exposed directly to end users. Callers should always supply p_validate => true during testing to exercise validation logic before committing production data.