Search Results status_batch_comm_error

Overview

IBY_UTILITY_PVT is a private (PVT) PL/SQL package in the Oracle Payments (IBY) module of Oracle E-Business Suite. It is a low-level utility library that centralizes the constants, conversion routines, NLS helpers, property accessors, and validation logic shared by the many public and private packages that make up the payments infrastructure. The package header carries the revision identifier $Header: ibyvutls.pls 120.9.12010000.4 2008/11/21 09:53:04 vkarlapu ship $, which indicates that the utility layer has been stable across the 12.1.1 and 12.2.2 code lines.

A significant portion of the specification is devoted to the iPayment transaction and batch status codes. These constants — including STATUS_SUCCESS, STATUS_COMM_ERROR, STATUS_DUP_ORDER_ID, STATUS_DUP_BATCH_ID, STATUS_FIELD_MISSING, STATUS_BEP_ERROR, STATUS_BATCH_PARTIAL, STATUS_BATCH_FAIL, STATUS_NOT_SUPPORTED, STATUS_TRANSITIONAL, STATUS_PENDING, STATUS_SCHED_*, STATUS_CANCELLED, STATUS_BEP_FAILED, STATUS_UNABLE_TO_PAY, STATUS_SUBMITTED, STATUS_INVALID_CC, STATUS_TRXN_DECLINED, STATUS_OPEN_BATCHED, STATUS_BATCH_COMM_ERROR, and STATUS_BATCH_TRANSITIONAL — must remain synchronized with the mid-tier definition in iby.ecapp.Constants. Because they are private, they exist to give server-side PL/SQL the same literal vocabulary that the Java payment engine uses.

Key Procedures and Functions

The package exposes 34 documented procedures and functions. For the user query get_view_param, the directly relevant routine is GET_VIEW_PARAM, which retrieves a stored view parameter value. Its counterpart, SET_VIEW_PARAM, writes such a value. Both operate against the global temporary table IBY_VIEW_PARAMETERS_GT, which is the OAF-style session-scoped parameter store used to carry state across pages and regions of the Payments UI.

Other routines fall into several functional groups:

• Type conversion and string handling: TO_NUM, ISNUMERIC, MAKE_ASCII, ENCODE64, DECODE64.
• Error handling: HANDLE_EXCEPTIONS and HANDLEEXCEPTION, which provide standardized exception logging and propagation.
• Property and profile access: GET_PROPERTY, SET_PROPERTY, and GET_JTF_PROPERTY.
• NLS support: GET_LOCAL_NLS, GET_NLS_CHARSET, and GET_CALL_EXEC.
• Validation: CHECK_LOOKUP_VAL, VALIDATE_PARTY_ID, VALIDATE_APP_ID, VALIDATE_TERRITORY, and IS_TRIVIAL.
• View parameter state: SET_VIEW_PARAM and GET_VIEW_PARAM.

Each routine is intentionally narrow in scope; the package acts as a grab-bag of primitives rather than a business service.

Tables Accessed

The package references the following tables through APPS synonyms:

• IBY_VIEW_PARAMETERS_GT — the global temporary table backing SET_VIEW_PARAM and GET_VIEW_PARAM.
• FND_APPLICATION and FND_TERRITORIES — used by VALIDATE_APP_ID and VALIDATE_TERRITORY.
• FND_LOOKUP_VALUES — used by CHECK_LOOKUP_VAL to validate lookup codes.
• HZ_PARTIES — accessed by VALIDATE_PARTY_ID.
• IBY_CREDITCARD — used in credit card related validation, notably around STATUS_INVALID_CC.
• IBY_TRXN_SUMMARIES_ALL, IBY_PAYMENTS_ALL, IBY_PAY_INSTRUCTIONS_ALL, IBY_FNDCPT_PMT_CHNNLS_B, IBY_FORMATS_B, IBY_PAY_SERVICE_REQUESTS — the core payments, format, and payment channel configuration tables consulted during utility operations.
• AP_INV_SELECTION_CRITERIA_ALL — accessed for invoice selection criteria.
• XDO_TEMPLATES_B — referenced for template metadata.
• DBMS_TRANSACTION — used for transaction-level operations such as savepoints.

Usage Notes

IBY_UTILITY_PVT is classified as a private API, meaning it is not intended for direct invocation by customer or partner code. It is referenced by 44 other packages within the Oracle Payments module, which import its constants and call its helper routines. In practice, developers encounter it indirectly: when an IBY form, an OA Framework page, or a payment-related concurrent program executes, the calling package delegates conversion, validation, NLS formatting, and view parameter storage to these routines. Custom code that must call GET_VIEW_PARAM or SET_VIEW_PARAM would do so only when extending a Payments OAF page or replicating its session-state behaviour. Because the package is private, Oracle does not guarantee signature stability across patches, and supported integration should always target the public IBY APIs instead.