Calendar widgets in Elementi 2017 and 2018

From SpinetiX Support Wiki

Jump to: navigation, search

This page is about the calendar data-driven widgets included into Elementi 2017 and Elementi 2018. For other versions, see the links below.

Calendar example

Introduction

Elementi software features 250+ widgets, a dozen of which are designed to work with your everyday calendar tool – be it Microsoft Outlook, Office 365, Google Calendar etc. Elementi widgets are a simple way to easily connect your calendar data to a digital signage display that anyone can manage: a dedicated technical person or an assistant. Simply updating the calendar you use on a daily basis will update the content displayed on the screen.

Use the Elementi calendar widgets for any industry sector and across any organization size – from a startup to a large corporation. Here are just a few examples of how you can put your calendar widget to use at best:

  • Hospitality
    If you are running a hotel, an events company or a travel agency, a calendar widget can help you: promote hotel services, guide events’ attendees, inform about locally organized events.
  • Corporate
    Empower your employees and streamline your day-to-day dynamics by: displaying meeting room availability, keeping track of project deadlines, reminding staff about birthdays, promoting internal and community events.
  • Education
    Use the Elementi calendar widgets to: display upcoming visits, events and ceremonies from your yearly calendar, inform students and staff about upcoming sports activities, promote special events and parent-teacher meetings to public, staff, and students.
  • Healthcare
    When lives are on the line, making use of time efficiently and effectively matters most. Use the Elementi calendar widgets to: inform patients and staff about doctors’ availability, display information about upcoming medical procedures at specific locations, reduce perceived waiting time by showing upcoming patient scheduled appointments.


Getting started

Getting started is easy; download Elementi software, launch it and create away! Just follow the 4 quick steps below:

  1. Get Elementi.
  2. Open Elementi and on the main window, click on the "Widgets" tab.
  3. Scroll down and open the "Calendars" folder. Pick a widget.
  4. Include that widget into your content and configure it.


Calendar widgets

Elementi software comes with several calendar widgets accessible from "Widgets" tab within the Browse panel of the Elementi GUI.

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.

Events

Events widget

The Events widget allows you to display a set of events in a configurable table layout.

Events widget properties

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

  • Data
    Click the Data Feed Properties button to open the Data Properties dialog and set up the data source.
  • 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

Monthly Events widget

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

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

Weekly Events widget

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

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.

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.

Data source setup

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 data source type (further called channel):

Note Notes:

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.

Google calendar channel

"Info"
Security is a fundamental element to consider when giving access to your personal data and we've created our data-driven widgets with that in mind. To ensure secure access and permission control, without exposing any user credentials, Cockpit must authorize any request for third-party data. For that, you need to do the following:
  1. Create a Cockpit account, if you don't have one.
  2. Register your Elementi license into your Cockpit account.
  3. Add your players into your Cockpit account.
  4. Connect your Google account to your Cockpit account.

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

When selecting this channel in the "Data Properties" dialog, your existing Google accounts are automatically retrieved from Cockpit and displayed in the "Account" drop-down box. If you need to connect a new account, follow these steps:

  1. Select "Connect account..." option .
  2. Click the link displayed within the "Connect account..." dialog to open it in a browser.
  3. If you are not signed into your Cockpit account, you are asked to do that.
  4. Cockpit then checks that your Elementi license is registered into your Cockpit account; if not, you are asked to do that.
  5. You are then redirected to the Google website. Log into your account there, if you are not already.
  6. Then, you need to authorize the SpinetiX app to access the specified information of your Google account.
  7. Once done, you are redirected back to Cockpit channels page and you can find your account listed under "Connected Accounts".
  8. Then, return to Elementi and click the "OK" button within the "Connect Account..." dialog.
  9. The list of accounts is refreshed and you can select the new one from the "Account" drop-down box.


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

Outlook Online channel

"Info"
Security is a fundamental element to consider when giving access to your personal data and we've created our data-driven widgets with that in mind. To ensure secure access and permission control, without exposing any user credentials, Cockpit must authorize any request for third-party data. For that, you need to do the following:
  1. Create a Cockpit account, if you don't have one.
  2. Register your Elementi license into your Cockpit account.
  3. Add your players into your Cockpit account.
  4. Connect your Outlook Online account to your Cockpit account.
"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.

Outlook Online channel connection

When selecting this channel in the "Data Properties" dialog, your existing Microsoft accounts are automatically retrieved from Cockpit and displayed in the "Account" drop-down box. If you need to connect a new account, follow these steps:

  1. Select "Connect account..." option .
  2. Click the link displayed within the "Connect account..." dialog to open it in a browser.
  3. If you are not signed into your Cockpit account, you are asked to do that.
  4. Cockpit then checks that your Elementi license is registered into your Cockpit account; if not, you are asked to do that.
  5. You are then redirected to the Microsoft website. Log into your account there, if you are not already.
  6. Then, you need to authorize the SpinetiX app to access the specified information of your Microsoft account.
  7. Once done, you are redirected back to Cockpit channels page and you can find your account listed under "Connected Accounts".
  8. Then, return to Elementi and click the "OK" button within the "Connect Account..." dialog.
  9. The list of accounts is refreshed and you can select the new one from the "Account" drop-down box.


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

Facebook events channel

"Warning!"
Starting with April 4, 2018, Facebook decided to immediately disable some capabilities, which resulted in the lost of the capability to retrieve Facebook events. Our team is actively working to find a workaround.


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.
  • Multiscreen usage.
    These widgets can only be used on a single screen when creating a multiscreen project; for multiple screens, a data feed widget must be used instead.

See also

This page was last modified on 14 June 2018, at 16:20.