ProcessMaker API Documentation
Script Central

Get Started with ProcessMaker

Watch our videos to quickly get started with ProcessMaker.

Overview

Get started with ProcessMaker by watching our videos how to do technical and advanced functions. Visit this page often to see new videos. Please note that some videos may display proof-of-concepts and/or slightly outdated user interfaces; use these videos for educational purposes only and not for your production development.

Videos are organized into sections based on their content.

Marketing Eye Candy

This section contains marketing videos for your eye-candy pleasure.

Create a Process
"Leave of Absence" Request
"Expense Report" Request
"Purchase" Request
Create a Process

See how easy it is to create a Process in ProcessMaker.

  • Intended audience: General and new users

  • Viewing time: 1 minute; no narration

  • Tags: create Process; create workflow; Process design; design Process; workflow design; design workflow; video

"Leave of Absence" Request

See how easy it is to start a Request for a "Leave of Absence" Process.

  • Intended audience: General and new users

  • Viewing time: 5 minutes to watch the four-part video series; no narration

  • Tags: start Request; start Process; start workflow; Leave of Absence Process Request; HR; human resources; video

"Expense Report" Request

See how easy it is to start a Request for a "Expense Report" Process.

  • Intended audience: General and new users

  • Viewing time: 3 minutes to watch the three-part video series; no narration

  • Tags: start Request; start Process; workflow; Expense Report Process Request; HR; human resources; financial; approval; rejection; Process approval; PDF Generator connector; video

"Purchase" Request

See how easy it is to start a Request for a "Purchase" Process.

  • Intended audience: General and new users

  • Viewing time: 5 minutes to watch the five-part video series; no narration

  • Tags: start Request; start Process; start workflow; Purchase Process Request; HR; human resources; financial; approval; rejection; Process approval; video

Develop Processes

This section contains videos discussing Process development proof-of-concepts and ideas how to use ProcessMaker.

Analyze Documents in a "Loan Application" Process
Call Third-Party APIs with Data Connectors
Analyze Documents in a "Loan Application" Process

See how ProcessMaker integrates with third-party services Amazon Textract and UiPath Robotic Process Automation (RPA) so a loan application workflow scans, analyzes, and intelligently routes a Request and provision a bot accordingly.

  • Intended audience: Process designers and business analysts

  • Viewing time: 11 minutes; contains narration

  • Tags: Process design; design Process; workflow design; design workflow; form; web form; design form; form design; analyze documents; Load Application Process Request; API; application program interface; third-party API call; RPA; robotic process automation; banking; financial; loan application; demo; video

Call Third-Party APIs with Data Connectors

Example 1

See how ProcessMaker Data Connectors call third-party Application Program Interfaces (APIs), and then use that data in Processes.

  • Intended audience: Process designers, business analysts, software developers, coding engineers

  • Viewing time: 9 minutes; contains narration

  • Tags: Process design; design Process; workflow design; design workflow; form; web form; design form; form design; ProcessMaker Data Connector; API; application program interface; third-party API call; Screen Builder; Select List control; demo; video

Example 2

This example demonstrates dependent fields: how the options in one Select List control depend on which option is selected from a previous Select List control. This example demonstrates how a Select List control in a ProcessMaker Screen can display the names of major universities around the world as its options in a drop-down menu. The options in this Select List control come from a ProcessMaker Data Connector that calls a third-party Application Program Interface (API) when the ProcessMaker Screen containing the Select List control opens.

  • Intended audience: Process designers, business analysts, software developers, coding engineers

  • Viewing time: 9 minutes; contains narration

  • Tags: Process design; design Process; workflow design; design workflow; form; web form; design form; form design; ProcessMaker Data Connector; ProcessMaker Screen; Screen Builder; Select List control; dependent controls; dependent fields; API; application program interface; third-party API call; higher education; demo; video

Design ProcessMaker Screens

This section contains videos discussing ProcessMaker Screen design using Screen Builder.

Using Screen Builder
Create a Leave Request Form
Populate a Record List from a Collection
Design Dependent Fields
Using Watchers
Using Screen Builder

See how to design interactive web-based forms, called ProcessMaker Screens, using Screen Builder.

  • Intended audience: Process designers, Web designers, graphic designers

  • Viewing time: 3 minutes; no narration

  • Tags: form; web form; design form; form design; ProcessMaker Screen; Screen Builder; Leave Request form; Leave of Absence Request form; employee information; video

Create a Leave Request Form

See how to design a Leave Request form using Screen Builder.

  • Intended audience: Process designers, Web designers, graphic designers

  • Viewing time: 3 minutes; no narration

  • Tags: form; web form; design form; form design; ProcessMaker Screen; Screen Builder; Leave Request form; Leave of Absence Request form; employee information; video

Populate a Record List from a Collection

See how to populate a Record List control from records in a ProcessMaker Collection.

Design Dependent Fields

Example 1

This example demonstrates dependent fields: how the options in one Select List control depend on which option is selected from a previous Select List control. This example demonstrates that after a country is selected from one Select List control, a second Select List control contains as options the states and/or provinces in that selected country.

The Select List control that contains the countries as its options gets those options from a ProcessMaker Data Connector that uses an Endpoint to get the list of countries and their corresponding ISO codes from a third-party application program interface (API). A Watcher monitors when a country is selected, and then another ProcessMaker Data Connector uses an Endpoint to get the list of states and/or provinces from that selected country based on that country's ISO code. The Watcher stores that list of states/provinces as a Request variable in that Request's data so that the second Select List control may access that list to display as its options. The second Select List control's options depend on the first Select List control's selection.

  • Intended audience: Process designers, Web designers, graphic designers, software developers, coding engineers

  • Viewing time: 21 minutes; contains narration

  • Tags: ProcessMaker Data Connector; ProcessMaker Screen; Select List control; dependent controls; dependent fields; API; application program interface; third-party API call; demo; video

Example 2

This example demonstrates dependent fields: how the options in one Select List control depend on which option is selected from a previous Select List control. This example demonstrates how a Select List control in a ProcessMaker Screen can display the names of major universities around the world as its options in a drop-down menu. The options in this Select List control come from a ProcessMaker Data Connector that calls a third-party Application Program Interface (API) when the ProcessMaker Screen containing the Select List control opens.

  • Intended audience: Process designers, Web designers, graphic designers, software developers, coding engineers

  • Viewing time: 9 minutes; contains narration

  • Tags: ProcessMaker Data Connector; ProcessMaker Screen; Select List control; dependent controls; dependent fields; API; third-party API call; higher education; demo; video

Using Watchers

Examples 1 and 2

See how to use Watchers in Screen Builder to monitor when a ProcessMaker Screen control changes value, then perform an action with a ProcessMaker Script or ProcessMaker Data Connector.

Example 1

Example 2

Use the ProcessMaker API and SDKs

This section contains videos how to use the ProcessMaker RESTful Application Program Interface (API) and ProcessMaker's Software Development Kits (SDKs). Every function that you may do in ProcessMaker's elegant and well-designed user interface makes an API call. Since every ProcessMaker function is supported in the ProcessMaker API, ProcessMaker can be white-labeled to run behind the scenes from other SaaS applications. Learn how you can use the ProcessMaker API.

Start a Request Via the API
Use the PHP SDK
Access the Database Via the API
Use the JavaScript SDK
Use Script Executors
Start a Request Via the API

Start a ProcessMaker Request using the ProcessMaker RESTful API.

  • Intended audience: Software developers and coding engineers

  • Viewing time: 2 minutes; contains narration

  • Tags: start Request; start Process; start Request via API; start Process via API; start workflow; start workflow via API; API; ProcessMaker API; application program interface; process_events; Process ID; ProcessID; curl; JSON; token; bearer token; demo; video

Use the PHP SDK

Use the PHP SDK with the ProcessMaker RESTful API from inside of a ProcessMaker Script.

  • Intended audience: Software developers and coding engineers

  • Viewing time: 2 minutes; contains narration

  • Tags: PHP; SDK; software development kit; ProcessMaker Script; Script Editor; API; ProcessMaker API; application program interface; getProcessesRequests; token; bearer token; demo; video

Access the Database Via the API

Make calls against the ProcessMaker database using the ProcessMaker RESTful API.

  • Intended audience: Software developers and coding engineers

  • Viewing time: 6 minutes; contains narration

  • Tags: Process design; design Process; workflow design; design workflow; database; API; ProcessMaker API; application program interface; token; bearer token; JSON; curl; demo; video

Use the JavaScript SDK

Use the JavaScript SDK with the ProcessMaker RESTful API from inside of a ProcessMaker Script.

  • Intended audience: Software developers and coding engineers

  • Viewing time: 4 minutes; contains narration

  • Tags: JavaScript; JS; Node; SDK; software development kit; ProcessMaker Script; Script Editor; API; ProcessMaker API; getProcessesRequest; application program interface; token; bearer token; demo; video

Use Script Executors

Use a ProcessMaker Script Executor to call the Google API that requires a custom Google class called Google Client. See how ProcessMaker Script Executors can securely run custom code or packages that a sanctioned third-party Application Program Interface (API) or Software Development Kit (SDK) requires to successful call that resource.

  • Intended audience: ProcessMaker Administrators, software developers, and coding engineers

  • Viewing time: 3 minutes; contains narration

  • Tags: JavaScript; JS; Node; R; Python; Lua; PHP; SDK; software development kit; ProcessMaker Script Executor; ProcessMaker Script; API; Google API; application program interface; demo; video

Administer ProcessMaker

This section contains videos discussing how to administer ProcessMaker.

Administer Script Executors
Administer Script Executors

Use a ProcessMaker Script Executor that includes a Docker RUN command to package the Google Client class provided by Google into that Script Executor, thereby allowing ProcessMaker Scripts using that Script Executor to successfully call the Google Application Program Interface (API).

  • Intended audience: ProcessMaker Administrators, software developers, and coding engineers

  • Viewing time: 3 minutes; contains narration

  • Tags: JavaScript; JS; Node; R; Python; Lua; PHP; SDK; software development kit; ProcessMaker Script Executor; ProcessMaker Script; API; Google API; application program interface; demo; video