Search Results okl_rule_extract_pub




Overview

OKL_RULE_EXTRACT_PUB is a public PL/SQL package in the APPS schema that belongs to the Oracle Enterprise Trading and Risk Management (ETRM) application family — specifically the Oracle Lease and Finance Management (OKL) module. Its role is to expose extraction services for the rule metadata that drives OKL's rule-based processing engine. In Oracle EBS 12.1.1 and 12.2.2, the OKL rule framework underpins contract and lease lifecycle behaviors such as pricing, accounting generation, and rule configuration. The package provides a public API surface through which callers can retrieve the definitions, sub-class rule groups, and metadata associated with rules, without exposing the private implementation package OKL_RULE_EXTRACT_PVT that performs the underlying work.

As a PUB-classified API, OKL_RULE_EXTRACT_PUB is intended for supported external invocation. The package is documented as VALID and is referenced by a companion wrapper, OKL_RULE_EXTRACT_PUB_W, which is the form-level or concurrent-program-facing layer. This two-tier design — public package, private package, and wrapper — is a standard Oracle EBS pattern that separates the callable interface from internal logic and grants flexibility for maintenance and versioning.

Key Procedures and Functions

The package exposes four documented entry points:

  • GET_SUBCLASS_RGS — Retrieves the rule groups (RGs) associated with a given subclass. This allows callers to enumerate the rule groupings applicable to a particular contract or entity subclass within the OKL rule hierarchy.
  • GET_RG_RULES — Returns the rules belonging to a specified rule group. This supports callers that need to walk from a rule group down to its constituent rule definitions.
  • GET_RULE_DEF — Retrieves the definition of an individual rule. This supplies the structural detail of a rule used by downstream processing or diagnostic routines.
  • GET_RULES_METADATA — Returns metadata describing rules in aggregate. This is the broadest accessor, intended for callers that need descriptive or configuration-level information about the rule set as a whole.

Each procedure function serves the extraction purpose implied by the package name: callers read rule configuration rather than modify it.

Tables Accessed

The ETRM dependency metadata records references to three OKC contract tables via APPS synonyms:

  • OKC_K_HEADERS_B — the contract header base table, providing the top-level contract context for rule extraction.
  • OKC_K_LINES_B — the contract line base table, supplying line-level context relevant to rules applied per line.
  • OKC_K_PARTY_ROLES_B — the contract party role base table, providing party and role context that influences rule applicability.

The package also depends on OKC_API, OKL_API, and OKL_RULE_EXTRACT_PVT. These references establish that rule extraction is resolved against the underlying OKC contract structure and the OKL private rule engine.

Usage Notes

OKL_RULE_EXTRACT_PUB is typically invoked indirectly. The documented reference from OKL_RULE_EXTRACT_PUB_W indicates that OKL forms or concurrent programs call the wrapper, which in turn calls the public package. Custom development should target the PUB package rather than the PVT package, observing the standard Oracle EBS rule that private packages are unsupported for direct use. Because the procedures are read-only extractors, invocation does not commit rule configuration changes; callers should treat returned data as reference metadata for validation, display, or rule evaluation. All calls are made in the APPS schema context with the standard EBS security and synonym conventions.