Search Results add_desc_flex_msg

Overview

The package body APPS.JTF_IH_CORE_UTIL_PVT is a private utility package belonging to the Interaction History (IH) foundation of Oracle E-Business Suite, part of the CRM/Telephony technology stack delivered under the JTF (Java Technology Foundation) schema. In Oracle EBS 12.1.1 and 12.2.2 it functions as an internal helper library that centralizes two categories of reusable logic: the construction and registration of standardized error messages through the FND message dictionary, and the validation of common argument, lookup, date, and WHO-column values used across the Interaction History public APIs.

Because the package carries the _PVT suffix and is classified as a private API, it is not intended for direct invocation by customer code. It exists to be called by the public JTF_IH API layer and by other utility packages so that message text, token substitution, and validation rules remain consistent throughout the module. The add_missing_param_msg procedure, which prompted the search, is representative of the package's design: a small, single-purpose routine that raises the correct Oracle Applications error message when a required parameter is absent.

Key Procedures and Functions

The package exposes fifteen documented program units, several of which are message-registration helpers that follow an identical pattern of checking the FND message level before calling FND_MESSAGE.SET_NAME, FND_MESSAGE.SET_TOKEN, and FND_MSG_PUB.ADD.

• ADD_MISSING_PARAM_MSG – Registers the appropriate error message when a mandatory parameter has not been supplied by the caller.
• ADD_NULL_PARAMETER_MSG – Registers an error when a parameter is present but evaluates to NULL.
• ADD_INVALID_ARGUMENT_MSG and ADD_INVALID_ARGUMENT_MSG_GEN – Report that an argument failed validation, capturing the offending value (truncated to the dictionary token limit) and the parameter name; the _GEN variant provides the generalized form of the same message.
• ADD_DUPLICATE_VALUE_MSG – Signals a uniqueness violation, naming both the API and the duplicated parameter.
• ADD_SAME_VAL_UPDATE_MSG – Reports that an update supplied a value identical to the stored value.
• ADD_PARAM_IGNORED_MSG – Warns that a supplied parameter will not be used under the current call context.
• CONVERT_LOOKUP_TO_CODE and VALIDATE_LOOKUP_CODE – Translate between lookup meanings and codes and verify that a code is valid for its lookup type.
• DEFAULT_COMMON_ATTRIBUTES – Populates DFF/common attribute placeholders with defaults.
• VALIDATE_DESC_FLEX – Confirms that descriptive flexfield data supplied to the API is well formed.
• VALIDATE_LATER_DATE – Ensures a supplied date does not precede the reference date.
• VALIDATE_WHO_INFO – Checks the WHO audit columns for consistency.
• TRUNC_STRING_LENGTH – Truncates a string to a defined maximum length, protecting message tokens and column assignments from overflow.
• IS_MULTIORG_ENABLED – Determines whether Multi-Org is active in the current installation.

Tables Accessed

The package references a small set of objects through APPS synonyms. FND_PRODUCT_GROUPS supplies installation-level information used by IS_MULTIORG_ENABLED and related checks. FND_USER provides the user identity context needed when validating WHO audit information and defaulting session attributes. DUAL is used for single-row evaluations. PLITBLM is the PL/SQL table of VARCHAR2 used by the FND message stack for token storage and retrieval. No application-owned Interaction History tables are written by this package; its role is confined to validation and message construction on behalf of callers that perform the actual DML.

Usage Notes

JTF_IH_CORE_UTIL_PVT is invoked indirectly. Interaction History forms, concurrent programs, and the public JTF_IH API packages call these routines to validate inputs and to post errors to the FND message stack before returning control to the user interface or batch driver. Custom extensions that build on the Interaction History public APIs may encounter its messages but should not call the private routines directly; the documented procedures are internal contracts and are subject to change without notice between 12.1.1 and 12.2.2. Developers who need equivalent validation should rely on the corresponding public JTF_IH APIs, which already delegate to this utility package. When debugging an error surfaced by add_missing_param_msg, the corrective action is to supply the required argument to the public API being called, since this helper only formats and registers the message.