Search Results get_encodedmessage




Overview
Explore in AI Chat

Overview

APPS.IEC_OCS_LOG_PVT is a private (PVT) PL/SQL package body belonging to the Oracle E-Business Suite Interaction Center / Oracle Contact Center (IEC) application module. Its principal business function is to centralize message construction, message encoding, and diagnostic logging for the IEC family of packages. Rather than embedding literal error text throughout the codebase, the IEC development standards route all runtime error and informational messaging through this package, which in turn delegates to the Oracle Application Object Library (FND) messaging and logging APIs: FND_MESSAGE and FND_LOG. The package therefore acts as the single point of control for how the IEC schema generates internal PL/SQL error messages, validation errors, and status-update errors, and for how those messages are encoded for transport to a client tier, such as the Oracle Telephony / Contact Center Java applet or a web-based UI.

The package body header identifies it as IECOCLGB.pls, version 120.1, last modified 2006/03/28, and the package is owned by APPS. In EBS 12.1.1 and 12.2.2 the object resides in the same form in the database, with 12.2.2 differing primarily in the editioning and Online Patching context of the APPS schema rather than in the package logic itself.

Key Procedures and Functions

The documented package exposes 35 procedures and functions. The most significant are summarized below.

  • Get_Module — Builds a standardized module identifier string from a package name, method name, and sub-method name, used as the logger name passed to FND_LOG.
  • Log_Message — Writes a message to the FND log at the UNEXPECTED level, gated by the current runtime logging level so that logging overhead is suppressed below the configured threshold.
  • Get_EncodedMessage — Retrieves the currently encoded FND message and also returns the decoded, human-readable text. This is the procedure most closely associated with the user's search term "get_encodedmessage," and it forms the core of the encoding contract: the encoded form is the transportable representation, while the plain form is what a user will ultimately read.
  • Init_SqlErrmMsg — Builds a standard internal PL/SQL error message using the IEC message IEC_DESC_INTERNAL_PLSQL_ERROR, substituting the SQLERRM value into a token, and then calls Get_EncodedMessage to produce both plain and encoded output.
  • Init_ValidationSqlErrmMsg — Similar to the above but uses the IEC_VAL_SQLERRM message, adding both a module token and an SQL_ERRM token.
  • Init_SourceTypeNotSupportedMsg, Init_SourceTypeDoesNotExistMsg, Init_SourceTypeMismatchAllMsg, Init_SourceTypeMismatchSomeMsg, Init_SourceTypeMissingColsMsg — Construct specific validation messages for source-type related conditions, including unsupported types, missing types, and column mismatches across all or selected records.
  • Init_GetSubsetViewErrorMsg, Init_SubsetViewDoesNotExistMsg — Report failures encountered while accessing subset views used by the Contact Center data model.
  • Init_TerritoryNotFoundMsg, Init_TerritoryNotUniqueMsg — Report failures to resolve a territory to a single record.
  • Init_StatusUpdateErrorMsg — Reports failures when updating status columns.
  • Init_NoEntriesFoundMsg — Reports an empty result set for a query the user expected to return data.
  • Log_List_Status_IEC_Error, Log_List_Status_AMS_Error, Log_Locate_List_Data_Error, Log_Recycle_MV_Dup_Rec_Stmt, Log_Internal_Plsql_Error — Logging entry points used to record IEC-specific list errors, application-message-server errors, list-locate failures, duplicate records encountered while recycling a materialized view, and internal PL/SQL errors respectively.

Tables Accessed

The ETRM metadata records no direct table references through APPS synonyms. The package operates entirely at the messaging and logging layer, reading only from the FND_MESSAGE and FND_LOG APIs, which in turn read FND_MESSAGES and the FND log tables internally. No IEC application data tables are touched by this package. This is consistent with its classification as a private utility package dedicated to message and log formatting rather than to business data manipulation.

Usage Notes

IEC_OCS_LOG_PVT is a private package, meaning it is not part of the public API contract and Oracle does not guarantee its signature across releases. It is referenced by approximately nine other packages in the IEC schema, which call its Init_* procedures to raise standardized, pre-encoded error messages and, in some cases, call Log_* procedures to emit diagnostic records. The Get_Module procedure is commonly invoked once per calling package to derive a logger name. Typical invocations occur from within IEC PL/SQL packages on the server side, in response to exceptions or validation failures encountered during Contact Center data retrieval and update operations. Because messages are produced through the FND_MESSAGE encoding mechanism, the plain-text form is suitable for display in a form or log, while the encoded form is suitable for passing across a tier boundary to a client that will decode it. Customizations should not call this package directly; instead, custom code should use the public FND_MESSAGE and FND_LOG APIs, or the public IEC packages that wrap this private helper.