Edit

msdyn_omnichannelconfiguration table/entity reference

  • Article

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse. Configuration for Omnichannel

Added by: Omnichannel - Base Patch Solution

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/msdyn_omnichannelconfigurations
See Create		 CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/msdyn_omnichannelconfigurations(msdyn_omnichannelconfigurationid)
See Delete		 DeleteRequest or
Delete
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
Retrieve GET [org URI]/api/data/v9.0/msdyn_omnichannelconfigurations(msdyn_omnichannelconfigurationid)
See Retrieve		 RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/msdyn_omnichannelconfigurations
See Query Data		 RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.0/msdyn_omnichannelconfigurations(msdyn_omnichannelconfigurationid)
Update statecode and statuscode properties.		 SetStateRequest
Update PATCH [org URI]/api/data/v9.0/msdyn_omnichannelconfigurations(msdyn_omnichannelconfigurationid)
See Update		 UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName msdyn_omnichannelconfigurations
DisplayCollectionName Omnichannel Configurations
DisplayName Omnichannel Configuration
EntitySetName msdyn_omnichannelconfigurations
IsBPFEntity False
LogicalCollectionName msdyn_omnichannelconfigurations
LogicalName msdyn_omnichannelconfiguration
OwnershipType OrganizationOwned
PrimaryIdAttribute msdyn_omnichannelconfigurationid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_omnichannelconfiguration

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_defaultAgentInputLanguage

Property Value
Description Default language in which customer's messages are translated for an org
DisplayName Default input language
IsValidForForm True
IsValidForRead True
LogicalName msdyn_defaultagentinputlanguage
RequiredLevel None
Type Picklist

msdyn_defaultAgentInputLanguage Choices/Options

Value Label
1025 Arabic - Saudi Arabia
1026 Bulgarian - Bulgaria
1027 Catalan - Spain
1029 Czech - Czech Republic
1030 Danish - Denmark
1031 German - Germany
1032 Greek - Greece
1033 English - United States
1035 Finnish - Finland
1036 French - France
1037 Hebrew - Israel
1038 Hungarian - Hungary
1040 Italian - Italy
1041 Japanese - Japan
1042 Korean - Korea
1043 Dutch - Netherlands
1044 Norwegian Bokmal - Norway
1045 Polish - Poland
1046 Portuguese - Brazil
1048 Romanian - Romania
1049 Russian - Russia
1050 Croatian - Croatia
1051 Slovak - Slovakia
1053 Swedish - Sweden
1054 Thai - Thailand
1055 Turkish - Türkiye
1057 Indonesian - Indonesia
1058 Ukrainian - Ukraine
1060 Slovenian - Slovenia
1061 Estonian - Estonia
1062 Latvian - Latvia
1063 Lithuanian - Lithuania
1066 Vietnamese - Vietnam
1069 Basque - Spain
1081 Hindi - India
1086 Malay - Malaysia
1087 Kazakh - Kazakhstan
1110 Galician - Spain
2052 Chinese - China
2070 Portuguese - Portugal
2074 Serbian (Latin) - Serbia
3076 Chinese - Hong Kong SAR
3082 Spanish - Spain
3098 Serbian (Cyrillic) - Serbia

msdyn_enable_advance_entity_routing

Property Value
Description Setting to change advance entity routing for the org.
DisplayName Enable advance entity routing
IsValidForForm True
IsValidForRead True
LogicalName msdyn_enable_advance_entity_routing
RequiredLevel None
Type Boolean

msdyn_enable_advance_entity_routing Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_enable_missed_notifications

Property Value
Description Setting to change agent status when a notification has been missed.
DisplayName Enable missed notifications setting
IsValidForForm True
IsValidForRead True
LogicalName msdyn_enable_missed_notifications
RequiredLevel None
Type Boolean

msdyn_enable_missed_notifications Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_enable_supervisor_assign

Property Value
Description Enables supervisor assign feature for the org
DisplayName Enable supervisor assign
IsValidForForm True
IsValidForRead True
LogicalName msdyn_enable_supervisor_assign
RequiredLevel ApplicationRequired
Type Boolean

msdyn_enable_supervisor_assign Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_enable_supervisor_monitor

Property Value
Description Enables supervisor monitor feature for the org
DisplayName Enable supervisor monitor
IsValidForForm True
IsValidForRead True
LogicalName msdyn_enable_supervisor_monitor
RequiredLevel ApplicationRequired
Type Boolean

msdyn_enable_supervisor_monitor Choices/Options

Value Label
1 Yes
0 No

DefaultValue: True

msdyn_enable_unified_routing_diagnostic

Added by: Dynamics 365 UR OmnichanelBase Dependency Solution

Property Value
Description Setting to change unified routing diagnostic for the org.
DisplayName Enable unified routing diagnostic
IsValidForForm True
IsValidForRead True
LogicalName msdyn_enable_unified_routing_diagnostic
RequiredLevel None
Type Boolean

msdyn_enable_unified_routing_diagnostic Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_enable_visitorjourney

Property Value
Description Enables self service feature for the org
DisplayName Enable self service
IsValidForForm True
IsValidForRead True
LogicalName msdyn_enable_visitorjourney
RequiredLevel ApplicationRequired
Type Boolean

msdyn_enable_visitorjourney Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_EnableRealTimeTranslation

Property Value
Description Enable real time translation feature for the org
DisplayName Enable Real Time Translation
IsValidForForm True
IsValidForRead True
LogicalName msdyn_enablerealtimetranslation
RequiredLevel None
Type Boolean

msdyn_EnableRealTimeTranslation Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_enablesoundnotifications

Property Value
Description Enable sound notifications feature
DisplayName Enable sound notifications
IsValidForForm True
IsValidForRead True
LogicalName msdyn_enablesoundnotifications
RequiredLevel None
Type Boolean

msdyn_enablesoundnotifications Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_inactive_presence_lookup

Property Value
Description Lookup to display inactive presence settings.
DisplayName Inactive Presence
IsValidForForm True
IsValidForRead True
LogicalName msdyn_inactive_presence_lookup
RequiredLevel None
Targets msdyn_presence
Type Lookup

msdyn_isdefaultpersonamapped

Property Value
Description
DisplayName isdefaultpersonamapped
IsValidForForm True
IsValidForRead True
LogicalName msdyn_isdefaultpersonamapped
RequiredLevel ApplicationRequired
Type Boolean

msdyn_isdefaultpersonamapped Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_ispersonalizationofsoundenabled

Property Value
Description Allow agents to create personal sound settings
DisplayName Allow agents to create personal sound settings
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ispersonalizationofsoundenabled
RequiredLevel ApplicationRequired
Type Boolean

msdyn_ispersonalizationofsoundenabled Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_isPersonalMessagesEnabled

Property Value
Description Enable personal messages feature for the org
DisplayName Enable personal messages
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ispersonalmessagesenabled
RequiredLevel None
Type Boolean

msdyn_isPersonalMessagesEnabled Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_ispersonasecurityrolemappingenabled

Property Value
Description
DisplayName ispersonasecurityrolemappingenabled
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ispersonasecurityrolemappingenabled
RequiredLevel ApplicationRequired
Type Boolean

msdyn_ispersonasecurityrolemappingenabled Choices/Options

Value Label
1 Yes
0 No

DefaultValue: True

msdyn_IsSkillBasedRoutingEnabled

Added by: Omnichannel - Skill Based Routing Solution

Property Value
Description Enable Skill Based Routing for Agents & Supervisors
DisplayName Enable Skill Based Routing
IsValidForForm True
IsValidForRead True
LogicalName msdyn_isskillbasedroutingenabled
RequiredLevel None
Type Boolean

msdyn_IsSkillBasedRoutingEnabled Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_IsUpdateSkillsEnabled

Added by: Omnichannel - SBR Patch Solution

Property Value
Description This will enable agents to view and update skills for a conversation.
DisplayName Enable update skill control
IsValidForForm True
IsValidForRead True
LogicalName msdyn_isupdateskillsenabled
RequiredLevel None
Type Boolean

msdyn_IsUpdateSkillsEnabled Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_maskforagent

Property Value
Description Mask agent data
DisplayName Mask for agent
IsValidForForm True
IsValidForRead True
LogicalName msdyn_maskforagent
RequiredLevel None
Type Boolean

msdyn_maskforagent Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_maskforcustomer

Property Value
Description Mask customer data
DisplayName Mask for customer
IsValidForForm True
IsValidForRead True
LogicalName msdyn_maskforcustomer
RequiredLevel None
Type Boolean

msdyn_maskforcustomer Choices/Options

Value Label
1 Yes
0 No

DefaultValue: True

msdyn_name

Property Value
Description The name of the custom entity.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

msdyn_omnichannelconfigurationId

Property Value
Description Unique identifier for entity instances
DisplayName Omnichannel Configuration
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_omnichannelconfigurationid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_SoundFormControl

Property Value
Description Field to host sound form control
DisplayName Sound Form Control
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_soundformcontrol
MaxLength 100
RequiredLevel None
Type String

msdyn_translationwebresourceurl

Property Value
Description Webresource URL used for real time translation of the messages
DisplayName Web resource URL
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_translationwebresourceurl
MaxLength 2000
RequiredLevel None
Type Memo

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

statecode

Property Value
Description Status of the Omnichannel Configuration
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Property Value
Description Reason for the status of the Omnichannel Configuration
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

msdyn_inactive_presence_lookupName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_inactive_presence_lookupname
MaxLength 100
RequiredLevel None
Type String

OrganizationId

Added by: Active Solution Solution

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Targets organization
Type Lookup

OrganizationIdName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

See also

Web API Reference