Search Results okl_case_util_pvt




Overview
Explore in AI Chat

Overview

OKL_CASE_UTIL_PVT is a private (PVT) PL/SQL utility package in the Oracle E-Business Suite Lease Management (OKL) application, owned by the APPS schema. It provides internal service routines used to create and manage case records associated with lease and contract objects. As an AUTHID CURRENT_USER package, it executes with the privileges of the calling session, which is the standard convention for ETRM private APIs that are invoked only from within the application's own PL/SQL stack.

The package is not intended as a public integration point. It is one of two internal packages that reference it, and its single documented entry point is designed to be called by higher-level OKL business logic rather than by external custom code. The package name and header comment (OKLRCUTS.pls) indicate it belongs to the Lease Management "RC" (case) utility family.

The package declares global message constants that drive the standard ETRM error-handling framework. The constant G_REQUIRED_VALUE is defined as 'OKL_REQUIRED_VALUE', which corresponds directly to the search term okl_required_value. This message identifies a mandatory parameter that was not supplied by the caller. Additional constants include G_INVALID_VALUE, G_UNEXPECTED_ERROR, and the token constants G_COL_NAME_TOKEN, G_COL_NAME1_TOKEN, G_COL_NAME2_TOKEN, G_PARENT_TABLE_TOKEN, G_SQLERRM_TOKEN, and G_SQLCODE_TOKEN. A global exception, G_EXCEPTION_HALT_VALIDATION, is also declared for control-flow interruption during validation.

Key Procedures and Functions

  • CREATE_CASE — The sole documented program unit in the package. It creates a case record and accepts a standard ETRM API parameter signature: p_api_version for version checking, p_init_msg_list for message stack initialization, and p_contract_id identifying the contract to which the case relates. It returns the standard out parameters x_return_status, x_msg_count, and x_msg_data to communicate success, error, or unexpected status back to the caller. Because the procedure is declared without a body in the published header excerpt, the exact insert logic resides in the package body.

Tables Accessed

The package interfaces with the Case Management data model and the OKL contract header table via APPS synonyms:

  • IEX_CASES_ALL_B — the base case entity table; a new case row is created here.
  • IEX_CASES_TL — the translation table holding case name and description in the session language.
  • IEX_CASE_DEFINITIONS — defines the case type and its attributes used to construct the case.
  • IEX_CASE_OBJECTS — associates a case with its related business object, here the lease contract.
  • OKC_K_HEADERS_B — the OKL contract header table, supplying the p_contract_id context for the case association.

Usage Notes

OKL_CASE_UTIL_PVT is invoked internally by OKL application logic when a lease contract requires an associated case record. It is called from forms or concurrent programs indirectly through higher-level OKL APIs rather than directly by end users. The presence of p_api_version and message-list parameters confirms it follows the standard ETRM API contract, and custom code should generally call the public OKL case APIs instead. The okl_required_value message surfaces to the caller through x_msg_data when the contract identifier is not passed, reinforcing that callers must supply a valid p_contract_id.