Table of Contents
iCalendar (iCal) is an open standard for exchanging calendar and scheduling information. iCal feed enables an application to fetch, push or syncronize date and time based data to an another calendar application (like Google calendar).
Zoho Creator supports iCal feed for reports (list, summary, spreadsheet and calendar) that have a date-time field as a displayed column. To subscribe to the calendar and scheduling information displayed in your report (list, summary, spreadsheet or calendar), you need to add it's iCal feed URL in the target calendar application.
To enable a calendar application to fetch data from a report (list, summary, spreadsheet or calendar) in your Zoho Creator app, you need to:
- Ensure that the date-time fields that define the start and end of your events, are visible in your report (they should not be hidden).
- Publish that report. This will generate the 'key' that is needed to make your report publicly accessible.
- Enable iCal feed for that report as follows:
- Access the required report.
- Click the Settings icon in the top-right, then click Links and select iCal Feed, as shown below:
- Check the checkbox next to Enable iCal feed for this view in the popup window that appears. The basic iCal feed URL of your report will be displayed in the same window, as shown below:
The iCal Feed URL of a report is as given below:
|app owner name||is the Zoho username of the application's owner|
|app link name||is the link name of the app|
|report link name||is the link name of the report|
|key||is a string of characters that Zoho Creator generates (when you publish your report), which enables the report to be publicly accessible|
|property1, property2||are iCal properties as given in this table (Note that the iCal properties DTSTART and DTEND are mandatory)|
|value||is the Field Deluge Name of the corresponding column in the report. The value stored in that field will be assigned to the iCal property.|
Note: You can append the iCal feed URL with more property-value pairs as query string, as given in this table. However, the resulting URL may become too long for a calendar application to read. In such cases, you need to use URL shortening and then add the shortened URL to your calendar application.
|Property Name||Type of field that can be mapped|
(as value to the property)
|DTEND (or) DURATION||DATE-TIME||Mandatory|
|SUMMARY||TEXT||The field linked to this will appear as the event title|
|UID||(this need not be specified as it is generated by default)||Mandatory|
(values can be: PUBLIC / PRIVATE / CONFIDENTIAL)
(values can be: tentative / confirmed / canceled)
- When you do not want the value of an iCal property to be assigned from your report, you must append it to the URL (as a query string) in the following format:
FormatZC_SET:<property name>=<value> Example ZC_SET:CLASS=Public
(where the iCal property "CLASS" will be assigned with the value "Public" for all the rows displayed by your report)
When your report displays a mixture of full-day and finite duration events, you need to:
- Have a field in the corresponding form which must store one of two values: true (if the record is a full-day event), and false (or null ) if it is not.
- Append the iCal feed URL with this query string: ZC_FULL_DAY_EVENT_VAR=<field_name>
where, <field_name> is the Field Deluge Name of the field you added in the step-1.
- The frequency at which external applications such as Google Calendar and Zoho Calendar fetch data from Zoho Creator is twice or thrice a day.
A fully constructed iCal feed URL of this report is given below. Here, the parameter ZC_FULL_DAY_EVENT_VAR is appended to the URL with the value as Full_day_event.
You can add the events displayed by this report in a calendar application which supports fetching date-time based data from URLs. In Google Calendar, you can add this URL as mentioned here: Subscribe to calenders in Google Calendar. The data will appear as shown below: