Validate Your Screen

Validate That Your Screen is Ready for Use in Processes.

Overview

Before you deploy your Screen to production, validate that it is ready for use in Processes for the following reasons:

• Minimize problems when previewing your Screen.

• ProcessMaker Platform represents Screens as JSON data models. You can view any JSON data model in Preview mode to test how a Process's JSON data model or another Screen's data model interacts with your Screen. When testing a JSON data model, the Screen Validation feature indicates when that data model is not valid.

• Minimize problems when Process designers test your Screen in their Processes. Since your Screen may be used in multiple Processes in your organization, ensure that your Screen won't cause production problems later.

• If a Process designer exports a Process that references your Screen, your Screen is also exported and referenced in all Task elements that use it. Therefore, by validating your Screen, those Processes that reference your Screen can successfully be imported later.

Validate a Screen

Your user account or group membership must have the following permissions to validate a Screen unless your user account has the Make this user a Super Admin setting selected:

• Screens: Edit Screens

• Screens: View Screens

See the Screens permissions or ask your Administrator for assistance.

Follow these steps to validate a Screen:

1. Create a new Screen or click the Edit iconto edit the selected Screen. The Screen is in Design mode. Though you can enable Screen Validation in Preview mode, you may only fix validation errors in Design mode.
2. Screen Validation is enabled by default. If the Screen Validation toggle key is disabled, enable the Screen Validation toggle key so that Screens Builder automatically validates your Screen as you work.

   
3. Work on your Screen. Screens Builder indicates any validation issues as you work. The following indicators may occur:

   • No errors found: If no errors are found, the following text displays to the right of the Open Console button: 0. The green check mark displays. Your Screen is valid.

   • Errors are found: If errors are found, Screens Builder displays how any errors are found to the right of the Open Console button. The error icon displays with the number of current errors. Click the Open Console button to display a summary of the errors. Below is an example.

     

     Furthermore, controls that are associated with errors display a red-colored highlight.

     
4. If errors are found, click the Open Console button again to hide the error summary. Make changes to your Screen or JSON data model and then repeat steps 3 and 4 again until Screens Builder finds no validation errors.

Related Topics

pageWhat is Screen Builder?pageScreen TypespageScreen Builder ModespageEdit Your ScreenpageAdd, Delete or Rename a PagepagePreview a Screen and Its JSON Data ModelpageManage Calculated PropertiespageAdd Custom CSS to a ScreenpageManage WatcherspageUndo and Redo Changes in Your ScreenpageSave Your ScreenpageScreen Design Best and Worst Practices