Apex Classes for Trade Promotion Management | Consumer Goods Cloud Developer Guide

User Interface Customization
This section provides information on how to customize the TPM user interface.

UI Edit Access Rights Customization
Edit Access Rights (EARights) is a mechanism used by the TPM UI application to selectively enable or disable certain functionality, or UI elements, depending on the business logic.

Promotion and Tactic Transfer Customization
When you save a promotion in Trade Promotion Management (TPM), it triggers a transfer of the planned promotion to Retail Execution (RE). You can modify the saved promotion and its associated tactic or tactic product details before they get transferred by creating two different callable Apex classes as customization hooks.

Calendar Launchpad Customization
Customize the hover content and the buttons for a promotion on the TPM calendar launchpad UI by creating an Apex class as a customization hook.

tpm-promotion Component
The tpm-promotion LWC is a service component that loads a TPM promotion, exposing methods to update the promotion state, and events to keep all UI components of the promotion page in sync when the promotion state changes. This component is provided as part of the released managed package.

Account Plan LWC Reference
The tpm-account-plan LWC is a service component that loads a TPM account plan, exposing methods to update the account plan state, and events to keep all UI components of the account plan page in sync when the account plan state changes.

Promotion Header LWCs
The TPM Promotion header LWCs provide access to the entire TPM promotion header and specific header slots.

Manual Inputs Class
This APEX class provides programmatic access to the TPM Promotion Manual Inputs for Calculation Overrides. This class is used also for Scenario Manual Inputs on Promotion.

ParticipatingCustomers Class
This APEX class provides programmatic access to the TPM Promotion Participating Customers List used in the Promotion Push process.

ParticipatingCustomers.ParticipatingCustomer Class
This APEX class provides programmatic access to a Participating Customer associated to an instance of TPM_ParticipatingCustomers.

ProductFilter Class
This APEX class provides programmatic access to the TPM Promotion Product Filter used in the Promotion. This Product Filter defines the Products that are included in the Promotion.

ProductFilter.ManualProduct Class
This APEX class provides programmatic access to a Manual Products associated to an instance of TPM_ProductFilter.

Promotion Class
This APEX class provides programmatic access to the TPM Promotion SObject and it’s related SObjects.

Promotion.DoWork Class
This APEX interface provides the capability to perform additional work once a promotion is completed and the related records are committed to the database. The transaction will be rolled back if there any any errors reported during the doWork execution.

Promotion.Record
This APEX class provides a wrapper to Promotion SObject Records. Each instance wraps an SObject Record related to the parent TPM_Promotion and provide methods to manipulate them in order to flag them for insertion or deletion. It also provides methods to extract the underlying SObject records so updates can be made.

Promotion.TacticRecord
This APEX class provides a wrapper to Promotion Tactic SObject Records. Each instance wraps an SObject Record related to the parent TPM_Promotion and provide methods to manipulate them in order to flag them for insertion or deletion. It also provides methods to extract the underlying SObject records so updates can be made.

SubAccounts
Creates an empty sub accounts structure.

SubAccounts.SubAccount
This APEX class provides programmatic access to a single Sub Account information contained in a TPM_SubAccounts instance.

Scenarios Class
This APEX class provides programmatic access to the TPM Promotion Scenario information used in the Promotion. Scenarios define selectable sets of Promotion Level Manual Inputs overrides to simulate different combinations of active/inactive tactics and KPI overrides in a TPM Promotion. A TPM_Scenarios structure can contain up to five scenarios information.

Scenarios.ScenarioParameter Class
This APEX class provides programmatic access to a single scenario parameter information contained in a TPM_Scenarios instance.

RTR Report Classes
The RTR report-related APEX classes provide programmatic access to the TPM Real Time Reporting (RTR) report data.

tpmGenericUtils Module
The tpmGenericUtils module provides replacements for accessing the @salesforce modules on components that have the cgcloud runtime namespace.

Trade Promotion Management Transformation Engine Workflows
The workflow comprises APEX callable class to apply the transformations from the input JSON into the output structure.

Promotion Creation Workflow
This section describes the list of workflow step rules that must be provided from core.

Promotion Copy Workflow
This section describes the list of workflow step rules that must be provided from core.

Scheduling Jobs
Most of the scheduling job endpoints use the Job Chain Process Flow.