Google Calendar Integration

The following steps are required to be performed to integrate with Google Calendar.

Steps in this procedure must be performed by the institution's Google administrator.

  1. Login to GCP using Gsuite Admin account credentials (https://console.cloud.google.com/).
  2. After login, In the GCP Console, click IAM & Admin > Manage Resources.

  3. Click Create Project

  4. In the new project window, enter the required field values and click Create.

    For example:

    Project Name: alphatest1

    Project ID : alphatest1

  5. On the Home page, click the projects dropdown and open the newly created project alphatest1:

  6. Click IAM & Admin > Service Accounts.

  7. Click Create Service Account.

  8. Type the Service account name and Service account ID field values and click CREATE

    .

  9. A message "Service account created" will be displayed. Click DONE.

  10. In the newly added service account, click Actions > Create Key.

  11. Select the JSON option and click CREATE.

  12. A message will display that the service account JSON key file has been created and downloaded to your computer. Make a note of the name of this file. You’ll need it later.

    Important

    For large domains, service accounts can take up to 24 hours to propagate through the domain.

    If you lose the key, repeat these steps to create a new key.

Steps in this procedure must be performed by the institution's Google administrator.

  1. Navigate to the Dashboard.

  2. In the displayed screen, click ENABLE APIS AND SERVICES.

  3. In the next screen, click Google Calendar API.

  4. In the next screen, click Enable.

    It will take few seconds to activate.

  5. On successfully being enabled, the Activation status will display the text Enabled.

  6. Repeat step 2 - 5 to enable Google Drive API.

Steps in this procedure must be performed by the institution's Google administrator.

  1. Authorize the service account in your Google Admin console. Log in to the Admin console, https://admin.google.com/.
  2. Click Security > API controls.

  3. Click MANAGE DOMAIN WIDE DELEGATION.

  4. Click Add new.

  5. In the Add a new client ID dialog:

    The Client ID will be available in the JSON file you downloaded when you created the GSuite service account.

  6. Click Authorize.

    Note

    It might take some time for the authorization process to complete. On successful authorization, information will be displayed in the API clients section.

Steps in this section must be performed by staff from Professional Services / Deployment team. Professional services must obtain JSON file information from the institution and create a service desk ticket for the Deployment team to update the Azure function. The sensitive JSON file information should then be shared via the confidential section of the service desk incident.

  1. In the Azure app service, click Configuration.

  2. From Application settings, click CMC_GoogleServiceAccount

  3. In the Value field, type the JSON file data downloaded when the Google service account was created.

    Copy the JSON file data into the Value field.

  4. Click OK and then restart the Azure App Service.

  5. Update the Customer Variable CMC_GoogleServiceAccount with the JSON file value to retain the Azure function configuration after upgrades.

  1. Step owner: Professional Services staff or institution’s administrator.

    In the Default Configuration page, based on your business need set the following values.

    For example:

    • Sync Appointments with Google : Primary Calendar
    • Send Google Event Notifications: All
    • Sync Appointment Attachments with Google Calendar: Yes

  2. Step owner: Professional Services staff or institution’s administrator.

    For users who need appointments to be synced with their Google account, ensure

    • Their primary email (Internal email address for the user) address belongs to the GSuite domain for which the service account was created.
    • In the user's record, Sync Appointments with Google is enabled

  3. Step owner: Deployment team

     Ensure the following processes are activated:

    • Google Integration - Sync Appointment with Google Calendar
    • Google Integration - Sync Recurring Appointment with Google Calendar
    • Google Integration - Sync Appointment Attachment with Google Calendar
    • Google Integration - Auto Sync Appointment with Google Calendar
    • Google Integration - Auto Sync Recurring Appointment with Google Calendar
    • Google Integration - Auto Sync Appointment Attachment with Google Calendar
    • Security - Fetch Entity Record Privileges for User

  1. Step owner: Professional Service / Deployment team

    Domain details from the Import/Export tab must be passed to the institution.

  2. Step owner: Institution's Google administrator

    1. As Google admin go to https://search.google.com/search-console/welcome.

    2. In the URL Prefix tile, specify the URL of the Reach environment for domain verification, and click Continue.

      The following message will be displayed to indicate that the domain is successfully verified.

      If the domain is not added in the Google cloud the Verify ownership dialog box is displayed.

      Perform the following steps:

      1. In the Other verification methods, expand the Domain name provider section.

      2. In the Select record type drop-down, select CNAME.

      3. Copy the CName Label/Host and CName Destination/Target field values and click Done. Send this information to staff in Professional Services / DevOps.

  3. Step owner: Professional Services / Cloud Platform

    1. Staff from Professional Services will pass the CName record details to the Cloud Platform team.

    2. The Cloud Platform team will need to add the CName details in the DNS and confirm with Professional Services that it's done.

    3. Professional Services must then communicate with an administrator at the institution to verify domain ownership.

  4. Repeat step 2for domain verification.