Search Results return_error

Overview

FND_FLEX_DIAGNOSE is a diagnostic utility package in the Oracle E-Business Suite Applications Foundation (FND) schema. Its purpose is to assemble and return structured diagnostic information about Oracle Flexfields — both Key Flexfields (KFF) and Descriptive Flexfields (DFF) — together with the surrounding configuration metadata such as applications, tables, columns, languages, responsibilities, and Flexbuilder objects. The package body carries the source header identifier AFFFDGNB.pls, which associates it with the flexfield subsystem of the FND product family.

The package body declares an extensive set of constants and row-type subtypes that mirror the flexfield dictionary tables, including app_type, tbl_type, col_type, rsp_type, and multiple value-set compound subtypes (vst_set_type, vst_tbl_type, vst_evt_type, vst_scr_type, vst_scl_type, vst_scu_type, vst_val_type) as well as KFF and DFF segment/flx subtypes. Internal constants such as g_api_name, g_std_date_mask, g_line_size, and g_text_size govern the format and length of the diagnostic text that the package emits. These declarations establish the package as a reporting layer over the flexfield dictionary rather than an operational API.

Key Procedures and Functions

The documented API surface contains 72 procedures and functions, of which the ETRM metadata names the following retrieval routines:

• GET_DB — returns database-level diagnostic information.
• GET_REL — returns release/version information relevant to the flexfield configuration.
• GET_WHO — returns the standard "WHO" audit columns (created/updated by, dates) for a subject record.
• GET_APP — returns application dictionary information.
• GET_TBL — returns table dictionary information.
• GET_COL — returns column dictionary information.
• GET_LNG — returns language information.
• GET_RSP — returns responsibility information.
• GET_FB_FUNC, GET_FB_KAPP, GET_FB_KFLX, GET_FB_KSTR — return Flexbuilder function, key application, key flexfield, and key structure information respectively.
• GET_VST_SET, GET_VST_TBL, GET_VST_EVT, GET_VST_SCR, GET_VST_SCL, GET_VST_SCU, GET_VST_VAL, GET_VST_RLG — return value-set related data covering the value set definition, validation table, validation event, value rules, rule lines, rule usages, values, and hierarchies.

Collectively these routines gather the pieces required to describe how a flexfield is defined and validated. They are read-oriented; no DML is implied by the naming or by the row-type carriage.

Tables Accessed

The package references the following tables through APPS synonyms:

• FND_APPLICATION, FND_TABLES, FND_COLUMNS — source of application, table, and column dictionary attributes.
• FND_DESCRIPTIVE_FLEXS, FND_DESCR_FLEX_CONTEXTS, FND_DESCR_FLEX_COLUMN_USAGES, FND_DEFAULT_CONTEXT_FIELDS — descriptive flexfield definitions, contexts, segment usages, and default context fields.
• FND_COMPILED_DESCRIPTIVE_FLEXS, FND_COMPILED_ID_FLEXS, FND_COMPILED_ID_FLEX_STRUCTS — compiled flexfield metadata.
• FND_FLEX_VALIDATION_EVENTS, FND_FLEX_VALIDATION_QUALIFIERS, FND_FLEX_INCLUDE_RULE_LINES, FND_FLEX_EXCLUDE_RULE_LINES, FND_FLEX_HIERARCHIES — validation event, qualifier, and rule-line configuration for value set security and rollup validation.
• FND_FLEXBUILDER_FUNCTIONS — Flexbuilder function registration.

These tables supply the definitional context the diagnostic routines report on.

Usage Notes

Because the ETRM metadata records no external package callers (Referenced by 0 other packages) and classifies the API as OTHER, FND_FLEX_DIAGNOSE is not a general-purpose integration API. It is invoked as a diagnostic aid — typically from a SQL*Plus or SQL Developer session, diagnostic concurrent program, or a developer troubleshooting flexfield configuration and validation behavior during support investigation. The return_error search term most likely corresponds to internal error-handling logic within the package rather than a named documented procedure; the retrieved rows and formatted text are intended to be inspected interactively. It should be treated as read-only and safe to run during investigation, though it is not an officially supported runtime API and should not be called from custom application logic where a supported flexfield API exists.