Results for “region_validation_api_pkg”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

AK_REGIONS is a metadata repository table in the Oracle E-Business Suite Application Object Library (AK) module. It stores the definition of every region used in Oracle EBS forms-based and self-service (OA Framework) user interfaces. A region is a logical grouping of items rendered together on a form or web page; AK_REGIONS holds the runtime and design-time attributes that describe that grouping, including the underlying database object, the region style, validation and defaulting APIs, and numerous display and search-related flags.

Because the table anchors many dependent metadata objects — items, flow pages, translated region names, and navigation targets — it behaves as a central entity within the AK metadata model. Under a heuristic Data Vault classification, AK_REGIONS is best characterized as hub-leaning: it carries a stable composite business key, and its dependent tables (translations, region items, page layouts) function as satellites and link tables. The primary key AK_REGIONS_PK is defined on the column pair REGION_CODE and REGION_APPLICATION_ID, and a unique index AK_REGIONS_U1 extends that business key with ZD_EDITION_NAME, supporting edition-aware lookups in 12.2.x.

Key Information Stored

The table contains 56 documented columns. The most significant are:

• REGION_CODE — the developer-facing identifier of the region; part of the primary key and of every foreign key relationship.
• REGION_APPLICATION_ID — the application owning the region; combines with REGION_CODE to form the composite key.
• DATABASE_OBJECT_NAME — the underlying database entity (typically a view or table) from which the region is populated; also forms the foreign key to AK_OBJECTS.
• REGION_STYLE — controls the visual layout style applied to the region.
• NUM_COLUMNS and NUM_ROWS_DISPLAY — govern grid or block dimensions and the number of rows shown.
• REGION_DEFAULTING_API_PKG, REGION_DEFAULTING_API_PROC, REGION_VALIDATION_API_PKG, REGION_VALIDATION_API_PROC — identify the PL/SQL package and procedure invoked for row defaulting and validation.
• REGION_OBJECT_TYPE and APPLICATIONMODULE_OBJECT_TYPE — classify the region and its owning module for the framework.
• ISFORM_FLAG and STATEFUL_FLAG — indicate whether the region is a forms region and whether it retains state across requests.
• SEARCH_PANEL, ADVANCED_SEARCH_PANEL, CUSTOMIZE_PANEL, DEFAULT_SEARCH_PANEL, RESULTS_BASED_SEARCH — define search and personalization behavior in OA Framework pages.
• ZD_EDITION_NAME — the editioning column used in 12.2.x for online patching and edition-based redefinition.
• Standard audit columns (CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE) and the ATTRIBUTE1–15 descriptive flexfield columns.

Common Use Cases and Queries

AK_REGIONS is principally queried during diagnostics and metadata analysis rather than transactional reporting. Typical scenarios include identifying which database object backs a region, tracing validation or defaulting logic for a form, and reviewing search-enabled regions in OA Framework pages.

SELECT r.region_code,
       r.region_application_id,
       r.database_object_name,
       r.region_style,
       r.num_columns,
       r.isform_flag,
       r.stateful_flag
FROM   ak.ak_regions r
WHERE  r.region_code = :region_code
AND    r.region_application_id = :app_id;

A frequent pattern joins to the translation table to obtain a user-facing name:

SELECT r.region_code, t.user_region_name
FROM   ak.ak_regions r,
       ak.ak_regions_tl t
WHERE  r.region_code = t.region_code
AND    r.region_application_id = t.region_application_id
AND    t.language = USERENV('LANG');

Inventory reports commonly list regions that define defaulting or validation logic, or that reference a specific database object via AK_OBJECTS, to assess customization surface area before an upgrade or patch.

Related Objects

• AK_OBJECTS — referenced by AK_REGIONS.DATABASE_OBJECT_NAME; identifies the database object supplying region data.
• AK_REGIONS_TL — the translation table, joined on REGION_CODE and REGION_APPLICATION_ID, holding language-specific region names.
• AK_REGION_ITEMS — child table joined on REGION_CODE and REGION_APPLICATION_ID; defines the individual items displayed within the region.
• AK_FLOW_PAGE_REGIONS — maps regions onto flow pages via REGION_CODE and REGION_APPLICATION_ID.
• AK_OBJECT_ATTRIBUTE_NAVIGATION — drives region-to-region navigation, joined through TO_REGION_CODE and TO_REGION_APPL_ID.
• OA Framework and forms runtime APIs consume AK_REGIONS metadata indirectly when rendering pages and forms, so changes to this table must follow supported Oracle configuration and patching procedures.