Results for “iex_open_interface_pub”

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

Overview

IEX_OPEN_INTERFACE_PUB is a public PL/SQL package body owned by APPS in the Oracle E-Business Suite Collections (Advanced Collections / IEX) module. It acts as the public gateway over the private implementation package IEX_OPI_PVT, exposing an API surface that allows forms, concurrent programs, and custom code to manage the lifecycle of "open interface" records — the staging rows that track disputes, promises, credit bureau inquiries, transfers, recalls, and related collection activities recorded in IEX_OPEN_INT_HST. The package encapsulates the business rules for creating, advancing, completing, and reversing these collection events while insulating callers from the underlying implementation.

The implementation follows the standard EBS PL/SQL API convention of delegating each public procedure to a corresponding private procedure (for example, REPORT_ALL_CREDIT_BUREAU simply calls IEX_OPI_PVT.REPORT_ALL_CREDIT_BUREAU, passing local errbuf and retcode variables through). This layering ensures consistent validation, message stack handling, and multi-org behavior are centralized in the private package. The header comment shows the file as IEXPOPIB.pls, validating the 12.1.x/12.2.x lineage.

Key Procedures and Functions

Eleven documented procedures comprise the public API. REPORT_ALL_CREDIT_BUREAU provides a concurrent-program-compatible entry point (errbuf/retcode signature) that generates credit bureau reporting activity for the population of relevant parties. INSERT_PENDING is the creation routine, adding a new pending open-interface record; its parameters indicate support for an API version and init-msg-list flag, object identifiers (OBJECT1_ID1/ID2 and JTOT_OBJECT1_CODE), an action, a status, comments, and external agency and scheduling attributes such as review date, recall date, and automatic-recall and review-before-recall flags, plus the standard return-status, message-count, and message-data out parameters. PROCESS_PENDING advances pending records through their workflow. COMPLETE_REPORT_CB and COMPLETE_TRANSFER mark the credit bureau reporting and transfer activities as finished. RECALL_TRANSFER and RECALL_FROM_EXTERNAL_AGENCY handle recall scenarios, while REVIEW_TRANSFER supports review-state transitions. NOTIFY_CUSTOMER, NOTIFY_RECALL_EXTERNAL_AGENCY, and NOTIFY_EXTERNAL_AGENCY manage outbound notification to customers and external agencies involved in a collection action.

Tables Accessed

The package and its delegated logic reference five documented tables via APPS synonyms. IEX_OPEN_INT_HST is the primary history/pending table and is the source of the anchored %TYPE declarations used for local variables in INSERT_PENDING (OBJECT1_ID1, OBJECT1_ID2, JTOT_OBJECT1_CODE, ACTION, STATUS, COMMENTS). HZ_PARTIES and HZ_CONTACT_POINTS supply party and contact-point information used to identify and notify customers. JTF_AMV_ITEMS_B provides the message/value lookup (AMV) entries used for statuses, action codes, and notification text. OKL_OPEN_INT links the collection interface rows to Oracle Lease Management open-interface data, enabling transfers and recalls to be coordinated with lease-related disputes.

Usage Notes

Because it is classified as a PUB (public) API, IEX_OPEN_INTERFACE_PUB is the supported integration point; callers should not invoke IEX_OPI_PVT directly. Typical invocations occur from the Advanced Collections forms (for example, the dispute, promise, and credit bureau windows), from the concurrent manager when running the credit bureau report program, and from custom extensions that need to log a pending collection action programmatically. Callers of INSERT_PENDING should follow the standard pattern: pass a valid API version, initialize the message list, provide the object identifiers and action/status codes drawn from JTF_AMV_ITEMS_B, then inspect x_return_status for 'S' success or 'E'/'U' failure and read x_msg_data when x_msg_count is one, or iterate the message stack when multiple messages are returned. The package is referenced by three other packages in the ETRM metadata, indicating it sits at the base of a wider collections integration chain.