Results for “dimension_description”

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

Overview

PAYFV_US_BALANCE_VALUES is a PL/SQL view owned by the APPS schema in Oracle E-Business Suite, belonging to the Payroll (PAY) product family. It is maintained as a copy of the view PAY_US_BALANCE_VALUES_V, created for the BIS (Business Intelligence System) team to conform to their naming conventions. The view exposes US-specific payroll balance data — the accumulated results of payroll processing such as earnings, deductions, taxes, and employer contributions — at the assignment and payroll action level. Its role is primarily reporting and integration: it provides a stable, BIS-friendly interface over the underlying payroll balance view so that downstream extracts, warehouse loads, and analytical reports do not need to reference the original view name directly. The view carries the standard object status of VALID and is available in both EBS 12.1.1 and 12.2.2 environments.

Underlying Base Objects

According to the documented view metadata, PAYFV_US_BALANCE_VALUES is defined over two referenced base objects:

• PAY_US_BALANCE_VALUES_V (VIEW) — the core source of all columns; the PAYFV view is a direct projection of this view with no filtering or transformation.
• PAY_BALANCE_PKG (PACKAGE) — the underlying payroll balance package that supplies the business logic for resolving balance values and dimensions.

Because the view text is a straight SELECT of fifteen named columns from PAY_US_BALANCE_VALUES_V, its behavior and row population are governed entirely by the base view and, in turn, by PAY_BALANCE_PKG. Any change to the base view's definition or to the balance package will propagate transparently to PAYFV_US_BALANCE_VALUES.

Key Columns

The view exposes the following columns, which together describe a balance value in its payroll context:

• ASSIGNMENT_ACTION_ID — identifier of the assignment action that produced the balance entry.
• ASSIGNMENT_ID — the employee assignment to which the balance belongs.
• PAYROLL_ACTION_ID — the payroll action that generated the run.
• EFFECTIVE_DATE — the date on which the balance value takes effect.
• BALANCE_TYPE_ID / BALANCE_NAME — the balance type identifier and its descriptive name.
• BALANCE_DIMENSION_ID / DIMENSION_NAME / DIMENSION_DESCRIPTION — the dimension (for example, assignment, tax unit, or jurisdiction) used to qualify the balance.
• DATABASE_ITEM_SUFFIX — the suffix that maps the balance to its database item definition; this column is the key linkage to the searched term and to database item configuration.
• DEFINED_BALANCE_ID — identifier of the defined balance.
• ROUTE_ID — routing identifier associated with the balance.
• VALUE — the numeric result of the balance, in the balance's defined currency or units.
• JURISDICTION_CODE / TAX_GROUP — US jurisdiction and tax group qualifiers for tax-related balances.

Common Use Cases and Queries

Typical uses include extracting balance values for a payroll period, reconciling tax balances by jurisdiction, and feeding downstream BIS reporting or data warehouse loads. A representative query retrieving balance values for a specific assignment follows:

SELECT assignment_id,
       effective_date,
       balance_name,
       dimension_name,
       database_item_suffix,
       value,
       jurisdiction_code
FROM   apps.payfv_us_balance_values
WHERE  assignment_id = :p_assignment_id
AND    effective_date BETWEEN :p_start_date AND :p_end_date
ORDER BY effective_date, balance_name;

To aggregate values by balance for a payroll action:

SELECT balance_name,
       SUM(value) total_value
FROM   apps.payfv_us_balance_values
WHERE  payroll_action_id = :p_payroll_action_id
GROUP BY balance_name;

Because the view is a direct wrapper over PAY_US_BALANCE_VALUES_V, it should be queried read-only; performance depends on the base view's own tuning and indexing within the payroll schema.