User Dashboard (UserForm) entity reference
User-owned dashboards.
Messages
| Message | SDK class or method |
|---|---|
| Assign | AssignRequest |
| Create | CreateRequest or Create |
| Delete | DeleteRequest or Delete |
| GrantAccess | GrantAccessRequest |
| ModifyAccess | ModifyAccessRequest |
| Retrieve | RetrieveRequest or Retrieve |
| RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
| RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
| RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
| RevokeAccess | RevokeAccessRequest |
| Update | UpdateRequest or Update |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | UserForms |
| DisplayCollectionName | User Dashboards |
| DisplayName | User Dashboard |
| EntitySetName | userforms |
| IsBPFEntity | False |
| LogicalCollectionName | userforms |
| LogicalName | userform |
| OwnershipType | UserOwned |
| PrimaryIdAttribute | userformid |
| PrimaryNameAttribute | name |
| SchemaName | UserForm |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- Description
- FormJson
- FormXml
- IsTabletEnabled
- Name
- ObjectTypeCode
- OwnerId
- OwnerIdType
- Type
- UserFormId
Description
| Property | Value |
|---|---|
| Description | Type additional information to describe the form or dashboard, such as the filter criteria or intended audience. |
| DisplayName | Description |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | description |
| MaxLength | 2000 |
| RequiredLevel | None |
| Type | Memo |
FormJson
| Property | Value |
|---|---|
| Description | Json representation of the form layout. |
| DisplayName | Json representation of the form layout. |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formjson |
| MaxLength | 1073741823 |
| RequiredLevel | None |
| Type | Memo |
FormXml
| Property | Value |
|---|---|
| Description | Shows the XML representation of the layout of the form or dashboard. |
| DisplayName | |
| Format | TextArea |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | formxml |
| MaxLength | 1073741823 |
| RequiredLevel | None |
| Type | Memo |
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 |
IsTabletEnabled Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 0
Name
| Property | Value |
|---|---|
| Description | Type a descriptive name for the form or dashboard. |
| DisplayName | Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | name |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ObjectTypeCode
| Property | Value |
|---|---|
| Description | Shows the record type (entity) code that the form applies to. |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | objecttypecode |
| RequiredLevel | None |
| Type | EntityName |
OwnerId
| Property | Value |
|---|---|
| Description | Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user. |
| DisplayName | Owner |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ownerid |
| RequiredLevel | SystemRequired |
| Targets | systemuser,team |
| Type | Owner |
OwnerIdType
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridtype |
| RequiredLevel | SystemRequired |
| Type | EntityName |
Type
| Property | Value |
|---|---|
| Description | Select the form type. |
| DisplayName | Form Type |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | type |
| RequiredLevel | None |
| Type | Picklist |
Type Choices/Options
| Value | Label | Description |
|---|---|---|
| 0 | Dashboard | |
| 103 | Power BI Dashboard |
UserFormId
| Property | Value |
|---|---|
| Description | Unique identifier of the user dashboard. |
| DisplayName | User Dashboard |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | userformid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OwnerIdName
- OwnerIdYomiName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- VersionNumber
CreatedBy
| Property | Value |
|---|---|
| Description | Shows who created the record. |
| DisplayName | Created By |
| IsValidForForm | False |
| 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 |
CreatedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyyominame |
| 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 | False |
| 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 |
ModifiedBy
| Property | Value |
|---|---|
| Description | Shows who last updated the record. |
| DisplayName | Modified By |
| IsValidForForm | False |
| 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 |
ModifiedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyyominame |
| 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 | False |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
ModifiedOnBehalfBy
| Property | Value |
|---|---|
| Description | Shows who created the record on behalf of another user. |
| DisplayName | Created 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 |
OwnerIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwnerIdYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwningBusinessUnit
| Property | Value |
|---|---|
| Description | Shows the business unit that the record owner belongs to. |
| DisplayName | Owning Business Unit |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningbusinessunit |
| RequiredLevel | None |
| Targets | businessunit |
| Type | Lookup |
OwningTeam
| Property | Value |
|---|---|
| Description | Unique identifier of the team who owns the dashboard. |
| DisplayName | Owning Team |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningteam |
| RequiredLevel | None |
| Targets | team |
| Type | Lookup |
OwningUser
| Property | Value |
|---|---|
| Description | Unique identifier of the user who owns the dashboard. |
| DisplayName | Owning User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owninguser |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
VersionNumber
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
UserForm_AsyncOperations
Same as the UserForm_AsyncOperations many-to-one relationship for the asyncoperation entity.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | UserForm_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
UserForm_BulkDeleteFailures
Same as the UserForm_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure entity.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | UserForm_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| 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 entity. Listed by SchemaName.
- lk_userformbase_modifiedonbehalfby
- lk_userformbase_createdonbehalfby
- team_userform
- lk_userform_createdby
- lk_userform_modifiedby
- user_userform
- business_unit_userform
lk_userformbase_modifiedonbehalfby
See the lk_userformbase_modifiedonbehalfby one-to-many relationship for the systemuser entity.
lk_userformbase_createdonbehalfby
See the lk_userformbase_createdonbehalfby one-to-many relationship for the systemuser entity.
team_userform
See the team_userform one-to-many relationship for the team entity.
lk_userform_createdby
See the lk_userform_createdby one-to-many relationship for the systemuser entity.
lk_userform_modifiedby
See the lk_userform_modifiedby one-to-many relationship for the systemuser entity.
user_userform
See the user_userform one-to-many relationship for the systemuser entity.
business_unit_userform
See the business_unit_userform one-to-many relationship for the businessunit entity.