Best Practice Analysis
EnterpriseBest Practice Analysis scans your crawled solutions against 12 rules covering naming conventions, security, performance, design, and documentation. It identifies issues before they become problems.
What It Analyzes
Best Practice Analysis examines every component discovered during a crawl and evaluates it against a set of rules. Each rule checks for a specific pattern, anti-pattern, or configuration issue that could impact maintainability, performance, security, or user experience.
The analysis runs entirely within Dataverse using plugin logic — no data leaves your environment. Results are stored in Cartographer's database and can be reviewed, resolved, and tracked over time.
How to Run Analysis
- 1Navigate to Solution Manager in the Cartographer app
- 2Select the solution you want to analyze
- 3Click Run Best Practice Analysis in the command bar
- 4Wait for the analysis to complete (typically 10-30 seconds)
- 5View results in the Best Practices tab of the solution detail view
Severity Levels
Critical
Issues that pose a security risk, can cause data loss, or significantly impact system reliability. These should be addressed immediately.
Warning
Issues that may cause problems over time or indicate a deviation from best practices. These should be reviewed and addressed when possible.
Info
Suggestions for improvement that are not urgent. These are recommendations that can improve code quality and user experience over time.
Rules Reference
The following 12 rules are checked during every Best Practice Analysis run:
| ID | Rule | Severity | Category | What It Checks |
|---|---|---|---|---|
| BP-001 | Publisher Prefix Consistency | Warning | Naming | All components in a solution should use the same publisher prefix |
| BP-002 | Table Display Name Convention | Info | Naming | Table display names should use PascalCase or Title Case consistently |
| BP-003 | Column Description Required | Warning | Documentation | Custom columns should have a description explaining their purpose |
| BP-004 | No Unused Columns | Warning | Design | Custom columns that appear on no forms or views may be unused |
| BP-005 | Plugin Step Isolation Mode | Critical | Security | Plugin steps should run in sandbox isolation mode for security |
| BP-006 | Async Preferred for Non-Critical | Warning | Performance | Post-operation plugin steps that are not user-facing should prefer async mode |
| BP-007 | Cloud Flow Error Handling | Critical | Reliability | Cloud flows should have error handling (try-catch) configured on key actions |
| BP-008 | Security Role Least Privilege | Critical | Security | Custom security roles should not grant Organization-level access to sensitive tables |
| BP-009 | Environment Variable Usage | Info | Design | Hardcoded URLs or connection references should use environment variables |
| BP-010 | Form Tab Organization | Info | UX | Forms with more than 8 tabs may benefit from consolidation |
| BP-011 | View Column Count | Info | Performance | Views with more than 10 columns may cause performance issues and poor UX |
| BP-012 | Business Rule Scope | Warning | Design | Business rules scoped to Entity run server-side and can impact API performance |
Resolving Issues
Each issue in the Best Practice results can be managed:
- Mark as Resolved — after fixing the issue in your solution, mark it as resolved. It will not reappear in future analysis runs unless the issue returns.
- Acknowledge / Ignore — if the issue is intentional (e.g., Organization-level access for a reporting role), you can acknowledge it. Acknowledged issues appear in a separate tab.
- View Component — click through to the component detail to see the full metadata and AI summary for context.