Skip to main content

Connecting to the Outlook Office add-in or Gmail extension (8.5.1 update)

Suggest edit Updated on January 21, 2021

The 8.5.1 patch release introduces updates to how you connect to the Outlook Office add-in and Gmail extension.

 

Outlook update

For Outlook, the "Configuring the manifest file" procedure has an additional substep 4.6, compared to the initial version in Integrating Pega Sales Automation with Microsoft Outlook by using the Pega for Outlook Office add-in.

Note: Generate the manifest file in every instance and use only that particular manifest file to launch the Outlook Office add-in. Starting with the 8.5 release, manifest files are instance specific, so each manifest file must be individually generated.

Configuring the manifest file

To provide your URLs for the Pega for Outlook Office add-in, configure the manifest file.

  1. In the navigation pane of App Studio, click Settings > Application Settings.
  2. Open the Microsoft Exchange tab.
  3. In the Office add-in only section, click Configure Manifest.
  4. Configure the manifest file the following way:
    1. In the Display Name field, enter the Outlook Office add-in display name.
    2. In the Instance details field, enter the Pega instance URL with port (if applicable).
    3. In the Application name field, enter the name of your application (This is used only to identify the manifest file).
    4. In the Icon label field, enter a label that you want to add for the Outlook header bar of the Outlook Office add-in.
    5. In the Group label field, enter a label that you want to add for the Outlook header bar of the Outlook Office add-in group.
    6. Select either the Default or Custom authentication type.
  5. Click Download.
  6. In the dialog box that is displayed after the system downloads the file, copy the Outlook Office add-in manifest's unique identifier (GUID).

    The Add-in manifest's unique identifier is used when the Outlook Office add-in is published by an administrator at the organizational level, and if clients are Mac Outlook client users.

  7. In App Studio, on the Microsoft Exchange tab, in the Configure manifest files section, paste the GUID into the Add-in manifest unique identifier(GUID) field.
  8. Click Save.

 

Gmail update

For Gmail, perform the two procedures "Configuring Pega Sales Automation" and "Configuring extension points" in the order presented in this article. Additionally, the "Configuring Pega Sales Automation" procedure has new steps: 2, 3 and 4, compared to the initial version in Connect to Gmail by using the Chrome extension. The "Configuring extension points" procedure has an updated step 3, compared to the initial version in Connect to Gmail by using the Chrome extension.

Configuring Pega Sales Automation

  1. In App Studio, click Settings > Application Settings.
  2. On the Features tab, in the Google Integration section, select either the Default or Custom (SSO) authentication type and click Save.
  3. When the Generate Gmail URL button is enabled, click on 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 task.
  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 in Connect to Gmail by using the Chrome extension.
  7. In Dev Studio, add the GmailExtension portal to the available portals list.
  8. Depending on the authentication type, perform one of the following actions:
    • If you are using the default authentication type, add the 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 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 based on 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 extension points

  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. 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, complete the following steps:
    • For Microsoft Windows users, push registry entities by using the 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 the quick start with Chrome browser on Mac, see the documentation provided in the Google Chrome Enterprise Help.

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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