Manage Screens throughout your organization.
Manage your Screen Categories.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Understand what Screen Categories are and how they can help organize your Screens.
Use Screen Categories to organize your Screens. Organizing your Screens into Categories makes it easier to search for a Screen based on its assigned Category. Assign multiple Screen Categories to a Screen if necessary. For example, assign a Screen named "Personal Information Form" to the "Banking Forms" and "Human Resources Forms" Screen Categories.
Screen Categories can be in active or inactive status. Following is a description of each status:
Active: Active Screen Categories can have Screens assigned to them.
Inactive: Inactive Screen Categories cannot have Screens assigned to them.
ProcessMaker Platform has multiple Category types for different types of assets. Each Category type is distinct from the others and can only be used for its type of ProcessMaker Platform asset. Following is a description of each Category type:
Project Categories: Organize your Projects.
Process Categories: Organize your Processes.
PM Block Categories: Organize your PM Blocks.
Script Categories: Organize your Scripts.
Screen Categories: Organize your Screens.
Data Connector Categories: Organize your Data Connectors.
Decision Table Categories: Organize your Decision Tables.
Search for a Screen Category.
Your user account or group membership must have the following permissions to search Screen Categories unless your user account has the Make this user a Super Admin setting selected:
Screens: View Screen Categories
Screens: View Screens
See the Screens permissions or ask your Administrator for assistance
Follow these steps to search for Screen Categories:
Enter in the Search setting the text to filter Screen Categories by name.
As you enter text into the Search setting, Screen Categories display that match your entered text.
If there are no search results, the following message displays: No Results.
View the Screen Categories in your organization.
Your user account or group membership must have the following permissions to view Screen Categories unless your user account has the Make this user a Super Admin setting selected:
Screens: View Screen Categories
Screens: View Screens
See the Screens permissions or ask your Administrator for assistance.
Follow these steps to view Screen Categories:
Log on to ProcessMaker Platform.
Click the Designer option from the top menu. The Designer Welcome Screen displays.
Click the Categories tab. The Screen Categories display.
The Categories tab displays the following information in tabular format about Screen Categories:
Name: The Name column displays the name of the Screen Category. The Screen Category named Uncategorized is the default Category.
Status: The Status column displays the status of the Screen Category. Below is a description of each status:
Active: Active Screen Categories can have Screens assigned to them. The Screen Category named Uncategorized is active by default.
Inactive: Inactive Screen Categories cannot have Screens assigned to them.
Screens: The # Screens column displays how many Screens in your organization have been assigned to that Screen Category.
Modified: The Modified column displays the date and time the Screen Category was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Created: The Created column displays the date and time the Screen Category was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
If no Screen Categories exist, the following message displays: No Results.
Use the Search setting to filter Screen Categories by their names.
​Control how tabular information displays, including how to sort columns or how many items display per page.
Improve your Screen organization by creating Categories to which to assign them.
Your user account or group membership must have the following permissions to create a new Screen Category unless your user account has the Make this user a Super Admin setting selected:
Screens: Create Screen Categories
Screens: View Screen Categories
Screens: View Screens
See the Screens permissions or ask your Administrator for assistance.
Follow these steps to create a new Screen Category:
Click the +Category button. The Create Screen Category screen displays.
In the Category Name setting, enter the name of the new Screen Category. The Screen Category name must be unique from all other Screen Category names in your organization and can only use apostrophe characters ('
) and spaces. This is a required setting.
From the Status drop-down menu, select one of the following options for the Screen Category's status:
Active: Active Screen Categories can have Screens assigned to them.
Inactive: Inactive Screen Categories cannot have Screens assigned to them.
The Active option is selected by default. This is a required setting.
Click Save.
Edit the name and/or status of a Screen Category.
Your user account or group membership must have the following permissions to edit a Screen Category unless your user account has the Make this user a Super Admin setting selected:
Screens: Edit Screen Categories
Screens: View Screen Categories
Screens: View Screens
Edit the following information about the Screen Category as necessary:
In the Category Name setting, edit the name of the Screen Category if necessary. The Screen Category name must be unique from all other Screen Category names in your organization. This is a required field.
From the Status drop-down menu, change the status of the Screen Category, if necessary, from the following options:
Active: Active Screen Categories can have Screens assigned to them.
Inactive: Inactive Screen Categories cannot have Screens assigned to them.
This is a required setting.
Click Save.
Click the Screens icon from the left sidebar. The Screens tab displays all Screens in the Screens page.
See the permissions or ask your Administrator for assistance.
Follow these steps to edit a :
.
Click the ellipses icon, and then select the Edit Category option for the Screen Category to edit. The Edit Screen Category page displays.
Delete a Screen Category when it is no longer needed.
Your user account or group membership must have the following permissions to delete a Screen Category unless your user account has the Make this user a Super Admin setting selected:
Screens: Delete Screen Categories
Screens: View Screen Categories
Screens: View Screens
See the Screens permissions or ask your Administrator for assistance.
Deleting a Screen Category cannot be undone.
Follow these steps to delete a Screen Category:
Click Confirm. The following message displays: The category was deleted.
To delete a Screen Category, no Screens can be assigned to it. If any Screens are assigned to the Screen Category, its Delete icondoes not display. Reassign those Screens to another Screen Category.
Click the ellipses icon, and then select the Edit Category option for the Screen Category to delete. A message displays to confirm deletion of the Screen Category.
Import a Screen that has previously been exported.
Import a Screen that has been exported from the same ProcessMaker Platform version or later. The imported Screen contains the configured controls from the exported Screen. Exported Screens have the .json
file extension.
ProcessMaker Platform ignores any Projects to which the importing Screen was assigned when it was exported.
Your user account or group membership must have the following permissions to import a Screen unless your user account has the Make this user a Super Admin setting selected:
Screens: Import Screens
Screens: View Screens
See the Screens permissions or ask your Administrator for assistance.
Follow these steps to import a Screen:
View your Screens. The Screens page displays.
Click the Import button. The Import Screen displays.
Click Browse to locate the Screen to import. Screens have the .json
file extension.
Click Import. The Import Screen screen displays to indicate that the Screen imported correctly.
Click List Screens. The Screens page displays the imported Screen with the same name as the original Screen except with a number "2" suffix.
If the original Screen cannot import successfully, the following message displays: Unable to import the screen. Ensure the following:
The .json
file you tried to import is a Screen and not a Process. An exported Process also uses the .json
file extension.
The exported Screen was exported from the same ProcessMaker Platform version.
Create a new Screen that can be re-used in any Process.
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.
See Screen Design Best Practices before creating a Screen.
Follow these steps to create a new Screen:
View your Screens. The Screens page displays.
Click the +Screen button. The Create Screen screen displays.
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.
Enter in the Description setting a description for the Screen. This is a required setting.
From the Type drop-down menu, select one of the following Screen types:
Conversational: Use the Conversational type to design functional rule-based modern chat style experiences. See Conversational Forms Package and Conversational 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.
Click Save. Screens Builder displays the new Screen in Design mode. See Screens Builder.
View the Screens in your organization.
ProcessMaker Platform displays all Screens in one location. Any Screen developed by any Process designer can be used in any Process. This makes it easy to manage Screens.
Your user account or group membership must have the "Screens: View Screens" permission to view the list of Screens unless your user account has the Make this user a Super Admin setting selected.
See the Screens permissions or ask your Administrator for assistance.
Follow these steps to view all Screens in your organization:
​Log on to ProcessMaker Platform.
Click the Designer option from the top menu. The Designer Welcome Screen displays.
Do one of the following:
The Screens page displays the following information in tabular format about Screens:
Name: The Name column displays the name of the Screen. Click the name to edit the Screen in Screens Builder.
Description: The Description column displays the description of the Screen. See Edit Script Configuration for more information.
Category: The Category column displays to which Screen Category the Screen is assigned.
Type: The Type column displays which type the Screen is. See Screen Types.
Modified: The Modified column displays the date and time the Screen was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Created: The Created column displays the date and time the Screen was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Use the Search setting to filter Screens that display.
Click the +Screen button. See Create a New Screen.
Click the Import button. See Import a Screen.
If no Screens exist, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Filter all Screens in your organization to find that one you need.
Use the Search function to filter all Screens from the Screens page based on your entered text.
Your user account or group membership must have the "Screens: View Screens" permission to search for Screens unless your user account has the Make this user a Super Admin setting selected.
Follow these steps to search for a Screen:
Enter in the Search setting the text to filter Screens using any of the following criteria:
Name: Filter by the Screen name that displays in the Name column.
Description: Filter by the Screen description that displays in the Description column.
As you enter text into the Search setting, Screens display that match your entered text.
If there are no search results, the following message displays: No Results.
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.
From the Project drop-down menu, optionally select the Project(s) that this Screen becomes an asset. This setting only displays Projects of which you are a member. To remove a Project that is currently selected, click theicon for that selection or press Enter
when the drop-down is visible.
From the Assets pane in the Designer Welcome Screen, mouse-hover over the Screens icon, and then select View All Screens.
Click the Screens icon from the left sidebar. The Screens tab displays all Screens in the Screens page.
Click the ellipses icon, and then select the Edit Screen option or click the Screen name. See Screens Builder for topics.
Click the ellipses icon, and then select the Configure option. See Edit Screen Configuration.
Click the ellipses icon, and then select the Add to Project option. See Add a Screen to a Project.
Click the ellipses icon, and then select the Copy option. See Copy a Screen.
Click the ellipses icon, and then select the Export option. See Export a Screen.
Click the ellipses icon, and then select the Delete option. See Delete a Screen.
See the permissions or ask your Administrator for assistance.
The Screens page displays.
Category: Filter by the Screen name that displays in the Category column.
Edit general information about a Screen.
Your user account or group membership must have the following permissions to configure 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 configure a Screen:
View your Screens. The Screens page displays.
Edit the following information about the Screen as necessary:
In the Name setting, edit the unique name of the Screen. This is a required field.
In the Description setting, edit the description of the Screen. This is a required setting.
Click Save.
The Versioning package must be installed to view or edit the version history for a Screen.
Furthermore, your user account or group membership must have the following permissions unless your user account has the Make this user a Super Admin setting selected:
Screens: Edit Screens
Screens: View Screens
Version History: Edit Version History
Version History: View Version History
See the Screens and Version History permissions or ask your Administrator for assistance.
A version is a set of changes made to a Screen at a particular time by a Process designer. Versioning maintains a record of all named and unnamed changes to that Screen. Any of these versions may be viewed or retrieved, if needed. The Version History page displays all saved versions of the Screen in a tabular format from where they can be edited and/or marked as the Current Version
according to your business needs. The current version of a Screen is used in all new Requests of a Process using that Screen. Version changes are not reflected in Requests which were in-progress or already completed when the version changed. See the Versioning package for more information.
Follow these steps to view or edit the version history of your Screen:
View your Screens. The Screens page displays.
Date: The date and time of when a Process designer saved this version in the Screen Builder.
Current Version: The most recent version of the Screen is displayed at the top and is marked as the Current Version
. This version is used in all in-progress and new Requests.
Name: The name of this version as entered by a Process designer when saving the Screen in Screen Builder.
Description: A description of the changes in this version as entered by a Process designer when saving the Screen in Screen Builder.
Saved by: The name of the Process designer who saved this version.
Toggle the Only show named versions toggle key to show only the versions with a name assigned to them.
Optionally, edit any of the following existing details about this named version:
In the Version Name setting, edit the name to this named version. If saving this named version with no name, this version does not display in the Version History page if the Only show named versions toggle key is enabled.
In the Additional Details (optional) setting, edit the details about this version. For example, describe the changes in this version for auditing, historical, or maintenance purposes.
Click Confirm and Save to save your changes. Otherwise, click Cancel.
Click Confirm and Save to set this version as the current version. Otherwise, click Cancel.
Add a Screen as an asset to a Project. Any members of that Project may then use that asset toward the goals of that Project.
Follow these steps to add a Screen to a Project:
Optionally, select the Use a copy of this asset option to use a copy of this Screen as the Project asset instead of the original. When selecting this option, any revisions made to the original Screen do not affect yours in your Project(s), and vice versa. Consider this option a best practice to use, especially if you intend to make changes from the original Screen that may not be an asset in any Project.
Click Add. The Screen is added as an asset to the selected Project(s).
Click the ellipses icon, and then select the Edit Screen option or click the Screen name. See Screens Builder for topics.
Click the ellipses icon, and then select the Configure option for your Screen. The Edit Configuration page displays.
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 the icon for that selection or press Enter
when the drop-down is visible. This is a required setting.
From the Project drop-down menu, optionally select the Project(s) that this Screen becomes an asset. This setting only displays Projects of which you are a member. To remove a Project that is currently selected, click theicon for that selection or press Enter
when the drop-down is visible.
Click the Configure iconfor your Screen. The Configuration tab of the Edit Configuration page displays.
Click on the Version History tab. The Version History page displays. The Version History page organizes versions in a monthly format and displays the following information:
Click the Change Version Details iconto edit version details for this version. The Change Version Details screen displays.
Click the Copy to Latest iconto set a version as the current version. The Copy to Latest screen displays.
The screen displays the warning This version will become the active version for this asset
,
indicating that this action will set this version as the current version.
Adding a to a adds that Process as an asset to that Project. Any Project member may then use that asset toward the goals of that Project.
the View Screens permission in the category of permissions
a member of any
. The Screens tab displays.
Click the ellipses icon, and then select the Add to Project option. The Add to a Project screen displays.
From the Select Project drop-down, select to which Project(s) this Screen becomes an asset. To remove a Project that is currently selected, click theicon for that selection or press Enter
when the drop-down is visible.
Copy an existing Screen.
Your user account or group membership must have the following permissions to copy 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.
Follow these steps to copy a Screen:
View your Screens. The Screens page displays.
Edit the following information from the original Screen as necessary:
In the Name setting, edit the name of the copied Screen. After the original Screen is copied, the word Copy is suffixed to the original Screen's name. This is a required setting.
In the Description field, edit the description of the original Screen.
Click Save.
The Type field shows which type the original Screen is. The copied Screen must be of the same Screen type as the original.
Export a Screen.
The exported Screen has the .json
file extension.
Your user account or group membership must have the following permissions to export a Screen unless your user account has the Make this user a Super Admin setting selected:
Screens: Export Screens
Screens: View Screens
Follow these steps to export a Screen:
Click Download, and then browse for the location on your local computer to save the exported Screen.
By default, ProcessMaker Platform exports the Screen using the original Screen name except spaces in the name are replaced with underscores (_
). The file has the file extension .json
. Rename the default file name if necessary, though do not change the file extension. As a best practice, specify in the file name that this is an exported Screen to distinguish it from other exported assets.
Specify a directory location to save the file. ProcessMaker Platform exports the .json
file to your local computer. The following message displays when the Screen exports successfully: The screen was exported.
Click the ellipses icon, and then select the Copy option for your Screen. The Copy Screen screen displays.
From the Category drop-down menu, optionally change 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.
Export a Screen to your local computer. The exported Screen may then be to the same or another ProcessMaker Platform instance of the same . An exported Screen may then be shared with others so they can import your Screen for their Processes.
An exported Screen contains all the as the original at the time the original Screen was exported.
See the permissions or ask your Administrator for assistance.
The Screens page displays.
Click the ellipses icon, and then select the Export option for your Screen. The following message displays: You are about to export a Screen. All the configurations of the screen will be exported.
Delete a Screen from being used in any Process.
Your user account or group membership must have the following permissions to delete a Screen unless your user account has the Make this user a Super Admin setting selected:
Screens: Delete Screens
Screens: View Screens
See the Screens permissions or ask your Administrator for assistance.
When a Screen is deleted, Process models that use that Screen in Task elements are not affected. However, that Screen can no longer be referenced from other Process models thereafter.
Deleting a Screen from the Screens page cannot be undone.
Follow these steps to delete a Screen:
View your Screens. The Screens page displays.
Click Confirm. The following message displays: The screen was deleted.
Click the ellipses icon, and then select the Delete option for the Screen to delete. The Caution screen displays to confirm the deletion of the Screen.
Edit a Screen.
Your user account or group membership must have the following permissions to edit 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 edit a Screen:
View your Screens. The Screens page displays.
Click the ellipses icon, and then select the Edit Screen option or click the Screen name. The Screen opens in Screen Builder. See Screen Builder.