Search Results start_ctrl_grp_process




Overview
Explore in AI Chat

Overview

AMS_LISTGENERATION_UTIL_PKG is a utility PL/SQL package in the Oracle E-Business Suite Oracle Marketing (AMS) module — the application that manages list generation, campaign audiences, and target group processing. In Oracle EBS 12.1.1 and 12.2.2 this package is owned by the APPS schema and is classified as an OTHER API (that is, it is an internal utility rather than a formally published public interface). Its declared AUTHID CURRENT_USER clause means it executes with the privileges of the calling session, behaving as an invoker's-rights routine.

The package supports the list generation lifecycle for list headers tracked in AMS_LIST_HEADERS_ALL. Its responsibilities include cancelling an in-flight list generation, deleting the entries produced by a generation run, updating the status of the list header, querying workflow item status, detecting whether a list is in the process of being cancelled, starting and cancelling the control-group processing step, and gathering preview counts for split previews. The package header originates in amsvlgus.pls version 120.3 (2006), which reflects the code base that has been carried forward into the 12.1.1 and 12.2.2 releases.

Key Procedures and Functions

  • CANCEL_LIST_GEN — Cancels a list generation that is currently in progress. It accepts the list header identifier along with remote-generation context information and returns standard message count, message data, and return status outputs.
  • DELETE_LIST_ENTRIES — Removes the list entries associated with a given list header, clearing the populated results of a generation run and returning standard message and status outputs.
  • UPDATE_LIST_HEADER — Updates the header record for the specified list, typically to reflect a status change during the generation or cancellation cycle. It returns a return status output.
  • GETWFITEMSTATUS — A function that returns the workflow item status for a given list header, used to determine the current workflow state of the generation request.
  • ISLISTCANCELLING — A function that returns an indicator (VARCHAR2) of whether the specified list is already in the process of being cancelled, preventing conflicting operations.
  • START_CTRL_GRP_PROCESS — Starts control-group processing for the identified list header.
  • CANCEL_CTRL_GRP_PROCESS — Cancels control-group processing for the identified list header.
  • GET_SPLIT_PREVIEW_COUNT — Retrieves preview counts for split queries, using a package-level record type and index-by table to hold sequence number, query text, and preview count (added under CR#4886329). The package also declares a cancelListGen exception and a get_status_code cursor over AMS_LIST_HEADERS_ALL.

Tables Accessed

The package references the following tables through APPS synonyms:

  • AMS_LIST_HEADERS_ALL — the master list header table; read for status codes and written by UPDATE_LIST_HEADER.
  • AMS_LIST_ENTRIES — the individual list entries; maintained by the delete operation.
  • AMS_LIST_SRC_TYPES and AMS_LIST_SRC_TYPE_USAGES — source type definitions and their usages, used to govern how a list is populated.
  • PLITBLM — a standard Oracle Applications temporary/PLSQL table used for passing tabular data, commonly supporting the split-preview count mechanism.

Usage Notes

Because this package is classified as an OTHER API, Oracle does not guarantee the stability of its signature across patches, and it should be treated as internal to the marketing list-generation flow. It is normally invoked indirectly — from Oracle Marketing forms, concurrent programs, or workflow background processes that orchestrate list generation and cancellation. Custom code performing similar operations should call the supported marketing list-generation APIs rather than this utility directly. Where custom integration is unavoidable, the most relevant entry point for the search term is UPDATE_LIST_HEADER, which changes the list header status, and CANCEL_LIST_GEN/DELETE_LIST_ENTRIES, which unwind a generation. Only the list header identifier and standard message/status out parameters should be passed; callers must handle the cancelListGen exception and inspect the returned status before proceeding. Two dependent packages reference this unit, confirming its role as a shared utility in the marketing list-generation framework.