View and Search for Data Connectors

View the Data Connectors in your organization.

View All Data Connectors

ProcessMaker Platform displays all Data Connectors in one location. This makes it easy to manage Data Connectors.

Permission

Your user account or group membership must have the "Data Connectors: View Data Connectors" permission to view the list of Data Connectors unless your user account has the Make this user a Super Admin setting selected.

See the Data Connectors permissions or ask your Administrator for assistance.

Follow these steps to view all Data Connectors in your organization:

1. Log on to ProcessMaker Platform.

2. Click the Designer option from the top menu. The Designer Welcome Screen displays.

3. Do one of the following:

   • From the Assets pane in the Designer Welcome Screen, mouse-hover over the Data Connectors icon, and then select View All Data Connectors.
   • Click the Data Connectors icon from the left sidebar. The Data Connectors tab displays all Data Connectors in the Data Connectors page.

"Data Connectors" tab displays all Data Connectors in your organization

The Data Connectors tab displays the following information in tabular format about Data Connectors:

• Name: The Name column displays the name of the Data Connector. If a Collection is created, the automatically created Data Connector that connects to that Collection has the same name as that Collection.

• Debug: Indicates whether debug mode for a Data Connector is enabled or disabled. Theicon indicates debug mode is enabled. Click theicon to enable debug mode for the selected Data Connector. Debug mode is disabled by default.
• Description: The Description column displays the description of the Data Connector. See Edit Details for a Data Connector for more information.

• Connector Type: The Connector Type column displays with which authentication method the Data Connector uses to connect to its data source. It can be REST or SOAP.

• Category: The Category column displays to which Data Connector Category the Data Connector is assigned. If a Collection is created, the automatically created Data Connector that connects to that Collection is assigned to the Generated Category by default.

• Modified: The Modified column displays the date and time the Data Connector was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.

• Created: The Created column displays the date and time the Data Connector was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.

Debug a Data Connector

Click theicon when debug mode is disabled for a selected Data Connector. See Debug a Data Connector.

Search for a Data Connector

Use the Search setting to filter Data Connectors that display.

Create a Data Connector

Click the +Data Connector button. See Create a New Data Connector.

Add a Data Connector to a Project

Click the menu, and then click the Add to Project option. See Add a Data Connector to a Project.

Edit a Data Connector

Click the menu, and then click the Edit icon. See Edit a Data Connector.

Delete a Data Connector

Click the menu, and then centoncelick the Delete icon. See Delete a Data Connector.

No Data Connectors?

If no Connectors exist, the following message displays: No Data Available.

Display Information the Way You Want It

Control how tabular information displays, including how to sort columns or how many items display per page.

Debug a Data Connector

Optionally debug a Data Connector if it does not authenticate properly or to test it.

Click theicon to toggle debug mode for a selected Data Connector. The icon changes toto indicate debug mode is enabled.

Search for a Data Connector

Permission

Your user account or group membership must have the "Data Connectors: View Data Connectors" permission to search for Data Connectors unless your user account has the Make this user a Super Admin setting selected.

See the Data Connectors permissions or ask your Administrator for assistance.

Follow these steps to create a new Data Connector:

1. View your Data Connectors. The Data Connectors tab displays.

2. Enter in the Search setting the text to filter Data Connectors using any of the following criteria:

   • Name: Filter by the Data Connector name that displays in the Name column.

   • Category: Filter by the Data Connector Category name that displays in the Category column.

   • Description: Filter by the Data Connector description that displays in the Description column.

As you enter text into the Search setting, Data Connectors display that match your entered text.

If there are no search results, the following message displays: No Data Available.