ProcessMaker API Documentation
ProcessMaker Examples

What is a Data Connector?

Understand what a ProcessMaker Data Connector is and how ProcessMaker designers can interact with a data source from within their ProcessMaker assets such as Screen Builder and Process Modeler.


In ProcessMaker, a Data Connector connects your ProcessMaker assets to a data source. Data sources may include ProcessMaker Collections and third-party data sources such as Application Program Interfaces (APIs). After a ProcessMaker Data Connector is created, ProcessMaker designers can reference the data source via the ProcessMaker Data Connector from within their ProcessMaker assets. Each ProcessMaker Data Connector is configured with which data source that Data Connector interacts, making it easy for ProcessMaker designers to interact with technical data sources such as APIs. Incorporating data from external data sources helps you make business decisions from information outside of your ProcessMaker instance.

Below are a few ways to use ProcessMaker Data Connectors:

  • In Screen Builder, use the records in a ProcessMaker Collection as Select List control options in a ProcessMaker Screen.

  • In Screen Builder, use a Watcher to act on data from a ProcessMaker Data Connector when the value of a Screen control changes.

  • While modeling a Process, place a Data Connector connector into your Process model to automatically access records from a ProcessMaker Collection records or access external data from a third-party data source to incorporate new information into Requests started from your Process. After this external data has been incorporated into Requests, make business decisions based on that data.

ProcessMaker Data Connectors use Endpoints with which to interact with a data source.

Video Demonstration

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

Video demonstration of a ProcessMaker Data Connector using an API as a data source

Related Topics