Results for “ak_custom_regions”

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

Overview

AK_CUSTOM_REGIONS is a table in the AK (Common Modules-AK) product schema of Oracle E-Business Suite, holding the definition of region property customizations applied to the declarative Framework (AK) regions that make up the Oracle Forms user interface in EBS 12.1.1 and 12.2.2. The AK schema is the technical foundation of the Oracle EBS Forms-based UI; regions defined in JDR (JDeveloper) files ship as seeded metadata, and AK_CUSTOM_REGIONS is the persistence layer where administrators record per-region property overrides without modifying the underlying application definition. Each row associates a customization identified by CUSTOMIZATION_APPLICATION_ID and CUSTOMIZATION_CODE with a specific REGION_APPLICATION_ID and REGION_CODE, and specifies which region property (PROPERTY_NAME) is to be changed and the replacement value.

The ETRM metadata classifies this table heuristically as standalone in Data Vault terms. In practice the table functions as a satellite-like attribute store attached to region and customization business keys rather than as a true hub or link; the modeling suggestion is that its business keys (region and customization identifiers) are the durable identity, while the property values and audit columns are descriptive and time-tracked. Because the business keys originate from seeded AK region metadata rather than from foreign keys enforced at the database level, no formal FK relationships are documented.

Key Information Stored

AK_CUSTOM_REGIONS exposes 14 documented columns. The primary key, AK_CUSTOM_REGIONS_PK, is a composite surrogate comprising CUSTOMIZATION_APPLICATION_ID, CUSTOMIZATION_CODE, PROPERTY_NAME, REGION_APPLICATION_ID and REGION_CODE. A second unique index, AK_CUSTOM_REGIONS_U1, adds ZD_EDITION_NAME and is the strongest business-key candidate; the edition column supports the Edition-Based Redefinition (EBR) model introduced with 12.2, allowing online patching to maintain separate customization rows per edition.

• CUSTOMIZATION_APPLICATION_ID / CUSTOMIZATION_CODE — identify the named customization that owns the override, typically seeded or customer-defined in the AK customization registry.
• REGION_APPLICATION_ID / REGION_CODE — identify the target AK region whose property is being customized.
• PROPERTY_NAME — the region property being overridden (for example a prompt, visibility, or rendering attribute).
• PROPERTY_VARCHAR2_VALUE / PROPERTY_NUMBER_VALUE — the replacement value, held in character or numeric form according to the property's data type.
• CRITERIA_JOIN_CONDITION — an optional join condition controlling when the customization applies.
• CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, LAST_UPDATE_LOGIN — standard EBS audit columns.
• ZD_EDITION_NAME — the EBR edition that owns the row.

Common Use Cases and Queries

Typical use cases include auditing which regions have been customized before an upgrade, diagnosing UI discrepancies between environments, and identifying customizations that may conflict with a patch or a new edition. Reports commonly join the table to AK region metadata to resolve the region code to a user-facing name. A representative query to list all customizations for a region is:

SELECT region_code, customization_code, property_name,
       property_varchar2_value, property_number_value
  FROM ak.ak_custom_regions
 WHERE region_code = :region_code
   AND region_application_id = :region_app_id;

A second pattern enumerates all customizations owned by a particular customization, using the composite key:

SELECT r.region_code, c.property_name, c.property_varchar2_value
  FROM ak.ak_custom_regions c
 WHERE c.customization_application_id = :app_id
   AND c.customization_code = :code;

When analyzing 12.2 environments, queries should constrain or report ZD_EDITION_NAME so that only rows applicable to the active edition are considered.

Related Objects

AK_CUSTOM_REGIONS is a leaf customization store; its identifiers reference seeded AK framework metadata rather than enforced foreign keys, so the relationship data classifies it as standalone. The most significant associated objects are:

• AK_REGIONS — seeded region definitions, joined on REGION_APPLICATION_ID and REGION_CODE to resolve region names and base properties.
• AK_REGION_ITEMS — region item metadata affected when region properties drive item rendering.
• AK_CUSTOMIZATION (customization registry) — joined on CUSTOMIZATION_APPLICATION_ID and CUSTOMIZATION_CODE to resolve the owning customization.
• AK_ATTRIBUTES / AK_REGION_PROPERTIES — property definitions that constrain valid values for PROPERTY_NAME.
• FND_APPLICATION — joined on the *_APPLICATION_ID columns to resolve application short names.
• AK_CUSTOM_REGIONS_PK and AK_CUSTOM_REGIONS_U1 — the primary and unique indexes that enforce row identity and the EBR-aware business key.

Collectively these objects make AK_CUSTOM_REGIONS the durable record of declarative UI overrides, and the point of reference for diagnosing, migrating, or retiring customizations across EBS releases and editions.