Repair-NAVCustomization

Reference

Module:: Microsoft.BusinessCentral.Management

Repairs UI customizations that are saved in a tenant so that they work with the currently installed base application and extensions. UI customizations include profile customizations and user personalizations.

Syntax

Repair-NAVCustomization
      [-ServerInstance] <String>
      -UserSid <Guid>
      [-Tenant <TenantId>]
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Repair-NAVCustomization
      [-ServerInstance] <String>
      [-AllUsers]
      [-Tenant <TenantId>]
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Repair-NAVCustomization
      [-ServerInstance] <String>
      -ProfileId <String>
      -ProfileAppId <Guid>
      [-Tenant <TenantId>]
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Repair-NAVCustomization
      [-ServerInstance] <String>
      [-AllProfiles]
      [-Tenant <TenantId>]
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Repair-NAVCustomization cmdlet recompiles UI customizations against the current base application and installed extensions. You typically use the Repair-NAVCustomization cmdlet cmdlet when a new version of the base application or other extension has been installed to ensure that profile customizations and user personalizations work properly with any changes that might have been introduced by the new base application or extensions.

For personalizations, you can specify whether to repair personalizations for a specific user or for all users. For general information about user personalization in the client, see Personalize Your Workspace.

For profile customizations, you can specify whether to repair customizations for a specific profile or all profiles. For general information about user personalization in the client, see Customize Pages for Profiles.

It is recommended that the Business Central Server instance is restarted after running the repair.

Examples

EXAMPLE 1

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

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

EXAMPLE 2

Repair-NAVCustomization -ServerInstance BusinessCentral -AllUsers

This example repairs all of personalizations for all users.

EXAMPLE 3

Repair-NAVCustomization -ServerInstance BusinessCentral -ProfileId MyProfile -ProfileAppId 00000000-0000-0000-0000-000000000000

This example repairs the profile customizations stored for a user-defined profile named MyProfile.

EXAMPLE 4

Repair-NAVCustomization -ServerInstance BusinessCentral -AllProfiles

This example repairs customizations for all profiles.

Parameters

-AllProfiles

Specifies to repair customizations for all profiles.

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

-AllUsers

Specifies to repair personalizations for all users.

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

-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

-ProfileAppId

Specifies the ID of the extension that defines the profile whose customizations you want to repair. Use this parameter if you want to repair the customizations made for just one profile.

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

-ProfileId

Specifies the ID of the profile whose personalizations you want to repair. Use this parameter if you want to repair the personalizations made for just one profile.

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 name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name, such as myinstance.

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

-Tenant

Specifies the ID of the tenant, such as Tenant1, where you want to repair UI customizations. This parameter is required unless the specified service instance is not configured to run multiple tenants. If not configured to run multiple tenants, you can either use 'default' as the value or omit 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 a Business Central user whose personalizations you want to repair. Use this parameter to repair the personalizations for one user only.

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

Share via