External Integration Settings

  • 7 minute(s) read

What are External Integrations?

ProcessMaker Platform faciliates integration with a large library of third-party applications and services, including the following:

  • BambooHR

  • DocuSign

  • GitHub

  • Gmail

  • Microsoft Excel

  • Slack

ProcessMaker Platform integrates with the external drivers in the following manner:

View External Integration Settings

Display all External Integration settings in one location. This makes it easy to manage these settings.

Permissions

Your user account or group membership must have the "Settings: View Settings" permission to view External Integration settings unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

Follow these steps to view all External Integration settings to synchronize users in your organization:

  1. Ensure that you are logged on to ProcessMaker Platform.

  2. Click the Admin option from the top menu. The Users page displays.

  3. Click the Settings icon from the left sidebar to view all settings.

  4. From the Settings panel on the left, expand the Integrations section.

  5. Select External Integrations to view the following details:

    • Setting: The Setting column displays the External Integrations setting name.

    • Configuration: The Configuration column displays the value of the setting and how it is configured.

External Integrations settings to synchronize data in your organization

Add a Driver

Permissions

Your user account or group membership must have the "Settings: View Settings" permission to add a driver unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

Follow these steps to add a driver for an External Registration:

  1. ​View your External Integrations. The External Registrations tab displays.

  2. Click the +Driver button. The Add Driver window displays.

  3. From the Select a Driver dropdown, select one of the following drivers:

    • BambooHR

    • DocuSign

    • GitHub

    • Gmail

    • Microsoft Excel

    • Slack

  4. Click Add Driver.

Configure an External Integration

Expand the options below to view configuration settings for each external integration.

Configure to Connect the BambooHR Server

Before proceeding, ensure that you have the API Key from your registered BambooHR server. For information on how to obtain this key, see BamboHR's Getting Started with the API guide.

Permissions

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

Follow these steps to connect to the BambooHR server:

  1. ​View your External Integrations. The External Integrations tab displays.

  2. Click the Edit icon next to BambooHR to view its settings. If you do not see BamboHR in the list, see instructions on how to dd the driver.

  3. In the API Key setting, enter the API Key from your registered BambooHR account. For more information on how to get the API Key, see Authentication.

  4. In the Domain setting, enter the domain from your registered BambooHR account. The domain is the text just before .bamboohr.com for your domain.

  5. Click Authorize. If authorization is successful, BambooHR will be listed as authorized on the External Integrations page.

Configure to Connect to the DocuSign Server

Before proceeding, ensure that you have the client ID and client secret from your registered DocuSign driver.

Follow these steps to connect to the DocuSign server:

Permissions

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

  1. ​View your External Integrations. The External Integrations tab displays.

  2. Click the Edit icon for the DocuSign setting. The DocuSign screen displays.

  3. In the Client ID setting, enter the client ID from your registered DocuSign driver. If testing DocuSign to get the client ID, see Enable OAuth for Connect.

  4. In the Client Secret setting, enter the client secret from your registered DocuSign driver. If testing DocuSign to get client secret, see Enable OAuth for Connect.

  5. Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.

  6. Enable Use Sandbox if you are using a sandbox account.

  7. Click Authorize. If authorization is successful, the External Integrations page lists DocuSign as authorized.

Configure to Connect the GitHub Server

Before proceeding, ensure that you have the client ID and client secret from your registered GitHub driver.

Permissions

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

Follow these steps to connect to the GitHub server:

  1. ​View your External Integrations. The External Integrations tab displays.

  2. Click the Edit icon for the GitHub setting. The GitHub screen displays.

  3. In the Client ID setting, enter the client ID from your registered GitHub driver. If testing GitHub to get the client ID, see Creating an OAuth app.

  4. In the Client Secret setting, enter the client secret from your registered GitHub driver. If testing GitHub to get the client secret, see Creating an OAuth app.

  5. Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.

  6. In the Repository Name setting, enter the GitHub repository name to restrict query results.

  7. In the User Login setting, enter the GitHub user name to restrict query results.

  8. Click Authorize. If authorization is successful, the External Integrations page lists GitHub as authorized.

Configure to Connect the Gmail Server

Before proceeding, ensure that you have the client ID and client secret from your registered Gmail driver. For information on getting the client ID and secret, see Google's Authentication API guide.

Permissions

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

Follow these steps to connect to the Gmail server:

  1. ​View your External Integrations. The External Integrations tab displays.

  2. Click the Edit icon next to Gmail to view its settings.  If you do not see Gmail in the list, see instructions on how to add the driver.

  3. In the Client ID setting, enter the client ID from your registered Gmail driver. For more information about how to get the client ID, see Obtain OAuth 2.0 credentials from the Google API Console.

  4. In the Client Secret setting, enter the client secret from your registered Gmail driver. For more information about how to get the client secret, see Obtain OAuth 2.0 credentials from the Google API Console.

  5. Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.

  6. Click Authorize. If authorization is successful, the External Integrations page lists Gmail as authorized.

Configure to Connect the Microsoft Excel Server

Before proceeding, ensure that you have the client ID and client secret from your registered Microsoft Excel driver.

Permissions

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

Follow these steps to connect to the Microsoft Excel server:

  1. ​View your External Integrations. The External Integrations tab displays.

  2. Click the Edit icon for the Microsoft Excel setting. The Microsoft Excel screen displays.

  3. In the Client ID setting, enter the client ID from your registered Microsoft Excel driver. If testing Microsoft Excel to get the client ID, see Add a client ID and client secret.

  4. In the Client Secret setting, enter the client secret from your registered Microsoft Excel driver. If testing Microsoft Excel to get the client secret, see Add a client ID and client secret.

  5. Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.

  6. From the Connection Type dropdown, select the service for storing and retrieving Microsoft Excel files such as Amazon S3, Azure Blog Store, Box, Dropbox, Google Cloud Storage, Google Drive, OneDrive, or SharePoint REST.

  7. In the URI setting, enter the Uniform Resource Identifier (URI) for the Microsoft Excel resource location.

  8. Click Authorize. If authorization is successful, the External Integrations page lists Microsoft Excel as authorized.

Configure to Connect the Slack Server

Before proceeding, ensure that you have the client ID and client secret from your registered Slack driver.

Permissions

Your user account or group membership must have the "Settings: Update Settings" permission to edit External Integrations unless your user account has the Make this user a Super Admin setting selected.

See the Settings permissions or ask your Administrator for assistance.

Follow these steps to connect to the Slack server:

  1. ​View your External Integrations. The External Integrations tab displays.

  2. Click the Edit icon for the Slack setting. The Slack screen displays.

  3. In the Client ID setting, enter the client ID from your registered Slack driver. If testing Slack to get the client ID, see Creating a Slack App.

  4. In the Client Secret setting, enter the client secret from your registered Slack driver. If testing Slack to get the client secret, see Creating a Slack App.

  5. Use the copy icon to copy the URL from the Redirect URL setting, and then provide it to your OAuth identity provider.

  6. Click Authorize. If authorization is successful, the External Integrations page lists Slack as authorized.