Calendar widgets in Elementi 2017

From SpinetiX Support Wiki

(Redirected from Calendar widgets)
Jump to: navigation, search
"Info"
This page is about the calendar data-driven widgets included into Elementi 2017.
For older versions, see Calendar widgets in Elementi 2016, Calendar widgets in Elementi 2015 and Feed widgets in Elementi 3.x pages.

Introduction

Calendars are commonly used to store one-time or repetitive events, like: meetings, room bookings, classes etc. The calendar widgets can be used to include the content of calendar files (.ics) within digital signage projects.

The following calendar data source types (further called channels) are supported:


Note Note: See more about accessing data from calendar applications and Data feeds in general.

Note Note: The current version of these widgets is not compatible with multiscreen content.

Calendar example

Video tutorial

Calendar widgets

Under the "Calendars" folder of Elementi 2017 Widgets, you can find many ready-to-use widgets that automatically display data extracted from a calendar data source:

Calendar widgets
  • Events
    Display the calendar events in a ready to use predefined layout.
  • Monthly Events
    Display all the calendar events of the current month, grouped by day using a ready to use predefined layout.
  • Weekly Events
    Display all the calendar events of the current week, grouped by day using a ready to use predefined layout.
  • Text Bar
    Displays text content using a fixed number of lines and applying a bottom-to-top & line-by-line scrolling effect whenever the entire text doesn't fit into the widget area.
  • Text Ticker
    Displays text content using a continuous horizontal scrolling effect. The font size is adjusted automatically for the text to fit into the widget area.
  • Text Roll
    Displays text content using a continuous vertical scrolling effect. The font size is adjusted automatically for the selected number of lines to fit into the predefined area.
  • Slideshow
    Displays slides composed of text & media layers, which are automatically filled out with data retrieved from the calendar. The slides are displayed one after another, with or without a transition effect in between, similarly to a playlist.
  • Horizontal Table, Vertical Table, Table, and Daily Events
    Displays slides composed of multiple cells of text & media layers, which are automatically filled out with data retrieved from the calendar. The slides are displayed one after another, with or without a transition effect in between, similarly to a playlist.


See also:

Configuration

Each of the widgets above can be customized using the options provided under "Properties" tab - for more details go to the dedicated page of each widget type, linked above.

To edit the properties related to the data source, click on the Data Properties button. This opens the "Data Properties" dialog, which offers different parameters depending on the selected channel:

  • ICS File (default)
  • Google Calendar


Note Note: At any point, the data source configuration can be tested by clicking on the "Test..." button.

ICS file channel

When the channel option is set to "ICS File", the "Data Properties" dialog offers the following parameters:

"Data Properties" dialog for calendar widgets - ICS file channel
  • Channel
    Select the spreadsheet data source type between "ICS File" (default), "Google Calendar", "Outlook File" or "Facebook Events".
  • URI
    Enter the URI to the ICS file - this can be a local path into the project or a remote HTTP(S) address.
  • Max count
    Enable this option and specify the maximum number of events to be kept from the data set (starting from the first row).
  • Refresh
    Specify the period after which the widget should refresh the spreadsheet data (this is useful especially when the widget is running in a loop); either select one of the provided options ("When document opens", 5m, 10m, ... , 24h) or enter a number, optionally followed by s (implicit), m or h; the minimum accepted value is 60 seconds. Using "When document opens" will refresh the data only when the document is re-opened.
  • Starts
    Specify the starting date / time for the data to be displayed - events before this date are not included in the final data set. The following options are possible:
    • Date
      Specify an absolute date / time for filtering the data.
    • Relative
      Specify a date / time relative to the moment when the widget is opened. Possible values includes "Now", "Today", "Tomorrow", "This Monday", "Next Month", "Last Year" etc.
    • Custom
      Specify a starting date using a custom date string. This option is only available in Elementi X.
  • Ends
    Specify the ending date / time for the data to be displayed - events after this date are not included in the final data set. The following options are possible:
    • Date, Relative, Custom
      Same as above.
    • Duration
      Specify a duration relative to the starting time specified under "From".
    • Indefinite
      Specify that all events occurring after the starting date must be included in the output data.


Note Note: To insert a line break in the event description of an external ICS calendar item, use the line feed character ("\n").

Google calendar channel

"Info"
Using this channel requires that having your Google account connected with the Cockpit account.
Moreover, your Elementi license must be registered into Cockpit and your target HMP must be added into Cockpit.

When the channel option is set to "Google Calendar", the "Data Properties" dialog offers the following parameters:

"Data Properties" dialog for calendar widgets - Google calendar channel
  • Channel
    Select the spreadsheet data source type between "ICS File" (default), "Google Calendar", "Outlook File" or "Facebook Events".
  • Account
    Select one of the connected Google accounts or click "Connect account..." if none was previously connected.
  • Calendar
    Select the calendar from which to get the events.
  • Max count, Refresh, Starts, Ends
    Same as above.

Google channel connection

Using the Google Calendar channel within the calendar widgets requires having your Google account connected with the Cockpit account where your Elementi license is registered. For that, follow these steps:

  1. Select the "Channel" option as "Google Calendar".
  2. Select the "Account" option as "Connect account...".
  3. Click the URL displayed within the "Connect Account..." dialog.
  4. The Google sign-in page is opened;
    • Follow the steps on that page to sign into your Google account.
  5. Allow the SpinetiX app to access the specified information of your Google account.
  6. Return to Elementi and click the "OK" button within the "Connect Account..." dialog.
  7. At this point, your Google account appears in the "Account" drop-down box and your Google calendars automatically appear in the "Calendar" drop-down box.


Note Note: The Google account can be disconnected at any time from Cockpit from the "Channels" page.

Outlook Online channel

Added in Elementi 2017.

"Info"
Using this channel requires that having your Microsoft online account connected with the Cockpit account.
Moreover, your Elementi license must be registered into Cockpit and your target HMP must be added into Cockpit.
"Data Properties" dialog for calendar widgets - Outlook Online channel

When the channel option is set to "Outlook Online", the "Data Properties" dialog offers the following parameters:

  • Channel
    Select the calendar data source type between "ICS File" (default), "Google Calendar", "Outlook File" or "Facebook Events".
  • Account
    Select one of the connected Microsoft online accounts or click "Connect account..." if none was previously connected.
  • Calendar
    Select the calendar from which to get the events.
  • Max count, Refresh, Starts, Ends
    Same as above.

Microsoft online channel connection

Using the Outlook Online channel within the calendar widgets requires having your Microsoft online account connected with the Cockpit account where your Elementi license is registered. For that, follow these steps:

  1. Select the "Channel" option as "Outlook Online".
  2. Select the "Account" option as "Connect account...".
  3. Click the URL displayed within the "Connect Account..." dialog.
  4. The Microsoft online sign-in page is opened;
    • Follow the steps on that page to sign into your Microsoft online account.
  5. Allow the SpinetiX app to access the specified information of your Microsoft online account.
  6. Return to Elementi and click the "OK" button within the "Connect Account..." dialog.
  7. At this point, your Microsoft online account appears in the "Account" drop-down box and your Outlook calendars automatically appear in the "Workbook" drop-down box.


Note Note: The Microsoft online account can be disconnected at any time from Cockpit from the "Channels" page.

Facebook events channel

Added in Elementi 2017.

"Info"
Using this channel requires that having your Facebook account connected with the Cockpit account.
Moreover, your Elementi license must be registered into Cockpit and your target HMP must be added into Cockpit.
"Data Properties" dialog for calendar widgets - Facebook Events channel

When the channel option is set to "Facebook Events", the "Data Properties" dialog offers the following parameters:

  • Channel
    Select the calendar data source type between "ICS File" (default), "Google Calendar", "Outlook File" or "Facebook Events".
  • Account
    Select one of the connected Facebook accounts or click "Connect account..." if none was previously connected.
  • Profile
    Select the name of the calendar from which to get the events.
  • Max count, Refresh, Starts, Ends
    Same as above.

Facebook channel connection

Using the Facebook events channel requires having your Facebook account connected with the Cockpit account where your Elementi license is registered. For that, follow these steps:

  1. Select the "Account" option as "Connect account...".
  2. Click the URL displayed within the "Connect Account..." dialog.
  3. Next, the Facebook sign-in page is opened;
    • follow the steps on that page to sign into your Facebook account.
  4. Next, allow the SpinetiX app to access the specified information of your Facebook account.
  5. Return to Elementi and click the "OK" button within the "Connect Account..." dialog.
  6. At this point, your Facebook account appears in the "Account" drop-down box.


Note Note: The Facebook account can be disconnected at any time from Cockpit from the "Channels" page.

Blue Pack

Added in Elementi 2017.

Events

Introduction

Events widget

The Events widget let you display a set of event in a configurable table layout.

Properties

Events widget properties

The following properties, found under "Properties" tab, can be used to customize the widget:

  • Data / Data source
    Click on the Data Properties button to edit the properties related to the data source from where the items are retrieved.
  • Locale
    Select the locale used for displaying dates and numbers.
  • Slide duration
    Enter the number of seconds each slide is displayed on the screen.
  • Transition
    Click on the Transition Properties button to select a transition effect and its properties.
  • Looping
    Select whether the widget ends after the last slide or loops to the first one.
  • Number of rows
    Enter the number of rows of data to display on a single slide.
  • Number of columns
    Enter the number of columns of data to display on a single slide.
  • Delay per cell
    Enter the number of seconds to wait before displaying the next cell of data.

Monthly Events

Introduction

Monthly Events widget

The Monthly Events widget let you display all the event of the current month, grouped by day.

Properties

Monthly Events widget properties

The following properties, found under "Properties" tab, can be used to customize the widget:

  • Data / Data source
    Click on the Data Properties button to edit the properties related to the data source from where the items are retrieved.
  • Locale
    Select the locale used for displaying dates and numbers.
  • Slide duration
    Enter the number of seconds each slide is displayed on the screen.
  • Transition
    Click on the Transition Properties button to select a transition effect and its properties.
  • Looping
    Select whether the widget ends after the last slide or loops to the first one.
  • Number of columns
    Enter the number of columns of data to display on a single slide.
  • Number of events
    Enter the maximum number of events to display for each column.
  • Days: Events
    Enter the maximum number of events to display for a given day.
  • Days: Slide duration
    If there are more than the above number of event for a single day, enter the number of seconds each group of events is displayed on the screen. This number should be inferior to the overall Slide duration for all the events to be displayed.
  • Headers: Show header
    Select whether the widget has an header or not.
  • Headers: Text
    Select the text of the header to be displayed.

Weekly Events

Introduction

Weekly Events widget

The Weekly Events widget let you display all the event of the current week, grouped by day.

Properties

Weekly Events widget properties

The following properties, found under "Properties" tab, can be used to customize the widget:

  • Data / Data source
    Click on the Data Properties button to edit the properties related to the data source from where the items are retrieved.
  • Locale
    Select the locale used for displaying dates and numbers.
  • Slide duration
    Enter the number of seconds each slide is displayed on the screen.
  • Transition
    Click on the Transition Properties button to select a transition effect and its properties.
  • Looping
    Select whether the widget ends after the last slide or loops to the first one.
  • Number of columns
    Enter the number of columns of data to display on a single slide.
  • Number of events
    Enter the maximum number of events to display for each column.
  • Days: Events
    Enter the maximum number of events to display for a given day.
  • Days: Slide duration
    If there are more than the above number of event for a single day, enter the number of seconds each group of events is displayed on the screen. This number should be inferior to the overall Slide duration for all the events to be displayed.
  • Headers: Show header
    Select whether the widget has an header or not.
  • Headers: Text
    Select the text of the header to be displayed.

Custom date string

Note
This option is only available in Elementi X.

Format

The custom date string can be entered using any of the following formats:

offset relative_date
time
offset relative_date time
offset relative_time
  • offset
    The offset applied to relative_date or relative_time as a signed integer (e.g., -12, -5, -1, +1, +2, +30 etc.) or the word this (instead of using 0).
  • relative_date
    The relative date specified using one of the following keywords:
    • day, days,
      Examples: "this day", "+1 day", "-5 days".
    • month, months, month-dd, months-dd,
      Note: dd is a fixed day during that month.
      Examples: "this month", "this month-10" (means the 10th day of the current month), "+1 month-31" (means last day of next month);
    • year, years, year-mm, years-mm, year-mm-dd, years-mm-dd,
      Note: mm is a fixed month and dd is a fixed day during that year.
      Examples: "-1 year" (means last year), "this year-12-1" (means December 1st of this year);
    • monday, tuesday, wednesday, thursday, friday, saturday, sunday (i.e. the day of the week in lowercased English format)
      Examples: "-2 sunday" "this monday", "+3 friday" etc.
  • time
    The fixed time during the specified date, if any, using hh, hh:mm, hh:mm:ss.
    If not provided, then 00:00:00 is used for start date (From) and 23:59:59 is used for end date (To). If some or all time-notation elements are provided, they are replaced within the default ones.
    Examples: "15" (defaults to 15:00:00 for start date, respectively 15:59:59 for end date), "07:30", "22:50:45".
  • relative_time (added into 3.1.0)
    The relative time specified using one of the following keywords: "hour", "hours", "minute", "minutes", "second", "seconds".
    Examples: "-3 hours", "+5 minutes", "+150 seconds".

This Monday

Using "This Monday" either as start or end filter refers to the Monday of the current week. With other words, if today is

  • Monday, then using "This Monday" means the current day,
  • Thursday, Wednesday, ..., Saturday, then using "This Monday" means last Monday.
  • Sunday, then using "This Monday" means either last Monday or next Monday depending on whether the week starts on Monday or Sunday, according to the selected locale.


Similarly, using "This Sunday" refers to the Sunday of the current week. With other words, if today is:

  • Sunday, then using "This Sunday" means the current day,
  • Monday, then using "This Sunday" means either next Sunday or last Sunday depending on whether the week starts on Monday or Sunday, according to the selected locale.
  • Thursday, Wednesday, ..., Saturday, then using "This Sunday" means next Sunday.

Troubleshooting

  • Displaying a calendar takes some time, freezes or even triggers an HMP restart (or safe mode).
    Most probably the calendar file has grown too much and the HMP requires too much time to parse it - if so, the quickest solution is to remove all the past events from the calendar.
This page was last modified on 5 May 2017, at 09:56.