Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
P

processmaker

> 编程语言
Open source

ProcessMaker BPM Core

538 stars0 likes2 views
WebsiteGitHub

About

ProcessMaker BPM Core

ProcessMaker 4 Documentation

Overview

ProcessMaker is an open source, workflow management software suite, which includes tools to automate your workflow, design forms, create documents, assign roles and users, create routing rules, and map an individual process quickly and easily. It's relatively lightweight and doesn't require any kind of installation on the client computer. This file describes the requirements and installation steps for the server.

Getting Started

If you are new to ProcessMaker 4 and would like to load the software locally, we recommend you download the Dockerized version from https://github.com/ProcessMaker/pm4core-docker

System Requirements

  • Composer 2
  • Node.js 16.18.1
  • NPM 8.9
  • PHP 8.1
  • PHP-FPM
  • PHP GD Extension
  • PHP ImageMagick Extension
  • PHP IMAP Extension
  • Nginx
  • MySql 8.0
  • Redis
  • Docker

Install

Before installing, Nginx needs to be configured to use php-fpm and point to the public folder

  1. Download and unzip a version from the releases page https://github.com/ProcessMaker/processmaker/releases
  2. Configure Nginx to use php-fpm and point to the public folder in the unzipped code. See https://laravel.com/docs/8.x/deployment#nginx
  3. CD into the folder and run composer install
  4. Run the installer php artisan processmaker:install and follow the instructions
  5. Edit the .env file to update any server specific settings
  6. Install javascript assets npm install
  7. Compile javascript assets npm run dev
  8. Configure laravel echo server in a separate shell npx laravel-echo-server init using the following settings:
    1. Do you want to run this server in development mode? Yes
    2. Which port would you like to serve from? 6001
    3. Which database would you like to use to store presence channel members? redis
    4. Enter the host of your Laravel authentication server. Enter your instance's url
    5. Will you be serving on http or https? http
    6. Do you want to generate a client ID/Key for HTTP API? No
    7. Do you want to setup cross domain access to the API? No
    8. What do you want this config to be saved as? laravel-echo-server.json
  9. Then run laravel echo server npx laravel-echo-server start
  10. Run horizon in a separate shell php artisan horizon
  11. If you change any settings, make sure to run php artisan optimize:clear and restart horizon

Installing and upgrading an enterprise instance hosted on AWS

https://processmaker.atlassian.net/wiki/spaces/PM4/pages/480149598/Server+Deployment

Using ProcessMaker 4

The online documentation for usage of ProcessMaker 4 can be found by clicking the link below.

https://docs.processmaker.com/

Testing

All PRs for PM4 and it's packages should be accompanied by a test.

CI/CD

Automated Tests

When ever you open or update a PR, the test suite is run with all packages installed.

If your PR requires branches in other packges or core, you can specify the branch anywhere in the PR body with this tag:

ci::

For example, if you open a PR in core that requires a bugfix branch in connector-send-email, put this in your core PR body text:

ci:connector-send-email:bugfix/FOUR-5059

This works in package PRs as well. To specify a branch in core, use:

ci:processmaker:my-branch-in-core

If no branches are specified in the PR body, the develop branch of each package will be used.

Release Branches and Packages

If your PR is based on a release branch (for example `release-2024-fall > /dev/null 2>&1


#### API

The ProcessMaker API is documented using OpenAPI 3.0 documentation and can be viewed at `/api/documentation`. The documention is generated by adding annotations to Models and Controllers.

You should add annotations to all models and controllers that you create or modify because it's how we generate the SDKs that are used when running scripts.

When developing, make sure to add this to your `.env` file so that any changes you make to the annotations are automatically turned into documentation when you reload the `/api/documentation` page:

```text
L5_SWAGGER_GENERATE_ALWAYS=TRUE

At the comment block at the top of the model, add an @OA annotation to describe the schema. See ProcessMaker/Models/Process.php for an example.

To keep things dry, you can define 2 schemas. One that inherits the other.

php
/**
 * ...existing comments above...
 *
 * @OA\Schema(
 *   schema="ProcessEditable",
 *   @OA\Property(property="process_category_uuid", type="string", format="uuid"),
 *   @OA\Property(property="name", type="string"),
 *   @OA\Property(property="description", type="string"),
 *   @OA\Property(property="status", type="string", enum={"ACTIVE", "INACTIVE"}),
 * ),
 * @OA\Schema(
 *   schema="Process",
 *   allOf={
 *       @OA\Schema(ref="#/components/schemas/ProcessEditable")
 *       @OA\Schema(
 *           type="object",
 *           @OA\Property(property="user_uuid", type="string", format="uuid"),
 *           @OA\Property(property="uuid", type="string", format="uuid"),
 *           @OA\Property(property="created_at", type="string", format="date-time"),
 *           @OA\Property(property="updated_at", type="string", format="date-time"),
 *       ),
 *   },
 *
 * )
 */
class Process extends ProcessMakerModel implements HasMedia
{
...

Now you can use the reference to the schema when annotating the controllers. See ProcessMaker/Http/Controllers/Api/ProcessController.php for an example.

php
    /**
     * @OA\Get(
     *     path="/processes",
     *     summary="Returns all processes that the user has access to",
     *     operationId="getProcesses",
     *     tags={"Process"},
     *     @OA\Parameter(ref="#/components/parameters/filter"),
     *     @OA\Parameter(ref="#/components/parameters/order_by"),
     *     @OA\Parameter(ref="#/components/parameters/order_direction"),
     *     @OA\Parameter(ref="#/components/parameters/per_page"),
     *     @OA\Parameter(ref="#/components/parameters/"),
     *
     *     @OA\Response(
     *         response=200,
     *         description="list of processes",
     *         @OA\JsonContent(
     *             type="object",
     *             @OA\Property(
     *                 property="data",
     *                 type="array",
     *                 @OA\Items(ref="#/components/schemas/Process"),
     *             ),
     *             @OA\Property(
     *                 property="meta",
     *                 type="object",
     *                 allOf={@OA\Schema(ref="#/components/schemas/metadata")},
     *             ),
     *         ),
     *     ),
     * )
     */
    public function index(Request $request)
    {
    ...

And for a show method

php
    /**
     * @OA\Get(
     *     path="/processes/{processUuid}",
     *     summary="Get single process by ID",
     *     operationId="getProcessByUuid",
     *     tags={"Process"},
     *     @OA\Parameter(
     *         description="ID of process to return",
     *         in="path",
     *         name="processUuid",
     *         required=true,
     *         @OA\Schema(
     *           type="string",
     *         )
     *     ),
     *     @OA\Response(
     *         response=200,
     *         description="Successfully found the process",
     *         @OA\JsonContent(ref="#/components/schemas/Process")
     *     ),
     */
    public function show(Request $request, Process $process)
    {
    ...

…

text
$user->createToken('Name it here')->accessToken;

…

text
APP_DEBUG=FALSE
APP_ENV=develop

…

bash
text
npm install
  1. Add the new svg icon file in the /processmaker/resources/devhub/pm-font/svg
/processmaker/resources/devhub/pm-font/svg/my-new-icon.svg

3.Run the follow command

npm run font

4.Run the follow command

npm run dev

5.To use your new icon, in any template or component, add the icon as follows:

RECOMMENDATIONS ABOUT ICONS

  1. We recommend using the file name with '-' for example:
"left-arrow.svg"
  1. To use the icon, we should use the same name of the file, for example:
File name: "my-jonas-custom-icon.svg"
How to use icon: 
  1. To check all the icons
npm run dev-font

…

env
CASE_RETENTION_POLICY_ENABLED=true
CASE_RETENTION_TIER=1

Use 1, 2, or 3. The default is 1 if not set. The default retention period shown in the UI for Tier 1 is one year.

Prometheus and Grafana

This guide explains how to install and run Prometheus and Grafana using Docker. Both tools complement each other: Prometheus collects and monitors metrics, while Grafana visualizes them with interactive dashboards.

Local Development with docker compose

Prometheus & Grafana

Go to the metrics directory

cd metrics

…

php
  $counter = Metrics::counter('http_requests_total', 'Total HTTP requests', ['method', 'status']);
  $counter->inc(['GET', '200']);
  $counter->incBy(2, ['GET', '200']);
  • Number of system errors (e.g., HTTP 5xx).

2. Gauge

A Gauge can increase or decrease. It is used for values that fluctuate over time.

  • Current number of active jobs in a queue:
    php
    $gauge = Metrics::gauge('active_jobs', 'Number of active jobs', ['queue']);
    $gauge->set(10, ['queue1']);
  • Memory or CPU usage.

3. Histogram

A Histogram measures value distributions by organizing them into buckets. It is ideal for latency or size measurements.

  • Duration of HTTP requests:
    php
    $histogram = Metrics::histogram('http_request_duration_seconds', 'HTTP request duration', ['method'], [0.1, 0.5, 1, 5, 10]);
    $histogram->observe(0.3, ['GET']);
  • File sizes or request durations.

Each type serves a specific role depending on the data being monitored.

Example: Incrementing a Counter

In a controller:

php
namespace App\Http\Controllers;

use ProcessMaker\Facades\Metrics;

class ExampleController extends Controller
{
    public function index()
    {
        //use metrics counter
        $counter = Metrics::counter('http_requests_total', 'Total HTTP requests', ['method', 'status']);
        $counter->inc(['GET', '200']); // Incrementa el contador para GET y estado 200.

        return response()->json(['message' => 'Hello, world!']);
    }
}

…


php artisan tenants:enable --migrate

…


valet link another-tenant.test

Run the following command to create another tenant:

php artisan tenants:create --domain="another-tenant.test" --name="Another Tenant" --database="another_tenant"

…


php artisan tenants:transition

This command will create a new tenant for each .env file in the storage/transitions folder.

You must move the tenants storage folder and the resources/lang folder manually

License

Distributed under the AGPL Version 3

ProcessMaker (C) 2002 - 2020 ProcessMaker Inc.

For further information visit: http://www.processmaker.com/

Issues· 0 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

PHPprocessmaker-4

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 17, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言