Configuration of Integration Meta Data

The integration meta configuration defines dimensions, export columns, filters, or conditions for CSV exports.

Before creating an integration meta configuration entry in RTR Report Configuration", the Salesforce integration dimension meta configuration must be created, saved, and synchronized to off-platform.

Note

If additional custom period is enabled for a salesorg, then the property enableForCustomTimeLevel: true should be added to the export configuration.

You can create CSV export integration metadata configuration by adding new report configuration entry to RTR Report Configurations.

Note

It is mandatory to include the key fields of each dimension in the exported columns when exporting a CSV file of the report.

For CSV export reports, provide the following inputs:

Attribute	Description
Information Internal Name	A unique internal name of the integration metadata configuration.
Configuration Usage	Integration Metadata.
Configuration of sales org	The sales organization to which the product belongs.
Configuration Reporting KPI Set	The KPI set connected to measure dimension.

Note

When you trigger an inbound integration data source, ensure that you specify the calendaryear instead of businessyear in the request parameters. For more information, see Triggering CSV Exports.

Examples of the supported data sources

Examples of different supported data sources are listed in this section. Such a meta JSON must be saved to off-platform in order to enable CSV export. A meta JSON consists of the following blocks:

datasources:

Inbound data source meta configuration supports only accountdimension and kpidimension. If other dimensions are configured, then they are ignored. Inbound datasources.
- PromotionTacticDailyMeasureReal
- PromotionTacticWeeklyMeasureReal
- DailyRealData
- DailyIntData
- ProductMeasures
- AccountMeasures
- AccountProductMeasures
- WeeklyMeasureReal
- WeeklyMeasureInt
Writeback datasources:
- AccountAndPromotionMeasures
- PromotionMeasures
- PromotionAndTacticMeasures
- PromotionMeasuresWithBOMComponents
- PromotionAndTacticMeasuresWithBOMComponents
See Triggering the CSV Export Process for more information.
dimensions:

Specifies dimensions to fetch data based on the selected data source:
- accountdimension: Retrieves Salesforce data from CGCloud__Account_Extension__c
- promotiondimension: Retrieves Salesforce data from CGCloud__Promotion__c
- tacticdimension: Retrieves Salesforce data from CGCloud__Tactic__c
- productdimension: Retrieves Salesforce data from Product2
- kpidimension: Specifies the KPIs that are exported. The KPIs that are calculated based on the KPI set defined in the report configuration are available for the export.
- timedimension: Specifies how to define the time dimension, by default, it’s fixed to the business year.
  - includetotal: true or false (include the total value of the KPI)
  - splitweeks: true (only valid for weekly or custom period) or false. For more information on splitweek measures export behavior and configuration restrictions, see Splitweek Measures Export Behavior and Configuration Restrictions.
  - period: weekly, monthly, custom, customweek, and custommonth. An additional custom period-enabled salesorg supports only custom, customweek, and custommonth whereas a custom period-enabled salesorg supports custom and monthly period types only. An org using a standard calendar supports only weekly and monthly period types. For period type customweek/custommonth, it is mandatory to include the timedimension.StartDate as the first timedimension column.
exportsettings:

Specifies columns to generate in CSV file and CSV separator.

Note

Export columns is not supported for inbound data sources. This means exportsettings.columns should not be specified in the export meta configuration.
- columns: Array of strings referencing dimension attributes.
  dimensionname.attribute must exist in the corresponding dimension. the allowed accessors for timedimension:
  - timedimension.label
  - timedimension.StartDate
  - timedimension.EndDate
  - timedimension.yearnumber
  The allowed accessors for kpidimension:
  - kpidimension.label
  - kpidimension.measurecode
  - kpidimension.name
- Spread operator: The last column requires spread operator on either a kpidimension or timedimension accessor. When spread operator is used on kpidimension as the last column, accessors of kpidimension can’t be used in columns before. When spread operator is used on timedimension as the last column, accessors of timedimension can’t be used in columns before.
- Separator: The string specifying CSV separator. The allowed separators are:
  - ,
  - |
  - ;
  - :
exportfilters:

Specifies conditions to apply when export process fetches data from Salesforce dimensions. For inbound data sources, filtering is supported only on accountdimension.