Search Results undo_periods

Overview

PN_INDEX_RENT_PERIODS_PKG is an Oracle Property Manager (PN) package owned by APPS in Oracle E-Business Suite 12.1.1 and 12.2.2. Its stated purpose is to maintain index rent periods, the schedule rows that drive rent adjustments on index leases. Index leases tie rent to a published price index, and the period generation logic in this package derives the basis periods against which rent is periodically re-calculated. The package is defined with AUTHID CURRENT_USER, so all unqualified references resolve through APPS synonyms under the calling user's privileges. It is characterized in the ETRM metadata as an "OTHER" API rather than a supported public interface, which means its procedures are intended primarily for internal use by Oracle Property Manager forms, concurrent programs, and other PN packages. The header history shows ongoing maintenance from 2001 through 2007, including a signature change to PROCESS_MAIN_LEASE_TERM_DATE (Bug 4931780) and the addition of HANDLE_TERM_END_DATES (Bug 5960582). Three other packages reference this package, confirming its role as a shared service for index lease period maintenance.

Key Procedures and Functions

Eleven documented procedures make up the package interface:

• GENERATE_PERIODS_BATCH — Concurrent-program entry point that generates index rent periods for an index lease, with a regenerate flag controlling whether existing periods are replaced.
• GENERATE_PERIODS — The core single-lease generation routine that creates index rent period rows for a given index lease identifier.
• PRINT_BASIS_PERIODS — Reporting utility that outputs the basis periods associated with an index lease.
• UNDO_PERIODS — Reverses previously generated index rent periods for a lease and returns a status message. This procedure corresponds to the "undo_periods" search term and is the standard mechanism for backing out period generation.
• PROCESS_NEW_TERMINATION_DATE — Recalculates periods when a lease is terminated on a new date.
• GENERATE_BASIS_DATA_CHECK — Validation routine that verifies basis data is sufficient before generation proceeds.
• PROCESS_MAIN_LEASE_TERM_DATE — Handles term date changes on the main lease; its signature was modified under Bug 4931780.
• DELETE_PERIODS — Removes index rent period records for a lease.
• PROCESS_PAYMENT_TERM_AMENDMENT — Adjusts periods when payment terms are amended.
• HANDLE_MTM_ACT — Supports mark-to-market activity affecting index rent periods.
• HANDLE_TERM_DATE_CHANGE — Added in 2007 to process term end date changes.

Tables Accessed

The package reads and writes the principal Property Manager tables. Period rows are stored in PN_INDEX_LEASE_PERIODS_ALL, the primary target of generation, undo, and delete operations. Lease definition data comes from PN_INDEX_LEASES, PN_INDEX_LEASES_ALL, PN_LEASES_ALL, PN_LEASE_DETAILS_ALL, and PN_LEASE_DETAILS_HISTORY. Term and constraint information is drawn from PN_INDEX_LEASE_TERMS_ALL, PN_INDEX_LEASE_CONSTRAINTS_ALL, and PN_INDEX_EXCLUDE_TERM_ALL. Payment-related processing touches PN_PAYMENT_TERMS, PN_PAYMENT_TERMS_ALL, PN_PAYMENT_ITEMS_ALL, and PN_PAYMENT_SCHEDULES_ALL. Distribution and change history records are maintained in PN_DISTRIBUTIONS_ALL and PN_LEASE_CHANGES_ALL.

Usage Notes

GENERATE_PERIODS_BATCH is registered as a concurrent program and invoked from the Property Manager responsibility, accepting an index lease number and a regenerate indicator. The remaining procedures are typically called from Property Manager forms or from other PN packages during lease amendments, terminations, and term date changes. The AUTHID CURRENT_USER clause requires that the executing user has the necessary privileges on the underlying tables through APPS synonyms. Because ETRM classifies this package as "OTHER," it is not a committed public API; customizations that call UNDO_PERIODS or related procedures directly should be validated against each patch level, particularly given the documented signature change to PROCESS_MAIN_LEASE_TERM_DATE.