Search Results generate_periods

Overview

APPS.PN_VAR_RENT_PUB is the public application programming interface for variable rent processing within Oracle Property Manager (PN), part of the Oracle E-Business Suite real estate and lease management solution. The package encapsulates the business logic required to define, generate, and maintain variable rent arrangements attached to lease agreements. In EBS 12.1.1 and 12.2.2, variable rent terms allow lessees and lessors to model rent that fluctuates based on measurable business drivers, such as percentage-of-sales thresholds, turnover bands, or consumer price index adjustments. The PUB designation indicates that this body is intended for external invocation by other Oracle modules, forms, and customer extensions, rather than being restricted to internal package-private use. Internally, it delegates most persistence work to the private package PN_VAREN_PVT, while the public wrapper enforces the standard EBS API conventions: an API version parameter for upward compatibility, an initialization-message-list flag, commit control, and validation-only execution modes. The package also declares standard global constants for success, warning, and error return codes, along with organization context and diagnostic settings derived from the PN_DEBUG_MODE profile option. The header revision 120.2 is dated 2011, with interface repository annotations added in April 2011 to bring the specification into conformance with Oracle's PL/SQL API documentation standards.

Key Procedures and Functions

• CREATE_VAR_RENT — Creates a new variable rent definition. It accepts the standard API control parameters (API version, initialization message list, commit flag, and validation flag) together with a variable rent record and a variable rent lines table, both passed as IN OUT NOCOPY parameters. The procedure validates input, inserts the header and its associated period or threshold lines through PN_VAREN_PVT, and optionally commits.
• GENERATE_PERIODS — Produces the period or line rows that a variable rent definition requires for a given lease term. It derives the applicable periods for the variable rent schedule, enabling downstream rent calculation and billing to consume consistent date-bounded records.
• CREATE_BKPT_CONST_ALLOW_ABAT — Creates the rent-rule combination of breakpoint, constant, and allowance or abatement structures associated with a variable rent arrangement. It supports modeling arrangements in which a fixed base applies below or above a breakpoint, with a separate abatement component.
• UPDATE_VAR_RENT — Modifies an existing variable rent definition, including its lines, revalidating the modified data and applying the same commit and validation controls as the create operation.

Tables Accessed

The package operates against the Property Manager variable rent schema through APPS synonyms. The primary objects are the variable rent header and line tables maintained by PN_VAREN_PVT, which store the variable rent definition, its period rows, and its breakpoint, constant, and abatement attributes. Period generation writes the generated rows into the variable rent line table. The package also reads lease, property, and organization context, using the ORG_ID profile value captured in the g_org_id constant to enforce multi-org security. No additional standalone tables are documented in the ETRM metadata, and no other packages are recorded as referencing this one, indicating that the dependent logic resides in the private PN_VAREN_PVT body.

Usage Notes

PN_VAR_RENT_PUB is typically invoked from the Property Manager variable rent forms and from concurrent programs that generate or recalculate variable rent schedules, including those triggered when lease terms change or when periods must be rolled forward. Because the package follows the EBS API standard, callers can pass p_validate_flag to perform a dry run without committing, and can control transaction boundaries with p_commit, allowing several API calls to be grouped in a single unit of work. Custom integrations should call this public package rather than PN_VAREN_PVT directly, since the private package may change without notice. The g_fun_name constant PN_PNXVAREN reflects the associated function registration used for menu and security validation.