Search Results okl_contracts_error

Overview

OKL_BP_RULES is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, associated with the Oracle Lease and Finance Management (OKL) and Enterprise Territory and Resource Management streams. It operates with AUTHID CURRENT_USER and is classified under the "OTHER" API category, indicating it is an internal utility package rather than a public, fully supported API. Its name and structure indicate that it serves as a rules-extraction component within the business-process (BP) layer of the leasing application, responsible for retrieving leasing rule definitions that govern how contracts and associated business processes behave.

The package is tightly coupled to Okl_Rule_Apis_Pvt, from which it derives its record types — including rulv_rec_type and rulv_disp_rec_type — and its internal working tables. This relationship confirms that OKL_BP_RULES is a thin wrapper or specialization layer built on top of the private rules API, exposing a focused extraction capability.

Key Procedures and Functions

The documented interface exposes a single procedure:

• EXTRACT_RULES — Retrieves rule information for a given leasing context. Callers supply an API version, an initialization message-list flag, identifying keys (a KHR identifier and a KLE identifier), and rule group/definition codes (RGD and RDF codes). The procedure returns the standard EBS API output parameters — return status, message count, and message data — together with a rules record (x_rulv_rec) populated from the private rules structures. The routine performs no DML against business entities; its role is to read and return rule data to the caller.

The package defines two error constants, G_ERROR ('OKL_CONTRACTS_ERROR') and G_UNEXPECTED_ERROR ('OKL_CONTRACTS_UNEXP_ERROR'). The former is the identifier most commonly surfaced when a contract-related failure is raised through this package.

Tables Accessed

Package metadata documents a reference to PLITBLM (via APPS synonyms). This is the PL/SQL interleaved table used by EBS messaging utilities — for example Okl_Api or FND_MSG_PUB — to accumulate and return the error/warning stack when an API call sets x_msg_count greater than zero. It is not a business data table; no OKL rule or contract tables are directly manipulated by the package, consistent with its read-only extraction design.

Usage Notes

Because this is an internal, private-layer package, it is not intended for direct invocation by external integrations. It is most likely called from within other leasing packages — particularly those handling contract rule validation, pricing, and business-process evaluation — and ultimately from the Lease Management forms and related concurrent programs when rule data must be materialized for a contract.

The search term "okl_contracts_error" is directly relevant here: OKL_BP_RULES declares G_ERROR as that exact string. When EXTRACT_RULES or a downstream caller encounters an unexpected condition, the error stack returned through x_msg_data and PLITBLM will typically be tagged with OKL_CONTRACTS_ERROR. Diagnosing such failures therefore begins by checking the message list populated during the API call, verifying that valid KHR and KLE identifiers and rule codes were passed, and confirming that the corresponding rule definitions exist. Customizations should avoid calling OKL_BP_RULES directly, since its signature and dependent private structures may change without notice between 12.1.1 and 12.2.2.