Results for “hz_citizenship_pkg”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

The APPS.HZ_CITIZENSHIP_PKG package body encapsulates the business logic required to maintain citizenship records within the Oracle E-Business Suite Trading Community Architecture (TCA). Citizenship data associates a party with one or more countries and defines the legal relationship between an individual or organization and a nation-state. This information is used across multiple EBS modules, including Human Resources, Payroll, Order Management, and regulatory reporting, for functions such as country-of-origin determination, tax treaty eligibility, and compliance with immigration and export-control regulations.

The package exposes a low-level CRUD (Create, Read, Update, Delete) API over the underlying HZ_CITIZENSHIP and HZ_CITIZENSHIP_S tables. It is a private implementation package in the sense that the documented ETRM metadata shows APPS.HZ_CITIZENSHIP_PKG is not referenced by any other database object. Instead, other TCA packages, forms, and the public TCA party API layer call this package to persist citizenship rows on behalf of a party.

Key Procedures and Functions

Five documented procedures form the operational surface of the package:

• INSERT_ROW — Inserts a new citizenship record for a party, populating the primary HZ_CITIZENSHIP row and, where applicable, its corresponding HZ_CITIZENSHIP_S (translation) rows for multilingual installations.
• LOCK_ROW — Acquires a row-level lock on an existing citizenship record to guarantee exclusive access during a subsequent update or delete, preventing lost updates in multi-user environments.
• UPDATE_ROW — Modifies the attributes of an existing citizenship record, including the associated country, date range, and primary citizenship flag, with validation and concurrency handling.
• SELECT_ROW — Retrieves a single citizenship record by its primary key, returning the column values to the calling program for display or further processing.
• DELETE_ROW — Removes a citizenship record and its dependent translation rows, applying referential integrity rules defined by TCA.

The procedures raise errors through FND_MESSAGE, FND_MSG_PUB, and APP_EXCEPTION, following the standard EBS API error-handling model. Common utility routines are supplied by HZ_UTILITY_V2PUB and the FND_API generic API framework.

Tables Accessed

The package reads and writes the following documented tables via APPS synonyms:

• HZ_CITIZENSHIP — The primary TCA citizenship entity, storing the party identifier, country, date range, and primary flag. It is the principal target of INSERT_ROW, UPDATE_ROW, and DELETE_ROW and the source for SELECT_ROW.
• HZ_CITIZENSHIP_S — The translation (TL) table holding language-specific descriptive text. It is maintained in parallel with the base table to support multilingual deployments.
• DUAL — Used for lightweight scalar expressions such as sequence lookups and system-date retrieval.

Usage Notes

This package is typically invoked indirectly rather than directly by end users. It is called by the TCA party API layer (for example, the public HZ_PARTY_V2PUB interactions) and by Oracle Forms that maintain the Party > Citizenship region. Concurrent programs and custom PL/SQL that need to create or maintain citizenship data should use the public TCA APIs wherever possible, since the public layer applies the complete set of validations and business rules before delegating to this package. In Oracle EBS 12.1.1 and 12.2.2 the object resolves as VALID in the APPS schema, and its status as a non-referenced internal package means it is safe to treat as an implementation detail — customizations should not depend on its signature unless the equivalent public API is unavailable.