Search Results iby_netutils_pvt




Overview
Explore in AI Chat

Overview

IBY_NETUTILS_PVT is a private (PVT classification) PL/SQL utility package in the Oracle Payments (IBY) module of Oracle E-Business Suite. Its purpose is to provide low-level network and URL-handling primitives used by other Payments components when communicating with external systems over HTTP or the local file system. The package encapsulates the mechanics of building URLs, encoding and decoding URL characters across differing NLS environments, managing HTTP proxy configuration, and issuing HTTP POST requests through UTL_HTTP. Because it is a private package, it is not intended as a public API; it exists as a shared infrastructure layer that higher-level IBY packages call internally. The source header (ibynutls.pls 120.4.12010000.1) confirms its historical role as a foundational utility within the Payments codebase.

Key Procedures and Functions

Eleven documented routines make up the package interface, each addressing a specific network or URL utility concern:

  • SET_PROXY — Configures HTTP proxy settings for a request, reading profile options such as IBY_HTTP_PROXY and IBY_NOPROXY_DOMAIN (defined as G_PROFILE_HTTP_PROXY and G_PROFILE_NO_PROXY constants in the specification).
  • DECODE_URL_CHARS — Decodes an encoded URL string, optionally translating between a local and a remote NLSLang to handle character-set differences correctly.
  • ESCAPE_URL_CHARS — Returns the URL-encoded form of a supplied string, again with optional local and remote NLS parameters; raises the encoding_error exception on failure.
  • UNPACK_RESULTS_URL — Parses a results URL returned by an external service, decomposing it into its constituent components for downstream consumption.
  • POST_REQUEST — Issues an HTTP POST request, forming the core outbound communication routine used to transmit data to remote endpoints.
  • CHECK_MANDATORY — Validates that required parameters or conditions are present before a network operation proceeds.
  • CHECK_OPTIONAL — Validates optional parameters, applying defaults or tolerating absence where appropriate.
  • GET_BASEURL — Derives or returns the base URL used to construct full request targets.
  • GET_LOCAL_NLS — Retrieves the local environment/database NLSLang value, used to drive character-set conversions in the encode/decode routines.
  • PATH_TO_URL — Converts a file system path into a URL form, using the G_NET_PATH_SEP ('/') and G_FILE_PROTOCOL ('file:') constants.

The package also declares the v240_tbl_type, an associative array of VARCHAR2(240) indexed by BINARY_INTEGER, used for storing name-value pairs, and the encoding_error exception for signalling encode/decode failures.

Tables Accessed

No application tables are read or written directly. The package references the following via APPS synonyms for its network and character-handling operations:

  • UTL_HTTP — Provides the HTTP client capabilities underlying POST_REQUEST and proxy handling.
  • UTL_TCP — Supplies lower-level TCP socket support used in network communication.
  • UTL_RAW — Enables raw byte manipulation required during URL encoding and decoding.
  • DBMS_LOB — Supports large-object handling for request and response payloads.

Configuration values are sourced from profile options (IBY_HTTP_PROXY, IBY_NOPROXY_DOMAIN) rather than from database tables.

Usage Notes

IBY_NETUTILS_PVT is referenced by three other packages in the IBY schema, which invoke it to construct URLs, encode parameters, manage proxies, and post requests to payment service providers or internal web services. It is designed to be called from PL/SQL code, typically within concurrent programs, workflow activities, or other server-side Payments processing rather than from Oracle Forms directly. When the term "send_request" is used in this context, it refers to the outbound HTTP request flow orchestrated through POST_REQUEST and its supporting routines SET_PROXY, GET_BASEURL, and the URL character-handling functions. Developers extending Payments integrations should treat this package as internal infrastructure and prefer documented public APIS over direct invocation.