Search Results set_message_token

Overview

APPS.PQH_UTILITY is a shared PL/SQL utility package within the Oracle E-Business Suite Public Sector/HR (PQH) module. It provides a centralized library of helper routines used across position management, budgeting, and related HR processes. The package encapsulates common operations such as message construction and token substitution, warning table management, shared-type lookups, date-tracked session handling, and position budget retrieval. Because it is classified as an OTHER API rather than a public business API, PQH_UTILITY is intended primarily for internal consumption by other PQH packages and forms, though its routines are technically callable from custom code. In Oracle EBS 12.1.1 and 12.2.2, the package header (pqutilty.pkh, version 120.2.12010000.1) remains the authoritative specification, and the package is referenced by 23 other packages, underscoring its role as a foundational dependency.

Key Procedures and Functions

• GET_SHARED_TYPE_NAME — Returns the display name of a shared type given its identifier and business group, drawing on PER_SHARED_TYPES.
• INIT_WARNINGS_TABLE / INSERT_WARNING / GET_NEXT_WARNING / GET_ALL_WARNINGS — A coordinated set of routines that initialize, populate, and iterate through a PL/SQL warnings table (warnings_tab), allowing calling processes to accumulate and retrieve non-fatal messages.
• GET_MESSAGE_LEVEL_CD — Determines the message level code for a given application, message name, and organization.
• SET_MESSAGE — Loads a message, using an application ID, message name, and optional organization ID, into the package's message state.
• SET_WARNING_MESSAGE — Loads a warning-class message for subsequent retrieval.
• SET_MESSAGE_TOKEN — Overloaded procedure that sets a named token and its value (either a plain value or an application-qualified token message). This routine performs the token substitution referenced in the search query, enabling dynamic message text assembly with runtime values.
• GET_MESSAGE_TYPE_CD / GET_MESSAGE — Retrieve the current message type code and the fully constructed message text after tokens have been applied.
• RAISE_ERROR — Raises the accumulated error condition to the caller.
• DECODE_ASSIGNMENT_NAME — Returns a formatted assignment name for a given assignment ID.
• SAVE_POINT / ROLL_BACK — Manage transaction savepoints and rollback within the package's processing context.
• SET_SESSION_DATE — Establishes the date-track session date for effective-dated operations.
• GET_POS_BUDGET_VALUES / GET_ALL_UNIT_DESC / GET_UNIT_DESC / CHK_POS_PENDING_TXNS — Support position budgeting lookups, organizational unit description retrieval, and detection of pending position transactions.

Tables Accessed

The package reads and writes a range of FND and HR/PER tables via APPS synonyms. FND_NEW_MESSAGES supplies message text for the warning and message routines. FND_FLEX_VALUE_SETS, FND_FLEX_VALIDATION_TABLES, and FND_SESSIONS support flexfield validation and session context. HR_ALL_ORGANIZATION_UNITS, HR_ALL_POSITIONS_F, and HR_ORGANIZATION_INFORMATION provide organization and position data. PER_ALL_ASSIGNMENTS_F and PER_ALL_PEOPLE_F supply assignment and person details used by assignment-name decoding. PER_ANALYSIS_CRITERIA, PER_ORGANIZATION_STRUCTURES, PER_ORG_STRUCTURE_ELEMENTS, and PER_ORG_STRUCTURE_VERSIONS underpin organizational hierarchy and structure resolution. PER_SHARED_TYPES and PER_SHARED_TYPES_TL provide shared-type identifiers and translated names.

Usage Notes

PQH_UTILITY is most commonly invoked indirectly: Oracle forms in the PQH module and other PQH packages call its routines to build user-facing messages, apply token substitution, accumulate warnings, and resolve position or organization descriptions. The set_message_token overloads are the standard mechanism for inserting runtime values into predefined FND messages before display. Because the package is referenced by 23 other packages, changes to its specification can have broad impact and should be treated as high-risk. Custom code may call these utilities, but developers should prefer public APIs where available and validate behavior against the specific EBS release (12.1.1 or 12.2.2), since private utility routines are not guaranteed stable across patches.