Search Results fnd_flex_key_api




Overview

FND_FLEX_KEY_API is the core Oracle Application Object Library (AOL) PL/SQL API responsible for creating, querying, and maintaining Oracle EBS key flexfield registrations and their supporting structures at runtime. Key flexfields (KFFs) underpin critical business identifiers such as Accounting Flexfields, Item Categories, and System Items. This package provides a programmatic alternative to the Oracle Forms-based Key Flexfield Administration interface, allowing developers and integrators to register new flexfields, define their segments and structures, manage validation rules, and populate segment attribute values directly from PL/SQL.

The package body is owned by the APPS schema and is classified as a standard Oracle EBS API. It is a foundational dependency within the EBS metadata layer; the ETRM dependency records show it is referenced by 58 other database objects and depends on a broad set of AOL metadata tables. It is documented against Oracle EBS 12.1.1 and 12.2.2 and carries a VALID status.

Key Procedures and Functions

The package exposes 49 documented procedures and functions spanning several functional areas:

These routines collectively allow fully programmatic construction of a key flexfield without navigating the administrative forms.

Tables Accessed

The package reads and writes the principal AOL metadata tables that define flexfields. Registration and structure data are stored in FND_ID_FLEXS, FND_ID_FLEX_SEGMENTS, and FND_ID_FLEX_STRUCTURES, with compiled runtime representations held in FND_COMPILED_ID_FLEXS and FND_COMPILED_ID_FLEX_STRUCTS. Validation rule definitions are managed through FND_FLEX_VALIDATION_RULES, FND_FLEX_VALIDATION_RULE_LINES, FND_FLEX_VALIDATION_RULE_STATS, and the include/exclude rule tables FND_FLEX_INCLUDE_RULE_LINES and FND_FLEX_EXCLUDE_RULE_LINES. Segment and flexfield qualifiers reside in FND_FLEX_VALIDATION_QUALIFIERS. Value set definitions are referenced in FND_FLEX_VALUE_SETS. Supporting metadata includes FND_APPLICATION, FND_COLUMNS, and FND_TABLES, which describe the surrounding database objects. The package also leverages infrastructure packages such as FND_API, FND_GLOBAL, and FND_ID_FLEX_STRUCTURES_PKG.

Usage Notes

FND_FLEX_KEY_API is typically invoked from custom PL/SQL code, concurrent programs, and installation or configuration scripts that need to register or modify key flexfields outside of the standard administrative forms. It may also be called by Oracle application setup utilities during implementation and upgrade activities. Because the package manipulates core AOL metadata and the compiled flexfield cache, calls must be performed carefully and are generally followed by a flexfield compilation or cache refresh step. Developers should treat the routines as privileged configuration interfaces, validate inputs thoroughly, and avoid direct DML against the underlying tables in favor of these supported API entry points.