OmniInteractionAccessConfig

Represents configuration settings for access to Omnistudio FlexCard caching and data sources.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

OmniInteractionAccessConfig components have the suffix .omniInteractionAccessConfig and are stored in the OmniInteractionAccessConfig folder.

Version

OmniInteractionAccessConfig components are available in API version 53.0 and later.

Special Access Rules

OmniInteractionAccessConfig is available if your org has the Omnistudio platform license and related addon and user licenses.

Fields

configName

Field Type: string
Description: Not used.

isAsyncCardCachingEnabled

Field Type: boolean
Description: Required. If set to true, enables asynchronous FlexCard caching.
Default value: false

isCardApexRemoteDisabled

Field Type: boolean
Description: Required. If set to true, disables remote Apex method calls for FlexCards.
Default value: false

isCardCacheDisabled

Field Type: boolean
Description: Required. If set to true, disables FlexCard caching.
Default value: false

isCardDataTfrmDisabled

Field Type: boolean
Description: Required. If set to true, disables Data Mapper data sources for FlexCards.
Default value: false

isCardIntegrationProcDisabled

Field Type: boolean
Description: Required. If set to true, disables Integration Procedure data sources for FlexCards.
Default value: false

isCardRestApiDisabled

Field Type: boolean
Description: Required. If set to true, disables REST calls for FlexCards.
Default value: false

isCardSoqlDisabled

Field Type: boolean
Description: Required. If set to true, disables SOQL queries for FlexCards.
Default value: false

isCardSoslDisabled

Field Type: boolean
Description: Required. If set to true, disables SOSL queries for FlexCards.
Default value: false

isCardStreamingApiDisabled

Field Type: boolean
Description: Required. If set to true, disables Streaming API calls for FlexCards.
Default value: false

isDataTfrmEncrpFieldsDisabled

Field Type: boolean
Description: Required. If set to true, disables Data Mapper field encryption for FlexCards.
Default value: false

masterLabel

Field Type: string
Description: Required. The name of the setting. The value is Profile_ProfileId, User_UserId, or Org_Wide.

setupOwner

Field Type: string
Description: The ID of the profile, user, or org to which the settings apply.

Declarative Metadata Sample Definition

The following is an example of an OmniInteractionAccessConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<OmniInteractionAccessConfig xmlns="http://soap.sforce.com/2021/10/metadata">
3   <isAsyncCardCachingEnabled>false</isAsyncCardCachingEnabled>
4   <isCardApexRemoteDisabled>false</isCardApexRemoteDisabled>
5   <isCardCacheDisabled>false</isCardCacheDisabled>
6   <isCardDataTfrmDisabled>false</isCardDataTfrmDisabled>
7   <isCardIntegrationProcDisabled>false</isCardIntegrationProcDisabled>
8   <isCardRestApiDisabled>false</isCardRestApiDisabled>
9   <isCardSoqlDisabled>false</isCardSoqlDisabled>
10   <isCardSoslDisabled>false</isCardSoslDisabled>
11   <isCardStreamingApiDisabled>false</isCardStreamingApiDisabled>
12   <isDataTfrmEncrpFieldsDisabled>false</isDataTfrmEncrpFieldsDisabled>
13   <masterLabel>Profile_00eB0000000ijOH</masterLabel>
14   <setupOwner>00eB0000000ijOH</setupOwner>
15</OmniInteractionAccessConfig>

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/2021/10/metadata">
3    <types>
4        <members>*</members>
5        <name>OmniInteractionAccessConfig</name>
6    </types>
7    <version>53.0</version>
8</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.