Channel Integration Framework v1.0 Provider (msdyn_ciprovider) table/entity reference (Microsoft Dynamics 365)

Entity that holds the configuration data for a channel provider based on Channel Integration Framework v1.0

Messages

The following table lists the messages for the Channel Integration Framework v1.0 Provider (msdyn_ciprovider) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
Associate Event: True	Associate records	Associate records
BulkRetain Event: True	BulkRetain	Learn to use messages with the SDK for .NET
Create Event: True	POST /msdyn_ciproviders See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /msdyn_ciproviders(msdyn_ciproviderid) See Delete	Delete records
Disassociate Event: True	Disassociate records	Disassociate records
IsValidStateTransition Event: False	IsValidStateTransition	IsValidStateTransitionRequest
PurgeRetainedContent Event: True	PurgeRetainedContent	Learn to use messages with the SDK for .NET
Restore Event: True	Restore	Learn to use messages with the SDK for .NET
Retain Event: True	Retain	Learn to use messages with the SDK for .NET
Retrieve Event: True	GET /msdyn_ciproviders(msdyn_ciproviderid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /msdyn_ciproviders See Query data	Query data
RollbackRetain Event: True	RollbackRetain	Learn to use messages with the SDK for .NET
SetState Event: True	PATCH /msdyn_ciproviders(msdyn_ciproviderid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: True	PATCH /msdyn_ciproviders(msdyn_ciproviderid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /msdyn_ciproviders(msdyn_ciproviderid) See Upsert a table row	UpsertRequest
UpsertMultiple Event: False	UpsertMultiple	UpsertMultipleRequest
ValidateRetentionConfig Event: True	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Channel Integration Framework v1.0 Provider (msdyn_ciprovider) table.

Property	Value
DisplayName	Channel Integration Framework v1.0 Provider
DisplayCollectionName	Channel Integration Framework v1.0 Providers
SchemaName	msdyn_ciprovider
CollectionSchemaName	msdyn_ciproviders
EntitySetName	msdyn_ciproviders
LogicalName	msdyn_ciprovider
LogicalCollectionName	msdyn_ciproviders
PrimaryIdAttribute	msdyn_ciproviderid
PrimaryNameAttribute	msdyn_name
TableType	Standard
OwnershipType	OrganizationOwned

Writable columns/attributes

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

• ImportSequenceNumber
• msdyn_AppSelector
• msdyn_channelprovidericon
• msdyn_cifsolversion
• msdyn_ciproviderapiversion
• msdyn_ciproviderId
• msdyn_ClickToAct
• msdyn_customparams
• msdyn_EnableAnalytics
• msdyn_Label
• msdyn_LandingUrl
• msdyn_name
• msdyn_RoleSelector
• msdyn_sandboxconfiguration
• msdyn_SortOrder
• msdyn_trusteddomain
• OverriddenCreatedOn
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

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

msdyn_AppSelector

Property	Value
Description	Select Unified Interface Apps for the Channel
DisplayName	App Selector
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_appselector
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

msdyn_channelprovidericon

Property	Value
Description	Customize channel provider icon
DisplayName	Channel Provider Icon
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_channelprovidericon
RequiredLevel	None
Type	Lookup
Targets	webresource

msdyn_cifsolversion

Property	Value
Description	Version of the CIF Solution
DisplayName	CIF Sol Version
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_cifsolversion
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	2000

msdyn_ciproviderapiversion

Property	Value
Description	API Version
DisplayName	API Version
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_ciproviderapiversion
RequiredLevel	None
Type	Picklist
DefaultFormValue	0
GlobalChoiceName	msdyn_ciproviderapiversion

msdyn_ciproviderapiversion Choices/Options

Value	Label
0	1.0
1	2.0

msdyn_ciproviderId

Property	Value
Description	Unique identifier for CIProvider records
DisplayName	CIProviderId
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_ciproviderid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_ClickToAct

Property	Value
Description	Enable Outbound Communication
DisplayName	Enable Outbound Communication
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_clicktoact
RequiredLevel	ApplicationRequired
Type	Boolean
GlobalChoiceName	msdyn_ciprovider_msdyn_clicktoact
DefaultValue	False
True Label	Yes
False Label	No

msdyn_customparams

Property	Value
Description	Custom Parameters for the Widget to load
DisplayName	Custom Parameters
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customparams
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	2000

msdyn_EnableAnalytics

Property	Value
Description	Enable CIF Analytics for the current provider
DisplayName	Enable Analytics
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_enableanalytics
RequiredLevel	None
Type	Boolean
GlobalChoiceName	msdyn_ciprovider_msdyn_enableanalytics
DefaultValue	False
True Label	Yes
False Label	No

msdyn_Label

Property	Value
Description	The label is displayed as the title on the widget
DisplayName	Label
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_label
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

msdyn_LandingUrl

Property	Value
Description	URL for the Channel provider
DisplayName	Channel URL
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_landingurl
RequiredLevel	ApplicationRequired
Type	String
Format	Url
FormatName	Url
ImeMode	Auto
IsLocalizable	False
MaxLength	1024

msdyn_name

Property	Value
Description	Name of the Channel provider
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_name
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

msdyn_RoleSelector

Property	Value
Description	Select the Roles for the Channel
DisplayName	Role Selector
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_roleselector
RequiredLevel	ApplicationRequired
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

msdyn_sandboxconfiguration

Property	Value
Description	Custom sandbox properties for the widget
DisplayName	Sandbox Configuration
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sandboxconfiguration
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	2000

msdyn_SortOrder

Property	Value
Description	Select Channel Order as 0 for this Channel to take precedence over others.
DisplayName	Channel Order
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sortorder
RequiredLevel	ApplicationRequired
Type	Integer
MaxValue	1000
MinValue	0

msdyn_trusteddomain

Property	Value
Description	Domain to be added to inclusion list
DisplayName	Trusted Domain
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_trusteddomain
RequiredLevel	None
Type	String
Format	Url
FormatName	Url
ImeMode	Auto
IsLocalizable	False
MaxLength	2000

OverriddenCreatedOn

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

statecode

Property	Value
Description	Status of the Channel Provider
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	msdyn_ciprovider_statecode

statecode Choices/Options

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

statuscode

Property	Value
Description	Reason for the status of the Channel Provider
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	msdyn_ciprovider_statuscode

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

Read-only columns/attributes

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

• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OrganizationId
• VersionNumber

CreatedBy

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

CreatedOn

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

CreatedOnBehalfBy

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
Type	Lookup
Targets	systemuser

ModifiedBy

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

ModifiedOn

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

ModifiedOnBehalfBy

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
Type	Lookup
Targets	systemuser

OrganizationId

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

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

• lk_msdyn_ciprovider_createdby
• lk_msdyn_ciprovider_createdonbehalfby
• lk_msdyn_ciprovider_modifiedby
• lk_msdyn_ciprovider_modifiedonbehalfby
• msdyn_webresource_ciprovider_channelprovidericon
• organization_msdyn_ciprovider

lk_msdyn_ciprovider_createdby

One-To-Many Relationship: systemuser lk_msdyn_ciprovider_createdby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdby
ReferencingEntityNavigationPropertyName	createdby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_msdyn_ciprovider_createdonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_ciprovider_createdonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdonbehalfby
ReferencingEntityNavigationPropertyName	createdonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_msdyn_ciprovider_modifiedby

One-To-Many Relationship: systemuser lk_msdyn_ciprovider_modifiedby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedby
ReferencingEntityNavigationPropertyName	modifiedby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_msdyn_ciprovider_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_ciprovider_modifiedonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedonbehalfby
ReferencingEntityNavigationPropertyName	modifiedonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

msdyn_webresource_ciprovider_channelprovidericon

One-To-Many Relationship: webresource msdyn_webresource_ciprovider_channelprovidericon

Property	Value
ReferencedEntity	webresource
ReferencedAttribute	webresourceid
ReferencingAttribute	msdyn_channelprovidericon
ReferencingEntityNavigationPropertyName	msdyn_channelprovidericon
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

organization_msdyn_ciprovider

One-To-Many Relationship: organization organization_msdyn_ciprovider

Property	Value
ReferencedEntity	organization
ReferencedAttribute	organizationid
ReferencingAttribute	organizationid
ReferencingEntityNavigationPropertyName	organizationid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

• msdyn_ciprovider_AsyncOperations
• msdyn_ciprovider_BulkDeleteFailures
• msdyn_ciprovider_DuplicateBaseRecord
• msdyn_ciprovider_DuplicateMatchingRecord
• msdyn_ciprovider_MailboxTrackingFolders
• msdyn_ciprovider_PrincipalObjectAttributeAccesses
• msdyn_ciprovider_ProcessSession
• msdyn_ciprovider_SyncErrors

msdyn_ciprovider_AsyncOperations

Many-To-One Relationship: asyncoperation msdyn_ciprovider_AsyncOperations

Property	Value
ReferencingEntity	asyncoperation
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_ciprovider_AsyncOperations
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ciprovider_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure msdyn_ciprovider_BulkDeleteFailures

Property	Value
ReferencingEntity	bulkdeletefailure
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_ciprovider_BulkDeleteFailures
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ciprovider_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord msdyn_ciprovider_DuplicateBaseRecord

Property	Value
ReferencingEntity	duplicaterecord
ReferencingAttribute	baserecordid
ReferencedEntityNavigationPropertyName	msdyn_ciprovider_DuplicateBaseRecord
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ciprovider_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord msdyn_ciprovider_DuplicateMatchingRecord

Property	Value
ReferencingEntity	duplicaterecord
ReferencingAttribute	duplicaterecordid
ReferencedEntityNavigationPropertyName	msdyn_ciprovider_DuplicateMatchingRecord
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ciprovider_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder msdyn_ciprovider_MailboxTrackingFolders

Property	Value
ReferencingEntity	mailboxtrackingfolder
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_ciprovider_MailboxTrackingFolders
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ciprovider_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess msdyn_ciprovider_PrincipalObjectAttributeAccesses

Property	Value
ReferencingEntity	principalobjectattributeaccess
ReferencingAttribute	objectid
ReferencedEntityNavigationPropertyName	msdyn_ciprovider_PrincipalObjectAttributeAccesses
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ciprovider_ProcessSession

Many-To-One Relationship: processsession msdyn_ciprovider_ProcessSession

Property	Value
ReferencingEntity	processsession
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_ciprovider_ProcessSession
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ciprovider_SyncErrors

Many-To-One Relationship: syncerror msdyn_ciprovider_SyncErrors

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	msdyn_ciprovider_SyncErrors
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

Many-to-Many relationships

These relationships are many-to-many. Listed by SchemaName.

msdyn_ciprovider_systemuser_membership

See systemuser msdyn_ciprovider_systemuser_membership Many-To-Many Relationship

Property	Value
IntersectEntityName	msdyn_ciprovider_systemuser
IsCustomizable	True
SchemaName	msdyn_ciprovider_systemuser_membership
IntersectAttribute	msdyn_ciproviderid
NavigationPropertyName	msdyn_ciprovider_systemuser_membership
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference