Search Results okl_api




Overview
Explore in AI Chat

Overview

OKL_API is the foundational utility package body within the Oracle Lease and Finance Management (OKL) module of Oracle E-Business Suite, residing in the APPS schema. As its name implies, it is not a business-entity API in the conventional sense (such as OKL_CONTRACT_PUB or OKL_ASSET_PUB) but rather a shared service layer that centralizes the common programming primitives required by every other OKL API in the application. Its principal responsibilities include standardized message-list initialization, activity bracketing for savepoint and transaction control, uniform exception handling, error-message publication, and retrieval of customer baseline data. Because it is referenced by 1197 other packages, OKL_API functions as the plumbing on which the majority of the leasing and financing application's PL/SQL stack depends. The package is designated VALID in both the 12.1.1 and 12.2.2 releases, and the documented metadata confirms that it is a core API object rather than a private implementation detail.

Key Procedures and Functions

The documented package exposes seven procedures and functions, each providing a reusable service to calling code:

  • INIT_MSG_LIST — Initializes the FND message list for the current session, ensuring that subsequent API calls have a working message stack. It is normally invoked at the start of a top-level API call before any validation or DML.
  • START_ACTIVITY — Marks the beginning of an activity block, typically establishing a savepoint or logical unit of work so that the work performed can be committed or rolled back as a unit.
  • END_ACTIVITY — Closes the activity opened by START_ACTIVITY, releasing the savepoint or completing the logical boundary.
  • HANDLE_EXCEPTIONS — Provides the standard exception handler invoked in the WHEN OTHERS clause of OKL APIs. It records the error, adds it to the message list, and returns control in a consistent manner.
  • SET_MESSAGE — Publishes a user-facing message to the FND message stack, allowing APIs to report success, warnings, or validation failures uniformly.
  • GET_CUSTOMER_BASELINE — Retrieves customer baseline information used for reference and comparison during contract or lease processing.

The metadata does not document public parameter lists, and none should be assumed.

Tables Accessed

The documented dependency list identifies DBMS_TRANSACTION as the sole referenced object, accessed through an APPS synonym. This confirms that START_ACTIVITY and END_ACTIVITY implement transaction and savepoint semantics rather than application-table DML. All application data access is delegated to the higher-level OKL APIs that call OKL_API. The package also depends on the Oracle Applications foundation packages FND_API, FND_LOOKUPS, FND_MESSAGE, and FND_MSG_PUB, which supply message-list creation, lookup validation, and message publication. Notably, OKL_API is not referenced by any database object, indicating it is invoked exclusively from PL/SQL code rather than from triggers or database-level constructs.

Usage Notes

OKL_API is invoked in every layer of the OKL application: from the leasing forms, from concurrent programs that process contracts and assets, and from custom extensions built on top of the standard APIs. The canonical invocation pattern is to call INIT_MSG_LIST first, then START_ACTIVITY to bracket the work, execute business logic, call SET_MESSAGE to report outcomes, and finally END_ACTIVITY or HANDLE_EXCEPTIONS depending on whether the operation succeeded or failed. Developers extending Oracle Lease and Finance Management should adopt this same pattern rather than writing bespoke error handling, because the FND message stack and transaction savepoints it manages are relied upon by the 1197 dependent packages. Because it is a public APPS object with a stable interface across 12.1.1 and 12.2.2, it is safe to reference directly from custom code, though Oracle's standard practice of wrapping calls within the caller's own message-list lifecycle should be observed.