Cireson Portal

How To: Add a Calendar to the Cireson Portal

With the introduction of OData and SQL Dashboard Calendars in version 10 of the portal, this article is now depreciated, however the steps below can still be followed if desired

How to Add a Calendar

At a high level, these are the steps required to create a new calendar and include it on a new view panel:

  1. Add/Insert a new calendar query to DataSource table
  2. Create the calendar definition
  3. Add/Insert a new viewpanel with calendar definition
  4. Create a view with the viewpanel definition created in step 3
  5. Add/Insert a new navigation link for the view created in step 4

Adding the query, view panel and navigation nodes are discussed in details in this documentation: https://support.cireson.com/KnowledgeBase/View/1106 This document only intends to explain the calendar definitions.

Calendar Definition

queryId ​(guid) - The Id property of the calendar’s data source stored in the DataSource table.

isVisible (boolean) - Sets the calendar’s visibility

id (string) -The property that corresponds to the mandatory unique identifier of the  calendar event

title (string) -The property that corresponds to title of the event which will be displayed on the calendar

description (string) - The property that corresponds to optional event description

startDate (date) - The property that corresponds to the date at which the scheduler event starts. The start date is mandatory.

endDate (date) - The property that corresponds to the date at which the scheduler event ends. The end date is mandatory.

views (object | array) - The list of views and their configurations to be displayed on the calendar. The array items can be either objects specifying the view configuration or strings representing the view types (assuming default configuration). Refer to this documentation (http://docs.telerik.com/kendo-ui/api/javascript/ui/scheduler#configuration-views for the detailed list of calendar views configurations

defautlView (string) - Sets the selected view. By default the calendar is set to month view.

Example:

{
  "Id": "d41d52b0-3583-48f9-9923-8c9b8749a700",
  "type": "calendar",
  "content": {
    "queryId": "f6017790-41d7-4ed9-a500-6229f5eab39e",
    "views": [
      "day",
      "week",
      "month",
      "agenda"
    ],
    "defaultView": "week",
    "id": "WorkItemId",
    "title": "Title",
    "description": "Description",
    "startDate": "ScheduledStartDate",
    "endDate": "ScheduledEndDate"
  }
}