Search Results igs_fi_f_cat_ca_inst_pkg




Overview
Explore in AI Chat

Overview

IGS_FI_F_CAT_CA_INST_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema, classified under the ETRM documentation as an "OTHER" API type. It belongs to the Student Systems / Financial Aid functional family (the IGS_ prefix denotes the Oracle Student System and its higher-education financial components). The package serves as the core programmatic interface for the IGS_FI_F_CAT_CA_INST entity, which associates a financial aid fee category with a calendar instance (academic period, term, or calendar instance). This junction entity determines the fee categories that are applicable to students within a specific calendar instance context.

The package encapsulates the standard Oracle Forms-generated DML infrastructure used throughout the IGS product family — it is a table-handler package rather than a public business API. Its primary role is to provide controlled insert, update, delete, and locking behavior for the underlying table while enforcing foreign key validation against the related calendar instance, calendar, and fee category entities.

Key Procedures and Functions

The ETRM metadata documents twelve procedures and functions for this package:

  • INSERT_ROW — Inserts a new IGS_FI_F_CAT_CA_INST record, populating the surrogate key and audit columns.
  • LOCK_ROW — Acquires a row-level lock on an existing record to prevent concurrent modification, typically invoked from Forms prior to an update.
  • UPDATE_ROW — Applies changes to an existing fee category/calendar instance association.
  • ADD_ROW — A convenience wrapper that combines validation, key generation, and insertion into a single logical operation.
  • DELETE_ROW — Removes an existing association after any referential validation.
  • GET_PK_FOR_VALIDATION — Returns the primary key value used for validation purposes during DML processing.
  • CHECK_CONSTRAINTS — Enforces the business and referential constraints defined on the entity before DML proceeds.
  • BEFORE_DML — A pre-DML hook that performs standard preprocessing such as audit column population and key derivation.
  • GET_FK_IGS_CA_DA_INST — Retrieves the foreign key descriptor for the IGS_CA_DA_INST (calendar instance) relationship.
  • GET_FK_IGS_CA_INST — Retrieves the foreign key descriptor for the IGS_CA_INST relationship.
  • GET_FK_IGS_FI_FEE_CAT — Retrieves the foreign key descriptor for the fee category (IGS_FI_FEE_CAT) relationship.
  • GET_FK_IGS_FI_FEE_STR_STAT — Retrieves the foreign key descriptor for the fee structure status relationship.

Tables Accessed

The package reads from and writes to the base table IGS_FI_F_CAT_CA_INST, referenced through APPS synonyms. This table stores the association between a financial aid fee category and a calendar instance, along with the effective calendar day instance and fee structure status references that qualify the association. All four GET_FK_* functions exist specifically to resolve and validate foreign keys against the parent tables of these relationships.

Usage Notes

This package is not intended for direct invocation by end users or external custom code. It is invoked indirectly by higher-level IGS packages and concurrent programs. The ETRM dependency report confirms that it is referenced by nine other packages, including IGS_CA_INST_PKG, IGS_CA_INST_REL_PKG, IGS_CA_DA_INST_PKG, IGS_FI_FEE_CAT_PKG, IGS_FI_FEE_RET_SCHD_PKG, IGS_FI_FEE_STR_STAT_PKG, IGS_FI_F_CAT_FEE_LBL_PKG, IGS_FI_F_RET_SCHD_HT_PKG, and IGS_FI_PRC_FEE_ROLLV. It also self-references, consistent with internal recursive validation logic. Because it is a Forms-generated table handler, direct use should be avoided in favor of the calling business APIs above it. This behavior is consistent across both Oracle EBS 12.1.1 and 12.2.2.