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

The polling mechanism for calendar integration checks for new, updated, and canceled appointments on your Microsoft Exchange server, and then synchronizes the appointments with your Pega Application calendar.

Use the polling method only if the push mechanism is not available for your implementation. For best results, use the push mechanism for Microsoft Exchange to Pega Application Calendar integration.

Prerequisites

Before you can configure the Microsoft Exchange to Pega Application calendar integration, you must configure and initiate the polling mechanism for Microsoft Exchange to Pega Application calendar synchronization.

Configuring settings for calendar integration

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

  1. Log in to Pega Application as a Admin operator.
  2. In the Dev Studio header, search for the following settings and update them as necessary, 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.

For more information, see RequestServerVersion.

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 operator 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 message for Pega Application synchronization with Microsoft Exchange.

To avoid locking issues, you should run the CalendarSynchronization job scheduler on a single node. For any custom settings, override the CalendarSynchronization job scheduler in your implementation ruleset.

Defining the custom settings for the calendar synchronization job scheduler

  1. Log in to Pega Application as an Admin operator.
  2. In the Dev Studio header search text field, search for CalendarSynchronization and select the job scheduler rule.
  3. Save as this job scheduler rule in the implementation ruleset.
  4. On the Definition tab, modify schedules. For real time sync, set schedule should be in minutes.
  5. Set the context to use the AsyncProcessor requestor type. Make sure that the AsyncProcessor requestor type points to the implementation access group.
  6. Click Save.

Starting the calendar synchronization polling job scheduler

When you start the calendar synchronization scheduler 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 polling job scheduler also synchronizes 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 polling job scheduler only synchronizes future appointments that have been created, updated, or deleted since the last synchronization.

  1. Log in to Pega Application as an Admin operator.
  2. Open Admin Studio.
  3. In the navigation panel, click Resources > Jobs and search for the CalendarSynchronization scheduler.
  4. Change the state to enabled by clicking the Override link.

Optional: Defining the interval for the calendar synchronization polling agent

The PegaCRMFW-ExchangeImpl agent is available for calendar synchronization in Pega applications. To tell Pega Application how frequently to run the calendar synchronization polling agent, you must define an interval in seconds. To avoid locking issues, you should run the polling agent on a single node.

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

Optional: Starting the calendar synchronization polling agent

When you start the calendar synchronization polling agent 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 polling agent also synchronizes 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 polling agent only synchronizes future appointments that have been created, updated, or deleted since the last synchronization.

  1. Log in to Pega Application.
  2. Open Admin Studio.
  3. In the navigation panel, click Resources > Agents.
  4. Select the CalendarSynchronization 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.

  1. Log in to Pega Application.
  2. In the Operator instance, set the isEnabledBiSync property to true.
  3. In Dev Studio, search for and select the isEnabledBiSync property.
  4. Click Actions > Property optimization and optimize this property to the Data-Admin-Operator-ID table.

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

  1. Verify that the IsEnabledBiSync property is 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.
Suggest Edit

Have a question? Get answers now.

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