Search Results okc_doclist_pvt




Overview
Explore in AI Chat

Overview

OKC_DOCLIST_PVT is a private PL/SQL package in the APPS schema that supports the document list feature of Oracle Contracts (OKC) within Oracle E-Business Suite 12.1.1 and 12.2.2. The document list provides users with a personalized view of contracts they have recently accessed or explicitly bookmarked. This package implements the persistence layer behind that view, managing the entries that appear in the Recent Documents and Bookmarks regions of the Contracts workbench and related forms.

The package is classified as a PVT (private) API, indicating it is not intended for direct customer invocation. Its public counterpart, OKC_DOCLIST_PUB, exposes the supported interface and internally delegates to OKC_DOCLIST_PVT for the underlying data manipulation. The package depends on several shared OKC components, including FND_API for the standard API error and message handling framework, OKC_API, OKC_UBL_PVT, and direct references to the OKC_K_HEADERS_B and OKC_K_HEADERS_TL contract header tables, as well as OKC_USER_BINS.

Key Procedures and Functions

The documented interface consists of three procedures:

  • ADD_RECENT — Records a contract as recently accessed by the current user. It inserts or updates the corresponding entry in the user's document list so the contract appears in the Recent Documents list. This is the routine invoked when a user opens a contract through the Contracts forms or workbench.
  • ADD_BOOKMARK — Creates a bookmark entry for a contract on behalf of the current user. It persists the user's explicit intent to retain the contract in a personal list for quick retrieval, independent of access recency.
  • DELETE_ENTRY — Removes an existing document list entry, whether created through recent-access tracking or as a bookmark. It is used when a user clears an item from the list or when the system purges stale entries.

No parameter lists are invented here; the documented metadata identifies the procedures by name only. All three operate against the current user context, which is derived from the EBS session rather than passed as an explicit argument.

Tables Accessed

  • OKC_K_HEADERS_B — The base contract header table. It is referenced to validate the contract identifier and to obtain core header attributes for the document list entry.
  • OKC_K_HEADERS_TL — The translation table for contract headers, providing the user-facing contract name or title displayed in the document list.
  • OKC_USER_BINS — The "user bins" table that stores per-user classification data such as bookmarks and recent-access markers. This is the primary storage for the entries managed by ADD_RECENT, ADD_BOOKMARK, and DELETE_ENTRY.
  • PLITBLM — A PL/SQL index-by table type referenced by the package. It is not a physical table but a PL/SQL construct used internally for bulk processing.

Usage Notes

OKC_DOCLIST_PVT is invoked indirectly through OKC_DOCLIST_PUB, the public wrapper that the Contracts forms and the Contracts workbench call when a user accesses or bookmarks a contract. It may also be referenced by custom extensions that require document list behavior, provided they route through the public API to preserve the supported contract. Because the metadata confirms it is referenced by OKC_DOCLIST_PUB and by itself, developers should treat it as an implementation detail and never call it directly from custom code. Direct invocation bypasses the validation and error-handling conventions enforced by the public layer and risks inconsistency with future patches. As with all OKC private packages, the interface may change without notice between 12.1.1 and 12.2.2 maintenance releases.