Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
UiFormatSpecificationSet
Parent Type
File Suffix and Directory Location
UiFormatSpecificationSet components have the suffix .uiFormatSpecificationSet and are stored in the uiFormatSpecificationSets folder.
Version
UiFormatSpecificationSet components are available in API version 62.0 and later.
Special Access Rules
There are no additional access requirements that are specific to this type.
Fields
| Field Name | Description |
|---|---|
| field |
|
| formatType |
|
| masterLabel |
|
| sobjectType |
|
| uiFormatSpecifications |
|
UiFormatSpecification
A single rule in the ruleset.
| Field Name | Description |
|---|---|
| formatProperties |
|
| formatType |
|
| order |
|
| visibilityRule |
|
UiFormulaRule
A set of one or more filters that define the conditions under which conditional field formatting displays on a Dynamic Forms-enabled Lightning page field instance. For example, you could construct a filter that causes conditional formatting to display only when the Amount field is greater than $1,000,000.
| Field Name | Description |
|---|---|
| booleanFilter |
|
| criteria |
|
UiFormulaCriterion
A single filter that when evaluated, helps define conditional formatting visibility on a Dynamic Forms-enabled Lightning page field instance.
| Field Name | Description |
|---|---|
| leftValue |
|
| operator |
|
| rightValue |
|
Declarative Metadata Sample Definition
The following is an example of an UiFormatSpecificationSet component.
<?xml version="1.0" encoding="UTF-8"?>
<UiFormatSpecificationSet xmlns="http://soap.sforce.com/2006/04/metadata">
<field>Contact.Customer_Sentiment__c</field>
<formatType>ICON</formatType>
<masterLabel>Sentiment Score</masterLabel>
<sobjectType>Contact</sobjectType>
<uiFormatSpecifications>
<formatProperties>{"icon":"happy_face",
"iconColor":"green"}</formatProperties>
<formatType>ICON</formatType>
<order>1</order>
<visibilityRule>
<criteria>
<leftValue>{!Record.Customer_Sentiment__c}</leftValue>
<operator>EQUAL</operator>
<rightValue>Happy</rightValue>
</criteria>
</visibilityRule>
</uiFormatSpecifications>
<uiFormatSpecifications>
<formatProperties>{"icon":"neutral_face",
"iconColor":"gray"}</formatProperties>
<formatType>ICON</formatType>
<order>2</order>
<visibilityRule>
<criteria>
<leftValue>{!Record.Customer_Sentiment__c}</leftValue>
<operator>EQUAL</operator>
<rightValue>Neutral</rightValue>
</criteria>
</visibilityRule>
</uiFormatSpecifications>
<uiFormatSpecifications>
<formatProperties>{"icon":"sad_face",
"iconColor":"red"}</formatProperties>
<formatType>ICON</formatType>
<order>3</order>
<visibilityRule>
<criteria>
<leftValue>{!Record.Customer_Sentiment__c}</leftValue>
<operator>EQUAL</operator>
<rightValue>Unhappy</rightValue>
</criteria>
</visibilityRule>
</uiFormatSpecifications>
</UiFormatSpecificationSet>The following is an example package.xml that references the previous definition.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>Sentiment_Score</members>
<name>UiFormatSpecificationSet</name>
</types>
<version>62.0</version>
</Package>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.