Search Results hz_api_file_debug_on

Overview

The APPS.HZ_EVENT_PKG package body implements the Oracle E-Business Suite event publishing infrastructure used by the Trading Community Architecture (TCA) and Oracle Workflow integration layer. Its principal business function is to accept application-level business events raised by TCA entities — most notably customer, party, account, and contact record changes — and translate them into Oracle Workflow events that subscribers may consume. In this role it acts as the mediator between the TCA Registry and the Workflow Event System, ensuring that downstream subscribers such as order capture, receivables, and customer-facing workflows are notified when reference data changes.

The package is classified under the ETRM as an OTHER API rather than a public, externally supported interface. This classification signals that the package is intended primarily for internal use by the TCA application code and by seeded components, and that its interface is not guaranteed for customer extensions. The header revision string identifies the source file as ARHEVESB.pls, confirming an original relationship to the Receivables/TCA event subscription domain.

Key Procedures and Functions

• EVENT — The primary event publication routine. It constructs and dispatches a Workflow event for a named TCA business activity, mapping the caller's context into the Workflow event payload.
• RAISE_EVENT — Invokes the Oracle Workflow event raise mechanism for a specified event name and key, making the event available to registered subscriptions. This is the documented entry point used by TCA code to broadcast changes.
• EXIST_SUBSCRIPTION — Returns 'Y' when a subscription for the supplied event name exists, otherwise 'N'. As documented in the source excerpt, it tests for the presence of the subscription parameter element hz_event_elt.hz_param_delete, allowing callers to avoid raising events that no subscriber will process.
• ITEM_KEY — Derives or returns the unique item key used to correlate a Workflow event with its originating TCA entity, providing the correlation identifier consumed by subscribers.
• ADDPARAMENVTOLIST — Population helper that appends parameter name/value pairs to the Workflow parameter list structure prior to raising the event.

The source body also documents private routines enable_debug and disable_debug; these are commented out in the delivered code. They reference the profiles HZ_API_FILE_DEBUG_ON and HZ_API_DBMS_DEBUG_ON and delegate to HZ_UTILITY_V2PUB. The profile HZ_API_FILE_DEBUG_ON is the object returned when the search term "hz_api_file_debug_on" is entered; it controlled file-based debug output for the HZ API family, but the corresponding logic in this package body is inactive in the 12.1.1 / 12.2.2 releases.

Tables Accessed

• WF_EVENTS — Event definitions consulted to validate and resolve the event name being raised.
• WF_EVENT_SUBSCRIPTIONS — Drives EXIST_SUBSCRIPTION and routing of the raised event to interested subscribers.
• WF_PARAMETER_LIST_T and WF_PARAMETER_T — Temporary parameter structures populated by ADDPARAMENVTOLIST and passed into the Workflow event payload.
• WF_SYSTEMS — Identifies the owning Workflow system for the event.
• HZ_WF_ITEMS_S — TCA-specific Workflow item store linking events to TCA entities.
• DUAL and PLITBLM — Utility access for scalar evaluation and PL/SQL table handling.

Usage Notes

HZ_EVENT_PKG is invoked indirectly by TCA entity maintenance logic and by concurrent programs that process bulk customer or party updates. Because the package is referenced by five other packages, direct custom calls should be treated as unsupported. Custom subscribers should instead register interest through standard Workflow subscription setup on the published event names rather than calling RAISE_EVENT directly. Debug behaviour is governed by the HZ API profile options, though the file debug path is disabled in the delivered body.