How to Use This Document

Welcome to documentation. This is a good place to start.

Overview

ProcessMaker Platform is a next-generation intelligent business process management software (iBPMs) platform for the enterprise to easily design and implement BPMN 2.0 compliant business processes within a modern and extensible system.

ProcessMaker Platform is a low-code, intelligent BPM platform for enterprises that want to get to, and stay ahead of, digital transformation. ProcessMaker Platform orchestrates both people, processes, and systems to build strong, future-proof companies to outlast the competition and become engines for innovation.

Our latest release empowers business users and developers alike to use the most cutting-edge workflow automation tools to digitally transform any business for success. ProcessMaker Platform builds on popular BPM and workflow features and contains elegant functionality in our most powerful platform yet.

Our goal for ProcessMaker Platform is to deliver simplicity, but to allow complexity. ProcessMaker Platform is easy to use, and allows you to design customized processes and end-user experiences.

Use This Document Based on How You Use ProcessMaker Platform

This document is organized based on how different roles use ProcessMaker Platform. Refer to the following roles:

• Administrator

• Process Designer

• Developer

• User

Administrator

An Administrator administers ProcessMaker Platform.

Refer to the Install ProcessMaker Platform section that includes the following topics:

• On-Premises Server Requirements

• Download the Open-Source Edition for On-Premises Installation

Refer to the ProcessMaker Platform Administration section that includes the following topics:

• User Management

• Group Management

• Permission Descriptions for Users and Groups

• Client Authentication Management

• Customize the User Interface

• Queue Management

• Script Executor Management

Learn about how to extend ProcessMaker Platform functionality by adding packages.

Process Designer

A Process Designer designs and maintains Processes and their assets that people use to make Requests.

Refer to the Manage and Model Processes section that includes the following topics:

• Process Management

• Script Management

• Screen Management

• Reference Magic Variables in Assets

• Environment Variable Management

• Process Modeling

• Vocabularies Management

Developer

A Developer extends out-of-the-box ProcessMaker Platform functionality in the following ways:

• Develop Scripts that Process designers use in Processes.

• Manage and develop Scripts in Script Editor.

• Learn how to access our API.

User

A user is a person whose interaction with ProcessMaker Platform is to participate in Requests, their Tasks, and/or Collections.

Refer to the Use ProcessMaker Platform section that includes the following topics:

• Log On to ProcessMaker Platform

• Profile Settings

• View ProcessMaker Platform Version Information

• Session Timeout Warning

• Log Out of ProcessMaker Platform

• Requests

• Task Management

• File Management

• Search Data Using ProcessMaker Query Language (PMQL)

• Saved Searches

• Notifications

• Control How Tabular Information Displays

Document Conventions

This document uses different font styles, types, and weights to represent types of information. The conventions described below are used in paragraphs and do not represent style variations in document titles or headers, nor standard document conventions such as for hyperlinks.

The table below describes these document conventions.

Convention	Description	Examples
Bold	Represents the following: Application labels such as for menus, fields, and panels Application messages displayed to the user	Click the Submit button. The following message displays: The file was saved successfully.
Code	Represents the following: File extension types Code samples and code blocks	A .deb file extension is downloaded. npm install