Edit

Share via

System Form (SystemForm) table/entity reference (Microsoft Dataverse)

Organization-owned entity customizations including form layout and dashboards.

Messages

The following table lists the messages for the System Form (SystemForm) 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
CopySystemForm
Event: True		 CopySystemForm CopySystemFormRequest
Create
Event: False		 POST /systemforms
See Create		 Create records
Delete
Event: False		 DELETE /systemforms(formid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
Retrieve
Event: False		 GET /systemforms(formid)
See Retrieve		 Retrieve records
RetrieveFilteredForms
Event: True		 RetrieveFilteredForms RetrieveFilteredFormsRequest
RetrieveMultiple
Event: False		 GET /systemforms
See Query data		 Query data
RetrieveUnpublished
Event: False		 RetrieveUnpublished RetrieveUnpublishedRequest
RetrieveUnpublishedMultiple
Event: False		 RetrieveUnpublishedMultiple RetrieveUnpublishedMultipleRequest
Update
Event: False		 PATCH /systemforms(formid)
See Update		 Update records
Upsert
Event: False		 PATCH /systemforms(formid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the System Form (SystemForm) table.

Property Value
DisplayName System Form
DisplayCollectionName System Forms
SchemaName SystemForm
CollectionSchemaName SystemForms
EntitySetName systemforms
LogicalName systemform
LogicalCollectionName systemforms
PrimaryIdAttribute formid
PrimaryNameAttribute name
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

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

AncestorFormId

Property Value
Description Unique identifier of the parent form.
DisplayName Parent Form
IsValidForForm True
IsValidForRead True
LogicalName ancestorformid
RequiredLevel None
Type Lookup
Targets systemform

CanBeDeleted

Property Value
Description Information that specifies whether this component can be deleted.
DisplayName Can Be Deleted
IsValidForForm False
IsValidForRead True
LogicalName canbedeleted
RequiredLevel SystemRequired
Type ManagedProperty

Description

Property Value
Description Description of the form or dashboard.
DisplayName Description
IsValidForForm False
IsValidForRead True
LogicalName description
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable True
MaxLength 2000

FormActivationState

Property Value
Description Specifies the state of the form.
DisplayName Form State
IsValidForForm False
IsValidForRead True
LogicalName formactivationstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue 1
GlobalChoiceName systemform_formactivationstate

FormActivationState Choices/Options

Value Label
0 Inactive
1 Active

FormId

Property Value
Description Unique identifier of the record type form.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName formid
RequiredLevel SystemRequired
Type Uniqueidentifier

FormJson

Property Value
Description Json representation of the form layout.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName formjson
RequiredLevel SystemRequired
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

FormPresentation

Property Value
Description Specifies whether this form is in the updated UI layout in Microsoft Dynamics CRM 2015 or Microsoft Dynamics CRM Online 2015 Update.
DisplayName AIR Refreshed
IsValidForForm False
IsValidForRead True
LogicalName formpresentation
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue 0
GlobalChoiceName systemform_formpresentation

FormPresentation Choices/Options

Value Label
0 ClassicForm
1 AirForm
2 ConvertedICForm

FormXml

Property Value
Description XML representation of the form layout.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName formxml
RequiredLevel SystemRequired
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

IntroducedVersion

Property Value
Description Version in which the form is introduced.
DisplayName Introduced Version
IsValidForForm False
IsValidForRead True
LogicalName introducedversion
RequiredLevel None
Type String
Format VersionNumber
FormatName VersionNumber
ImeMode Auto
IsLocalizable False
MaxLength 48

IsAIRMerged

Property Value
Description Specifies whether this form is merged with the updated UI layout in Microsoft Dynamics CRM 2015 or Microsoft Dynamics CRM Online 2015 Update.
DisplayName Refreshed
IsValidForForm False
IsValidForRead True
LogicalName isairmerged
RequiredLevel None
Type Boolean
GlobalChoiceName systemform_isairmerged
DefaultValue False
True Label Yes
False Label No

IsCustomizable

Property Value
Description Information that specifies whether this component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

IsDefault

Property Value
Description Information that specifies whether the form or the dashboard is the system default.
DisplayName Default Form
IsValidForForm False
IsValidForRead True
LogicalName isdefault
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName systemform_isdefault
DefaultValue False
True Label Yes
False Label No

IsDesktopEnabled

Property Value
Description Information that specifies whether the dashboard is enabled for desktop.
DisplayName Is Desktop Enabled
IsValidForForm False
IsValidForRead True
LogicalName isdesktopenabled
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName systemform_isdesktopenabled
DefaultValue False
True Label Yes
False Label No

IsTabletEnabled

Property Value
Description Information that specifies whether the dashboard is enabled for tablet.
DisplayName Is Tablet Enabled
IsValidForForm False
IsValidForRead True
LogicalName istabletenabled
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName systemform_istabletenabled
DefaultValue False
True Label Yes
False Label No

Name

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

ObjectTypeCode

Property Value
Description Code that represents the record type.
DisplayName Entity Name
IsValidForForm False
IsValidForRead True
LogicalName objecttypecode
RequiredLevel None
Type EntityName

Type

Property Value
Description Type of the form, for example, Dashboard or Preview.
DisplayName Form Type
IsValidForForm False
IsValidForRead True
LogicalName type
RequiredLevel None
Type Picklist
DefaultFormValue -1
GlobalChoiceName systemform_type

Type Choices/Options

Value Label
0 Dashboard
1 AppointmentBook
2 Main
3 MiniCampaignBO
4 Preview
5 Mobile - Express
6 Quick View Form
7 Quick Create
8 Dialog
9 Task Flow Form
10 InteractionCentricDashboard
11 Card
12 Main - Interactive experience
13 Contextual Dashboard
100 Other
101 MainBackup
102 AppointmentBookBackup
103 Power BI Dashboard

UniqueName

Property Value
Description Unique Name
DisplayName Unique Name
IsValidForForm False
IsValidForRead True
LogicalName uniquename
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 200

Version

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName version
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

Read-only columns/attributes

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

ComponentState

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

ComponentState Choices/Options

Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

FormIdUnique

Property Value
Description Unique identifier of the form used when synchronizing customizations for the Microsoft Dynamics 365 client for Outlook.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName formidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

FormXmlManaged

Property Value
Description formXml diff as in a managed solution. for internal use only
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName formxmlmanaged
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

IsManaged

Property Value
Description
DisplayName State
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

OrganizationId

Property Value
Description Unique identifier of the organization.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Type Lookup
Targets organization

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 DateOnly
ImeMode Inactive
SourceTypeMask 0

PublishedOn

Property Value
Description
DisplayName Published On
IsValidForForm False
IsValidForRead True
LogicalName publishedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

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 Represents a version of customizations to be synchronized with the Microsoft Dynamics 365 client for Outlook.
DisplayName
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.

form_ancestor_form

One-To-Many Relationship: systemform form_ancestor_form

Property Value
ReferencedEntity systemform
ReferencedAttribute formid
ReferencingAttribute ancestorformid
ReferencingEntityNavigationPropertyName ancestorformid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

organization_systemforms

One-To-Many Relationship: organization organization_systemforms

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.

form_ancestor_form

Many-To-One Relationship: systemform form_ancestor_form

Property Value
ReferencingEntity systemform
ReferencingAttribute ancestorformid
ReferencedEntityNavigationPropertyName form_ancestor_form
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

processtrigger_systemform

Many-To-One Relationship: processtrigger processtrigger_systemform

Property Value
ReferencingEntity processtrigger
ReferencingAttribute formid
ReferencedEntityNavigationPropertyName processtrigger_systemform
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

SystemForm_AsyncOperations

Many-To-One Relationship: asyncoperation SystemForm_AsyncOperations

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

SystemForm_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure SystemForm_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName SystemForm_BulkDeleteFailures
IsCustomizable False
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
systemform