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.
RE_Order Class: This Apex class provides programmatic access to the retail order sObject, and its related sObjects.
RE_Order.DoWork Interface: The RE_Order.DoWork Apex interface provides the capability to perform additional work after an order and the related records are committed to the database.
RE_Order.Record Class: The RE_Order.Record Apex class provides a wrapper for the order sObject records.
RE_PromotionTransfer Class: The RE_PromotionTransfer Apex class provides programmatic access to the RE_PromotionTransfer sObject and its related sObjects.
RE_TacticTransfer Class: The RE_TacticTransfer Apex class provides programmatic access to the RE_TacticTransfer sObject and its related sObjects.
RTRReportResult: The RTRReportResult Apex class provides methods to access and process RTR reports.
RTR Report Classes: The RTR report-related APEX classes provide programmatic access to the TPM Real Time Reporting (RTR) report data.
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. Adds a new Manual Input entry to the instance.Returns the list of all Manual Inputs in the current instance.Removes the passed in manual input from the instance. If the manual input is not contained in the instance, nothing is removed.Serializes the manual inputs information to a generic Object instance. Useful for using the information in Remote calls.Serializes the manual inputs information for storage.Creates an empty structure with no manual inputs.Deserializes the received manual inputs from the input generic object. The current instance will be cleared and the manual inputs represented by the input will be loaded.Deserializes the received manual inputs from the input payload. The current instance will be cleared and the manual inputs represented by the payload will be loaded.Deletes all manual inputs from the instance. Similar state as creating a new instance.Returns a list of all manual inputs in the current instance.Adds a new manual input entry to the instance.
ParticipatingCustomers.ParticipatingCustomer Class: This APEX class provides programmatic access to a Participating Customer associated to an instance of TPM_ParticipatingCustomers.Returns true if the Participating customer is included, false otherwise.Sets the Participating customer as included or excluded.Sets the Participating Customer Account External Id valueReturns the Account External ID of the Participating Customer.
ParticipatingCustomers Class: This APEX class provides programmatic access to the TPM Promotion Participating Customers List used in the Promotion Push process.Serializes the information of the participating customers to a generic Object instance. Useful for using the information in Remote calls.Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded.Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded.Removes the passed in participating customer from the instance. If the participating customers is not contained in the instance, nothing is removed.Serializes the information of the participating customers information for storage.Creates an empty structure with no participating customers.Deserializes the information of the participating customers from the input generic object. The current instance will be cleared and the participating customers represented by the input will be loaded.Deserializes the information of the participating customers from the input payload. The current instance will be cleared and the participating customers represented by the payload will be loaded.Removes all information about all participating customers for the current instance.
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.Serializes the product filter information into a String used for storage.Returns a list of all the Manual Products included in the Product filter.Returns the selected criteria values for the given criteria field. The Criteria field must be a Product2 SObject field. If the criteria field is not part of the Product Filter Criteria, an empty array is returned.Adds a Manual Product to the Product Filter. The parameters are the product id to manually included and a flag to include or exclude it.Serializes the product filter information into a generic object. Useful for usage on remote calls.Returns all Product2 SObject fields used in the Product Filter criteria.Creates an empty product filter.Loads the Product Filter information from the parameter generic object. The current instance will be cleared and the product filter represented by the payload will be loaded.Loads the serialized Product Filter information into the current instance. The current instance will be cleared and the product filter represented by the payload will be loaded.Removes all information from the Product Filter and makes it empty.Removes all Criteria filters from the ProductFilter instance.Removes the Criteria filter for the given criteria field. The Criteria field must be a Product2 SObject field.Removes the manual product passed as a parameter. If the manual product is not part of the product filter manual products, the parameter will not be removed.Sets the values for the given criteria field. The Criteria field must be a Product2 SObject field.
Promotion Class: This APEX class provides programmatic access to the TPM Promotion SObject and it’s related SObjects.Returns the List<TPM_Promotion.Record> instances with the Promotion Attachment Links contents.This method creates an empty Promotion record.Returns the List<TPM_Promotion.Record> instances with the Promotion Attachments contents.Returns a filtered List<TPM_Promotion.Record> instances with the Promotion Product Share contents.Returns a filtered List<TPM_Promotion.Record> instances with the Promotion Attachments contents.Returns a filtered List<TPM_Promotion.Record> instances with the Promotion Attachment Links contents.Returns a filtered List<TPM_Promotion.Record> instances with the Tactic Fund contents.Returns the List<TPM_Promotion.Record> instances with the Tactic Fund contents.Returns the List<TPM_Promotion.Record> instances with the Tactic contents.Returns a filtered List<TPM_Promotion.Record> instances with the Tactic contents..Returns a filtered List<TPM_Promotion.Record> instances with the Tactic Condition Creation Definitions contents.Returns the List<TPM_Promotion.Record> instances with the Tactic Condition Creation Definitions contents.Returns the List<TPM_Promotion.Record> instances with the Promotion Product Share contents.Returns the read only list of effective categories of the promotion.Returns the read only list of effective brands of the promotion.Returns a TPM_ManualInputs instance with the Manual Inputs Information.Returns a TPM_ParticipatingCustomers instance with the Participating Customers information.Returns the TPM_ProductFilter instance with the Product Filter informationIf promotionId is null, throw an exception. This method loads the Promotion record referenced by the input Promotion Id along with its related SObjects. Appends a Custom SObject Record to the TPM_Promotion instance. This record will be inserted/updated/deleted (depending on the TPM_Promotion.Record instance state) during the same transaction the Promotion object is committed to the database.Adds a Tactic Condition Creation Definition Record to the promotion. The returned wrapper can be used for further operations.Adds a Promotion Attachment Record to the promotion. The returned wrapper can be used for further operations.Adds a Promotion Attachment Link Record to the promotion. The returned wrapper can be used for further operations.Adds a Promotion Product Share Record to the promotion. The returned wrapper can be used for further operations.Adds a Tactic Fund Record to the promotion. The returned wrapper can be used for further operations.Returns the wrapper object for the record identified by the parameter id. It will search among all the records associated to the promotion.Adds a Tactic Record to the promotion. The returned wrapper can be used for further operations.Returns a TPM_Scenarios instance with the Promotion Scenarios information.Returns a TPM_SubAccounts instance with the Sub Accounts information.Notifies the TPM_Promotion instance about a relationship between 2 records. Avoid using direct DML manipulations for Records that are part of the transactional state of a Promotion. During the Promotion Save process, the records provided by the TPM_Promotion instances use temporary Id’s for records that are not still in the database. Using the methods provided by TPM_Promotion object ensures all relationships and Id’s are properly resolved before committing. Adds work to be executed after the promotion is committed to the database. Use this method to perform additional operations after all the Promotion related records are correctly committed to the database. See TPM_Promotion.DoWork reference for details about the Interface methods. Removes all the current values and reloads all the promotion data from the Database. This operation is disabled in the TPM_Promotion instance during the Save Promotion Customization Hook. Saves the all the changes contained in promotion SObject record and it’s related SObject records. This operation is disabled in the TPM_Promotion instance during the Save Promotion Customization Hook, as this method will be automatically called when the Core business logic finish processing. The method will need to check the status of the TPM_Promotion.Record wrapper (isDeleted(), isNew()) to determine the DB operation to perform.
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.Returns the read only list of effective brands of the tactic.Returns the read only list of effective categories of the tactic.Returns the Product filter of the tactic.
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. Index must be an scenario index between 1 and 5 (included) Adds a parameter to the scenario parameters of the selected scenario. The required attributes are the scenario index, the KPI Name to set (must be a Scenario KPI defined on the Promotion Template), the numeric value of the KPI and if the parameter is already applied (If applied, UI will not re-apply the value when loading the scenario information. If not applied, when loading the scenario, UI will apply the value of the parameter to the total of the KPI) .Index must be an scenario index between 1 and 5 (included) Returns all the scenario parameters for the selected scenario. Serializes the scenarios information into a generic object. Useful for usage on remote calls.Index must be an scenario index between 1 and 5 (included) Serializes the parameters information for the selected scenario into a generic object. Useful for usage on remote calls. Index must be an scenario index between 1 and 5 (included) Serializes the manual inputs information for the selected scenario into a generic object. Useful for usage on remote calls. Loads the serialized scenarios information into the current instance. The current instance will be cleared and the scenarios represented by the payload will be loaded.Index must be an scenario index between 1 and 5 (included) Serializes the parameters information for the selected scenario into a String used for storage. Serializes the scenarios information into a Sstring used for storage.Index must be an scenario index between 1 and 5 (included) Serializes the manual inputs information for the selected scenario into a String used for storage. Creates an empty scenario sctructure.Loads the scenarios information from the parameter generic object. The current instance will be cleared and the scenarios represented by the payload will be loaded.Index must be an scenario index between 1 and 5 (included) Sets the parameter manual inputs as manual inputs for the selected scenario. Index must be an scenario index between 1 and 5 (included) Returns the manual inputs for the selected scenario.Removes all information for the five possible scenarios.Index must be an scenario index between 1 and 5 (included) Removes the passed in scenario parameter from the parameters of the selected scenario. If the ScenarioParameter is not part of the scenario, nothing is removed.
SubAccounts: Creates an empty sub accounts structure.Returns the list of all sub accounts in the sub accounts instance.Serializes the sub accounts information into a generic object. Useful for usage on remote calls.Serializes the sub accounts information into a String used for storage.Adds a sub account information to the current SubAccounts instance. The parameters are the Account External Id, a flag to determine if the sub account is included or excluded and it’s volume percentage (between 0 and 100).Creates an empty sub accounts structure.Loads the serialized sub accounts information into the current instance. The current instance will be cleared and the sub accounts represented by the payload will be loaded.Loads the sub accounts information from the parameter generic object. The current instance will be cleared and the sub accounts represented by the payload will be loaded.Removes all information from the current instance and leaves it empty. Same state as the constructor.Removes the parameter sub account from the instance. If the Sub Account is not part of the instance, nothing is removed.
SubAccounts.SubAccount: This APEX class provides programmatic access to a single Sub Account information contained in a TPM_SubAccounts instance.Gets the included/excluded status of the sub account.Get the volume percent of the sub account.Gets the sub account Account External ID.Sets the sub account account external ID.Sets the sub account as included or excluded.Sets the sub account volume percent (Decimal between 0 and 100)
RTRReportResult Class: Use this class to execute the Trade Promotion Management Real Time Reporting (RTR) report and access the report data.Execute a RTR Report and retrieve all the Report data.Retrieve an instance of the Reporting UI component.
FlatList Class: Represents a Real Time Reporting (RTR) report UI Flatlist component. This class extends the ReportComponent class. Returns an instance of a FlatlistRowIterable object with all the rows contained in the Flatlist. Returns an instance of a FlatlistRowIterable object with all the rows that match the specified row type filter. The available values for the row type filter can be extracted with the getRowTypes method. Returns a set that includes all the available column names in the Flatlist. Returns all the available row type filters present in the Flatlist. The row type filters can be used to filter the dataset.
FlatListRow Class: Represents a Real Time Reporting (RTR) report UI Flatlist component single rows. Extracts the column value specified for the column name Row type filters can be used to filter the dataset.
FlatListRowIterable Class: Represents a Real Time Reporting (RTR) report UI Flatlist component set of rows. This class implements the Iterable interface that allows it to be used in batch processes. Returns true if a record can be retrieved.Returns the next record in the dataset.
ReportComponent Class: Represents a Real Time Reporting (RTR) report UI component. This is an abstract class and can’t be instantiated.
ScoreCard Class: Represents a Real Time Reporting (RTR) report scorecard component. This class extends the ReportComponent class.Returns true if a record can be retrieved.
Apex Classes for Retail Order Customization: Use these Apex classes to access retail order records and to run additional work after an order and its related records are committed.
Metadata Wizard: The MetadataWizard is designed as a library that can be used to build simple wizard pages that are rendered to the user based on the defined wizard metadata. This document describes the NewPromotionWizardCallable APEX Class created for providing data for the New Promotion Metadata Driven wizard.
CGCloud Namespace: The CGCloud namespace provides classes that allow you to customise Real Time Reporting (RTR) data extraction from Apex.
Apex Save Process Customization: This section provides information on the different workflow process to customize the save process using APEX calls.
APEX Configuration: In order to customize the Promotion Save process in APEX layer, you must introduce a callable APEX class as a customization hook.
Abort Export Process: Sets the state of a CSV export process to Aborted. When a CSV export process is running for a longer duration than expected, it consumes resources and blocks the scheduling of new exports. The following Abort Export code snippet unblocks the scheduling by aborting the export process.
Get Measure Exports: Retrieves the list of the exports scheduled for a particular period. This list provides an overview of the scheduled exports and identifies the exports to be aborted.
Begin Promotion Import: This endpoint initializes a promotion import from an external system. You can group a set of promotions using the import ID, retrieved by thie end point. This endpoint announces that the import contains a specified number of promotions to be processed. The system can import the promotions, create, and update them, and trigger a promotion calculation for the given promotions. The status of the import can be monitored with the GET_PROMOTION_IMPORT_STATUS endpoint.
TPM_Promotion: These rules are linked to the TPM_Promotion and TPM_Promotion.Promotion output entities. The rules are executed based on the generated output of the previous rules.
Customize the TPM Calendar Launchpad: To customize the promotion hover content and buttons on the TPM calendar launchpad UI, create a callable Apex class as a customization hook.
Associated Objects for Retail Execution: This section provides a list of objects associated to Retail Execution standard objects with their standard fields.
Business Objects API: Business Object API is a feature designed to facilitate integrations of external systems and processes with TPM related SObjects.
Configuration Entities: Business Object API records contains Workflows and Output Entities.
Direct Store Delivery: Direct Store Delivery (DSD) is a supply chain model where a manufacturer sells goods directly to retailers. You can process orders, payments, deliveries, and returns by using DSD.
Retail Execution: With Retail Execution, a sales manager can plan store visits for field representatives and analyze the business’s health across stores.
Implementing Workflow Steps: Workflow Steps are implemented as APEX classes that are used in implementing the System.Callable interface.
Process Configuration Settings: When executing BO API process, the system reads the following configuration values from System Setting Custom setting in order to define it’s behavior.
Sync Management: Sync Management is part of Retail Execution and it ensures that the information available in web portal and mobile application is the same.
Derive and Copy Promotions with MetadataWizard and Business Object API: The Derive and Copy Promotion features use Metadata wizard and Business Object API. This allows complete customization of the UI Wizards, and the Derive and Copy Apex processes for promotions by leveraging MetadataWizard and Business Object API customization capabilities.
Promotion Business Object API: This section describes the base configuration provided for the Promotion Business Object.
Use Case: Add a New Workflow Step: In this use case, you will create a complete new workflow step that updates the Tactic Comment field with a new specified value that you will send as input.
Use Promotion Business Objects API: Promotion Business Object API can be accessed through REST API, Aura Components, and Lightning Web Component.
Trade Promotion Management: Trade Promotion Management (TPM) helps you oversee the promotions that you run for your retailers, from planning to completion, to ensure that each promotion achieves its objectives. Use TPM to streamline your team’s efforts, overcome the complexities of running several promotions concurrently, and unlock maximum results.
JobStatusNotificationService Class: Processes job status notifications from external batch processing systems for Trade Promotion Management operations.
Trade Promotion Management Service APIs: Trade Promotion Management (TPM) is the process of planning, budgeting, presenting, and running incentive programs between consumer goods manufacturers and retailers.
Abort a Job Chain: Stops the running job chain worker for a sales org.
Abort Behavior: Understand what an abort stops and what it leaves unchanged.
Begin Job Scheduling Transaction: Begin a scheduling transaction for a job in a job chain. The job either starts an open transaction (if the number of job items is not announced) that must be explicitly committed to, or communicates the expected number of job items to the off-platform system.
Get Global Account Product List: Retrieves the account products from the global account product list based on the volumes and measures for the customer for the account.
Get Products: Retrieve a list of products. The list is returned based on the Product Definition Level setting that you configured in the promotion template.
Get Report Data: Get runtime report data for display on the user-interface.
Schedule Account Plan Calculation: Schedule calculation for account plans for the given account plan IDs, category IDs, and time range for a given KPI collection.
Schedule Account Plan Calculation V2: Schedules the calculation of account plans. Batch chains support editable account plans. It can schedule up to 500 account plan IDs for calculation.
Schedule Account Plan Category Calculation: Schedules one or multiple account plan categories for batch calculation. It accepts up to 1000 account plan categories and schedules them for calculation.
Schedule Fund Calculation: Enqueues a given list of funds for batch calculation. The calculation result is transferred back to Salesforce via the KPI Upload once the calculation is finished.
Schedule Reorganization: Performs off-platform data cleanup and reorganization. Promotions in Salesforce that are deleted, inactive, or cancelled are removed from off-platform data. Additionally, softly deleted measure data is hard deleted.
Schedule SF Data Sync: Schedules a data sync from Salesforce to the off-platform database.
Scheduling Jobs: Most of the scheduling job endpoints use the Job Chain Process Flow.
Update Product Assortment: Receives a list of products within the time-dependent account product list and updates it.
Update Promotion: Updates the details of a given promotion in the promotion cache (without calculation).
Retail Execution Standard Metadata APIs: Metadata API enables you to access some entities and feature settings that you can customize in the user interface.
Recommendation Decision Input: Input representation of recommendations details for which recommendation decision is taken.
Abort Export Process: Uses the POST method to set the state of a CSV export process to Aborted.
Get Measure Exports: Uses the GET method to retrieve the list of the exports scheduled for a particular period.
Promotion Import Status: An import started with BEGIN_PROMOTION_IMPORT can be monitored with this endpoint. It takes the import ID and returns the status of the number of promotions. The import process will be complete, after all the promotions have been moved to either Calculated or Error status.
Ingest Promotions: This endpoint receives the promotions payload that must be processed. The system import promotions, creates and updates them, and triggers the promotion calculation. The status of the import can be monitored with the GET_PROMOTION_IMPORT_STATUS endpoint.
getAccounts: This method returns the list of accounts valid for the target promotion. Target promotion timeframe is calculated by the difference in days between the original promotion date and the new date.
getAccountSets: This method returns the list of account sets valid for the target promotion. Target promotion timeframe is calculated by the difference in days between the original promotion date and the new date.
getPromotion: This method returns the requested fields for the given promotion ID.
isPromotionAndUserSameSalesOrg: This method validates if the given promotion belongs to the same Salesorg where the user exists.
IsPromotionTemplateCopyable: This method validates the given promotion has a promotion template that can be copied.
getAccounts: This method returns the list of accounts valid for the target derived promotion.
getPromotionTemplates: This method returns the list of possible Promotion Templates for derive workflow.
Generic: This section provides information about the mapValues.
getAccountSets: This method returns the list of account sets valid for the period defined by the input date from and date through.
getAccounts: This method returns the list of accounts valid for the period defined by the input date from and the date through.
getProducts: This method returns the list of tactic templates related to the input promotion template.
getPromotionKPIs: This method returns the list of editable and editable calculated KPIs on promotion level for the input promotion template
getPromotionTemplates: This method returns the list of promotion templates along with additional information. The method will search for promotion templates where the "Display_In_MetadataWizard__c" field is set to true unless the "all" parameter is set to true.
getTacticCompensationModels: This method returns the list of valid compensation model values for a tactic template based on the tactic template defined tactic record type.
getTacticKPIs: This method returns the list of editable and editable calculated KPI's on tactic level for the input ppromotion template and tactic template. It returns all the possible KPI's that are part of the tactic template defined KPI subset in the order defined by the sort field.
getTacticTemplates: This method returns the list of tactic templates related to the input promotion template.
ScheduleTPMAccrualProcessChain Class: This Apex class initiates TPM Accrual Process orchestrator after ensuring the accrual export configuration is successfully updated.
AiVisitRecommendation: Represents the details of a visit recommendation. This object is available in API version 50.0 and later.
AiVisitRecommendRequest: Represents the details of a visit recommendation request. This object is available in API version 50.0 and later.
Einstein Visit Activity Recommendation Standard Objects: Einstein Visit Activity Recommendation data model provides you objects and fields to contain data about visit task recommendation requests and visit task recommendations. Einstein Visit Activity Recommendation supports sales managers and field reps in scheduling tasks and assessment indicators for visits.
Einstein Visit Recommendation Standard Objects: Einstein Visit Recommendation data model provides you objects and fields to contain data about visit recommendation requests and visit recommendations. Einstein Visit Recommendation supports sales managers and field reps in scheduling visits to the right stores, at the right time.
Exporting the KPIs from Hyperforce: This section provides information on how to export the KPIs from Hyperforce. You can create CSV export integration metadata configuration by adding new report configuration entry to RTR Report Configurations.
LWC Configuration: In order to access the TPM promotion data in LWC layer, the tpm-promotion service component is used. Use the tpm-promotion component to hook into the promotion state and be able to extract data from the promotion (through events) and push new data to the promotion (through methods).
Manual Inputs: This section provides information about manual inputs.
RetailExecutionSettings: Represents settings to manage your inventory, promotions, planograms, and in-store activities.
Metadata Components: This topic describes the list of available components that can be used on metadata-driven wizards.
Metadata Definition: This topic describes the metadata structure and the available wizard components that can be used to build wizards.
Metadata Wizard Expression: Expressions provide dynamic values to Wizard Components. Wizard Components accept expressions in some of their metadata properties. With expressions, you can also access instance values of other Wizard Components and dynamically set the metadata attributes, and create conditions. When a Wizard Component has an expression as a metadata attribute, the Wizard Component gets re-rendered every time the expression value changes.
Product Filter: This section provides information about Product Filter criteria.
Promotion: This section provides information about promotion..
PromotionHoverContent Class: The PromotionHoverContent Apex class provides programmatic access to the promotion hover content and the buttons on the trade calendar promotion launchpad UI.
Promotion Copy Workflow: This section describes the list of workflow step rules that must be provided from core.
Promotion Creation Workflow: This section describes the list of workflow step rules that must be provided from core.
Get Started with Consumer Goods Cloud: Streamline customer relationships, grow your business, and initiate intelligent sales with Salesforce Consumer Goods Cloud product. It allows you to collaborate with your customers and deliver on your brand promises.
Retail Order LWC: Access the RE order data in the LWC layer using the orderExtensionUtils service component.
Retail Order Customization: Customize the order proposal list and the order screens, such as Order Header, Order Details, Order Items, Add Items, and Free Items by creating an Apex customization hook.
Data Source: AccountMeasure: This example provides details on the integration metadata JSON with the data source. This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for AccountMeasure.
Data Source: AccountProductMeasure: This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for AccountProductMeasure.
Checking Job Status: Use the CSV Export Job Status API to get the status of the scheduled export. The API uses the csvGuid of the scheduled export as an input parameter.
Committing CSV Export: Use the Commit CSV Export API to commit a specific csvGuid and take the related CSV as a new baseline for future delta exports. This means after this commit, the next delta export contains only those records in the KPIs that have been either added, changed, or deleted from the previous committed state.
Data Source: DailyRealData/DailyIntData: This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for DailyRealData/dailyIntData.
Example: This example provides details on the integration metadata JSON with data source.
Example: This sample integration metadata configuration specifies product data at the product part level.
Example: This example provides details on the integration metadata JSON with data source.
Example: This sample integration metadata configuration specifies product data at the product part level, and defines the fields from the sObjects to be exported along with the KPIs.
Example: Spreading Time Label: This example provides details on the integration metadata JSON with datasource AccountAndPromotionMeasures (time label spreaded).
Examples: This section provides sample code snippets for different data sources.
Product Part Dimension: To extract data at the Bill of Materials (BOM) component or product part level, configure Product Part Dimension for each sales org on which CSV exports are executed.
Product Dimension: You must configure product dimension for integration export for each sales org on which CSV exports is executed.
Data Source: ProductMeasure: This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for ProductMeasure.
Data Source: Promotion and Tactic Measures with BOM Components: The PromotionAndTacticMeasuresWithBOMComponents data source allows export of information related to promotion and tactic measures at the Bill of Material (BOM) component or product part level in RTR.
Promotion Dimension: You must configure the promotion dimension for integration export for each sales org on which CSV exports is executed.
Data Source: Promotion Measures: An integration metadata report configuration using the data source PromotionMeasures requires dimensions.
Data Source: Promotion Measures with BOM Components: The PromotionMeasuresWithBOMComponents data source allows export of information related to promotion measures at the Bill of Material (BOM) component or product part level in RTR.
Data Source: PromotionTacticDailyMeasureReal: This example provides details on the integration metadata JSON with the data source. This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for PromotionTacticDailyMeasureReal.
Data Source: PromotionTacticWeeklyMeasureReal: This example provides details on the integration metadata JSON with the data source. This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for PromotionTacticWeeklyMeasureReal.
Tactic Dimension: You must configure the tactic dimension for integration exports for each sales org on which CSV exports is executed.
Triggering CSV Export: This Apex call expects the mandatory values of the business year, the actual name of the RTR report config record, and the sales org that must be exported.
Triggering the CSV Export Process: The CSV export for a configured integration metadata report is triggered with endpoints provided by the RTR gateway. When the CSV export process is finished, the CSV file can be downloaded through the integration API endpoints.
Triggering CSV Exports: Use the Triggering CSV Exports API to trigger CSV exports simultaneously. The CSV exports are generated asynchronously.
Data Source: WeeklyMeasureInt: This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for WeeklyMeasureInt.
Data Source: WeeklyMeasureReal: This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for WeeklyMeasureReal.
StandardObjectNameChangeEvent: A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.
StandardObjectNameFeed: StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.
StandardObjectNameFeed: StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.
StandardObjectNameFeed: StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.
StandardObjectNameHistory: StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.
StandardObjectNameHistory: StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.
StandardObjectNameHistory: StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.
StandardObjectNameOwnerSharingRule: StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.
StandardObjectNameOwnerSharingRule: StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.
StandardObjectNameOwnerSharingRule: StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.
StandardObjectNameShare: StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.
StandardObjectNameShare: StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.
StandardObjectNameShare: StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.
Account: Standard and custom fields extend the standard Account object for use in Consumer Goods Cloud to represent an individual account, which is an company or person involved with your business, such as customers, competitors, and partners. This object is available in API version 55.0 and later.
AiVisitTaskRcmd: Represents the visit task recommendations. These recommendations can be accepted or rejected by a sales manager. This object is available in API version 51.0 and later.
AiVisitTaskRcmdRequest: Represents the request parameters and responses of visit task recommendations. This object is available in API version 51.0 and later.
AssessmentIndDefinedValue: Stores the list of acceptable values which are defined as part of assessment indicator definition for a single and multi select question. This object is available in API version 49.0 and later.
AssessmentIndicatorDefinition: Define parameters that act as markers of compliance for retail tasks to compare target and actual values. This object is available in API version 47.0 and later.
AssessmentIndValue: Stores the list of target or captured values which are defined as part of assessment indicator definition for a single and multi select question. This object is available in API version 49.0 and later.
AssessmentTask: Perform activities such as planogram check, inventory check, promotion check, in-store survey, or custom task in stores to capture information. This object is available in API version 47.0 and later.
AssessmentTaskContentDocument: Associate content documents to visits, tasks, promotions, or planograms. This object is available in API version 47.0 and later.
AssessmentTaskDefinition: Associate an assessment task with an assessment indicator definition. This object is available in API version 48.0 and later.
AssessmentTaskIndDefinition: Associate an assessment indicator definition with an assessment task definition.This object is available in API version 48.0 and later.
AssessmentTaskOrder: Define an order activity that the sales rep can perform during a visit to the stores. This object is available in API version 47.0 and later.
Asset: Standard and custom fields extend the standard Asset object in Consumer Goods Cloud to represent an item of commercial value, such as a product sold by your company or a competitor, that a customer has purchased. This object is available in API version 55.0 and later.
Assortment: Represents a list of products that are eligible for sale in a store. This object is available in API version 47.0 and later.
AssortmentProduct: Associate products to an assortment. This object is available in API version 47.0 and later.
TimeSheet: Represents a schedule of an assignee's time in Consumer Goods Cloud. This object is available in API v65.0 and later. Time sheets are composed of time sheet entries, which typically track individual tasks.
TimeSheetEntry: Represents a span of time that an assignee spends on a task. This object is available in API version 65.0 and later. Time sheets are composed of time sheet entries. Time sheet entries typically track individual tasks.
cgc_sync__Sync_Client_Registration__c: Stores the details of the Consumer Goods Cloud offline mobile app device that a synchronization request to Salesforce is initiated from. This object is available in API version 61.0 and later.
cgc_sync__Sync_API_Log__c: Stores performance information that's executed on synchronization endpoints. This object is available in API version 53.0 and later.
cgc_sync__Sync_Config__c: Represents the settings for synchronization engine client and its backend. For example, background sync, sync on startup, and Apex endpoint thresholds. This object is available in API version 53.0 and later.
cgc_sync__Sync_History__c: Stores information about every sync that's performed on the mobile app along with its status information and associated Key Performance Indicators (KPIs). This object is available in API version 53.0 and later.
cgc_sync__Sync_History_Detail__c: Contains detailed information about all sync history records. This object is available in API version 53.0 and later.
cgc_sync__Sync_ID_Mapping__c: Contains information about the mappings of the local mobile application IDs to Salesforce IDs. This object is available in API version 53.0 and later.
cgc_sync__Sync_Message__c: Represents the messages that are exposed to a mobile app user during the sync process. This object is available in API version 53.0 and later.
cgc_sync__Sync_Metadata_Changes__c: Stores the timestamps for the changes that are made in the metadata. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_Component__c: Contains the settings for different customizable UI components in the theme. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_Depl_Pkg__c: Deployment packages that contain application runtime artifacts of the mobile app. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_Depl_Pkg_As__c: Contains information about the recipient of the deployment package. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_Depl_Pkg_Inst__c: Maintains a record of the installed deployment packages, their installation timestamps, and devices on which those packages are deployed. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_Domain__c: Stores information about domains that are available as dropdown boxes in the mobile app. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_Installation__c: Contains information about the user to whom the deployment package is to be distributed. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_Log__c: Stores the error messages and warnings that occurred in the mobile app. Such error messages and warnings are uploaded every time a user runs the upload to Salesforce action in the mobile app. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_Macro__c: Contains the color macros that are used for themes. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_PL_Config__c: Contains the mapping information of picklists for dropdown boxes in the mobile app. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_PL_Map__c: Contains the mapping information of picklists and dropdown boxes in the mobile application. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_PL_Map_Ext__c: Contains the mapping information of picklists and dropdown boxes in the mobile app. This object is available in API version 53.0 and later.
cgc_sync__Sync_Mobile_App_PL_Repo__c: Represents the repository of dropdown boxes in a mobile app. This object is available in API version 53.0 and later.
cgc_sync__Sync_Named_Fetch_Tree_Nodes__c: Contains information about the nodes that are used to construct the tree structure of sync objects. This object is available in API version 53.0 and later.
cgc_sync__Sync_Named_Query__c: Contains details and SOQL (Salesforce Object Query Language) statements for a named query. This object is available in API version 53.0 and later.
cgc_sync__Sync_Remote_Request__c: Stores requests to trigger technical activities on the mobile app. For example, data resupply and clean-up upload queue. This object is available in API version 53.0 and later.
cgc_sync__Sync_Report_Links__c: Contains information about the conjunction object for reports and related logs. This object is available in API version 53.0 and later.
cgc_sync__Sync_Tracked_Object_Config__c: Contains configurations for tracked objects including data distribution, sync settings, and client schema. This object is available in API version 53.0 and later.
cgcloud__Account_Condition__c: Contains the details of the relationship between customer and the customer conditions. This object is available in API version 54.0 and later.
cgcloud__Account_Extension__c: This object records account roles and further product-related attributes. This object is available in API version 54.0 and later.
cgcloud__Account_Manager__c: This object stores the details of users who manage specific accounts in a particular function (ManagementType). This object is available in API version 54.0 and later.
cgcloud__Account_Org_Unit__c: Contains the details of the relationship between customer and the org unit. This object is available in API version 54.0 and later.
cgcloud__Account_Plan__c: Contains the details of the account data for one planning account, one business year and one or multiple categories. This object is available in API version 54.0 and later.
cgcloud__Account_Plan_Category__c: Categories of the account plan including the manual inputs. Categories can be assigned to an account plan. A category can only be assigned to one account/business year combination. This object is available in API version 54.0 and later.
cgcloud__Account_Plan_User_Filter__c: Contains the filter selections of a user for a planning account. This object is available in API version 54.0 and later.
cgcloud__Account_Product_Profile__c: This object stores statistical profiles that indicate the distribution of weekly data between a customer and category. This object is available in API version 54.0 and later.
cgcloud__Account_Receivable__c: Holds the customer related information regarding invoices to be paid and debit and credit notes. This object is available in API version 55.0 and later.
cgcloud__Account_Relationship__c: This object represents the relationship between two customer accounts. This object is available in API version 54.0 and later.
cgcloud__Account_Sales_Data__c: Contains the information of the sales of a customer for two consecutive years. Access of the object provided to the System Admin. This object is available in API version 54.0 and later.
cgcloud__Account_Set__c: Represents the object for the creation of Customer Sets. This object is available in API version 54.0 and later.
cgcloud__Account_Set_Account__c: Junction object between Customer and Customer Set. This object is available in API version 54.0 and later.
cgcloud__Account_Set_Manager__c: Custom object to store the relation between Customer Set and User. This object is available in API version 54.0 and later.
cgcloud__Account_Sub_Account__c: Defines the account to sub-account relationship. This object is available in API version 54.0 and later.
cgcloud__Account_Task__c: This object represents the details of the customer task (customer issue). This object is available in API version 54.0 and later.
cgcloud__Account_Task_Template__c: Represents the details of the customer task template to be used for customer tasks. This object is available in API version 54.0 and later.
cgcloud__Account_Template__c: Stores the details of the account template object that's to be used for accounts. This object is available in API version 54.0 and later.
cgcloud__Account_Trade_Org_Hierarchy__c: This object represents the details of the account hierarchy. This object is available in API version 54.0 and later.
cgcloud__Account_Visit_Setting__c: This object stores the settings for the calls of a user based on a customer. This object is available in API version 54.0 and later.
cgcloud__Approval_Code__c: Represents the attributes for approval code of users. This object is available in API version 54.0 and later.
cgcloud__Asset_Audit__c: Represents the details of an asset survey. This object is available in API version 54.0 and later.
cgcloud__Asset_Template__c: An asset is a physical element that has a certain value which a manufacturer can place at a customer's location (retailer, bar, hotel, shop, and so on), and it can be associated to a POS (such as a shelf, cooler, fridge, and more). This object is available in API version 54.0 and later.
cgcloud__Auto_Number_Sequence__c: Stores information about the numbered index of the next transaction log record. This object is available in API version 54.0 and later.
cgcloud__Batch_Process_Configuration__c: Custom setting that captures the configuration of the batch process. This object is available in API version 54.0 and later.
cgcloud__Batch_Run_Status__c: Keeps track of batch processes. This object is available in API version 54.0 and later.
cgcloud__BO_API__c: This table stores the header record of Business Object APIs. This object is available in API version 54.0 and later.
cgcloud__BO_API_Entity__c: This table stores the entity definitions of Business Object APIs. This object is available in API version 54.0 and later.
cgcloud__BO_API_Output_Entity__c: This table stores the output entities of the Business Object API. This object is available in API version 54.0 and later.
cgcloud__BO_API_Step_Input_Structure__c: This table stores the input structure configuration that the business object API workflow step expects. This object is available in API version 54.0 and later.
cgcloud__BO_API_Transaction_Log__c: This object stores information about Business Object API Transaction Log, which is a collection of one or more promotions that should be created or updated under the same name via the Promotion BO Creation API. This object is available in API version 54.0 and later.
cgcloud__BO_API_Workflow__c: This table stores the workflows that are defined for the Business Object. This object is available in API version 54.0 and later.
cgcloud__BO_API_Workflow_Entity__c: This object stores the entities that Business Object API Workflows use. This object is available in API version 54.0 and later.
cgcloud__BO_API_Workflow_Step__c: This table stores the definitions of the workflow step. This object is available in API version 54.0 and later.
cgcloud__BO_API_Workflow_Workflow_Step__c: This table stores the junction object to identify the workflow steps that apply for each workflow. This object is available in API version 54.0 and later.
cgcloud__Business_Year__c: This object stores the attributes of the Business Year. This object is available in API version 54.0 and later.
cgcloud__CGCPS_Service_Settings__c: Use this custom setting to either enable or disable CGCPS service data mocking. With this setting, you can develop non-CGCPS service-enabled orgs. This object is available in API version 54.0 and later.
cgcloud__Color_Schema__c: Defines various Sales Organization-dependent property-based color schemes for the Trade Calendar. This object is available in API version 54.0 and later.
cgcloud__Condition_Search_Group__c: Holds the attributes of Condition Search Group. This object is available in API version 55.0 and later.
cgcloud__Condition_Search_Rule__c: Holds the attributes of Condition Search Rule. This object is available in API version 55.0 and later.
cgcloud__Condition_Template__c: Stores the details of the condition template object. This object is available in API version 54.0 and later.
cgcloud__Contract__c: Stores the details of the customer contract object, which is used to track various types of customer agreements. This object is available in API version 54.0 and later.
cgcloud__Contract_Payment__c: Stores the details of the contract payment object. With this object, you can track the types of customer payment requests that are agreed via a contract. This object is available in API version 54.0 and later.
cgcloud__Contract_Payment_Tactic__c: Stores the details of the relationship between a contract payment and contract tactics. By using this object, you can check the contract tactics for which the payment is applicable after the customer has fulfilled the agreement. This object is available in API version 54.0 and later.
cgcloud__Contract_Payment_Template__c: Stores the details of the contract payment template, which is used for contract payments. This object is available in API version 54.0 and later.
cgcloud__Contract_Product__c: Stores the details of the relationship between a customer contract and a product. With this object, you can capture product-specific agreements that are included in a customer contract. This object is available in API version 54.0 and later.
cgcloud__Contract_Tactic__c: Relation between a Contract and a Tactic template. This object is available in API version 54.0 and later.
cgcloud__Contract_Template__c: Contract and Tactic Templates object. This object is available in API version 54.0 and later.
cgcloud__CP_Calculation_Schema__c: The calculation schema object is used for complex pricing. This object is available in API version 54.0 and later.
cgcloud__CP_Calculation_Schema_Determination__c: The calculation schema determination object is used to determine the rule based on order template pricing type and customer pricing type. This object is available in API version 54.0 and later.
cgcloud__CP_Calculation_Schema_Step__c: This object stores the details of the relationship between calculation schema and pricing condition template that's used for the calculation steps that belong to a calculation schema. This object is available in API version 54.0 and later.
cgcloud__CP_Key_Attribute__c: The key attribute object is used to determine the complex pricing condition. This object is available in API version 54.0 and later.
cgcloud__CP_Key_Type__c: The key type object is used in the complex pricing search strategy. This object is available in API version 54.0 and later.
cgcloud__CP_Pricing_Condition__c: This object holds the details of the pricing condition object that the Penny Perfect Pricing functionality uses. This object is available in API version 54.0 and later.
cgcloud__CP_Pricing_Condition_Template__c: The pricing condition template object is used to define what is to be calculated in a step of a calculation schema. This object is available in API version 54.0 and later.
cgcloud__CP_Search_Strategy__c: The search strategy object is used to search for complex pricing conditions. This object is available in API version 54.0 and later.
cgcloud__CP_Search_Strategy_Step__c: This object stores the details of the relationship between search strategy and key type, which is used to search for complex pricing strategy steps. This object is available in API version 54.0 and later.
cgcloud__Custom_Calendar__c: This object stores the attributes of the custom calendar. This object is available in API version 54.0 and later.
cgcloud__Custom_Period__c: This object stores the attributes of the custom period. This object is available in API version 54.0 and later.
cgcloud__Data_Type__c: Stores the flexible data type. This object is available in API version 54.0 and later.
cgcloud__Data_Type_Option__c: Stores the item (picklist item) of a flexible data type. This object is available in API version 54.0 and later.
cgcloud__Field_Sales_Activity__c: Stores the details of the field sales activity object. Field Sales Activity (FSA) covers a set of job definition lists. This object is available in API version 54.0 and later.
cgcloud__Flatten_Account_Hierarchy__c: This object stores node hierarchy information for the Customer Segmentation functionality. This object is available in API version 54.0 and later.
cgcloud__Flatten_Org_Unit_Hierarchy__c: This object stores node org unit hierarchy information for the Customer Segmentation functionality. This object is available in API version 54.0 and later.
cgcloud__Fund__c: A fund is the amount of money that's given to an employee for a special reason during a specific business period. This money is used to pay special activities such as promotion campaigns. This object is available in API version 54.0 and later.
cgcloud__Fund_Product__c: A Fund object can be linked to multiple brands or categories based on the fund template settings. This object is available in API version 54.0 and later.
cgcloud__Fund_Template__c: Template for the creation of a Fund. This object is available in API version 54.0 and later.
cgcloud__Fund_Transaction__c: Holds the fund transaction details. This object is available in API version 54.0 and later.
cgcloud__Fund_Transaction_Header__c: Fund Transaction Header object facilitates the creation of multiple fund transactions in either a multiple source or target fund business scenario. This object dictates key fields such as the fund transaction template. The source or target funds for the fund transaction records to be created are based on transaction types such as Transfer, drawback, and more. This object is available in API version 54.0 and later.
cgcloud__Fund_Transaction_Template__c: Template for the creation of a transaction for the Fund. This object is available in API version 54.0 and later.
cgcloud__Historic_Product__c: Junction object between the Customer (Account) and Product (Product__c) objects. This object is available in API version 54.0 and later.
cgcloud__Inventory__c: Stores the details of the inventory object. This object is available in API version 54.0 and later.
cgcloud__Inventory_Control_Template__c: Stores the details of the inventory control template that's to be used for inventories. This object is available in API version 54.0 and later.
cgcloud__Inventory_Transaction_Template__c: Stores the details of the inventory control template that's to be used for inventory control transactions. This object is available in API version 54.0 and later.
cgcloud__Job_Definition_List__c: Stores the set of questions or surveys that are to be carried out in the respective call and contains further relevant configurations. This object is available in API version 54.0 and later.
cgcloud__Job_Definition_List_Account__c: Stores the details of the relationship between job definition list and customer. This object is available in API version 54.0 and later.
cgcloud__Job_Definition_List_Product__c: Stores the details of the relationship between the Job Definition List and Product related lists. This object is available in API version 54.0 and later.
cgcloud__Job_Definition_Template__c: Stores the definition of the questions or product surveys that are available in the system. This object is available in API version 54.0 and later.
cgcloud__Job_DL_Job_Definition_Template__c: This object stores the questions or surveys that are used in the job definition list. This object is available in API version 54.0 and later.
cgcloud__Job_DL_Template_Def_Template__c: Stores the list of job definition templates in the Job definition list template. When creating a job definition list based on this template, the assigned job definition templates are used to preset job definitions. This object is available in API version 54.0 and later.
cgcloud__Job_List__c: Stores the job lists that are generated from non-standard job definition lists. This object is available in API version 54.0 and later.
cgcloud__Job_Template__c: Stores whether a job is to be considered as either a task, a question, a product related question (survey), or any other object related job like capturing orders. This object is available in API version 54.0 and later.
cgcloud__KPI_Definition__c: Contains the description of a single measure. The fields of the table can be derived from the current KPI_Set .json file. This object is available in API version 54.0 and later.
cgcloud__KPI_Map__c: Holds the information about the KPI Map configuration. This object is available in API version 54.0 and later.
cgcloud__KPI_Set__c: This table contains information about KPI Set Configuration. This object is available in API version 54.0 and later.
cgcloud__KPI_Set_KPI_Definition__c: Junction object between KPI Definition and KPI Definition Set. This object is available in API version 54.0 and later.
cgcloud__Listing_Classification__c: Holds the information about the listing modules and the product category for a customer. This object is available in API version 54.0 and later.
cgcloud__Listing_Module__c: This object stores information about listing modules for a product assortment. This object is available in API version 54.0 and later.
cgcloud__Mobile_Link__c: Deep Link Object. This object is available in API version 54.0 and later.
cgcloud__Order__c: Stores the header details of the order entry. This object is available in API version 54.0 and later.
cgcloud__Order_Item__c: Stores the details of the order item object. This object is available in API version 54.0 and later.
cgcloud__Order_Item_Inventory_Transaction__c: Holds the association details for the order item template, the inventory control template, and the inventory transaction template. This object is available in API version 54.0 and later.
cgcloud__Order_Item_Rule__c: Defines the rules handled by the pricing engine during the complex pricing calculation. This object is available in API version 54.0 and later.
cgcloud__Order_Item_Template__c: This template controls the behavior of an Order Item Template. For example, OrderEntry is an important template, which allows a sales document to behave like an order entry. This object is available in API version 54.0 and later.
cgcloud__Order_Payment__c: Holds the attributes of the Order Payment object. This object is available in API version 54.0 and later.
cgcloud__Order_Payment_Inventory_Transaction__c: Holds the association details for the order payment template, the inventory template, and the inventory transaction template. This object is available in API version 54.0 and later.
cgcloud__Order_Payment_Template__c: Holds the attributes of the order payment template. This object is available in API version 54.0 and later.
cgcloud__Order_Template__c: Template that controls the behavior of a sales document. This object is available in API version 54.0 and later.
cgcloud__Org_Unit__c: Stores the details of the Organization unit object that defines a manufacturer's organizational structure. This object is available in API version 54.0 and later.
cgcloud__Org_Unit_Hierarchy__c: Stores the details of the relationship between two org units. It's typically used for the sales org unit hierarchy. This object is available in API version 54.0 and later.
cgcloud__Org_Unit_User__c: Stores the details of the relationship between the organization unit and the user. This object is available in API version 54.0 and later.
cgcloud__Organization_Setting__c: This object enables or disables the role hierarchy in a call module. This object is available in API version 54.0 and later.
cgcloud__Package_Setting__c: This is a custom setting that helps you manage dynamic namespaces. This object is available in API version 54.0 and later.
cgcloud__Payment__c: This object stores the value that retailers expect as compensation for running promotions, which are executed by using tactics. This object is available in API version 54.0 and later.
cgcloud__Payment_External_Reference__c: This object contains the hyperlinks that are related to a payment record. This object is available in API version 54.0 and later.
cgcloud__Payment_Tactic__c: This object represents the relationship between Fund and Payment Tactic junction objects. This object is available in API version 54.0 and later.
cgcloud__Payment_Tactic_Fund__c: This object stores the relationship between the Fund and Payment Tactic junction objects. This object is available in API version 54.0 and later.
cgcloud__Payment_Tactic_Product__c: This object contains payment tactic products and assigned values at the LDP level or at the level that the project defines as payment product level. This object is available in API version 54.0 and later.
cgcloud__Payment_Template__c: Stores the details of the payment template that's to be used for payments. This object is available in API version 54.0 and later.
cgcloud__Picklist_Toggle_Addon__c: This is a non-data object. It's purely used to define different picklists, which are retail mobile only or that don't have any real corresponding field in the RCG back end. These picklists are then mapped with the Picklist-Toggle-Mapping concepts in Sync Package. This object is available in API version 54.0 and later.
cgcloud__POS__c: Stores the details of the POS object. A Point of Sale (POS) stores the information about a place in the customer's premises at which goods are sold to consumers. This object is available in API version 54.0 and later.
cgcloud__POS_Template__c: Stores the details of the POS template object that's to be used for POS (Point of Sale). This object is available in API version 54.0 and later.
cgcloud__Product_Assortment_Order_Template__c: Stores the details of the relationship between product assortment and order template. This object is available in API version 54.0 and later.
cgcloud__Product_Assortment_Product_Share__c: This object stores the details of categories that are assigned to a Product assortment. This object is available in API version 54.0 and later.
cgcloud__Product_Assortment_Store__c: The object holds the customers (stores) for which the Product assortment (authorization list) is valid. The store assignment is taken from the trade org hierarchy by the batch process that represents the listing finding. This object is available in API version 54.0 and later.
cgcloud__Product_Assortment_Template__c: Template for product assortments. Controls the behavior of the instances of this template. For example, if a business partner is to be specified (AccountMultiplicity). This table is dependent on the sales organization. This object is available in API version 54.0 and later.
cgcloud__Product_Category_Share__c: This business class contains the product categories or brands that a user manages. This object is available in API version 54.0 and later.
cgcloud__Product_Condition__c: This object uses product-specific conditions. For example, specifying product prices that are relevant for simple order value calculation. This object is available in API version 54.0 and later.
cgcloud__Product_Hierarchy__c: Relation from a product (Child_Product) to its parent. This relation is time-framed. This object is available in API version 54.0 and later.
cgcloud__Product_Listing_Module__c: Add products to Product Assortment with listing modules. This object is available in API version 54.0 and later.
cgcloud__Product_Part__c: Stores the details of the relationship between two products. Describes which and how many products (ChildPKey) are assembled into a parent product (ParentPKey). In comparison to a product assortment, the result is a real product. This relation is only used as information; it can't be used to define a set of products to be used in other applications. This object is available in API version 54.0 and later.
cgcloud__Product_Template__c: Stores the details of the product template object that's used for products. This object is available in API version 54.0 and later.
cgcloud__Promotion__c: Promotion is an activity of a user that includes the definition of prices for a time segment. This object is available in API version 54.0 and later.
cgcloud__Promotion_Attachment__c: You can add pictures as attachments to a promotion. This object is available in API version 54.0 and later.
cgcloud__Promotion_Attachment_Link__c: Relationship between promotion and promotion attachment. This object is available in API version 54.0 and later.
cgcloud__Promotion_Calculation_Server_Offset__c: Stores the time range during which the server (Offplatform) calculates a Promotion. This object is available in API version 54.0 and later.
cgcloud__Promotion_Hurdle__c: This object stores the restriction that must be satisfied to apply the rewards. This object is available in API version 54.0 and later.
cgcloud__Promotion_Hurdle_Expression__c: New object that stores the information about an expression. This object is available in API version 54.0 and later.
cgcloud__Promotion_Product_Share__c: This object holds the details of categories that are assigned to a promotion. This object is available in API version 54.0 and later.
cgcloud__Promotion_Push_Status__c: Contains for each push process an entry that contains the status and statistics for the push. This object is available in API version 54.0 and later.
cgcloud__Promotion_Reward__c: This object stores the details of rewards that are assigned to a reward group. This object is available in API version 54.0 and later.
cgcloud__Promotion_Reward_Group__c: This object holds the details of the reward group that's assigned to a promotion. This object is available in API version 54.0 and later.
cgcloud__Promotion_Reward_Product__c: This object stores the details of the product that's assigned to a promotion reward. This object is available in API version 54.0 and later.
cgcloud__Promotion_Sales_Folder__c: Junction object between Promotion and Sales folder. This object is available in API version 54.0 and later.
cgcloud__Promotion_Store__c: This object holds the relation for the customer promotion hierarchy. This object is available in API version 54.0 and later.
cgcloud__Rate_Based_Funding__c: This object stores general information along with metadata that's associated with the RBF Template from which it was created. This object is available in API version 54.0 and later.
cgcloud__RBF_Category__c: Junction object between Rate Based Funding and Product for driving RBF and Product association. This object is available in API version 54.0 and later.
cgcloud__RBF_Product_Manual_Input__c: This object represents the junction between Rate-based Funding and Product. This object is available in API version 54.0 and later.
cgcloud__RBF_Template__c: Creation template for Rate-based Funding (RBF) records. This object is available in API version 54.0 and later.
cgcloud__Route__c: Stores the details of the route object. This object is available in API version 54.0 and later.
cgcloud__Route_Account__c: Stores the details of the relationship between routes and customers. This object is available in API version 54.0 and later.
cgcloud__Route_Template__c: Stores the details of the route template object that's to be used for routes. This object is available in API version 54.0 and later.
cgcloud__RTR_Report_Configuration__c: This object contains Real Time Report (RTR) Configurations. One record defines the data that's to be loaded for a report and what or how it gets shown in a declarative manner. This object is available in API version 54.0 and later.
cgcloud__Sales_Folder__c: This object contains the attributes that are associated with the Sales Folder. This object is available in API version 54.0 and later.
cgcloud__Sales_Folder_Sell_Sheet__c: This object stores the details of the relationship between the sales folder and sell sheet. This object is available in API version 54.0 and later.
cgcloud__Sales_Folder_Template__c: This object contains the attributes that are associated with the Sales Folder Template. This object is available in API version 54.0 and later.
cgcloud__Sales_Organization__c: This object stores the details of the Sales Organization. This object is available in API version 54.0 and later.
cgcloud__Sales_Organization_User__c: This object stores the details of the relationship between a sales organization and a user. This object is available in API version 54.0 and later.
cgcloud__Segmentation_Rule__c: This object stores the details of the segmentation rule. This object is available in API version 54.0 and later.
cgcloud__Segmentation_Rule_Def__c: Contains the available queries and its attributes to create segmentation rules. This object is available in API version 54.0 and later.
cgcloud__Segmentation_Rule_Def_Column__c: This object defines the query attributes of the Segmentation Rule Definition. This object is available in API version 54.0 and later.
cgcloud__Segmentation_Rule_Template__c: This object contains information that configures the behavior for the associated segmentation rules. This object is available in API version 54.0 and later.
cgcloud__Sell_Sheet__c: This object contains the attributes that are associated with the sell sheet to be used on the Sales folder. This object is available in API version 54.0 and later.
cgcloud__Signature__c: This object stores the attributes for signatures. This object is available in API version 54.0 and later.
cgcloud__Signature_Attribute__c: Entity that stores the attributes and values for signatures. This object is available in API version 54.0 and later.
cgcloud__Signature_Flow_Step__c: This object stores the details of the signature flow steps that are used in a signature template. This object is available in API version 54.0 and later.
cgcloud__Signature_Template__c: Stores the details of the signature template object that's used for signature flow steps. This object is available in API version 54.0 and later.
cgcloud__Substitution__c: The use case stores the details of the substitute object that specifies the basis of a substitution depending on a substitution period and user. This object is available in API version 54.0 and later.
cgcloud__System_Number__c: This object specifies the number definition that's used for number generation on CAS OnPremise Mobility. This object is available in API version 54.0 and later.
cgcloud__System_Number_Last__c: Last used number of a specific number type and device. This object is available in API version 54.0 and later.
cgcloud__System_Setting__c: Custom setting that stores all system setting attributes as a key-value pair. This object is available in API version 54.0 and later.
cgcloud__Tactic__c: Configures the relation between a Promotion and a Tactic. This object is available in API version 54.0 and later.
cgcloud__Tactic_Fund__c: This object stores the relationship between the Fund and Payment Tactic junction objects. This object is available in API version 54.0 and later.
cgcloud__Tactic_Product__c: Junction object between Tactic and Product. This object is available in API version 54.0 and later.
cgcloud__Tactic_Product_Condition__c: Use this object to store the internal conditions that are generated out of promotions. This object is available in API version 54.0 and later.
cgcloud__Tactic_Template__c: Template that controls the behavior of a tactic. This object is available in API version 54.0 and later.
cgcloud__Tactic_Template_Cond_Creation_Def__c: Contains the configuration of condition creation definitions that will be generated for the related tactic. This object is available in API version 55.0 and later.
cgcloud__Tactic_Template_Fund_Template__c: Junction object between tactic template and fund template. This object defines the valid fund types for the given tactic template. This object is available in API version 54.0 and later.
cgcloud__Tour__c: Stores the details of the tour object. This object is available in API version 54.0 and later.
cgcloud__Tour_Check__c: Stores the details of the tour check object that's used as part of tour execution for tour checking. This object is available in API version 54.0 and later.
cgcloud__Tour_Object_Reference__c: Stores the details of the object references of a tour. This object is available in API version 54.0 and later.
cgcloud__Tour_Template__c: Stores the details of the tour template object that's to be used for tours. This object is available in API version 54.0 and later.
cgcloud__Tour_Template_Tour_Check__c: Stores the details of the relationship between tour template and tour check, which is used to define the relevant tour checks on a tour. This object is available in API version 54.0 and later.
cgcloud__Tour_Tour_Check__c: Stores the details of the relationship between tour and tour check. This object is available in API version 54.0 and later.
cgcloud__Transaction_Log__c: This object contains all transaction log messages that are related to CG. This object is available in API version 54.0 and later.
cgcloud__Trigger_Setting__c: Custom Setting, helper object that enables clients to disable certain triggers that are part of the managed package. This object is available in API version 54.0 and later.
cgcloud__Trip_List__c: Use Trip List to plan visits based on a predefined sequence of customers. This object is available in API version 54.0 and later.
cgcloud__Trip_List_Account__c: The object stores the association between a trip list and a customer. This object is available in API version 54.0 and later.
cgcloud__UI_Contract__c: This object contains the contract information for templates that are used in the smart UI. This object is available in API version 54.0 and later.
cgcloud__Unit_of_Measure__c: Stores the details of the units of measure (logistic unit) of a product. This object is available in API version 54.0 and later.
cgcloud__Update_Activation__c: This custom setting defines the sales org-specific update activation record to make sure that maintenance is only possible by using the Update Activation page. This object is available in API version 54.0 and later.
cgcloud__User_Accountable__c: Represents a Sales Rep or Supervisor or other Retail Execution user who is accountable for a Retail Execution business process. This object is available in API version 55.0 and later.
cgcloud__User_Document__c: Stores the details of the daily report object. This object is available in API version 54.0 and later.
cgcloud__User_Document_Activity__c: Stores the details of the relationship between the daily report and user activity. This object is available in API version 54.0 and later.
cgcloud__User_Document_Template__c: Stores the details of the daily report template, which is to be used for daily reports. This object is available in API version 54.0 and later.
cgcloud__User_Document_Template_Activity__c: Stores the details of the relationship between the daily report template and user activity. This object is available in API version 54.0 and later.
cgcloud__User_Setting__c: Object that's created to store user settings. This object is available in API version 54.0 and later.
cgcloud__User_View__c: This object is a User and View relation junction object. This object is available in API version 54.0 and later.
cgcloud__Validation_Rules_Setting__c: Custom setting that manages various validation rules, such as granting bypass access. This object is available in API version 54.0 and later.
cgcloud__Vehicle__c: Stores the details of the vehicle object. This object is available in API version 54.0 and later.
cgcloud__Vehicle_Warehouse__c: This object stores the relationship between a vehicle and a warehouse. This object is available in API version 54.0 and later.
cgcloud__View__c: This object stores the filter criteria for the trade calendar. This object is available in API version 54.0 and later.
cgcloud__Visit_Job__c: This object contains answered questions and product surveys (jobs). This object is available in API version 54.0 and later.
cgcloud__Visit_Template__c: Template that describes the basic call behavior. This object is available in API version 54.0 and later.
cgcloud__Warehouse__c: Stores the details of the warehouse object. An organizational segmentation for the purpose of maintaining materials that are stored in different places. This object is available in API version 54.0 and later.
cgcloud__Warehouse_Product__c: Stores the relationship between a warehouse and a product. This object is available in API version 54.0 and later.
cgcloud__Warehouse_User__c: Stores the details of the relationship between a warehouse and a user. This object is available in API version 54.0 and later.
cgcloud__Week_Day_Share_Profile__c: Contains statistical profiles of the distribution of weekly data among different days of a week. This object is available in API version 54.0 and later.
cgcloud__Workflow__c: Stores the attributes of the workflow. This object is available in API version 54.0 and later.
DeliveryTask: Represents information about shipments and orders to be delivered to a store in a visit. This object is available in API version 50.0 and later.
InStoreLocation: Create locations within a retail store’s layout such as aisles, shelves, or backrooms. This object is available in API version 47.0 and later.
Operatinghours: Standard and custom fields extend the standard Operating hours object in Consumer Goods Cloud to represent the hours in which a service territory, service resource, or account is available for work. This object is available in API version 55.0 and later.
OtherComponentTask: Represents the details of a component task performed in a visit. A component task allows customers to launch components from the task framework. This object is available in API version 50.0 and later.
Product2: Represents a product that your company sells. Custom fields extend the standard Product object for use in Consumer Goods Cloud. This object is available in API version 55.0 and later.
PromotionChannel: Associate a promotion with a store, store group, or an account. This object is available in API version 47.0 and later.
PromotionProduct: Associate a promotion with a product. This object is available in API version 47.0 and later.
PromotionProductCategory: Associate a promotional activity with a product category. This object is available in API version 47.0 and later.
Promotion: Create promotional activities that are either part of a campaign or isolated targeted promotions to run at retail stores. This object is available in API version 47.0 and later.
VisitedParty: Represents the contact person at the account that’s being visited. This object is available in API version 49.0 and later.
Visitor: Represents the sales reps performing visits. This object is available in API version 49.0 and later.
RetailLocationGroup: Group retail stores based on shared features, such as size, location, part of a retail chain. This object is available in API version 47.0 and later.
RetailStore: Create records for physical retail stores associated to business accounts. This object is available in API version 47.0 and later.
RetailStoreGroupAssignment: Represents a junction between a retail store and a retail store group. This object is available in API version 52.0 and later.
RetailStoreKpi: Map store groups to assessment indicator definition, products, and in-store location categories and define targets. Targets are the expected compliance values for each assessment indicator definition, which is a parameter based on which markers of compliance are decided for a task. This object is available in API version 47.0 and later.
RetailVisitKpi: Capture the actual information during a visit against the defined assessment indicator definition and target values. This object is available in API version 47.0 and later.
Shift: Represents a shift for a user. Available in API versions 65.0 and later.
ShiftTemplate: Represents a template for creating shifts. This object is available in API version 65.0 and later.
SignatureTask: Represents the signature-related information that a visitor captures as part of a visit. This object is available in API version 50.0 and later.
SignatureTaskLineItem: Represents a junction between a signature task and a digital signature captured in a visit. This object is available in API version 50.0 and later.
StoreAssortment: Associate an assortment to either a store, a store group, or an account. This object is available in API version 47.0 and later.
StoreActionPlanTemplate: Associate an action plan template with a store. This object is available in API version 48.0 and later.
StoreProduct: Associate a product to a retail store or to a specific in-store location. This object is available in API version 47.0 and later.
Task: Standard and custom fields extend the standard Task object in Consumer Goods Cloud to represent business activities, which are Task and Event records, such as making a phone call. The object is available in API version 55.0 and later.
User: Standard and custom fields extend the standard User object for use in Consumer Goods Cloud to represent a user in your company. This object is available in API version 55.0 and later.
VehicleUserAssignment: Represents the assignment of a vehicle to a driver. Vehicle is a moving location. This object is available in API version 51.0 and later.
Visit: Track information related to a field rep’s visit to a retail store where they perform retail activities. This object is available in API version 47.0 and later.
Promotion: This document describes the list of Workflow Step Rules that must be provided from the core. This section provides information about the mapValues.
Tactic: This section provides information about tactic.
Customize the Tactic Transfer Process: To modify the tactic details related to the promotion being transferred, create a callable Apex class as a customization hook.
tpmGenericUtils Module: The tpmGenericUtils module provides replacements for accessing the @salesforce modules on components that have the cgcloud runtime namespace.
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.This method returns a promise resolving to the values of the KPIs for the selected KPI subsets or names, levels, and period types.Imperatively retrieve the account plan state properties.This method returns a promise resolving to the list of levels that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error.This method returns a promise resolving to the list of KPI subsets that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error.This method returns a promise resolving to the list of KPIs that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error.This method returns a promise resolving to the list of periods that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error.This method returns a promise resolving to the list of period types that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error.This method sets an array of manual inputs in the account plan service component.
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.
EARightsAccess Class: Use the EARightsAccess class to access EARights the application uses.
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.Here are all the tpm-promotion methods.This method returns a promise resolving to the values of the KPIs for the selected KPI subsets or names, levels, and period types.The method returns a promise resolving to a JavaScript object with all the tactic attributes preset.This method generates a Tactic record using the tacticTemplateId as a base. The method returns a promise resolving to a Javascript object with all the tactic attributes preset. After generating the tactic, it can be added to the promotion data by calling setTacticField for all the fields. Imperatively retrieve promotion state properties.This method returns a promise resolving to the list of levels that are currently loaded in the Calculation Engine. If the calculation status isn’t valid, the method returns an error.This method returns a promise resolving to the list of KPI Subsets that are currently loaded in the Calculation Engine. If the calculation status isn’t valid, the method returns an error.This method returns a promise resolving to the list of KPIs that are currently loaded in the Calculation Engine. If the calculation status isn’t valid, the method returns an error.This method returns a promise resolving to the list of Periods that are currently loaded in the Calculation Engine. If the calculation status isn’t valid, the method returns an error.This method returns a promise resolving to the list of Period Types that are currently loaded in the Calculation Engine. If the calculation status isn’t valid, the method returns an error.This method returns true if an EARight element is flagged as editable for the passed record ID.This method returns true if an EARight element is flagged as visible for the passed record ID.Moves the page focus to the passed in target. The target object requires an area attribute and an optional section attribute:Begins the promotion push process. Saves the current state of the promotion SObject and all of its related SObjects. Reloads the promotion SObject and all the related records.Remove already setup callback functions that will be called as part of method flows. Begins the promotion save process. Saves the current state of the promotion SObject and all of its related SObjects. I’ll also save the custom state. During the save process, the component will emit events to notify custom components about different events that might happen during the process. This process initiates the close promotion process. It sets the promotion phase to ToBeFinanciallyClosed and initiates the save process. This triggers the financial closure workflow in Processing Services, which handles the promotion's accruals and final calculations. The method also saves the related SObjects and custom state.Sets the internally selected tactic to the passed in tactic ID.Setup callback functions that will be called as part of method flows.This object will be sent along with the promotion information during save to SFDC in order to be processed and committed. Using the custom state, customers can set up additional data to send along the promotion data to be saved in the same transaction as the promotion. This custom state will be forwarded to the customized APEX class handling promotion save customizations..Sets the promotion into edit mode or exits edit mode.This method sets the editability value of an EARight element for the given promotion or tactic record ID.This method sets the visibility value of an EARight element for the given promotion, or tactic record ID. Lists the objects with the participating customers format.Displays or hides the P&L filter section on the promotion P&L view.Sets the related promotion attachment links to the promotion.Sets the related promotion attachments to the promotion. Promotion attachments cannot be created or deleted from the tpm-promotion component API. Promotion attachment records need to be previously created before linking them to a promotion with a promotion attachment link record. Sets the list of categories of the promotion. TPM Application will only detect category changes after a reload. Sets a promotion SObject field.This method sets an array of manual inputs in the TPM promotion service component.Lists the objects with the SubAccounts format.Sets the related tactic condition creation definition records to the promotion.Sets the tactic SObject field.Sets the related tactic funds to the Promotion. To delete the tactic fund record, set the IsDeleted attribute to true. To flag a record as new, set the IsNew attribute to true. If the Sales Org has Fund Autodetermination enabled, TPM Application will always overwrite tactic funds with the records generated by the autodetermination process. This method returns a promise resolved when an uplift prediction is completed for the promotion. If the uplift prediction is disabled or the promotion isn’t in a correct status, the promise is rejected with an error stating the cause.
Promotion Header LWCs: The TPM Promotion header LWCs provide access to the entire TPM promotion header and specific header slots.
TPM Promotion Header LWC: The tpm-promotion-header-component service component provides access to the TPM promotion header in the LWC layer. This component is part of the TPM managed package.
TPM Promotion Header Slot LWCs: The slot-specific LWCs related to the promotion header provide access to various promotion header sections in the LWC layer.
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.
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.
Customize the TPM UI EARights: Enable the global editability and visibility of a promotion or tactic by modifying its EARights.
UI Customization: All managed packages provided UI components are replaceable by custom implementations if the default requirements are not suited for your implementation.
