Edit the Configuration of a Process Template.
Follow these steps to configure a Process Template:
View all Process Templates. The Templates tab displays.
Edit the following Process Template configuration as necessary:
In the Name setting, edit the unique name of the Process Template. This is a required setting.
In the Description setting, edit the description of the Process Template. This is a required setting.
In the Version setting, edit the version of the Process Template. This is required setting and accepts numerical values only.
Click Save to save your changes.
Save one of your Processes as a Template.
Follow these steps to create a new Template from an existing Process:
In the Template Name setting, enter a unique name for the Template. Template names must be unique in your organization and can only use apostrophe characters ('
) and spaces. This is a required setting.
In the Description setting, enter a description of the Template. This is a required setting.
In the Version setting, enter a version number for this template. This is required setting and accepts numerical values only.
Do one of the following:
Select the Save all assets option to include all assets associated with this Process, including but not limited to Screens, Scripts, and Data Connectors, as part of this Template.
Select the Save process model only option to include only the Process model in the Template.
Click the Save button to create a new Template from this Process. The new Template displays in the Templates tab.
Manage your Process Templates.
A Process Template is a ready-to-use Process that serves as a foundation for designing new Processes. By using Process Templates, expedite the time to design new Processes, minimize the need for duplicative effort, and guarantee a consistent appearance and functionality across all Processes in your organization.
ProcessMaker knows how to best design Processes. Learn from our best practices how to model Process. Our curated Processes across multiple industries and use cases saves time and effort from designing your own from a blank Process Modeler canvas.
Process Templates save time and effort in the following ways:
Process Templates provide an overview of that Template's purpose, use case, and a thumbnail view of the Process model.
Regardless of whether you are an experienced Process designer or are new to ProcessMaker Platform, use Process Templates to quickly learn Process design and best practices from ready-to-deploy Process models and associated assets.
ProcessMaker Platform displays Process Templates created by Process designers throughout your organization in one table. This makes it easy to manage these Process Templates.
Follow these steps to view all Process Templates:
Click the Templates tab. All available Process Templates display.
The Templates tab displays the following information in tabular format:
Name: The Name column displays the Process Template name.
Category: The Category column displays the Process Category to which the Template is assigned. Process Templates use the same Categories as those for Processes.
Template Author: The Template Author column displays the name of the user who created this Process Template.
Created: The Created column displays the date and time the Template 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.
For instructions on how to use Process Templates, see Create a new Process from an Existing Template.
Use the Search function to filter all Process Templates from the Templates page based on the entered text.
Follow these steps to search for a Process Template:
View all Process Templates. The Templates tab displays.
Enter in the Search setting the text to filter Process Templates using any of the following criteria:
Name: Filter by the Process Template name that displays in the Name column.
Category: Filter by the Process Category name that displays in the Category column.
Owner: Filter by the Process Template Author's full name that displays in the Template Author column.
As you enter text into the Search setting, Process Templates matching the entered text display.
If there are no search results, the following message displays: No Results.
See View Process Templates for ways to manage your Process Templates.
Make changes to an existing Process Template.
Download a Process Template from ProcessMaker Template Gallery, Import, and then configure that Template for your ProcessMaker Platform instance.
Follow these steps to download a ready-to-use Process Template from ProcessMaker Template Gallery to import it into your ProcessMaker Platform instance:
Click on a Process Template's tile to view a description that Template. Details of the Template display.
Click on the Template link below the Process Template's name to download that Template. If this is the first time downloading a Process Template, or your Web browser's cookies have expired from ProcessMaker's web site, do the following. Otherwise, continue to step 4.
Click the Access Resources button to download the Process Template.
A ZIP file contains the Process Template. Select the location where to save the ZIP file.
Extract the contents of the ZIP file. The Process Template is a JSON file. ProcessMaker Platform files are in JSON format.
Follow these steps to import a Process Template:
Click the Import button. The Import Process Template page displays.
Click the Select file from computer link to locate the Template to import. Process Templates have the .json
file extension. ProcessMaker Platform evaluates the file to import. If the Process Template was not exported from a ProcessMaker Platform Spring 2023 version or later instance, that Process Template may not be imported completely.
The Import Process Template screen displays. Only the Basic import option is available for Process Templates and all assets within the Template will be imported.
Assets used in the Process Template that are not installed in the importing ProcessMaker Platform instance are removed from the Process Template upon import. The following message displays: Some elements are not supported.
Click the Update button to update the current Process Template.
Click the Import as New button to create a new Template with unique IDs. A new Process Template is created with a numerical suffix added to the original Template's name.
If your ProcessMaker Platform instance only has the default user and groups, then do the following:
Locate the Script setting in the Configuration panel. This setting already has a Script to run. Do not change this Script setting.
Locate the Run script as setting.
From the Run script as setting, select the user account with appropriate permissions to access the ProcessMaker Platform REST API.
User Tasks must be assigned to users and/or groups within your ProcessMaker Platform instance. These users and/or groups must exist prior to assigning user Tasks. If your ProcessMaker Platform instance only has the default user and groups, then do the following:
Inspect the Process model for each user Task. There are two types of user Tasks:
Do the following for each user Task:
Configure email Task notification settings.
Click the menu, and select the Configure Template option. The Configuration tab displays.
From the Category drop-down menu, select to which Process Category to assign the Process Template. To remove a Process Category that is currently selected, click the icon for that Process Category. This is a required setting.
Click the menu for your Process, and then select the Save as Template option. The Create Template screen displays.
From the Category drop-down menu, select one or more Process Categories to associate with this Template. To remove a Process Category that is currently selected, click the icon for that selection. The category list is populated from Process Categories.
Editing a Process Template revises that Template such that future uses of that Template, such as when , derive from those revisions.
See the permissions or ask your Administrator for assistance.
. The Templates tab displays.
Click the menu, and then select the Edit Template option. The Process Template opens in the Process Modeler for editing.
Make changes to the Process Template, and then click the to publish a new version of that Template.
See the permissions or ask your Administrator for assistance.
. The Templates tab displays.
Click the menu, and then select the Export Template option. The Process Template exports as a .json
file to your local computer or network. The following message displays when the Process Template exports successfully: The template was exported.
See the permissions or ask your Administrator for assistance.
. The Templates tab displays.
Click the menu, and then select the Delete Template option. A message displays asking for confirmation to delete a Process Template.
provides ready-to-use to customize and publish your next business solution. Refer to the following sections to use Process Templates from ProcessMaker Template Gallery:
Access to view a list of available Templates. A list of Templates with a brief description for each displays.
The Get Access screen displays. Enter your contact information, and then consent to the .
into your ProcessMaker Platform instance.
See the permissions or ask your Administrator for assistance.
to expedite the time to design your next business solution.
or otherwise acquired the Template to import.
. The Templates tab displays.
Click the Import button to complete the import procedure. The Process Template appears in the Templates tab. You may then .
If a Template with the same name already exists, the following warning message displays: Caution: Process Template Already Exists. Do one of the following:
After and , that may require additional configuration to properly function in your ProcessMaker Platform instance. For example, a must be configured with your unique email server for your ProcessMaker Platform instance. The Process Template that uses that Send Email connector cannot be configured prior to you downloading and importing it to your ProcessMaker Platform instance.
This section references ProcessMaker Platform features that require configuration to your ProcessMaker Platform instance after importing a Process Template. After a Process Template is and , that Template can be used with those customized settings to your ProcessMaker Platform instance.
Refer to the following sections regarding any custom configurations to a Process Template after it has been imported. Note that not all Process Templates have all of these features within them. , and then inspect for any of the following features that would require customization to your ProcessMaker Platform instance if they are used:
Refer to the following sections regarding configurations for BPMN elements after :
Scripts configured for Script Tasks must be assigned a user account from which to run within your ProcessMaker Platform instance. Ensure that the selected user's account has the appropriate API to access the ProcessMaker Platform REST API.
and users to whom to assign user Tasks.
and groups to more easily organize users and other groups.
Follow these steps after and :
Inspect the Process model for each . Script Tasks are denoted by an icon by default.
.
for the Script shown in the Script setting.
and users to whom to assign user Tasks.
and groups to more easily organize users and other groups.
Follow these steps after and :
: Form Task elements are denoted by an icon by default.
: Manual Task elements are denoted by an icon by default.
Form Task elements: .
Manual Task elements: .
Inspect the Process model for a Send Email connector. Send Email connectors are denoted by an icon by default. If the Process Template uses a Send Email connector, then configure email Task notifications for each user Task by doing the following:
Form Task elements: .
Manual Task elements: .
Refer to the following sections regarding configurations for after :
Actions By Email connectors must be configured with which configured email server to use. An prior to configuring an Actions By Email connector.
Follow these steps after and :
Inspect the Process model for an Actions By Email connector. Actions By Email connectors are denoted by an icon by default.
.
Data Connector connectors must be configured to reference which each uses to access its data source. Note that your ProcessMaker Platform instance must have at least one to select and configure its use.
Follow these steps after and :
Inspect the Process model for a Data Connector connector. Data Connector connectors are denoted by an icon by default.
.
must be configured to reference which each uses to evaluate business rules within that Process Template. Note that your ProcessMaker Platform instance must have at least one to select and configure its use.
Follow these steps after and :
Inspect the Process model for a Decision Task connector. Decision Task connectors are denoted by an icon by default.
.
must be configured to prior to use.
Follow these steps after and :
Inspect the Process model for a DocuSign connector. DocuSign connectors are denoted by an icon by default.
. For an example how to configure a DocuSign connector, see .
must be configured prior to use. A ProcessMaker IDP instance is required. ProcessMaker IDP is ProcessMaker's intelligent document processing (IDP) solution.
Follow these steps after and :
Inspect the Process model for an IDP connector. IDP connectors are denoted by an icon by default.
.
must be configured to prior to use.
Follow these steps after and :
Inspect the Process model for a PDF Generator connector. PDF Generator connectors are denoted by an icon by default.
.
must be configured with which configured email server to use. An prior to configuring a Send Email connector.
Follow these steps after and :
Inspect the Process model for a Send Email connector. Send Email connectors are denoted by an icon by default.
.
Slack Notification connectors must be configured prior to use. A Slack instance is required. Ensure to .
Follow these steps after and :
Inspect the Process model for a Slack Notification connector. Slack Notification connectors are denoted by an icon by default.
.
View documentation for your Process Template.
The Template Documentation option is available to view documentation for your Process Templates. Entered documentation is for informational purposes only and does not affect Request workflow.
The documentation displays as a page within ProcessMaker Platform. Use the Web browser to print or save as a PDF if your browser supports those functions.
Process Template documentation has the following attributes:
The page generated by the Documentation package provides the following information about the Process Template:
The name of the Process Template.
When was the Process Template last updated and by whom.
A description of the Process Template as entered when creating a new template.
An image of the Process model in the Process Template.
Names of all Process model elements and/or connectors and their unique node IDs.
The documented description of each Process element and/or connector. If no description has been entered for an element/connector, the following message displays: No Documentation Found.
Below is an example of a documented Process Template.
Follow these steps to view documentation for a Process Template:
View all Process Templates. The Templates tab displays.
Alternatively, use the print or save as PDF functions of your Web browser to print or save Process Template documentation.
Click the menu, and then select the Template Documentation option. Process Template documentation displays as a page within ProcessMaker Platform.