Search Results ams_actmetric_pub




Overview
Explore in AI Chat

Overview

APPS.AMS_ACTMETRIC_PUB is a public PL/SQL package within the Oracle E-Business Suite Marketing (AMS) module, classified as a PUB (public) API layer. Its business function is to manage activity metrics, which are the measurement definitions used by Oracle Marketing's campaign analytics and the Enterprise Territory/Resource Management (ETRM) analytics framework. Activity metrics quantify the outcomes of marketing activities and campaigns—such as responses generated, leads created, revenue attributed, or contacts reached—and support the dashboards and reports that marketing managers use to evaluate campaign effectiveness.

The package follows the standard EBS public/private API design pattern. AMS_ACTMETRIC_PUB exposes the externally callable, supported interface, while the actual business logic and DML are delegated to the private package AMS_ACTMETRIC_PVT. The PUB layer depends on the private package, on the FND_API foundation utilities, and on STANDARD (Java-accessible PL/SQL). In the standard Oracle EBS APPS schema, the package status is VALID in both the 12.1.1 and 12.2.2 releases documented here.

Key Procedures and Functions

The package exposes six documented procedures that together provide the full lifecycle for an activity metric definition:

  • CREATE_ACTMETRIC — Creates a new activity metric record, including its name, description, and associated measurement attributes.
  • UPDATE_ACTMETRIC — Modifies the attributes of an existing activity metric, enabling maintenance of metric definitions over time.
  • DELETE_ACTMETRIC — Removes an activity metric definition that is no longer required.
  • LOCK_ACTMETRIC — Acquires a lock on a metric record, supporting concurrency control so that parallel users or processes do not modify the same definition simultaneously.
  • VALIDATE_ACTMETRIC — Performs validation of the metric data before or after persistence, enforcing the business rules defined by the private API layer.
  • INVALIDATE_ROLLUP — Marks associated rollup or aggregated metric data as invalid so that summary values are recalculated, which is essential when an underlying metric definition changes.

Detailed parameter lists are not reproduced here; the public signatures follow the standard EBS conventions (record identifiers, API return status, and message fields), with implementation details held in AMS_ACTMETRIC_PVT.

Tables Accessed

The ETRM metadata indicates that the tables referenced by this package are resolved through APPS synonyms rather than direct schema-qualified references. This is standard EBS practice: the package executes as the APPS schema and accesses the underlying AMS base tables (such as the activity and metric definition tables owned by the AMS schema) via synonyms. Maintenance operations—CREATE, UPDATE, DELETE—write to the metric definition tables, while the validation and rollup invalidation logic reads those definitions and updates dependent aggregate rows. The precise table list is not enumerated in the provided metadata; the authoritative list should be obtained by reviewing the package body or the dependent-code view in ETRM.

Usage Notes

AMS_ACTMETRIC_PUB is not typically invoked directly by end users. It is called by higher-level marketing components, as confirmed by the dependency information: the package is referenced by AMS_CAMPAIGNRULES_PVT and AMS_REFRESHMETRIC_PVT, the latter indicating use during the metric refresh process. It is invoked from Oracle Marketing setup and administration forms when metric definitions are created or maintained, and from concurrent programs that refresh campaign metrics and rollups. Because it is a public API, customers and partners may also call these procedures from custom PL/SQL to extend or automate activity metric maintenance, provided they respect the documented public interface and do not call AMS_ACTMETRIC_PVT directly. When calling it from custom code, the standard EBS API conventions apply: check the return status, inspect the message fields, and commit or roll back the transaction at the appropriate boundary. The INVALIDATE_ROLLUP procedure should be used deliberately, as it affects aggregated analytics data and may trigger recalculation programs.