Search Results igs_uc_app_clearing_pkg




Overview
Explore in AI Chat

Overview

The APPS.IGS_UC_APP_CLEARING_PKG package is a public PL/SQL API within the Oracle E-Business Suite "IGS" (Student Systems / Higher Education) product family, specifically the UC (Universities and Colleges admissions) subsystem. It serves as the primary programmatic interface for maintaining records in the IGS_UC_APP_CLEARING table, which stores centralized clearing application data — the process by which prospective applicants are matched to available places at institutions after the main admissions cycle.

The package is declared AUTHID CURRENT_USER, indicating it executes with the privileges of the invoking schema rather than the defining schema. The header carries an old-style RCS revision tag ($Header: IGSXI04S.pls 115.4), reflecting a long-standing, stable API that has shipped unchanged across EBS 12.1.1 and 12.2.2. It is classified in the ETRM repository as an "OTHER" API type and is referenced by four other packages, confirming its role as a foundational data-access layer for clearing application records.

Key Procedures and Functions

The package exposes eight documented procedures, all of which operate on the clearing application entity:

  • INSERT_ROW — Inserts a new clearing application record, accepting the full set of clearing attributes and returning the generated ROWID and primary key.
  • LOCK_ROW — Acquires a row-level lock on an existing clearing application, used to serialize concurrent updates within an interactive transaction.
  • UPDATE_ROW — Modifies an existing clearing application row, validating the supplied key and column values before writing.
  • ADD_ROW — Performs an insert-or-update style "upsert" operation, generating the key and ROWID where a new row is created.
  • DELETE_ROW — Removes a clearing application record from the base table.
  • GET_PK_FOR_VALIDATION — Returns the primary key for a given row, supporting validation logic in dependent forms and APIs.
  • GET_FK_IGS_UC_APPLICANTS — Retrieves the foreign key linking the clearing record to its parent applicant record.
  • BEFORE_DML — A private-time processing hook invoked prior to DML to enforce business rules and maintain derived columns.

Parameters generally mirror the IGS_UC_APP_CLEARING column list (for example x_app_id, x_enquiry_no, x_cef_no, x_central_clearing, x_institution, x_course, x_campus, x_entry_month, x_entry_year, x_entry_point, x_result, x_cef_received, and x_imported), with a x_mode parameter defaulting to 'R' to control processing behavior.

Tables Accessed

The package reads and writes two documented base objects through APPS synonyms:

  • IGS_UC_APP_CLEARING — The primary clearing application table; all insert, update, delete, and lock operations target this table.
  • IGS_UC_APP_CLEARING_S — The corresponding intersection/segment table, manipulated alongside the header for multi-segment clearing data.
  • DUAL — Used for single-row lookups and validation calls such as key generation checks.

Usage Notes

This package is typically invoked from the Student Systems clearing maintenance forms (the UC clearing window), from concurrent programs that import or reconcile clearing applications from external UCAS/CEF feeds, and from custom PL/SQL that programmatically loads or corrects clearing data. Because it is an AUTHID CURRENT_USER package, callers must hold appropriate grants on the underlying tables. The standard pattern is to call LOCK_ROW before UPDATE_ROW or DELETE_ROW for interactive edits, whereas batch imports use INSERT_ROW or ADD_ROW. Direct DML against the base tables is discouraged; the API enforces the BEFORE_DML business rules and maintains the ROWID and primary-key semantics expected by dependent packages. The "rest clear" search shorthand relates to this clearing-restoration functionality, confirming the package's role in the clearing application lifecycle.