- 1. Enterprise Connectors
- 2. Connector Wizard
- 3. Connector Library
- 4. executeRestConnector()
- 5. Service Task
- 6. ProcessMaker Endpoints
- 7. Google Connectors
- 8. Adobe Sign Connectors
- 9. DocuSign Connectors
- 10. Alfresco Connectors
- 11. Zimbra Connectors
- 12. SugarCRM Connectors
Google Services and Enterprise Connectors
The following Google connectors are available to be downloaded via the connector public library:
- Google Calendar
- Google Drive
- Google Sheets
Taking into consideration that each one of these connectors have their own configuration and their own defined parameters, it is recommended to read the Google API documentation for Google Calendar, Google Drive and Google Sheets.
The Enterprise Connectors plugin has integration with the Google Calendar API.
Note: If the listCalendar response with the Service Account authentication does not return any information, review the Google OAuth Client ID - G suite permission setting. Otherwise, you can use the Authorization Code authentication.
The Enterprise Connectors plugin has integration with the Google Drive API.
The Enterprise Connectors plugin has integration with the Google Sheets API.
To do this, an authentication configuration named Service Google Account is included by default inside the configuration auth section. This configuration only needs a service account file credential to work successfully.
When using a Google endpoint with PM Connectors particular settings must be configured.
Google Connectors Configuration Example
This example shows how to configure the following:
Configuring the OAuth Client ID
To generate the credential keys needed to integrate ProcessMaker Enterprise Connectors with a Google account, follow these steps:
Access the Google Developers Console page.
In the top navigation menu, click then select menu.
Choose the New Project option.
Enter the Project name, select the Organization and then click Create.
Select the project created.
Click Create Credentials and then click OAuth client ID.
Click CONFIGURE CONSENT SCREEN.
Select Internal in the User Type section and then click CREATE.
Enter the App name and the select the User support email.
Scroll down the page. Enter the Email addresses field and then click SAVE AND CONTINUE.
In the Scopes step, click SAVE AND CONTINUE.
Click BACK TO DASHBOARD.
In the left sidebar menu, select Library.
In the search box, type drive and then select the Google Drive API option.
Click the left sidebar menu and then select Credentials on the APIs & Services option.
Click Create Credentials and then click OAuth client ID.
Select the Application type, enter the name, enter the URIs and then click CREATE.
The Oauth Client was created successfully. Click OK.
The information from this list is used in the Authentication Configuration. To see the Client ID and Client secret values, click the edit icon.
Save the Client ID and Client secret values in a separate file.
Note: If you are integrating with Google Drive APIs, take into account that a service account must have permissions to access the Google Drive folders. For this purpose, you must share your Google Drive folders with the Service Account ID (Email address) configured in this section. For more information about service accounts and IAM roles, see Service accounts.
Enabling Google API
In order to allow the Enterprise Connectors plugin to access the user Google account information, it is necessary to enable the API requests. For this purpose, after the creation of a new Service Account, follow these steps.
In the navigation menu, go to the APIs & Services > Library option.
The API library displays. Go to the G Suite section.
In the G Suite section, enable all Google API libraries needed for the Google connectors.
- Click the Google Calendar API icon or link Google Calendar API to enable the Google Calendar API.
- Click the Google Drive API icon or link Google Drive API to enable the Google Drive API.
- Click the Google Sheets API icon or link Google Sheets API to enable the Google Sheets API.
A similar window displays for each library:
Configuring Google Connectors
Configure Enterprise Connectors in your ProcessMaker instance to correctly run Google Services.
To configure Google Enterprise Connectors, follow these steps:
Go to Admin > PM Connectors > Connectors menu.
The Connectors screen displays. At the top right of the screen, click the Download button to download the necessary connectors from the connectors library.
The Download Connectors from the Library screen displays. In the Services drop-down menu, select one of the following Google connectors.
In this case, select Google Calendar.
All the available connectors for the Google Calendar display in the same screen. Download all the connectors by clicking the Download All button located at the bottom right of the screen.
The connector status changes to Downloaded. Next to the Status column, the Replace button displays for each connector. Click Close.
Note: After downloading all the connectors, the Google Calendar service, and the Service Account Google authentication configuration automatically download.
The connectors are listed. Click Edit for each connector to change its settings.
The Connectors screen displays. In the Services drop-down, ensure that the Google Calendar service is selected. In the Authentication Configuration drop-down menu, ensure that the Service Account Google is selected. Modify all the necessary parameters and finally click Save.
Repeat the last two steps for each connector.
The Service Account Google automatically downloads after you download the Google Connectors. After obtaining the private key from the Google Developers Console page, provide the authorization key to the Service Account Google authentication configuration. Follow these steps to provide the authorization key.
Go to Admin > PM Connectors > Authentication Configuration menu.
The Authentication Configuration screen displays. In the Service Account Google row, click Edit to see and edit the authentication configuration details.
The Authentication Protocol Configuration window displays. Edit the file_credential parameter.
Note: According to the Service Account configuration, the other parameters have been filled out.
The Authentication Protocol Configuration window displays. In the Upload File field, click Choose File, navigate and then select the
.jsonfile generated in the Google OAuth Client ID. Click Save and the Authentication Protocol Configuration window closes.
Finally, click the Test button to test the configuration. If the configuration test is successful, a green message displays at the top of the window. Click the Save button.
The Google Calendar service automatically downloads after you download the Google Calendar Connectors. To see the service details and the Google Calendar version with which connectors are connected, follow the next steps:
Go to Admin > PM Connectors > Services menu.
The Services screen displays. In the Google Calendar row, click Edit to see the Google Calendar service details.
The Services window displays. Click Close.