Search Results create_split_contract

Overview

The APPS.OKL_SPLIT_CONTRACT_PUB_W package is a public Oracle E-Business Suite API wrapper that belongs to the Oracle Leasing (OKL) module, which is part of the Enterprise Contracts and Leasing / ETRM (Enterprise Trade and Risk Management) family of applications. Its principal business function is to support the division of an existing lease or contract into two or more separate contracts through a single programmatic call. This "split contract" operation is a common leasing business requirement: a customer may wish to partially terminate a lease, subdivide a master agreement into component agreements, or separate assets and their associated payment streams into distinct contractual instruments. Rather than forcing users to manually recreate contracts, the API performs the controlled split while preserving the integrity of contract data, references, and downstream relationships.

The package is documented as an OTHER-classified API (not a standard open-interface or business-object API), which indicates that it is intended for programmatic use by Oracle internal components or by carefully validated custom extensions rather than by broad third-party integration.

Key Procedures and Functions

The documented metadata lists one public procedure within the package: CREATE_SPLIT_CONTRACT. This procedure is the sole entry point through which a caller requests the split of an existing contract. Its parameter signature follows the standard Oracle EBS API conventions, including an p_api_version input for compatibility checking, a p_init_msg_list flag to control message list initialization, and the standard error-handling out parameters (x_return_status, x_msg_count, x_msg_data).

The remaining parameters follow the familiar Oracle eTRM pattern of paired p6_* input arrays and p7_* output arrays, implemented as JTF_NUMBER_TABLE and JTF_VARCHAR2_TABLE_200 types. p_old_contract_number identifies the source contract to be split. The p6_* input tables carry the attributes of the new contract(s) to be generated, while the p7_* output tables return the corresponding identifiers and descriptive values of the newly created contracts after the operation completes. The x_return_status value indicates success or failure, and any errors or warnings are surfaced through the message count and message data outputs.

Tables Accessed

The ETRM metadata provided does not enumerate the specific tables referenced by this package through APPS synonyms. In general, an OKL split-contract operation would interact with core Oracle Leasing tables such as OKL_CONTRACTS (contract headers), OKL_CONTRACT_LINES (contract lines and asset associations), and related party, term, and pricing tables, since a split must duplicate or redistribute these records. Because the documented metadata supplies no table list, integrators should treat the underlying table access as internal to the package and rely on the API rather than direct table manipulation.

Usage Notes

Given its classification as an OTHER API and its enumerated parameter structure, OKL_SPLIT_CONTRACT_PUB_W is typically invoked from custom PL/SQL code, from Oracle Forms customization (for example, a custom button or menu action in the Leasing contract form), or from a concurrent program wrapper. When calling CREATE_SPLIT_CONTRACT, the standard eTRM error-handling sequence must be observed: check x_return_status after the call, and if it does not equal FND_API.G_RET_STS_SUCCESS, iterate over the message list using the x_msg_count and x_msg_data outputs to retrieve the error text and roll back the transaction where appropriate. The API is not referenced by any other documented package, so it acts as a standalone entry point. Because the header indicates an older revision (115.3), callers should pass the correct p_api_version and should validate behavior in each target environment—particularly when migrating between EBS 12.1.1 and 12.2.2—since internal table structures and the underlying split logic may differ between releases.