Customization Analysis Report (CAR)

This article describes how to generate a Customization Analysis Report for your model. It also describes some best practice rules that are included in the report, and provides suggestions for fixing errors and warnings that are associated with these rules.

What is the Customization Analysis Report?

The Customization Analysis Report is a tool that analyzes your customization and extension models, and runs a predefined set of best practice rules. The report is one of the requirements of the solution certification process. The report is in the form of a Microsoft Excel workbook.

How to generate the report

The xppbp.exe tool is located in c:\packages\bin or I:\AosService\PackagesLocalDirectory\bin. To generate the Customization Analysis Report, run the following command in a development environment.

xppbp.exe -metadata=<local packages folder> -all -model=<ModelName> -xmlLog=C:\BPCheckLogcd.xml -module=<PackageName> -car=<reportlocation>

If your custom model references an ISV model, then you must include the -PackagesRoot parameter, for example:

-packagesroot=K:\AosService\PackagesLocalDirectory

Example

xppbp.exe -metadata=C:\Packages -all -model="MyAppSuiteCustomizations" -xmlLog=C:\temp\BPCheckLogcd.xml -module="ApplicationSuite" -car=c:\temp\CAReport.xlsx

Issues List

This section describes all best practice rules (errors, warnings, or informational messages) that can appear on the Issues List page of the report and provides suggestions for fixing the issues. Issues are of the metadata or code type. For all code issues, keep in mind that, if the warning or error occurs in a method that you've overlaid, the lines of code that violate the rule might belong to a model in a lower layer. In that case, you're not responsible for fixing warnings and errors in code that isn't yours.

BPCheckPackReturnsConnull

BPCheckParametersModified

BPCheckSQLCode

BPCheckNestedLoopInCode

BPCheckInsertMethodInLoop

BPCheckSelectwithJoin

BPFunctionCallwithSelect

BPCheckinvalidExecuteQuery

BPCheckInvalidInitFormMethod

BPCheckEmptyLoop

BPCheckLockQueryRange

BPCheckSkipStatementValidation

BPCheckNoTTSTryBlock

The following examples show when the rule will fail or pass. Use these examples as guidelines to refactor your code.

ttsbegin;
try {
}
// fail
catch {
}
try {
}
// pass
catch(Exception::UpdateConflict) {
}
try {
}
// pass
catch(Exception::UpdateConflictNotRecovered) {}

BPCheckEmptyTableMethod

BPCheckBatchJobsEnabled

BPCheckDisplayMethodCached

You can fix this warning by using one of the following patterns:

• Set the Cache Data Method property to Yes.

• Set the Cache Data Method property to Auto, and mark the data method of the table with the SysClientCacheDataMethodAttribute attribute. Here is an example.

  [SysClientCacheDataMethodAttribute(true)]
  Display TransDate myDateMethod()
  {
      //...
  }
  

• Use CacheAddMethod in the init method of the form to mark the method as cached.

BPCheckSQLQueryInInit

BPCheckNewQueryWithForm

BPCheckSelectForUpdateAbsent

BPCheckTablePropertyMismatch

BPCheckMissingDeleteActions

BPCheckAddressModel

BPCheckDimensionModel

BPCheckNumberofNewFields

BPCheckEnumUpgradeIssue

BPCheckPassiveJoinUse

BPCheckAlternateKeyAbsent

BPCheckBaseTableModified