ICal Export: Difference between revisions

Jump to navigation Jump to search
No edit summary
Line 24: Line 24:


Select whether to export bookings only, blocked dates or both bookings and blocked dates.
Select whether to export bookings only, blocked dates or both bookings and blocked dates.


== Calendar content ==
== Calendar content ==
The calendar information consists of a "Summary" and a "Description.
*The Summary of each event can be customized using the '''iCal Summary''' field, this field can contain text and [[Template Variables]].
*The Description of each event can be customized using the '''iCal Property Description''' and '''iCal Room Description''' fields, these fields can contain text and [[Template Variables]].
Both are optional, The iCal Property Description will be included in the iCal feeds for each room in the property. The iCal Room Description is individual for each room.


Because the iCal feed is public, by default only non personal data will be included.
We provide 4 different URLs from which you can choose:
 
'''iCal''': Because the iCal feed is public, by default only non personal data will be included in this URL


If the secret token in the URL is used, the iCal SUMMARY and DESCRIPTION fields of each iCal event can contain more information about the booking.  
If the secret token in the URL is used, the iCal SUMMARY and DESCRIPTION fields of each iCal event can contain more information about the booking.  


Privacy Note: Anyone who knows your token values can access the potentionally personal information in the Summary and Description fields. See below to change the token values.
'''Include Property and Room Description''': This link will show personal information plus the values of the template variables you have entered in the "iCal Property Description" and "iCal Room Description" fields.


The Summary of each event can be customised using the '''iCal Summary''' field, this field can contain text and [[Template Variables]].
'''Include Property Description''': This link will show personal information plus the values of the template variables you have entered in the "iCal Property Description" field.


The Description of each event can be customised using the '''iCal Property Description''' and '''iCal Room Description''' fields, these fields can contain text and [[Template Variables]].
'''Include Room Description''': This link will show personal information plus the values of the template variables you have entered in the "iCal Room Description" field.


Both are optional, The iCal Property Description will be included in the iCal feeds for each room in the property. The iCal Room Description is individual for each room.
=== Seed ===
The Seed is optional and can be used to change the token values. You only need to use this function if your token is compromised.  


Secret tokens are available to show different combinations of the description fields, this makes it possible to distribute multiple iCal feeds for each room, each with different content.
Enter a short phrase or word to seed new tokens. After you press SAVE you will see that the Urls for "Include Property and Room Description", "Include Property Description" and "Include Room Description" have changed. Make sure you have these exact URLs entered in your calendars.  


The Token Seed is optional and can be used to change the token values. Enter a short phrase or word to seed new tokens.
If anyone accesses the calendar with the wrong token only the default non-personal iCal feed will be shown.  


If anyone accesses the calendar with the wrong token only the default non-personal iCal feed will be shown.


== In your Calendar ==
== In your Calendar ==
The iCal export will work with any calendar capable of importing iCal format data. Google and Mac chosen here as examples because they are often used.
The iCal export will work with any calendar capable of importing iCal format data. Google and Mac chosen here as examples because they are often used.


Line 65: Line 72:


== Data Options ==
== Data Options ==
Additional parameters can be added to the calendar URL to further specify the export data.
Additional parameters can be added to the calendar URL to further specify the export data.


Line 109: Line 115:
*Remove the link from your calendar
*Remove the link from your calendar
== Notes ==
== Notes ==
If you want to use a custom URL you can use a URL shorten-er service which lets you customise the link.
If you want to use a custom URL you can use a URL shorten-er service which lets you customize the link.