Search Results igs_ge_note_pkg




Overview

IGS_GE_NOTE_PKG is a general-purpose PL/SQL package in the Oracle EBS Student Systems (IGS) product family, owned by APPS and declared with AUTHID CURRENT_USER. Its name indicates that it manages notes associated with records in the IGS schema, storing free-form note text keyed by a reference number and a note format type. The package follows the standard Oracle EBS table-handler (TPP) pattern: it exposes the full set of row-level DML operations required to maintain a single base table, together with foreign key validation and constraint checking routines that support the underlying Forms-based user interface. In EBS terminology it is classified as API classification OTHER, meaning it is a generated table handler rather than a public business API, and its use is generally limited to the form or component for which it was generated. The package supports the note-capture business requirement — attaching descriptive, formatted notes to reference records within the student information model — and provides the referential-integrity logic that links each note to the lookup that defines its format type.

Key Procedures and Functions

  • INSERT_ROW — Inserts a new note record into the base table, accepting the row identifier, reference number, note format type and note text, with a mode parameter defaulting to 'R'.
  • LOCK_ROW — Acquires a row-level lock on the identified note record, used to enforce optimistic concurrency control during interactive updates.
  • UPDATE_ROW — Updates the reference number, note format type and note text of an existing note identified by row identifier.
  • ADD_ROW — Combines the insert semantics required by the Forms layer, accepting the same attribute set as INSERT_ROW and returning the row identifier.
  • DELETE_ROW — Deletes the note record identified by row identifier.
  • GET_PK_FOR_VALIDATION — Boolean function that validates the primary key, taking a reference number and confirming the existence of the underlying record.
  • GET_FK_IGS_LOOKUPS_VIEW — Foreign key validation procedure for the note format type. It checks that the value supplied for the format type exists in the IGS lookups view, thereby enforcing the relationship between the note and its lookup definition. This is the routine most commonly cited in searches for the package.
  • Check_Constraints — Validates column constraints, optionally scoped to a single column and value, and is invoked by the other DML routines.
  • Before_DML — Internal hook that populates audit columns and performs pre-DML validation, calling the constraint and foreign key checks before insert, update or delete.

Tables Accessed

The package operates on IGS_GE_NOTE via the APPS synonym, which holds the note text, its reference number and its format type. The format type is validated against the IGS lookups view through GET_FK_IGS_LOOKUPS_VIEW, so the package also reads the lookups entity indirectly. Audit columns (creation date, created by, last update date, last updated by, last update login) are handled in Before_DML.

Usage Notes

IGS_GE_NOTE_PKG is invoked primarily from the Oracle Forms UI that maintains notes, and it is referenced by 25 other packages in the IGS schema, indicating broad internal reuse for note handling. Because it is a generated table handler, custom code should avoid calling it directly where a public API exists; direct invocation requires setting the FND global context and passing a valid row identifier. In 12.1.1 and 12.2.2 the package resides in the APPS schema and is deployed through the standard IGS patch cycle.