Search Results g_api_version

Overview

APPS.FEM_LOADER_ENG_UTIL_PKG is a utility package within the Oracle E-Business Suite Financial Consolidation Hub / Enterprise Performance Foundation (EPF) family of products. Its role is to determine the execution mode that governs how the various FEM loaders — dimension, hierarchy, cross-GL, and fact loaders — should behave at runtime. The package exposes a public constant, G_API_VERSION (defined as 1.0), which serves as the default API version parameter for every procedure in the specification. This constant is the value most commonly reached when a user searches the ETRM repository for "g_api_version," since it appears in the signature of each documented procedure.

Rather than performing data movement itself, FEM_LOADER_ENG_UTIL_PKG acts as a configuration lookup service. Callers pass a small set of context identifiers and receive back an execution-mode string that the calling loader interprets to decide whether to run immediately, defer, or suppress processing. This pattern centralizes loader-policy logic so that individual loader programs do not have to hard-code behavior.

Key Procedures and Functions

The specification documents four procedures, all following the standard Oracle Application Object Library API convention with parameters for API version, message-list initialization, commit control, encoding, and the standard x_return_status, x_msg_count, and x_msg_data outputs.

• GET_DIM_LOADER_EXEC_MODE — Returns the execution mode for the dimension loader given a dimension identifier (p_dimension_id).
• GET_HIER_LOADER_EXEC_MODE — Returns the execution mode for the hierarchy loader, taking a dimension identifier and a hierarchy name.
• GET_XGL_LOADER_EXEC_MODE — Returns the execution mode for the cross-GL (XGL) loader, taking a calendar period, ledger, and dataset code.
• GET_FACT_LOADER_EXEC_MODE — Returns the execution mode for the fact loader, taking a calendar period and ledger identifier.

Each procedure returns its result through x_exec_mode. Because the API version parameter defaults to G_API_VERSION, callers may omit it and still receive the currently supported interface contract.

Tables Accessed

The package reads configuration and catalog metadata from several FEM tables, accessed through APPS synonyms:

• FEM_DATA_LOADER_OBJECTS and FEM_OBJECT_CATALOG_B — define the loadable objects and their catalog attributes, supplying the context used to resolve an execution mode.
• FEM_PL_OBJECT_EXECUTIONS and FEM_PL_REQUESTS — record prior loader execution and request state, allowing the utility to reflect in-flight or completed processing.
• FEM_PL_TABLES — provides the registration of the underlying staging/target tables associated with loader objects.
• FEM_XDIM_DIMENSIONS — supplies dimension definitions referenced by the dimension and hierarchy lookups.
• FND_LOG_MESSAGES — used for diagnostic logging through the FND logging framework.

Usage Notes

FEM_LOADER_ENG_UTIL_PKG is an internal utility rather than an end-user API. It is invoked by other FEM loader programs and concurrent programs during the preparation phase of a load, when the engine must decide whether a given dimension, hierarchy, XGL, or fact load can proceed. Three other packages in the ETRM inventory reference it directly. Custom code should generally call this package only when extending or emulating the FEM loader engine; callers must supply the correct context identifiers and should check x_return_status against FND_API.G_RET_STS_SUCCESS and inspect the message stack on error. The G_API_VERSION constant guarantees forward-compatible signatures across the 12.1.1 and 12.2.2 releases.