Search Results hz_suspension_activity_pkg




Overview
Explore in AI Chat

Overview

The APPS.HZ_SUSPENSION_ACTIVITY_PKG package is a low-level data manipulation package within the Oracle E-Business Suite Receivables and Trading Community Architecture (TCA) module. Its principal business function is to maintain the HZ_SUSPENSION_ACTIVITY table, which stores records governing the suspension of activities for parties, customer accounts, or related TCA entities. Suspension activity records are used when an organization wishes to temporarily halt specific business interactions — such as order entry, shipments, or invoicing — against a party or account. The package encapsulates the standard insert, update, lock, and delete operations required to manage these suspension records, ensuring consistent access to the underlying table.

In the ETRM metadata for release 12.2.2 the package is classified with an API classification of OTHER, indicating that Oracle does not publish it as a formally supported public API. It resides in the APPS schema, is reported with a VALID status, and is documented in release 12.1.1 as well as 12.2.2. The package exposes four documented procedures and references a single application table via APPS synonyms. No other packages were documented as referencing it, suggesting it is invoked from a narrow set of callers, most likely the TCA forms and internal TCA maintenance logic.

Key Procedures and Functions

Four procedures are documented for this package. The metadata does not publish parameter lists, so only purpose is described below.

  • INSERT_ROW — Creates a new suspension activity record in the HZ_SUSPENSION_ACTIVITY table. It is the entry point for registering a new suspension against a party, account, or related entity.
  • UPDATE_ROW — Modifies an existing suspension activity record, permitting attributes such as status, dates, or reason to be changed without creating a new row.
  • LOCK_ROW — Acquires a row-level lock on a specific suspension activity record so that concurrent updates cannot occur while a caller is modifying the record. This procedure supports the multi-user integrity of the table.
  • DELETE_ROW — Removes a suspension activity record from the table, typically when the suspension is lifted or the record is otherwise retired.

Collectively these procedures provide a complete CRUD (create, read, update, delete) surface plus explicit locking behaviour.

Tables Accessed

The only documented table referenced by this package is HZ_SUSPENSION_ACTIVITY, accessed through APPS synonyms. This table holds the persistent suspension activity data managed by the four procedures above. Because the package is a table-focused CRUD container, it does not appear in the documented dependencies against other application tables; its scope is deliberately limited to the suspension activity entity. No reference is documented to HZ_PARTIES, HZ_CUST_ACCOUNTS, or other TCA tables at the package dependency level, although callers of the package would normally supply keys to those entities as part of the row data.

Usage Notes

Because HZ_SUSPENSION_ACTIVITY_PKG is classified as OTHER rather than as a supported public API, it is best treated as an internal implementation component. Typical invocation paths are:

  • TCA or Receivables forms that present suspension activity information to end users, which rely on the package for insert, update, lock, and delete operations.
  • Internal TCA maintenance or data-fix routines that need to register, amend, or remove suspension activity records programmatically.
  • Custom code, used with caution. Any custom caller must respect the same locking and validation conventions the packaged procedures assume, since parameter lists are undocumented.

No concurrent programs are documented as calling the package. When upgrading between 12.1.1 and 12.2.2, developers should verify the signature and behaviour of the four procedures in the target environment before relying on them, as OLTP documentation for OTHER-classified packages is limited and the interface is not guaranteed to be backward compatible.