Results for “grossup_allowed_flag”

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

Overview

HR_S_DEFINED_BALANCES is a Human Resources (PER) module table within the Oracle E-Business Suite HR schema. In the ETRM 12.2.2 metadata the object is documented as VALID and carries the description "Retrofitted," indicating that it was introduced or re-registered as part of an upgrade or retrofit effort rather than as an original seed object. Functionally, the table serves as the definition layer for configured balances used by Oracle HRMS compensation and payroll balance processing. It governs how a named balance is derived, which dimensions qualify it, which legislation it applies to, and how the balance should be handled at runtime.

The heuristic Data Vault classification mined from the FK structure is standalone, which is best read as a modeling suggestion that the object behaves largely as a reference or configuration entity rather than as a transactional hub or link. Practitioners designing a Data Vault or dimensional model around HR balances would therefore typically treat HR_S_DEFINED_BALANCES as a satellite-like descriptor of balance definitions, keyed by a surrogate identifier and surrounded by descriptive attributes.

Key Information Stored

The documented physical schema lists 16 columns. The most significant are summarized below.

• DEFINED_BALANCE_ID — the surrogate primary key for each defined balance row.
• BUSINESS_GROUP_ID — the operating unit/business group partition, a standard HRMS multi-tenancy discriminator and a strong business-key candidate.
• LEGISLATION_CODE — the legislative context (for example US, GB, CA) that scopes the balance definition.
• BALANCE_TYPE_ID — references the underlying balance type that this definition is built upon.
• BALANCE_DIMENSION_ID — the foreign key to PAY_BALANCE_DIMENSIONS, defining the dimensional context in which the balance is calculated.
• LEGISLATION_SUBGROUP — further refinement of the legislative grouping, useful when multiple sub-jurisdictions exist.
• FORCE_LATEST_BALANCE_FLAG — controls whether the engine must recompute and return the most current balance rather than a cached value.
• GROSSUP_ALLOWED_FLAG — indicates whether gross-up processing is permitted for the defined balance.
• SAVE_RUN_BALANCE and RUN_BALANCE_STATUS — runtime control and status fields governing balance persistence during a payroll or balance run.
• OBJECT_VERSION_NUMBER — the optimistic locking column used by the Oracle ADF/BC4J framework.
• LAST_UPDATE_DATE, LAST_UPDATED_BY, LAST_UPDATE_LOGIN, CREATED_BY, CREATION_DATE — standard WHO audit columns.

Business-key candidates typically combine BUSINESS_GROUP_ID with LEGISLATION_CODE, BALANCE_TYPE_ID, and BALANCE_DIMENSION_ID; the surrogate DEFINED_BALANCE_ID remains the reliable join key.

Common Use Cases and Queries

Typical scenarios involve reporting on configured balances, auditing which dimensions and legislation a balance is bound to, and diagnosing gross-up or run-balance behavior. A representative query joining to the dimension table is:

• SELECT d.defined_balance_id, d.balance_type_id, d.legislation_code, dim.balance_dimension_name FROM hr_s_defined_balances d, pay_balance_dimensions dim WHERE d.balance_dimension_id = dim.balance_dimension_id AND d.business_group_id = :p_bg_id;
• Filtering by FORCE_LATEST_BALANCE_FLAG = 'Y' to identify definitions that force recomputation.
• Filtering by GROSSUP_ALLOWED_FLAG = 'Y' for gross-up eligibility reporting.
• Monitoring RUN_BALANCE_STATUS and SAVE_RUN_BALANCE to trace run-time balance persistence issues.

Because the table is configuration-oriented rather than high-volume transactional, queries are usually low-cost and can be safely embedded in concurrent programs, BI Publisher extracts, and Fast Formula diagnostics.

Related Objects

The documented foreign key relationship anchors the object to the balance dimension model. The most significant related objects are:

• PAY_BALANCE_DIMENSIONS — joined via BALANCE_DIMENSION_ID, the primary documented FK.
• PAY_BALANCE_TYPES — referenced indirectly through BALANCE_TYPE_ID, supplying the balance name and classification.
• PAY_BALANCES — the runtime balance values produced for definitions configured here.
• PAY_BALANCE_ATTRIBUTES — additional descriptive attributes attached to balance definitions.
• HR_S_BALANCE_* sibling tables — related retrofitted definition objects sharing the DEFINED_BALANCE_ID naming convention.
• PER_BUSINESS_GROUPS — joined via BUSINESS_GROUP_ID to resolve the operating group.

Oracle HRMS balance APIs and the payroll balance calculation engine consume these definitions, so changes to HR_S_DEFINED_BALANCES directly affect how balances are derived and reported.