Search Results insert_overules




Overview

OKL_SETUPOVERULES_PUB is the public application programming interface package body for the Oracle Lease Management (OKL) setup override rules subsystem, part of the Oracle E-Business Suite (EBS) 12.1.1 / 12.2.2 ETRM application stack. The package exposes the externally callable entry points for creating, retrieving, and removing override rule definitions used during lease contract and quote setup. It follows the standard Oracle EBS PL/SQL API pattern: the "PUB" package acts as a thin public wrapper that validates API versioning and initialization flags before delegating business logic to its private counterpart, OKL_SETUPOVERULES_PVT. The header directive ($Header: OKLPSODB.pls 115.4 2004/04/13) indicates the package has been stable since the 11.5.x lineage and remains unchanged in the documented 12.2.2 metadata, meaning the override rules API surface is effectively frozen. The package is registered in the ETRM repository with owner APPS and an API classification of PUB, and it is referenced by one other package within the OKL module.

Key Procedures and Functions

  • GET_REC — Retrieves a single override rules record from the OKL_OPV_RULES_V view. It accepts a primary-key record structure and returns the fully populated override rule record along with a return status, an unexpected-error message buffer, and a NO_DATA_FOUND boolean. Internally it forwards the call to OKL_SETUPOVERULES_PVT.GET_REC, re-raises FND_API.G_EXC_UNEXPECTED_ERROR when the private layer signals an unexpected failure, and standardizes exception handling by emitting the G_UNEXPECTED_ERROR message via FND_MESSAGE.
  • INSERT_OVERULES — Public wrapper for the insert override rules process API. It accepts the standard EBS API parameters (API version, message list initialization flag, and the return status / message count / message data out parameters) together with three input record structures (option, overrides-event, and override-detail records) and returns the resulting override-detail record. This is the procedure surfaced when users search for "insert_overules."
  • DELETE_OVERULES — Public wrapper for the delete override rules process API, removing an existing override rule definition using the same EBS API convention for message handling and status reporting.

Tables Accessed

The documented metadata does not list base tables accessed via APPS synonyms. The GET_REC procedure references OKL_OPV_RULES_V, the override rules view that projects the underlying OKL override rule definition tables. Insert and delete operations performed by the corresponding private procedures ultimately persist to the override rule base tables beneath this view. Because no direct table list is published, consumers should treat OKL_OPV_RULES_V as the canonical documented data access point for read operations and rely on the private package layer for write semantics.

Usage Notes

OKL_SETUPOVERULES_PUB is an internal ETRM API and is not intended for direct ad hoc SQL invocation. It is typically called from Lease Management setup forms, from concurrent programs that seed or migrate override rule configurations, and from custom extensions that must programmatically create or remove override rules while honoring EBS API conventions — including setting p_init_msg_list to OKC_API.G_TRUE when the caller requires an isolated message stack, and unconditionally checking x_return_status for FND_API.G_RET_STS_UNEXP_ERROR rather than relying on propagated exceptions. Custom code should always call the PUB layer, never the PVT package, to preserve upgrade compatibility. Callers performing insert or delete operations should invoke FND_MSG_PUB.initialize and count/retrieve messages after each call.