Results for “ams_refreshmetric_pvt”

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

Overview

AMS_REFRESHMETRIC_PVT is a private PL/SQL package body in the APPS schema that supports Oracle Marketing (AMS) metric refresh processing. Its role is to recalculate, regenerate, and maintain metric records associated with marketing campaigns, events, deliverables, offers, and other marketing objects. As a PVT (private) API, it is not intended for direct invocation by external interfaces; instead, it is called internally by the public marketing metric engine and related APIs such as AMS_ACTMETRICS_ENGINE_PVT, AMS_ACTMETRIC_PUB, AMS_ACTMETRIC_PVT, and AMS_METRIC_PVT.

The package sits within the Marketing Analytics metric subsystem, where metrics quantify campaign performance, response rates, accruals, and other measurable outcomes defined in metric templates. The refresh logic reconciles seeded metric definitions, triggers recomputation against source transactional data, and ensures metric accruals remain consistent across the marketing object hierarchy. In Oracle EBS 12.1.1 and 12.2.2, the body remains VALID and is referenced by seven other packages, confirming its role as a foundational internal component of the AMS metric infrastructure.

Key Procedures and Functions

The ETRM metadata documents eight procedures and functions within this package body:

• REFRESH_METRIC — The central procedure for refreshing a metric. It recalculates metric values by consulting metric definitions and source data, and persists results for downstream reporting.
• REFRESH_ACT_METRICS — Refreshes actual metrics, typically invoked after transactional activity such as responses, orders, or campaign executions, ensuring actuals align with accrued definitions.
• GETMETCATVAL — Retrieves the category value associated with a metric, supporting classification and grouping of metric results.
• COPY_SEEDED_METRIC — Copies seeded (predefined) metric templates or definitions into a customer-specific context, enabling out-of-the-box metrics to be adopted and customized.
• CREATE_APPORT_METRIC — Creates apportioned or allocated metrics, distributing metric values across related objects such as campaigns or schedules.
• CONVERT_UOM — Converts metric values between units of measure, leveraging currency/UOM conversion facilities (INV_CONVERT is a documented dependency).
• CHECK_OBJECT_STATUS — Validates the status of a marketing object before refreshing its metrics, preventing processing of inactive or invalid records.

An eighth documented entry completes the set; the listed procedures cover refresh, seeding, apportionment, conversion, and status validation — the complete lifecycle of metric maintenance.

Tables Accessed

The package operates across the core AMS metric and marketing object tables, accessed via APPS synonyms:

• AMS_METRICS_ALL_B, AMS_METRICS_VL — Base and view-level metric definitions.
• AMS_ACT_METRICS_ALL, AMS_ACTMETRICS_ENGINE_PVT (dependency) — Actual metric values and engine logic.
• AMS_METRIC_ACCRUALS, AMS_METRIC_ACCRUALS_S — Accrual records and their sequence.
• AMS_MET_TPL_DETAILS, AMS_MET_TPL_HEADERS_B — Metric template details and headers.
• AMS_CAMPAIGNS_ALL_B, AMS_CAMPAIGN_SCHEDULES_B — Campaign and schedule context.
• AMS_CATEGORIES_B, AMS_CATEGORIES_VL — Metric category definitions.
• AMS_DELIVERABLES_ALL_B, AMS_EVENT_HEADERS_ALL_B, AMS_EVENT_OFFERS_ALL_B — Deliverable, event, and offer objects whose metrics are computed.
• AMS_CUSTOM_SETUP_ATTR, AMS_OBJECT_ASSOCIATIONS — Setup attributes and object relationship mappings.
• DUAL — Used for single-row lookups and dual-purpose queries.

Usage Notes

AMS_REFRESHMETRIC_PVT is a private package and should not be called directly from custom code or SQL*Plus scripts. It is invoked indirectly through the public marketing metric APIs — AMS_ACTMETRIC_PUB and AMS_ACTMETRIC_PVT — which are in turn triggered by Marketing forms, concurrent programs, and the activity metric engine. Typical invocation scenarios include campaign performance refresh, actual-metric recalculation following response capture, and template-based metric seeding during implementation. Customizations that must extend metric behavior should target the public APIs and leverage the documented dependencies (FND_API, FND_GLOBAL, FND_MESSAGE, FND_MSG_PUB, and INV_CONVERT) rather than modifying this body. Because it is not referenced by any database object outside the APPS metric stack, its signature changes are generally governed by Oracle patch and upgrade cycles.