Search Results activate_batch




Overview
Explore in AI Chat

Overview

HZ_IMP_BATCH_SUMMARY_V2PUB is a public PL/SQL API package in the Oracle E-Business Suite (EBS) Release 12.1.1 and 12.2.2 environment, owned by the APPS schema and classified as PUB (public) in the ETRM documentation. The package provides the programmatic interface for creating and activating import batches within the Oracle Trading Community Architecture (TCA) / Customer Data Management (CDM) import framework. An import batch is a logical container used to group and track records introduced from an external source system (for example DNB or CSV feeds) before they are processed by the customer and contact import programs.

The package body carries the header identifier ARH2BSSB.pls, with the original authoring entry dated 09-JUL-2003, placing the object within the HZ (Trading Community) module lineage. It conforms to the standard Oracle EBS API conventions, including savepoint-based transaction control, message stack initialization via FND_API.G_TRUE/FND_API.G_FALSE, and standardized return status values of FND_API.G_RET_STS_SUCCESS, G_RET_STS_ERROR, and G_RET_STS_UNEXP_ERROR.

Key Procedures and Functions

The ETRM metadata documents two public procedures for this package:

  • CREATE_IMPORT_BATCH — Creates an import batch record. Based on the packaged source excerpt, the procedure accepts a batch name, description, original system, load type (for example DNB or CSV), and an estimated number of records as inputs, and returns the system-generated batch identifier along with the standard API return status, message count, and message data outputs. The procedure establishes a savepoint named create_import_batch at the start of execution and includes an original system existence check (referenced as Bug 4179332).
  • ACTIVATE_BATCH — Activates a previously created import batch, transitioning it into a state in which its records can be processed by the downstream import programs. The ETRM metadata lists this as the second documented procedure of the package.

Together, these two procedures define the minimal lifecycle for an import batch: creation followed by activation.

Tables Accessed

The package reads and writes the following objects, accessed through APPS synonyms as documented for Release 12.2.2:

  • HZ_IMP_BATCH_SUMMARY — The primary transaction table storing the import batch header record, including the batch name, description, original system, load type, and estimated record count. CREATE_IMPORT_BATCH inserts into this table and ACTIVATE_BATCH updates its status.
  • HZ_IMP_BATCH_SUMMARY_S — The sequence and/or secondary key structure used to generate the unique batch identifier returned in the x_batch_id output parameter.
  • HZ_ORIG_SYSTEMS_B — The base table of registered original (source) systems. It is used to validate the p_original_system value supplied by the caller, consistent with the existence-flag check noted in the source excerpt.
  • DUAL — Used for single-row queries and assignments within the procedural logic.

Usage Notes

HZ_IMP_BATCH_SUMMARY_V2PUB is typically invoked by forms, concurrent programs, and custom integration code that need to register an incoming data set before it is imported into TCA. Because it is classified as a PUB API, Oracle supports direct calls from customer extensions and interfaces, provided the documented parameters and return-status conventions are respected.

Callers should always initialize the message list as required, then inspect x_return_status after each call; a value other than FND_API.G_RET_STS_SUCCESS indicates that the batch was not created or activated. The ETRM metadata records that the package is referenced by two other packages, confirming its role as a lower-level service in the import dependency chain. When x_msg_count is one, x_msg_data carries the message text; when it exceeds one, callers should retrieve the full message stack through the standard FND_MSG_PUB utilities. Transaction control follows the savepoint model, so the calling application is responsible for committing or rolling back the surrounding transaction.