Search Results create_region_relation

Overview

The APPS.AK_FLOW_GRP package body is the group-level API for the Oracle E-Business Suite Application Framework (AK) flow model. It belongs to the AK product family, whose objects underpin the extensible "flow" and "page" definitions used to describe navigational and functional groupings of application content — for example, the flows that organize regions, pages, page regions, and region items within the HTML-based and self-service product families.

The package carries an API classification of GRP (a group API), indicating that it exposes a consolidated, business-function-oriented interface rather than the lower-level private (PVT) APIs. Consistent with the standard AK group API pattern, each public procedure validates its API version, optionally initializes the FND message table, and delegates the substantive work to the corresponding private API before returning the standard return status. Header information in the source body indicates the object dates to the 11i/12.x stream, with a current API version of 1.0 for the group API as a whole.

Key Procedures and Functions

The body documents sixteen public procedures, organized as create, update, and delete operations across the four main flow-model entities. The CREATE_FLOW procedure — the entry point most relevant to a search for create_flow — creates a new flow record from the supplied flow columns. Its documented parameters include the standard API controls (validation level, API version number, message-table initialization flag, and the output message count, message data, and return status), together with the flow's application identifier, flow code, name, descriptive attributes, and audit columns. It explicitly excludes the primary page application identifier and primary page code, because no flow pages exist at the point a flow is first created.

• CREATE_FLOW — creates a flow using the given flow information; returns the standard return status (unexpected error, error, or success).
• CREATE_PAGE, CREATE_PAGE_REGION, CREATE_PAGE_REGION_ITEM, CREATE_REGION_RELATION — create the constituent page, page-region, page-region-item, and region-relation records that build out a flow.
• UPDATE_FLOW, UPDATE_PAGE, UPDATE_PAGE_REGION, UPDATE_PAGE_REGION_ITEM, UPDATE_REGION_RELATION — modify the corresponding existing definitions.
• DELETE_FLOW, DELETE_PAGE, DELETE_PAGE_REGION, DELETE_PAGE_REGION_ITEM, DELETE_REGION_RELATION — remove the corresponding definitions.
• DOWNLOAD_FLOW — extracts flow definition data, supporting the AK metadata extraction/download mechanism.

Tables Accessed

The documented table references for this package are DUAL and PLITBLM, both resolved through APPS synonyms. DUAL is the standard Oracle single-row utility table used for scalar evaluation and default-value handling within the API logic. PLITBLM is the Application Framework's PL/SQL item table used to hold collections of item identifiers and associated attributes in memory; it supports the set-based processing and validation performed by the flow, page, region, and region-item procedures. The package is referenced by one other package in the framework, reflecting its role as a shared service for flow maintenance.

Usage Notes

AK_FLOW_GRP is typically invoked programmatically rather than interactively. Callers should pass a compatible p_api_version_number (1.0) and should initialize the message table only when they intend to consume the returned message data. The output parameters p_return_status, p_msg_count, and p_msg_data follow the standard FND_API protocol and must be checked by the calling code; a status of G_RET_STS_UNEXP_ERROR is returned when the API version is incompatible.

Because the group API delegates to private APIs, custom code should call AK_FLOW_GRP rather than the underlying private procedures directly, so that validation and error handling remain consistent. Typical consumers include AK framework components, application setup utilities, and custom extensions that need to define or maintain flows, pages, page regions, page region items, and region relations in a supported manner.