Search Results add_bookmark

Overview

OKC_DOCLIST_PUB is the public (PUB) API package belonging to the Oracle Contracts (OKC) module of Oracle E-Business Suite, release 12.1.1 and 12.2.2. Its business purpose is to maintain the personal document lists — commonly called bins — that each user sees when working with contracts. These lists provide the "recent documents" and "bookmarked documents" features exposed through the Contracts workbench and related contract search windows. The package body wraps a private implementation package, OKC_DOCLIST_PVT, and exposes a small, stable public interface so that forms, concurrent programs, and customer extensions can manipulate user bins without accessing the underlying OKC_USER_BINS table directly. All three documented entry points operate on a single user's bin entries and return the standard concurrent-style OUT parameters: x_return_status, x_msg_count, and x_msg_data. The header comment identifies the source file as OKCPUBLB.pls, version 120.0, last touched in May 2005, which is consistent with the long-stable nature of this API across the 12.1.1 and 12.2.2 code lines.

Key Procedures and Functions

Three procedures are documented in the ETRM metadata:

• ADD_RECENT — Inserts a "recent" row (type R) into the user bins table, capturing the contract identifier, contract number, contract type, number modifier, short description, and the program that generated the entry. The body declares the procedure with PRAGMA AUTONOMOUS_TRANSACTION so the insert commits independently of the caller's transaction, ensuring that merely viewing a contract records it in the user's recent list even if the surrounding form transaction is rolled back.
• ADD_BOOKMARK — Adds a "bookmark" row (type B) to the same table, allowing a user to explicitly flag a contract for later retrieval. Together with ADD_RECENT it forms the two write operations that populate a user's bin.
• DELETE_ENTRY — Removes a specific row from the user's bin. This is the entry point a user hits when clearing a recent item or removing a bookmark. It is the procedure most relevant to the search term "delete_entry".

Each procedure delegates to the corresponding routine in OKC_DOCLIST_PVT after passing the input parameters and returns the standard status triplet. The published parameter lists are intentionally not reproduced here; the private package owns the detailed signatures.

Tables Accessed

• OKC_USER_BINS — The primary target of all three procedures. This table stores the per-user bin entries (type R for recent, type B for bookmark) along with the contract reference, program name, and creation metadata.
• OKC_K_HEADERS_B — The contract header base table, read to validate and supply the contract identifier, contract number, type, and number modifier stored against a bin entry.
• OKC_K_HEADERS_TL — The translated header table, read to obtain the short description displayed for a contract in the user's list.

All three are referenced through APPS synonyms, so no direct schema qualification is required in the package body.

Usage Notes

OKC_DOCLIST_PUB is typically invoked from the Oracle Contracts forms layer. When a user opens a contract, the form calls ADD_RECENT; when the user clicks the bookmark control, the form calls ADD_BOOKMARK; and when the user clears an entry, the form calls DELETE_ENTRY. The AUTONOMOUS_TRANSACTION pragma on ADD_RECENT is significant for custom code — developers must not rely on the caller's rollback undoing a recent-document insert. Extensions should call the PUB package rather than the PVT package to remain upgrade-safe. The ETRM metadata records zero packages referencing OKC_DOCLIST_PUB, confirming it is a leaf API consumed by the application rather than by other PL/SQL packages. Its compact interface and stable history make it a low-risk integration point in both 12.1.1 and 12.2.2.