Bulk Creation of Sub-Calendars and Links

The calendar’s settings page allows calendar administrators to create and maintain sub-calendars and access links through an easy-to-use web-based user interface. This is the recommended way to configure your calendar.

In some exceptional use cases there is a need to create a very large number of sub-calendars or access links. For such use cases Teamup offers the option to import sub-calendars and access links from CSV files. This article explains how this is done. It requires some familiarity working with the CSV file format.

Steps

The import of sub-calendars and calendar keys is a hidden feature and you won’t find any reference to it in the user interface. Follow the steps below to proceed:

  1. Open the calendar settings and select view Import Events.
  2. Select input format Comma Separated Values (.csv).
  3. Select a file to import. The required formats are described below. The import tool looks at the format of the file and determines if events, sub-calendars or calendar links are to be imported.
  4. Click Save to start the import process.

Import Sub-Calendars from a CSV File

This section explains the format required to import sub-calendars from a CSV file.

Example: CSV File to import Sub-Calendars

Calendar Name, Color Id, Allow Overlap
Conf. Room Newton, 25, true
Conf. Room Thales, 17, true
Auditorium, 20, true

Line 1 is a header line and defines all the columns of this file: “Calendar Name“, “Color Id” and “Allow Overlap“. The header line must be present in the file exactly as shown in above example. Further lines each define a sub-calendar and must consist of three value separated by a comma.

Supported Fields

The following table defines the supported field names and the format of the field values.

Field Name Required? Description
Calendar Name Yes Name of the sub-calendar. Up to 100 characters.
Color Id Yes ID of color assigned to sub-calendar. All supported colors are defined in the API documentation
Allow Overlap No Supported values are “true” or “false”. This defines if the sub-calendar allows overlapping events or not.

Import Links from a CSV File

This section explains the format required to import calendar links from a CSV file.

Example: CSV File to import Calendar Links

Link Name, Password, Calendars Shared, Permissions
Admin, SecretAdminPassword, all, 0
Reception, , all, 1
Sarah, , selected, Conf. Room Newton=1; Conf. Room Thales=2
Frank, , selected, Auditorium=1;

Line 1 is a header line and defines all the columns of this file. This line must be present in the file exactly as shown in the example above. Further lines each define a calendar link.

Supported Fields

The following table defines the supported field names and the format of the field values.

Field Name Required? Description
Link Name Yes Name of link. Up to 100 characters.
Password No A password is optional. If a value is provided for this field, a password check is activated for this link.
Calendars Shared Yes This field defines if all or only selected sub-calendars are accessible through this link.  Supported values are “all” and “selected”.
Permissions Yes The value of the permission field depends on how field “Calendars Shared” is configured.

If field “Calendars Shared” is set to “all”, then this column takes an integer that defines the permission that is granted to all sub-calendars. The following permission values are supported:

  • 0 : Administrator
  • 1 : Modify
  • 2 : Read-only
  • 3 : Read-only, no details
  • 4 : Add-only
  • 5 : Add-only, no details
  • 6 : Modify from same link
  • 7 : Modify from same link, no details

If field “Calendars Shared” is set to “selected”, then this column takes a list of “name=value” pairs separated by semicolons. The name is equal to the name of an existing sub-calendar. The value is a permission value as defined below:

  • 1 : Modify
  • 2 : Read-only
  • 3 : Read-only, no details
  • 4 : Add-only
  • 5 : Add-only, no details
  • 6 : Modify from same link
  • 7 : Modify from same link, no details

Examples:

Let’s have a closer look at the example file given above.

Link Name, Password, Calendars Shared, Permissions
Admin, SecretAdminPassword, all, 0 
Reception, , all, 1 
Sarah, , selected, Conf. Room Newton=1; Conf. Room Thales=2 
Frank, , selected, Auditorium=1;
  • Line 1 is a header line and must be copied as shown above.
  • On line 2, a link named “Admin” is assigned administration permission to the calendar. A password is enable and set to the value “SecretAdminPassword”
  • On line 3, a link named “Reception” is assigned modify permission to all sub-calendars.
  • On line 4, a link named “Sarah” is assigned modify permission to sub-calendar “Conf. Room Newton” and read-only permission to sub-calendar “Conf. Room Thales”.
  • On line 5, a link named “Frank” is assigned modify permission to sub-calendar “Auditorium”.

We are always striving to improve the documentation. Your feedback to support@teamup.com is very much appreciated.