Search Results download_header

Overview

AK_ON_OBJECTS_PVT is a private PL/SQL package in the Oracle E-Business Suite Applications (APPS) schema whose name reflects its role as the private implementation layer for the Oracle Application Object Library (AK) component commonly referred to as the "Object Navigator" or "On-Objects" subsystem. In EBS 12.1.1 and 12.2.2, this package supplies the low-level parsing, buffering, file writing, and validation routines that support the loading and downloading of AK metadata definitions — attributes, flows, objects, regions, custom regions, security definitions, query objects, and AM parameter registry entries. Constant declarations such as G_CREATE ('C'), G_DOWNLOAD ('D'), G_UPDATE ('U'), and the entity type constants (G_ATTRIBUTE, G_FLOW, G_OBJECT, G_REGION, G_CUSTOM_REGION, G_SECURITY, G_QUERYOBJ, G_AMPARAM_REGISTRY) indicate that the package processes definition records across a range of AK entity types. The package is classified as PVT, meaning Oracle does not support its direct invocation by customers; it is intended to be called only by other AK-owned private APIs. The header comment confirms this: "This procedure is intended to be called only by other APIs that are owned by the Core Modules Team (AK)."

Key Procedures and Functions

The package exposes 14 documented procedures and functions. Their purposes, as reflected in the metadata and in the internal comments, are as follows:

• APPEND_BUFFER_TABLES — Appends all elements of one buffer table (of type AK_ON_OBJECTS_PUB.Buffer_Tbl_Type) to the end of another, supporting accumulation of log and upload data.
• DOWNLOAD_HEADER — Writes the header portion of a download file, using G_MAX_FILE_LINE_LEN to format output lines.
• GET_TOKEN — Parses a line of text and extracts the next token, used during line-oriented upload processing.
• READ_LINE — Reads a line from a source (file or buffer) during upload processing; this is the routine most closely associated with the "read_line" search term.
• REPLACE_SPECIAL_CHAR — Substitutes special characters during parsing or formatting.
• SET_WHO — Populates the standard "Who" columns (creation/update audit fields) on records being written.
• IS_UPDATEABLE — Determines whether a given record or definition can be updated, returning a boolean-style result.
• UPLOAD — Drives the upload of a definition set into the AK loader tables.
• VALID_APPLICATION_ID — Validates that a supplied application ID exists in FND_APPLICATION.
• VALID_LOOKUP_CODE — Validates a lookup code against AK_LOOKUP_CODES.
• VALID_YES_NO — Validates that a value is a recognized Yes/No indicator.
• WRITE_FILE — Writes a line to the output (download) file.
• WRITE_LOG_FILE — Writes a line to the log file associated with upload/download sessions.
• WRITE_TO_TABLE — Inserts processed rows into the loader table AK_LOADER_TEMP.

Tables Accessed

The package references the following tables through APPS synonyms:

• AK_LOADER_TEMP — Staging table for upload and download processing; rows are written via WRITE_TO_TABLE and indexed via G_TBL_INDEX.
• AK_LOOKUP_CODES — Source for lookup validation (VALID_LOOKUP_CODE).
• FND_APPLICATION — Source for application ID validation (VALID_APPLICATION_ID).
• DUAL — Used for simple single-row queries and constant retrieval.
• PLITBLM — The standard Applications implementation of DBMS_UTILITY-style line/table manipulation, used for buffer handling.
• V$PARAMETER — Consulted to read database parameter settings, typically for file handling or environment detection.

Usage Notes

AK_ON_OBJECTS_PVT is not invoked directly by end users or by customer-written concurrent programs. It is called by AK-owned private APIs, as confirmed by the documented fact that it is referenced by 27 other packages. In practice, its routines execute during AK object definition upload and download operations — for example, when administrators load or export object definitions through the AK Object Navigator UI or its supporting concurrent programs. The package's READ_LINE, GET_TOKEN, and related parsing routines form the core of the line-oriented upload pipeline, while WRITE_FILE, WRITE_LOG_FILE, and DOWNLOAD_HEADER form the corresponding download pipeline. Because the package maintains session-scoped state in globals such as G_SESSION_ID, G_WRITE_MODE, G_UPL_TABLE_NUM, and G_LOG_BUFFER_TBL, calls within a single session are not re-entrant and must be sequenced by the calling AK API. Customers and partners should treat all entry points as private and unsupported; any customization should target the public counterparts in AK_ON_OBJECTS_PUB rather than this package.