Calendar Configuration

Last updated
Save as PDF

The calendar configuration file is responsible for defining the properties of the overall schedule container.

Description

This is where the calendar title is defined that the user sees, along with the web name parameter that is passed on the URL to indicate which schedule to load and display to the end user.

Properties

All the following properties must be included in the configuration file, even if they are not used. Properties that are not used should be set to the blank string "".

Property	Description
uuid	A unique identifier comprised of an alpha-numeric string. Example: "`changes`"
name	The name displayed at the top of the calendar page. Example: "`Change Calendar`"
webname	The value used in the "webname" URL parameter to identify the calendar. This value must be unique across all calendars. Example: "`changes`"
description	A description for the calendar indicating what type of information the calendar will display. This value is displayed in the calendar listing page. Example: "`Displays all changes for company XYZ`"
status	Indicates whether the calendar is active or inactive. If the calendar is inactive, it cannot be viewed. Example: "`Active`"
summaryColor	The color that will be used in the summary row to indicate events exist during the time slot. The summary row compounds events from all rows below it. Can be any valid css color name or hex color value. Example: "`#dd0000`"
tickerSegments	NEW In v1.1.0 The number of segments each hour/day is divided into. A value of 4 will have three tick marks at 15 minute intervals. A value of 3 will have two tick marks at 20 minute intervals. Example: "`4`"
visibility	Not used. May set to blank string - ""
acl	Not used. May set to blank string - ""
defaultView	Defines the number of days to display on initial page load, by indicating the view range. Allowable Values: "`day`", "`week`", "`month`", "`custom`" Example: "`day`"
defaultPage	The JSP used to render the calendar. A default theme is supplied with the installation war, and should be used if no custom themes have been developed. Changing the JSP page allows for changes to corporate branding, language settings, etc... Example: "`themes/default/jsp/main_en.jsp`"
encoding	The character encoding used when sending the response to the browser. This value should always be "UTF-8". Example: "`UTF-8`"
visibleInListing	Indicates whether the schedule is visible to end users in the root index page. Valid values are "true" or "false". Schedules that are not visible are still accessible, they just do not show up in the index page. Example: "`true`"
clickHandler	If defined, allows an action to take place when a user clicks an open time slot on the calendar. Please see the click handlers configuration page for more details.
customIncrement	NEW In v1.1.0 When the `defaultView` property is set to "`custom`", this property sets how many units - hours or days - will be displayed when the page is initially loaded. Format: `Positive integer value` Example: "`1`"
customUnit	NEW In v1.1.0 When the `defaultView` property is set to "`custom`", this property sets the units value in the increment by drop-down selector when the page is initially loaded. Format: `either "hours" or "days"` Example: "`hours`"
customHour	NEW In v1.1.0 When the `defaultView` property is set to "`custom`", this property sets the start hour to indicate what hour the custom view should start when the page is initially loaded. Only used if the customUnit property is also set to "hours". Format: integer value between 0 - 23 Example: "8"
createdAt	Not used, may set to `null`. If used, must be an ISO8601 formatted date string. Format: `yyyy-MM-ddTHH:mm:ssZ` Example: "`2013-07-17T16:33:06-0500`"
createdBy	Not used. May set to blank string - ""
modifiedAt	Not used, may set to `null`. If used, must be an ISO8601 formatted date string. Format: `yyyy-MM-ddTHH:mm:ssZ` Example: "`2013-07-17T16:33:06-0500`"
modifiedBy	Not used. May set to blank string - ""

Sample Calendar Configuration File

{
    "calendar": {
        "uuid": "tickets",
        "name": "Site Tickets",
        "webname": "tickets",
        "description": "Tickets by Site",
        "summaryColor": "yellow",
        "visibility": "",
        "status": "Active",
        "acl": "",
        "defaultView": "day",
        "defaultPage": "themes/default/jsp/main_en.jsp",
        "customIncrement": "12",
        "customUnit": "hours",
        "customHour": "7",
        "encoding": "UTF-8",
        "visibleInListing": "false",
        "clickHandler": {
            "type": "url",
            "callback": "http://www.mycompany.com/createTicketForSite",
            "target": "_blank",
            "showDialogFirst": "false",
            "startTimeParameter": "startTime",
            "parameters": [
                {
                    "name": "resourceId",
                    "value": "{{sourceMapKey}}"
                },
                {
                    "name": "eventType",
                    "value": "{{sourceMapDatasourceValuesKeyId}}"
                },
                {
                    "name": "duration",
                    "value": "60"
                }
            ]
        },
        "createdAt": null,
        "createdBy": "",
        "modifiedAt": null,
        "modifiedBy": ""
    }
}