Search Results igf_ap_tax_pkg




Overview

The APPS.IGF_AP_TAX_PKG package body is a server-side PL/SQL component within the Oracle E-Business Suite Financials/Student Systems family of modules. The IGF prefix associates this package with Oracle's Grants/Federal financial aid processing (the former "IGF" application module), and its _TAX suffix indicates that its business function is the maintenance of tax-related records tied to accounts payable/student award disbursement processing. In Oracle EBS 12.1.1 and 12.2.2, this package is a procedural data-management layer sitting between the IGF_AP_TAX_ALL table and the calling forms or concurrent programs. Its primary purpose is to provide a controlled, reusable API for inserting, updating, locking, and deleting rows in the underlying tax table, applying the standard EBS "table handler" pattern (row locking, WHO-column population, and primary/foreign key validation). The object metadata records a status of VALID and an API classification of OTHER, confirming it is a supporting internal package rather than a public, versioned open interface.

Key Procedures and Functions

The ETRM metadata documents eight procedures and functions in this package body:

  • INSERT_ROW — Inserts a new tax record into the underlying table, populating mandatory columns and audit (WHO) columns.
  • LOCK_ROW — Acquires a row-level lock against an existing tax record to prevent concurrent modification during an interactive session.
  • UPDATE_ROW — Applies modified attribute values to an existing tax row and refreshes audit columns.
  • ADD_ROW — Higher-level wrapper that creates a row, typically invoked when a parent entity requires an associated tax record.
  • DELETE_ROW — Removes a tax record from the table, generally after validating that deletion is permissible.
  • GET_PK_FOR_VALIDATION — Retrieves the primary key value for a tax row, used to validate that a referenced record exists.
  • GET_FK_IGF_AP_FA_BASE_REC — Returns the foreign key linking a tax row to its parent record in the IGF_AP_FA_BASE_REC_PKG structure, supporting referential integrity between the tax table and the base award record.
  • BEFORE_DML — A pre-DML trigger-style procedure that centralizes defaulting, WHO-column population, and validation logic executed prior to any insert, update, or delete.

Tables Accessed

The package reads and writes IGF_AP_TAX_ALL, accessed through an APPS synonym. This table stores the tax records associated with accounts payable transactions in the grants/financial aid flow. All DML against the table is funneled through the procedures above, ensuring consistent enforcement of locking, key validation, and audit-column maintenance. The package additionally depends on the IGF_AP_FA_BASE_REC_PKG body for foreign key resolution against the base financial-aid record, and on IGF_AW_GEN for award-generation logic.

Usage Notes

IGF_AP_TAX_PKG is typically invoked from the Forms-based UI, from concurrent programs, or from other PL/SQL packages that must maintain tax records without direct DML. The dependency metadata shows it references FND_GLOBAL (for session/user context in WHO columns), FND_MESSAGE and IGS_GE_MSG_STACK (for error messaging), APP_EXCEPTION (for standardized exception handling), and IGF_AP_TAX_ALL. Notably, the ETRM record states the package is not referenced by any database object while being referenced by one other package, indicating it is called dynamically or from a package layer rather than being a hard dependency of database-level objects. Because it is classified as OTHER rather than a public API, it should be treated as an internal implementation package; customizations should call it only after regression testing, as Oracle does not guarantee its signature across patches. Applications should not bypass it to write directly to IGF_AP_TAX_ALL. References to STANDARD and SYS confirm standard Oracle PL/SQL runtime dependencies only.