Salesforce Docs Portal

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.

Supported Calls

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

Fields

LastReferencedDate

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

LastViewedDate

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

Name

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

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: ID of the record owner.

    This is a polymorphic relationship field.

  • Relationship Name: Owner
  • Relationship Type: Lookup
  • Refers To: Group, User

RecordTypeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Type of the KPI, defines how the KPI is handled by the system.

    This is a relationship field.

  • Relationship Name: RecordType
  • Relationship Type: Lookup
  • Refers To: RecordType

cgcloud__Aggregation_Merge_Rule__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: Determines how subperiods are merged into either full weeks or months.
  • Default value: sum
  • Possible values:
    • avg—Avg
    • sum—Sum

cgcloud__Aggregation_Rule__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Defines how the data in lower level nodes are aggregated to higher levels.
  • Possible values:
    • avg—Avg
    • formula—Formula
    • max—Max
    • min—Min
    • sum—Sum

cgcloud__Aggregation_Time_Rule__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Defines the monthly calculation rule.
  • Possible values:
    • aggregate—Aggregate
    • formula—Formula
    • read—Read

cgcloud__BoM_Scope__c

  • Type: multipicklist
  • Properties: Create, Filter, Nillable, Update
  • Description: Defines the levels for which the calculation engine determines values.

    This field is available in API version 55.0 and later.

  • Possible values:
    • Component
    • Header
    • Product

cgcloud__Comment__c

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Stores extra information about the KPI Definition.

cgcloud__Compound_Main__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Specifies whether this KPI is main compound KPI.
  • Default value: false

cgcloud__Data_Source_Aggregation_Mode__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Defines whether a core aggregation is to be used or a custom aggregation is to be used
  • Default value: standard
  • Possible values:
    • custom—Custom
    • standard—Standard

cgcloud__Data_Source_BoM_Component_Source_Level__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Defines from which level the values are determined.

    This field is available in API version 55.0 and later.

  • Possible values:
    • Component
    • Product

cgcloud__Data_Source_Condition_Search_Group_Code__c

  • Type: string
  • Properties: Filter, Nillable, Sort
  • Description: Stores the group code of the condition search group.

    This field is a calculated field.

    This field is available in API version 55.0 and later.

  • Formula: 
    cgcloud__Data_Source_Condition_Search_Group__r.cgcloud__Group_Code__c

cgcloud__Data_Source_Condition_Search_Group__c

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: References to the condition search group.

    This field is a relationship field.

    This field is available in API version 55.0 and later.

  • Relationship Name: cgcloud__Data_Source_Condition_Search_Group__r
  • Relationship Type: Lookup
  • Refers To: cgcloud__Condition_Search_Group__c

cgcloud__Data_Source_Consider_Product_Hierarchy__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the product hierarchy is considered for the condition search.
  • Default value: false

cgcloud__Data_Source_Load_For_Sub_Accounts__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Defines whether the loaded data is anchored to the planning account or to a list of accounts (Sub accounts). This field is applicable only for Read type.
  • Default value: false

cgcloud__Data_Source_Measure_Code__c

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Unique code of a data source measure.

cgcloud__Data_Source_Monthly_Table_Name__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Name of the source table for Monthly data that's to be read.
  • Possible values:
    • accountmeasure—Account Measure
    • accountproductmeasure—Account Product Measure
    • dailymeasureint—Daily Measure Int
    • dailymeasurereal—Daily Measure Real
    • monthlyaccountmeasureresult—Monthly Account Measure Result
    • monthlypaymenttacticmeasureresult—Monthly Payment Tactic Measure Result
    • monthlypromotionmeasureresult—Monthly Promotion Measure Result
    • productmeasure—Product Measure
    • promotiontacticdailymeasurereal—Promotion Tactic Daily Measure Real

cgcloud__Data_Source_Table_Name__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Name of the source table from which the measure data is drawn.
  • Possible values:
    • accountmeasure—Account Measure
    • accountproductmeasure—Account Product Measure
    • dailymeasureint—Daily Measure Int
    • dailymeasurereal—Daily Measure Real
    • productmeasure—Product Measure
    • promotiontacticdailymeasurereal—Promotion Tactic Daily Measure Real
    • promotiontacticweeklymeasurereal—Promotion Tactic Weekly Measure Real
    • weeklyaccountmeasureresult—Weekly Account Measure Result
    • weeklymeasureint—Weekly Measure Int
    • weeklymeasurereal—Weekly Measure Real
    • weeklypaymenttacticmeasureresult—Weekly Payment Tactic Measure Result
    • weeklypromotionmeasureresult—Weekly Promotion Measure Result

cgcloud__Data_Source_Week_Offset__c

  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Data is fetched from the database for the timeframe that lies within this number of weeks before the promotion. This field is supported only for volume data.

cgcloud__Data_Source_Year_Offset__c

  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Number of years to go back in time. The data is fetched from the database for the timeframe that lies within this number of years that can be either one or two years before the promotion. This field is applicable only for Read type. It can't be used in combination with week offset for one KPI at the same time.

cgcloud__Description_Language_1__c

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

cgcloud__Description_Language_2__c

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

cgcloud__Description_Language_3__c

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

cgcloud__Description_Language_4__c

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

cgcloud__Description__c

  • Type: string
  • Properties: Filter, Nillable, Sort
  • Description: Description based on the user-specified language.

    This is a calculated field.

  • Formula: 
    CASE($User.cgcloud__Language_Postfix__c,
      "Language1", cgcloud__Description_Language_1__c,
      "Language2", BLANKVALUE(cgcloud__Description_Language_2__c,cgcloud__Description_Language_1__c),
      "Language3", BLANKVALUE(cgcloud__Description_Language_3__c,cgcloud__Description_Language_1__c),
      "Language4", BLANKVALUE(cgcloud__Description_Language_4__c,cgcloud__Description_Language_1__c),
      cgcloud__Description_Language_1__c)

cgcloud__Display_Enabled__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Only the measures whose display is enabled are to be displayed on the UI.
  • Default value: true

cgcloud__Display_Round__c

  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: UI Rounding determines the number of decimal places that are to be shown in the cell.

cgcloud__Distribution_Acc_Hierarchy_Dist_Type__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Measure code defines the code that's used to distributevalues down the account hierarchy.
  • Possible values:
    • copy—Copy
    • equal—Equal
    • metric—Metric (KPI)

cgcloud__Distribution_Acc_Hierarchy_Metric_Code__c

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The measure code defines the code that is used for distribution of values down the account hierarchy.

cgcloud__Distribution_Order__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Defines the order in which hierarchies are traversed.
  • Default value: PlanThenTime
  • Possible values:
    • PlanThenTime—Planning Hierarchy -> Time
    • TimeThenPlan—Time -> Planning Hierarchy

cgcloud__Distribution_Plan_Hierarchy_Dist_Metric__c

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Reference to the KPI definition when distribution is of plan hierarchy.

    This is a relationship field.

  • Relationship Name: cgcloud__Distribution_Plan_Hierarchy_Dist_Metric__r
  • Relationship Type: Lookup
  • Refers To: cgcloud__KPI_Definition__c

cgcloud__Distribution_Plan_Hierarchy_Dist_Type__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Defines the distribution type that's to be used to distribute values down the planning hierarchy.
  • Default value: metric
  • Possible values:
    • copy—Copy
    • equal—Equal
    • metric—Metric (KPI)
    • proportional—Proportional

cgcloud__Distribution_Time_Hierarchy_Dist_Metric__c

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Reference to the KPI definition when distribution is of time hierarchy.

    This is a relationship field.

  • Relationship Name: cgcloud__Distribution_Time_Hierarchy_Dist_Metric__r
  • Relationship Type: Lookup
  • Refers To: cgcloud__KPI_Definition__c

cgcloud__Distribution_Time_Hierarchy_Dist_Type__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Defines the distribution type that's to be used to distribute values down the time hierarchy.
  • Default value: metric
  • Possible values:
    • copy—Copy
    • equal—Equal
    • metric—Metric (KPI)
    • proportional—Proportional

cgcloud__Editable_Edit_Mode__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: This field is for lump sum. After this field is enabled and when a user introduces a total, the totals don't change even if other items change (KPI, products, and so on).
  • Default value: week
  • Possible values:
    • all—All
    • none—None
    • total—Total
    • week—Week

cgcloud__Editable_Enable_Past_Weeks__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: If true, the cells of past weeks remain editable.
  • Default value: false

cgcloud__Editable_Fixed_Totals__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Defines whether the non-obsolete last edited or calculated total value of the KPI is saved for use in the Promotion Calculation.
  • Default value: false

cgcloud__Editable_Measure_Code__c

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Unique code of the editable measure that's used when saving the edit history.

cgcloud__Formula__c

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Function that executes the calculation.

cgcloud__Is_Storage_Level_Bom_Component__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Flag that indicates whether the KPI Definition Storage Levels is BOM Component.

    This field is available in API version 55.0 and later.

  • Default value: false

cgcloud__Parent__c

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Reference to the Compound KPI to which this KPI belongs.

    This is a relationship field.

  • Relationship Name: cgcloud__Parent__r
  • Relationship Type: Lookup
  • Refers To: cgcloud__KPI_Definition__c

cgcloud__Reporting_Formula__c

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Defines the calculation rule for calculated reporting KPIs as a JavaScript formula.

cgcloud__Reporting_Relevant__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Defines whether the KPI is relevant for reporting.
  • Default value: false

cgcloud__Reporting_Type__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Controls whether the KPI is either directly read from the Writeback measure or calculated.
  • Default value: read
  • Possible values:
    • calculated—Calculated
    • external—External
    • read—Read

cgcloud__Rounding_Order__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Period Then Sub Periods method rounds period values first, and then rounds the buckets. This ensures that their merged value matches the period value. Sub Periods Then Period rounds subperiods first, and then merges them into periods.
  • Possible values:
    • default—Default
    • periodfirst—Period Then Sub Periods
    • subperiodfirst—Sub Periods Then Period

cgcloud__Rounding_Precision__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Defines the precision to which the calculation engine rounds the calculated values of the KPI at product level such that these values aggregate up to the correct weekly, monthly, and total values without losing precision.
  • Possible values:
    • 0
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

cgcloud__Rounding_Type__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Rounding With Carry Over is a special configuration that uses a carryover from one cell to another to ensure that aggregations and totals match with the rounded number. Rounding Enabled performs a simple rounding to the nearest number.
  • Possible values:
    • nocarryover—Rounding Enabled
    • withcarryover—Rounding With Carry Over

cgcloud__Scope__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: Defines the object scope of the KPI. The KPI can be added to the relevant KPI Set based on the defined scope.
  • Default value: account
  • Possible values:
    • account—Account
    • fund—Funding
    • paymenttactic—Payment Tactic
    • promotion—Promotion
    • promotiontactic—Promotion Tactic

cgcloud__Storage_Options_Measure_Code__c

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Unique code of the writeback measure that's used when writing back KPIs. The last character may be a # for KPIs with the object scope as Payment Tactic.

cgcloud__Storage_Options_Storage_Levels__c

  • Type: multipicklist
  • Properties: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update
  • Description: Levels on which the data is written back. More than one level can be defined.
  • Default value: Product
  • Possible values:
    • Brand
    • Category
    • Flavor—Sub Brand
    • Package—Product Price Group
    • Product
    • SubCategory—Sub Category
    • Tactic
    • measures—Measures

cgcloud__Storage_Options_Subperiod__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: If active, writeback has to generate daily accurate values for the subperiods that belong to different months.
  • Possible values:
    • weeksplits—Week Splits By Month

cgcloud__Storage_Options_Writeback__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Rows with writeback as true are saved back to the database for further use by external tools.
  • Default value: false

cgcloud__Time_Granularity__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: If granularity is Subperiod, the formula is applied at the subperiod level and then merged by using merge rule. In Period granularity, the formula is applied over already merged values.
  • Default value: subperiod
  • Possible values:
    • period—Period
    • subperiod—Sub Period

cgcloud__Time_Scope__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: Consideration of time ranges within the calculation.
  • Default value: complete
  • Possible values:
    • complete—Complete
    • custom1—Custom 1
    • custom2—Custom 2
    • order—Order
    • placement—Instore
    • shipment—Shipment

cgcloud__Total_Calculation_Cumulative__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies whether the KPI is a cumulative KPI.
  • Default value: off
  • Possible values:
    • off—Off
    • on—On

cgcloud__Total_Calculation_Rule__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Defines how the total column is aggregated along the x-axis.
  • Possible values:
    • avg—Avg
    • formula—Formula
    • max—Max
    • min—Min
    • sum—Sum

cgcloud__Validation_Error_Message__c

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Label ID of the error string.

cgcloud__Validation_Level__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Determines the level at which the validation is to be executed. This field is applicable only for the Validation record type.
  • Possible values:
    • promotion—Promotion
    • promotionproduct—Promotion Product
    • promotionproductgroup1—Promotion Product Group1
    • promotionproductgroup2—Promotion Product Group2
    • tactic—Tactic
    • tacticproduct—Tactic Product
    • tacticproductgroup1—Tactic Product Group1
    • tacticproductgroup2—Tactic Product Group2

cgcloud__Validation_Value_Type__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Determines the granular level at which the validation is run.
  • Possible values:
    • total—Total
    • week—Week

cgcloud__Value_Type__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Determines the granular level at which the validation is executed. This field is applicable only for the Validation record type.
  • Default value: None
  • Possible values:
    • Money
    • None
    • Percentage
    • Price
    • Volume

Associated Objects

Associated Objects

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