Search Results get_ip_installation

Overview

PAY_IP_WRAPPER is a PL/SQL package body owned by the APPS schema in Oracle E-Business Suite, documented against releases 12.1.1 and 12.2.2. Its header comment identifies it as the wrapper package for the Payroll Exception Report for International Payroll (the "IP" prefix throughout the package and its procedures denotes International Payroll functionality). The package was authored by Oracle's IDC development group in Hyderabad, India, and carries a copyright notice dated 2005, with the source control header referencing version 120.1.12020000.2 last modified on 20-FEB-2013.

The wrapper exists to expose International Payroll installation checks to other components of the payroll application in a controlled, encapsulated manner. Rather than allowing callers to invoke the underlying utility package directly, the wrapper provides a stable, minimal interface that shields dependent code from changes in the underlying implementation. The package body declares a single global variable, gv_package, initialized to the literal string 'pay_ip_wrapper' in the package initialization block. This global is used for diagnostic and error-message construction so that any failure raised through the wrapper can be attributed to the correct package.

Key Procedures and Functions

The ETRM metadata documents exactly one callable program unit within this package body: GET_IP_INSTALLATION.

• GET_IP_INSTALLATION — Accepts a legislation code as an input and returns a flag indicating whether International Payroll is installed and enabled for that legislation. It does not perform the determination logic itself; it delegates directly to PAY_IP_UTILITY.GET_IP_INSTALLATION, passing the legislation code through and assigning the returned value to its OUT NOCOPY parameter. The change list records that this OUT parameter was converted from a standard OUT to OUT NOCOPY in version 115.1 to avoid unnecessary copying of the return value.

The package specification declares no other procedures or functions, and the body contains no private helper routines. The documented interface is therefore intentionally narrow: a single pass-through call whose sole purpose is installation verification.

Tables Accessed

The ETRM metadata records no tables referenced directly through APPS synonyms by this package. This is consistent with its design as a delegation layer — any data access relating to installation status is performed inside PAY_IP_UTILITY, which the wrapper invokes. No DML statements, cursors, or direct SQL references appear in the documented source excerpt, and no insert, update, or delete activity is attributed to the package.

Usage Notes

PAY_IP_WRAPPER is a utility-layer package invoked programmatically rather than through a user-facing form or concurrent program parameter screen. Typical invocation paths include the Payroll Exception Report for International Payroll and other International Payroll components that must first confirm whether International Payroll functionality is licensed and installed for a given legislation before proceeding. It is also a common defensive check in custom extensions and client-specific code, where developers call GET_IP_INSTALLATION to branch behavior based on whether International Payroll is active.

The metadata indicates that this package is referenced by one other package, confirming its role as a shared dependency within the International Payroll suite rather than a top-level entry point. Because the wrapper throws errors attributed to gv_package, error logs produced during failed installation checks will identify 'pay_ip_wrapper' as the source. When the wrapper is called, the legislation code supplied must correspond to a valid legislation recognized by PAY_IP_UTILITY; an unrecognized or non-International-Payroll legislation will return a negative flag rather than raising an exception. Note that the user search term "AGRO INDIA CORPORATION" does not correspond to any documented element of this package and appears to be unrelated to the object metadata.