Search Results hz_ui_util_pkg




Overview
Explore in AI Chat

Overview

The APPS.HZ_UI_UTIL_PKG package is a utility package within the Oracle E-Business Suite Release 12.1.1 / 12.2.2 Trading Community Architecture (TCA) / Oracle Customers Online (HZ) schema. It provides centralized UI-layer security and data-access helper logic used by the TCA Java-based and Oracle Forms-based user interfaces. Rather than performing business transactions itself, the package encapsulates reusable predicates and access-check routines that determine whether a given end user may create, view, update, or delete a specific TCA entity, and it resolves the SQL predicates necessary to restrict queries to authorized rows. It is classified as an OTHER API in the ETRM documentation, indicating that it is an internal support package rather than a public, externally-facing API. The package depends on APPS.HZ_MIXNM_UTILITY and the SYS STANDARD package, and the primary package specification and body are wrapped or referenced through the HZ_UI_UTIL_PKG and HZ_UI_UTIL_PKG_W subobjects.

Key Procedures and Functions

The ETRM metadata documents eight procedures/functions in this package:

  • CHECK_ENTITY_CREATION — Verifies whether the current user is permitted to create a new TCA entity (for example, a party, customer account, or relationship) of the given type.
  • GET_VIEW_PREDICATE — Returns a SQL predicate fragment used to filter queries so that only rows the user is authorized to view are returned.
  • CHECK_ROW_ACCESS — General row-level access check that evaluates whether a user may access a specific TCA record.
  • CHECK_ROW_VIEWABLE — Determines whether a specific row is visible to the current user in the UI context.
  • CHECK_ROW_UPDATEABLE — Determines whether the current user holds update privileges on a specific row.
  • CHECK_ROW_DELETEABLE — Determines whether the current user is permitted to delete a specific row.
  • CHECK_COLUMNS — Evaluates column-level visibility or editability rules, typically driving which attributes appear or are editable in a form.
  • GET_VALUE — Retrieves a utility value used by the UI layer, typically resolving descriptive or lookup information for display.

The naming convention (CHECK_ROW_*) reflects a consistent CRUD-authorization model: the package exposes discrete, Boolean-returning predicates for each DML operation.

Tables Accessed

The package references the following tables via APPS synonyms:

  • HZ_CUST_ACCOUNTS — Customer account records; checked for view/update/delete authorization and entity creation rights.
  • HZ_CUST_ACCT_SITES_ALL — Customer account site usages and locations, used in the same access-control evaluations.
  • HZ_PARTIES — The core TCA party entity (persons, organizations, groups) against which most access checks are made.
  • HZ_PARTY_SITES — Party site assignments linking parties to locations, consulted for row-level filtering.
  • HZ_RELATIONSHIPS — Party relationship records, used to resolve access rights derived from relationships.
  • PLITBLM — A PL/SQL index-by table utility type used internally by the package for set- or bulk-based processing.

These tables supply the entity identifiers and ownership/relationship data needed to compute security predicates. The package writes to none of them directly; it reads them to evaluate access.

Usage Notes

HZ_UI_UTIL_PKG is an internal UI-support package. It is typically invoked by TCA and Customers Online user interface components — Oracle Forms and OA Framework / JTT-based screens — rather than by concurrent programs. Because the public APIs of the Applications Technology layer do not call it, custom code should not depend on this package unless replicating UI behavior; Oracle may change its internals without notice. In 12.1.1 and 12.2.2 the package is present as both a specification and a wrapped body; the _W subobject indicates the wrapped body consumed at runtime. Developers inspecting dependencies will note it depends on HZ_MIXNM_UTILITY for mixed-name handling and is referenced only by the sibling UI utility objects. For routine integration, the documented public HZ APIs (rather than HZ_UI_UTIL_PKG) should be used.