Search Results replace_token

Overview

APPS.JL_CUSTOM_PUB is a public PL/SQL package body belonging to the Oracle E-Business Suite Japan Localization (JL) module. Its documented header identifies it as version 120.1, last modified in August 2010, and the noship designation in the source control tag indicates it is a non-shipped, custom-extensible object rather than a core seeded component delivered with the base application. The package provides utility services for the Japan localization layer, most notably a token substitution engine used to build localized messages and a public API entry point for retrieving the "our number" value associated with a document. It follows Oracle EBS PL/SQL API conventions, including the standard FND_API compatibility checking pattern, versioned API calls, and standardized return status and message data output parameters. The package is classified as a PUB (public) API, meaning its documented procedures are intended to be callable by other EBS components and by customer extensions.

Key Procedures and Functions

The ETRM metadata documents one public procedure, GET_OUR_NUMBER, although the package body excerpt also reveals an internal helper function, REPLACE_TOKEN, that supports its operation.

• GET_OUR_NUMBER — The sole documented public procedure. It retrieves the "our number" identifier for a given document and returns it through an OUT parameter, along with the standard FND_API return status and message data outputs. It accepts an API version and a commit flag as optional inputs following the conventional signature pattern (P_API_VERSION, P_COMMIT, P_ DOCUMENT_ID, X_OUR_NUMBER, X_RETURN_STATUS, X_MSG_DATA). Its implementation declares two local exceptions, incompatible_apiversion and invalid_apiversion, and performs a standard call to FND_API.COMPATIBLE_API_CALL to validate the caller's API version before proceeding.
• REPLACE_TOKEN — An internal function that performs token substitution within a message string. It accepts the message text plus parallel collections of tokens and their replacement values, iterates over the token array, and successively applies a REPLACE operation to the message buffer, returning the fully substituted text. This function is used to construct the dynamic error messages raised when API version compatibility checks fail.

Tables Accessed

The documented table referenced by the package is PLITBLM (accessed via an APPS synonym). PLITBLM is a standard EBS database object used in the message and token infrastructure, and its presence here is consistent with the package's role of assembling and substituting tokens into user-facing or diagnostic messages. No other base tables are documented as being read or written by this package.

Usage Notes

JL_CUSTOM_PUB is typically invoked from custom code, localization extensions, or other Japan localization components that require the document number retrieval service or the token substitution mechanism. Because it is a PUB-classified API, callers should adhere to the FND_API calling convention, passing a compatible API version and handling the X_RETURN_STATUS and X_MSG_DATA outputs to detect failures. In the 12.1.1 and 12.2.2 environments the package remains available under the APPS schema. The metadata records that no other packages reference JL_CUSTOM_PUB, confirming its role as a leaf-level utility consumed directly by forms, concurrent programs, or bespoke PL/SQL rather than being called internally by seeded EBS packages.