Search Results custom_exists

Overview

AK_CUSTOM_PVT is a private PL/SQL package in the APPS schema that implements the low-level customization engine for Oracle E-Business Suite's Application Framework. The AK_* table family stores user-defined customizations, custom regions, region items, and search criteria that allow end users to extend and personalize Oracle EBS forms and web pages without modifying base application code. AK_CUSTOM_PVT performs the actual data manipulation, validation, and buffered write operations that back the public API surface exposed through AK_CUSTOM_PUB.

The package follows Oracle's standard private/public (PVT/PUB) API pattern. It is classified as a PVT package, meaning it is intended for internal consumption by the framework and is not documented as a supported integration point. Business users interact with these capabilities indirectly through the "Customize" (personalization) features of EBS forms; developers and framework code interact with them through the PUBLIC wrapper AK_CUSTOM_PUB or through higher-level packages such as AK_CUSTOM2_PVT and AK_CUSTOM_GRP.

Key Procedures and Functions

The documented interface contains 22 procedures and functions, organized into logical groupings:

• Buffer writers — WRITE_CUSTOM_TO_BUFFER, WRITE_CUST_REGION_TO_BUFFER, WRITE_CUST_REG_ITEM_TO_BUFFER, and WRITE_CRITERIA_TO_BUFFER stage in-memory records prior to commit, supporting the bulk nature of customization download and upload operations.
• Create operations — CREATE_CUSTOM, CREATE_CUST_REGION, CREATE_CUST_REG_ITEM, and CREATE_CRITERIA insert new customization, region, region item, and criteria definitions.
• Existence checks — CUSTOM_EXISTS, CUST_REGION_EXISTS, CUST_REG_ITEM_EXISTS, and CRITERIA_EXISTS return boolean/flag indicators used to enforce uniqueness and validate state before DML.
• Update operations — UPDATE_CUSTOM, UPDATE_CUST_REGION, UPDATE_CUST_REG_ITEM, and UPDATE_CRITERIA modify existing definitions and their translated (TL) attributes.
• Validation and retrieval — VALIDATE_CUSTOM and VALIDATE_CUST_REGION perform business-rule checks before persistence; DOWNLOAD_CUSTOM extracts customization definitions (typically to a file or staging buffer) for propagation; INSERT_CUSTOM_PK_TABLE populates a primary-key join table used internally for set-based processing.

Tables Accessed

The package operates on the core AK_* customization tables through APPS synonyms:

• AK_CUSTOMIZATIONS / AK_CUSTOMIZATIONS_TL — the base and translated customization headers, holding personalization definitions keyed to forms and functions.
• AK_CUSTOM_REGIONS / AK_CUSTOM_REGIONS_TL — custom region definitions and their language-specific text.
• AK_CUSTOM_REGION_ITEMS / AK_CUSTOM_REGION_ITEMS_TL — items belonging to custom regions, with translated attributes.
• AK_CRITERIA and AK_REGIONS — criteria definitions and the base region registry against which customizations are anchored.
• FND_FORM_FUNCTIONS, FND_RESPONSIBILITY, FND_LANGUAGES, FND_TERRITORIES, MTL_PARAMETERS — reference and context data used for validation (function registration, responsibility ownership, language/territory validation, and operating-unit context).
• DUAL and PLITBLM — utility access; PLITBLM is the standard PL/SQL table (array) support package used for buffered collection handling.

Usage Notes

AK_CUSTOM_PVT is not a directly callable API. It is referenced by AK_CUSTOM2_PVT, AK_CUSTOM_GRP, and recursively by itself, and depends on AK_CUSTOM_PUB, the FND_API error-handling framework, and the SYS.STANDARD package. Because two packages reference it, the package is a shared internal workhorse rather than a leaf module.

Invocation occurs when users save or apply personalizations in the EBS Forms-based UI, when customization data is migrated or downloaded between environments (via DOWNLOAD_CUSTOM), and when framework code creates or updates region definitions programmatically. Because it is a private package, support statements warn against direct invocation from custom code; developers requiring this functionality should use AK_CUSTOM_PUB or the documented personalization APIs. Modifying the AK_* tables or calling AK_CUSTOM_PVT directly outside the supported framework path risks corrupting customization metadata in both Oracle EBS 12.1.1 and 12.2.2.