Search Results ams_listheader_pvt




Overview
Explore in AI Chat

Overview

The APPS.AMS_LISTHEADER_PVT package body is the core private API layer for managing list headers within the Oracle Marketing (AMS) module of Oracle E-Business Suite. List headers represent the top-level definition of a marketing list — a named grouping of contacts, prospects, customers, or other entities that is assembled according to selection criteria and used in campaigns, telemarketing efforts, and lead generation activities. The package encapsulates the business logic required to create, maintain, validate, and delete these list header records, shielding callers from the underlying data model distributed across the AMS_LIST_HEADERS_ALL, AMS_LIST_HEADERS_ALL_TL, and related tables.

Classified as a PVT (private) API, this package is not intended for direct invocation by external integrators. It is invoked by the corresponding public API layer, by Oracle Marketing forms, and by other dependent packages within the AMS schema. The package is a VALID object owned by the APPS schema and, per the ETRM metadata, is referenced by sixteen other packages, confirming its role as a foundational component of the marketing list infrastructure.

Key Procedures and Functions

The ETRM documentation identifies twelve procedures and functions that constitute the package interface:

  • CREATE_LISTHEADER — Inserts a new list header record, assigning identifiers and persisting the header definition to the base and translation tables.
  • UPDATE_LISTHEADER — Modifies an existing list header, applying changes and maintaining translation and descriptive flexfield data.
  • DELETE_LISTHEADER — Removes a list header and manages the associated referential integrity across dependent list entry and usage tables.
  • LOCK_LISTHEADER — Obtains a lock on the list header record to prevent concurrent modification during transactional processing.
  • VALIDATE_LISTHEADER — Performs attribute-level and business-rule validation on header data before persistence.
  • VALIDATE_LIST_ITEMS — Validates the collection of items associated with a list, ensuring entries conform to defined rules.
  • VALIDATE_LIST_RECORD — Validates an entire list record as a unit, encompassing both header and dependent data.
  • INIT_LISTHEADER_REC — Initializes the list header record structure with default or caller-supplied values prior to processing.
  • COMPLETE_LISTHEADER_REC — Populates derived or computed attributes on the list header record to complete the in-memory structure.
  • UPDATE_LIST_HEADER_COUNT — Recalculates and updates the count of entries or members associated with a list header.
  • UPDATE_PREV_CONTACTED_COUNT — Maintains the counter tracking previously contacted members for a list, supporting telemarketing suppression logic.
  • COPY_LIST — Duplicates an existing list header and its associated definition, enabling reuse of established list configurations.

Tables Accessed

The package reads and writes across the AMS list data model. The primary tables are AMS_LIST_HEADERS_ALL (base header records), AMS_LIST_HEADERS_ALL_TL (translated name and description columns), and the sequence AMS_LIST_HEADERS_ALL_S used for primary key generation. The view AMS_LIST_HEADERS_VL provides the language-joined representation used for validation and display.

List membership and selection logic draws on AMS_LIST_ENTRIES, AMS_LIST_TMP_ENTRIES, AMS_LIST_SRC_TYPES, AMS_LIST_SRC_TYPE_USAGES, AMS_LIST_SELECT_ACTIONS, and AMS_LIST_RULE_USAGES, which together define how entries are sourced and selected. AMS_ACT_LISTS links lists to activities such as campaigns. Configuration and lookup data come from AMS_CUSTOM_SETUPS_B, AMS_SOURCE_CODES, and AMS_USER_STATUSES_VL. Workflow integration references WF_ITEM_ACTIVITY_STATUSES via WF_ENGINE, while FND_LANGUAGES, FND_GLOBAL, FND_MESSAGE, and FND_MSG_PUB supply language, session, and message framework services.

Usage Notes

This package is invoked indirectly through the Oracle Marketing application rather than by direct external calls, consistent with its private (PVT) classification. The Marketing Lists and Telemarketing forms call the public wrapper API, which in turn delegates to AMS_LISTHEADER_PVT for header-level operations. The COPY_LIST routine supports the form-based "Copy List" action, while UPDATE_PREV_CONTACTED_COUNT is exercised during telemarketing and campaign execution to keep suppression counts current.

Because the package is referenced by sixteen other AMS packages, including AMS_LISTENTRY_PVT, AMS_LIST_ENTRIES_PVT, and AMS_LIST_QUERY_PVT, customizations should avoid modifying it directly. Custom code requiring list header manipulation should target the corresponding public API or, where none exists, call the private procedures with full awareness that signatures are unsupported and subject to change across patch levels in both 12.1.1 and 12.2.2. The package relies on the standard FND_API error-handling and message-stack conventions; callers should inspect the message stack after invocation rather than relying solely on return status.