Results for “do_retrieval_translation”
8 results
AI-generated from documented ETRM metadata — verify critical details on the linked pages.
Overview
HXC_ALIAS_TRANSLATOR is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports the translation of alias values used within the Oracle Time and Labor (OTL) self-service timecard and deposit processing framework. Aliases in OTL provide a mechanism to display alternative or user-friendly representations of timecard attributes, building block information, and reference objects instead of raw identifiers. The package acts as the runtime translation engine that converts stored alias identifiers into their display or reference values during self-service time entry and retrieval operations.
The package is classified as an OTHER API, meaning it is not intended as a public integration API but rather as an internal processing utility invoked by the OTL self-service stack. It is referenced by ten other packages, indicating its central role in the alias resolution chain. The header comment references Bug 6943339, which introduced an associative array (g_vset_fmt) to hold value set formats across translation procedures. This array caches the value set format keyed by reference object identifier and is used only when an alias name is based on a value set of type "none."
Key Procedures and Functions
The package exposes two documented procedures:
- DO_DEPOSIT_TRANSLATION — Handles alias translation during the deposit (save) path of self-service time entry. It accepts an attribute collection and a message collection, both passed as IN OUT NOCOPY parameters so that translated values and any diagnostic messages are returned to the caller with minimal copying overhead. This procedure is the target of the search term "do_deposit_translation" and is the preferred entry point when alias values must be resolved before timecard data is persisted.
- DO_RETRIEVAL_TRANSLATION — Handles alias translation on the retrieval (query) path. In addition to an attribute collection and a message collection, it accepts parameters controlling the retrieval window (start and stop times), the resource identifier (timekeeper or resource), the processing mode (defaulting to the self-service mode constant), and two boolean flags that control whether the alias display value and the alias reference object are appended to the results.
The package also declares the global variable g_attribute_id and the associative array type assoc_array, used for internal state and value set format caching respectively.
Tables Accessed
The package reads and writes against the following tables through APPS synonyms:
- HXC_ALIAS_DEFINITIONS_TL — Provides the translatable alias definition metadata used to resolve alias names.
- HXC_ALIAS_TYPES — Defines the alias types that determine how a given alias is interpreted during translation.
- HXC_ALIAS_VALUES — Supplies the concrete alias values that are substituted for attribute identifiers.
- FND_FLEX_VALUE_SETS — Referenced when an alias is based on a value set, particularly to determine the value set format used by the g_vset_fmt cache.
- DBMS_UTILITY and PLITBLM — Oracle-supplied utilities used for error formatting and PL/SQL table management during processing.
Usage Notes
HXC_ALIAS_TRANSLATOR is invoked internally by the OTL self-service timecard components rather than directly by end users. It is typically called from the self-service time entry and retrieval flows, where building block attribute information and timecard information are passed in for alias resolution. Customizations that extend OTL self-service behavior may call DO_DEPOSIT_TRANSLATION before persisting timecard data and DO_RETRIEVAL_TRANSLATION when rendering retrieved time entries. The NOCOPY parameter modes make the procedures efficient for large attribute collections, but callers must observe the IN OUT contract and supply the correct HXC attribute and message table types. Because the package is classified as OTHER, it should be treated as an internal dependency whose signature may change between releases, and any custom invocation should be validated against the target EBS release (12.1.1 or 12.2.2).