Skip to main content


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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Integrating Pega Sales Automation with Microsoft Outlook by using the Pega for Outlook VSTO add-in

Updated on September 10, 2021

Pega Sales Automation provides a Pega for Outlook VSTO add-in that allows you to integrate your application with Microsoft Outlook 2010, 2013, or 2016.

With the Pega for Outlook VSTO add-in, you can search, open, and display Pega sales Automation leads, contacts, and opportunities from within Microsoft Outlook. You can also create emails, appointments, activities, and contacts in Microsoft Outlook and synchronize them with Pega Sales Automation.

For a list of Pega for Outlook Office add-in limitations, see Using Pega for Outlook with Pega Sales Automation.

Prerequisites

  • Microsoft .NET Framework 4.5
  • Microsoft Outlook version 2010, 2013, or 2016

To configure and install the Pega for Outlook VSTO add-in, complete the following steps:

Configuring settings for the Pega for Outlook VSTO add-in

Configure settings in Pega Sales Automation to control the display of the Pega for Outlook VSTO add-in, determine how the add-in handles attachments, and specify internal domains to filter out from the Add a Person list for emails and appointments.

  1. In the App Studio Explorer panel, click Settings > Application Settings.
  2. Click the Microsoft Exchange tab.
  3. In the Outlook add-in settings section, enter the Internal domains that you want to filter out when populating the Add a Person list for emails and appointments.
  4. In the VSTO add-in only sections, to determine how the add-in displays in Pega Sales Automation, select one of the following Side panel configuration options:
    • Explorer Only – The side panel opens by default in Explorer, but a button displays in Compose, Reply, and Read Only Inspector. Recommended for 32 bit.
    • Explorer Compose & Reply – The side panel opens by default in Explorer, Compose, and Reply, but a button displays in Read Only Inspector. Suitable for 32 bit.
    • All – The side panel opens by default in all views. Recommended for 64 bit.
  5. In the VSTO add-in only section, in the Maximum side panel width (pixels) field, enter 320.
  6. Click Save.

Installing the Pega for Outlook VSTO add-in

Install the Pega for Outlook VSTO add-in on the workstation of each Pega Sales Automation user who will use the Microsoft Outlook integration.

  1. Exit Microsoft Outlook, if it is already running.
  2. Open the /Install/Optional/PegaForOutlook/ directory from the Pega Sales Automation installation media and launch Pega for Outlook setup.exe.
  3. Follow the Pega Sales Automation Outlook Add-in Setup wizard instructions and complete the installation process.
    If the Microsoft .NET runtime is not already installed, during the installation process, the installer attempts to download and install the appropriate version.
  4. After the installation is complete, launch Microsoft Outlook and confirm that you want to enable the Pega for Outlook VSTO add-in.
  5. In the Pega for Outlook section of the Add-Ins tab, click Login and provide the information that Microsoft Outlook needs to log in to your Pega Sales Automation application, including your Pega Sales Automation server URL, operator ID, and password. If you change the operator's password on the Pega Sales Automation server, you must update the password in the Pega for Outlook section of the Add-Ins tab.

A Pega Sales Automation panel now displays in Microsoft Outlook. The panel shows the relevant organizations, accounts, contacts, leads, and opportunities based on the email or appointment that you are viewing in Microsoft Outlook. You can also search for and create work objects from within the add-in.

Optional: Configuring Microsoft Outlook with custom authentication

To set up custom authentication for Microsoft Outlook, you must create a new AuthenticationServlet dynamic system setting under the PegaFW-Outlook ruleset.

  1. In Dev Studio, click Create > SysAdmin > Dynamic System Settings.
  2. On the Create Dynamic System Settings form, in the Owning Ruleset field, enter PegaFW-Outlook, then enter a Short Description and Setting Purpose for the new setting.
  3. Click Create and Open.
  4. On the Edit Dynamic System Settings form, in the Value field, enter the servlet path of the authentication service.
    For example, if the servlet path is /prweb/PRWebLDAP1, enter PRWebLDAP1 in the Value field.
  5. 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.

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

Close Deprecation Notice
Contact us