Search Results hxc_trans_display_key_utils




Overview
Explore in AI Chat

Overview

HXC_TRANS_DISPLAY_KEY_UTILS is an Oracle E-Business Suite PL/SQL utility package owned by the APPS schema (API classification: OTHER). It forms part of the Oracle Time and Labor (OTL) middle-tier processing infrastructure, specifically the layer that prepares timecard data for rendering in self-service web pages and forms. Its central responsibility is the construction, validation, and maintenance of the translation display key, a delimited string assembled from the display attributes of a timecard's building blocks. This key drives how timecard rows are grouped, ordered, and labelled when presented to end users, and it enables the presentation layer to detect anomalies — most notably missing or non-sequential rows — before the timecard is displayed.

The package header (hxctdkut.pkh, version 120.2, dated 2007) defines a nested associative array type, translation_row_used, indexed by binary_integer and holding pls_integer values. A value of 1 marks a row index as populated for the current timecard; absent indices indicate rows where no detail appeared according to the display translation key. A constant, c_key_separator, set to the pipe character (|), delimits the components of the key.

Key Procedures and Functions

The package exposes seven documented program units:

  • MISSING_ROWS — Returns true when gaps exist in the row data index (that is, the index is not sequential), signalling that the timecard may not render correctly and that corrective action is required.
  • NEW_DISPLAY_KEY — Generates a fresh translation display key, assembling its components with the pipe separator.
  • REMOVE_EMPTY_ROWS — Strips row entries that contain no displayable detail, compacting the row set prior to display.
  • RESET_COLUMN_INDEX_TO_ZERO — Reinitialises column indexing, typically between timecards or rebuild passes, so that column sequencing restarts from a defined baseline.
  • SET_ROW_DATA — Populates the translation_row_used structure with row usage information gathered during timecard retrieval.
  • TIMECARD_ROW_COUNT — Returns the number of rows associated with the current timecard.
  • ALTER_TRANSLATION_KEY — Modifies an existing display key, supporting adjustments when row usage or display attributes change.

Documentation does not publish parameter lists for these units; callers should consult the package specification in the target environment.

Tables Accessed

The package references two objects via APPS synonyms: HXC_TIME_BUILDING_BLOCKS, the core OTL table storing the individual components that make up a timecard, from which display attributes are derived when building keys and evaluating row usage; and PLITBLM, the standard PL/SQL table-to-database interface used to pass PL/SQL index-by tables to and from the database tier. Access to HXC_TIME_BUILDING_BLOCKS is read-oriented, supporting key construction and row analysis.

Usage Notes

HXC_TRANS_DISPLAY_KEY_UTILS is not an end-user-facing API. It is invoked internally by the OTL middle-tier timecard retrieval flow — principally form and self-service timecard pages — and is referenced by three other packages within the application. The typical sequence is: row data is loaded via SET_ROW_DATA, missing rows are identified with MISSING_ROWS, empty rows are eliminated through REMOVE_EMPTY_ROWS, and the final key is produced by NEW_DISPLAY_KEY or adjusted by ALTER_TRANSLATION_KEY. Customisations should treat this package as private implementation; direct calls risk breaking assumptions about index origin at 1 and the pipe-delimited key format. Searches unrelated to Oracle EBS, such as the key-retrieval query that returned this article, will not find a product-key function here.