Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Connecting to Gmail by using the Chrome extension

Updated on February 26, 2021

Pega Sales Automation provides a Pega for Google Chrome extension so that you can boost sales productivity and increase the efficiency of the entire sales process. As a Gmail user, you no longer have to leave Pega Sales Automation in order to see Gmail insights in your explorer view.

Pega Sales Automation Implementation Guide Pega Sales Automation Implementation Guide Pega Sales Automation Implementation Guide Pega Sales Automation Implementation Guide Pega Sales Automation Implementation Guide Pega Sales Automation Implementation Guide

The Pega for Google Extension supports the following features:

  • Single sign-on (SSO) – after you log in to the extension side panel for the first time, you can access it from any other device, without reentering your login credentials.
  • Pinnable task pane – when you switch between messages, you can leave the extension side panel open in your mailbox.

Use the Pega for Google Chrome extension to perform the following actions:

  • Search, open, and display Pega Sales Automation leads, contacts, opportunities, organizations, and accounts.
  • Associate emails or appointments with contacts, leads, opportunities, organizations, and accounts.
  • Create contacts, leads, opportunities, activities, and tasks.

The Pega for Google Chrome extension has the following limitations:

  • The integration of attachments in Google Calendar is not supported.
  • Replies using templates are not supported for calendar events.
  • Calendar events cannot be related to any sales entities before the initial save or send.
  • The Gmail extension works with Microsoft Windows and Mac Chrome browsers only, and is valid only for G Suite accounts. The extension does not work with personal accounts.

Installing the Pega for Google Chrome extension

The Pega for Google Chrome extension is available in the Chrome Web Store.

Before you begin: In your Chrome browser settings, enable third-party cookies by clearing the Block third-party cookies check box. For more information, see the Google Chrome documentation.
  1. In your Chrome web browser, go to the Chrome Web Store and search for the Pegasystems extension.
  2. Click Add to Chrome.

    Result: After installation is complete, a button for the Pega for Google extension is displayed in the top-right corner of the Chrome menu bar with any other existing extension buttons.
  3. Choose how you want to install the extension.
    • For Microsoft Windows users, you can update the Chrome policy in the Extension Settings or Individual Policy (ExtensionInstallForcelist). The Extension Settings policy overrides the Individual Policy. For more information, refer to the suggested articles in the Google Chrome Enterprise Help documentation listed above.
    • For Mac users, to update the policy, use the mcxpreference setting in the configuration profile, or individual policy plist settings in the managed preferences. For more information about how to install extensions for multiple users and Google Chrome policy management, see the ExtensionInstallForcelist section in the Policy List article on The Chromium Projects website.
  4. Optional: If you are a Google administrator, you can install the Pegasystems extension for multiple users by searching for Automatically installing apps and extensions or managing extensions in your enterprise in the Google Chrome Enterprise Help documentation. For more information, search for Chrome policy management in the Google Chrome Enterprise Help documentation.

Configuring Google Identity services

After you configure the extension points, you must configure Google Identity services.

  1. In your browser, open https://console.developers.google.com and log in as an administrator.
  2. Click MenuAPIs & ServicesCredentials.
  3. Select an existing project or create a new project, and then open it.
  4. In the navigation pane, click Library, and then search for and enable Gmail API and Calendar API.
  5. Click Credentials, and then click Create credentialsOAuth client ID.
  6. Optional: To configure the consent screen on a first-time login, perform the following steps:
    1. Choose the application type.
    2. Add the following scopes:

      https://www.googleapis.com/auth/gmail.readonly

      https://www.googleapis.com/auth/calendar.events

      https://www.googleapis.com/auth/calendar.readonly

      https://www.googleapis.com/auth/gmail.modify

      https://www.googleapis.com/auth/gmail.compose

      https://www.goodleapis.com/auth/gmail.labels

      If the scope is set to public, then these scopes are validated by the Google team to verify client IDs.

    3. In the Authorized domains field, enter your private domain.
    4. Add your organization's homepage and privacy policy links.

      For a public application type, this information goes through a verification process.

    5. Save the form and click Submit.
  7. On the OAuth client ID page, perform the following steps:
    1. Select the Web application type.
    2. Enter the name of your application.
    3. Enter the authorized JavaScript origins and authorized redirect URLs.
    4. Click Save.
      The system generates the client ID and client secret code. Copy these details for use in further configuration.
    Note: Use the client ID for Google Identity services authentication.

Configuring Pega Sales Automation

Configure Pega Sales Automation to use the Chrome extension.

Before you begin:
Caution: If you use Pega Cloud Services, see the "Configuring Pega Sales Automation for Pega cloud" procedure instead.
  1. In the navigation pane of App Studio, click SettingsApplication Settings.
  2. On the Features tab, in the Google Integration section, select either the Default or Custom (SSO) authentication type, and then click Save.
  3. When the Generate Gmail URL button is enabled, click the button to generate the Gmail URL.
  4. Copy the Gmail URL. The Gmail URL is your Environment URL that you require later, in the “Configuring extension points” procedure.
  5. On the Features tab, in the Google Integration section, paste the client ID that you generated as part of the "Configuring Google Identity services" procedure.
  6. In Dev Studio, ensure that the D_LoadAuthorizationConfig data page has the same client ID as the GoogleClientID dynamic system setting.
    If the client ID is not the same, remove this data page and start again from the "Configuring Google Identity services" task.
  7. In Dev Studio, add the GmailExtension portal to the available portals list.
  8. Depending on the authentication type that you use, perform one of the following actions:
    • If you use the default authentication type, add the following servlet entry to the web.xml file to support the Google Identity sign-in process.
      <servlet> <servlet-name>GmailExtension</servlet-name> <display-name>GmailExtension</display-name>
<description>Internet Application Composer, using custom authentication techniques</description>
<servlet-​class>com.pega.pegarules.internal.web.servlet.WebStandardBoot</servlet-class>
<init-param> <param-name>PegaEtierClass</param-name><!--COMPONENTS:This was previously com.pega.pegarules.services.HttpAPI -->
<param-​value>com.pega.pegarules.session.internal.engineinterface.service.HttpAPI</param-value> </init-param>
<init-param> <param-name>AuthenticationType</param-name> <param-​value>PRCustom</param-value> </init-param>
<init-param> <param-name>RuntimeServletName</param-name> <param-​value>GmailExtension</param-value> </init-param>
<init-param> <param-name>AuthService</param-name> <param-​value>GmailExtensionService</param-value> </init-param> </servlet>
<servlet-mapping> <servlet-name>GmailExtension</servlet-name> <url-pattern>/GmailExtension</url-pattern> </servlet-mapping>
<servlet-mapping> <servlet-name>GmailExtension</servlet-name> <url-pattern>/GmailExtension/*</url-pattern> </servlet-mapping>
    • If you are using the custom authentication type, perform the following steps:
      1. In the header of Dev Studio, search for and select the GmailExtension.js text file, and then find the following lines inside the file:
        var snapstartURL = prpcURL.concat("/prweb").concat("?pyActivity=").concat("Data-Portal.OutlookViewInBrowser");

var clientURL = prpcURL.concat("/prweb").concat("?pyActivity=").concat("Data-Portal.OutlookViewInBrowser&outlookWO=" +insHandle);
      2. Add your custom servlet to each line, as shown in the following example:
        var snapstartURL = prpcURL.concat("/prweb/SSO").concat("?pyActivity=").concat("Data-Portal.OutlookViewInBrowser");

var clientURL = prpcURL.concat("/prweb/SSO").concat("?pyActivity=").concat("Data-Portal.OutlookViewInBrowser&outlookWO=" +insHandle
      3. Click Save.

Configuring Pega Sales Automation for Pega cloud

Configure Pega Sales Automation to use the Chrome extension.

This procedure is for Pega Cloud services installations only. If you do not use Pega Cloud services, see the "Configuring Pega Sales Automation" procedure instead.
  1. In the navigation pane of App Studio, click SettingsApplication Settings.
  2. On the Features tab, in the Google Integration section, select either the Default or Custom (SSO) authentication type, and then click Save.
  3. When the Generate Gmail URL button is enabled, click the button to generate the Gmail URL.
  4. Copy the Gmail URL. The Gmail URL is your Environment URL that you require later, in the “Configuring extension points” procedure.
  5. On the Features tab, in the Google Integration section, paste the client ID that you generated as part of the "Configuring Google Identity services" procedure.
  6. In Dev Studio, ensure that the D_LoadAuthorizationConfig data page has the same client ID as the GoogleClientID dynamic system setting.
    If the client ID is not the same, remove this data page and start again from the "Configuring Google Identity services" task.
  7. In Dev Studio, add the GmailExtension portal to the available portals list.
    The Pega Sales Automation configuration process for Pega Cloud services is different from the process without Pega Cloud services:
    • Do not add a servlet manually in the web.xml file because Pega Cloud services already adds the servlet.
    • To find the servlets, in the header of Dev Studio, click ConfigureSystemSettingsServlet Management.
  8. In the header of Dev Studio, search for and select the GmailExtension.js text file, and then find the following lines inside the file:
    var snapstartURL = prpcURL.concat("/prweb").concat("?pyActivity=").concat("Data-Portal.OutlookViewInBrowser");

var clientURL = prpcURL.concat("/prweb").concat("?pyActivity=").concat("Data-Portal.OutlookViewInBrowser&outlookWO=" +insHandle);
  9. Add your custom servlet to each line, as shown in the following example:
    var snapstartURL = prpcURL.concat("/prweb/SSO").concat("?pyActivity=").concat("Data-Portal.OutlookViewInBrowser");

var clientURL = prpcURL.concat("/prweb/SSO").concat("?pyActivity=").concat("Data-Portal.OutlookViewInBrowser&outlookWO=" +insHandle
  10. Click Save.

Configuring extension points

Configure the extension points to finalize the process of connecting to Gmail.

  1. Open Chrome, and then open the Pega for Google extension.
    When you open the extension for the first time, the system displays the configuration panel.
  2. Choose either the Default or Custom authentication type.

    • Default authentication uses Google Identity services to log in. After you log in with your credentials and approve the terms and conditions, your Google account is associated with your Pega user account.

    • Custom authentication is recommended for enterprise purposes.

  3. In the Environment field, enter your Environment URL (the Gmail URL) that you copied from App Studio in the Configuring Pega Sales Automation section.
  4. Leave the Enable verbose logs check box cleared.
  5. Optional: To configure authentication settings for multiple users, perform the following steps:

    • For Microsoft Windows users, push registry entities by using the graphics processing unit (GPU).

      For more information, refer to the Configuring Apps and Extensions by Policy topic in the documentation for administrators on The Chromium Projects website.

    • For Mac users, use the plist file or a configuration profile. Add the following code to the plist file:

      <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" ""http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0"> <dict>
<key>com.google.Chrome.extensions.acbnognkfggkichjogfmienjabfhedac</key> <dict>
<key>authdetails</key> <dict>
<key>state</key> <string>always</string> <key>value</key> <dict>
<key>auth_type</key> <string>Default/Custom</string>
<key>url</key> <string>https://****.***.pega.com/prweb</string> </dict> </dict> </dict> </dict> </plist>

      For more information about getting started with Chrome browser on Mac, see the documentation provided in the Google Chrome Enterprise Help.

Tags

Pega Sales Automation 8.6

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us