Search Results update_docs

Overview

OZF_AR_SETTLEMENT_PVT is a private PL/SQL API package owned by APPS that supports the Oracle E-Business Suite Trade Management (formerly Oracle Trade Management / ETRM) settlement processing for promotional claims. It is classified as a Private (PVT) API, meaning it is not intended as a public extension point but rather as the internal engine invoked by Oracle's own workflows, forms, and concurrent programs. The package header is declared with AUTHID CURRENT_USER, so all unqualified references resolve against the calling schema's privileges, an important consideration when the package is executed from a custom session.

The package's central business function is to drive the lifecycle of a promotional claim (OZF_CLAIMS) through the settlement process: validating that a claim is eligible and complete, preparing settlement documents and GL entries, creating payments or adjustments, updating the associated Oracle Receivables records, and closing the claim. The settlement process is orchestrated largely through Oracle Workflow, and several procedures in this package are function activities invoked directly by Workflow item types—the header even documents the specific activity OZF_AR_SETTLEMENT_PVT.OZF_SET_REMINDER.

Key Procedures and Functions

The package exposes 18 documented procedures and functions. The most representative include:

• SET_ORG_CONTEXT — A Workflow standard initialisation routine that accepts item type, item key, activity id, command, and an OUT result string, used to establish the correct organisational (multi-org) context before downstream processing.
• START_SETTLEMENT — The primary entry point that initiates settlement for a given claim, accepting the claim id together with previous, current, and next status values, an optional promotional claim flag, and a process identifier (default OZF_CLAIM_GENERIC_SETTLEMENT).
• SET_REMINDER — A Workflow function activity that sends settlement reminders and returns a Run/Cancel/Timeout result to Workflow.
• INCOMPLETE_CLAIM — Handles claims that cannot proceed, typically driving the Workflow to a terminate or error path.
• CHECK_PROMO_CLAIM, CHECK_CLAIM_CLASS, CHECK_PAYMENT_METHOD, CHECK_AUTO_SETL_PROCESS — Validation routines that determine whether a claim qualifies for a given settlement method, payment method, or automated settlement flow before processing continues.
• PREPARE_INSTRUCTIONS, PREPARE_DOCS, UPDATE_DOCS, CREATE_SETTLE_DOC — Assemble the settlement instruction set, generate settlement documentation, and persist those documents.
• CREATE_GL_ENTRIES, REVERT_GL_ENTRIES — Post or reverse the General Ledger accounting for the settlement.
• CREATE_PAYMENT — Creates the payment or adjustment reflecting the settlement amount.
• RESET_STATUS, CLOSE_CLAIM, HANDLE_ERROR — Manage claim status transitions, final closure, and error handling/rollback of the workflow.

Tables Accessed

The package reads and writes a broad set of Trade Management and Receivables tables through APPS synonyms. Claim data is held in OZF_CLAIMS, OZF_CLAIMS_ALL, and OZF_CLAIM_LINES, with settlement documentation in OZF_SETTLEMENT_DOCS. Financial settlement touches AR_ADJUSTMENTS, AR_PAYMENT_SCHEDULES, and AR_RECEIVABLE_APPLICATIONS, all core Oracle Receivables objects, which is expected given the AR (Accounts Receivable) orientation of the settlement flow. Supporting master data is drawn from HZ_CUST_ACCOUNTS, HZ_CUST_SITE_USES, HZ_PARTIES, HR_ALL_ORGANIZATION_UNITS, FND_USER, JTF_RS_SALESREPS, JTF_RS_RESOURCE_EXTNS, and MTL_UNITS_OF_MEASURE.

Usage Notes

Because this is a private API, it should not be called directly from custom code if a public API exists. It is primarily invoked by Oracle Workflow activities associated with the promotional claim settlement item type, and secondarily by settlement forms, concurrent programs, and three other packages that reference it. Custom code that must call it should replicate the Workflow sequence: set the org context, validate the claim, prepare documents and instructions, create GL entries and payment, then close or reset the claim, with error handling through HANDLE_ERROR. Any direct invocation should account for the AUTHID CURRENT_USER declaration and the fact that DDL and behaviour may change between patch levels in 12.1.1 and 12.2.2.