Consumer Goods Cloud Developer Guide

Consumer Goods Standard Objects
Sync Management Custom Objects
Retail Execution Custom Objects
Trade Promotion Management Custom Objects
Custom Objects for Retail Execution and Trade Promotion Management
Custom Objects for Future Use
Consumer Goods Cloud Associated Objects
Consumer Goods Standard Metadata APIs
Consumer Goods Cloud Custom Metadata Types
Consumer Goods Business APIs
Trade Promotion Management Service APIs
MetadataWizard
Metadata Definition
Metadata Wizard Expression
Metadata Components
Promotion Wizards & Customization
New Promotion Wizard Input Structure
Trade Promotion Management Transformation Engine Workflows
Promotion Creation Workflow
Promotion Copy Workflow
TPM User Interface Customization
TPM UI Edit Access Rights Customization
TPM Promotion and Tactic Transfer Customization
Retail Order Customization
TPM Calendar Launchpad Customization
tpm-promotion Component
TPM Account Plan LWC Reference
TPM Promotion Header LWCs
TPM_ManualInputs Class
TPM_ParticipatingCustomers Class
TPM_ParticipatingCustomers.ParticipatingCustomer Class
TPM_ProductFilter Class
TPM_ProductFilter.ManualProduct Class
TPM_Promotion Class
TPM_Promotion.DoWork Class
TPM_Promotion.Record
TPM_Promotion.TacticRecord
TPM RTR Report Classes
TPM_Scenarios Class
TPM_Scenarios.ScenarioParameter Class
TPM_SubAccounts
TPM_SubAccounts.SubAccount
tpmGenericUtils Module
Einstein Visit Recommendation Standard Objects
Einstein Visit Recommendation Recommendation Associated Objects
Einstein Visit Recommendation Recommendation Actions
Einstein Visit Activity Recommendation Standard Objects
Einstein Visit Task Recommendation Associated Objects
API End-of-Life Policy
PDF

Newer Version Available

This content describes an older version of this product. View Latest

New Promotion Wizard Input Structure

This document describes the input that SmartUI generates when initializing the new metadata-driven promotion wizard. SmartUI extracts information on where the user clicked when launching the wizard in order to provide as much information as possible to the wizard so it can be used to provide sensible defaults.

Input Sample for New Promotion

Properties

This method returns a list of items with the following properties:
Property Name Type Description
Slogan String

Promotion slogan of the row where the user clicked to create a new promotion.
GroupText String

Group text of the row where the user clicked to create a new promotion.
initialDate Number Timestamp of the date on the calendar view the user clicked on in milliseconds.
AnchorAccount Id

Account of the row where the user clicked to create a new promotion.
PromotionTemplate Id

Promotion template of the row where the user clicked to create a promotion.
criterion_<X>_product__c Id

Product hierarchy of the row where the user clicked to create a promotion.
<x>__c String

Additional product grouping attributes present in the row where the user clicked to create a promotion.

Input Sample for Copy Promotion

Properties

This method returns a list of items with the following properties:

Property Name Type Description
promotionId String

ID of the promotion that is copied.

Input Sample for Derive Promotion

Properties

This method returns a list of items with the following properties:

Property Name Type Description
promotionId String

ID of the promotion that is derived..

Using MetadataWizard in custom components

MetadataWizard engine can be used in Aura components to render wizards in your custom Aura components.

Component Markup
Component Controller
Parameter Type Required Default Value Description
metadata Object true* Object representing the Wizard metadata (same format as on MetadataWizard Configuration Record).
metadataName String true* MetadataWizard configuration record name to extract the metadata from.
input Object FALSE {} Metadata Wizard Input. This object can be accessed in expressions using the _input_ identifier.
stateBeforeSubmit Boolean FALSE FALSE Represents the state of the wizard input state between executions of the runWizard function.
modal Boolean FALSE FALSE If true, the wizard will e rendered as a modal. If false, the wizard will be rendered inline.