Search Results rule_information

Overview

OKL_RULE_APIS_PUB is the public application programming interface for Oracle Enterprise Asset Management and Oracle Lease Management (OKL) contract rules, distributed with Oracle E-Business Suite 12.1.1 and 12.2.2 as part of the ETRM (Enterprise Contracts and Trade Management) product family. The package exposes a controlled, supported entry point for retrieving rule groups, rules, and the information segments associated with those rules against a contract. In EBS architecture terms, it is a "PUB" classified API, meaning its procedures are intended for external consumption by other modules, forms, and custom extensions. Internally it delegates to OKL_RULE_APIS_PVT, the private implementation package, as evidenced by the SUBTYPE declarations that inherit the record and table structures (rgpv_rec_type, rulv_rec_type, rulv_tbl_type, rulv_disp_rec_type) from the private layer. This separation ensures API stability while allowing Oracle to change private logic between releases.

Key Procedures and Functions

The ETRM metadata documents seven public program units. Their names, and by extension their purpose, are as follows:

• GET_CONTRACT_RGS — retrieves contract rule groups for a given contract header identifier (p_chr_id), contract line identifier (p_cle_id), or both, as well as an optional rule group code (p_rgd_code). It supports header-level and line-level rule group retrieval; a null header identifier returns line-level data, and a null line identifier returns header-level data.
• GET_CONTRACT_RULES — returns the rules belonging to a contract or to specific contract rule groups, allowing callers to enumerate all rule definitions attached to a contract.
• GET_RULE_INFORMATION — the procedure most relevant to the searched term "rule_information". It returns the information segment records for a rule, populating the display structure (rulv_disp_rec_type) with the name to be displayed for a rule information segment.
• GET_JTOT_OBJECT — returns the name and description for the JTOT (object type) identified by id1 and id2, used to render object references on the rule display.
• GET_RULE_DISP_VALUE — resolves the display value for an individual rule segment, converting stored values into user-readable text.
• GET_RULE_SEGMENT_VALUE — returns the raw segment value for a rule, distinct from the formatted display value returned by the preceding procedure.

Tables Accessed

The metadata excerpt does not enumerate the specific base tables referenced through APPS synonyms; those details reside in the private package OKL_RULE_APIS_PVT. In practice the public API surfaces data drawn from the OKL rule group and rule definition tables (such as OKL_RULE_GROUPS and OKL_RULES) and from contract header/line tables keyed by chr_id and cle_id. The record and table structures exposed as subtypes (rgpv, rulv) mirror those underlying rows, and the JTOT lookup resolves object type names via id1/id2 pairs rather than exposing raw foreign keys.

Usage Notes

OKL_RULE_APIS_PUB is normally invoked by Oracle lease and contract entry forms when displaying rule groups and rule segments to a user, and by concurrent programs or custom PL/SQL that need rule metadata without touching the private layer. Four other packages reference it, confirming it is called both from the base application and from dependent APIs. Because it is a PUB API, developers should call OKL_RULE_APIS_PUB rather than OKL_RULE_APIS_PVT; the public wrapper handles standard EBS error messages (OKL_CONTRACTS_ERROR, OKL_CONTRACTS_UNEXP_ERROR) and maintains upward compatibility across 12.1.1 and 12.2.2 patch levels. Callers should supply either p_chr_id, p_cle_id, or both, depending on the contract level at which the rule group was attached.