Search Results clear_message

Overview

OKL_PERD_STATUS_PVT is a private (PVT-classified) PL/SQL package body in the Oracle Lease and Finance Management (OKL) module of Oracle E-Business Suite. It supports the accounting period status infrastructure used by lease contracts and their associated subledger accounting events. The package exposes a small, focused API surface whose primary purpose is to let callers search and update the period-status records that determine whether a given accounting period is open or closed for lease-related processing.

The source header indicates the file is OKLRPSMB.pls and that the current version (120.8.12010000.3, dated 2008/12/11) was shipped by sgiyer. The package carries debug instrumentation generated automatically, with the module identifier LEASE.ACCOUNTING.PERIOD and a debug-enabled constant sourced from OKL_DEBUG_PUB.CHECK_LOG_ENABLED. The body also declares a global G_WARNING_STATUS VARCHAR2(1) := 'W', used to flag warning-level state within the API. Although the package is formally a private (PVT) unit, it is referenced by three other packages, which means it functions as an internal service layer rather than a user-facing API.

One especially notable routine is Clear_Message, which was added by kthiruva on 26-Sep-2003 under Bug No. 3126403. Its purpose is to purge all but the first error message from the FND message stack. It loops from 1 to fnd_msg_pub.count_msg-1 and, while more than one message remains, calls fnd_msg_pub.delete_MSG(p_msg_index => 1). This ensures that only the original error is surfaced to the caller, which is important because a malformed or multi-row processing attempt could otherwise flood the FND stack with redundant messages. This routine is the direct match for the user search term "clear_message."

Key Procedures and Functions

• SEARCH_PERIOD_STATUS — Queries and returns period-status records for a given lease accounting period. It accepts an API version, initialization flag, and a period record, and returns a period table along with the standard x_return_status, x_msg_count, and x_msg_data OUT parameters. Internally it builds a dynamic SQL statement selecting APPLICATION_ID, LEDGER_ID, PERIOD_NAME, LAST_UPDATE_DATE, LAST_UPDATED_BY, CLOSING_STATUS, START_DATE, END_DATE, PERIOD_TYPE, PERIOD_YEAR, PERIOD_NUM, QUARTER_NUM, ADJUSTMENT_PERIOD_FLAG, CREATION_DATE, CREATED_BY, and LAST_UPDATE_LOGIN, filtered by set of books. Application ID is fixed at 540 (the Lease Management application). The result set is fetched through a REF CURSOR declared as perd_csr.
• UPDATE_PERIOD_STATUS — Updates the closing status and related attributes of an existing period-status row for the lease accounting period. It is the write counterpart to SEARCH_PERIOD_STATUS.
• UPDATE_PERD_ROW — A lower-level row update helper used when individual period/ledger rows require modification. It supports the granular update path for subledger accounting period processing.

Tables Accessed

The package reads and writes the following tables via APPS synonyms:

• GL_PERIOD_STATUSES — The General Ledger period-status table. This is the core source of period open/close state used by the search and update routines.
• XLA_EVENTS — Subledger accounting events. Period status changes may need to account for unprocessed or pending XLA events before allowing a period to close.
• XLA_TRANSACTION_ENTITIES — Subledger accounting transaction entities, referenced in conjunction with XLA_EVENTS to validate accounting completeness.
• PLITBLM — A PL/SQL index-by table used for bulk message or record handling within the API.

Usage Notes

Because OKL_PERD_STATUS_PVT is classified as PVT, it is not intended for direct invocation by end users or external integrations. It is instead called internally by the three other packages that reference it, and is typically reached through forms or concurrent programs that manage lease accounting period close, period status inquiry, or the validation of pending subledger events before a period is closed. Developers writing custom code should call the public OKL API layer rather than this private package, but may consult Clear_Message as a pattern for collapsing the FND message stack to a single error. The package's debug instrumentation allows trace-level logging to be enabled through OKL_DEBUG_PUB for troubleshooting period-processing failures.