Article

Synchronizing the Microsoft Exchange calendar with the Pega Application calendar

The Microsoft Exchange to Pega Application calendar integration is a background process that synchronizes your Microsoft Exchange calendar with your Pega Application calendar. With this integration, you can create, update, and cancel appointments in the Pega Application and synchronize them in real time with your Microsoft Exchange server.

To synchronize your calendars, choose one of the following options:

Prerequisites

Before you can configure the Microsoft Exchange to Pega Application calendar integration, you must complete the steps that are required to configure the Pega Application to Microsoft Exchange calendar integration.

To create an appointment in Pega Application and synchronize the appointment with Microsoft Exchange, you must create one impersonation account on Microsoft Exchange with impersonation privileges for all of the users who will manage appointments in the application. With Microsoft Exchange impersonation, one account is acting as another account. When an account is impersonated, the system logs the access as if the impersonated account is acting on the system. The calling account must have the appropriate permissions and email ID to perform impersonation. This allows the user who has impersonation permissions to make calls against the other user's account. The impersonated account is maintained in the EWS_Integration_AuthProfile authentication profile.

  • Create only one impersonation account to manage appointments for all Pega Application users.
  • Your Microsoft Exchange administrator must configure the Microsoft Exchange impersonation account for your Pega Application implementation and provide you with the user name and password so you can update the security profile in the application.

Configuration

To configure your Pega Application to Microsoft Exchange calendar integration, complete the following steps:

Additional information:

Generating a keystore file with SSL certificate

You must generate a keystore file with the appropriate SSL certificate for your Microsoft Exchange integration. The keystore file and SSL certificate are used by Pega Application to communicate securely with your Microsoft Exchange server.

Before you can generate your keystore file, you must install Java.
  1. Retrieve the Exchange Web Services (EWS) endpoint URL from Microsoft Outlook. For information on how to retrieve the EWS endpoint URL, see the Microsoft website. The EWS endpoint URL should look like the following example URL: https//mail.*****.com/ews/Exchange.asmx
  2. Launch the EWS endpoint URL in a web browser.
  3. Generate and save the SSL certificate file by using the Base-64 Encoded X.509 format.
  4. In the Program Files directory on your machine, open the JDK/bin folder. (Sample path: C:\Program Files\Java\jdk1.6.0_26\bin)
  5. Run the Java Keytool application in the JDK/bin folder.
  6. Open the Command Prompt dialog and run the following command:
    keytool -importcert -file "<Path for ssl certificate>" -keystore "<Path for jks file name>" - alias "<anything>".
  • For the <Path for ssl certificate>, enter the path where you generated the SSL certificate.
  • For the <Path for jks file name>, enter the name for the jks file with path similar to the path for the SSL certificate.

    The command should look like the following example command:
    keytool -importcert -file ../../../cert.cer -keystore ../../../jkfile.jks -alias certificate.

  1. Click Enter.
  2. At the prompt, enter a password and confirm the password.
  3. Click Enter.
  4. At the Trust Question prompt, enter yes. The keystore file is generated in the same path where your SSL certificate exists.

Updating the security profile in Pega Application

You must update the security profile in Pega Application with the keystore file and password that you generated previously. This provides Pega Application with the SSL certificate that is required to communicate with your Microsoft Exchange server.

  1. In the Dev Studio header search field, search for and select the EWS_Integration_SecurityProfile WS-security profile.
  2. On the Keystore tab, click Open, and then Upload file.
  3. Click Choose File, and then search for and select the JKS keystore file for your server.
  4. Click Upload file.
  5. Enter the keystore password and click Save.

Updating the authentication profile in Pega Application

You must update the authentication profile in Pega Application with the user name and password for your Microsoft Exchange impersonation account. Your Microsoft Exchange administrator can provide you with the user name and password for the impersonation account.

  1. In the Dev Studio header search field, search for and select the EWS_Integration_ AuthProfile authentication profile.
  2. Click Save as.
  3. In the Type field, select NTLM.
  4. Click Create and Open.
  5. Enter the User name that is required by Microsoft Exchange. This is the user email for the impersonated user account.
  6. Click Set password.
  7. Enter the password for the user and click Submit.
  8. Click Save.

Updating dynamic system settings in Pega Application

To configure your implementation for Microsoft Exchange integration, you must update the EnableAppointments and CreateItemURL dynamic system setting values.

  1. In the Dev Studio header search field, search for and select the EnableAppointments dynamic system setting.
  2. In the Value field, enter true.
  3. Click Save.
  4. In the Dev Studio header search text field, search for and select the CreateItemURLdynamic system setting.
  5. In the Value field, enter the URL for the integration. This is your service endpoint URL.
  6. Click Save.

Limitations

The following calendar integration functionality is not supported when using Pega Application:

  • Synchronizing recurring appointments from Microsoft Exchange to Pega Application
  • Synchronizing private appointments from Microsoft Exchange to Pega Application
  • Accepting an appointment from Pega Application

    Published December 18, 2018 — Updated April 1, 2019


    100% found this useful

    Related Content

    Have a question? Get answers now.

    Visit the Pega Support Community to ask questions, engage in discussions, and help others.