ProcessMaker API Documentation
ProcessMaker Examples

Data Connector Package

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

Overview

The Data Connector package must be installed.

Use the Data Connector package to connect your ProcessMaker assets, such as Screens, Scripts, and Collections to and from third-party data sources such as Application Program Interfaces (APIs). After a Data Connector is created, Process Designers can reference the data source via the 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 Data Connectors:

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

  • In Screen Builder, use a Watcher to act on data from a 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 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:

  • Manage Data Connectors: Manage your Data Connectors from one place. After your 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 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 Data Connectors call third-party Application Program Interfaces (APIs), and then use that data in Processes.

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

Related Topics