ProcessMaker API Documentation
ProcessMaker Examples

Data Connector Package

Access both ProcessMaker Collection records and third-party data sources from any ProcessMaker asset, including ProcessMaker Screens, ProcessMaker Scripts, and Process models.


The Data Connector package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Data Connector package can be installed in your ProcessMaker instance.

Use the Data Connector package to connect your ProcessMaker assets, such as ProcessMaker Screens, ProcessMaker Scripts, and ProcessMaker Collections to and from 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. Incorporating data from external data sources such as APIs 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.

The Data Connector package has the following components after it is installed to your ProcessMaker instance:

  • Manage ProcessMaker Data Connectors: Manage your ProcessMaker Data Connectors from one place. After your ProcessMaker Data Connectors are configured, your Process designers can access them from their ProcessMaker assets.

  • Process model connector: A Data Connector connector is a control that integrates into Process Modeler. Use the Data Connector connector as you would BPMN controls: drag and place the Data Connector connector into your Process model, configure its settings, and then add its incoming and outgoing Sequence Flow elements.

  • Screen Builder controls: Interact with ProcessMaker Collection records and third-party data source directly from within specific Screen Builder controls, such as the Select List and Record List controls.

Video Example

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