Search Results activate_contract

Overview

The OKL_ACTIVATE_CONTRACT_PUB package is a public (PUB) API within the Oracle E-Business Suite Lease and Finance Management (formerly Oracle Lease Management, OKL) module. Its business purpose is to activate an existing lease or financing contract, transitioning it from a booked or drafted state into an active state in which the contract becomes operational. Activation is a milestone event in the contract lifecycle because it triggers downstream processes in Fixed Assets (FA) and Installment Billing (IB), and initializes the financial and asset-related structures that drive subsequent accounting, billing, and termination activity.

The package header comment explicitly describes the API as: "Will call the FA Activation and IB Activation public APIs," and notes that it is "called from the activate button on the booking screen." This establishes the package as the central orchestration point for committing a contract to an active status, coordinating the internal OKL contract structures with the external FA and IB activations.

Key Procedures and Functions

• ACTIVATE_CONTRACT — The single documented procedure in this package. Its purpose is to perform the activation of a contract. Based on the documented header comments and parameter naming (p_chr_id / p_chrv_id identifying the contract, and p_call_mode identifying the activation context), the procedure accepts an API version, standard message-handling parameters (init message list, return status, message count, and message data), a contract identifier, and a call mode. The p_call_mode parameter governs the activation context, with documented values of 'BOOK' (booking), 'REBOOK' (rebooking), and 'RELEASE' (release). The procedure returns the standard EBS API status indicators through x_return_status, x_msg_count, and x_msg_data, allowing callers to detect success, error, or unexpected outcomes and to retrieve diagnostic messages.

Tables Accessed

The package reads and writes a broad set of OKL and OKC contract tables, reflecting the scope of contract activation:

• OKC_K_HEADERS_B, OKC_K_LINES_B, OKC_K_LINES_TL, OKC_K_ITEMS, OKC_K_PARTY_ROLES_B, OKC_LINE_STYLES_B, OKC_RULES_B, OKC_STATUSES_B — core contract header, line, item, party role, line style, rules, and status structures that define the contract and its resulting status change upon activation.
• OKL_K_LINES, OKL_STRM_ELEMENTS, OKL_STRM_TYPE_B — lease line detail, stream element (payment/charge stream) and stream type data used to establish the financial schedule of the activated contract.
• OKL_ASSET_RETURNS_B — asset return records associated with the contract.
• OKL_RBK_SELECTED_CONTRACT — selected contract data supporting rebooking scenarios.
• HZ_CUST_ACCT_SITES_ALL — customer account site information, used to resolve the customer/party context of the contract.
• FND_LOG_MESSAGES — the standard EBS logging table, used to record diagnostic and debug messages during activation.

Usage Notes

This package is the programmatic entry point invoked when a user presses the Activate button on the contract booking screen. It is also designed to be called from other public APIs and custom code. The documented metadata confirms it is referenced by one other package, indicating it occupies a mid-level orchestration role rather than being a leaf-level utility. Customizations and extensions that must act at the point of contract activation should call OKL_ACTIVATE_CONTRACT_PUB.ACTIVATE_CONTRACT, inspecting x_return_status and the message stack before proceeding, rather than manipulating the underlying OKC/OKL tables directly. Because activation triggers FA and IB processing, callers must ensure the contract is in a valid pre-activation state to avoid partial or failed activations.