Skip to main content

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

Connect to Gmail by using the Chrome extension

Updated on December 21, 2020

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.

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 by 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 on Microsoft Windows and Mac Chrome browsers only, and is valid only for G Suite accounts. It does not work with personal accounts.
What to do next: See the "Installing the Pega for Google Chrome extension" section.

Installing the Pega for Google Chrome extension

To use the Pega for Google Chrome extension, you must install it.

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. From a browser, go to the Chrome Web Store and search for the Pegasystems extension.
  2. Click Add to Chrome.

    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.

    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.

    Result: After the 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.
What to do next: See the "Configuring extension points" section.

Configuring extension points

After you install the Pega for Google Chrome extension, configure the extension points to specify the type of authentication.

  1. Open Chrome, and then open the Pega for Google extension.
    When you open the extension for the first time, the configuration panel is displayed.
  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. Depending on the authentication type, in the Environment field, enter your environment address in the following format:
    • For default, choose https://*****.******.***/prweb.

    • For custom, choose https://*****.****.***/****/SSO.
  4. Leave the Enable verbose logs check box cleared.
  5. Optional: To configure authentication settings for multiple users, perform one of the following actions:
    • 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" """>
      <plist version="1.0"> <dict>
      <key></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://****.***</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.

What to do next: See the "Configuring Google Identity Services" section.

Configuring Google Identity services

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

  1. In your browser, open 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 panel, 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: If you log in for the first time, configure the consent screen by performing the following steps:
    1. Choose the application type.
    2. Add the following scopes:

      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 further configuration.
  8. Use the client ID for Google Identity services authentication.
What to do next: See the "Configuring Pega Sales Automation" section.

Configuring Pega Sales Automation

After you configure Google Identity services, configure Pega Sales Automation to use the Chrome extension.

  1. In the App Studio navigation pane, click SettingsApplication Settings.
  2. On the Features tab, in the Google Integration section, paste the client ID that you generated as part of the "Configuring Google Identity services" task.
  3. In Dev Studio, ensure that the D_LoadAuthorizationConfig data page has the same client ID as the GoogleClientID dynamic system setting.
    If not, remove this data page and start again from the "Configuring Google Identity services" task.
  4. In Dev Studio, add the GmailExtension portal to the available portal's list.
  5. Depending on the authentication type, perform one of the following actions:
    • If you are using 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>
      <init-param> <param-name>PegaEtierClass</param-name><!--COMPONENTS:This was previously -->
      <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 Dev Studio header, search for and select the GmailExtension.js text file and find the following lines:
        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 in 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.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us