Article

Configuring the push mechanism for Microsoft Exchange to Pega Application calendar integration

The push mechanism for calendar integration listens for Exchange Web Services (EWS) notifications to identify new, updated, and canceled appointments on the Microsoft Exchange server, and then synchronizes the appointments with your Pega Application calendar.

Prerequisites

Before you can configure the Microsoft Exchange to Pega Sales Automation calendar integration, you must configure and initiate the push mechanism for Microsoft Exchange to Pega Sales Automation calendar integration.

To configure the push mechanism, perform the following steps:

Configuring settings for calendar integration

You must configure application settings for your Microsoft Exchange calendar integration.

  1. Log in to Pega Application as an Admin operator.
  2. In Dev Studio, search for and update the following settings, and then click Save.

Setting name

Setting value

EWSNotificationsListenerURL

Enter the URL for your Microsoft Exchange server.

ExchangeVersion

Enter the Microsoft Exchange version for your implementation in the following format: Exchange2010,Exchange2013, Exchange2016, Exchange365.

Pega Application supports Microsoft Exchange 2010 and 2013.

EWSBatchSize

Enter the batch size to tell the application the number of calendar items to process in each batch for a mailbox user. The push agent continues to loop until all calendar items are synchronized.

Microsoft Exchange supports a batch range of 1 to 512.

PushNotificationsListener

Enter the end point URL for the PushNotificationsListener REST service for Microsoft Exchange service notifications.

StatusFrequencyForEWSNotifications

Enter the number of minutes to use as the maximum timeout value before canceling the synchronization and sending a calendar synchronization failure email notification. The application retries the synchronization until the timeout limit is reached. For optimal performance, enter 30 for this setting.

NotifySyncFailureTo

Enter the email addresses of the operators to whom you want to send calendar synchronization failure email notifications. Separate email addresses by using a semicolon (;).

For a description of common calendar synchronization failure messages, see Failure messages for Pega Application calendar synchronization with Microsoft Exchange.

Configuring the service package for the REST service listener

Modify the service access group in the EWSPushNotifications service package for your implementation.

  1. Log in to Pega Application as an Administrator.
  2. In the Dev Studio header search field, search for and select the EWSPushNotifications service package.
  3. On the Context tab, enter the service access group for your implementation.
  4. Click Save.

Defining the custom settings for the calendar synchronization push related job schedulers

  1. Log in to Pega Application as an Admin operator.
  2. In the Dev Studio header search field, search for the ProcessEWSPushNotifications and ManagePushSubscriptionsForCalendarSync job schedulers.
  3. Click Save as and save the rules in the implementation ruleset.
  4. On the Definition tab, modify a schedule. For a real time sync, set the schedule in minutes.
  5. Set the context to use the AsyncProcessor requestor type or the proper access group. Make sure that the AsyncProcessor requestor type points to the implementation access group.
  6. Click Save.

Starting the calendar synchronization push job schedulers

When you start the calendar synchronization push job schedulers for the first time, Pega Application begins to synchronize all future appointments for the operators that are enabled for calendar synchronization. During the initial synchronization, the push schedulers also synchronize past appointments for the operators within a specified time period. The time period that is used for synchronizing past appointments is driven by the IsSkipAppointment when rule. The default value for this rule is 180 days.

After the initial synchronization completes, the push schedulers only synchronize future appointments that have been created, updated, or deleted since the last synchronization.

  1. Log in to Pega Sales Automation as an Admin and launch Admin Studio.
  2. In the navigation panel, click Resources > Jobs and search for the ProcessEWSPushNotifications and ManagePushSubscriptionsForCalendarSync job schedulers.
  3. Change the state to enabled by clicking the override link.

Optional: Defining the interval for the calendar synchronization push agents

To configure the calendar synchronization for push subscriptions and push notifications agents, you must define an interval in seconds. You should run the push agents on multiple nodes.

  1. Log in to Pega Application.
  2. In the Dev Studio header search field, search for and select the PegaCRMFW-ExchangeImpl agent.
  3. On the Schedule tab, enter the Interval (sec) for the ManagePushSubscriptionsForCalendarSync agent and the ProcessEWSPushNotifications agent.
  4. Click Save.

Optional: Starting the calendar synchronization push agents

When you start the calendar synchronization push agents for the first time, Pega Application begins to synchronize all future appointments for the operators that are enabled for calendar synchronization. During the initial synchronization, the push agents also synchronize past appointments for the operators within a specified time period. The time period that is used for synchronizing past appointments is driven by the IsSkipAppointment when rule. The default value for this rule is 180 days.

After the initial synchronization completes, the push agents only synchronize future appointments that have been created, updated, or deleted since the last synchronization.

  1. Log in to Pega Application and open Admin Studio.
  2. In the navigation panel, click Resources > Agents.
  3. To subscribe operators to the calendar synchronization push agent, select the ManagePushSubscriptionsForCalendarSync agent. Only operators who are enabled for calendar synchronization are subscribed to the agent.
  4. To run the synchronization, select the ProcessEWSPushNotifications agent.
  5. In the Single activity in queue toolbar, click Start.

Enabling operators for calendar synchronization

You must enable calendar synchronization for each operator who will use the feature. Set the isEnabledBiSync property to true in the operator instance.

To verify that calendar synchronization is enabled for an operator, complete the following steps:

  1. Verify that the IsEnabledBiSync property set to True on the operator record.
  2. Verify that the email address in the Email field is the operator's Microsoft Exchange email address.

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.