Search Results igf_ap_pers_note_pkg




Overview

The APPS.IGF_AP_PERS_NOTE_PKG package body is a stored PL/SQL API within the Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 environments, residing in the APPS schema. It supports the Oracle Grants Management / Oracle Financials product family—specifically the grants-related "IGF" (formerly IGS) module that manages person and award data. Its principal business function is to provide the programmatic interface for creating, maintaining, locking, and validating records in the IGF_AP_PERS_NOTE table, which stores notes associated with persons and base records. The package encapsulates the data-manipulation logic, referential validation, and message handling required to keep note records consistent with their parent entities, ensuring that callers do not manipulate the underlying table directly. The package is classified in ETRM as an "OTHER" API, indicating it is an internal support API rather than a formally published public API, and it is documented as VALID in the EBS metadata.

Key Procedures and Functions

The package body exposes nine documented procedures and functions covering the full note lifecycle:

  • INSERT_ROW — Inserts a new note record into IGF_AP_PERS_NOTE, populating the primary key and audit columns.
  • LOCK_ROW — Obtains a row-level lock on an existing note, typically invoked before an update or delete to prevent concurrent modification.
  • UPDATE_ROW — Modifies the attributes of an existing note record while preserving key and audit integrity.
  • ADD_ROW — A convenience routine that combines insert and validation logic for adding a note.
  • DELETE_ROW — Removes a note record from the table.
  • GET_PK_FOR_VALIDATION — Derives or returns the primary key value used during validation of a note.
  • GET_FK_IGS_PE_NOTE_TYPE — Retrieves the foreign key value referencing the person note type lookup, supporting note-type validation.
  • GET_FK_IGF_AP_FA_BASE_REC — Retrieves the foreign key value referencing the associated base record, linking the note to its originating entity.
  • BEFORE_DML — A shared pre-DML routine that performs common validation and defaulting tasks invoked by the insert/update/delete operations.

Tables Accessed

The primary table referenced by this package is IGF_AP_PERS_NOTE, accessed via its APPS synonym. This table holds the person note rows that the package inserts, locks, updates, and deletes. In addition, the package references IGF_AP_FA_BASE_REC_PKG and the base record it manages, confirming that notes are tied to a base record through the GET_FK_IGF_AP_FA_BASE_REC function. Note-type lookups are resolved through IGS_LOOKUPS_VIEW_PKG, supporting GET_FK_IGS_PE_NOTE_TYPE. Error and message handling relies on APP_EXCEPTION, FND_MESSAGE, and IGS_GE_MSG_STACK, while FND_GLOBAL supplies session context such as the current user and login.

Usage Notes

As an internal API classified as "OTHER," IGF_AP_PERS_NOTE_PKG is not typically called directly from end-user screens. Instead, it is invoked by Oracle Forms applications, concurrent programs, and other PL/SQL packages in the Grants module that manage person notes. The ETRM metadata indicates the package body references IGF_AP_PERS_NOTE_PKG itself (recursive reference) and is referenced by one other package, confirming it functions as a shared utility for note maintenance. Customizations and extensions that require programmatic note creation or update should call these procedures rather than issuing direct DML against IGF_AP_PERS_NOTE, thereby preserving the validation, foreign-key resolution, and message-stack behavior implemented in BEFORE_DML and the associated routines.