Google Calendar - Calendar synchronization

  • Release version: Xanadu
  • Updated August 1, 2024
  • 4 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Google Calendar - Calendar synchronization

    The Workplace Reservation Management application enables seamless synchronization of reservations with Google Calendar. This bi-directional sync ensures that reservations made in ServiceNow are reflected on Google Calendar and vice versa. Synchronization supports incremental updates using delta synchronization, improving efficiency by retrieving only changes since the last sync.

    Show full answer Show less

    Note that strict mode configuration for Google Calendar is not supported.

    Synchronization from Workplace Reservation Management to Google Calendar

    • Uses the Google Calendar spoke within ServiceNow's Flow Designer to establish the connection.
    • Requires installation of the Google Calendar Spoke and authenticating ServiceNow with Google.
    • Allows use of default or custom connection and credential aliases for flexibility.
    • Google Calendar provider must be configured and linked appropriately to enable synchronization.

    Synchronization from Google Calendar to Workplace Reservation Management

    • Utilizes a scheduled job named WSDRS Sync Calendar items to pull calendar updates from Google.
    • This job is disabled by default and must be enabled to start synchronization; it runs every five minutes by default but can be adjusted.
    • Synchronization uses delta sync with synchronization tokens to efficiently fetch incremental changes per reservable resource (room).
    • Each synchronization event creates or updates corresponding events in ServiceNow’s Events table.
    • When creating or activating a reservable sync configuration for Google Calendar, a flow generates synchronization tokens stored in the Sync Deltas module.
    • Supports Create, Update, Delete, and Read operations for reservations.

    Synchronizing Past Reservations

    • Supports syncing past reservations by specifying a date and time range.
    • Requires the Google Calendar provider and reservable sync configuration to be active and the “Synchronize past reservations” option selected.
    • After enabling, it is necessary to manually trigger synchronization per location.

    No request Handling

    This feature allows administrators to validate the JSON payload generated for calendar events without making actual API calls to Google Calendar. It helps ensure payload correctness before live synchronization.

    Authentication and Configuration Essentials

    • Google integration requires setting up scopes and credentials for authentication.
    • Connections and credential records are managed via Flow Designer, with options to use default or custom aliases.
    • Google must be configured as a calendar provider and linked to reservable rooms to enable synchronization.

    Practical Considerations for ServiceNow Customers

    • Enable and schedule the WSDRS Sync Calendar items job to automate calendar updates.
    • Configure reservable sync configurations carefully and activate them to initiate synchronization flows.
    • Use delta synchronization to optimize performance and reduce data transfer.
    • Use the No request mode to validate integration payloads safely before enabling live sync.
    • Ensure credentials and connections are properly configured and maintained for uninterrupted synchronization.

    Create a connection with Google Calendar and synchronize reservations made using the Workplace Reservation Management application. You can synchronize all the reservations that are made using the Workplace Reservation Management to the Google Calendar and vice versa.

    The reservation synchronization from a Google Calendar to the Workplace Reservation Management is performed using various approaches like events, and occurrences.

    Important:
    The application does not support a strict mode configuration for Google Calendar.

    Synchronization from Workplace Reservation Management to Google Calendar

    The synchronization process from Workplace Reservation Management to Google is performed using the Google Calendar spoke. You can configure a connection with Google using the Flow designer.

    The synchronization process includes the following steps:
    1. Install Google Calendar Spoke.
    2. Set up Google Calendar spoke
    3. Authenticate ServiceNow with Google. Refer to Authenticate Google for calendar synchronization.
    4. Configuring the Google Calendar Spoke connection using the Flow designer. Refer to Create a Connection and credential record for Google.
    5. Creating the Google Calendar provider. Refer to Configure Google as calendar provider.
    The application also enables you to create your own connection and credential alias instead of using the default alias created by using the flow designer. Refer to Configure your own Google connection and credential alias.

    Synchronization from Google Calendar to Workplace Reservation Management

    The reservation synchronization from the Google Calendar to Reservation portal is done by pulling the latest calendar updates in Google Calendar by using a scheduled job, WSDRS Sync Calendar items. All the events related to the sync-enabled rooms are read and updated in the Workplace Reservation Management application. The application creates Create, Update, Delete, and Read events in the Events table.

    The scheduled job, WSDRS Sync Calendar items, is provided with the application to get the latest changes for all the active reservable sync configurations. The scheduled job is set to False by default and it must be enabled to start synchronizing. By default, the scheduled job is set to run for every five minutes. However, you can set the scheduled job time as you want. At any time, you can also manually execute it.

    An approach called, Delta synchronization is used by the Workplace Calendar Synchronization application. With Delta synchronization, you retrieve only the incremental changes made on a resource email id of the calendar using a reference point called as synchronization token. That is, for each room (each reservable sync record), linked to the on-premises calendar provider you get the synchronization tokens, which are the reference points to get the update from the calendar in increments.
    • Based on the Page size, Sync batch size and the Sync batch interval, the information is retrieved by the synchronization tokens. For example, if you specified the values as 5, 500, and 60 respectively (in the previous fields). It means that you can raise 500 requests in an interval of 60 seconds. The synchronization results five changes in a page.
    • When you create a reservable sync configuration record under the Google calendar, you must ensure that it is activated.
    • When the sync record is activated, a flow is triggered and a synchronization token for that reservable synchronization record is created in the Sync Deltas module.
    • The scheduled job, WSDRS Sync Calendar items, is provided with the application to get the latest changes for all the active reservable sync configurations. The scheduled job is set to False by default and it must be enabled to start synchronizing. By default, the scheduled job is set to run for every five minutes. However, you can set the scheduled job time as you want. At any time, you can also manually execute it.
    • The changes made on the reservable sync configurations are created as events in the Events module. The application creates Create, Update, Delete, and Read, events for the Google Calendar.
    • For each sync record, an event is created. Depending on the page size specified on the calendar provider, the changes are displayed. If there are any pending changes, it is displayed during the next scheduled job run.
    • The API that is used to get the synchronization tokens, saves the response in the Response field of the event. The API provides changes made on a single reservation, multi-reservation, and the parent recurring reservation.
    • Using the response created by the API, a reservation is created in the Workplace Reservation Management application.
    • With every scheduled job run, the synchronization token is also updated which is used as the reference point for the next synchronization.

    Synchronizing past reservations

    he Workplace Calendar Synchronization enables you to also synchronize reservations made in the past. You can specify the date and time range in the Sync start date time and Sync end date time fields. For the on-premises calendar, the following conditions must be met to sync past reservations:
    • The calendar provider that is the Google Calendar calendar provider that you configured must be active.
    • The Synchronize past reservations field must be selected.
    • The reservable sync configuration for which you want to sync past reservations must be active.
      Note:
      After you enable the Synchronize past reservations, you must navigate to the locations of each reservable sync configuration record and select Sync Location.

    'No request' handling

    No request is a mechanism to validate the generated syntax of the payload of an event created for the calendar. But, instead of sending the event to the calendar provider, it is only created. The admin can validate the payload content of the event (JSON) to ensure that is generated as expected. 'No request' ensures that the application does not make any API calls to the calendar provider when you create, update, or cancel a reservation in the Workplace Reservation Management application.