Search Results ak_region_pvt




Overview
Explore in AI Chat

Overview

AK_REGION_PUB is a public PL/SQL package owned by the APPS schema in Oracle E-Business Suite, classified as a PUB (public) API within the Application Object Library / Application Toolkit (AK) family of components. Its business function is to expose region-related functionality — the regions that make up the configurable page layouts used by Oracle's "Personalize" and "Forms Personalization" frameworks, as well as by the application's region-based UI metadata — to other modules and to external callers. Regions in the AK schema represent reusable UI sections composed of attribute groups and fields, and AK_REGION_PUB acts as the supported, stable entry point for querying and manipulating region definitions.

The package is validated as VALID in ETRM 12.2.2 and is present in 12.1.1 as well. Its counterpart, AK_REGION_PVT (the search term provided by the user), is the private implementation package that contains the bulk of the region business logic; AK_REGION_PUB is the thin public wrapper that calls into it. This public/private split is a standard Oracle EBS pattern: only the PUB package is documented and safe for customer extension, while the PVT package may change without notice.

Key Procedures and Functions

The ETRM metadata for this publication documents zero procedures or functions explicitly, and no parameter lists are provided. This is consistent with AK_REGION_PUB being a lightweight dispatching wrapper: it typically declares a small number of entry points that mirror the underlying AK_REGION_PVT routines for loading, validating, and returning region metadata. Because the documented surface is empty, integrators should not assume any specific signature; the authoritative list must be obtained from the package specification in the target instance (for example, via USER_SOURCE or ALL_SOURCE for AK_REGION_PUB). What can be stated with confidence from the dependency data is that these routines delegate to FND_API for the standard EBS API framework — error handling, message stacking, and the standard fnd_api.g_ret_sts_* return conventions — rather than implementing their own framework.

Tables Accessed

Two tables are documented as referenced through APPS synonyms:

  • AK_CATEGORY_USAGES — records which categories (attribute groupings) are used by a given region and in what capacity. AK_REGION_PUB reads this table to resolve the composition of a region, i.e. which category usages belong to it.
  • AK_REGION_LOV_RELATIONS — defines the relationships between regions and their associated list-of-values definitions. AK_REGION_PUB reads this to resolve LOV behaviour attached to region fields.

Both tables are read-oriented from the public API's perspective; insert, update, and delete activity on region metadata is generally routed through the private package. Callers should never write to these tables directly, as that bypasses validation and caching performed by the AK framework.

Usage Notes

AK_REGION_PUB is referenced by at least eight other packages, which demonstrates its role as a foundational dependency rather than an end-user-facing API. Its documented dependents include AK_REGION_PVT, AK_REGION2_PVT, AK_OBJECT2_PVT, AK_FLOW2_PVT, AK_CUSTOM_PVT, AK_DELETE_GRP, AK_DOWNLOAD_GRP, AK_REGION_GRP, and BIS_AK_REGION_PUB. Notably, the AK_REGION_PVT → AK_REGION_PUB → AK_REGION_PVT cycle seen in the metadata reflects the layered wrapper design described above.

In practice, this package is invoked indirectly:

  • By the Application Toolkit runtime when rendering or validating configurable regions in the EBS Forms UI.
  • By the AK bulk utilities (AK_DELETE_GRP, AK_DOWNLOAD_GRP) when regions are downloaded or removed as part of attribute/region administration.
  • By the Business Intelligence Publisher bridging package BIS_AK_REGION_PUB, which exposes region metadata to BI Publisher data models.
  • By customer and Oracle customizations that must retrieve region structure in a supported manner, usually by calling AK_REGION_PUB rather than querying AK tables directly.

Because AK_REGION_PUB is classified PUB and validated in both 12.1.1 and 12.2.2, it may be called from custom PL/SQL, concurrent programs, and forms triggers. Callers should always check the returned FND_API status code and consult FND_MSG_PUB for accumulated messages, and they should re-verify the exact procedure signatures against the installed package specification, since the ETRM excerpt does not enumerate them.