Search Results wsh_parameters_pvt




Overview
Explore in AI Chat

Overview

WSH_PARAMETERS_PVT is a private PL/SQL package in the APPS schema that provides a central access layer for reading parameter values stored in the WSH_PARAMETERS table. It belongs to the Oracle Shipping (WSH) module of Oracle E-Business Suite and is classified as a PVT (private) API, meaning it is intended for internal consumption by other WSH packages rather than for direct invocation by external or customer-written code. The package was originally created on 10-SEP-96 by ANEOGI and still carries the header identifier WSHUPRMS.pls, with an AUTHID CURRENT_USER declaration that causes execution to run under the privileges of the calling schema.

Its core business purpose is to decouple the retrieval of shipping configuration parameters from the physical table layout of WSH_PARAMETERS. Rather than embedding direct SELECT statements against the parameter table throughout the Shipping application, calling programs reference this package, which in turn fetches parameter values scoped to a given organization. This encapsulates organization-level parameter lookup and provides typed accessors for both character and numeric values.

Key Procedures and Functions

The package exposes two documented public procedures. Neither is a function; both return values through OUT parameters.

  • GET_PARAM_VALUE — Retrieves the value of a named parameter as a character (VARCHAR2) value, scoped to a specific organization. It optionally fetches the corresponding row from the WSH_PARAMETERS table and passes back the value of the given parameter. Documented arguments include the organization identifier, the parameter name, and an OUT parameter value.
  • GET_PARAM_VALUE_NUM — Retrieves the value of a named parameter as a numeric (NUMBER) value, scoped to a specific organization. It follows the same lookup pattern as GET_PARAM_VALUE but returns the parameter in numeric form, which is suitable for parameters that represent quantities, tolerances, or numeric thresholds.

Both procedures accept an organization identifier, a parameter name, and an OUT value. No additional parameters are documented in the ETRM metadata, and callers should not assume any beyond these.

Tables Accessed

The package reads from a single documented table, WSH_PARAMETERS, accessed through the APPS synonym. WSH_PARAMETERS is the Shipping module's parameter repository, holding parameter names, values, and organization identifiers. GET_PARAM_VALUE and GET_PARAM_VALUE_NUM query this table by organization and parameter name to return the stored configuration value. The metadata documents read access only; there is no evidence of inserts, updates, or deletes performed by this package, which is consistent with its stated purpose of fetching and passing parameter values. Parameter maintenance is therefore handled elsewhere in the Shipping application.

Usage Notes

Because WSH_PARAMETERS_PVT is classified as a private package, it is not part of Oracle's published, supported API surface and should ordinarily be invoked only by other WSH module packages. The metadata records that it is referenced by five other packages, confirming that it functions as a shared internal utility for parameter lookup across the Shipping codebase.

Typical invocation occurs from within Shipping forms, concurrent programs, and other WSH back-end logic that require organization-specific configuration values at runtime. Developers writing custom code should prefer any public Shipping API or a direct, controlled query, since Oracle does not guarantee backward compatibility for private packages; signatures and internal behavior may change between releases and patches. Where use is unavoidable, calls should pass a valid organization identifier and a parameter name known to exist in WSH_PARAMETERS, and callers should handle the possibility that no row is found. Both character and numeric variants should be selected according to the native data type of the targeted parameter to avoid conversion errors.