Menu

#629 Integration/Import external calendars

Parent Category:
DPCalendar
Category:
Introduction
Last Updated:
Allon Moritz, Wednesday, 21 August 2024 08:55
Created:
Friday, 17 February 2012 21:35
Hits:
28807

Introduction

If you have been using other calendars like iCloud, Google calendar or MS Exchange and want to continue to use them, and you need to display their events on your Joomla website, DPCalendar supports integration and import of many different calendar systems. This chapter describes how the integration is done and how it can be activated.

External sources are included through Joomla plugins and are of type "dpcalendar". You can find them in the Joomla plugin manager. This means all the logic is implemented in its own plugin and does not touch the DPCalendar core code. The integration can easily be activated or deactivated through the publishing state of the plugin.

After you have installed DPCalendar, open the plugin in the back end. Now add your external calendar by clicking the New or Import button. Some systems like Google do require manual set up outside of DPCalendar and Joomla first, others like MS Exchange do need only username and password and an url. There are various adjustments you can do when editing the plugin. All the different settings are described below or in the corresponding plugin.

Settings

Every external calendar has system specific settings like OAuth tokens or uris and there are general settings like calendar color or permissions. We will explain here the general settings as the system specific settings are covered in the specific plugin article.

  • Title
    The title of the calendar.
  • Color
    The color the events will have when the events from the system do not have their own colors.
  • Force Color
    If the external system supports event colors but you want to use the calendar color.
  • Description
    The calendar description.
  • Access Level
    The access level of the calendar, means which users can see the calendar and it's events.
  • Access Content
    Which users can see the content of the event, means the details like title and description. If none is available, then a busy placeholder is shown.
  • State
    The state of the calendar, like published or unpublished.
  • Language
    The language the calendar belongs to.
  • Permissions
    If the plugin supports two way sync, you can edit the events within Joomla in the external calendar system, then you can define which user groups can do create, edit or delete the events.
Ical plugin

Integration vs Import

Integration means that the events in your external calendars are displayed within your Joomla calendar directly. But the external system is still the master of the events and DPCalendar is synchronizing the events from the remote source. For performance reason, the events are cached for a couple of minutes on your Joomla site to speed up page load. During synchronization, the database is not touched (except you have database caching activated). When the cache is expired a new API call to the external calendar system is done. For example when you integrate your Google calendars, then a HTTPS call is made to googleapi.com.

When an external calendar is created in the respective plugin, then this calendar can be selected in the menu item or module. Some systems are integrated in a two way sync mode, where you can edit the events within DPCalendar and they are updated directly on the remote system.

On the other site, when you import the events from your old calendar system into DPCalendar, then the import tool creates the event's in the database of DPCalendar (can be found under Components -> DPCalendar -> Tools -> Import). They are stored in the Joomla database and do loose all connections to the original event. This means you have migrated the events into the database of DPCalendar. The import does always create events in a calendar with the title in the plugin. More information about the import task, can be found in the Import external events article.

Comments (0)

We use cookies on our website. Some of them are essential for the operation of the site, while others help us to improve this site and the user experience (tracking cookies). You can decide for yourself whether you want to allow cookies or not. Please note that if you reject them, you may not be able to use all the functionalities of the site.