Search Results dump_api_output_data




Overview
Explore in AI Chat

Overview

The APPS.AR_CMGT_HZ_COVER_API package is a public PL/SQL API belonging to the Oracle Receivables customer management layer, straddling the Receivables (AR) and Trading Community Architecture (HZ) schemas. It is declared with AUTHID CURRENT_USER, meaning its SQL statements execute under the privileges of the invoking session rather than the package owner, a convention typical of Oracle EBS public APIs that rely on APPS synonyms and grants. The package encapsulates logic for maintaining organization-oriented customer profile data in the TCA model, providing a programmatic alternative to the Receivables customer forms. Its documented surface consists of three procedures: UPDATE_ORGANIZATION, CREATE_PARTY_PROFILE, and DUMP_API_OUTPUT_DATA. The presence of the third procedure is a strong indicator that the package follows the standard EBS API error-handling pattern, in which each business procedure returns p_return_status, p_msg_count, and p_msg_data outputs that callers inspect and print through a dedicated debug helper. The package is referenced by one other package, which confirms it is a dependency in a wider customer-management code path rather than an isolated utility.

Key Procedures and Functions

  • update_organization — The central procedure of the package and the object most commonly searched for as "update_organization". It maintains organization-level attributes on a party record. Documented parameters include p_party_id, which identifies the TCA party to be updated, together with organization profile attributes such as year established, employees total, URL, SIC code type, SIC code, tax reference, and DUNS number. The procedure updates profile and account-level information associated with the party rather than creating the party itself.
  • create_party_profile — Creates the profile row that carries organization attributes for a given party. It accepts the party identifier as input and returns the standard EBS API status triple via p_return_status (declared OUT NOCOPY VARCHAR2), which indicates success, unexpected error, or expected error.
  • dump_api_output_data — A diagnostic helper that accepts the status, message count, and message data returned by the other procedures and emits them for debugging or logging. It carries no business logic.

Tables Accessed

Through APPS synonyms, the package operates on two documented tables. HZ_CUSTOMER_PROFILES holds the profile records that create_party_profile inserts and that update_organization maintains; it is the primary repository for the organization attributes exposed by the API (year established, employees total, URL, SIC classification, tax reference, and DUNS number). HZ_CUST_ACCOUNTS supplies the customer account context linked to the party, allowing the package to validate and align the party's organization data with its Receivables customer representation. The use of shared TCA tables means changes made here are immediately visible to both Receivables and other TCA-enabled applications.

Usage Notes

AR_CMGT_HZ_COVER_API is typically invoked from custom PL/SQL, Receivables customer maintenance flows, or as a supporting routine behind the Customer Standard and Customer Management forms, rather than by a seeded concurrent program. Because its procedures return the standard EBS API status and message outputs, callers should always check p_return_status for FND_API.G_RET_STS_SUCCESS and, on failure, iterate the message stack using p_msg_count and p_msg_data, optionally routing those values through dump_api_output_data during development. The package is dated to Release 12.1 (120.2.12010000.2) and remains documented in ETRM 12.2.2 with APPS as owner and an API classification, so customizations that call it should treat its signature as stable across 12.1.1 and 12.2.2 while honoring the AUTHID CURRENT_USER privilege model and the standard TCA commit and validation expectations.