PM Blocks

Understand what PM Blocks are in ProcessMaker Platform.

Plan Availability:

What is a PM Block?

A PM Block is a reusable Process Modeler object composed of a set of other objects designed to serve a specific purpose or function. Process designers can place a PM Block into a process as its own object and then configure it as a functional unit. The process designer developing a business solution does not need the technical skills to compose the PM Block.

PM Blocks have the following key features:

• PM Blocks are pre-built, packaged Processes: PM Blocks are ready-to-use, packaged Processes with their own configuration settings designed by the PM Block author who built the PM Block.

• PM Blocks are reusable: PM Blocks are reusable by any Process Designer with appropriate permissions. This allows PM Blocks be quickly configured and deployed regardless of technical expertise or the involvement of Administrators.

• PM Block are customizable: While building a PM Block, configure custom settings and global variables that the Process Designer uses to implement that PM Block.

• Built in Process Modeler: PM Blocks are built in the Modeler, saved as a Process, and then saved as a PM Block. Process Designers can design complex functionality that other Designers may leverage with no technical skills.

• Current processes can be saved as PM Blocks: Any user with appropriate permissions may save a Process as a PM Block..

• PM Blocks are accessible in the Modeler: Within the Modeler, PM Blocks are available in a separate tab from the Object menu on the left.

• PM Blocks can be exported/imported: PM Blocks can be imported/exported to other ProcessMaker Platform instances. While exporting, the PM Block can be locked to prevent editing. When locked, that PM Block may only be used in Processes and other PM Blocks but not edited.

View all PM Blocks

Permissions

Your user account or group membership must have the "PM Blocks: View PM Blocks" permission to view and search for 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 PM Block Categories:

1. Log on to ProcessMaker Platform.

2. Click the Designer option from the top menu. The Designer Welcome Screen displays.

3. Click the PM Blocks icon from the left sidebar. The PM Blocks tab displays all PM Blocks in the PM Blocks page.

PM Blocks tab shows all for PM Blocks

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.

• 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 user profile's 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 user profile's Time zone setting is specified.

Create a PM Block

See Create a New PM Block.

Import a PM Block

Click the Import button. See Import a PM Block.

Edit a PM Block

Click the menu, and then select the Edit PM Block option. See Edit a PM Block. 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.

Otherwise, the Edit PM Block option is not available.

Configure a PM Block

Click the menu, and then select the Configure PM Block option. See Configure a PM Block.

Export a PM Block

Click the menu, and then select the Export PM Block option. See Export a PM Block.

Archive a PM Block

Click the menu, and then select the Archive PM Block option. See Archive a PM Block.

No PM Blocks?

If no PM Blocks exist, the following message displays: No Data Available

Search for a PM Block

Use the Search function to filter all PM Blocks from the PM Blocks page based on your entered text.

Follow these steps to search for a PM Block:

1. View your PM Blocks. The PM Blocks page displays.

2. Enter in the Search setting the text to filter Screens 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.

   • Category: Filter by the PM Block Category name that displays in the Category column.

   • 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.

Related Topics

Guidelines and Best Practices to Build and Use PM Blocks

Manage PM Block Categories

Create and Edit a PM Block

Configure a PM Block

Add a PM Block to a Process

Import and Export a PM Block

Archive and Restore a PM Block