Results for “check_install”

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

Overview

The APPS.WMS_INSTALL package body is a Warehouse Management System (WMS) utility package in Oracle E-Business Suite. Its primary business function is to determine whether the WMS application is installed and enabled at either the site level or for a specific inventory organization. WMS, which is assigned application ID 385 in the FND_APPLICATION table, is a licensed module of the Oracle Advanced Supply Chain Planning and Logistics family, and many dependent modules must confirm its presence before executing WMS-specific logic. This package provides that confirmation through a single documented function, CHECK_INSTALL, which acts as the canonical installation-check API for the WMS stack.

The package is owned by the APPS schema and is classified as an "OTHER" API type in the ETRM repository, meaning it is a supporting utility rather than a formal public DML API. Its header is dated 2005 (revision 120.1), indicating stability across the 12.1.1 and 12.2.2 releases. The package is referenced by 51 other packages, underscoring its role as a shared gating mechanism across WMS-adjacent functionality.

Key Procedures and Functions

• CHECK_INSTALL — The sole documented routine. It returns a BOOLEAN value indicating whether WMS is installed (TRUE) or not (FALSE). It accepts an optional organization identifier; when a specific organization is supplied, the check is scoped to that organization, whereas a NULL organization results in a relaxed, site-level check. Standard Oracle API OUT parameters for return status, message count, and message data are also provided. Internally, the function declares local status, industry, and WMS-enabled flag variables, and compares against the constant WMS application ID (385). Critically, the function documentation states that callers must use the boolean return value — not x_return_status — to determine installation status, because x_return_status can be SUCCESS even when WMS is not installed.

Tables Accessed

• MTL_PARAMETERS (accessed via an APPS synonym) — This inventory organization parameters table stores the WMS_ENABLED_FLAG (and related industry/status columns) used to evaluate whether WMS is enabled. The presence and flag values in this table are the factual basis for CHECK_INSTALL's determination, both at the site level and for a specific organization.

Additional metadata references FND_APPLICATION (via the hard-coded application ID 385) to identify the WMS application registration, though the primary ETRM-documented table dependency is MTL_PARAMETERS.

Usage Notes

CHECK_INSTALL is typically invoked at the start of WMS-dependent business flows, forms, and concurrent programs to gate processing so that WMS-specific logic executes only when the module is genuinely installed and enabled. Given that 51 packages reference this body, it is commonly called by other PL/SQL APIs rather than directly by end users. A typical call passes an organization_id when organization-scoped behavior is required, or NULL for a broader site-level check that is more permissive. Custom code integrating with WMS should follow the same pattern: call CHECK_INSTALL, inspect the returned boolean, and only proceed with WMS functionality when TRUE is returned. Callers should not rely on x_return_status for the installation determination, since a SQL error can set an error status independently of whether WMS is installed. The package is fully compatible with both EBS 12.1.1 and 12.2.2, and its long-stable revision history confirms it remains the authoritative installation-check mechanism for WMS.