Edit

Share via

msdyn_forecastdefinition table/entity reference

  • Article

Note

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

Defines the parameters used for forecasting.

Added by: Forecasting Solution

Messages

Message Web API Operation SDK class or method
Assign PATCH /msdyn_forecastdefinitions(msdyn_forecastdefinitionid)
Update ownerid property.		 AssignRequest
BulkRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Create POST /msdyn_forecastdefinitions
See Create		 CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /msdyn_forecastdefinitions(msdyn_forecastdefinitionid)
See Delete		 DeleteRequest or
Delete
GrantAccess GrantAccess GrantAccessRequest
IsValidStateTransition IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess ModifyAccess ModifyAccessRequest
PurgeRetainedContent This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retrieve GET /msdyn_forecastdefinitions(msdyn_forecastdefinitionid)
See Retrieve		 RetrieveRequest or
Retrieve
RetrieveMultiple GET /msdyn_forecastdefinitions
See Query Data		 RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess RevokeAccessRequest
RollbackRetain This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
SetState PATCH /msdyn_forecastdefinitions(msdyn_forecastdefinitionid)
Update statecode and statuscode properties.		 SetStateRequest
Update PATCH /msdyn_forecastdefinitions(msdyn_forecastdefinitionid)
See Update		 UpdateRequest or
Update
UpdateMultiple UpdateMultiple UpdateMultipleRequest
ValidateRetentionConfig This message is to be executed only by Dataverse to trigger registered plug-ins and flows.

Properties

Property Value
CollectionSchemaName msdyn_forecastdefinitions
DisplayCollectionName Forecast definitions
DisplayName Forecast definition
EntitySetName msdyn_forecastdefinitions
IsBPFEntity False
LogicalCollectionName msdyn_forecastdefinitions
LogicalName msdyn_forecastdefinition
OwnershipType UserOwned
PrimaryIdAttribute msdyn_forecastdefinitionid
PrimaryNameAttribute msdyn_forecastdefinitionname
SchemaName msdyn_forecastdefinition

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_fiscalmonth

Property Value
Description Select the fiscal month for the forecast definition.
DisplayName Fiscal month
IsValidForForm True
IsValidForRead True
LogicalName msdyn_fiscalmonth
RequiredLevel None
Type Picklist

msdyn_fiscalmonth Choices/Options

Value Label Description
0 January
1 February
2 March
3 April
4 May
5 June
6 July
7 August
8 September
9 October
10 November
11 December

msdyn_fiscalquarter

Property Value
Description Select the fiscal quarter for the forecast definition.
DisplayName Fiscal quarter
IsValidForForm True
IsValidForRead True
LogicalName msdyn_fiscalquarter
RequiredLevel None
Type Picklist

msdyn_fiscalquarter Choices/Options

Value Label Description
0 Q1
1 Q2
2 Q3
3 Q4

msdyn_fiscalyear

Property Value
Description Select the fiscal year for the forecast definition.
DisplayName Fiscal year
IsValidForForm True
IsValidForRead True
LogicalName msdyn_fiscalyear
RequiredLevel None
Type Picklist

msdyn_fiscalyear Choices/Options

Value Label Description
0 FY2018
1 FY2019
2 FY2020
3 FY2021
4 FY2022
5 FY2023
6 FY2024
7 FY2025
8 FY2026
9 FY2027
10 FY2028
11 FY2029
12 FY2030
13 FY2031
14 FY2032
15 FY2033
16 FY2034
17 FY2035
18 FY2036
19 FY2037
20 FY2038
21 FY2039
22 FY2040

msdyn_forecastdefinitionId

Property Value
Description Unique identifier for the forecast definition.
DisplayName Forecast definition
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_forecastdefinitionid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_forecastdefinitionname

Property Value
Description Name of the forecast definition.
DisplayName Forecast name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_forecastdefinitionname
MaxLength 100
RequiredLevel ApplicationRequired
Type String

msdyn_forecastperiodtype

Property Value
Description Select the type of period for which the forecast must be generated.
DisplayName Forecast period
IsValidForForm True
IsValidForRead True
LogicalName msdyn_forecastperiodtype
RequiredLevel ApplicationRequired
Type Picklist

msdyn_forecastperiodtype Choices/Options

Value Label Description
0 Monthly
1 Quarterly
2 Custom

msdyn_metricid

Property Value
Description Select metric to attach with forecast
DisplayName Forecast metric
IsValidForForm True
IsValidForRead True
LogicalName msdyn_metricid
RequiredLevel ApplicationRequired
Targets metric
Type Lookup

msdyn_numberofrecurrences

Property Value
Description Indicate the number of recurrences that the forecast will be generated.
DisplayName Number of recurrences
Format None
IsValidForForm True
IsValidForRead True
LogicalName msdyn_numberofrecurrences
MaxValue 12
MinValue 1
RequiredLevel ApplicationRequired
Type Integer

msdyn_quotasource

Property Value
Description Select whether the quota for the forecast must to be taken from a goal or entered manually.
DisplayName Quota source
IsValidForForm True
IsValidForRead True
LogicalName msdyn_quotasource
RequiredLevel ApplicationRequired
Type Picklist

msdyn_quotasource Choices/Options

Value Label Description
192350000 Goal-based
192350001 Manual

msdyn_rollupquery

Property Value
Description Select the query that will be used to calculate data for the rollup field.
DisplayName Rollup query
IsValidForForm True
IsValidForRead True
LogicalName msdyn_rollupquery
RequiredLevel None
Targets goalrollupquery
Type Lookup

msdyn_validfrom

Property Value
DateTimeBehavior DateOnly
Description Shows the date from which the forecast is applicable. The date and time are displayed in the time zone selected in Dynamics 365 Customer Engagement apps options.
DisplayName Valid from
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName msdyn_validfrom
RequiredLevel ApplicationRequired
Type DateTime

msdyn_validto

Property Value
DateTimeBehavior DateOnly
Description Shows the date till which the forecast is applicable. The date and time are displayed in the time zone selected in Dynamics 365 Customer Engagement apps options.
DisplayName Valid to
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName msdyn_validto
RequiredLevel ApplicationRequired
Type DateTime

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

OwnerId

Added by: Active Solution Solution

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

OwnerIdType

Added by: Active Solution Solution

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

statecode

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

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Draft 1 Draft
1 Published 2 Published

statuscode

Property Value
Description Reason for the status of the Forecast Definition
DisplayName Status reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
1 Draft 0
2 In progress 1
3 Success 1
4 Failed 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_metricidName

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

msdyn_rollupqueryName

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

OwnerIdName

Added by: Active Solution Solution

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

OwnerIdYomiName

Added by: Active Solution Solution

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

OwningBusinessUnit

Added by: Active Solution Solution

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

OwningBusinessUnitName

Added by: Active Solution Solution

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

OwningTeam

Added by: Active Solution Solution

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

OwningUser

Added by: Active Solution Solution

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

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

One-To-Many Relationships

Listed by SchemaName.

msdyn_msdyn_forecastdefinition_msdyn_forecastinstance

Same as the msdyn_msdyn_forecastdefinition_msdyn_forecastinstance many-to-one relationship for the msdyn_forecastinstance table/entity.

Property Value
ReferencingEntity msdyn_forecastinstance
ReferencingAttribute msdyn_forecastdefinitionid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName msdyn_msdyn_forecastdefinition_msdyn_forecastinstance
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_msdyn_forecastdefinition_msdyn_forecastrecurrence

Same as the msdyn_msdyn_forecastdefinition_msdyn_forecastrecurrence many-to-one relationship for the msdyn_forecastrecurrence table/entity.

Property Value
ReferencingEntity msdyn_forecastrecurrence
ReferencingAttribute msdyn_forecastdefinitionid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName msdyn_msdyn_forecastdefinition_msdyn_forecastrecurrence
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label: Unique identifier for Forecast Definition associated with Forecast Recurrence.
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: Cascade
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 table. Listed by SchemaName.

msdyn_metric_msdyn_forecastdefinition_metricid

Added by: System Solution Solution

See the msdyn_metric_msdyn_forecastdefinition_metricid one-to-many relationship for the metric table/entity.

msdyn_goalrollupquery_msdyn_forecastdefinition_rollupquery

Added by: System Solution Solution

See the msdyn_goalrollupquery_msdyn_forecastdefinition_rollupquery one-to-many relationship for the goalrollupquery table/entity.

Dataverse table/entity reference
Web API Reference