Use solution checker to validate your model-driven apps in Power Apps

To deliver on complex business requirements, model-driven app makers often can end up with highly advanced solutions that customize and extend the Microsoft Dataverse platform. With advanced implementations come an increased risk where performance, stability, and reliability issues become introduced, which can negatively impact the user experience. Identifying and understanding how to resolve these issues can be complicated and time consuming. With the solution checker feature, you can perform a rich static analysis check on your solutions against a set of best practice rules and quickly identify these problematic patterns. After the check completes, you receive a detailed report that lists the issues identified, the components and code affected, and links to documentation that describes how to resolve each issue.

Important

Starting March 2022, solution checker won’t analyze plugins in solutions. Plugin validations are being modernized and will eventually focus on the native plugin authoring time, which will help you detect and fix issues earlier.

The solution checker analyzes these solution components:

  • Dataverse custom workflow activities
  • Dataverse web resources (HTML and JavaScript)
  • Dataverse configurations, such as SDK message steps

Solution checker works with unmanaged solutions that can be exported from an environment.

Note

  • This topic explains how to run solution checker from the Power Apps maker portal. A PowerShell module is also available that you can use to interact directly with the service. The Microsoft.PowerApps.Checker.PowerShell module can be used for analysis of unmanaged solutions for Power Apps environments, or to automate and integrate the service into your build and release pipelines. More information: Microsoft.PowerApps.Checker.PowerShell Overview
  • Solution checker supports global variables for ECMAScript 2015 (ES6) and up to ECMAScript 2018 (ES9) syntax. When JavaScript is detected using global variables later than ES6 or syntax later than ES9, a web-unsupported-syntax issue for the web resource is reported.
  • Use of solution checker does not guarantee that a solution import will be successful. The static analysis checks performed against the solution do not know the configured state of the destination environment and import success may be dependent on other solutions or configurations in the environment.

Run the solution checker

  1. Sign in to Power Apps.

  2. In the left pane, select Solutions.

  3. Next to the unmanaged solution that you want to analyze, select ..., point to Solution checker, and then select Run.

    Run solution checker command.

  4. The status pane located on the upper right of the Solutions page displays Solution checker running.

    Solution checker status.

    Note the following:

    • The solution checker can take a few minutes to complete the analysis.

    • During this time you'll notice a Running… state in the Solution check column of the Solution list.

    • You'll receive an email notification and a notification in the Notifications area of the Power Apps site when the check is completed.

  5. View the report when the check is completed.

Cancel a check

After you submit a solutions check in your environment, the check can be canceled through the status pane on the upper right area of the Solutions page.

When you cancel a check, the solution check stops running and the solution check status returns to the previous state.

Solution checker states

When you install the solution checker in your environment, the Solution check column becomes available in the Solutions list. This column displays the solution analysis states for a solution.

State Description
Hasn’t been run The solution has never been analyzed.
Running The solution is being analyzed.
Couldn’t be completed Solution analysis was requested but the analysis didn't complete successfully.
Results as of date and time Solution analysis completed and results are available for download.
Couldn’t be completed. Result as of date and time The latest analysis request didn't complete successfully. The last successful results can be downloaded.
Checked by Microsoft This is a Microsoft-managed solution. Solution analysis isn't permitted on these solutions.
Checked by Publisher This is a third-party-managed solution. Currently, solution analysis isn't available for these solutions.

Review the solution checker report

When a solution check is completed, you can view the analysis report in the portal, or you can download the report from your web browser. In the portal, you have options to filter, group results by Issue, Location or by Severity and view detailed information for issues detected in your solution.

  1. In the left pane, select Solutions.

  2. Next to the unmanaged solution where you want to view the solution checker report, select ..., point to Solution checker, and then select View results.

  3. Select an Issue to view the details and guidance on how to resolve.

    Solution checker view results.

The solution check results are also available for download. The solution checker zip file is downloaded to the folder specified by your web browser. The download report is in Excel format and contains several visualizations and columns that assist you in identifying the impact, type, and location of each issue detected in your solution. A link to detailed guidance about how to resolve the issue is also provided.

  1. In the left pane, select Solutions.
  2. Next to the unmanaged solution where you want to download the solution checker report, select ..., point to Solution checker, and then select Download results.
  3. The solution checker zip file is downloaded to the folder specified by your web browser.

Here's a summary of each column in the report.

Report column Description Applies-to component
Issue The title of the issue identified in the solution. All
Category The categorization of the issue identified, such as Performance, Usage, or Supportability. All
Severity Represents the potential impact of the issue identified. Available impact types are High, Medium, Low, and Informational. All
Guidance Link to article detailing the issue, impact, and recommended action. All
Component The solution component where the issue was identified. All
Location The location and/or source file of the component where the issue that was identified occurred, such as the assembly or JavaScript file name. All
Line # The line number reference of the issue in the impacted web resource component. Web resources
Module Module name where the issue identified in the assembly was detected. Custom workflow activity
Type Type of the issue identified in the assembly. Custom workflow activity
Member Member of the issue identified in the assembly. Custom workflow activity
Statement The code statement or configuration that resulted in the issue. All
Comments Details about the issue that include high-level resolution steps. All

Best practice rules used by solution checker

Solution component Rule name Rule description
Plug-in or workflow activity meta-remove-dup-reg Avoid duplicate Dataverse plug-in registrations.
Plug-in or workflow activity meta-avoid-reg-no-attribute Include filtering attributes with Dataverse plug-in registrations.
Plug-in or workflow activity meta-avoid-reg-retrieve Use caution with Dataverse plug-ins registered for Retrieve and RetrieveMultiple messages.
Plug-in or workflow activity meta-remove-inactive Remove inactive configurations in Dataverse.
Plug-in or workflow activity meta-avoid-crm4-event Don't use Microsoft Dynamics CRM 4.0 plug-in registration stage.
Plug-in or workflow activity meta-avoid-retrievemultiple-annotation Avoid registering a plugin on RetrieveMultiple of annotation.
Web Resources use-async Interact with HTTP and HTTPS resources asynchronously.
Web Resources avoid-modals Avoid using modal dialogs.
Web Resources avoid-dom-form
Web Resources avoid-dom-form-event
Web Resources avoid-crm2011-service-odata Don't target the Microsoft Dynamics CRM 2011 OData 2.0 endpoint.
Web Resources avoid-crm2011-service-soap Don't target the Microsoft Dynamics CRM 2011 SOAP services.
Web Resources avoid-browser-specific-api Don't use Internet Explorer legacy APIs or browser plug-ins.
Web Resources avoid-unpub-api
Web Resources avoid-window-top
Web Resources avoid-2011-api Don't use the deprecated Microsoft Dynamics CRM 2011 object model. Instead follow Dataverse Web API documentation.
Web Resources use-relative-uri Don't use absolute Dataverse endpoint URLs.
Web Resources use-cached-webresource
Web Resources use-client-context Use client contexts.
Web Resources use-navigation-api Use navigation API parameters.
Web Resources use-offline
Web Resources do-not-make-parent-assumption
Web Resources use-org-setting Use organization settings.
Web Resources use-global-context
Web Resources use-grid-api Use the grid APIs.
Web Resources use-utility-dialogs
Web Resources avoid-isActivityType Replace Xrm.Utility.isActivityType method with new Xrm.Utility.gettableMetadata and don't use in ribbon rules.
Web Resources meta-avoid-silverlight Silverlight web resource usage is deprecated.
Web Resources remove-debug-script Avoid including debug script in non-development environments.
Web Resources use-strict-mode Use strict mode when possible.
Web Resources use-strict-equality-operators Use strict equality operators.
Web Resources avoid-eval Don't use the 'eval' function or its functional equivalents.
Web Resources remove-alert Don't use the 'alert' function or its functional equivalents.
Web Resources remove-console Avoid using methods on console.
Web Resources avoid-ui-refreshribbon Avoid using refreshRibbon in form onload and EnableRule.
Web Resources use-getsecurityroleprivilegesinfo Avoid userSettings.securityRolePrivileges. Use userSettings.getSecurityRolePrivilegesInfo instead.
Canvas App app-formula-issues-high Refer to Power Apps formula references for additional details.
Canvas App app-formula-issues-medium Refer to Power Apps formula references for additional details.
Canvas App app-formula-issues-low Refer to Power Apps formula references for additional details.
Canvas App app-use-delayoutput-text-input Use delayed load in some scenarios to improve performance.
Canvas App app-reduce-screen-controls Limit the number of app controls for improved performance.
Canvas App app-include-accessible-label Use explicit labels to improve app accessibility.
Canvas App app-include-alternative-input Ensure all interactive elements are accessible to alternative inputs.
Canvas App app-avoid-autostart Avoid using autostart on players within an app.

See also

Best practices and guidance for the Dataverse
Best practices and guidance for model-driven apps
Common issues and resolutions for Solution Checker