Edit

Real Time Streaming Analytics KPI Definition (msdyn_ccrtakpidefinition) table/entity reference (Microsoft Dynamics 365)

A custom KPI calculated from other Contact Center real time streaming analytics metrics.

Messages

The following table lists the messages for the Real Time Streaming Analytics KPI Definition (msdyn_ccrtakpidefinition) 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
Assign
Event: True		 PATCH /msdyn_ccrtakpidefinitions(msdyn_ccrtakpidefinitionid)
Update the ownerid property.		 AssignRequest
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_ccrtakpidefinitions
See Create		 Create records
CreateMultiple
Event: True		 CreateMultiple CreateMultipleRequest
Delete
Event: True		 DELETE /msdyn_ccrtakpidefinitions(msdyn_ccrtakpidefinitionid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
GrantAccess
Event: True		 GrantAccess GrantAccessRequest
IsValidStateTransition
Event: False		 IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess
Event: True		 ModifyAccess ModifyAccessRequest
PurgeRetainedContent
Event: True		 PurgeRetainedContent 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_ccrtakpidefinitions(msdyn_ccrtakpidefinitionid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: True		 GET /msdyn_ccrtakpidefinitions
See Query data		 Query data
RetrievePrincipalAccess
Event: True		 RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True		 RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True		 RevokeAccess RevokeAccessRequest
RollbackRetain
Event: True		 RollbackRetain Learn to use messages with the SDK for .NET
SetState
Event: True		 PATCH /msdyn_ccrtakpidefinitions(msdyn_ccrtakpidefinitionid)
Update the statecode and statuscode properties.		 SetStateRequest
Update
Event: True		 PATCH /msdyn_ccrtakpidefinitions(msdyn_ccrtakpidefinitionid)
See Update		 Update records
UpdateMultiple
Event: True		 UpdateMultiple UpdateMultipleRequest
Upsert
Event: False		 PATCH /msdyn_ccrtakpidefinitions(msdyn_ccrtakpidefinitionid)
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 Real Time Streaming Analytics KPI Definition (msdyn_ccrtakpidefinition) table.

Property Value
DisplayName Real Time Streaming Analytics KPI Definition
DisplayCollectionName Real Time Streaming Analytics KPI Definitions
SchemaName msdyn_ccrtakpidefinition
CollectionSchemaName msdyn_ccrtakpidefinitions
EntitySetName msdyn_ccrtakpidefinitions
LogicalName msdyn_ccrtakpidefinition
LogicalCollectionName msdyn_ccrtakpidefinitions
PrimaryIdAttribute msdyn_ccrtakpidefinitionid
PrimaryNameAttribute msdyn_name
TableType Standard
OwnershipType UserOwned

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
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

IsCustomizable

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

msdyn_category

Property Value
Description Grouping category for the KPI (for example, Customer Experience or Operational).
DisplayName Category
IsValidForForm True
IsValidForRead True
LogicalName msdyn_category
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 50

msdyn_ccrtakpidefinitionId

Property Value
Description Unique identifier for entity instances
DisplayName Real Time Streaming Analytics KPI Definition
IsValidForForm False
IsValidForRead True
LogicalName msdyn_ccrtakpidefinitionid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_description

Property Value
Description Description of what this KPI measures and how to interpret it.
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName msdyn_description
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 4000

msdyn_enabled

Property Value
Description When enabled, this KPI is active. When disabled, it is kept but not used.
DisplayName Enabled
IsValidForForm True
IsValidForRead True
LogicalName msdyn_enabled
RequiredLevel None
Type Boolean
GlobalChoiceName msdyn_ccrtakpidefinition_msdyn_enabled
DefaultValue True
True Label Yes
False Label No

msdyn_formatpattern

Property Value
Description Optional display format for the KPI value (for example, 0.0% or #,##0).
DisplayName Format Pattern
IsValidForForm True
IsValidForRead True
LogicalName msdyn_formatpattern
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 50

msdyn_formula

Property Value
Description Defines how this KPI is calculated from other metrics.
DisplayName Formula
IsValidForForm True
IsValidForRead True
LogicalName msdyn_formula
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 32768

msdyn_name

Property Value
Description Display name of the KPI (for example, Abandoned Rate).
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName msdyn_name
RequiredLevel ApplicationRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 200

msdyn_schemaversion

Property Value
Description Version of the KPI definition.
DisplayName Schema Version
IsValidForForm True
IsValidForRead True
LogicalName msdyn_schemaversion
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

msdyn_unit

Property Value
Description Unit of the computed result. One of: count, seconds, percent, score, currency.
DisplayName Unit
IsValidForForm True
IsValidForRead True
LogicalName msdyn_unit
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 20

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

OwnerId

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Type Owner
Targets systemuser, team

OwnerIdType

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

statecode

Property Value
Description Status of the Real Time Streaming Analytics KPI Definition
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName msdyn_ccrtakpidefinition_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 Real Time Streaming Analytics KPI Definition
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue
GlobalChoiceName msdyn_ccrtakpidefinition_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.

ComponentIdUnique

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue
GlobalChoiceName componentstate

ComponentState Choices/Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

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

IsManaged

Property Value
Description Indicates whether the solution component is part of a managed solution.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

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

OverwriteTime

Property Value
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

OwnerIdName

Property Value
Description Name of the owner
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Type Lookup
Targets businessunit

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Type Lookup
Targets team

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Type Lookup
Targets systemuser

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

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.

business_unit_msdyn_ccrtakpidefinition

One-To-Many Relationship: businessunit business_unit_msdyn_ccrtakpidefinition

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute owningbusinessunit
ReferencingEntityNavigationPropertyName owningbusinessunit
IsHierarchical
CascadeConfiguration Archive: Restrict
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_ccrtakpidefinition_createdby

One-To-Many Relationship: systemuser lk_msdyn_ccrtakpidefinition_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_ccrtakpidefinition_createdonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_ccrtakpidefinition_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_ccrtakpidefinition_modifiedby

One-To-Many Relationship: systemuser lk_msdyn_ccrtakpidefinition_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_ccrtakpidefinition_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_ccrtakpidefinition_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

owner_msdyn_ccrtakpidefinition

One-To-Many Relationship: owner owner_msdyn_ccrtakpidefinition

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

team_msdyn_ccrtakpidefinition

One-To-Many Relationship: team team_msdyn_ccrtakpidefinition

Property Value
ReferencedEntity team
ReferencedAttribute teamid
ReferencingAttribute owningteam
ReferencingEntityNavigationPropertyName owningteam
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

user_msdyn_ccrtakpidefinition

One-To-Many Relationship: systemuser user_msdyn_ccrtakpidefinition

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute owninguser
ReferencingEntityNavigationPropertyName owninguser
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_ccrtakpidefinition_AsyncOperations

Many-To-One Relationship: asyncoperation msdyn_ccrtakpidefinition_AsyncOperations

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

msdyn_ccrtakpidefinition_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure msdyn_ccrtakpidefinition_BulkDeleteFailures

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

msdyn_ccrtakpidefinition_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder msdyn_ccrtakpidefinition_MailboxTrackingFolders

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

msdyn_ccrtakpidefinition_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess msdyn_ccrtakpidefinition_PrincipalObjectAttributeAccesses

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

msdyn_ccrtakpidefinition_ProcessSession

Many-To-One Relationship: processsession msdyn_ccrtakpidefinition_ProcessSession

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

msdyn_ccrtakpidefinition_SyncErrors

Many-To-One Relationship: syncerror msdyn_ccrtakpidefinition_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_ccrtakpidefinition_SyncErrors
IsCustomizable True
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

  • Last updated on