Search Results iby_checknumber_pub




Overview
Explore in AI Chat

Overview

IBY_CHECKNUMBER_PUB is a public PL/SQL package in the APPS schema that centralizes check numbering and paper document handling for Oracle Payments (IBY) in Oracle E-Business Suite 12.1.1 and 12.2.2. During payment instruction build, disbursement, and printing, Payments must assign sequential or formula-driven document numbers to paper payment instruments, record the printed documents that consume those numbers, and synchronize the results back to payment instructions and payments. This package encapsulates that logic so that disbursement and instruction-building programs do not embed numbering rules directly.

The package operates in the context of payment instructions and payment documents. It determines how many printed documents a payment requires, splits payments by instrument type, assigns check or electronic document numbers, updates instructions with the resulting check numbers, and inserts the paper document rows that represent physical output. It also performs the persistence step and the final database updates within the payment build transaction. Because it is classified as a PUB API, it is intended for invocation by other Payments APIs and concurrent programs rather than by end users.

Key Procedures and Functions

The package exposes 18 documented procedures and functions. Their purposes are as follows.

  • PERFORMCHECKNUMBERING – drives the overall check numbering process for a set of payments or instructions.
  • POPULATEDOCUMENTCOUNT – populates the count of documents required for the payments being processed.
  • UPDATEPAYMENTINSTRUCTIONS – writes numbering and document results back to payment instructions.
  • PERFORMDBUPDATES – performs the consolidated database updates within the numbering transaction.
  • PROCESSPAPERPAYMENTS – processes payments that produce paper instruments.
  • GETNUMPRINTEDDOCSBYFORMULA – returns the number of printed documents derived from a numbering formula.
  • GETDOCUMENTCOUNTFORPAYMENT – returns the document count applicable to a given payment.
  • PERFORMSPECIALPAPERDOCHANDLING – applies special handling rules for paper documents.
  • UPDATEPMTSWITHCHECKNUMBERS – updates payment records with assigned check numbers.
  • UPDATESETUPDOCSFLAGFORINSTR – sets the document setup flag on the instruction.
  • INSERTPAPERDOCUMENTS – inserts the paper payment document rows.
  • SPLITPAYMENTSBYTYPE – splits payments according to instrument or document type.
  • ASSIGNCHECKNUMBERS – assigns check numbers to paper payments.
  • ASSIGNELECTRONICCHECKNUMBERS – assigns document numbers to electronic payments that still require numbering.
  • ISPAPERDOCNUMUSED – indicates whether a paper document number has already been used.
  • ISSINGLEPAYMENT – indicates whether the payment under evaluation is a single payment.
  • ISCONTIGPAPERNUMAVLBL – indicates whether contiguous paper numbers are available.
  • ISPAPERNOSUSEDONEXISTPMT – indicates whether paper numbers are already used on an existing payment.

Tables Accessed

The package reads and writes the core Payments tables through APPS synonyms. CE_PAYMENT_DOCUMENTS and IBY_USED_PAYMENT_DOCS hold the document numbers and the record of used numbers, supporting the assignment and validation routines. IBY_DOCS_PAYABLE_ALL and IBY_PAYMENTS_ALL are updated with assigned check numbers and payment-level document results. IBY_PAY_INSTRUCTIONS_ALL is updated with instruction-level check numbers and document setup flags. IBY_PAY_SERVICE_REQUESTS, IBY_TRANSACTION_ERRORS, and IBY_TRXN_ERROR_TOKENS are used for service request tracking and error capture. DUAL and PLITBLM are used for scalar evaluation and PL/SQL table handling.

Usage Notes

IBY_CHECKNUMBER_PUB is invoked indirectly by disbursement and build processing, including IBY_BUILD_INSTRUCTIONS_PUB_PKG, IBY_DISBURSE_SINGLE_PMT_PKG, IBY_DISBURSE_SUBMIT_PUB_PKG, and IBY_DISBURSE_UI_API_PUB_PKG, and it is referenced by itself for internal recursion across its own subprograms. Typical triggers are the Payments instruction build and the payment disbursement/print process, where check numbers must be assigned before printing and persisted afterward. Custom code should call the package only through the supported Payments APIs; direct invocation requires an understanding of the payment instruction and document state, since numbering depends on document counts, formulas, and the available contiguous number range. Special paper document handling and contiguous-range validation should be allowed to run before any external numbering is applied.