Search Results complete_form_ent_rec

Overview

APPS.AMS_FORMULA_PVT is a private PL/SQL package that supports the Oracle Marketing (AMS) online formula framework. Its declared purpose is to provide procedures that allow the insertion, deletion, update, and locking of Marketing On-Line formulas and formula entries, and to store the seeded functions that can be executed as part of a formula entry. In addition, the package exposes functions that execute a formula and persist the resulting values. The package is defined with AUTHID CURRENT_USER, meaning its SQL statements execute with the privileges of the invoking schema rather than the defining schema — a standard convention for private EBS API packages that are called from other application code rather than directly by end users.

The header history records that the package was created on 31-May-2000 by tdonohoe, with the shipped version corresponding to file amsvfmls.pls 115.7. It belongs to the product's private (PVT) API classification, indicating that it is an internal implementation layer rather than a formally supported public interface.

Key Procedures and Functions

The package exposes seventeen documented procedures and functions, which fall into three logical groups.

• Formula maintenance: CREATE_FORMULA, UPDATE_FORMULA, DELETE_FORMULA, and LOCK_FORMULA manage the header-level definition of an activity metric formula. VALIDATE_FORMULA, VALIDATE_FORMULA_ITEMS, and VALIDATE_FORMULA_REC perform validation on the header record and its associated line items, while COMPLETE_FORMULA_REC finalises the formula record for persistence.
• Formula entry maintenance: CREATE_FORMULA_ENTRY, UPDATE_FORMULA_ENTRY, DELETE_FORMULA_ENTRY, and LOCK_FORMULA_ENTRY manage individual entries (the rows that make up a formula's calculation), invoked in the context of the user's search term create_formula_entry. VALIDATE_FORMULA_ENTRY, VALIDATE_FORM_ENT_ITEMS, VALIDATE_FORM_ENT_REC, and COMPLETE_FORM_ENT_REC validate and complete the entry record before it is written.
• Execution: EXECUTE_FORMULA executes an activity metric formula and stores the result in the AMS_ACT_METRIC_FACTS table. This is the runtime counterpart to the maintenance APIs above.

Two record types are declared: ams_formula_rec_type, carrying the formula id, activity metric id, level depth, parent formula id, audit columns, object version, and formula type; and ams_formula_entry_rec_type, carrying the formula entry id, formula id, order number, entry type, entry value, metric column value, entry operator, and audit columns. These structures are used as the parameter carriers for the create, update, validate, and complete routines.

Tables Accessed

The package reads and writes the core Marketing formula tables through APPS synonyms:

• AMS_ACT_METRIC_FORMULAS and AMS_ACT_METRIC_FORMULAS_S — the base table and its translated (_S) companion, holding formula header definitions and their language-dependent text.
• AMS_ACT_METRIC_FORMULA_ENT_S and AMS_ACT_METRIC_FORM_ENT — the formula entry tables, storing the ordered lines that make up each formula and the translated descriptions of those entries.
• DUAL — used for single-row queries and simple function evaluation.
• PLITBLM — the standard EBS PL/SQL index-by table of VARCHAR2 used for bulk DML within the private API layer.

The package is referenced by one other package in the application, confirming its role as a subordinate implementation layer rather than a top-level entry point.

Usage Notes

Because AMS_FORMULA_PVT is classified PVT, it is not intended for direct invocation from custom code. It is normally called from the Oracle Marketing setup forms that maintain activity metric formulas and their entries, from concurrent programs that evaluate marketing metrics, and from the higher-level AMS public packages that wrap this layer. The validation and completion routines are invoked internally before any insert or update to enforce consistency of the record structures. Customisations that need to create or modify formulas should target the supported public AMS APIs; direct calls to this package risk being invalidated by patching, since the file header shows it is a shipped private implementation with no declared backward-compatibility guarantee.