1.Introduction
Google Calendar Sync created is useful extension that allows you to synchronize your Vtiger and Google calendar.
Synchronization is via Cron (Scheduler) fully automatized in the Vtiger CRM.
2.How to install Google Calendar Sync
Please provide following steps in order to install Google Calendar Sync
- Install the .zip (package) file of the Google Calendar Sync module via CRM Settings -> Studio -> Module Manager. Click on the Import from Zip.
- Select the .zip (package) file that you downloaded from our shop. Please check that you accepted the disclaimer and would like to proceed. Click on the button.If you have after this step error message: Sorry! Attempt to access restricted file. Please check if folder test/vlib has correct write permission for browser (apache, www-data).
- Verify the import details parsed from the .zip (package) file. Please check that you accepted the license agreement and click to proceed or Cancel to cancel.
- Google Calendar Sync was imported
In order to finish installation, please provide following validation steps.
- Please find ITS4You Google Cal Sync in Integration Setting of CRM
- Please check your Company information and insert license key. Make sure that your server has Internet access. Click on button [Validate]. If you want to change your Company information, click on button [Change Company Information].
- Finish validation
3.How to update Google Calendar Sync
The upgrade of the Google Calendar Sync is initiated in the same way as Google Calendar Sync installation so please refer to above installation part for details how to initiate the import of the module from the file.
As you can be seen on the Picture below you will be notified that the Google Calendar Sync module already exists. Confirm License agreement and upgrade will start immediately when you click on the button.
After upgrade the notification about successful upgrade is shown.
4.Before you start using Google Calendar Sync
Before you start using Google Calendar Sync for your vtiger CRM Open Source, you need to create a Project in Google get the API credentials for correct authenticate you and your Vtiger.
Also in the project settings you will be needed to validate your CRM URL, this will be explained further.
4.1.How to create Project in Google and receive credentials
In the below creating synchronization is in the 3 steps:
- A) Create Project
- B) Verify Domain
- C) Create OAuth Cliend ID
A) Creating Project:
- Please visit: https://console.developers.google.com/project, log in with your Google Apps or Google account and click on the button .
- A pop-up window will appear, check the Terms of Services and fill project name and click on button.
- Your project has been created. It may take a few seconds until your project will be shown:
- Next, open Dashboard of Google APIs:
- Enable Calendar API by clicking on button:
- Select or find Google Calendar API:
- Enable Calendar API:
- API has been created:
- Now you need to set OAuth Credentials:
- You need to Configure consent screen first:
- Select User Type:
- Next, fill up the name, then scroll down and Save:
B) Domain verification before creating OAuth Cliend ID:
Before we proceed to the Creating OAuth Cliend ID for Google Sync, you need to verify your domain.
Please follow next steps:
- Click on Domain verification and on button.
- Insert your domain URL address:
- The following pop-up window will appear, click “TAKE ME THERE”:
- In next step click on the button and fill up your domain. Then click “Continue”:
- Now, the HTML verification file was generated, (1) click on the .html file to download it and (2) copy it to your Vtiger directory.
When the file is in the directory, (3) visit the page on your screen in step 3. Confirm.
(4) Check that you are not a robot and (5) click on the button - The following message will appear:
- Now again go to Domain verification and click on button.
- Insert your domain URL address:
- Following window will appear with the list of verified domains:
- Now add domain to your OAuth consent screen you created, by going to OAuth consent screen, then click on
- In the Edit window, scroll a bit down and look for (1) Authorised domains, (2) enter your domain url in the field and confirm with ENTER on your keyboard.
*must not specify the protocol (http:// or https://)
- When domain is entered, confirm via button.
C) Creating OAuth Cliend ID
- Now we need to create OAuth client ID, go to Credentials and click on then on OAuth client ID
- Choose “Web application”, fill name and into Authorized redirect URls add your Vtiger site url + following link and press Enter
[yourvtigercrmurl]/index.php?module=Calendar&view=Extension&extensionModule=ITS4YouGoogleCalendarSync&extensionView=Extension&authorize=true&service=GoogleITS4YouGoogleCalendarSync
- Finally, you get your Client ID and Client Secret IDs:
4.2.First configuration
Now, you need to set Synchronization in your Vtiger CRM. You have 2 options:
- like admin set one default ID of Project for whole users (we recommend this way).
- each user can set own ID of Project but it means that each user must create own Project like is above written.
How to set default Project ID for all users
- Open ITS4You Google Cal Sync in Integration settings and click on button.
- Now, fill your Credentials from Google Project and click on button.
- You Credentials have been saved. If you need, you can Edit or Remove it from this tab.
How to set ID for each user individually
- Login like user that you want to add Google Project ID
- Open please your Calendar module and you will see Google Synchronization block. Click please on Calendar Settings to open settings part
- Select “Own” Google Credentials, fill own Credentials, choose Sync Direction and click on Save
- Credentials have been successfully saved
Now, you need to connect your Google account to Vtiger
- Open please your Calendar module and you will see Google Synchronization block. Click please on Calendar Settings to open settings part
- If you want to use Default Google Credentials set by Admin use “Default Google Credentials” option in other case use “Own”(written above). Select Direction of Synchronization and Save it.
- Now please click on button.
- Sign in to your Google account
- Allow Vtiger to manage your Calendar
- You have been successfully sign in Google
4.3.Vtiger to Google mapping
After you have been successfully sign in Google, you need to map vtiger activity types to Google calendar.
- In Calendar settings please click on Vtiger to Google mapping. Now, you can see all your activity types. So please map it to Calendar that you want.
- If you mapped your activity types, please save it save.
- Mapping has been saved
4.4.How to create new Google calendar
We recommend for each activity type create own Calendar because of correct mapping.
To create new Calendar for each Activity type please provide following steps:
- First at all you need to open Google Calendar
- Now, you can see your Calendar(s)
- Click on Settings button and select Settings
- Click on Add calendar and New calendar
- Fill name and create calendar
- Now you can see your new Calendars
5.How synchronization works?
In following sections is described how synchronization work and how to automate Google->Vtiger CRM way.
5.1.Vtiger CRM -> Google Calendar
If you create event in your Vtiger, record is immediately sent to Google calendar that you select in mapping setting.
5.2.Google Calendar -> Vtiger CRM
To create record in Google please provide following steps:
- In your Google Calendar please click on date and time or on button
- Fill title of record, select your Calendar (in Vtiger it is “activity type”) and save it
- Your records is now created within Google Calendar
- But, record is still missing in your Vtiger
- Please click on button to synchronize your vtiger Calendar manually
- Now, you can see your record from Google Calendar in your Vtiger 6 CRM. And as you can see on previous picture you have info about changes in Vtiger as well as Google Calendar
5.2.1.How to automate Google -> Vtiger CRM synchronization
To automate Google->Vtiger 6 CRM Sync you can use our default Cron Job. It is Active by default but you can check it.
To check and activate our Cron Job please provide like admin:
- Go please to Setting -> CRM Settings -> Other Setting -> Scheduler and check if Schedule ITS4YouGoogleCalendarSync is Active or Inactive.
- if it is Active then each 15 min (or Frequency that you set) your Vtiger synchronize recorods from Google into your Vtiger
- if it is Inactive then please provide following steps
- If no please click on button in our Schedule ITS4YouGoogleCalendarSync
- Set status to Active, set Frequency of cron job and save it
- Now, your cron has been set. And depends on your frequency Synchronization be starting automatically
6.How to remove Connection
In case that you want to Remove connection please provide following steps:
- Open your Calendar module and click on Calendar Setting
- Click please on
- Your connection has been removed
7.Settings of Google Calendar Sync for vtiger 6.x
Settings part you can find in Settings-> CRM Settings-> Integration-> ITS4You Google Cal Sync.
Settings part contains of:
- Users – list of active users of Google Calendar Sync
- License – license settings of Google Calendar Sync
- Upgrade – option to upgrade Google Calendar Sync
- Uninstall – option to uninstall Google Calendar Sync
7.1.Users
In this section you can see your users who use Google Calendar Synchronize. Also from this page you can remove Sync for any user.
User section you can find in Setting tab when you select Users.
Now you can see all users who is connected to Google.
If you want to remove user please click on .
And confirm removing.
7.2.License
In case you need to deactivate license for any reason (deleting Vtiger, moving to other hosting) please deactivate license first.
To deactivate license please provide following steps:
- In Setting Tab select License
- Click on button
- Confirm Deactivation
7.3.Upgrade
To upgrade our Google Calendar Sync please provide following steps:
- In Settings Part select Upgrade
- Choose File and accept check box and Click on Import button
- As you can be seen on the Picture below you will be notified that the Google Calendar Sync module already exists. Confirm License agreement and upgrade will start immediately when you click on the button.
After upgrade the notification about successful upgrade is shown.
7.4.How to uninstall Google Calendar Sync for vtiger 6.x?
To uninstall our Google Calendar Sync please provide following steps:
- In Settings Part select Uninstall
- Please, click on button
- Confirm uninstall
8.Change log
8.1.GoogleCalendarSync
- 16 July 2019: ITS4YouGoogleCalendarSync 3.5
- fixed issues where actualization via Cron/Scheduler was not working properly for users
*We recommend to download/update your Google Sync to this version
- fixed issues where actualization via Cron/Scheduler was not working properly for users
- 28 February 2019: ITS4YouGoogleCalendarSync 3.0-3.2
- fixed issue with licensing on domains with https protocol
- fixed issue where synchronization was not working after updating module to the versions 3.0 and 3.1
- March 2018: ITS4YouGoogleCalendarSync 1.0
- first initiate for vtiger 6.x
8.2.Manual of GoogleCalendarSync
- April 2020: manual based on ITS4YouGoogleCalendarSync 3.5
- updated chapter: 4.1.How to create Project in Google and receive credentials
- March 2018: manual based on ITS4YouGoogleCalendarSync 1.0
- first initiate for vtiger 6.x