Results for “cancel_award_fabase”
4 results
AI-generated from documented ETRM metadata — verify critical details on the linked pages.
Overview
The APPS.IGF_AW_CANCEL_AWD package is a member of the Oracle E-Business Suite financial aid module family, specifically the Oracle Grants/Funds Management "Award" (IGF_AW) subsystem responsible for administering student and sponsor awards. Its principal business function is to provide a controlled, validated mechanism for cancelling an existing award record while preserving referential integrity across the interdependent award, fund, and financial-aid base tables. Cancellation of an award is a significant transactional event: it reverses or voids award funding, affects the associated financial aid base record used by disbursement processing, and updates the award's lifecycle status. Because these effects span multiple schemas and tables, the package encapsulates the business rules that determine whether an award is eligible for cancellation and performs the coordinated updates required to execute it. The object is registered in the ETRM as a VALID PL/SQL package owned by the APPS schema, has an API classification of OTHER, and is documented with five procedures/functions. It is a standalone utility package — the ETRM reports that it is referenced by zero other packages and does not form part of a public callable API chain, indicating that it is invoked internally rather than exposed as a general-purpose integration point.
Key Procedures and Functions
The documented callable units are:
- CANCEL_AWARD — the primary entry point that performs the cancellation of an award, applying the package's business rules and updating the award record accordingly.
- CHK_AWD_CANCEL — a validation routine that checks whether a given award may legitimately be cancelled, returning or signalling the outcome of that eligibility test before any destructive action is taken.
- CANCEL_AWARD_FABASE — cancels or voids the associated financial aid base record (the
IGF_AP_FA_BASE_REC_ALLentry) that underpins the award, keeping the base record consistent with the cancelled award. - CHK_AWD_EXP_DATE — validates the award's expiration date, a check relevant to determining whether an award is still active and therefore cancellable.
- GET_BASE_ID_PER_NUM — a lookup function that retrieves the base record identifier associated with a person number, resolving the linkage between the person and their financial aid base record.
Parameter signatures are not documented in the ETRM and are deliberately omitted here.
Tables Accessed
Through APPS synonyms the package references the following documented tables:
- IGF_AW_AWARD_ALL — the core award table; the award being cancelled is updated here.
- IGF_AP_FA_BASE_REC_ALL — the financial aid base record underlying the award, cancelled via
CANCEL_AWARD_FABASE. - IGF_AW_FUND_MAST_ALL — the award fund master, providing fund context for the cancellation.
- HZ_PARTIES — the Trading Community Architecture party record for the award recipient.
- IGS_CA_INST_ALL and IGS_PE_PERSID_GROUP_ALL — student/calendar instance and person identification-group data used to resolve the recipient and their enrollment context.
Additional dependencies visible in the ETRM metadata include IGF_AW_AWARD, IGF_AP_FA_CON_V, IGF_LOOKUPS_VIEW, IGS_PE_PERSON_BASE_V, and IGS_PE_ALL_PERSID_GROUP_V, which supply award header, conversion, lookup, and person views.
Usage Notes
Because the package is referenced by no other PL/SQL object in the ETRM graph, invocation occurs from outside the PL/SQL dependency chain — typically from an Oracle Forms award maintenance screen, from the Awards concurrent program set, or from custom concurrent programs and extensions that need to cancel awards in bulk. Custom code should call CHK_AWD_CANCEL first to confirm eligibility, and GET_BASE_ID_PER_NUM to resolve the base record before invoking CANCEL_AWARD, which in turn drives CANCEL_AWARD_FABASE. The package is present and valid in both EBS 12.1.1 and 12.2.2; the underlying IGF award schema is unchanged across these releases, so customizations remain portable.