Rollup Field (RollupField) table/entity reference (Microsoft Dataverse)

Article
01/21/2025

Field to be rolled up to calculate the actual and in-progress values against the goal.

Messages

The following table lists the messages for the Rollup Field (RollupField) 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
`Create` Event: True	`POST` /rollupfields See Create	Create records
`Delete` Event: True	`DELETE` /rollupfields(rollupfieldid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`Retrieve` Event: True	`GET` /rollupfields(rollupfieldid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /rollupfields See Query data	Query data
`Update` Event: True	`PATCH` /rollupfields(rollupfieldid) See Update	Update records
`Upsert` Event: False	`PATCH` /rollupfields(rollupfieldid) See Upsert a table row	UpsertRequest

Properties

The following table lists selected properties for the Rollup Field (RollupField) table.

Property	Value
DisplayName	Rollup Field
DisplayCollectionName	Rollup Fields
SchemaName	`RollupField`
CollectionSchemaName	`RollupFields`
EntitySetName	`rollupfields`
LogicalName	`rollupfield`
LogicalCollectionName	`rollupfields`
PrimaryIdAttribute	`rollupfieldid`
TableType	`Standard`
OwnershipType	`None`

Writable columns/attributes

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

DateAttribute
EntityForDateAttribute
GoalAttribute
ImportSequenceNumber
IsStateParentEntityAttribute
MetricId
RollupFieldId
SourceAttribute
SourceEntity
SourceState
SourceStatus
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

DateAttribute

Property	Value
Description	Select a date field for the selected record type, such as Actual Closed Date for the Opportunity record type. A record participates in the goal rollup, if the selected date falls between the start date and the end date for the goal.
DisplayName	Date Field
IsValidForForm	True
IsValidForRead	True
LogicalName	`dateattribute`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

EntityForDateAttribute

Property	Value
Description	Select the record type that contains the date field that will be considered while rolling up data to the goal.
DisplayName	Record Type
IsValidForForm	True
IsValidForRead	True
LogicalName	`entityfordateattribute`
RequiredLevel	ApplicationRequired
Type	EntityName

GoalAttribute

Property	Value
Description	Select a rollup field where the metric rollup data will be displayed in the goal. The options are an integer or money, depending on the Metric Type you chose for the goal metric.
DisplayName	Rollup Field
IsValidForForm	True
IsValidForRead	True
LogicalName	`goalattribute`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

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

IsStateParentEntityAttribute

Property	Value
Description	Tells whether the state or status belongs to the parent entity.
DisplayName	Is State/Status From Parent Entity
IsValidForForm	False
IsValidForRead	True
LogicalName	`isstateparententityattribute`
RequiredLevel	None
Type	Boolean
GlobalChoiceName	`rollupfield_isstatefromparent`
DefaultValue	False
True Label	Yes
False Label	No

MetricId

Property	Value
Description	Unique identifier of the goal metric associated with the rollup field.
DisplayName	Goal Metric
IsValidForForm	False
IsValidForRead	True
LogicalName	`metricid`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	metric

RollupFieldId

Property	Value
Description	Unique identifier of the rollup field.
DisplayName	Rollup Field
IsValidForForm	False
IsValidForRead	True
LogicalName	`rollupfieldid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SourceAttribute

Property	Value
Description	Type the name of the field that the data for the goal rolls up from.
DisplayName	Source Field
IsValidForForm	True
IsValidForRead	True
LogicalName	`sourceattribute`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

SourceEntity

Property	Value
Description	Type the name of the record type (entity) that the data for the goal must roll up from.
DisplayName	Source Record Type
IsValidForForm	True
IsValidForRead	True
LogicalName	`sourceentity`
RequiredLevel	ApplicationRequired
Type	EntityName

SourceState

Property	Value
Description	Select the state of the records you want to use as the source of the rollup data for the metric.
DisplayName	Source Record Type State
IsValidForForm	True
IsValidForRead	True
LogicalName	`sourcestate`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

SourceStatus

Property	Value
Description	Select the status of the records you want to use as the source of the rollup data for the metric.
DisplayName	Source Record Type Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`sourcestatus`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

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	Shows who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
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	Shows who created the record on behalf of another user.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedBy

Property	Value
Description	Shows who last updated the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
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	Shows who last updated the record on behalf of another user.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Choose the ID of the organization that the record is associated with.
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`organizationid`
RequiredLevel	None
Type	Lookup
Targets

VersionNumber

Property	Value
Description	Version number of the rollup field.
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_rollupfield_createdby
lk_rollupfield_createdonbehalfby
lk_rollupfield_modifiedby
lk_rollupfield_modifiedonbehalfby
metric_rollupfield

lk_rollupfield_createdby

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

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

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

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

metric_rollupfield

One-To-Many Relationship: metric metric_rollupfield

Property	Value
ReferencedEntity	`metric`
ReferencedAttribute	`metricid`
ReferencingAttribute	`metricid`
ReferencingEntityNavigationPropertyName	`metricid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `Cascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

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

rollupfield_AsyncOperations
rollupfield_ProcessSessions
RollupField_SyncErrors

rollupfield_AsyncOperations

Many-To-One Relationship: asyncoperation rollupfield_AsyncOperations

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

rollupfield_ProcessSessions

Many-To-One Relationship: processsession rollupfield_ProcessSessions

Property	Value
ReferencingEntity	`processsession`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`rollupfield_ProcessSessions`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 110 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

RollupField_SyncErrors

Many-To-One Relationship: syncerror RollupField_SyncErrors

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

Share via