Consumer Goods Cloud Developer Guide

Get Started with Consumer Goods Cloud
Retail Execution
Trade Promotion Management
Custom Objects for Trade Promotion Management
Trade Promotion Management Service APIs
Trade Promotion Management Business APIs
Promotion Wizards & Customization
Metadata Wizard
Apex Classes for Trade Promotion Management
Business Objects API
Process Configuration Settings
Configuration Entities
Implementing Workflow Steps
Promotion Business Object API
Business Object API Entity
Business Object API Output Entities
Business Object API Workflows
Workflows and Associated Workflow Steps
Business Object API Workflow Steps
Business Object API Workflow Step Input Structures
Use Promotion Business Objects API
Use Case: Add a New Workflow Step
Custom Objects for Retail Execution and Trade Promotion Management
Custom Objects for Future Use
API End-of-Life Policy
PDF

Newer Version Available

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

Business Object API Workflow Steps

The following table provides information about the BO API Workflow Steps.
Workflow Step Name Classname Method Entity Description
setPromotionDates2 Promotion2BoApiCoreWorkflowSteps setPromotionDates Promotion Sets the promotion dates (Date From, Date Thru, Commit Date, Shipment Date From, Shipment Date Thru, Order Date From, Order Date Thru, In-Store Date From and In-Store Date Thru of a promotion).
setTacticDates2 Promotion2BoApiCoreWorkflowSteps setTacticDates Tactic Sets/Updates the tactic dates (Date From, Date Thru, Shipment Date From, Shipment Date Thru, Instore Date From and Instore Date Thru of a tactic) from input.
applyPromotionDateHandling2 Promotion2BoApiCoreWorkflowSteps applyPromotionDateHandling TPM_Promotion Applies automatic date handling rules to the promotions to be processed. Needs to be executed after "setPromotionDates" rule.
handleManualInputs2 Promotion2BoApiCoreWorkflowSteps handleManualInputs ManualInputs Sets the manual inputs (totals) on product, promotion and tactic level.
setPromotionAnchor2 Promotion2BoApiCoreWorkflowSteps setPromotionAnchor Promotion Sets the Promotion Anchor (Customer, Customer Set or null) depending on the anchor type of the template.
setPromotionCategories2 Promotion2BoApiCoreWorkflowSteps setPromotionCategories TPM_Promotion Sets the promotion categories based on the categories the user has access to for the anchor customer or customer set.
mapPromotionValues2 Promotion2BoApiCoreWorkflowSteps mapValues Promotion Maps promotion values to the output object. Each field is mapped into the Output Object field specified in the 'Maps To' attribute of the Input Structure.
mapTacticValues2 Promotion2BoApiCoreWorkflowSteps mapValues Tactic Maps tactic values to the output object. Each field is mapped into the Output Object field specified in the 'Maps To' attribute of the Input Structure.
setPromotionSubAccounts2 Promotion2BoApiCoreWorkflowSteps setPromotionSubAccounts TPM_Promotion Sets the promotion Sub Accounts, if sub account planning are enabled in promotion template.
setPromotionParticipatingCustomers2 Promotion2BoApiCoreWorkflowSteps setPromotionParticipatingCustomers TPM_Promotion Sets the promotion Participating Customers for pushable promotions.
managePromotionProductFilterCopy2 Promotion2BoApiCopyCoreWorkflowSteps managePromotionProductFilterCopy TPM_Promotion Filters out invalid products from the promotion product filter. It removes products that are no longer valid for the promotion timeframe. Filter Criteria's are not touched.
setPromotionDates(update)2 Promotion2BoApiCoreWorkflowSteps setPromotionDates Promotion Updates the promotion dates (Date From, Date Thru, Commit Date, Shipment Date From, Shipment Date Thru, Order Date From, Order Date Thru, In-Store Date From and In-Store Date Thru of a promotion).
loadPromotionDefaults(update)2 Promotion2BoApiCoreWorkflowSteps loadPromotionDefaults Promotion Load promotion values. Id or externalId of the promotion must be provided to load promotion record values. Step to be used by 'update' workflow.
loadTacticDefaults(update)2 Promotion2BoApiCoreWorkflowSteps loadTacticDefaults Tactic Load tactic values. TacticId or externalId must be provided to load tactic record values. Step to be used by 'update' workflow.
setPromotionAnchor(Update)2 Promotion2BoApiCoreWorkflowSteps setPromotionAnchor Promotion Sets the Promotion Anchor (Customer, Customer Set or null) depending on the anchor type of the template.
mapPromotionValues(Update)2 Promotion2BoApiCoreWorkflowSteps mapValues Promotion Maps promotion values to the output object. Each field is mapped into the Output Object field specified in the 'Maps To' attribute of the Input Structure.
loadPromotionBOForCopy2 Promotion2BoApiCopyCoreWorkflowSteps loadPromotionBOForCopy Promotion Loads promotion values for copy. The input Id parameter must reference a valid Promotion by SFDC Id or External Id. If the Promotion template is not Copyable, it will report an error.
loadTacticsLOForCopy2 Promotion2BoApiCopyCoreWorkflowSteps loadTacticsLOForCopy Promotion Loads Promotion Tactics.The input Id parameter must reference a valid Promotion by SFDC Id or External Id. If the Promotion Template does not have "Tactics" as the copied components, Promotion Tactics won't be loaded.
loadPromotionAttachmentsForCopy2 Promotion2BoApiCopyCoreWorkflowSteps loadPromotionAttachmentsForCopy Promotion Loads Promotion Attachments for the referenced Promotion. The input Id parameter must reference a valid Promotion by SFDC Id or External Id. If input "CopyAttachments" flag is set to false or not defined, attachments won't be loaded.
resetPromotion2 Promotion2BoApiCopyCoreWorkflowSteps resetPromotion TPM_Promotion Resets the Promotion values to their initial values in order for the promotion to be inserted again. Workflow fields are set to their initial values and the Promotions SFDC Id is reset in order to be able to be inserted again.
manageParticipatingCustomersCopy2 Promotion2BoApiCopyCoreWorkflowSteps manageParticipatingCustomersCopy TPM_Promotion Filters out invalid Participating Customers. If the promotion is pushable, it removes Participating Customers that are no longer valid for the current promotion timeframe.
resetTactic2 Promotion2BoApiCopyCoreWorkflowSteps resetTactic TPM_Promotion.Tactic Resets the Tactic values to their initial values in order for the tactic to be able to be inserted. Workflow fields are set to their initial values and the Tactic SFDC Id is reset in order to be able to be inserted again.
manageTacticProductFilterCopy2 Promotion2BoApiCopyCoreWorkflowSteps manageTacticProductFilterCopy TPM_Promotion.Tactic Filters out invalid products from the tactic product filter. It removes products that are no longer valid for the promotion timeframe. Filter Criteria's are not touched.
manageSubAccountsCopy2 Promotion2BoApiCopyCoreWorkflowSteps manageSubAccountsCopy TPM_Promotion Filters out invalid Sub Accounts. If the promotion has Sub Accounts Enabled, it removes Sub Accounts that are no longer valid for the current promotion timeframe.
manageManualInputCopy2 Promotion2BoApiCopyCoreWorkflowSteps manageManualInputCopy TPM_Promotion Handles the manual inputs copy. If the promotion template has "ManualInput" as part of the copied components, it adjusts the Promotion Manual Inputs for the new Promotion Timeframe. It also adjusts Tactic inputs to reference the correct new tactics.
movePromotionTimeframe2 Promotion2BoApiCopyCoreWorkflowSteps movePromotionTimeframe Promotion Moves the Promotion timeframe by the amount of specified years in the input "AddYears" property or the difference in days between the input "DateFrom" and Promotion current Date From. If the neither of the input properties is specified, a default value of 1 will be used for "AddYears". If both of them are provided, an error will be thrown. It also moves the tactic timeframes by the same offsets calculated for the parent promotion. It also checks the customer/customer set is still valid for the new Promotion Timeframe.
setTacticConditionCreationDefinitions(update) PromotionBoApiCoreWorkflowSteps setTacticConditionCreationDefinitions TacticConditionCreationDefinitions Input for updating Tactic Condition Creation Definitions.
setTacticConditionCreationDefinitions PromotionBoApiCoreWorkflowSteps setTacticConditionCreationDefinitions TacticConditionCreationDefinitions Input for creating Tactic Condition Creation Definitions.
setTacticConditionCreationDefinitions2 Promotion2BoApiCoreWorkflowSteps setTacticConditionCreationDefinitions TacticConditionCreationDefinitions Input for creating Tactic Condition Creation Definitions.
setTacticConditionCreationDefinitions(update)2 Promotion2BoApiCoreWorkflowSteps setTacticConditionCreationDefinitions TacticConditionCreationDefinitions Input for updating Tactic Condition Creation Definitions.
manageTCCDsLOForCopy PromotionBoApiCopyCoreWorkflowSteps manageTCCDsLOForCopy BOPromotion This method copies the TCCD records from the source promotion tactics to the target promotion tactics. It reads the tactics from current output JSON and fetches the related TCCD records and updates the output JSON. The field 'Create Default Conditions' checkbox is set to false so that only the source promotion’s TCCDs are copied and the default TCCDs are not created.
manageTCCDsLOForCopy2 Promotion2BoApiCopyCoreWorkflowSteps manageTCCDsLOForCopy TPM_Promotion This method copies the TCCD records from the source promotion tactics to the target promotion tactics. It reads the tactics from current output JSON and fetches the related TCCD records and updates the output JSON. The field 'Create Default Conditions' checkbox is set to false so that only the source promotion’s TCCDs are copied and the default TCCDs are not created.
loadPromotionForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps loadPromotion Promotion Loads promotion values for derive. The input Id parameter must reference a valid Promotion by SFDC Id or External Id. If the Promotion template for the promotion is not Derivable, it will report an error. Promotion Template parameter must reference a valid Promotion Template by Id or Name. This Promotion Template must be a child template from the promotion one where the Usage is set to derive.
handleAttachmentsForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps handleAttachments Promotion Handles Promotion Attachments for the context Promotion. If input "DeriveAttachments" flag is set to false or not defined, attachments won't be derived.
setPromotionTemplateForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps setPromotionTemplate Promotion Assigns the target derive Promotion Template to the Promotion as it's template.
setPromotionAnchorForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps setPromotionAnchor Promotion Assigns the target derive Anchor Account to the Promotion as it's anchor.
resetPromotionForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps resetPromotion TPM_Promotion Resets the Promotion values to their initial values in order for the promotion to be inserted again. Workflow fields are set to their initial values and the Promotions SFDC Id is reset in order to be able to be inserted again.
resetTacticForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps resetTactic TPM_Promotion.Tactic Resets the Tactic values to their initial values in order for the tactic to be able to be inserted. Workflow fields are set to their initial values and the Tactic SFDC Id is reset in order to be able to be inserted again.
managePromotionProductFilterForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps managePromotionProductFilter TPM_Promotion Filters out invalid products from the promotion product filter. It removes products that are no longer valid for the promotion timeframe. Filter Criteria's are not touched.
manageTacticProductFilterForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps manageTacticProductFilter TPM_Promotion.Tactic Filters out invalid products from the tactic product filter. It removes products that are no longer valid for the promotion timeframe. Filter Criteria's are not touched.
manageParticipatingCustomersForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps manageParticipatingCustomers TPM_Promotion Filters out invalid Participating Customers. If the promotion is pushable, it removes Participating Customers that are no longer valid for the current promotion timeframe.
manageSubAccountsForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps manageSubAccounts TPM_Promotion Filters out invalid Sub Accounts. If the promotion has Sub Accounts Enabled, it removes Sub Accounts that are no longer valid for the current promotion timeframe.
manageTCCDsForDerive2 Promotion2BoApiDeriveCoreWorkflowSteps manageTCCDs TPM_Promotion This method copies the TCCD records from the source promotion tactics to the target promotion tactics. It reads the tactics from current output JSON and fetches the related TCCD records and updates the output JSON. The field 'Create Default Conditions' checkbox is set to false so that only the source promotion’s TCCDs are copied and the default TCCDs are not created.
setPromotionAnchorForCopy2 Promotion2BoApiCopyCoreWorkflowSteps setPromotionAnchorForCopy Promotion Sets the Promotion Anchor (Customer, Customer Set or null) depending on the anchor type of the Promotion template. No value is set, no chages to the anchor are performed.
mapPromotionValuesForCopy2 Promotion2BoApiCoreWorkflowSteps mapValues Promotion Maps promotion values to the output object. Each field is mapped into the Output Object field specified in the 'Maps To' attribute of the Input Structure.
movePromotionTimeframeDerive2 Promotion2BoApiDeriveCoreWorkflowSteps movePromotionTimeframe Promotion Moves the Promotion timeframe by the difference in days between the input "DateFrom" and Promotion current Date From. If not provided, same dates as source promotion will be set. It also moves the tactic timeframes by the same offsets calculated for the parent promotion. It also checks the customer/customer set is still valid for the new Promotion Timeframe.