Search Results retrieve_parameter_set




Overview

The APPS.BIS_PMF_ALERT_REG_PUB package body is the public API for managing the Alert Registration Repository within Oracle E-Business Suite. Alert Registration is the mechanism by which Business Intelligence System (BIS) alert definitions are associated with the events, actions, and delivery parameters that determine when and how notifications are dispatched to end users. This package exposes the repository's maintenance operations to external callers in a controlled, standards-compliant manner, insulating them from the underlying private implementation logic housed in BIS_PMF_ALERT_REG_PVT.

The package conforms to the Oracle EBS PL/SQL API coding standards: it declares a package name constant (G_PKG_NAME), accepts an p_api_version argument for version compatibility checking, supports an optional p_commit parameter defaulting to FND_API.G_FALSE, and returns a standard x_return_status value together with a structured error table of type BIS_UTILITIES_PUB.Error_Tbl_Type. Exception handling maps FND_API.G_EXC_ERROR and FND_API.G_EXC_UNEXPECTED_ERROR to the standard return statuses, while an OTHERS handler traps unanticipated failures and records them through BIS_UTILITIES_PVT.Add_Error_Message.

Key Procedures and Functions

  • CREATE_PARAMETER_SET — Creates a new parameter set record in the alert registration repository. The procedure accepts a parameter set record passed by reference as an IN OUT NOCOPY parameter, delegates the insert to the private package, and propagates the return status and error table to the caller.
  • DELETE_PARAMETER_SET — Removes a single parameter set from the repository. Its purpose is the logical or physical deletion of a registration parameter set identified by the caller.
  • RETRIEVE_PARAMETER_SET — Reads an existing parameter set from the repository and returns its attributes to the caller, supporting enquiry and maintenance screens.
  • MANAGE_ALERT_REGISTRATIONS — The principal entry point corresponding to the user's search term. It orchestrates the creation, update, and ongoing maintenance of alert registrations, applying the supplied registration data against the repository. This is the procedure most custom integrations should call when programmatically registering or modifying alert subscriptions.
  • PARAMETER_SET_EXIST — A validation function that determines whether a given parameter set already exists in the repository, allowing callers to avoid duplicate registrations.

Tables Accessed

The ETRM metadata for this object does not enumerate the underlying tables directly. Based on the package's role, the procedures operate against the BIS alert registration repository tables through APPS synonyms, holding alert definitions, parameter sets, and their associations. All persistence work is performed by the private package BIS_PMF_ALERT_REG_PVT; the public package itself performs no direct DML, which preserves the layering of the BIS architecture.

Usage Notes

The package is typically invoked from the Oracle Forms-based Alert Registration maintenance screens, from concurrent programs that seed or migrate alert registrations, and from custom PL/SQL integration code. Callers must always supply p_api_version, inspect x_return_status against the FND_API constants, and read the returned error table when the status is not G_RET_STS_SUCCESS. Because commit control is delegated to the caller, transactional boundaries remain under the invoking program's control. The package is referenced by six other database objects, confirming its role as a shared, stable interface. The header identifies the script as BISPARTB.pls, last updated in December 2002, and the API remains compatible with Oracle EBS 12.1.1 and 12.2.2.