Search Results tapi_dev_kit




Overview
Explore in AI Chat

Overview

APPS.TAPI_DEV_KIT is a PL/SQL development kit package owned by the APPS schema and classified under the Oracle EBS API infrastructure category "OTHER." Its design follows the Oracle Application Object Library (AOL) API programming model, combining generic helper routines for API lifecycle management with a set of standard missing-value constants. The package body is not a business-logic API in its own right; rather, it is a reusable utility layer intended for use by other APIs that need a consistent mechanism for starting activities, handling exceptions, closing activities, populating WHO columns, raising messages, and generating primary keys.

The header comments and structure reflect the package lineage as a custom or legacy extension (the "DEV_KIT" naming and the $Header: cscttdkb.pls tag indicate a developer toolkit rather than a shipped Oracle product API). ETRM records that the package is referenced by 29 other packages, confirming that it is a widely consumed dependency within the APPS schema.

Key Procedures and Functions

  • START_ACTIVITY — Opens an API invocation. It establishes a savepoint named from the API name and API type via DBMS_TRANSACTION.SAVEPOINT, validates caller compatibility using FND_API.Compatible_API_CALL, optionally initializes the message list when the initialization flag is set, and returns the standard return status (for example FND_API.G_RET_STS_SUCCESS).
  • HANDLE_EXCEPTIONS — The routine most directly associated with the user search term. It rolls back to the API savepoint created by START_ACTIVITY, then inspects the incoming exception name. Where the exception maps to a standard API error status, it invokes FND_MSG_PUB.Count_And_Get to populate the message count and message data output parameters and returns an unexpected-error status by default.
  • END_ACTIVITY — Closes an API invocation, releasing the savepoint established at start and finalizing the message list handling.
  • GET_WHO_INFO — Retrieves WHO-column context information (created by, creation date, last updated by, last update date, last update login) needed to stamp audit columns on insert and update operations.
  • SET_MESSAGE — Places a message onto the message stack using the standard FND message publication mechanism.
  • GET_PRIMARY_KEY — Generates or retrieves a primary key value for entities managed by calling code, typically via sequence or table-based key generation.
  • G_MISS_NUM_F, G_MISS_DATE_F, G_MISS_CHAR_F — Globally defined constants representing missing (unset) numeric, date, and character values, used to distinguish "no change" from an explicit null in update APIs.

Tables Accessed

ETRM documents only two referenced database objects, both accessed through APPS synonyms: DBMS_SQL and DBMS_TRANSACTION. These are not application tables in the conventional sense. DBMS_TRANSACTION is used for savepoint creation and its rollback counterpart, providing transactional integrity around API calls. DBMS_SQL indicates dynamic SQL usage, most plausibly within GET_PRIMARY_KEY and GET_WHO_INFO for constructing statements at runtime. No EBS business tables are documented as being read or written directly by this package.

Usage Notes

TAPI_DEV_KIT is intended to be called from other PL/SQL APIs rather than from Oracle Forms or concurrent programs directly. The canonical pattern is: call START_ACTIVITY, execute the business logic, and on any exception invoke HANDLE_EXCEPTIONS, whose result is returned to the caller; END_ACTIVITY closes the transaction scope. Because the package creates and rolls back savepoints, calling code must observe the standard AOL API savepoint discipline and must not nest incompatible savepoint names. The 29 referencing packages confirm broad reuse across the APPS schema.