Search Results oke_api




Overview
Explore in AI Chat

Overview

OKE_API is the foundational public API package for the Oracle E-Business Suite Oracle Contracts (OKE) module, which governs the creation, revision, and lifecycle management of contract and project-related agreements. In Oracle EBS 12.1.1 and 12.2.2, OKE_API serves as the central programmatic entry point that other contract sub-APIs and integration routines rely upon. Its primary role is to provide a consistent, reusable framework for API processing: initializing and managing the PL/SQL message list, establishing savepoint-based transactional boundaries, standardizing error handling, and exposing common utility routines consumed by the broader Contracts API layer. Rather than performing a single business transaction, OKE_API functions as shared infrastructure — an API scaffolding package — that enforces uniform behavior across the many procedures that create, modify, and validate contracts and contract deliverables. This design ensures consistent error reporting, message propagation through FND_MSG_PUB, and controlled commit/rollback behavior across the module. The package is owned by the APPS schema and is documented as a valid, API-classified object in the ETRM repository.

Key Procedures and Functions

The documented package exposes six procedures, each supporting the API lifecycle and utility pattern:

  • INIT_MSG_LIST — Initializes the global message list prior to an API call, ensuring that all subsequent messages (errors and warnings) are captured and retrievable by the calling program.
  • START_ACTIVITY — Marks the beginning of an API activity and establishes the transactional context, typically by setting a savepoint so that the operation can be safely rolled back on failure.
  • HANDLE_EXCEPTIONS — Centralizes exception processing, translating Oracle and application errors into standardized messages placed on the message list and determining the appropriate error state for the caller.
  • END_ACTIVITY — Concludes the API activity, finalizing the transactional boundary and reconciling success or failure against the savepoint established in START_ACTIVITY.
  • SET_MESSAGE — A utility that places a formatted message (by name or token) onto the shared message list for propagation to the user interface or calling process.

These public routines are invoked internally by OKE_API itself, forming the backbone of the module's error-handling and transaction discipline.

Tables Accessed

The documented dependency metadata lists DBMS_TRANSACTION as the primary referenced object. Because DBMS_TRANSACTION is the Oracle-supplied package that controls savepoints, commits, and rollbacks, its inclusion confirms that OKE_API manages transactional control rather than directly manipulating Contracts application tables. By wrapping savepoint and transaction logic behind START_ACTIVITY and END_ACTIVITY, OKE_API allows the higher-level contract APIs to concentrate on business data while delegating atomicity and recovery concerns to this shared layer. The package likewise depends on the standard Oracle API framework packages — FND_API, FND_MESSAGE, and FND_MSG_PUB — for message creation and list management.

Usage Notes

OKE_API is not typically invoked directly by end users or from standard Oracle Contracts forms; instead it is consumed internally by the Contracts APIs and, per ETRM metadata, is referenced by 41 other packages in the APPS schema. It also contracts no inbound references from database objects other than those frameworks, confirming its role as a service layer. Custom integrations and extensions that need to create or maintain contract data in Oracle EBS should invoke the higher-level OKE contract APIs (for example, the service contract and project contract APIs), which in turn rely on OKE_API for message-list initialization, savepoint handling, and exception translation. When developing custom contract transactions, developers should follow the same convention: call INIT_MSG_LIST and START_ACTIVITY before performing work, and END_ACTIVITY or HANDLE_EXCEPTIONS afterward, so that error state and transaction control remain consistent with standard FND_API usage patterns across Oracle EBS 12.1.1 and 12.2.2.