Search Results ar_cmgt_event_pkg




Overview
Explore in AI Chat

Overview

AR_CMGT_EVENT_PKG is a public PL/SQL package in the APPS schema that acts as the event-raising gateway for Oracle Receivables' credit management (CMGT) module within Oracle E-Business Suite 12.1.1 and 12.2.2. Its central purpose is to bridge Receivables credit management activity into the Oracle Workflow Business Event System (BES), allowing internal credit-related conditions to be published as named business events that other applications, subscriptions, or integration layers can consume. The package is declared with AUTHID CURRENT_USER and its header identifies it by the file name ARCMBEVS.pls, consistent with Oracle's internal source control naming for Receivables credit management event services. It exposes a small, focused API rather than transactional credit processing logic, meaning it is invoked at points where credit management code needs to notify subscribers that a business event has occurred.

Key Procedures and Functions

  • exist_subscription — A function that takes an event name and returns a value indicating whether a subscription exists for that event. This is the object referenced by the search term "exist_subscription" and is commonly used to guard event publication so that the system does not raise events with no active listeners. It returns a VARCHAR2 result, typical of Oracle's convention of returning an event name or a status token such as "NOTFOUND".
  • event — A function that accepts an event name and returns a VARCHAR2 value, validating and returning the event name if the entered event exists, and otherwise returning NOTFOUND, as noted in the source comments.
  • item_key — A function that builds the unique item key for an event, taking an event name and a numeric unique identifier. The item key is the business-event correlation value used by Workflow to distinguish individual event instances.
  • AddParamEnvToList — A procedure that appends the application-context parameters to an existing Workflow parameter list (WF_PARAMETER_LIST_T). It accepts optional user, responsibility, responsibility application, security group, and organization identifiers, enabling events to carry a consistent runtime context.
  • raise_event — The principal procedure. Per its embedded comments, it checks whether the event exists, verifies the event name conforms to the pattern 'oracle.apps.ar.cmgt%', retrieves the item key, and raises the event. It accepts the event name, event key, an optional CLOB data payload, and an optional Workflow parameter list.

Tables Accessed

The metadata identifies the underlying Workflow Business Event System tables via APPS synonyms. WF_EVENTS stores the definitions of registered business events. WF_EVENT_SUBSCRIPTIONS holds the subscription registrations checked by exist_subscription. WF_PARAMETER_T and WF_PARAMETER_LIST_T support the parameter list manipulated by AddParamEnvToList and passed into raise_event; WF_PARAMETER_LIST_T is the PL/SQL collection type mirroring WF_PARAMETER_T rows. PLITBLM is the standard Oracle PL/SQL integer-indexed table type used internally for bulk operations. Collectively these objects confirm that the package reads and writes exclusively against Workflow event metadata and parameter structures rather than Receivables transactional tables.

Usage Notes

AR_CMGT_EVENT_PKG is invoked programmatically from Receivables credit management code paths when a business event must be published, and it is referenced by four other packages, indicating a shared internal dependency. Because raise_event enforces the 'oracle.apps.ar.cmgt%' naming prefix, customizations should register events under that namespace to be accepted. Callers typically populate a parameter list through AddParamEnvToList, resolve the item key with item_key, optionally test listeners with exist_subscription, then call raise_event. Direct calls from forms or concurrent programs are unusual; it is normally reached through the credit management package layer or custom code that subscribes to Receivables credit management business events.