cgcloud__Promotion_Template__c

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

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

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: Most recent date on which a user referenced this record.

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: Most recent date on which a user viewed this record.

• Type: string
• Properties: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
• Description: Unique identification of the record.

• 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

• Type: reference

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description:

  This is a relationship field.

• Relationship Name: RecordType

• Relationship Type: Lookup

• Refers To: RecordType

• 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).
• Default value: false

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the template is active.
• Default value: true

• 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.

• Default value: Planning

• Possible values:

  • Adjustment
  • BaselineManagement
  • Broker
  • Finance
  • MidLevelPlanning
  • Monitoring
  • Planning
  • PromoUI
  • PromotionScenarios
  • Retailer
  • SPC
  • SPCLumpSum
  • SPCPR
  • VPC

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Stores the description of KPI Set KPI Definition.

  This is a calculated field.

• Formula:

  1cgcloud__Adjustment_KPI_1__r.cgcloud__KPI_Definition__r.cgcloud__Description__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:

  1cgcloud__Adjustment_KPI_1__r.cgcloud__KPI_Definition__r.Name

• 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

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Stores the description of KPI Set KPI Definition.

  This is a calculated field.

• Formula:

  1cgcloud__Adjustment_KPI_2__r.cgcloud__KPI_Description__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:

  1cgcloud__Adjustment_KPI_2__r.cgcloud__KPI_Definition__r.Name

• 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

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Stores the description of KPI Set KPI Definition.

  This is a calculated field.

• Formula:

  1cgcloud__Adjustment_KPI_3__r.cgcloud__KPI_Description__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:

  1cgcloud__Adjustment_KPI_3__r.cgcloud__KPI_Definition__r.Name

• 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

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Specifies the anchor type of the promotion.

• Possible values:

  • Customer
  • CustomerSet

• 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.
• Default value: false

• 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:

  • Brand
  • Category
  • Flavor—Sub Brand
  • Package—Product Price Group
  • SubCategory—Sub Category

• 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.

• Default value: None

• Possible values:

  • ConsiderBOMs
  • ExcludeBOMs
  • None

• Type: picklist

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: Specifies the values of Calculation Mode for the promotion.

• Default value: No

• Possible values:

  • AdHoc
  • No
  • Writeback

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Flag that indicates whether Account Product List is considered for Promotions.
• Default value: false

• 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.
• Default value: false

• 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.

• Default value: PromotionCommitDate

• Possible values:

  • PromotionCommitDate—Promotion Commit Date
  • PromotionTimeframe—Promotion Timeframe

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Specifies whether the promotion is considered for rewards.
• Default value: false

• 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:

  • Both
  • Laptop
  • Mobility

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Stores the description of language 1.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Stores the description of language 2.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Stores the description of language 3.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Stores the description of language 4.

• Type: string

• Properties: Filter, Nillable, Sort

• Description: Stores the description.

  This is a calculated field.

• Formula:

  1CASE($User.cgcloud__Language_Postfix__c,
  2"Language1", cgcloud__Description_Language_1__c,
  3"Language2", BLANKVALUE(cgcloud__Description_Language_2__c,cgcloud__Description_Language_1__c),
  4"Language3", BLANKVALUE(cgcloud__Description_Language_3__c,cgcloud__Description_Language_1__c),
  5"Language4", BLANKVALUE(cgcloud__Description_Language_4__c,cgcloud__Description_Language_1__c),
  6cgcloud__Description_Language_1__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.
• Default value: true

• 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.
• Default value: false

• 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.
• Default value: false

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Depending on the value of this checkbox, SPC is shown.
• Default value: false

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: VPC is shown.
• Default value: false

• Type: multipicklist

• Properties: Create, Filter, Nillable, Restricted picklist, Update

• Description: Product levels that are shown in P&L Views (VPC/SPC).

• Possible values:

  • Brand
  • Category
  • Flavor—Sub Brand
  • Package—Product Price Group
  • SubCategory—Sub Category

• 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.

  This field is available in API version 55.0 and later.

• Default value: false

• 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.

• Type: boolean

• Properties: Create, Defaulted on create, Filter, Group, Sort, Update

• Description: Flag that indicates whether a promotion template is copyable.

  ’.

• Default value: false

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the Promotion Template can be used for a derive action.
• Default value: false

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Identifies whether the Promotion Template is pushable.
• Default value: false

• 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.Possible values are

  • No
  • Yes

• Default value: No

• 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

• 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.

• Default value: Weekday

• Possible values:

  • Date
  • Weekday

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Color that are used to show the promotion.

• Possible values:

  • 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

• Type: double

• Properties: Filter, Nillable, Sort

• Description: Total number of Hierarchies under the Promotion Template with Copy Usage.

  This is a calculated field.

• Type: double

• Properties: Filter, Nillable, Sort

• Description: Total number of Hierarchies under the Promotion Template with Derive Usage.

  This is a calculated field.

• Type: double

• Properties: Filter, Nillable, Sort

• Description: Number of Child Templates in the Hierarchy with Usage as Push.

  This is a calculated field.

• Type: picklist

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: Specifies the level at which products are defined.

• Default value: Tactic

• Possible values:

  • Promotion
  • Tactic

• 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:

  • Dynamic
  • Static

• 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.

• Default value: Preparation

• Possible values:

  • Cancelled
  • Committed
  • ForApproval
  • Modeling
  • Planning
  • Preparation

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: Specifies the type of promotion.

• Possible values:

  • Promotion
  • SellablePromotion

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: Promotion push process type.

• Possible values:

  • calculate
  • distributeAndCalculate

• Type: picklist

• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: Sales org of the promotion template.

• Possible values:

  • 0000
  • 0001
  • 0002
  • 0003

• 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.
• Default value: false

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: Sort number.

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Flag indicates whether the Promotion is special order-relevant.
• Default value: false

• 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.
• Default value: false

• 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.
• Default value: false

• 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

• 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.

• 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.

• 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.

• 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.

• Default value: Manual

• Possible values:

  • Manual
  • Simple—Automatic Simple

• Type: picklist

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: Specifies the color of the promotion in Trade Calendar.

• Default value: x76DED9

• Possible values:

  • 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

• 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.

• Default value: Yes

• Possible values:

  • Default
  • No
  • Yes

• 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:

  • Canceled
  • Committed
  • ForApproval
  • Modeling
  • Planning
  • Preparation
  • Rejected

• 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.

• 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.

• 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.

• 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

• Type: picklist

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update

• Description: Specifies that the UI is displayed for a particular promotion type.

• Default value: StandardUI

• Possible values:

  • SmartUI
  • StandardUI

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Flag that indicates whether UI contracts are switched off for promotions.
• Default value: false

• 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.

• Default value: commitdate

• Possible values:

  • commitdate—Commit Date
  • today—Today

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.

j

Get Started with Consumer Goods Cloud

Retail Execution

Trade Promotion Management

Custom Objects for Retail Execution and Trade Promotion Management

cgcloud__Account_Condition__c

cgcloud__Account_Extension__c

cgcloud__Account_Manager__c

cgcloud__Account_Relationship__c

cgcloud__Account_Set__c

cgcloud__Account_Set_Account__c

cgcloud__Account_Set_Manager__c

cgcloud__Account_Template__c

cgcloud__Account_Trade_Org_Hierarchy__c

cgcloud__Account_Org_Unit__c

cgcloud__Batch_Run_Status__c

cgcloud__Batch_Run_Status_Detail__c

cgcloud__CGCPS_Service_Settings__c

cgcloud__Condition_Template__c

cgcloud__Custom_Permission_User_Role_Mapping__c

cgcloud__Flatten_Account_Hierarchy__c

cgcloud__Product_Assortment_Template__c

cgcloud__Product_Category_Share__c

cgcloud__Product_Hierarchy__c

cgcloud__Product_Template__c

cgcloud__Promotion__c

cgcloud__Promotion_Attachment__c

cgcloud__Promotion_Attachment_Link__c

cgcloud__Promotion_Template__c

cgcloud__Promotion_Template_Hierarchy__c

cgcloud__Promotion_Template_Tactic_Template__c

cgcloud__Sales_Organization__c

cgcloud__Sales_Organization_User__c

cgcloud__Segmentation_Rule__c

cgcloud__Segmentation_Rule_Def__c

cgcloud__Segmentation_Rule_Def_Column__c

cgcloud__Segmentation_Rule_Template__c

cgcloud__System_Setting__c

cgcloud__Trigger_Setting__c

cgcloud__Tactic__c

cgcloud__Tactic_Product__c

cgcloud__Tactic_Template__c

cgcloud__Transaction_Log__c

cgcloud__Update_Activation__c

cgcloud__User_Setting__c

cgcloud__Validation_Rules_Setting__c

Standard and Custom Objects for Future Use

API End-of-Life Policy

Previous Versions