Results for “itg_setup”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

ITG_SETUP is a server-side PL/SQL package owned by the APPS schema that supports the Oracle E-Business Suite Intelligence Trading Gateway (ITG). Its primary business function is to perform the one-time and repeatable configuration steps required before ITG can exchange transactional documents through the XML Gateway. The package script header carries a source control trace of itghlocs.pls 120.2, indicating that the package has been stable since at least 2005 and is a legacy component still delivered in the 12.1.1 and 12.2.2 file systems.

Three configuration activities are documented in the package header comments: creating a default trading partner location record in HR_LOCATIONS, defining the XML Gateway trading partner definition, and enabling the ITG database triggers. Although the package can technically be invoked from any PL/SQL caller, its intended entry point is a concurrent program that supplies the standard concurrent request OUT parameters and reports failure through the request log. The package is classified as OTHER in the ETRM metadata and is not referenced by any other database package, confirming that it is a top-level setup utility rather than a shared library routine.

Key Procedures and Functions

The ETRM metadata documents seven procedures within the package. Their documented purposes are as follows:

• SETUP — The master driver procedure, intended to be called from a concurrent program. It orchestrates the setup sequence: setting up the default trading partner location in HR_LOCATIONS, creating the XML Gateway trading partner definition, and enabling all ITG triggers. It returns the standard concurrent program OUT parameters and fails the concurrent request if any error occurs.
• SETUP_HR_LOC — Creates the default trading partner record identified by the location code OIPC Default TP in the HR_LOCATIONS_ALL table. All input parameters for this procedure are mandatory because the underlying HR location APIs require them; default values are supplied through the concurrent program definition that wraps this call.
• SETUP_ECX_TP_HEADER — Establishes the XML Gateway trading partner header definition used by ITG transactions.
• SETUP_TP_DETAILS — Populates the XML Gateway trading partner detail information that complements the header definition.
• ADD_OR_UPDATE_TP_DETAIL — Inserts a new trading partner detail row or updates an existing one, supporting repeat execution of the setup without creating duplicates.
• TRIGGER_CONTROL — Enables or disables the ITG database triggers as part of the setup or teardown sequence.
• SET_ERRMESG — A utility routine that formats error messages returned to the concurrent program or calling process.

The metadata does not expose individual parameter lists for the majority of these procedures, so callers should consult the package specification in the EBS instance for exact signatures.

Tables Accessed

The package references seven tables through APPS synonyms. The HR_LOCATIONS_ALL table is written by SETUP_HR_LOC to hold the OIPC Default TP location, which the XML Gateway trading partner setup requires as a valid address reference. The ECX_TP_HEADERS and ECX_TP_DETAILS tables store the trading partner header and detail definitions created by the trading partner setup routines. The ECX_STANDARDS and ECX_EXT_PROCESSES tables provide the XML Gateway transaction standard and external process metadata against which the trading partner is registered, and ECX_TRANSACTIONS holds the transaction records that ITG processes once the configuration is active. PLITBLM is the standard PL/SQL table used for bulk DML operations against these tables. All accesses occur through APPS synonyms, so the package does not reference the underlying schema owners directly.

Usage Notes

ITG_SETUP is typically invoked through a concurrent program rather than from a form or from custom code. The concurrent program accepts the mandatory arguments that SETUP_HR_LOC requires and defaults them within the program definition, so the administrator running the request supplies only the standard concurrent request parameters and reads the resulting request log for errors. Because the package fails the concurrent request on any error, ITG administrators are expected to review the log and correct problems such as a missing or duplicate OIPC Default TP location before rerunning the request. The package may also be called from custom PL/SQL during migration or cloning activities when the ITG configuration must be recreated in a new environment, but such calls bypass the concurrent manager logging and must handle exceptions directly. No other package in the EBS data model depends on ITG_SETUP, so its execution order relative to other components is governed only by the ITG configuration workflow.