New D365CAReport

---

external help file: d365fo.tools-help.xml Module Name: d365fo.tools online version: schema: 2.0.0

New-D365CAReport

SYNOPSIS

Generate the Customization's Analysis Report (CAR)

SYNTAX

New-D365CAReport [[-OutputPath] <String>] [-Module] <String> [-Model] <String> [-SuffixWithModule]
 [[-BinDir] <String>] [[-MetaDataDir] <String>] [[-XmlLog] <String>] [-PackagesRoot] [[-LogPath] <String>]
 [-ShowOriginalProgress] [-OutputCommandOnly] [<CommonParameters>]

DESCRIPTION

A cmdlet that wraps some of the cumbersome work into a streamlined process

EXAMPLES

EXAMPLE 1

New-D365CAReport -module "ApplicationSuite" -model "MyOverLayerModel"

This will generate a CAR report against MyOverLayerModel in the ApplicationSuite Module. It will use the default value for the OutputPath parameter, which is "c:\temp\d365fo.tools\CAReport.xlsx".

EXAMPLE 2

New-D365CAReport -OutputPath "c:\temp\CAReport.xlsx" -module "ApplicationSuite" -model "MyOverLayerModel"

This will generate a CAR report against MyOverLayerModel in the ApplicationSuite Module. It will use the "c:\temp\CAReport.xlsx" value for the OutputPath parameter.

EXAMPLE 3

New-D365CAReport -module "ApplicationSuite" -model "MyOverLayerModel" -SuffixWithModule

This will generate a CAR report against MyOverLayerModel in the ApplicationSuite Module. It will use the default value for the OutputPath parameter, which is "c:\temp\d365fo.tools\CAReport.xlsx". It will append the module name to the desired output file, which will then be "c:\temp\d365fo.tools\CAReport-ApplicationSuite.xlsx".

EXAMPLE 4

New-D365CAReport -OutputPath "c:\temp\CAReport.xlsx" -module "ApplicationSuite" -model "MyOverLayerModel" -PackagesRoot

This will generate a CAR report against MyOverLayerModel in the ApplicationSuite Module. It will use the binary metadata to look for the module and model. It will use the "c:\temp\CAReport.xlsx" value for the OutputPath parameter.

PARAMETERS

-OutputPath

Path where you want the CAR file (xlsx-file) saved to

Default value is: "c:\temp\d365fo.tools\CAReport.xlsx"

Type: String
Parameter Sets: (All)
Aliases: Path, File

Required: False
Position: 1
Default value: (Join-Path $Script:DefaultTempPath "CAReport.xlsx")
Accept pipeline input: False
Accept wildcard characters: False

-Module

Name of the Module to analyse

Type: String
Parameter Sets: (All)
Aliases: ModuleName, Package

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Model

Name of the Model to analyse

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SuffixWithModule

Instruct the cmdlet to append the module name as a suffix to the desired output file name

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-BinDir

The path to the bin directory for the environment

Default path is the same as the AOS service PackagesLocalDirectory\bin

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: "$Script:PackageDirectory\bin"
Accept pipeline input: False
Accept wildcard characters: False

-MetaDataDir

The path to the meta data directory for the environment

Default path is the same as the aos service PackagesLocalDirectory

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: "$Script:MetaDataDir"
Accept pipeline input: False
Accept wildcard characters: False

-XmlLog

Path where you want to store the Xml log output generated from the best practice analyser

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: (Join-Path $Script:DefaultTempPath "BPCheckLogcd.xml")
Accept pipeline input: False
Accept wildcard characters: False

-PackagesRoot

Instructs the cmdlet to use binary metadata

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-LogPath

The path where the log file(s) will be saved

When running without the ShowOriginalProgress parameter, the log files will be the standard output and the error output from the underlying tool executed

Type: String
Parameter Sets: (All)
Aliases: LogDir

Required: False
Position: 7
Default value: $(Join-Path -Path $Script:DefaultTempPath -ChildPath "Logs\CAReport")
Accept pipeline input: False
Accept wildcard characters: False

-ShowOriginalProgress

Instruct the cmdlet to show the standard output in the console

Default is $false which will silence the standard output

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-OutputCommandOnly

Instruct the cmdlet to only output the command that you would have to execute by hand

Will include full path to the executable and the needed parameters based on your selection

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

CommonParameters

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

INPUTS

OUTPUTS

NOTES

Author: Tommy Skaue (@Skaue)

Author: Mötz Jensen (@Splaxi)

RELATED LINKS