#8376 Spreadsheet plugin

Parent Category:: DPCalendar

Category:: Calendar plugins

Last Updated:: Allon Moritz, Tuesday, 21 November 2023 12:23 (3 weeks ago.)

Created:: Tuesday, 02 February 2021 15:58

Hits:: 2000

This feature is part of the DPCalendar Professional subscription.

SubscribePHP 7.4PHP 8Joomla 3.10Joomla 4Joomla 5

Introduction

The spreadsheet plugin creates out of a spreadsheet file, events which can be displayed in DPCalendar. The file has to be locally on your web server.

The file on your server must have the proper permissions to access it as web server user. Make sure that the file is accessible to DPCalendar through your Joomla hosting server.

File Format

The spreadsheet plugin comes with an example Opendocument format file which has a structure that works out of the box. For every spreadsheet calendar you can define a column name which is mapped to an event attribute. For example if the title of the event is in a column with the name sps_title then fill that value as option in the external calendar configuration.

The following example should give you a rough idea about the structure. The first row defines always the columns of the file.

"title","alias","rrule","start_date","end_date","all_day","location","color","url","description","show_end_time"
"Yearly recurring","yearly","FREQ=YEARLY;UNTIL=20220514T000000Z","2019-01-01 00:00:00","2019-12-31 23:59:59","0",,"27CC37",,"Sample description",1
"Single day","single-event",,"2019-12-29 22:00:00","2007-12-29 22:20:00","0",,"A32929",,,1
"All day","allday",,"2019-12-29 00:00:00","2017-12-30 00:00:00","1",,"A32929",,,1
"Weekly recurring","weekly","FREQ=WEEKLY;BYDAY=TU,TH,SA","2017-12-10 20:00:00","2017-12-10 22:30:00","0","New York",,"http://www.digital-peak.com","This event also ends at 22:30 but the show end time flag is set to false, so it is not shown.",0
"Dayli recurring","dayli","FREQ=DAILY","2017-12-11 20:00:00","2017-12-11 21:30:00","0","London",,"http://jooml.digital-peak.com","<p>Desc</p><ul><li>with HTML</li><li>content</li></ul><p><strong>Strong text</strong></p>",1

Libre Office, Openoffice or Excel

Spreadsheet files are in binary format and can be edited with Excel or Libre Office apps. In either case the file will be broken down into cells.

Export of DPCalendar data

The Spreadsheet plugin also supports to export DPCalendar entities like events, locations, bookings or tickets in the back end and front end. When activated then an export button will appear in the respective lists.

While configuring the plugin, it is also possible to fine tune the export behavior. The site admin can define the field order, hidden fields, if HTML tags should be stripped or configure the output of custom fields.

DPCalendar Options

These settings are the same for every calendar configured in the plugin.

Uri [Type: Text]: An uri to an online file like http://www.example.com/files/data.csv or a local path like plugins/dpcalendar/csv/examples/example.csv. If the uri is a file and starts with a '/' DPCalendar will interpret it as an absolute path otherwise relative to the joomla installation folder.

Delimiter [Type: Text] [Default: ,]: The delimiter of the CSV file.

Enclosure [Type: Text] [Default: "]: The enclosure of the CSV file.

Has Header Row [Type: Radio] [Default: Yes]

Does the CSV file have a header row.
The following options are available:

Title Column [Type: Text] [Default: title]: The column for the title.

Start Date Column [Type: Text] [Default: start_date]: The column for the start date.

End Date Column [Type: Text] [Default: end_date]: The column for the end date.

All Day Column [Type: Text] [Default: all_day]: The column for the all day.

Show End Time Column [Type: Text] [Default: show_end_time]: The column for the show end time.

Description Column [Type: Text] [Default: description]: The column for the description.

RRule Column [Type: Text] [Default: rrule]: The column for the recurrence rule.

Location Column [Type: Text] [Default: location]: The column for the location.

Url Column [Type: Text] [Default: url]: The column for the url.

Alias Column [Type: Text] [Default: alias]: The column for the alias.

Colour Column [Type: Text] [Default: color]: The column for the colour.

SSL Verification [Type: Radio] [Default: Yes]

Is SSL verification activated? Disable only when you know what you are doing as it can cause security issues. When disabled the connection the remote host can't be trusted anymore.
The following options are available:

Plugin Options

Custom Field Value Type [Type: Radio] [Default: Value]

The value type of the custom field. Raw returns the stored value from database and value means the display value.
The following options are available:

Value
Raw Value

Strip HTML [Type: Radio] [Default: No]

Strip the HTML tags during export.
The following options are available:

Separator [Type: Text] [Default: ,]: Separator of the exported file.

Events Field Order [Type: Subform]: The order of the fields. The ones which are not listed, will be appended at the end.

Hide Event Fields [Type: Dpcfields]: The events fields which should be hidden.

Bookings Field Order [Type: Subform]: The order of the fields. The ones which are not listed, will be appended at the end.

Hide Booking Fields [Type: Dpcfields]: The booking fields which should be hidden.

Tickets Field Order [Type: Subform]: The order of the fields. The ones which are not listed, will be appended at the end.

Hide Ticket Fields [Type: Dpcfields]: The ticket fields which should be hidden.

Plugin Options

Caching [Type: List] [Default: Joomla]

Select whether to cache the calendar data.
The following options are available:

Joomla
Database
Never

Cache Time [Type: Text] [Default: 900]: The time for the cache in sec.

Sync Start [Type: Text] [Default: -3 year]: The relative start date to sync from.

Sync End [Type: Text] [Default: +3 year]: The relative end date to sync from.

Sync Steps [Type: Text] [Default: 1 year]: The sync steps.