Difference between revisions of "ICal Export"

From Beds24 Wiki
Jump to navigation Jump to search
 
(49 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Channel Manager]]
 
[[Category:Channel Manager]]
−
'''Synchronising Beds24.com with your Google or any iCal calendar'''
+
[[Category:Ical]]
 +
[[Category:Error Messages from Channels]]
 +
[[Category:Troubleshooting]]
 +
<div class="heading">Ical Export</div>
 +
This page is about the menu {{#fas:cog}} (SETTINGS) CHANNEL MANAGER > ICAL EXPORT and explains how to synchronise Beds24 with your Google or any iCal calendar''
 +
== Capabilities ==
 +
Beds24.com can export bookings and unavailable dates as an iCal feed.
  
−
== Capabilities ==
+
Google calendar and many other systems can read the iCal feed.
−
Beds24.com can export bookings to your Google (iCal) calendar.
 
  
 
Many holiday rental sites support Ical  [[Ical_Sync|more Information]]
 
Many holiday rental sites support Ical  [[Ical_Sync|more Information]]
 +
 +
For details please [[Channel_Manager_Capabilities|click here]]
  
 
== Limitations ==
 
== Limitations ==
 
Only active bookings are exported, cancelled bookings will not appear.  
 
Only active bookings are exported, cancelled bookings will not appear.  
 +
 +
Settings in prices which limit availability are not considered.
  
 
Your Calendar program is responsible for routinely updating the calendar, we have no control over how often systems like Google calendar actually perform an update.
 
Your Calendar program is responsible for routinely updating the calendar, we have no control over how often systems like Google calendar actually perform an update.
  
 +
== What you will need ==
 +
The Beds24 Calendar URL as displayed in the channel manager menu for each room.
  
−
== What you will need ==
+
== Beds24.com ==
 +
=== 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,
 +
 
 +
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.
  
−
The Beds24 Calendar URL as displayed in the channel manager menu for each room.
+
'''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 calendar will only be activated when at least one of the checkboxes are checked.
+
'''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.
  
−
If the token in the URL is correct the booking will be exported with the description entered in the '''Booking Description''' field. Use [[Template Variables]], here to include information from each booking.
+
'''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.
  
−
The password is optional and can be used to change the token value. If anyone accesses the calendar with the wrong token, no personal information will be available in the calendar.
 
  
−
== Beds24.com ==
+
If you add &nourl=1 to the URL the link to the booking will be removed.
  
 +
=== Activate ===
 
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.
 +
 +
All upcoming bookings are included and blocked dates for one year in advance.
 +
 +
=== 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.
 +
 +
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.
 +
 +
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 ==
Line 39: Line 70:
 
*Click Add Calendar and the bookings for that room should import.
 
*Click Add Calendar and the bookings for that room should import.
 
*Repeat for any other rooms.
 
*Repeat for any other rooms.
−
 
  
 
'''Mac'''
 
'''Mac'''
Line 46: Line 76:
 
*Enter a name for the calendar in the Name field and choose a color from the adjacent pop-up menu.
 
*Enter a name for the calendar in the Name field and choose a color from the adjacent pop-up menu.
 
*Repeat for any other rooms.
 
*Repeat for any other rooms.
 +
 +
== Data Options ==
 +
1. These options can be used to setup two way syncing to a google or other calendar without re-exporting imports and creating duplicate bookings. See also the options for iCal import to ignore duplicates.
 +
{| class="wikitable"
 +
|-
 +
! scope="col"| Paramenter
 +
! scope="col"| Use
 +
|-
 +
 +
| &icalimport1=hide
 +
| add this to not include bookings imported from channel Ical Import 1.
 +
|-
 +
 +
| &icalimport2=hide
 +
| add this to not include bookings imported from channel Ical Import 2.
 +
|-
 +
 +
| &icalimport3=hide
 +
| add this to not include bookings imported from channel Ical Import 3.
 +
|-
 +
 +
|}
 +
 +
2. Additional parameters can be added to the calendar URL to further specify the export data.
 +
{| class="wikitable"
 +
|-
 +
! scope="col"| Paramenter
 +
! scope="col"| Use
 +
|-
 +
 +
| &end=lastnight
 +
| Exports the end date of the booking as the date of the last night, i.e. one day before the checkout date
 +
|-
 +
 +
| &dates=checkin
 +
| Only shows check-in days, not the rest of the booking
 +
|-
 +
 +
| &dates=checkout
 +
| Only shows check-out days, not the rest of the booking
 +
|-
 +
 +
| &showtime=true''
 +
| Adds time to the calendar dates. Default checkin is added at 2PM and checkout at 10AM
 +
<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span>This option should only be used if your software requires dates including time information.
 +
|-
 +
 +
| &starttime=hh:mm
 +
| Specifies the event start time, for example 16:00 when using &showtime=true
 +
|-
 +
 +
| &endtime=hh:mm
 +
| Specifies the event end time, for example 11:00 when using &showtime=true
 +
|-
 +
 +
 +
| &timezone=Europe/London
 +
| Specify the timezone if your calendar needs it, the timezone must be a valid ical timezone value. Valid timezone values can be found in the TZ* column at this link http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
 +
|-
 +
 +
| &hiderequest=true
 +
|Prevents request status bookings appearing in the ical
 +
|-
 +
 +
| &hideblack=true
 +
|Prevents black status bookings appearing in the ical
 +
|-
 +
 +
| &showinquiry=true
 +
|Shows Inquiry bookings in the ical, they will not appear without this option.
 +
|-
 +
 +
| &includerooms=true
 +
| Include the details of bookings included from other rooms as per the room dependency "Include Bookings From" settings.
 +
|-
 +
 +
| &unavaildates=365
 +
| The default days in the future returned is 365 days, this can be overridden with this parameter to any value between 0 and 750 days in advance.
 +
|-
 +
 +
| &nourl=true
 +
| Hides the view booking link.
 +
|-
 +
 +
| &back=7
 +
| Include bookings from this many days ago (allowed values are 0 to 30).
 +
|-
 +
 +
 +
|}
 +
 +
== Troubleshooting ==
 +
'''Check-out date shows available'''
 +
Some calendars will fix dates particularly the check-out date midnight. This will cause the check-out date to show available. You can fix this by adding '''&showtime=true''' as explained above.
 +
 +
== Disconnect ==
 +
*To disconnect set "Export" = Disable
 +
*Remove the link from your calendar
 +
== Notes ==
 +
If you want to use a custom URL you can use a URL shorten-er service which lets you customize the link.

Latest revision as of 14:54, 27 March 2024

Ical Export
This page is about the menu  (SETTINGS) CHANNEL MANAGER > ICAL EXPORT and explains how to synchronise Beds24 with your Google or any iCal calendar

1 Capabilities

Beds24.com can export bookings and unavailable dates as an iCal feed.

Google calendar and many other systems can read the iCal feed.

Many holiday rental sites support Ical more Information

For details please click here

2 Limitations

Only active bookings are exported, cancelled bookings will not appear.

Settings in prices which limit availability are not considered.

Your Calendar program is responsible for routinely updating the calendar, we have no control over how often systems like Google calendar actually perform an update.

3 What you will need

The Beds24 Calendar URL as displayed in the channel manager menu for each room.

4 Beds24.com

4.1 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,

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.

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.

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.

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.


If you add &nourl=1 to the URL the link to the booking will be removed.

4.2 Activate

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

All upcoming bookings are included and blocked dates for one year in advance.

4.3 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.

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.

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

5 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.

Google.com

  • Log into your Google calendar.
  • In the left column select "Other calendars".
  • Select "Add by URL".
  • Enter the Beds24 Calendar URL (see above).
  • Click Add Calendar and the bookings for that room should import.
  • Repeat for any other rooms.

Mac

  • In Calendar, choose File > New Calendar Subscription.
  • Enter the calendar’s web address, and then click Subscribe.
  • Enter a name for the calendar in the Name field and choose a color from the adjacent pop-up menu.
  • Repeat for any other rooms.

6 Data Options

1. These options can be used to setup two way syncing to a google or other calendar without re-exporting imports and creating duplicate bookings. See also the options for iCal import to ignore duplicates.

Paramenter Use
&icalimport1=hide add this to not include bookings imported from channel Ical Import 1.
&icalimport2=hide add this to not include bookings imported from channel Ical Import 2.
&icalimport3=hide add this to not include bookings imported from channel Ical Import 3.

2. Additional parameters can be added to the calendar URL to further specify the export data.

Paramenter Use
&end=lastnight Exports the end date of the booking as the date of the last night, i.e. one day before the checkout date
&dates=checkin Only shows check-in days, not the rest of the booking
&dates=checkout Only shows check-out days, not the rest of the booking
&showtime=true Adds time to the calendar dates. Default checkin is added at 2PM and checkout at 10AM

This option should only be used if your software requires dates including time information.

&starttime=hh:mm Specifies the event start time, for example 16:00 when using &showtime=true
&endtime=hh:mm Specifies the event end time, for example 11:00 when using &showtime=true
&timezone=Europe/London Specify the timezone if your calendar needs it, the timezone must be a valid ical timezone value. Valid timezone values can be found in the TZ* column at this link http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
&hiderequest=true Prevents request status bookings appearing in the ical
&hideblack=true Prevents black status bookings appearing in the ical
&showinquiry=true Shows Inquiry bookings in the ical, they will not appear without this option.
&includerooms=true Include the details of bookings included from other rooms as per the room dependency "Include Bookings From" settings.
&unavaildates=365 The default days in the future returned is 365 days, this can be overridden with this parameter to any value between 0 and 750 days in advance.
&nourl=true Hides the view booking link.
&back=7 Include bookings from this many days ago (allowed values are 0 to 30).

7 Troubleshooting

Check-out date shows available
Some calendars will fix dates particularly the check-out date midnight. This will cause the check-out date to show available. You can fix this by adding &showtime=true as explained above.

8 Disconnect

  • To disconnect set "Export" = Disable
  • Remove the link from your calendar

9 Notes

If you want to use a custom URL you can use a URL shorten-er service which lets you customize the link.

Retrieved from "https://wiki.beds24.com/index.php?title=ICal_Export&oldid=24762"