Search Results igs_fi_f_ret_schd_ht_pkg




Overview
Explore in AI Chat

Overview

The APPS.IGS_FI_F_RET_SCHD_HT_PKG package is a component of the Oracle Student Financials (formerly part of the Oracle Financials for Higher Education and subsequently the Student System / Campus Solutions-adjacent modules) schema owned by the APPS account. Its name — comprising tokens IGS (Institution of Higher/Graduate Studies, the legacy prefix for the Student System), FI (Financials/Financial Aid), and F_RET_SCHD_HT (likely a "Fee Return Schedule History" or comparable retention schedule header entity) — indicates that it manages a header-level business entity within the student financials retention or refund scheduling domain. The HT suffix and the presence of history-related DML wrappers (INSERT_ROW, UPDATE_ROW, DELETE_ROW) confirm that this is a table-maintenance package dedicated to a single underlying base table, IGS_FI_F_RET_SCHD_HT_ALL.

In Oracle EBS 12.1.1 and 12.2.2 the package is documented as VALID and is classified in the ETRM repository under API classification OTHER. It exposes ten documented procedures, all oriented toward row-level data manipulation and validation rather than complex business processing. It is referenced by two other packages — IGS_FI_F_CAT_CA_INST_PKG and IGS_FI_GEN_002 — indicating that it serves as a dependent building block for catalog/instance configuration and a generated utility routine respectively.

Key Procedures and Functions

The ten documented procedures form a conventional table-handler API. Their purposes are as follows:

  • INSERT_ROW — Inserts a single row into the underlying base table, applying the standard IGS attributes.
  • ADD_ROW — Alternative/overloaded insertion entry point, typically used by the Forms or generated code path to add a new record.
  • UPDATE_ROW — Updates an existing row's column values, addressing the row by its primary key.
  • DELETE_ROW — Removes a row identified by its primary key.
  • LOCK_ROW — Issues a SELECT ... FOR UPDATE to obtain a row-level lock, supporting the standard concurrency-control pattern used throughout IGS table handlers.
  • GET_PK_FOR_VALIDATION — Returns the primary-key column set, used by validation routines to build key predicates.
  • GET_UK1_FOR_VALIDATION — Returns the first unique-key column set, used for uniqueness/validation checks.
  • CHECK_CONSTRAINTS — Performs application-level validation of constraint conditions before a DML operation proceeds.
  • BEFORE_DML — Pre-DML hook that populates WHO columns (created_by, creation_date, last_updated_by, last_update_date) and other derived attributes.
  • GET_FK_IGS_FI_F_CAT_CA_INST — Retrieves the foreign-key value referencing the IGS_FI_F_CAT_CA_INST parent entity; this establishes the package's relationship to IGS_FI_F_CAT_CA_INST_PKG.

Tables Accessed

The package accesses a single documented base table, IGS_FI_F_RET_SCHD_HT_ALL, referred through the APPS synonym. The _ALL suffix indicates it is a multi-organization (operating unit) table, and the DML procedures read, lock, insert, update and delete rows in it. The GET_FK_IGS_FI_F_CAT_CA_INST procedure implies a foreign-key lookup against the catalog/calendar-instance table or view named IGS_FI_F_CAT_CA_INST.

Usage Notes

This package is most typically invoked indirectly. It is referenced by IGS_FI_F_CAT_CA_INST_PKG (catalog/calendar-instance processing) and by the generated package IGS_FI_GEN_002, both of which call into its DML API. Standard EBS Forms — likely the Fee Return / Retention Schedule maintenance form in the Student Financials responsibility — invoke the row-handling procedures through the Oracle Forms base-table data block mechanics, with BEFORE_DML and CHECK_CONSTRAINTS driving validation and WHO-column population. Custom PL/SQL should follow the same ordering convention: LOCK_ROW (or GET_PK_FOR_VALIDATION/GET_UK1_FOR_VALIDATION), CHECK_CONSTRAINTS, BEFORE_DML, then INSERT_ROW/UPDATE_ROW/DELETE_ROW. Direct SQL against IGS_FI_F_RET_SCHD_HT_ALL is discouraged, because bypassing these procedures omits the WHO audit values and application-level constraint checks. No concurrent-program entry point is documented in the ETRM metadata for this package.