Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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 the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

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

Version

MktCalcInsightObjectDef components are available in API version 52.0 and later.

Special Access Rules

You need the Salesforce CustomizeApplication permission to access this object.

Fields

Field Name	Field Type	Description
builderExpression	string	Reserved for internal use.
creationType	CalculatedInsightCreationType(enumeration of type string)	Required. Describes whether this Calculated Insight Object Definition was added was added by the customer. Valid values include: Custom.
description	string	The description for this Calculated Insight Object Definition.
expression	string	Required when the Calculated Insight Object Definition is for internal insight type. This is the SQL query to generate the calculated insight.
masterLabel	string	Required. App name for this Calculated Insight Object Definition.
system	string	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.

Metadata API Developer Guide