Integration with Google Calendar
(API v.2)

Getting started

First of all, to start sync, check whether the extension php_curl.dll is enabled.

If it's not, activate it by removing a semicolon from the following line in the php.ini file, used by your web server:

;extension=php_curl.dll

Once you are sure that the needed extension is enabled, you can move to setup.

To sync Scheduler with Google Calendar, do the following:

• Download the 'gCal_proxy_v2' package.
• Unzip the package into the root directory of your web server.

Server-side:

• Open the '01_proxy.php' file placed at [rootFolder] gCal_proxy server in notepad. The file contains the standard proxy initialization code:

<?php
 
$email = "";
$pass = "";
$cal = "";
 
include('google_proxy.php');
$calendar = new GoogleCalendarProxy($email, $pass, $cal);
//$calendar->map("location", "details");
$calendar->connect();
 
?>

• Set values for 3 variables and leave the rest of the code, as it is.
  Variables that you should set values for, are:
  • $email - the user name of your Gmail account;
  • $pass - the password of your Gmail account;
  • $cal - the name of your Google Calendar.

Make sure that you wrote the correct values. For example, if the name of your calendar is test@googlemail.com, the value test@gmail.com results in error.

• Save the changes and close the file.

Client-side:

• Open the HTML file containing the initialized scheduler. If you don't have any scheduler initialized, create a new HTML file in the root folder of your web server.
• Initialize scheduler in a standard way (see details in How to Start).
• Load Google Calendar's events to Scheduler through the load method. Set its parameter to the path to the '01_proxy.php' file, which you've recently modified.

scheduler.load("../gCal_proxy/server/01_proxy.php");

• Initialize dataProcessor, to provide 2-way sync.

• Include one more file.

<script src="../gCal_proxy/sample/codebase/dhtmlxdataprocessor.js"></script>

• Take the path to the same php file '01_proxy.php', as the parameter of the constructor.

var dp =  scheduler.createDataProcessor("../gCal_proxy/server/01_proxy.php");
dp.init(scheduler);//'scheduler' is the name of the scheduler instance.

The sync is finished. You can find the ready-to-use example 'sample.html' at [rootFolder] gCal_proxy sample.

Export

To export events from Google Calendar to your database, just follow these steps:

1. Open the '03_export.php' file placed at [rootFolder] gCal_proxy server in notepad.
2. Set values for the variables and leave the rest of the code as it is.
   Variables that you should set values for:
   • $email - the user name of your Gmail account;
   • $pass - the password of your Gmail account;
   • $cal - the name of your Google Calendar;
   • $db_host - the name of your MySQL server host or IP-address;
   • $db_user - the username of your MySQL account;
   • $db_pass - the password of your MySQL account;
   • $db_name - the name of your MySQL database;
   • $db_table - the name of the database table;
3. Save changes and close the file.
4. Run the '03_export.php'.
5. Once the file has been run, events from Google Calendar will be saved to the appropriate database table.

Import

To import events from your database to Google calendar, just follow these steps:

1. Open the '02_import.php' file placed at [rootFolder] gCal_proxy server in notepad.
2. Set values for the variables and leave the rest of the code as it is. Variables that you should set values for are the same as in case of exporting.
3. Save changes and close the file.
4. Run the '02_import.php'.
5. Once the file has been run, events from the database will be moved to the Google Calendar.

How to pass additional information related to the event

Google Calendar has one set of fields and Scheduler has the other. So, to sync (import or export) the event information correctly, you should set mapping between the related fields of the calendars.

By default, there is the following mapping between Google Calendar and Scheduler:

Google Calendar -> Scheduler

• id -> id
• title -> text
• startTime -> start_date
• endTime -> end_date

Additionally, you can pass information of the following Google Calendar fields:

Field	Description
canEdit	defines whether the logged-in user can edit the current event. Possible values: '0' or '1'
created	the event's creation date in gcal format
details	the event's details
updated	the last update date of the event in gcal format
location	the location, where the event takes place
status	shows the current status of the event: cancelled (the event is canceled), confirmed (the event is confirmed), tentative (the event is tentatively scheduled)

To pass some additional info, follow the steps below:

Server-side:

• According to the desired action, open in notepad the appropriate file placed at [rootFolder] gCal_proxy server: to sync - '01_proxy.php', to import - '02_import.php', to export - '03_export.php'.
• Map the desired fields by using the method map(). For example, if you want to get the location of the event (in addition to the text, start and end times) you should write the following line:

$calendar->map("location", "place");

• location - the name of the Google Calendar field;

• place - the name of the related Scheduler field. You can write any name here.

• Save changes and close the file.

Client-side:

• Open the HTML file containing the initialized scheduler.
• Add to the definition of the scheduler:

The lightbox section:

scheduler.config.lightbox.sections=[
    ...
    {name:"placeField", height:50, map_to:"place", type:"textarea"}
];

where the map_to parameter must be set to the value, specified on server-side (see above).

• the label of the newly added section:

scheduler.locale.labels.section_placeField = 'Place';

where after the underscore you should specify the name of the related section.

• Save changes and close the file.

Back to top