Search Results gms_po_api2_grp




Overview
Explore in AI Chat

Overview

APPS.GMS_PO_API2_GRP is a PL/SQL group (GRP) package within the Oracle E-Business Suite Grants Management module. In EBS 12.1.1 and 12.2.2, this package provides the application programming interface layer that bridges Grants Management award data with Oracle Purchasing transactional data. Its principal business purpose is to support the creation and maintenance of award-linked purchasing distributions and the purging of purchasing documents associated with grants and awards. The package is declared with AUTHID CURRENT_USER, meaning that its SQL statements execute with the privileges of the invoking user rather than the definer, which has implications for schema-level grants and synonym resolution across the APPS schema.

The source header ($Header: gsgpo2s.pls 120.1 2005/07/26) indicates the package has been stable since the mid-2000s and remains part of the standard Grants Management code line through the 12.x releases. Because it is classified as a GRP package, it is intended to be called as a cohesive unit rather than consumed as individual public APIs, though its procedures are individually invocable.

Key Procedures and Functions

The ETRM metadata documents four procedures/functions within this package. Their names and purposes are as follows:

  • CREATE_ADLS — Creates award distribution lines (ADLs), establishing the linkage between a grant award and the purchasing distribution records that carry the award reference. This is the primary interface used when a purchasing document must be associated with grant-funded activity.
  • VALIDATE_PO_PURGE — Performs validation logic to determine whether a given purchasing document (or set of entities) is eligible for purge. It returns entity identifiers and an action indicator via the purge-out record type, allowing the caller to decide whether to proceed with the physical purge.
  • PO_PURGE — Executes the purge of purchasing documents and their related distributions that are tied to grant awards, removing obsolete or invalid records that would otherwise obstruct award closeout or data cleanup.
  • GET_AWARD_NUMBER — Retrieves the award number associated with a given entity, providing a lookup utility used by the other routines and by external callers that need to resolve a distribution back to its parent award.

The package defines several collection and record types, including TBL_NUM, TBL_V1, TBL_V15, PURGE_IN_RECTYPE (entity_name, entity_ids), and PURGE_OUT_RECTYPE (entity_ids, action), which are used as the parameter carriers for the purge routines. Standard API parameters (p_api_version, p_init_msg_list, p_commit, p_validation_level, x_return_status, x_msg_count, x_msg_data) follow the conventional EBS API calling contract.

Tables Accessed

Four tables are referenced via APPS synonyms:

  • GMS_AWARDS_ALL — The base award table; read to resolve award identity and attributes during distribution creation and award-number lookup.
  • GMS_AWARD_DISTRIBUTIONS — The award distribution table; the target of inserts and updates performed by CREATE_ADLS.
  • PO_DISTRIBUTIONS_ALL — The purchasing distributions table; used to link or purge the purchasing-side distribution records that carry the award reference.
  • PLITBLM — A PL/SQL table (index-by table) used internally for message storage and bulk operations.

Usage Notes

This package is typically invoked from Grants Management forms and concurrent programs that manage award-linked purchasing activity, and from custom extensions that must create or purge award distributions. Because one other package references it, callers should treat the group as a dependent API rather than an entry-point. When calling PO_PURGE, the standard EBS API contract should be observed: pass p_init_msg_list and p_commit appropriately, check x_return_status against G_RET_STS_SUCCESS ('S'), G_RET_STS_ERROR ('E'), and G_RET_STS_UNEXP_ERROR ('U'), and retrieve messages via x_msg_count and x_msg_data when an error occurs.