MktCalcInsightObjectDef

Represents Calculated Insight definition such as expression.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

MktCalcInsightObjectDef components have the suffix mktCalcInsightObjectDef and are stored in the mktCalcInsightObjectDefs folder.

Version 

Introduced in API version 52.0.

Special Access Rules 

You need the Salesforce CustomizeApplication permission to access this object.

Fields 

builderExpression 

  • Type: string
  • Required: No
  • Description: Reserved for internal use.

creationType 

  • Type: CalculatedInsightCreationType (enumeration of type string)
  • Required: Yes
  • Description: Required. Describes whether this Calculated Insight Object Definition was added was added by the customer. Valid values include: Custom.

description 

  • Type: string
  • Required: No
  • Description: The description for this Calculated Insight Object Definition.

expression 

  • Type: string
  • Required: No
  • Description: Required when the Calculated Insight Object Definition is for internal insight type. This is the SQL query to generate the calculated insight.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. App name for this Calculated Insight Object Definition.

system 

  • Type: string

  • Required: Yes

  • Description: Required. Indicates how this calculated insight object definition was added, by the customer or by the system. Valid values are:

    • Custom
    • System (API version 61.0 and later)

Declarative Metadata Sample Definition 

The following is an example of a MktCalcInsightObjectDef component.

1<?xml version="1.0" encoding="UTF-8"?>
2<MktCalcInsightObjectDef xmlns="http://soap.sforce.com/2006/04/metadata">
3    <creationType>Custom</creationType>
4    <description>InsightName description</description>
5    <expression>SELECT COUNT(ssot__Individual__dlm.ssot__Id__c) as count__c FROM ssot__Individual__dlm</expression>
6</MktCalcInsightObjectDef>

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.