Search Results create_query_object_line

Overview

The APPS.AK_QUERYOBJ_GRP package body is a Group API within the Oracle E-Business Suite Application Object Library (AK/AD) region. It provides a programmatic interface for creating and downloading query object definitions used by Oracle EBS query frameworks and object registration utilities. Query objects define stored, reusable query definitions that the framework can invoke dynamically. This package supports the migration and management of those definitions between environments by allowing developers and administrators to extract query object metadata to a flat file through a bulk download API, and to create query objects and their associated lines within the database. Its classification as a GRP (Group) API indicates it follows the standard FND_API conventions, including the p_return_status parameter, the p_msg_count/p_msg_data message stack pattern, and the FND_API.G_VALID_LEVEL_FULL validation level. These conventions ensure consistent error handling and integration with the standard EBS API framework.

Key Procedures and Functions

• CREATE_QUERY_OBJECT — Creates a query object definition. It establishes the parent object record that subsequent line entries depend upon, following standard FND_API conventions.
• CREATE_QUERY_OBJECT_LINE — Creates an individual line associated with a query object. This is the procedure a user searching for "create_query_object_line" would be referencing. Lines typically represent the constituent components of a query object definition, such as select statements or query clauses bound to a parent object. Use of this API permits programmatic insertion of lines that would otherwise be maintained through the forms interface.
• DOWNLOAD_QUERY_OBJECT — Writes a standard loader file header to a flat file, then invokes a private extraction API to write query object attributes selected by application ID, application short name, or a specific set of primary key values to the output file. Parameters include an optional NLS language, application identification parameters, and a primary key table (p_queryobj_pk_tbl). It returns the standard status values: Unexpected error, Error, or Success. Version history indicates initial version 1.0.

Tables Accessed

Documented table references via APPS synonyms are limited to DUAL and PLITBLM. DUAL is used for lightweight scalar queries and to test the success of preceding operations, a common pattern in PL/SQL APIs. PLITBLM is an internal table type used in the ETRM/AK framework that provides a declarative table structure—typically holding indexed name/value pairs used to pass structured data sets between APIs, such as the primary key collection referenced by p_queryobj_pk_tbl. Because the excerpt is a package body header, additional DML against query object tables is likely performed inside private helper routines not itemized in the documented metadata.

Usage Notes

The package is typically invoked from concurrent programs or custom PL/SQL code during environment migration, setup replication, or bulk registration of query objects. Administrators use DOWNLOAD_QUERY_OBJECT to export definitions into a load file for transport into another instance, while CREATE_QUERY_OBJECT and CREATE_QUERY_OBJECT_LINE support the reverse operation—loading definitions during setup. The package is referenced by one other package and should be called through the standard FND_API initialization/commit sequence, respecting the p_init_msg_tbl, message count/data, and return status parameters. Callers must ensure exactly one of the three application selection parameters is supplied to the download API; the application ID overrides the short name when both are provided. In both Oracle EBS 12.1.1 and 12.2.2, the source header indicates no structural differences, so the same interface applies across releases.