ProcessMaker BPM Core
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.
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
Before installing, Nginx needs to be configured to use php-fpm and point to the public folder
composer installphp artisan processmaker:install and follow the instructionsnpm installnpm run devnpx laravel-echo-server init using the following settings:npx laravel-echo-server startphp artisan horizonphp artisan optimize:clear and restart horizonhttps://processmaker.atlassian.net/wiki/spaces/PM4/pages/480149598/Server+Deployment
The online documentation for usage of ProcessMaker 4 can be found by clicking the link below.
https://docs.processmaker.com/
All PRs for PM4 and it's packages should be accompanied by a test.
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.
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=TRUEAt 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.
/**
* ...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.
/**
* @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
/**
* @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
…
text
npm install/processmaker/resources/devhub/pm-font/svg/my-new-icon.svg3.Run the follow command
npm run font4.Run the follow command
npm run dev5.To use your new icon, in any template or component, add the icon as follows:
"left-arrow.svg"File name: "my-jonas-custom-icon.svg"
How to use icon: npm run dev-font
…
env
CASE_RETENTION_POLICY_ENABLED=true
CASE_RETENTION_TIER=1Use 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.
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.
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']);A Gauge can increase or decrease. It is used for values that fluctuate over time.
$gauge = Metrics::gauge('active_jobs', 'Number of active jobs', ['queue']);
$gauge->set(10, ['queue1']);A Histogram measures value distributions by organizing them into buckets. It is ideal for latency or size measurements.
$histogram = Metrics::histogram('http_request_duration_seconds', 'HTTP request duration', ['method'], [0.1, 0.5, 1, 5, 10]);
$histogram->observe(0.3, ['GET']);Each type serves a specific role depending on the data being monitored.
In a controller:
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.testRun the following command to create another tenant:
php artisan tenants:create --domain="another-tenant.test" --name="Another Tenant" --database="another_tenant"
…
php artisan tenants:transitionThis 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
Distributed under the AGPL Version 3
ProcessMaker (C) 2002 - 2020 ProcessMaker Inc.
For further information visit: http://www.processmaker.com/
No open issues yet, or sync has not completed.