ProcessMaker API Documentation
ProcessMaker Examples

Create a New Screen

Create a new Screen that can be re-used in any Process.

Create a New ProcessMaker Screen

Permissions Required

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

  • Screens: View Screens

  • Screens: Create Screens

See the Screens permissions or ask your Administrator for assistance.

Best Practices

See Screen Design Best Practices before creating a Screen.

Follow these steps to create a new Screen:

  1. View your Screens. The Screens page displays.

  2. Click the +Screen button. The Create Screen screen displays.

  3. In the Name setting, enter a unique name for the Screen. Screen names must be unique in your organization and can only use apostrophe characters (') and spaces. This is a required setting.

  4. From the Type drop-down menu, select one of the following Screen types:

    • Advanced: Use the Advanced type to design your own advanced forms using HTML syntax and JavaScript. This is an ideal solution for highly technical designers to create their own form designs and functionality. See Advanced Screen Package and Advanced Screen-type.

    • Conversational: Use the Conversational type to design functional rule-based modern chat style experiences. See Conversational Forms Package and Conversational Screen-type.

    • Display: Use the Display type to display information or allow Request participants to download files. The Display type has limited functionality compared the Form type. See Display Screen-type.

    • Email: Use the Email type to compose the email body for email messages to be used with the Send Email connector. Note that the Send Email connector must be installed for this option to display. See Send Email Connector and Email Screen-type.

    • Form: Use the Form type to design interactive and complex forms. See Form Screen-type.

    This is a required setting.

  5. Enter in the Description setting a description for the Screen. This is a required setting.

  6. From the Category drop-down menu, select one or more Screen Categories to associate with this Screen. In doing so, Screen Categories may be sorted from the Screens page. To remove a Screen Category that is currently selected, click theicon for that selection or press Enter when the drop-down is visible. This is a required setting.

  7. Click Save. Screens Builder displays the new Screen in Design mode. See Screens Builder.

Related Topics