ProcessMaker Documentation
ProcessMaker HomeGive Us FeedbackRelease NotesDownload Open-Source Edition
Search…
ProcessMaker 4.2
ProcessMaker Documentation
Quick Links
ProcessMaker Home
Give Us Feedback
Contact Sales
Start Here
How to Use This Document
Get Started with ProcessMaker
Use ProcessMaker
Web Browser Requirements
Log On to ProcessMaker
Profile Settings
View File Manager
View ProcessMaker Product Documentation
View ProcessMaker Version Information
Session Timeout Warning
Log Out of ProcessMaker
Requests
Task Management
File Management
Search ProcessMaker Data Using ProcessMaker Query Language (PMQL)
Saved Searches
Notifications
Control How Tabular Information Displays
JSON: The Foundation of Request Data
What is Request Data?
What is a Request Variable?
What is JSON?
Manage and Model Processes
Process Management
Script Management
Screen Management
Reference Magic Variables in ProcessMaker Assets
Environment Variable Management
Signal Management
Data Connector Management
Vocabularies Management
Process Modeling
ProcessMaker Administration
User Management
Group Management
Permission Descriptions for Users and Groups
Manage Saved Searches
Settings
Client Authentication Management
Customize the User Interface
Queue Management
Script Executor Management
ProcessMaker Collections
User Interface Language Management
Download for On-Premises Installation
On-Premises Server Requirements
Download the Open-Source Edition for On-Premises Installation
Open-Source Edition Installation Instructions
Packages
What is a Package?
ProcessMaker Packages
Actions By Email Package
Advanced Screens Package
Advanced User Package
Auth Package
C# Package
Collections Package
Comments Package
Conversational Forms Package
Data Connector Package
Documentation Package
DocuSign Package
Dynamic UI Package
File Manager Package
Google Places Package
Java Package
PDF Generator Package
Process Optimization Package
Python Package
R Package
Saved Searches Package
Send Email Package
Signature Package
Slack Notification Package
Translations Package
Versioning Package
Vocabularies Package
Web Entry Package
ProcessMaker API Documentation
Access ProcessMaker RESTful API Documentation
ProcessMaker Examples
Collections Examples
Data Connector Examples
Screen Design Examples
Script Executor Examples
Deprecation Notices
Advanced Screens Package
Other Links
Download ProcessMaker Open-Source Edition
ProcessMaker Open-Source Edition Installation Instructions
Privacy Statement
Powered By GitBook
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

Previous
Conversational Forms Package
Next
Documentation Package
Last modified 11mo ago
Export as PDF
Copy link
Edit on GitHub
Contents
Overview
Video Example
Related Topics