Search Results get_prg_appl_inst_dff_values

Overview

IGS_CO_GEN_003 is a general-purpose PL/SQL package owned by the APPS schema within the Oracle E-Business Suite Student System (Oracle Student System / IGS) product family. It belongs to the "Communication" (CO) functional group and is classified under the ETRM as an OTHER API, meaning it exposes a set of standalone utility functions rather than a transactional or entity-maintenance API. The package was originally created in February 2002 to centralize reusable "getter" logic that returns derived person, applicant, and enrollment attribute values needed when generating student correspondence and application-related communications. Its documented header confirms this purpose: it consolidates functions to retrieve person name and address data for correspondence, descriptive flexfield values associated with an application instance, expected program completion dates, and similar attributes. The header also carries a PRAGMA RESTRICT_REFERENCES declaration of WNDS, WNPS on its functions, indicating that these are pure query functions that neither write to database state nor to package state, and are therefore safe for use inside SQL statements. The package is referenced by nine other packages in the EBS instance, confirming its role as a shared lower-level utility dependency within the IGS code base.

Key Procedures and Functions

The documented interface comprises five functions:

• GET_PER_ADDR_FOR_CORR — Returns the person name and address formatted for use in correspondence. It is the primary utility for assembling the addressee block of student letters and mailings.
• GET_PRG_APPL_INST_DFF_VALUES — Returns Application Instance Descriptive Flexfield values for a given applicant and program application instance, allowing institution-specific flexfield attributes to be surfaced in correspondence and processing logic.
• GET_PROGRAM_COMPLETION_DT — Returns the expected program completion date. The header change history records that parameters for attendance type and location code were added in October 2002 for bug 2647482, reflecting that completion date derivation varies by attendance pattern and location.
• GET_RESIDENCY_DFF_VALUES — Returns Residency Descriptive Flexfield values associated with a person's residency record, exposing institution-defined residency attributes to calling programs.
• GET_STUDENT_CITIZENSHIP_STATUS — Returns the student's citizenship status. This function is the object most commonly retrieved when searching the term "get_student_citizenship_status," and it is typically used to print or evaluate citizenship information in student-facing documents and downstream processing rules.

Tables Accessed

The package reads, via APPS synonyms, the following documented tables:

• HZ_PARTIES — TCA party records, used to derive person name components for correspondence addressing.
• FND_LOOKUP_VALUES — Used to translate stored codes (for example, citizenship or residency codes) into their meaningful descriptions.
• IGS_AD_PS_APPL_INST_ALL — Admissions application instance data, the source for application-instance flexfield values and program completion information.
• IGS_PE_EIT — Extra information types for person records, used to store and retrieve institution-defined attributes such as citizenship detail.
• IGS_PE_RES_DTLS_ALL — Person residency details, the basis for residency flexfield value retrieval.

Usage Notes

Because IGS_CO_GEN_003 is a group of pure query functions, it is invoked wherever derived student or applicant attributes must be resolved for display or decision logic. Typical callers include Oracle Student System forms and self-service pages that render correspondence previews, concurrent programs and reports that generate letters, and the other IGS packages known to reference this package. Custom extensions can call the functions directly from PL/SQL or embed them in SELECT statements, since the WNDS/WNPS pragmas guarantee they perform no database or package state modification. The package is shipped with the IGS application code and should be treated as a standard, upgrade-safe utility rather than modified in place.