cgcloud__Promotion_Template__c

Template to create promotions. This object is available in API version 54.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Most recent date on which a user referenced this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Most recent date on which a user viewed this record.
Name
Type
string
Properties
Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Unique identification of the record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the record owner.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
RecordTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
This is a relationship field.
Relationship Name
RecordType
Relationship Type
Lookup
Refers To
RecordType
cgcloud__Active_Policy__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether a promotion of this template is initially active or if a tactic of this type is initially pre-set as included in the promotion (not considered if the tactic is manually added to the promotion).
The default value is false.
cgcloud__Active__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the template is active.
The default value is true.
cgcloud__Additional_Custom_Main_KPI_Subsets__c
Type
multipicklist
Properties
Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update
Description
Used when Subset Load Optimization is enabled to specify subsets that are additionally loaded when opening a promotion.
Possible values are:
  • Adjustment
  • BaselineManagement
  • Broker
  • Finance
  • MidLevelPlanning
  • Monitoring
  • Planning
  • PromoUI
  • PromotionScenarios
  • Retailer
  • SPC
  • SPCLumpSum
  • SPCPR
  • VPC
The default value is 'Planning'.
cgcloud__Adjustment_KPI_1_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Stores the description of KPI Set KPI Definition.
This is a calculated field.
Formula
cgcloud__Adjustment_KPI_1__r.cgcloud__KPI_Definition__r.cgcloud__Description__c
cgcloud__Adjustment_KPI_1_Name__c
Type
string
Properties
Filter, Nillable, Sort
Description
Currently not used in the layout. It will be referred by the UI team.
This is a calculated field.
Formula
cgcloud__Adjustment_KPI_1__r.cgcloud__KPI_Definition__r.Name
cgcloud__Adjustment_KPI_1__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to KPI Set KPI Definition of the attached KPI Set.
This is a relationship field.
Relationship Name
cgcloud__Adjustment_KPI_1__r
Relationship Type
Lookup
Refers To
cgcloud__KPI_Set_KPI_Definition__c
cgcloud__Adjustment_KPI_2_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Stores the description of KPI Set KPI Definition.
This is a calculated field.
Formula
cgcloud__Adjustment_KPI_2__r.cgcloud__KPI_Description__c
cgcloud__Adjustment_KPI_2_Name__c
Type
string
Properties
Filter, Nillable, Sort
Description
Currently not used in the layout. It will be referred by the UI team.
This is a calculated field.
Formula
cgcloud__Adjustment_KPI_2__r.cgcloud__KPI_Definition__r.Name
cgcloud__Adjustment_KPI_2__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to KPI Set KPI Definition of the attached KPI Set.
This is a relationship field.
Relationship Name
cgcloud__Adjustment_KPI_2__r
Relationship Type
Lookup
Refers To
cgcloud__KPI_Set_KPI_Definition__c
cgcloud__Adjustment_KPI_3_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Stores the description of KPI Set KPI Definition.
This is a calculated field.
Formula
cgcloud__Adjustment_KPI_3__r.cgcloud__KPI_Description__c
cgcloud__Adjustment_KPI_3_Name__c
Type
string
Properties
Filter, Nillable, Sort
Description
Currently not used in the layout. It will be referred by the UI team.
This is a calculated field.
Formula
cgcloud__Adjustment_KPI_3__r.cgcloud__KPI_Definition__r.Name
cgcloud__Adjustment_KPI_3__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reference to KPI Set KPI Definition of the attached KPI Set.
This is a relationship field.
Relationship Name
cgcloud__Adjustment_KPI_3__r
Relationship Type
Lookup
Refers To
cgcloud__KPI_Set_KPI_Definition__c
cgcloud__Anchor_Type__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the anchor type of the promotion.
Possible values are:
  • Customer
  • CustomerSet
cgcloud__Auto_Close_On_Filter_Apply__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the manage product modal window is closed automatically after applying the filters.
The default value is false.
cgcloud__Available_Product_Level__c
Type
multipicklist
Properties
Create, Filter, Nillable, Restricted picklist, Update
Description
Specifies whether the multiple set of values that a user can choose that will be further used for aggregation on the calculation grid for promotions.
Possible values are:
  • Brand
  • Category
  • Flavor—Sub Brand
  • Package—Product Price Group
  • SubCategory—Sub Category
cgcloud__BOM_Handler__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Determines whether BOM products will be considered in promotions created using the template.
Possible values are:
  • ConsiderBOMs
  • ExcludeBOMs
  • None
The default value is None.
cgcloud__Calculation_Mode__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the values of Calculation Mode for the promotion.
Possible values are:
  • AdHoc
  • No
  • Writeback
The default value is No.
cgcloud__Consider_Account_Product_List__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Flag that indicates whether Account Product List is considered for Promotions.
The default value is false.
cgcloud__Consider_Listing__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Controls whether all products of active listings are considered when bringing back the products that are part of the promoted cluster or product group according to the specified listing finding template.
The default value is false
cgcloud__Consider_Product_KAM_Status__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the promotion dates that are used to determine valid products based on KAM Status.
Possible values are:
  • PromotionCommitDate—Promotion Commit Date
  • PromotionTimeframe—Promotion Timeframe
The default value is PromotionCommitDate.
cgcloud__Consider_Promotion_Rewards__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether the promotion is considered for rewards.
The default value is false.
cgcloud__Creation_Platform__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates the platform on which this template can be used to create new promotions.
Possible values are:
  • Both
  • Laptop
  • Mobility
cgcloud__Description_Language_1__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the description of language 1.
cgcloud__Description_Language_2__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the description of language 2.
cgcloud__Description_Language_3__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the description of language 3.
cgcloud__Description_Language_4__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the description of language 4.
cgcloud__Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Stores the description.
This is a calculated field.
Formula
CASE($User.cgcloud__Language_Postfix__c,
"Language1", cgcloud__Description_Language_1__c,
"Language2", BLANKVALUE(cgcloud__Description_Language_2__c,cgcloud__Description_Language_1__c),
"Language3", BLANKVALUE(cgcloud__Description_Language_3__c,cgcloud__Description_Language_1__c),
"Language4", BLANKVALUE(cgcloud__Description_Language_4__c,cgcloud__Description_Language_1__c),
cgcloud__Description_Language_1__c)
cgcloud__Display_Fund_Card__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Determines whether a fund card is enabled for promotions created by using this template.
The default value is true.
cgcloud__Display_In_Visit__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
If at the call date the promotion is valid for the business partner of the call, the promotion is shown in a call.
The default value is false.
cgcloud__Display_KPI_Validations_Only_On_Save__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Determines whether KPI validations are shown only on save while editing the promotion.
The default value is false.
cgcloud__Display_SPC__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Depending on the value of this checkbox, SPC is shown.
The default value is false.
cgcloud__Display_VPC__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
VPC is shown.
The default value is false.
cgcloud__Displayed_Product_Level__c
Type
multipicklist
Properties
Create, Filter, Nillable, Restricted picklist, Update
Description
Product levels that are shown in P&L Views (VPC/SPC).
Possible values are:
  • Brand
  • Category
  • Flavor—Sub Brand
  • Package—Product Price Group
  • SubCategory—Sub Category
cgcloud__Enable_Condition_Creation__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Feature flag to enable the Tactic Condition Creation for promotions of this template. When enabled, conditions will be created for condition generating tactics.
The default value is false.
This field is available in API version 55.0 and later.
cgcloud__Ignore_Time_When_Deleting_The_Promotion__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
If a TPM promotion is associated with a promotion template where Ignore_Time_When_Deleting_The_Promotion is true, then the dates of the TPM promotion (and the transfer lead time or the followup time) aren’t observed to determine if the promotion is relevant for the deletion process.
The default value is false.
cgcloud__Is_Copyable__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Flag that indicates whether a promotion template is copyable.
The default value is false'.
cgcloud__Is_Derivable__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the Promotion Template can be used for a derive action.
The default value is false.
cgcloud__Is_Pushable__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Identifies whether the Promotion Template is pushable.
The default value is false.
cgcloud__Is_Transfer_Relevant__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Identifies and evaluates the promotion associated with the promotion template where Is Transfer Relevant is Yes for the promotion transfer process.
The default value is No.
Possible values are
  • No
  • Yes
cgcloud__KPI_Set__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
This is a relationship field.
Relationship Name
cgcloud__KPI_Set__r
Relationship Type
Lookup
Refers To
cgcloud__KPI_Set__c
cgcloud__Mass_Copy_Start_Date__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Controls how the dates of new promotions are determined when promotions are copied via the Mass Copy process.
Possible values are:
  • Date
  • Weekday
The default value is Weekday.
cgcloud__Mobility_Color__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Color that are used to show the promotion.
Possible values are:
  • Black
  • Blue
  • Coral
  • Corn Flower Blue
  • Cranberry Red
  • Dark Orange
  • Dark Salmon
  • Dark Sea Green
  • Gold
  • Golden Rod
  • Grey Blue
  • Ink Blue
  • Khaki 2
  • Light Blue
  • Light Coral
  • Light Salmon
  • Light Sea Green
  • Light Sky Blue
  • Light Steel Blue
  • Lime Green 2
  • Periwinkle Blue
  • Plum
  • Red
  • Red Violet
  • Rosy Brown
  • Sage Green
  • Salmon
  • Sandy Brown
  • Sea Green 2
  • Sky Blue
  • Sky Blue 2
  • Turquoise 2
  • White
  • Yellow
  • Yellow Orange
cgcloud__Number_Of_Copy_Usage_Hierarchies__c
Type
double
Properties
Filter, Nillable, Sort
Description
Total number of Hierarchies under the Promotion Template with Copy Usage.
This is a calculated field.
cgcloud__Number_Of_Derive_Usage_Hierarchies__c
Type
double
Properties
Filter, Nillable, Sort
Description
Total number of Hierarchies under the Promotion Template with Derive Usage.
This is a calculated field.
cgcloud__Number_Of_Push_Usage_Hierarchies__c
Type
double
Properties
Filter, Nillable, Sort
Description
Number of Child Templates in the Hierarchy with Usage as Push.
This is a calculated field.
cgcloud__Product_Definition_Level__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the level at which products are defined.
Possible values are:
  • Promotion
  • Tactic
The default value is Tactic.
cgcloud__Product_Definition_Policy__c
Type
multipicklist
Properties
Create, Filter, Nillable, Restricted picklist, Update
Description
For Dynamic policy, promotion products can be defined via a filter. Promotion products change according to the changes in the product master data. The result can change until the promotion is frozen (Promotion.Is_Frozen = 'True'). For Static policy, promotion products are explicitly defined. Changes in the product master data don't trigger a change of the promotion products.
Possible values are:
  • Dynamic
  • Static
cgcloud__Promo_Phases_Cleaning__c
Type
multipicklist
Properties
Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update
Description
Promotion phases in which promotion cleaning (scenarios, inactive tactics) happens. Depends on the Promotion_Phases global picklist.
Possible values are:
  • Cancelled
  • Committed
  • ForApproval
  • Modeling
  • Planning
  • Preparation
The default value is Preparation.
cgcloud__Promotion_Type__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of promotion.
Possible values are:
  • Promotion
  • SellablePromotion
cgcloud__Push_Process_Flow__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Promotion push process type.
Possible values are:
  • calculate
  • distributeAndCalculate
cgcloud__Sales_Org__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Sales org of the promotion template.
Possible values are:
  • 0000
  • 0001
  • 0002
  • 0003
cgcloud__Selectable_Promotion__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether the promotion is auto-granted or selectable by selecting the corresponding checkbox.
The default value is false.
cgcloud__Sort__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Sort number.
cgcloud__Special_Order_Relevant__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Flag indicates whether the Promotion is special order-relevant.
The default value is false.
cgcloud__Sub_Accounts_Enabled__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Defines whether the Sub Account Planning feature is enabled for the promotions with this template. This checkbox can only be enabled if Anchor Type is Customer.
The default value is false.
cgcloud__Synchronize_Promotion_Timeframes__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
If this field is selected as TRUE, the Shipment Dates From and Thru and InStore From and Thru dates always have the values set in Date From and Date Thru.
The default value is false.
cgcloud__Target_Promotion_Template__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Identifies target promotion template.
Relationship Name
cgcloud__Target_Promotion_Template__r
Relationship Type
Lookup
Refers To
cgcloud__Promotion_Template__c
cgcloud__TFD_Commit_Date_Offset__c
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Offset that's used to calculate the value of Commit Date from Date From, if the Timeframe Determination Policy isn't Manual.
cgcloud__TFD_Delivery_Date_From_Offset__c
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Offset that's used to calculate the value of Shipment Date From from In-Store Date From, if the Timeframe Determination Policy isn't Manual.
cgcloud__TFD_Delivery_Date_Thru_Offset__c
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Offset that's used to calculate the value of Shipment Date Thru from n-Store Date Thru, if the Timeframe Determination Policy isn't Manual.
cgcloud__Timeframe_Determination_Policy__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Determines whether promotion dates are added by the user or automatically determined by the system from a given pair of In-Store dates.
Possible values are:
  • Manual
  • Simple—Automatic Simple
The default value is Manual.
cgcloud__Trade_Calendar_Color__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the color of the promotion in Trade Calendar.
Possible values are:
  • 0x002266—Violet Blue
  • 0x003344—Ink Blue
  • 0x0070D2—Navy Blue
  • 0x00716B—Pine Green
  • 0x008899—Sea Green
  • 0x009E73—Green Haze
  • 0x00A1E0—Pacific Blue
  • 0x00aa99—Aquamarine
  • 0x023248—Sherpa Blue
  • 0x08A69E—Persian Green
  • 0x16325C—Catalina Blue
  • 0x224433—Deep Green
  • 0x2f539c—Deep Violet
  • 0x337722—Forest Green
  • 0x359b4c—Emerald
  • 0x408fcd—Sky Blue
  • 0x551155—Red Violet
  • 0x60B17D—Ocean Green
  • 0x61022A—Tyrian Purple
  • 0x76DED9—Turquoise Blue
  • 0x7B399C—Vivid Violet
  • 0x94E3B1—Algae Green
  • 0x993399—Violet
  • 0xA10010—Carmine
  • 0xC23934—Flush Mahogany
  • 0xE2CE7D—Chenin
  • 0xE69F00—Gamboge
  • 0xFf9900—Yellow Orange
  • 0xaa1133—Cranberry
  • 0xbbbb00—Lime Green
  • 0xdd4411—Dark Orange
  • 0xeeaa00—Chrome Yellow
The default value is x76DED9.
cgcloud__Trade_Calendar_Relevant__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies whether the promotion is to be shown in Trade Calendar.
Possible values are:
  • Default
  • No
  • Yes
The default value is Yes.
cgcloud__Transfer_Relevant_Phases__c
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
Identifies the promotion phases for the transfer process. Only the promotions in the transfer-relevant phases are considered for transfer.
Possible values are:
  • Canceled
  • Committed
  • ForApproval
  • Modeling
  • Planning
  • Preparation
  • Rejected
cgcloud__Transfer_Lead_Time__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Defines the number of days in the past from the current date the promotion is eligible for transfer.
cgcloud__Transfer_Follow_Up_Time__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Defines the number of days in the future from the current date the promotion is eligible for transfer.
cgcloud__Transfer_Sales_Org__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Identifies the target sales org.
The picklist values are preset from the global picklist value set of the cgcloud__Sales_Org_Value__c field in the cgcloud__Sales_Organization__c object.
cgcloud__UI_Contract__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Contract that's associated with a template.
This is a relationship field.
Relationship Name
cgcloud__UI_Contract__r
Relationship Type
Lookup
Refers To
cgcloud__UI_Contract__c
cgcloud__UI_Type__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Specifies that the UI is displayed for a particular promotion type.
Possible values are:
  • SmartUI
  • StandardUI
The default value is StandardUI.
cgcloud__Use_UI_Contract__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Flag that indicates whether UI contracts are switched off for promotions.
The default value is false.
cgcloud__Used_Reference_Date__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Defines the date that's to be used for the product hierarchy resolution if promotions of this type are calculated.
Possible values are:
  • commitdate—Commit Date
  • today—Today
The default value is commitdate.

Associated Objects

This object has these associated objects. If the API version isn’t specified, they are available in the same API versions as this object. Otherwise, they are available in the specified API version and later.

cgcloud__Promotion_Template__cChangeEvent
Change events are available for the object.
cgcloud__Promotion_Template__cFeed
Feed tracking is available for the object.
cgcloud__Promotion_Template__cHistory
History is available for the tracked fields of the object.
cgcloud__Promotion_Template__cOwnerSharingRule
Sharing rules are available for the object.
cgcloud__Promotion_Template__cShare
Sharing is available for the object.