Search Results lock_tl_row

Overview

The APPS.FND_DOCUMENTS_PKG package is the core PL/SQL API for managing document and attachment records within Oracle E-Business Suite, spanning both 12.1.1 and 12.2.2. It encapsulates the business logic required to create, maintain, and delete entries stored in the Foundation documents schema, which underlies the "Attachments" feature available throughout EBS forms and self-service applications. The package abstracts the complexity of the multi-table document model, including the base document definition, translated (TL) descriptive text, long text and long raw content storage, short text attributes, and Large Object (LOB) handling. Its header trace ($Header: AFAKADCS.pls 120.2 ...) indicates a long-standing, versioned component of the Foundation product family. Because the package is reported as referenced by 24 other packages, it functions as a shared infrastructure dependency rather than an application-specific utility. The API classification is OTHER, reflecting that it is an internal Foundation API rather than a public, fully supported integration interface.

Key Procedures and Functions

The documented package exposes eight procedures:

• INSERT_ROW — Inserts the primary document record into the base documents table, populating identifiers, datatype, category, security, storage, usage, date-range, descriptive, attribute, and file/URL columns.
• INSERT_TL_ROW — Inserts the translated description row for a document in a specified language, supporting the multi-language (TL) model.
• LOCK_ROW — Obtains a row-level lock on the base document record, used to serialize concurrent modifications.
• LOCK_TL_ROW — Obtains a row-level lock on the translated document row; this is the procedure users typically target when searching for lock_tl_row.
• UPDATE_ROW — Updates the base document record.
• UPDATE_TL_ROW — Updates the translated description for a document.
• DELETE_ROW — Removes a document record and its associated data.
• ADD_LANGUAGE — Adds a new language translation row for an existing document.

The procedures follow the standard EBS API conventions, accepting WHO columns (creation/update audit fields), a X_Rowid parameter, and standard attribute columns.

Tables Accessed

Through APPS synonyms, the package reads and writes the following Foundation tables:

• FND_DOCUMENTS, FND_DOCUMENTS_S — base document definitions.
• FND_DOCUMENTS_TL — translated descriptive text.
• FND_DOCUMENTS_SHORT_TEXT, FND_DOCUMENTS_SHORT_TEXT_S — short text content.
• FND_DOCUMENTS_LONG_TEXT, FND_DOCUMENTS_LONG_TEXT_S — long text content.
• FND_DOCUMENTS_LONG_RAW, FND_DOCUMENTS_LONG_RAW_S — binary/raw content.
• FND_ATTACHED_DOCUMENTS — links documents to owning entities.
• FND_LOBS, FND_LOBS_S — large object storage for file uploads.
• FND_LANGUAGES — language validation.
• DUAL — utility select context.

Usage Notes

The package is invoked primarily by the Oracle Forms-based Attachments framework, by concurrent programs that migrate or manage documents, and by other PL/SQL packages (24 documented dependents). Custom code should generally favor the public Attachments APIs or DMT-style interfaces, but direct calls to FND_DOCUMENTS_PKG procedures such as LOCK_TL_ROW, INSERT_ROW, and UPDATE_TL_ROW are common when building custom attachment management routines. Callers must pass valid WHO audit parameters and observe the entity's multi-language model to avoid orphaned TL rows.