Export-NAVAppReportLayout

  • Reference
Module:
Microsoft.BusinessCentral.Apps.Tools

Exports the specified custom report layout from a Business Central database to a file.

Syntax

Export-NAVAppReportLayout
      -LayoutCode <String[]>
      [-Tenant <TenantId>]
      [-ServerInstance] <String>
      -Path <String>
      [-PassThru]
      [-Force]
      [-ProgressAction <ActionPreference>]
      [<CommonParameters>]

Description

Use the Export-NAVAppReportLayout cmdlet to export a custom report layout from a Business Central database to a file.

Examples

Example 1

Export-NAVAppReportLayout -ServerInstance BC -Path .\ReportLayout.layoutdata -LayoutCode MS-1016-DEFAULT

This example exports the report layout with the code 'MS-1016-DEFAULT' in the database that is used by the BC server instance to the ReportLayout.layoutdata file.

Example 2

Export-NAVAppReportLayout -ServerInstance BC -Path .\ReportLayout.layoutdata -LayoutCode MS-1016-DEFAULT -PassThru

          Mode             LastWriteTime            Length Name
          ----             -------------            ------ ----
          -a---            11/25/2017   11:47 AM       450 ReportLayout.xml

Description

This example exports the report layout with the code 'MS-1016-DEFAULT' in the database that is used by the BC server instance to the ReportLayout.layoutdata file, then returns the location of the file.

Parameters

-Force

Forces the command to run without asking for user confirmation to overwrite an existing report layout file at the given path.

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

-LayoutCode

Specifies the Code of the report layout that will be exported.

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

-PassThru

Returns the path to the report layout file.

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

-Path

Specifies the name and location of the file that the report layout is exported to.

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 that the report layout will be exported from, such as BC.

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

-Tenant

Specifies the tenant from which to export data. If the server instance is configured for single tenant, do not set the parameter.

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

Inputs

System.String[]

By property name: LayoutCode

Microsoft.Dynamics.Nav.Types.TenantId

By property name: Tenant

System.String

By value and by property name: ServerInstance

System.String

By property name: Path