Creator Help

iCal Feed

Overview

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.

iCal feed for a report

Prerequisites

To enable a calendar application to fetch data from a report (list, summary, spreadsheet or calendar) in your Zoho Creator app, you need to:

  1. 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).
  2. Publish that report. This will generate the 'key' that is needed to make your report publicly accessible.

    Note: If the screenshots in the ensuing steps do not match your app's UI, please email to support@zohocreator.com to enable iCal feed. Once you get this enabled, you can construct your report's iCal feed URL as mentioned in this section.

  3. Enable iCal feed for that report as follows:
    1. Access the required report.
    2. Click the Settings icon in the top-right, then click Links and select iCal Feed, as shown below:

    3. 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:

iCal feed URL format

The iCal Feed URL of a report is as given below:

https://creatorexport.zoho.com/<app owner name>/<app link name>/ical/<report link name>/<key>/<property1>=<value>&<property2>=<value>

where,

app owner name is the Zoho username of the application's owner 
app link nameis the link name of the app
report link nameis the link name of the report 
keyis 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)
valueis 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.

iCal properties supported by Zoho Creator

Property NameType of field that can be mapped
(as value to the property)
Requirement
DTSTARTDATE-TIMEMandatory
DTEND (or) DURATIONDATE-TIMEMandatory
SUMMARYTEXTThe field linked to this will appear as the event title
UID(this need not be specified as it is generated by default)Mandatory
ORGANIZERTEXTOptional
CREATEDDATE-TIMEOptional
CLASSTEXT
(values can be: PUBLIC / PRIVATE / CONFIDENTIAL)
Optional
DESCRIPTIONTEXTOptional
LAST-MODDATE-TIMEOptional
LOCATIONTEXTOptional
ORGANIZERTEXTOptional
PRIORITYINTEGEROptional
DTSTAMPDATE-TIMEOptional
STATUSTEXT
(values can be: tentativeconfirmed / canceled)
Optional

Things to know

  • 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:
    Format
    ZC_SET:<property name>=<value>
    ExampleZC_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:

    1. 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.
    2. 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.

Example

The iCal feed URL for this sample report is,

 

https://creatorexport.zoho.com/sampleapps/ical-feed/ical/Event_Management_Report

 

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.

https://creatorexport.zoho.com/sampleapps/ical-feed/ical/Event_Management_Report/ORGANIZER=Coordinator&DTSTART=Start_Date&DTEND=End_Date&ZC_FULL_DAY_EVENT_VAR=Full_day_event&SUMMARY=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:

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocreator.com