Search Results igs_tr_note_type_pkg




Overview
Explore in AI Chat

Overview

IGS_TR_NOTE_TYPE_PKG is a PL/SQL package owned by the APPS schema that encapsulates the data-manipulation logic for the IGS_TR_NOTE_TYPE entity within the Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 environments. IGS_TR_NOTE_TYPE belongs to the Oracle Student System / Academic Records (IGS) product family, which manages student records, tracking, and academic progression. The "_TR_" infix indicates the table and package relate to the tracking area of the student system — specifically the definition and maintenance of note types used to categorize annotations attached to tracking records, items, groups, steps, and type-steps.

The package is a standard EBS table-handler package generated to provide a controlled API layer over the underlying IGS_TR_NOTE_TYPE table. Rather than allowing direct DML against the base table, the surrounding IGS packages invoke this package so that locking, constraint validation, primary-key derivation, and audit (WHO column) population are performed consistently. The ETRM classification for this package is OTHER, reflecting that it is an internal utility handler rather than a public business API. Its dependency graph is typical of this class of object: it depends only on SYS.STANDARD (the PL/SQL language standard), and it is referenced by four sibling packages — IGS_TR_GROUP_NOTE_PKG, IGS_TR_ITEM_NOTE_PKG, IGS_TR_STEP_NOTE_PKG, and IGS_TR_TYP_STEP_NOTE_PKG — confirming its role as a shared foundation for note-type handling across the tracking subsystem.

Key Procedures and Functions

Eight documented subprograms are exposed by this package:

  • INSERT_ROW — Performs the physical insert of a new row into IGS_TR_NOTE_TYPE, applying default WHO audit columns and any derived values.
  • LOCK_ROW — Acquires a row-level lock (SELECT ... FOR UPDATE) on an existing note type record to serialize concurrent updates.
  • UPDATE_ROW — Updates an existing note type row after locking, populating the LAST_UPDATE_DATE and related audit columns.
  • ADD_ROW — Higher-level creation entry point that validates, checks constraints, and delegates to INSERT_ROW for a new note type.
  • DELETE_ROW — Removes a note type row, subject to referential-integrity validation performed by CHECK_CONSTRAINTS.
  • GET_PK_FOR_VALIDATION — Derives or returns the primary-key value used to identify and validate a specific note type record.
  • CHECK_CONSTRAINTS — Validates business and database constraints (uniqueness, mandatory columns, and foreign-key relationships) before DML proceeds.
  • BEFORE_DML — A pre-DML hook that centralizes audit-column and derived-field processing invoked ahead of insert, update, or delete operations.

The package specification and body are both VALID in the APPS schema, indicating a correctly compiled state at the time of the ETRM extract.

Tables Accessed

The only documented table referenced (through an APPS synonym) is IGS_TR_NOTE_TYPE. This table stores the master definition of note types available for tracking notes. The package reads from it to retrieve and lock existing rows (LOCK_ROW, UPDATE_ROW, DELETE_ROW, GET_PK_FOR_VALIDATION) and writes to it for creation and modification (INSERT_ROW, ADD_ROW, UPDATE_ROW). No additional base tables are documented as direct dependencies of this package; related referential checks are handled by the constraint-validation logic and by the calling packages.

Usage Notes

This package is an internal handler and is not typically invoked directly from a user-facing form. Instead, it is called by the four dependent tracking packages that manage group notes, item notes, step notes, and type-step notes. Those higher-level packages invoke IGS_TR_NOTE_TYPE_PKG when a user creates, amends, or removes a note type through the Oracle Student System tracking setup forms, or when a concurrent program or batch process needs to resolve note-type definitions.

For customizations in 12.1.1 or 12.2.2, Oracle best practice is to call this package's procedures rather than issuing direct DML against IGS_TR_NOTE_TYPE, so that locking, constraint checking, and audit-column maintenance remain consistent with standard EBS behavior. Because the package resides in APPS and is referenced by multiple components, any modification should be evaluated against all four dependent packages before being deployed. Developers should also be aware that the OAF (Oracle Application Framework) pages and any client extensions in the tracking area rely on the same underlying table-handler logic, so direct table writes risk bypassing validation enforced here.