Edit

Share via

Navigation Setting (NavigationSetting) table/entity reference (Microsoft Dataverse)

Navigation Setting: A setting page or group of pages available for configuration within an app. A record representing a group of pages is regarded as the parent navigation setting of one or more other records. For internal use only.

Messages

The following table lists the messages for the Navigation Setting (NavigationSetting) 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 /navigationsettings
See Create		 Create records
Delete
Event: True		 DELETE /navigationsettings(navigationsettingid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
Retrieve
Event: False		 GET /navigationsettings(navigationsettingid)
See Retrieve		 Retrieve records
RetrieveMultiple
Event: False		 GET /navigationsettings
See Query data		 Query data
RetrieveUnpublishedMultiple
Event: False		 RetrieveUnpublishedMultiple RetrieveUnpublishedMultipleRequest
Update
Event: True		 PATCH /navigationsettings(navigationsettingid)
See Update		 Update records
Upsert
Event: False		 PATCH /navigationsettings(navigationsettingid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the Navigation Setting (NavigationSetting) table.

Property Value
DisplayName Navigation Setting
DisplayCollectionName Navigation Settings
SchemaName NavigationSetting
CollectionSchemaName NavigationSettings
EntitySetName navigationsettings
LogicalName navigationsetting
LogicalCollectionName navigationsettings
PrimaryIdAttribute navigationsettingid
PrimaryNameAttribute name
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

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

AdvancedSettingOrder

Property Value
Description Enter the position of this NavigationSetting as it should appear within its group in the Advanced Setup menu.
DisplayName AdvancedOrder
IsValidForForm False
IsValidForRead True
LogicalName advancedsettingorder
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

AppConfigId

Property Value
Description Enter the App Config record that this Navigation Setting is associated with.
DisplayName AppConfigId
IsValidForForm False
IsValidForRead True
LogicalName appconfigid
RequiredLevel ApplicationRequired
Type Lookup
Targets appmodule

AppConfigIdUnique

Property Value
Description For system use only.
DisplayName AppConfigIdUnique
IsValidForForm False
IsValidForRead True
LogicalName appconfigidunique
RequiredLevel None
Type Uniqueidentifier

Description

Property Value
Description Type a description that describes that Navigation Setting in detail.
DisplayName Description
IsValidForForm False
IsValidForRead True
LogicalName description
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable True
MaxLength 2000

GroupName

Property Value
Description Type the name of the group represented by this Navigation Setting record.
DisplayName Group Name
IsValidForForm False
IsValidForRead True
LogicalName groupname
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable True
MaxLength 400

IconResourceId

Property Value
Description The web resource identifier of the icon to be used for a navigation setting area or sub area.
DisplayName IconResourceId
IsValidForForm False
IsValidForRead True
LogicalName iconresourceid
RequiredLevel None
Type Uniqueidentifier

IntroducedVersion

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

Name

Property Value
Description Type a title or name that describes the Navigation Setting so it can be identified in Dynamics CRM views.
DisplayName Name
IsValidForForm False
IsValidForRead True
LogicalName name
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable True
MaxLength 100

NavigationSettingId

Property Value
Description Identifies a single setting page or group of pages configured for use in a single app.
DisplayName NavigationSettingId
IsValidForForm False
IsValidForRead True
LogicalName navigationsettingid
RequiredLevel SystemRequired
Type Uniqueidentifier

NavigationSettingIdUnique

Property Value
Description For system use only.
DisplayName NavigationSettingIdUnique
IsValidForForm False
IsValidForRead True
LogicalName navigationsettingidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ObjectTypeCode

Property Value
Description Enter the Object Type Code of the entity associated whose page this Navigation Setting record represents.
DisplayName EntityObjectTypeCode
IsValidForForm False
IsValidForRead True
LogicalName objecttypecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

PageUrl

Property Value
Description Type the URL which locates the page associated with this Navigation Setting record.
DisplayName Page Url
IsValidForForm False
IsValidForRead True
LogicalName pageurl
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 400

ParentNavigationSettingId

Property Value
Description The Navigation Setting record that represents the group that this record belongs to.
DisplayName Parent Navigation Setting Id
IsValidForForm False
IsValidForRead True
LogicalName parentnavigationsettingid
RequiredLevel None
Type Uniqueidentifier

Privileges

Property Value
Description Enter the Privilege Mask for the entity associated with this navigation setting page that will be the minimum requirement for the page to be made available to a user.
DisplayName Privileges
IsValidForForm False
IsValidForRead True
LogicalName privileges
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

ProgressState

Property Value
Description Select the setup completion level for this Navigation Setting page.
DisplayName Progress State
IsValidForForm False
IsValidForRead True
LogicalName progressstate
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName navigationsetting_progressstate
DefaultValue False
True Label Visited
False Label Not Visited

QuickSettingOrder

Property Value
Description Enter the position of this NavigationSetting as it should appear in the Quick Setup menu.
DisplayName QuickOrder
IsValidForForm False
IsValidForRead True
LogicalName quicksettingorder
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue 0

ResourceId

Property Value
Description The Web Resource that will be associated with this Navigation Setting record.
DisplayName Resource Id
IsValidForForm False
IsValidForRead True
LogicalName resourceid
RequiredLevel None
Type Uniqueidentifier

SettingType

Property Value
Description Select the type of group this Navigation Setting record represents. This determines which of the three in-app customization menus will contain this group.
DisplayName Group Type
IsValidForForm False
IsValidForRead True
LogicalName settingtype
RequiredLevel None
Type Picklist
DefaultFormValue
GlobalChoiceName navigationsetting_settingtype

SettingType Choices/Options

Value Label
0 Advanced Setup
1 Basic Setup
2 Advanced Setup Summary
3 Basic Setup Summary

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

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm False
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 CRM options.
DisplayName Created On
IsValidForForm False
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 False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

ImportSequenceNumber

Property Value
Description Unique identifier of the data import or data migration that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

IsManaged

Property Value
Description For internal use only.
DisplayName Is Managed
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm False
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 CRM options.
DisplayName Modified On
IsValidForForm False
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 False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

OrganizationId

Property Value
Description System-populated field that identifies the organization that owns this Navigation Setting record.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Type Lookup
Targets organization

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

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

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

Many-to-One relationships

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

lk_navigationsetting_createdby

One-To-Many Relationship: systemuser lk_navigationsetting_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName navigationsetting_createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_navigationsetting_createdonbehalfby

One-To-Many Relationship: systemuser lk_navigationsetting_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName navigationsetting_createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_navigationsetting_modifiedby

One-To-Many Relationship: systemuser lk_navigationsetting_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName navigationsetting_modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_navigationsetting_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_navigationsetting_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName navigationsetting_modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

navigationsetting_appconfig

One-To-Many Relationship: appconfig navigationsetting_appconfig

Property Value
ReferencedEntity appconfig
ReferencedAttribute appconfigid
ReferencingAttribute appconfigid
ReferencingEntityNavigationPropertyName navigationsetting_appconfig
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
RollupView: NoCascade
Share: Cascade
Unshare: Cascade

organization_navigationsetting

One-To-Many Relationship: organization organization_navigationsetting

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organization_navigationsetting_navigationsetting
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

See also

Dataverse table/entity reference
Dataverse Web API Reference
navigationsetting