ProcessMaker API Documentation
Script Central

Edit a Data Connector

Edit how to connect to the data source in a ProcessMaker Data Connector.

Edit Details for a ProcessMaker Data Connector

ProcessMaker Package Required

The Data Connector package must be installed in your ProcessMaker instance. 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 Connectors package can be installed in your ProcessMaker instance.

Permissions Required

Your user account or group membership must have the following permissions to edit details for a Data Connector unless your user account has the Make this user a Super Admin setting selected:

  • Data Connectors: Edit Data Connectors

  • Data Connectors: View Data Connectors

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

Follow these steps to edit the details for a ProcessMaker Data Connector:

  1. View your ProcessMaker Data Connectors. The Data Connectors page displays.

  2. Click the Edit iconfor the ProcessMaker Data Connector to edit. The Details tab displays.

  3. Edit the following information about the ProcessMaker Data Connector as necessary:

    • In the Name setting, edit the name of the ProcessMaker Data Connector. ProcessMaker Data Connector names must be unique in your organization and can only use apostrophe characters (') and spaces. This is a required setting.

    • In the Description setting, edit the description of the ProcessMaker Data Connector.

    • From the Category drop-down menu, select one or more Data Connector Categories to associate with this ProcessMaker Data Connector. In doing so, Data Connector Categories may be sorted from the Data Connectors page. To remove a Data Connector Category that is currently selected, click theicon for that selection or press Enter when the drop-down is visible. This is a required setting.

  4. Click Save. The following message displays: The Data Connector was saved.

Edit Authorization

ProcessMaker Package Required

The Data Connector package must be installed in your ProcessMaker instance. 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 Connectors package can be installed in your ProcessMaker instance.

Permissions Required

Your user account or group membership must have the following permissions to edit authorization for a Data Connector unless your user account has the Make this user a Super Admin setting selected:

  • Data Connectors: Edit Data Connectors

  • Data Connectors: View Data Connectors

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

Follow these steps to edit the details for a ProcessMaker Data Connector:

  1. View your ProcessMaker Data Connectors. The Data Connectors page displays.

  2. Click the Edit iconfor the ProcessMaker Data Connector to edit. The Details tab displays.

  3. Click the Authorization tab.

  4. From the Method drop-down menu, select how the Data Connector authenticates with the data source:

    • No Auth: Select the No Auth option to not send authorization details when connecting to the data source. Note that there is no security using this option.

    • Basic Auth: Select the Basic Auth option to send a verified username and password when connecting to the data source. Configure these authorization credentials after the ProcessMaker Data Connector is created.

    • Bearer Token: Select the Bearer Token option to send an access token when connecting to the data source. Get the access token after the ProcessMaker Data Connector is created. ProcessMaker Data Connectors that connect to ProcessMaker Collections use Bearer Token authorization method.

    • Auth 2.0 Password: Select the Auth 2.0 Password option to use Password grant type as part of the OAuth 2.0 authentication protocol to connect to the data source. In doing so, first get an access token from the data source owner, and then use that token to authenticate future connections directly to that data source. Configure the OAuth 2.0 authentication credentials after the ProcessMaker Data Connector is created.

Endpoints

ProcessMaker Package Required

The Data Connector package must be installed in your ProcessMaker instance. 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 Connectors package can be installed in your ProcessMaker instance.

Permissions Required

Your user account or group membership must have the following permissions to edit Endpoints for a Data Connector unless your user account has the Make this user a Super Admin setting selected:

  • Data Connectors: Edit Data Connectors

  • Data Connectors: View Data Connectors

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

Related Topics