Industries Common Resources Developer Guide
jFlexcardDefinition
Each row represents a Flexcard's configuration
such as its name and author. A Flexcard can display data and launch actions or Omniscripts.
This object stores specific information about a Flexcard to render it at
runtime.
Parent Type
This type extends the Metadata metadata type and inherits its fullName field.
File Suffix and Directory Location
FlexcardDefinition components have the suffix .flexcardDefinition and are stored in the flexcardDefinitions folder.
Version
FlexcardDefinition components are available in API version 67.0 and later.
Special Access Rules
Fields
| Field Name | Description |
|---|---|
| authorName |
|
| clonedFromFlexcardKey |
|
| dataSourceConfiguration |
|
| description |
|
| flexcardKey |
|
| flexcardType |
|
| isActive |
|
| isManagedUsingStdDesigner |
|
| isTrackingEnabled |
|
| masterLabel |
|
| overrideKey |
|
| propertySetConfig |
|
| references |
|
| sampleDataSourceResponse |
|
| stylingConfiguration |
|
FlexcardPropertySetConfig
| Field Name | Description |
|---|---|
| accessibilityToggle |
|
| dataSource |
|
| dynamicProperties |
|
| enableLwc |
|
| integrationProcedureRootConfig |
|
| isFlex |
|
| omniScriptRootConfig |
|
| selectableMode |
|
| states |
|
| theme |
|
| title |
|
| xmlObject |
|
IntegrationProcedurePropertySetConfig
OmniScriptPropertySetConfig
FlexcardStatePropertySetConfig
| Field Name | Description |
|---|---|
| actions |
|
| blankCardState |
|
| childCards |
|
| components |
|
| conditions |
|
| definedActions |
|
| documents |
|
| dynamicProperties |
|
| fields |
|
| isSmartAction |
|
| name |
|
| omniscripts |
|
| smartAction |
|
| styleObject |
|
Declarative Metadata Sample Definition
The following is an example of a FlexcardDefinition component.
1<?xml version="1.0" encoding="UTF-8"?>
2<FlexcardDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3 <authorName>TestAuthor</authorName>
4 <dataSourceConfiguration>{"dataSource":{"type":null,"value":{},"orderBy":{},"contextVariables":[]}}</dataSourceConfiguration>
5 <description>Test Flexcard Definition for Metadata Gauntlet</description>
6 <flexcardKey>TestFlexcardDefinition/TestAuthor</flexcardKey>
7 <flexcardType>Parent</flexcardType>
8 <isActive>true</isActive>
9 <isManagedUsingStdDesigner>true</isManagedUsingStdDesigner>
10 <isTrackingEnabled>false</isTrackingEnabled>
11 <masterLabel>TestFlexcardDefinition_TestAuthor</masterLabel>
12 <propertySetConfig>
13 <states>
14 <fields>[]</fields>
15 <conditions>{"id":"state-condition-object","isParent":true,"group":[]}</conditions>
16 <definedActions>{"actions":[]}</definedActions>
17 <name>Active</name>
18 <isSmartAction>false</isSmartAction>
19 <smartAction>{}</smartAction>
20 <styleObject>{"padding":[{"type":"around","size":"x-small"}],"margin":[{"type":"bottom","size":"x-small"}],"container":{"class":"slds-card"},"size":{"isResponsive":false,"default":"12"},"sizeClass":"slds-size_12-of-12","class":"slds-card slds-p-around_x-small slds-m-bottom_x-small"}</styleObject>
21 <components>{"layer-0":{"children":[{"name":"Text","element":"outputField","size":{"isResponsive":false,"default":"12"},"stateIndex":0,"class":"slds-col ","property":{"record":"{record}","mergeField":"Test","card":"{card}"},"type":"text","styleObject":{"sizeClass":"slds-size_12-of-12"},"datasourceKey":"state0element0","uKey":"1767799962280-500","elementLabel":"Text-0"}]}}</components>
22 <childCards>[]</childCards>
23 <actions>[]</actions>
24 <omniscripts>[]</omniscripts>
25 <documents>[]</documents>
26 <dynamicProperties></dynamicProperties>
27 <blankCardState>false</blankCardState>
28 </states>
29 <dataSource>{"type":null,"value":{},"orderBy":{},"contextVariables":[]}</dataSource>
30 <title>TestFlexcardDefinition</title>
31 <enableLwc>true</enableLwc>
32 <isFlex>true</isFlex>
33 <theme>slds</theme>
34 <selectableMode>Multi</selectableMode>
35 <accessibilityToggle>true</accessibilityToggle>
36 <xmlObject>{"targetConfigs":"PHRhcmdldENvbmZpZyB0YXJnZXRzPSJsaWdodG5pbmdfX0FwcFBhZ2UiPgogICAgICAgICAgICAgICAgICAgIDxwcm9wZXJ0eSBuYW1lPSJkZWJ1ZyIgdHlwZT0iQm9vbGVhbiIvPgogICAgICAgICAgICAgICAgICAgIDxwcm9wZXJ0eSBuYW1lPSJyZWNvcmRJZCIgdHlwZT0iU3RyaW5nIi8+CiAgICAgICAgICAgICAgICA8L3RhcmdldENvbmZpZz4KICAgICAgICAgICAgICAgIDx0YXJnZXRDb25maWcgdGFyZ2V0cz0ibGlnaHRuaW5nX19SZWNvcmRQYWdlIj4KICAgICAgICAgICAgICAgICAgICA8cHJvcGVydHkgbmFtZT0iZGVidWciIHR5cGU9IkJvb2xlYW4iLz4KICAgICAgICAgICAgICAgIDwvdGFyZ2V0Q29uZmlnPg==","targets":{"target":["lightning__RecordPage","lightning__AppPage","lightning__HomePage"]},"apiVersion":61,"description":""}</xmlObject>
37 <dynamicProperties></dynamicProperties>
38 <integrationProcedureRootConfig>
39 <mockResponseMap></mockResponseMap>
40 <omniProcessId></omniProcessId>
41 <linkToExternalObject></linkToExternalObject>
42 <integrationProcedureOutput></integrationProcedureOutput>
43 <additionalChainableResponse></additionalChainableResponse>
44 <relationshipFieldsMap></relationshipFieldsMap>
45 <integrationProcedureInput></integrationProcedureInput>
46 <description></description>
47 <trackingCustomData></trackingCustomData>
48 <requiredPermission></requiredPermission>
49 <nameColumn></nameColumn>
50 <columnsPropertyMap></columnsPropertyMap>
51 <isIntegProcdSignatureAvl></isIntegProcdSignatureAvl>
52 <transientValues></transientValues>
53 <labelSingular></labelSingular>
54 <labelPlural></labelPlural>
55 <dynamicProperties></dynamicProperties>
56 <autoSaveOnStepNext>false</autoSaveOnStepNext>
57 <persistentComponent>false</persistentComponent>
58 <includeAllActionsInResponse>false</includeAllActionsInResponse>
59 <rollbackOnError>false</rollbackOnError>
60 <disableDefinitionCache>false</disableDefinitionCache>
61 <chainableQueryRowsLimit>0</chainableQueryRowsLimit>
62 <ttlMinutes>0</ttlMinutes>
63 <chainableHeapSizeLimit>0</chainableHeapSizeLimit>
64 <queueableChainableQueriesLimit>0</queueableChainableQueriesLimit>
65 <queueableChainableHeapSizeLimit>0</queueableChainableHeapSizeLimit>
66 <chainableActualTimeLimit>0</chainableActualTimeLimit>
67 <chainableDMLRowsLimit>0</chainableDMLRowsLimit>
68 <chainableDMLStatementsLimit>0</chainableDMLStatementsLimit>
69 <chainableSoslQueriesLimit>0</chainableSoslQueriesLimit>
70 <chainableQueriesLimit>0</chainableQueriesLimit>
71 <queueableChainableCpuLimit>0</queueableChainableCpuLimit>
72 <chainableCpuLimit>0</chainableCpuLimit>
73 </integrationProcedureRootConfig>
74 <omniScriptRootConfig>
75 <cancelRedirectPageName></cancelRedirectPageName>
76 <currencyCode></currencyCode>
77 <consoleTabLabel></consoleTabLabel>
78 <cancelRedirectTemplateUrl></cancelRedirectTemplateUrl>
79 <lkObjName></lkObjName>
80 <stylesheet></stylesheet>
81 <consoleTabIcon></consoleTabIcon>
82 <consoleTabTitle></consoleTabTitle>
83 <saveURLPatterns></saveURLPatterns>
84 <seedDataJSON></seedDataJSON>
85 <cancelSource></cancelSource>
86 <stepChartPlacement></stepChartPlacement>
87 <currentLanguage></currentLanguage>
88 <scrollBehavior></scrollBehavior>
89 <message></message>
90 <visualforcePagesAvailableInPreview></visualforcePagesAvailableInPreview>
91 <saveForLaterRedirectTemplateUrl></saveForLaterRedirectTemplateUrl>
92 <saveNameTemplate></saveNameTemplate>
93 <saveForLaterRedirectPageName></saveForLaterRedirectPageName>
94 <errorMessage></errorMessage>
95 <dynamicProperties></dynamicProperties>
96 <trackingCustomData></trackingCustomData>
97 <persistentComponent></persistentComponent>
98 <cancelType></cancelType>
99 <elementTypeToHTMLTemplateMapping></elementTypeToHTMLTemplateMapping>
100 <knowledgeArticleTypeQueryFieldsMap></knowledgeArticleTypeQueryFieldsMap>
101 <saveObjectId></saveObjectId>
102 <mergeSavedData>false</mergeSavedData>
103 <allowSaveChanges>false</allowSaveChanges>
104 <showInputWidth>false</showInputWidth>
105 <allowCancel>false</allowCancel>
106 <allowSaveForLater>false</allowSaveForLater>
107 <hideStepChart>false</hideStepChart>
108 <rtpSeed>false</rtpSeed>
109 <disableUnloadWarn>false</disableUnloadWarn>
110 <autoSaveChanges>false</autoSaveChanges>
111 <autoFocus>false</autoFocus>
112 <enableKnowledge>false</enableKnowledge>
113 <autoSaveOnStepNext>false</autoSaveOnStepNext>
114 <ssm>false</ssm>
115 <saveContentEncoded>false</saveContentEncoded>
116 <pubsub>false</pubsub>
117 <bulk>false</bulk>
118 <accessibilityToggle>false</accessibilityToggle>
119 <timeTracking>false</timeTracking>
120 <wpm>false</wpm>
121 <saveExpireInDays>0</saveExpireInDays>
122 </omniScriptRootConfig>
123 </propertySetConfig>
124 <references>[]</references>
125</FlexcardDefinition>The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>*</members>
5 <name>FlexcardDefinition</name>
6 </types>
7 <version>[ftest]</version>
8</Package>