RollupField entity reference
Field to be rolled up to calculate the actual and in-progress values against the goal.
Messages
Message | SDK class or method |
---|---|
Create | CreateRequest or Create |
Delete | DeleteRequest or Delete |
Retrieve | RetrieveRequest or Retrieve |
RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
Update | UpdateRequest or Update |
Properties
Property | Value |
---|---|
CollectionSchemaName | RollupFields |
DisplayCollectionName | Rollup Fields |
DisplayName | Rollup Field |
EntitySetName | rollupfields |
IsBPFEntity | False |
LogicalCollectionName | rollupfields |
LogicalName | rollupfield |
OwnershipType | None |
PrimaryIdAttribute | rollupfieldid |
PrimaryNameAttribute | |
SchemaName | RollupField |
Writable attributes
These 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 |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | dateattribute |
MaxLength | 100 |
RequiredLevel | ApplicationRequired |
Type | String |
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 |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | goalattribute |
MaxLength | 100 |
RequiredLevel | ApplicationRequired |
Type | String |
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 |
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 |
IsValidForUpdate | False |
LogicalName | isstateparententityattribute |
RequiredLevel | None |
Type | Boolean |
IsStateParentEntityAttribute Choices/Options
Value | Label | Description |
---|---|---|
1 | Yes | |
0 | No |
DefaultValue: 0
MetricId
Property | Value |
---|---|
Description | Unique identifier of the goal metric associated with the rollup field. |
DisplayName | Goal Metric |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | metricid |
RequiredLevel | ApplicationRequired |
Targets | metric |
Type | Lookup |
RollupFieldId
Property | Value |
---|---|
Description | Unique identifier of the rollup field. |
DisplayName | Rollup Field |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
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 |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | sourceattribute |
MaxLength | 100 |
RequiredLevel | ApplicationRequired |
Type | String |
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 |
IsValidForUpdate | False |
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 |
Format | None |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | sourcestate |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
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 |
Format | None |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | sourcestatus |
MaxValue | 2147483647 |
MinValue | -2147483648 |
RequiredLevel | None |
Type | Integer |
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 attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedByName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- MetricIdName
- ModifiedBy
- ModifiedByName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- VersionNumber
CreatedBy
Property | Value |
---|---|
Description | Shows who created the record. |
DisplayName | Created By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
CreatedByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
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 |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
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 |
Targets | systemuser |
Type | Lookup |
CreatedOnBehalfByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
CreatedOnBehalfByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
MetricIdName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | metricidname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedBy
Property | Value |
---|---|
Description | Shows who last updated the record. |
DisplayName | Modified By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Targets | systemuser |
Type | Lookup |
ModifiedByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedOn
Property | Value |
---|---|
DateTimeBehavior | UserLocal |
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 |
Format | DateAndTime |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
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 |
Targets | systemuser |
Type | Lookup |
ModifiedOnBehalfByName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
ModifiedOnBehalfByYomiName
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
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 |
Targets | |
Type | Lookup |
VersionNumber
Property | Value |
---|---|
Description | Version number of the rollup field. |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
rollupfield_ProcessSessions
Same as the rollupfield_ProcessSessions many-to-one relationship for the processsession entity.
Property | Value |
---|---|
ReferencingEntity | processsession |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | rollupfield_ProcessSessions |
AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 110 |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
RollupField_SyncErrors
Same as the RollupField_SyncErrors many-to-one relationship for the syncerror entity.
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | True |
ReferencedEntityNavigationPropertyName | RollupField_SyncErrors |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade |
rollupfield_AsyncOperations
Same as the rollupfield_AsyncOperations many-to-one relationship for the asyncoperation entity.
Property | Value |
---|---|
ReferencingEntity | asyncoperation |
ReferencingAttribute | regardingobjectid |
IsHierarchical | False |
IsCustomizable | False |
ReferencedEntityNavigationPropertyName | rollupfield_AsyncOperations |
AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
- lk_rollupfield_createdby
- lk_rollupfield_createdonbehalfby
- lk_rollupfield_modifiedby
- lk_rollupfield_modifiedonbehalfby
- metric_rollupfield
lk_rollupfield_createdby
See the lk_rollupfield_createdby one-to-many relationship for the systemuser entity.
lk_rollupfield_createdonbehalfby
See the lk_rollupfield_createdonbehalfby one-to-many relationship for the systemuser entity.
lk_rollupfield_modifiedby
See the lk_rollupfield_modifiedby one-to-many relationship for the systemuser entity.
lk_rollupfield_modifiedonbehalfby
See the lk_rollupfield_modifiedonbehalfby one-to-many relationship for the systemuser entity.
metric_rollupfield
See the metric_rollupfield one-to-many relationship for the metric entity.