Search Results igs_en_spa_terms_api




Overview
Explore in AI Chat

Overview

The APPS.IGS_EN_SPA_TERMS_API package body is a public API within the Oracle E-Business Suite Student/Academic (Higher Education) module, delivered under the APPS schema in release 12.1.1 and 12.2.2. Its business function is to manage student program attempt term records — the term-level rows in the IGS_EN_SPA_TERMS table that associate a student's program attempt (IGS_EN_STDNT_PS_ATT) with a specific academic calendar term, including attendance type, attendance mode, location, program version, fee category, and class standing. The package is classified as an API and provides a controlled, validated interface for creating, updating, and querying these term records without direct DML against the underlying table. Internally it depends on the EBS API infrastructure (FND_API, FND_MESSAGE, FND_PROFILE, APP_EXCEPTION, and IGS_GE_MSG_STACK) and on the private package IGS_EN_SPA_TERMS_PKG, which performs the lower-level data manipulation. The package body is documented as VALID, and it is referenced by 23 other database objects, confirming its role as a foundational component used throughout student term processing.

Key Procedures and Functions

The ETRM documentation lists 26 procedures and functions. The principal groups are:

All procedures raise errors through the standard EBS message stack rather than raising unhandled exceptions, allowing callers to inspect and display errors.

Tables Accessed

The package reads and writes through APPS synonyms for the following documented tables:

  • IGS_EN_SPA_TERMS — the primary table holding student program attempt term records; the API inserts, updates, and queries here.
  • IGS_CA_INST_REL — the calendar instance relationship table, used to derive term sequencing for the current, previous, and next term functions.
  • IGS_CA_STAT — calendar instance status, consulted to ensure only valid (for example, active) terms are considered.
  • IGS_CA_TYPE — calendar type, used to validate the term calendar type set by SET_SPA_TERM_CAL_TYPE.
  • IGS_EN_PLAN_UNITS — plan unit data, used to resolve program version and plan-related attributes returned by the GET_SPAT_* functions.

Additional referenced objects such as IGS_EN_ATD_TYPE, IGS_EN_ATD_MODE, IGS_PE_PERSON, IGS_PS_VER, and IGS_AD_LOCATION support the descriptive-value lookups.

Usage Notes

IGS_EN_SPA_TERMS_API is normally invoked from the Student System forms and from concurrent programs that process student program attempt terms, as well as from custom PL/SQL that must create or interrogate term records. The standard calling pattern is to invoke the setter procedures first to establish calendar type and sequence context, then call the GET_SPAT_* functions or validation routines, and finally commit through the private package. Because the package is an API and depends on FND_API and the message stack, callers should check the message stack after execution. The package does not depend on any other database object for its own definition (no object references it in the dependency chain), and its public interface should be used in preference to direct DML on IGS_EN_SPA_TERMS to preserve data integrity and upgrade safety across EBS releases.