Modifier

Partager via

NavigationSetting entity reference

  • Article

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

Message SDK class or method
Create CreateRequest or
Create
Delete DeleteRequest or
Delete
Retrieve RetrieveRequest or
Retrieve
RetrieveMultiple RetrieveMultipleRequest or
RetrieveMultiple
RetrieveUnpublishedMultiple RetrieveUnpublishedMultipleRequest
Update UpdateRequest or
Update

Properties

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

Writable attributes

These 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
Format None
IsValidForForm False
IsValidForRead True
LogicalName advancedsettingorder
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

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

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
FormatName Text
IsLocalizable True
IsValidForForm False
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type String

GroupName

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

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
FormatName VersionNumber
IsLocalizable False
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName introducedversion
MaxLength 100
RequiredLevel None
Type String

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
FormatName Text
IsLocalizable True
IsValidForForm False
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel SystemRequired
Type String

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
IsValidForUpdate False
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
Format None
IsValidForForm False
IsValidForRead True
LogicalName objecttypecode
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

PageUrl

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

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
Format None
IsValidForForm False
IsValidForRead True
LogicalName privileges
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

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

ProgressState Choices/Options

Value Label Description
1 Visited
0 Not Visited

DefaultValue: 0

QuickSettingOrder

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

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

SettingType Choices/Options

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

Read-only attributes

These attributes return false for both IsValidForCreate or 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

ComponentState Choices/Options

Value Label Description
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
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 CRM 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 False
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 SystemRequired
Type String

ImportSequenceNumber

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

IsManaged

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

IsManaged Choices/Options

Value Label Description
1 Managed
0 Unmanaged

DefaultValue: 0

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

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 CRM options.
DisplayName Modified On
Format DateAndTime
IsValidForForm False
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 False
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 SystemRequired
Type String

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

OrganizationIdName

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

OverriddenCreatedOn

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

OverwriteTime

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

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

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_navigationsetting_modifiedonbehalfby

See the lk_navigationsetting_modifiedonbehalfby one-to-many relationship for the systemuser entity.

navigationsetting_appconfig

See the navigationsetting_appconfig one-to-many relationship for the appconfig entity.

lk_navigationsetting_createdonbehalfby

See the lk_navigationsetting_createdonbehalfby one-to-many relationship for the systemuser entity.

lk_navigationsetting_createdby

See the lk_navigationsetting_createdby one-to-many relationship for the systemuser entity.

lk_navigationsetting_modifiedby

See the lk_navigationsetting_modifiedby one-to-many relationship for the systemuser entity.

organization_navigationsetting

See the organization_navigationsetting one-to-many relationship for the organization entity.

See also

About the Entity Reference
Web API EntityType Reference