Search Results pay_upgrade_definitions_pk

Overview

PAY_UPGRADE_DEFINITIONS is an HR-owned table within the Oracle Payroll (PAY) product module. It serves as the control registry that defines each individual Data Upgrade that must be performed against an Oracle E-Business Suite payroll environment. In release 12.1.1 and 12.2.2, this object functions as the central catalogue of upgrade definitions, describing what an upgrade does, how it executes, its criticality, and which legislative context it applies to. The table does not store upgrade results itself; rather, it holds the declarative metadata used by the payroll upgrade engine to orchestrate, parameterize, and monitor execution.

From a data-warehouse modeling perspective, the heuristic Data Vault classification mined from the foreign-key structure is standalone. This suggests modeling the object as an independent hub-like reference entity, since no inbound foreign key to another registry table was identified; dependent records in other tables point to it, not the reverse.

Key Information Stored

The surrogate primary key is UPGRADE_DEFINITION_ID, enforced through PAY_UPGRADE_DEFINITIONS_PK. The documented business-key candidate is the unique index PAY_UPGRADE_DEFINITIONS_UK2, defined over SHORT_NAME and ZD_EDITION_NAME, which allows an upgrade definition to be uniquely identified by its short name within an edition.

• UPGRADE_DEFINITION_ID — surrogate primary key; referenced by dependent parameter and status tables.
• SHORT_NAME — abbreviated business identifier for the upgrade; part of the unique business key.
• ZD_EDITION_NAME — edition qualifier; the second component of the unique business key.
• NAME — descriptive name of the upgrade definition.
• DESCRIPTION — narrative explaining the purpose of the upgrade.
• LEGISLATION_CODE — the legislative context to which the definition applies.
• UPGRADE_LEVEL — the tier or sequence level at which the upgrade runs.
• CRITICALITY — indicates how essential the upgrade is to a successful run.
• THREADING_LEVEL — concurrency or parallelism setting for execution.
• FAILURE_POINT — specifies the stage at which failure handling applies.
• LEGISLATIVELY_ENABLED — flag controlling legislative applicability.
• UPGRADE_METHOD and UPGRADE_PROCEDURE — the mechanism and stored procedure invoked to perform the upgrade.
• QUALIFYING_PROCEDURE — logic used to determine whether a given record qualifies for the upgrade.
• VALIDATE_CODE and ADDITIONAL_INFO — validation control and supplementary configuration.
• Audit columns LAST_UPDATE_DATE, LAST_UPDATED_BY, LAST_UPDATE_LOGIN, CREATED_BY, CREATION_DATE, plus FIRST_PATCHSET and OWNER_APPLICATION_ID for provenance.

Common Use Cases and Queries

Administrators and technical consultants query this table to inventory available upgrades, filter them by legislation or criticality, and join them to execution status. Typical reporting includes listing all critical upgrades and tracking which procedures implement them.

• Inventory of upgrades for a legislation: SELECT short_name, name, upgrade_level FROM pay_upgrade_definitions WHERE legislation_code = :leg;
• Critical upgrade listing: SELECT short_name, criticality, upgrade_procedure FROM pay_upgrade_definitions ORDER BY criticality;
• Join to status to monitor execution outcomes across runs, and to parameters to review configuration values.

Related Objects

The following objects depend on or reference PAY_UPGRADE_DEFINITIONS through documented relationships:

• PAY_UPGRADE_PARAMETERS — joins on UPGRADE_DEFINITION_ID, supplying runtime parameters for each definition.
• PAY_UPGRADE_STATUS — joins on UPGRADE_DEFINITION_ID, recording execution status per definition.

Together these dependent tables form the operational pair used alongside the definition registry to configure, run, and audit payroll data upgrades.