Search Results set_row_data




Overview
Explore in AI Chat

Overview

HXC_TRANS_DISPLAY_KEY_UTILS is a private utility package body in the Oracle E-Business Suite (EBS) Application Object Library, owned by the APPS schema. It belongs to the Oracle Time and Labor (OTL) module, whose schema prefix is HXC, and it is classified under the ETRM metadata as an OTHER API type rather than a public or open interface. The package is not a business API exposed to external callers; instead it provides internal string-manipulation and structural helper logic for translation display keys used in the OTL timecard data-entry framework.

A translation display key follows a positional convention of the form layout_component_id|row_index|column_index, where the layout component identifies a timecard region, the row index identifies a row within that region, and the column index identifies a day or field within the row. The package encapsulates the parsing, mutation, and row-counting operations on these keys so that timecard rendering and data-binding logic elsewhere in the module does not have to reimplement them. The header comment $Header: hxctdkut.pkb 120.3 2008/04/15 ... noship $ indicates a patch-level file last maintained in 2008 and shipped with the product (noship denotes a non-shell, buildable object). The package is referenced by three other packages, confirming its role as a shared internal dependency rather than a top-level entry point.

Key Procedures and Functions

The ETRM metadata lists seven documented procedures and functions. Their names indicate the following responsibilities:

  • MISSING_ROWS — Identifies rows that are absent from a timecard or layout representation, supporting gap detection when rows must be filled or reconciled against expected layout state.
  • NEW_DISPLAY_KEY — Constructs a fresh translation display key, composing the layout component, row, and column components into the canonical pipe-delimited format.
  • REMOVE_EMPTY_ROWS — Eliminates empty or placeholder rows from a timecard structure so that only populated rows remain. This matches the user's search term remove_empty_rows and is the most directly relevant routine for callers wishing to compact a displayed result set.
  • RESET_COLUMN_INDEX_TO_ZERO — Resets the column-index portion of a display key to zero, typically used when re-initialising a row's day pointer during navigation or re-rendering.
  • SET_ROW_DATA — Associates or writes row-level data against a display key, acting as the mutation counterpart to the key-construction functions.
  • TIMECARD_ROW_COUNT — Returns the number of rows present in a timecard structure, used by callers to size loops and validate layout consistency.
  • ALTER_TRANSLATION_KEY — Modifies an existing translation display key in place or returns an altered form, generalising the earlier replace_row_index_in_key private helper documented in the source excerpt.

The source excerpt additionally shows the private function replace_row_index_in_key, which substitutes the row-index segment of a key by locating the first and last pipe delimiters with INSTR and reassembling the string with SUBSTRB. This illustrates the package's thin, stateless, string-oriented design.

Tables Accessed

Two tables are referenced through APPS synonyms:

  • HXC_TIME_BUILDING_BLOCKS — The core OTL table holding time building block records, including the TRANSLATION_DISPLAY_KEY column whose PL/SQL type is used to declare local variables in the package. This table provides the persistent representation of timecard and time-entry rows that the display-key utilities operate against.
  • PLITBLM — A standard Oracle Forms/PL/SQL infrastructure table used for parsing or temporary storage of delimited string data. Its presence indicates that at least one routine splits composite display keys or row data into constituent parts.

Usage Notes

Because the package is owned by APPS and marked OTHER, it is intended for internal consumption within Oracle Time and Labor rather than as a supported public API. It is most commonly invoked indirectly from the OTL timecard user interface, where Oracle Forms logic relies on display keys to map presented rows and columns to underlying time building block records. The REMOVE_EMPTY_ROWS routine is particularly relevant during timecard display, when rows with no entered time must be suppressed or compacted before rendering, and during any process that reconstructs a layout after inserts, deletes, or period changes. TIMECARD_ROW_COUNT and MISSING_ROWS are typically paired with such rendering logic to validate layout integrity.

In Oracle EBS 12.1.1 and 12.2.2, the package body is delivered as part of the shipped HXC product files and should not be customised directly. Customers extending Time and Labor should call the supported public APIs, not this private utility package. Because three other packages depend on it, any change to its behaviour carries regression risk across timecard display, entry, and approval flows. The 12.2.x adoption of the Online Patching (Editioning) model does not alter this package's role; it remains a shared internal helper with a stable interface defined by its caller packages.