Search Results igs_en_drop_units_api




Overview
Explore in AI Chat

Overview

IGS_EN_DROP_UNITS_API is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified as a public API within the Student Systems (IGS) product family, specifically the Enrollments module. Its purpose is to encapsulate the business logic required when a student drops units from an enrollment. Rather than allowing direct DML against the underlying student unit attempt and warning tables, the package provides a controlled, validated interface for removing a student's unit attempt records and recording the associated warnings and administrative consequences. The package is marked VALID in ETRM 12.1.1 and remains available in 12.1.1 and 12.2.2 environments, where the IGS schema objects continue to be deployed under the APPS owner.

Because it is an API rather than a standalone concurrent program, it is designed to be called from other enrollment packages, Oracle Forms-based enrollment screens, and custom extensions that must preserve data integrity and auditability when a drop transaction occurs.

Key Procedures and Functions

The documented interface exposes five callable units, of which four core entry points are described below. Parameter lists are not reproduced here; callers should refer to the package specification for exact signatures.

  • REORDER_DROP_UNITS — Coordinates the re-sequencing of remaining unit attempts following a drop, ensuring that the student's surviving enrollment records retain a consistent ordering and linkage after units are removed.
  • CREATE_SS_WARNING — Creates a student warning record, typically used to flag situations such as an attempt to drop a unit that breaches minimum load, progression, or other academic rules. It writes to the standard warning table so that downstream eligibility and notification logic can act on the condition.
  • DROP_SS_UNIT_ATTEMPT — Performs the core drop operation against the student unit attempt record, applying the enrollment rules that govern whether and how an attempt may be deleted or marked as dropped.
  • UPDATE_DROPPED_UNITS — Updates the affected unit attempt rows after a drop has been processed, propagating status, date, and related attribute changes required to keep the enrollment record internally consistent.

Tables Accessed

Dependency metadata shows the package referencing APPS synonyms for IGS_EN_STD_WARNINGS, IGS_EN_METHOD_TYPE, and IGS_EN_SU_ATTEMPT_ALL, with additional references to IGS_CA_INST (calendar instance) and IGS_EN_SU_ATTEMPT. The warning table stores the output of CREATE_SS_WARNING; IGS_EN_SU_ATTEMPT_ALL holds the student unit attempt rows that DROP_SS_UNIT_ATTEMPT and UPDATE_DROPPED_UNITS operate on; IGS_EN_METHOD_TYPE and IGS_CA_INST supply method-of-attendance and teaching-period context used to validate the drop. All access is performed through the standard APPS synonyms, so no direct schema qualification against IGS is required by callers.

Usage Notes

IGS_EN_DROP_UNITS_API is referenced by five other packages: IGS_EN_ADD_UNITS_API, IGS_EN_ELGBL_PERSON, IGS_EN_ELGBL_PROGRAM, IGS_EN_ELGBL_UNIT, and IGS_EN_PLAN_UTILS, and it also references IGS_EN_ELGBL_PLAN_UTILS style planning utilities. This dependency pattern confirms that drops are usually initiated indirectly — for example, when eligibility or planning logic determines that a unit must be removed — rather than called in isolation. Custom code should invoke the API rather than issuing DML directly against IGS_EN_SU_ATTEMPT_ALL or IGS_EN_STD_WARNINGS, so that warning creation, reordering, and downstream eligibility recalculation occur in the intended sequence. In Oracle EBS 12.1.1 and 12.2.2 the package is deployed in the APPS schema and should be called with the standard FND_API error-handling conventions used by other IGS enrollment APIs.