Skip to content

Instantly share code, notes, and snippets.

@utumno86
Created January 12, 2021 23:26
Show Gist options
  • Save utumno86/8cbc1e803794befa72b71556540f3b04 to your computer and use it in GitHub Desktop.
Save utumno86/8cbc1e803794befa72b71556540f3b04 to your computer and use it in GitHub Desktop.
Scheduler Component Guide

HTML Scheduler Component


As of 1/12/2021 we have replaced our flash scheduler compoenent with an html version of the same component as a result of flash's end of life as of December 31st. This is a usage guide for the new component, which is available on the screens/schedule screen where it always was.

  • Get Scheduled Items Screen

    Since the new scheduler does not have a slick calendar UI it functions by displaying a list all items scheduled for a screen within a given time frame. Since we wanted our user to provide the timeframe, the initial screen is a form for the user to provide it.

    If you simply click the green "get scheduled items" button, it will default to a time frame from two weeks in the future to two weeks in the past.

  • Scheduled Items List Screen

    This screen provides a list of every time a playlist is scheduled for a given screen within a given timeframe. The individual items give you information on the dates and timing of the items as well as edit and delete buttons for the item.

  • Edit button

    The pencil button takes you to a form where you can edit an exising scheduled item. The form for it is identical to the create form described below.

  • Delete Button

    This button will remove a scheduled item from the database. Note that because each of these individual items corresponds with multiple entries in the scheduled items table, it will remove multiple entires.

  • Playlist Picker

    This just picks amongst the playlists to be scheduled.

  • Start Time

    Start time determines both the date and time that a particular playlist is supposed to be scheduled. The system uses this value to determine when to load new playlists so it is crucial.

  • Stop Time

    This optional value determines how long on a given day a playlist will play. E.g if start time is on 1/7/2021 7:30 A.M. and Stop Time is on 1/7/2021 11:00 A.M. the playlist will play from 7:30 AM to 11:00 AM. This timeframe will carry over for any schedule recurrence; i.e. if the schedule is set to daily, it will play from 7:30 to 11:00 A.M. every day. Note that stop time is capped at a 24 hour difference from start time, so it isn't possible to schedule stop time for a seperate date.

  • All Day

    This toggle allows you to completely ignore the 'time' portion of start time, end time, and ignore stop time alltogether. With this checked, the system will assume that the scheduled item will play all day on every date during which it is scheduled. I.e. if you have this checked, and a start time of 1/7/2021, a blank stop time, and an end_time of 1/10/2021, with a daily recurrence, that playlist would play from midnight to midnight on 1/7, 1/8, 1/9, and 1/10 and then revert back to the default playlist.

  • End Time

    End time determines on what date the recurrence of the playlist ends. I.e. if you wanted to schedule something to to be scheduled every day from May 1st to June 30th, you would set this value at June 30th and set recurrence to daily. The time portion would be evaluated on June 30th, so if you set end time to 06/30/2021 8PM that 8PM wouldn't be relevant until June 30th.

  • Recurrence

    This determines how often a particular item recurs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment