Search Results validate_reason_rec

Overview

OZF_REASON_PVT_W is the Oracle Application Object Library (AOL) wrapper package for the ETRM (Enterprise Territory Management / Trade Management) reason-handling private API, OZF_REASON_PVT. The package exists to bridge the PL/SQL native record and collection types used internally by the ETRM reason API and the generic JTF_NUMBER_TABLE, JTF_VARCHAR2_TABLE_100, JTF_VARCHAR2_TABLE_200, JTF_VARCHAR2_TABLE_2000, and JTF_DATE_TABLE structures surfaced to Java, Forms, and OAF (Oracle Application Framework) callers. In Oracle EBS 12.1.1 and 12.2.2 it is owned by APPS and classified as OTHER, meaning it is a support/wrapper API rather than a primary business-facing interface. The "W" suffix is the standard EBS convention denoting a wrapper that exposes PL/SQL-table-typed parameters so that the OZF reason and action records can be passed across the JDBC and BC4J boundary without violating the restrictions those layers impose on record and associative-array types. Business-wise, this package underpins maintenance of reason codes and associated actions used by Trade Management and territory-processing flows, and its VALIDATE_REASON_REC entry point is the one most commonly queried by developers, since it is the server-side validation routine invoked before a reason record is committed.

Key Procedures and Functions

• ROSETTA_TABLE_COPY_IN_P3 / ROSETTA_TABLE_COPY_OUT_P3 — Marshalling routines that copy JTF scalar table parameters into (and out of) the OZF_REASON_PVT.ACTION_TBL_TYPE record structure. They support the three-column action layout and handle the conversion for callers passing data in bulk.
• ROSETTA_TABLE_COPY_IN_P7 / ROSETTA_TABLE_COPY_OUT_P7 — The corresponding marshalling routines for OZF_REASON_PVT.REASON_TBL_TYPE, which is a wide record type (approximately 34 attributes spanning number, date, and varchar2 columns). These two procedures are the largest in the package and exist solely to translate the wide reason row between native PL/SQL and layered JTF tables.
• CREATE_REASON — Creates a new reason record in the ETRM reason model, applying the values supplied by the caller.
• UPDATE_REASON — Modifies an existing reason record.
• UPDATE_ACTIONS — Maintains the action records attached to a reason, inserting, changing, or removing action rows as required.
• CHECK_UNIQUE_ACTION — Validates that the action being defined does not duplicate an existing action on the reason, enforcing the uniqueness rule at the API level.
• VALIDATE_REASON_REC — The record-level validation entry point. It checks a candidate reason record for completeness and business-rule conformance and raises the appropriate error if the record is not valid. This is the procedure identified by the user's search term and is the routine Forms, OAF pages, and custom code call before issuing a create or update.
• VALIDATE_REASON — The scalar-form validation procedure, performing the same logical validation for callers that supply individual attributes rather than a record.
• COMPLETE_REASON_REC — The "completion" routine that fills in derived or defaulted attributes (who-columns and similar) on a reason record prior to persistence.

Tables Accessed

The ETRM metadata documents a single table reference for this package via an APPS synonym: PLITBLM, the AOL PL/SQL interface table used for temporary storage during multi-row PL/SQL table processing. The substantive reason and action data is written by the underlying OZF_REASON_PVT implementation through the OZF_REASON and OZF_ACTION tables, not by this wrapper directly. Customisations should therefore treat OZF_REASON_PVT_W as a pass-through layer and never assume it performs table-level work beyond the PLITBLM interaction.

Usage Notes

OZF_REASON_PVT_W is not invoked from concurrent programs or standalone scripts. It is called programmatically by the ETRM business components and by Forms/OAF code that must move reason and action collections across the JDBC boundary, and it is referenced by no other documented PL/SQL packages. Custom code that needs to validate a reason should call VALIDATE_REASON_REC (or VALIDATE_REASON for scalar input) rather than the OZF_REASON_PVT private API directly, because the wrapper guarantees that the layered JTF table types are correctly populated. Because the package signature is anchored to the JTF_*_TABLE types, callers must build those tables explicitly and must map columns positionally; the column order is fixed by the ROSETTA_TABLE_COPY_IN_P7/P3 definitions. In 12.2.2 the package remains a private API with no supported extension points, so any direct modification risks invalidation, and upgrades should be validated against the ROSETTA copy routines in particular.