Convert-NAVCustomization

  • Reference
Module:
Microsoft.BusinessCentral.Management

Converts user personalizations in the Business Central database to the latest version.

Syntax

Convert-NAVCustomization
       [-ServerInstance] <String>
       [-Tenant <TenantId>]
       -UserSid <Guid>
       [-Force]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Convert-NAVCustomization
       [-ServerInstance] <String>
       [-Tenant <TenantId>]
       [-AllUsers]
       [-Force]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Convert-NAVCustomization
       [-ServerInstance] <String>
       [-Tenant <TenantId>]
       -ProfileId <String>
       [-ExportPath <String>]
       [-OverwriteExisting]
       [-Force]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Convert-NAVCustomization
       [-ServerInstance] <String>
       [-Tenant <TenantId>]
       [-AllProfiles]
       [-ExportPath <String>]
       [-OverwriteExisting]
       [-Force]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

In the Business Central, client users can personalize pages (like adding, hiding, and moving page elements like fields, actions and parts). Personalization can be done using the Business Central Web client or the Dynamics NAV Client Connected to Business Central (formerly the Windows client). However, the Dynamics NAV Client and early versions of the Business Central use a different version of personalization than the current Business Central release.

Because of this version difference, users are locked from personalizing a page in the current Business Central Web client if the page was previously only personalized using the Dynamics NAV Client or an early version of Business Central. Users can choose to unlock the page and continue. Unlocking a page converts the old personalization to new version, but it also disconnects the personalization between the Business Central Web client and the Dynamics NAV Client.

You use the Convert-NAVCustomization cmdlet to globally convert all page personalizations from the old version to the latest version; essentially unlocking the pages for users in advance, so they can start personalizing them in the Business Central Web client. You have the option to convert personalization for a specific user or for all users.

Examples

EXAMPLE 1

Convert-NAVCustomization -ServerInstance BusinessCentral -UserSid 00000000-0000-0000-0000-000000000001

This example converts the personalizations stored for the default SUPER user.

EXAMPLE 2

Convert-NAVCustomization -ServerInstance BusinessCentral -AllUsers

This example converts all of the personalizations for all users.

Parameters

-AllProfiles

Specifies to convert all profiles.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-AllUsers

Specifies that all user personalizations are to be converted.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExportPath

Specifies the path and file name to where you want to export the converted profile(s). Profiles are exported as a ZIP compressed file, so the file name must have the .zip file extension.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OverwriteExisting

Specifies that existing profiles and their corresponding customization should be overwritten. This applies to both saving in the database and exporting to a zip file.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProfileId

Specifies the name of the profile to convert.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProgressAction

A common PowerShell parameter that determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider. Learn more.

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Specifies the Business Central Server instance for the customization.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Tenant

Specifies the ID of the tenant where the user resides, such as Tenant1. You can specify the value default if the specified server instance is not configured for multiple tenants. Alternatively, do not set the parameter.

Type:TenantId
Aliases:Id
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserSid

Specifies the security ID of the Business Central user whose personalization you want to convert.

Type:Guid
Position:Named
Default value:00000000-0000-0000-0000-000000000000
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

By value and by property name: ServerInstance

System.Guid

By property name: UserSid

System.Management.Automation.SwitchParameter

By property name: AllUsers

Microsoft.Dynamics.Nav.Types.TenantId

By property name: Tenant