Share via


Repair-NAVCustomization

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

SingleUserSet (Default)

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

AllUsersSet

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

SingleProfileSet

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

AllProfilesSet

Repair-NAVCustomization
    [-ServerInstance] <String>
    [-AllProfiles]
    [-Tenant <TenantId>]
    [-Force]
    [-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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AllProfilesSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-AllUsers

Specifies to repair personalizations for all users.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

AllUsersSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SingleProfileSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SingleProfileSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:TenantId
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:Guid
Default value:00000000-0000-0000-0000-000000000000
Supports wildcards:False
DontShow:False

Parameter sets

SingleUserSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

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