Results for “oke_agreement_pvt”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

OKE_AGREEMENT_PVT is a private PL/SQL package body in the Oracle E-Business Suite Applications (APPS) schema that encapsulates the core business logic for creating, updating, and funding service agreements managed by Oracle Contracts (OKE). The package operates against the Project Accounting agreement and funding model, bridging contract header information held in OKE tables with the agreement, project, and funding records maintained in PA tables. In the context of EBS 12.1.1 and 12.2.2, the object is classified as a private (PVT) API, meaning it is not intended as a public integration interface; instead it is invoked internally by higher-level public APIs, forms, and concurrent processes that manage service agreement lifecycles.

The package header carries the signature $Header: OKEVKAGB.pls 120.3.12020000.4 2012/11/29 06:49:42 ansraj ship $, indicating maintenance through the 12.2 code line. The body contains both private helper routines and documented entry points, with a local variable L_USER_ID NUMBER := FND_GLOBAL.USER_ID; capturing the executing user for audit and defaulting purposes, and g_agrnum_length NUMBER := 0; governing agreement number formatting logic.

Key Procedures and Functions

• CREATE_AGREEMENT — Constructs a new service agreement record, deriving the agreement number, associating the agreement type, and establishing the link between the OKE contract entity and the corresponding PA agreement.
• UPDATE_AGREEMENT — Applies modifications to an existing agreement, including changes to agreement attributes maintained in the Project Accounting agreement tables.
• UPDATE_PA_FUNDING — Adjusts existing funding records associated with an agreement, recalculating or redistributing funded amounts across funding sources and allocations.
• ADD_PA_FUNDING — Inserts new funding rows for an agreement, allocating amounts against defined funding sources and enabling the project funding structure to reflect the agreement's financial terms.

In addition to these documented procedures, the body exposes several private functions, including set_hard_limit, which interprets a numeric input to return 'Y' or 'N' for the hard-limit flag (treating NULL, OKE_API.G_MISS_NUM, and zero as 'N'), and get_term_id, which queries OKE_K_TERMS for the RA_PAYMENT_TERMS term value associated with a contract header, raising OKE_API.G_EXCEPTION_ERROR with the OKE_API_MISSING_VALUE message when no payment term is found.

Tables Accessed

The package reads and writes across contract and project accounting tables referenced through APPS synonyms. OKE_K_TERMS supplies agreement terms such as receivable payment terms, and OKE_K_FUNDING_SOURCES and OKE_K_FUND_ALLOCATIONS define the funding structures applied to agreements. PA_AGREEMENTS_ALL and PA_AGREEMENT_TYPES hold the agreement header and classification records created or maintained by the API, while PA_PROJECTS_ALL and PA_PROJECT_FUNDINGS link the agreement to its project and funding detail. PA_IMPLEMENTATIONS_ALL governs Project Accounting configuration. Customer information is validated against HZ_CUST_ACCOUNTS and HZ_PARTIES, currency values against FND_CURRENCIES, and metadata checks against ALL_TAB_COLUMNS and USER_SYNONYMS. PLITBLM supports PL/SQL table-to-database operations.

Usage Notes

Because OKE_AGREEMENT_PVT is a private package, it is invoked indirectly rather than called directly by external integrations. Typical callers are the Oracle Contracts service agreement forms, concurrent programs that process agreement funding, and one other dependent package identified in the ETRM repository. Extensions and customizations should normally target the public OKE_API surface, since the private body may change between releases. When invoked, the package relies on FND_GLOBAL.USER_ID for session context and raises OKE_API exceptions, allowing callers to surface standardized messages through the OKE_API message stack. The get_term_id logic confirms that a valid receivable payment term must exist on the contract header before funding operations proceed, enforcing data integrity between the agreement and its billing terms.