Skip to main content


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

Integrating with Microsoft Outlook by using the Pega for Outlook Office add-in

Updated on February 26, 2021

Pega Sales Automation provides a Pega for Outlook Office add-in that you can use to integrate your application with multiple client types depending on Exchange server versions.

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 Pega Sales Automation Implementation Guide Pega Sales Automation Implementation Guide Pega Sales Automation Implementation Guide
Note:
  • For a list of limitations on the Pega for Outlook Office add-in, see Pega for Outlook add-in and Pega for Outlook VSTO add-in comparison.
  • Pega Sales Automation does not support Internet Explorer. To use the Pega for Outlook Office add-in, use the Microsoft Edge browser.
  • To display the add-in in Outlook, the add-in uses the browser. The browser that is used is determined by the operating system, the Office version, and whether the Edge WebView2 (Chromium-based) is installed. For more info, see Browsers used by Office Add-ins on the Microsoft documentation site.

With the Pega for Outlook Office add-in, you can perform the following actions:

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

The Pega for Outlook Office add-in supports the following features:

  • Single sign-on (SSO) – after you log in to the add-in for the first time, you can access it from any device, without reentering your login credentials.
  • Pinnable taskpane – leave the add-in taskpane open in your mailbox when you switch between messages.
Note: Only Outlook 2016 for Windows and Outlook Online support Pinnable taskpane. For more information, see Pinnable taskpane.

If you customize your URL pattern by replacing prweb in your URL with a custom value, you must override the OutlookLogin.js and OutlookAddIn.js script files in your implementation layer. Email and appointment replies also support Pinnable taskpane.

Integration prerequisites

  • Verify that your server is SSL enabled (HTTPS).
  • Verify that third-party cookies are enabled for your browser. To learn how to enable cookies, see your browser's online documentation.
  • If you are using Microsoft Edge to access a private server, add https://outlook.office.com to your list of trusted websites.
  • To configure the Outlook add-in on iPhone in Safari, you must first allow cross-site tracking in Safari.

Configuring the Web server

Configure your Sales Automation server for the Pega for Outlook Office add-in user by adding the AddIn folder and entering your authentication credentials.

The AddIn folder contains the required images for your Pega for Outlook Office add-in integration.
Note:
  • You can replace the Pega-provided icons in the AddIn/Images folder with your own images. However, you must use the Pega-provided icon names for your images because these names are referenced in the manifest URLs.
  • If you have a Pega Cloud services installation, do not perform this procedure and go to the "Configuring the Web server for Pega cloud" procedure, instead.
  1. Download the following AddIn folder: AddIn folder.
  2. Open the WinSCP Login dialog box and log in to your server.
  3. Add the AddIn folder to the/opt/tomcat/webapps directory.
  4. If you are using Tomcat 7 or later, to designate the Pipe symbol (|) as a valid character in your query parameters, in the /opt/tomcat/conf directory, add tomcat.util.http.parser.HttpParser.requestTargetAllow=|{} to catalina.properties.
  5. Authenticate the Pega for Office Outlook add-in user. To do it, in the /opt/tomcat/webapps/prweb/WEB-INF folder, open the web.xml file and add the following servlet and servlet mappings:
    <servlet>

<servlet-name>OutlookAddIn</servlet-name>
                    <display-name>OutlookAddIn</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>OutlookAddIn</param-value>

                               </init-param>

                                <init-param>

                                      <param-name>AuthService</param-name>

                                                <param-value>OutlookAddinService</param-value>

                                </init-param>

                </servlet>

               <servlet-mapping>

                                <servlet-name>OutlookAddIn</servlet-name>

                                <url-pattern>/OutlookAddIn</url-pattern>

                </servlet-mapping>

                <servlet-mapping>

                                <servlet-name>OutlookAddIn</servlet-name>

                              <url-pattern>/OutlookAddIn/*</url-pattern>

                </servlet-mapping>

Configuring the Web server for Pega Cloud services

Configure the Web server when have a Pega Cloud services installation. Web server configuration for Pega Cloud installations is different than the configuration without Pega Cloud.

  • Do not manually add servlets to the web.xml file, because Pega Cloud already adds the servlet.
  • To find the servlets, in the header of Dev Studio, click ConfigureSystemSettingsServlet Management.
  • Do not add tomcat.util.http.parser.HttpParser.requestTargetAllow=|{} to catalina.properties.
  1. To customize the add-in images, replace the binary files Icon80, Icon64, Icon32, Icon16 with your own images.
  2. If you want to change the names of the binary files, you must replace them in the OAddinManifest.xml file.

Configuring the manifest file

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

Before you begin: If you are authenticating the Pega for Outlook Office add-in by using a custom single sign-on (SSO), follow the instructions in the "Authenticating the Pega for Outlook Office add-in using a custom single-sign-on (SSO)" section.
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.
  1. In the top-right corner of App Studio, click ResourcesApplication Guides.
  2. Open the MLP guide and go to the "Configure Pega for Outlook add-in" section.
  3. In the "Configure Pega for Outlook add-in" section, click Configure manifest file.
  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 add-in.
    5. In the Group label field, enter a label that you want to add for the Outlook header bar of the Outlook add-in group.
    6. Select either the Default or Custom authentication type.
  5. Click Download manifest.
  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 the User portal, go to Microsoft Integration, and paste the GUID into the Exchange sync identifier field.
  8. Click Save.

Configuring settings for the Pega for Outlook Office add-in

To determine how the Pega for Outlook Office add-in handles attachments and to specify the internal domains to filter out from the Add a Person list for emails and appointments, configure the settings in Pega Sales Automation. Configuration is divided into App Studio settings and Developer settings.

  1. In the User portal, from the Explorer panel, select Administration.
  2. Go to Microsoft Integration, and complete the following steps:
    1. In the Internal domains field, enter the internal domains that you want to filter out when populating the Add a Person list for emails and appointments. For example, if you enter in.pega.com, any email or appointment recipients that have the domain @in.pega.com do not display in the Add a Person list. If you enter multiple domains, enter the domain names as comma-separated values. For example, pega.com, in.pega.com.
    2. Paste the GUID generated as part of the "Configuring the manifest file" task into the Exchange sync identifier field.
    3. Optional: If you want to process attachments when synchronizing emails and appointments, select the Process attachments checkbox. For more information, see Configuring Pega Sales Automation to Microsoft Exchange calendar integration.
    4. Click Save.
  3. Enter the certificate location to validate the JWT token, which is used to establish SSO across devices. To do this, in Dev Studio, go to RecordsSecurityKeystoreOffice365.
    • If you have Office 365, no action is needed.
    • If you are using an on-premises Exchange 2013 or 2016 server, change the KeyStore URL to reflect your Exchange URL. For example, if you are using an Exchange 2013 server with the URL mail.in.company.com, then your KeyStore URL is https://mail.in.company.com /autodiscover/metadata/json/1/.
  4. In Dev Studio, configure an Email Listener account. To do this, go to RecordsIntegration ResourcesEmail ListenerOfficeAddInComposeView and make sure that the listener address in the Email account field is correct.
    It is recommended not to have multiple listeners configured with the same email account (within or across systems).
    1. Optional: If the synchronization is not automatic, configure the Email Listener account to use the IMAP option (send event invitations in iCalendar format) in Exchange Server.
    2. Optional: If you are using Office 365 mailbox, configure the Mail settings. Open Mail SettingsPOP/IMAP settings and select the Send Event Invitations in iCalendar format. chcek box
  5. Enable sync in the compose view.

Authenticating the Pega for Outlook Office add-in by using a custom single-sign-on (SSO)

The Pega for Outlook Office add-in includes an authentication service called OutllookAddInService (servlet name: OutlookAddIn) that enables you to use a single sign-on (SSO) functionality. The authentication service uses Pega Sales Automation operator credentials and a Microsoft Exchange Server JWT token to validate users.

You can use your organization's SSO service to allow authentication by using network credentials, rather than the Microsoft Exchange Server JWT token.
  1. Open the OAddinManifest.xml file.
  2. Search for the OutlookAddIn servlet and replace it with your SSO servlet.
  3. Search for [email protected]&pzAuth=guest and replace it with pyActivity=Data-Portal.OutlookLogin.
    Result: The URL should now appear as: https://pegadevap.murex.com/prweb/sso?pyActivity=Data-Portal.OutlookLogin.
  4. Log in to Dev Studio.
  5. In the Records explorer, click SysAdminAuthentication Service.
  6. Select your SSO and copy your identity provider (idP) domain name. Make sure the domain is https.
  7. In the manifest file, add your idP domain under the <AppDomains> element.
  8. Import the manifest file for your mailbox user account and verify the add-in.
  9. In the Dev Studio header search text field, search for and select the Outlookaddin.js file.
  10. Find the following two lines in the Outlookaddin.js 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);
  11. Add your SSO servlet after prweb in each line ("/prweb/SSO").
    For 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

Publishing the Pega for Outlook Office add-in as an organizer to all mailbox users

If you need to publish the Pega for Outlook Office add-in to all mailbox users, complete the following steps.

  1. Log in to Microsoft Office 365 as an admin user and open the Microsoft Exchange Admin center.
  2. Click AdminExchangeOrganizationAdd-ins.
  3. Click AddAdd from File.
  4. Upload and install the OAddinManifest.xml file that you configured for your Pega for Outlook Office add-in.
    1. Log in to Pega Sales Automation as an administrator.
    2. In the header of Dev Studio, in thesearch box, search for and select the OAddinManifest.xml file.
    3. Click Download file.
    4. Open the file and change the Pega-provided URLs to match the URLs for your implementation.
  5. Double-click the application to open the Edit Add-in settings window and review the default settings.
    If you select Optional (disabled by default), your users must manually enable the add-in.

Publishing the Pega for Outlook Office add-in to an individual mailbox user

If you need to publish the Pega for Outlook Office add-in to only one mailbox user, complete the following steps.

  1. In your Microsoft Office 365 inbox, in the top right-hand corner of the screen, click the gear icon.
  2. In the Settings pane, click Manage add-ins.
  3. Click Click here to add a custom add-in.
  4. Click Add from file and upload the OAddinManifest.xml file that you configured for your Pega for Outlook Office add-in.

Calendar items update from Pega Sales Automation User portal

The order in which you configure the Microsoft Exchange calendar integration and the Pega for Outlook Office add-in impacts your ability to update calendar items from the Pega Sales Automation User portal.

If you configure the Microsoft Exchange calendar integration after enabling the Pega for Outlook Office add-in, you will not be able to update the calendar items from the Pega Sales Automation User portal. Meetings synchronized using the Outlook add-in cannot be updated in the portal until you run the MigrateOfficeAddinAppointment activity.

Tags

Pega Sales Automation 8.7

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