Screen templates can be created from existing screens.
When saving a screen as a template, all assets in the screen are exported to the template except Watches and Calculated Properties.
Follow these steps to save a current screen as a template.
Click the Save as Template option. The Create Template screen displays.
In the Template Name setting, enter a name for the template. This is a required setting.
In the Description setting, enter a short description for the template. This is a required setting.
From the Type dropdown menu, select whether this will be a Display, Email, or a Form template.
In the Template Thumbnail section, upload image(s) to make it easily to identify a template.
In the Version setting, enter a version number. This settings accepts numeral values only.
Optionally, select Make Public.
Click Save to create the template. The template will display in the My Templates tab when viewing all screen templates.
Follow these steps to edit a Screen Template:
View all Screen Templates and navigate to the My Templates or Shared Templates tab.
Click the dropdown menu. A menu displays the template options.
Click the Edit Template option. The Screen Template opens in the Screen Builder for editing.
Make changes as needed, and then click the Publish button to publish a new version of that Template.
Follow these steps to configure a Screen Template:
View all Screen Templates and navigate to the My Templates tab.
Click the dropdown menu. A menu displays the template options.
Click the Configure Template option.
Make the required changes in the Configuration template screen.
Following changes can be made to the template's configuration.
Name of the template.
Description of the template
Category of the template.
Template Thumbnail.
Version number.
Share template.
Make changes as needed, and then click the Save button to publish a new version of that Template.
Follow these steps to configure a Screen Template:
View all Screen Templates and navigate to the My Templates tab.
Click the dropdown menu. A menu displays the template options.
Click the Share Template option. The template will now display in the Shared Templates tab.
Exporting a screen allows you to share it with others for use in their processes. This functionality is especially useful for collaborative development across different instances of ProcessMaker Platform.
After exporting a Screen Template, the exported .json file can be shared with others and imported into other ProcessMaker instances. An exported Screen Template contains all the controls as the original template.
The import function is designed to work with Screens Templates exported from the same version of ProcessMaker, ensuring compatibility across different instances.
Follow these steps to export a Screen:
View all Screen Templates and navigate to the My Templates or Shared Templates tab.
Click the dropdown menu. A menu displays the template options.
Click the Export Template option. The Export Screen Template window displays.
Click Download. The template is downloaded to your default Downloads folder.
To import a Screen Template into the ProcessMaker Platform, ensure that the template was previously exported as a.json
file. The template must be from the same version of ProcessMaker or a compatible version to ensure full functionality of its configured controls.
Follow these steps to import a Screen Template:
View all Screen Templates and navigate to the My Templates or Shared Templates tab.
Click the Import button to the right of the search bar.
From Import Screen Template screen, click Browse to select a.json
file for import.
Click Import to import the screen template. The template will now appear in the My Templates tab.
If the import is not successful, the following message displays: Unable to import the screen template. Ensure the following:
The .json
file you tried to import is a Screen Template and not a Process Template. Process Templates also uses the .json
file extension.
The template was exported from the same ProcessMaker Platform version.
Learn how to use screen templates to quickly create new screens.
Use Screen Templates to quickly create a new screen and ensure design consistency across all your processes. Screen templates not only save time, but also ensure that a design standard is maintained in your organization. Key features of these templates include:
Use one of the pre-built templates or save one of your current screens as a template.
Maintain a repository of commonly used screen designs.
Share templates with your team.
Watch the following product tour to learn how to use Screen Templates.
Ensure that you are logged on to ProcessMaker Platform.
Select the Designer option from the top menu.
Screen Templates are displayed in the two tabs My Templates and Shared Templates.
My Templates: This tab displays screen templates that you have created.
Shared Templates: This tab displays pre-built screen templates provided by ProcessMaker, as well as templates created and shared by users within your organization.
Follow these steps to create a new screen using a screen template.
View your Screens. A list of screens is displayed.
Click the +Screen button to create a new screen.
Choose a screen type from the first dropdown. Templates are available for Form, Display, and Email Screens.
From Styles For The Screen Type, select either My Templates or Public Templates to view a list of templates available in the category.
Optionally, you can select the Set as Default Template option to designate a template as the default for the selected screen type.
In the Name setting, enter a name for the new Screen. This is a required setting.
In the Description setting, enter a short description for the Screen. This is a required setting.
Optional, choose a project from the Project dropdown menu to assign this Screen to a Project.
Click Save to create the new Screen. The Screen displays in he Screen Builder.
To continue building your screen, see Screen Builder.
Click the menu from the top right to see available options.
From the Category dropdown menu, select a category for the template. To remove a category, click the remove category icon .
Hover the template row. The menu display.
Hover the template row. The menu display.
Hover the template row. The menu display.
Hover the template row. The menu display.
From the Assets pane, hover over the Screens icon , and then select View all Screens.
From the Category dropdown menu, select a category for the Screen. To remove a category, click the remove category icon .