Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Search for a PM Block Category.
The PM Blocks package must be installed.
Your user account or group membership must have the following permissions to search for a PM Block Category unless your user account has the Make this user a Super Admin setting selected:
PM Blocks: View PM Block Categories
PM Blocks: View PM Blocks
See the PM Blocks permissions or ask your Administrator for assistance.
Follow these steps to search for PM Blocks Categories:
Enter in the Search setting the text to filter PM Block Categories by name.
As you enter text into the Search setting, PM Block Categories display that match your entered text.
As you enter text into the Search setting, PM Block Categories display that match your entered text.
Manage your PM Block Categories.
Improve your PM Block organization by creating Categories to which to assign them.
The PM Blocks package must be installed.
Your user account or group membership must have the following permissions to create a new PM Block Category unless your user account has the Make this user a Super Admin setting selected:
PM Blocks: Create PM Block Categories
PM Blocks: View PM Block Categories
PM Blocks: View PM Blocks
See the PM Blocks permissions or ask your Administrator for assistance.
Follow these steps to create a new PM Block Category:
Click the +Category button. The Create PM Block Category screen displays.
In the Category Name setting, enter the name of the new PM Block Category. The PM Block Category name must be unique from all other PM Block 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 PM Block Category's status:
Active: Active PM Block Categories can have Scripts assigned to them.
Inactive: Inactive PM Block Categories cannot have Scripts assigned to them.
The Active option is selected by default. This is a required setting.
Click Save.
Understand what PM Block Categories are and how they can help organize your PM Blocks.
Use PM Block Categories to organize your PM Blocks. Organizing your PM Blocks into Categories makes it easier to search for a PM Block based on its assigned Category. Assign multiple PM Block Categories to a PM Block if necessary. For example, assign a PM Block named "Photo Capture and Intelligent Document Processing (IDP)" to the "Banking" and "Human Resources" PM Block Categories.
PM Block Categories can be in active or inactive status. Following is a description of each status:
Active: Active PM Block Categories can have PM Blocks assigned to them.
Inactive: Inactive PM Block Categories cannot have PM Blocks assigned to them.
View the PM Block Categories in your organization.
Follow these steps to view PM Block Categories:
Click the Designer option from the top menu. The Processes page displays.
Click the Categories tab. The PM Blocks Categories display.
The Categories tab displays the following information in tabular format about PM Block Categories:
Name: The Name column displays the name of the PM Block Category. The PM Block Category named Uncategorized is the default Category.
Status: The Status column displays the status of the PM Block Category. Below is a description of each status:
Active: Active PM Block Categories can have PM Blocks assigned to them. The PM Block Category named Uncategorized is active by default.
Inactive: Inactive PM Block Categories cannot have PM Blocks assigned to them.
PM Blocks: The # PM Blocks column displays how many PM Blocks in your organization have been assigned to that PM Block Category.
: Organize your .
PM Block Categories: Organize your (if the PM Blocks package is installed).
: Organize your .
: Organize your .
: Organize your (if the is installed).
: Organize your (if the is installed).
The must be installed.
See the permissions or ask your Administrator for assistance.
to ProcessMaker Platform.
Click the PM Blocks icon from the left sidebar. The PM Blocks tab displays all PM Blocks in the PM Blocks page.
Modified: The Modified column displays the date and time the PM Block Category was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your Time zone setting is specified.
Created: The Created column displays the date and time the PM Block Category was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your Time zone setting is specified.
​, including how to sort columns or how many items display per page.
Manage PM Blocks throughout your organization.
Delete a PM Block Category when it is no longer needed.
The PM Blocks package must be installed.
Your user account or group membership must have the following permissions to delete a PM Block Category unless your user account has the Make this user a Super Admin setting selected:
PM Blocks: Delete PM Block Categories
PM Blocks: View PM Block Categories
PM Blocks: View PM Blocks
See the PM Blocks permissions or ask your Administrator for assistance.
To delete a PM Block Category, no PM Blocks can be assigned to it. If any PM Blocks are assigned to the PM Block Category, its Delete Category option does not display. Reassign those PM Blocks to another PM Block Category.
Deleting a PM Block Category cannot be undone.
Follow these steps to delete a PM Block Category:
Click Confirm. The following message displays: The category was deleted.
Edit the name and/or status of a PM Block Category.
The PM Blocks package must be installed.
Your user account or group membership must have the following permissions to edit a PM Block Category unless your user account has the Make this user a Super Admin setting selected:
PM Blocks: Edit PM Block Categories
PM Blocks: View PM Block Categories
PM Blocks: View PM Blocks
See the PM Blocks permissions or ask your Administrator for assistance.
Follow these steps to edit a PM Block Category:
Edit the following information about the PM Block Category as necessary:
In the Category Name setting, edit the name of the PM Block Category if necessary. The PM Block Category name must be unique from all other PM Block Category names in your organization. This is a required setting.
From the Status drop-down menu, change the status of the PM Block Category, if necessary, from the following options:
Active: Active PM Block Categories can have PM Blocks assigned to them.
Inactive: Inactive PM Block Categories cannot have PM Blocks assigned to them.
This is a required setting.
Click Save.
Filter all PM Blocks in your organization to find that one you need.
Use the Search function to filter all PM Blocks from the PM Blocks page based on your entered text.
Your user account or group membership must have the "PM Blocks: View PM Blocks" permission to search for PM Blocks unless your user account has the Make this user a Super Admin setting selected.
Follow these steps to search for a PM Block:
Enter in the Search setting the text to filter PM Blocks using any of the following criteria:
Name: Filter by the PM Block name that displays in the Name column.
Description: Filter by the PM Block description that displays below the name for each PM Block.
Author: Filter by the name of the user who built the PM Block.
Version: Filter by the version of the PM Block.
Version Date: Filter by the version date of the PM Block that displays in the Version Date column.
As you enter text into the Search setting, PM Blocks display that match your entered text.
If there are no search results, the following message displays: No Results.
Import a PM Block that has previously been exported.
Follow these steps to import a PM Block:
Click the Import button. The Import PM Block page displays.
Click the Select file from computer link to locate the PM Block to import. PM Blocks have the .json
file extension. ProcessMaker Platform evaluates the file to import. If the PM Block was not exported from a ProcessMaker Platform Summer 2023 version or later instance, that PM Block may not be imported completely.
The Import PM Block screen displays. Only the Basic import option is available for PM Blocks and all assets within the PM Block will be imported.
Click the Import button to complete the import procedure. The PM Block appears in the PM Blocks tab.
If the PM Block was exported with the Lock PM Block toggle key enabled, then the PM Block may not be edited and/or configured. That PM Block may only be used in Processes or other PM Blocks.
Create a new PM Block, a reusable Process Modeler object that serves a specific purpose or function, which any Process Designer may place into a Process model with no prior technical skills.
Follow these steps to create a new PM Block:
Create a new Process in any of the following ways:
PM Blocks cannot be created from Process Templates.
From the PM Block Name setting, enter a name for the PM Block. This name must be unique from other PM Blocks. This is a required setting.
In the Description setting, enter a description of the PM Block. This description displays below the name of the PM Block from the PM Blocks page. This is a required setting.
From the Icon setting, choose an icon from the default icon if necessary. Do one of the following:
Select an icon: From the Icon setting, select a different icon from the default. By default, PM Blocks use the Cube icon.
Upload a custom icon: Click the Upload Custom Icon icon, and then locate the icon to represent your PM Block. The icon must not be larger than two (2) kilobytes or the following message displays below the Icon setting: The custom icon file is too large. File size must be less than 2KB..
From the Author setting, enter the name of the user who created the PM Block.
From the Version setting, enter the version of the PM Block.
Click Publish. The following message displays: PM Block successfully created. The PM Block displays in the PM Blocks page.
View the PM Blocks in your organization.
ProcessMaker Platform displays all PM Blocks in one location. Any PM Block developed by any Process Designer can be used in any Process. This makes it easy to manage PM Blocks.
Follow these steps to view all PM Blocks in your organization:
Click the Designer option from the top menu. The Processes page displays.
The PM Blocks page displays the following information in tabular format about PM Blocks:
Name: The Name column displays the name and description of the PM Block.
Author: The Author column displays which user built the PM Block.
Version: The Version column displays the version of the PM Block as specified by the PM Block author.
Otherwise, the Edit PM Block option is not available.
If no PM Blocks exist, the following message displays: No Data Available
Click the ellipses icon, and then select the Delete Category option for the PM Block Category to delete. A message displays to confirm deletion of the PM Block Category.
Click the ellipses icon, and then select the Edit Category option for the PM Block Category to edit. The Edit PM Block Category page displays.
See the permissions or ask your Administrator for assistance.
. The PM Blocks page displays.
Category: Filter by the PM Block name that displays in the Category column.
Import a PM Block that has been from the same or later. Exported PM Blocks have the .json
file extension. The imported PM Block can then be used in Processes and other PM Blocks.
The must be installed.
See the permissions or ask your Administrator for assistance.
. The PM Blocks page displays.
The must be installed.
See the permissions or ask your Administrator for assistance.
.
.
In Process Modeler, design and/or configure the Process model using and to meet your PM Block's functionality.
.
.
Click the ellipses icon, and then select the Save As PM Block option. The Publish PM Block screen displays.
From the Category drop-down menu, select one or more to associate with this PM Block. In doing so, PM Block Categories may be sorted from the PM Blocks page. To remove a PM Block Category that is currently selected, click theicon for that selection or press Enter
when the drop-down is visible. This is a required setting.
.
The must be installed.
See the permissions or ask your Administrator for assistance.
to ProcessMaker Platform.
Click the PM Blocks icon from the left sidebar. The PM Blocks tab displays all PM Blocks in the PM Blocks page.
Category: The Category column displays to which the PM Block is assigned.
Version Date: The Version Date column displays the date and time the PM Block was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your Time zone setting is specified.
Use the setting to filter PM Blocks that display.
See .
Click the Import button. See .
Click the ellipses icon, and then select the Edit PM Block option. See . Note that this option is only available when that PM Block was not locked when it was exported, thereby allowing that PM Block to be edited.
Click the ellipses icon, and then select the Configure PM Block option. See .
Click the ellipses icon, and then select the Export PM Block option. See .
Click the ellipses icon, and then select the Archive PM Block option. See .
, including how to sort columns or how many items display per page.
Edit the functional design in Process Designer for a PM Block.
PM Blocks are edited in Process Modeler.
Note that an imported PM Block may be edited only if it was not locked when it was exported.
Editing a PM Block involves revising the functional design of Process Modeler objects in that PM Block, including its BPMN elements and/or connectors.
Separately, revise the configuration settings that Process Designers use to implement how each instance of that PM Block functions. The configuration settings are built in Process Modeler are separate from the PM Block's functional design.
The PM Blocks package must be installed.
Your user account or group membership must have the following permissions to edit a PM Block unless your user account has the Make this user a Super Admin setting selected:
PM Blocks: Edit PM Blocks
PM Blocks: View PM Blocks
See the PM Blocks permissions or ask your Administrator for assistance.
Follow these steps to edit a PM Block:
View your PM Blocks. The PM Blocks page displays.
Edit the PM Block as necessary.
Click the Publish button to publish a new version of this PM Block that includes the revisions.
Archive a PM Block that is no longer needed in your organization.
An archived PM Block has the following attributes:
All archived PM Blocks in the organization are accessible from the Archived PM Blocks page. See View Archived PM Blocks.
Archived PM Blocks are not available from the PM Blocks panel in Process Modeler. Archived PM Blocks cannot be added to future Process models.
A PM Block currently used by Processes can be archived. Current and future Requests for Processes using PM Blocks are not affected if those PM Blocks are archived.
Do not confuse archived PM Blocks with inactive ones. The Inactive status for a PM Block also indicates that new Requests of the Process can not be started. However, Process Designers can edit the Process as needed. Archived PM Blocks cannot be edited until they are restored.
The PM Blocks package must be installed.
Your user account or group membership must have the "PM Blocks: View PM Blocks" permission to view archived PM Blocks unless your user account has the Make this user a Super Admin setting selected.
See the PM Blocks permissions or ask your Administrator for assistance.
Follow these steps to view archived PM Blocks:
View your PM Blocks. The PM Blocks page displays.
Click the Archived PM Blocks tab. The Archived PM Blocks page displays all archived PM Blocks in your organization.
The Archived PM Blocks page displays the following information in tabular format about archived PM Blocks:
Name: The Name column displays the PM Block name.
Category: The Category column displays to which PM Block Category the PM Block is assigned.
Author: The Author column displays which user built the PM Block.
Version: The Version column displays the version of the PM Block as specified by the PM Block author.
Version Date: The Version Date column displays the date and time the PM Block 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.
The PM Blocks package must be installed.
Your user account or group membership must have the "PM Blocks: View PM Blocks" permission to archive a PM Block unless your user account has the Make this user a Super Admin setting selected.
See the PM Blocks permissions or ask your Administrator for assistance.
Follow these steps to archive a PM Block:
View your PM Blocks. The PM Blocks page displays.
Click Confirm to archive the PM Block. The following message displays: The pm block was archived. The PM Block moves from the PM Blocks page to the Archived PM Blocks page. See View Archived PM Blocks. Also see Restore a PM Block.
Build the configuration settings that Process Designers use to implement how each instance of a PM Block functions.
Configuring a PM Block involves building the configuration settings that Process Designers use to implement how each instance of that PM Block functions. The configuration settings are built in Process Modeler are separate from the PM Block's functional design.
Configuring a PM Block involves the following:
The PM Blocks package must be installed.
Furthermore, your user account or group membership must have the following permissions to configure a PM Block unless your user account has the Make this user a Super Admin setting selected:
PM Blocks: Edit PM Blocks
PM Blocks: View PM Blocks
See the PM Blocks permissions or ask your Administrator for assistance.
Follow these steps to configure general settings for a PM Block:
View your PM Blocks. The PM Blocks page displays.
Edit the following information about the PM Block as necessary:
In the Name setting, edit the name for the PM Block. This name must be unique from other PM Blocks. This is a required setting.
In the Description setting, edit the description of the PM Block. This description displays below the name of the PM Block from the PM Blocks page. This is a required setting.
From the Icon setting, choose an icon from the default icon if necessary. Do one of the following:
Select an icon: From the Icon setting, select a different icon from the default. By default, PM Blocks use the Cube icon.
Upload a custom icon: Click the Upload Custom Icon icon, and then locate the icon to represent your PM Block. The icon must not be larger than two (2) kilobytes or the following message displays below the Icon setting: The custom icon file is too large. File size must be less than 2KB..
From the Status drop-down menu, select the status for this PM Block:
Active: Select the Active status to make this PM Block available for Process Designers to use in their Process models. This PM Block becomes available from the PM Blocks tab in Process Modeler's left-side panel.
Inactive: Select the Inactive status to make this PM Block unavailable for Process Designers to use in their Process models. The Inactive status does not affect Processes that already implement this PM Block.
Do one of the following:
Click Save.
As part of configuring a PM Block, build its settings. Process Designers will enter values into these settings when configuring each instance of this PM Block in their Process models designed in Process Modeler. These PM Block settings display in Process Modeler's Configuration panel.
PM Block configuration settings may be composed of any of the following control types:
These control types are designed similarly to those in Screen Builder. Validation rules can apply to each of these control types to verify that the entered value for a PM Block configuration is valid to use.
As a Process Designer using a PM Block in your Process, follow these guidelines to reference the setting value of a PM Block during Requests of your Process:
Locate the PM Block setting in the Configuration panel from which to get its value during Requests.
Note its Variable Name setting value.
From a Script called from a Script Task element, reference that setting's value by using the _parent
JSON key within mustache syntax, where VariableName
is the name of the PM Block setting to get its value:
{{ _parent.config.VariableName }}
The _parent
JSON key references Request data outside of that PM Block.
Follow these steps to build the Configuration panel settings for a PM Block:
View your PM Blocks. The PM Blocks page displays.
Click the Labels tab. The Panel Configuration page displays.
The left pane displays control types from which to drag onto the canvas on the right side of that pane.
In the Name setting, enter the PM Block's label as it displays as a Process model object. This is not the name of the PM Block itself, which is configured its general settings.
Place into the canvas the controls with which to configure your PM Block. Use the controls similarly to Screen Builder by dragging and placing a control into the order to display the settings in the Configuration panel within Process Modeler. Provide helper text for each control to instruct the Process Designer how to configure each setting in your PM Block for use in a Process model. See the settings for the following control types:
As part of configuring a PM Block, specify custom settings for this PM Block that store both globally available data that may contain personal or authentication information. These variables, called Block Environment Variables, are similar to Environment Variables but may only be used for that PM Block. For every instance that this PM Block triggers during a Request, these Block Environment Variables generate and become part of that Request's data.
See the following sections:
As a Process Designer using a PM Block in your Process, use a Script called from a Script Task element to get the value from a Block Environment Variable. Similar to other Environment Variables, a Block Environment Variable's value may only be acquired from a Script because these variables often contain personal or authentication information that cannot be viewed.
See ProcessMaker Platform and Environment Variable Syntax, Usage, SDK, and Examples for examples how to call Environment Variables using supported programming languages.
Follow these steps to specify Block Environment Variables for a PM Block:
View your PM Blocks. The PM Blocks page displays.
Click the Environment Variables tab. The Block Environment Variables page displays.
The PM Block Global Settings page displays all global settings configured for this PM Block in tabular format:
Setting: The Setting column displays the Block Environment Variable name that is the custom setting.
Configuration: The Configuration column displays how the Block Environment Variable is configured.
Do one of the following:
Follow these steps to specify a Block Environment Variable for a PM Block:
View your PM Blocks. The PM Blocks page displays.
View the Block Environment variables for the PM Block in which to add a variable.
Click the Edit Fields button, and then click the Add Field button. The Add Field screen displays.
In the Field Label setting, enter the label that displays for this Block Environment Variable. The Field Label setting displays in the Setting column. This is a required setting.
In the Helper Text setting, enter text that provides information about this setting. The Helper Text setting displays below the Field Label value in the Settings column. This is a required setting.
From the Select if this value holds sensitive data checkbox, select to mask the data for this Block Environment Variable to prevent it from being displayed or copied. Use this setting when this Block Environment Variable may contain personal information, authentication information, or other data to keep private.
Click Add. The new Block Environment Variable displays in the Block Environment Variables page.
The PM Block has the following naming structure: PMB_EnvironmentVariableName_PMBlockName_uniqueID, where
PMB: "PMB" is an acronym for PM Block.
EnvironmentVariableName: This is the name of the Block Environment Variable.
PMBlockName: This is the name of the PM Block.
UniqueID: This is a unique ID automatically assigned to the Block Environment Variable.
Furthermore, the Block Environment Variable also displays in the Environment Variables page.
Click the Done button from the Block Environment Variables page when all Block Environment Variables are configured properly.
Restore an archived PM Block to use again in your organization.
Follow these steps to restore a PM Block:
Export a PM Block.
The exported PM Block has the .json
file extension.
Follow these steps to export a PM Block:
Edit the existing configuration settings for the PM Block prior to exporting as necessary:
In the Author setting, edit the name of the user who created the PM Block.
In the Version setting, edit the version of the PM Block.
Click Export. The following message displays when the PM Block exports successfully: The PM Block Photo Capture and Intelligent Document Processing was exported.
Click the ellipses icon, and then select the Edit PM Block option for the PM Block to edit. The PM Block opens in Process Modeler.
Click the ellipses icon, and then select the Archive PM Block option for the PM Block to archive. The Caution screen displays to confirm archiving the PM Block.
Click the ellipses icon, and then select the Configure PM Block option for the PM Block to configure. The Configuration tab displays.
From the Category drop-down menu, select one or more PM Block Categories to associate with this PM Block. In doing so, PM Block Categories may be sorted from the PM Blocks page. To remove a PM Block Category that is currently selected, click theicon for that selection or press Enter
when the drop-down is visible. This is a required setting.
Click the ellipses icon, and then select the Configure PM Block option for the PM Block to configure. The Configuration tab displays.
Click the ellipses icon, and then select the Configure PM Block option for the PM Block to configure. The Configuration tab displays.
Optionally, click the ellipses icon, and then select the Edit Field option for the Block Environment Variable to edit. The Edit Field screen displays. Edit the Block Environment Variable settings as needed, and then click Update.
Restore an to make it available to Process Designers to use it in their Process models. After a PM Block is restored, that PM Block moves from the Archived PM Blocks page to the PM Blocks page.
The must be installed.
See the permissions or ask your Administrator for assistance.
. The Archived PM Blocks page displays.
Click the ellipses icon, and then select the Restore PM Block option for the PM Block to restore. The following message displays: The pm block was restored. The PM Block moves from the Archived PM Blocks tab to the PM Blocks tab. See .
Export a PM Block to your local computer. The exported PM Block may then be to the same or another ProcessMaker Platform instance of the same .
The must be installed.
See the permissions or ask your Administrator for assistance.
. The View PM Blocks page displays.
Click the ellipses icon, and then select the Edit PM Block option for the PM Block to export. The Export PM Block page displays.
Enable the Lock PM Block toggle key to prevent the PM Block from being edited after this PM Block is . Since PM Blocks are pre-built functional components that are ready to use in Processes, the Custom option is not available.