Skip to content

Announcements

Niall edited this page Aug 30, 2019 · 5 revisions

This page currently only applies to KiteBoard 2.0.0 - 2.0.15. Not currently implemented in 3.0 Announcements can be scheduled using KiteBoard's built in announcement system powered by cron4j. This uses the same syntax as cron based scheduling systems.

Default configuration

announcements:
  everyHalfHour:
    #This schedules an announcement at 12pm every day.
    time: "12 * * * *"
    type: "BOARD_GROUP"
    group: "announcement_midday"
  anotherAnnouncement:
    time: "* * * * *"
    type: ACTIONBAR
    message: "This action bar is triggered every minute!"

Valid Announcement Types:

  • BOARD_GROUP
  • ACTIONBAR
  • TITLE

Scheduling patterns:

The pattern is: [Minute] [Hour] [Day of Month] [Month] [Weekday]

  • [Minute] is a number between 0 and 59.
  • [Hour] is a number between 0 and 23.
  • [Day of Month] is a number between 1 and 31, depending on the month.
  • [Month] is either the name of month (for example january) or a number between 1 and 12.
  • [Weekday] is either the name of the day (Mon, tue, wed, ...) or a number between 1 and 7.

Some examples:
(Source: http://www.sauronsoftware.it/projects/cron4j/manual.php#p02)

5 * * * *
This pattern causes a task to be launched once every hour, at the begin of the fifth minute (00:05, 01:05, 02:05 etc.).

* * * * *
This pattern causes a task to be launched every minute.

* 12 * * Mon
This pattern causes a task to be launched every minute during the 12th hour of Monday.

* 12 16 * Mon
This pattern causes a task to be launched every minute during the 12th hour of Monday, 16th, but only if the day is the 16th of the month.

Every sub-pattern can contain two or more comma separated values.

59 11 * * 1,2,3,4,5
This pattern causes a task to be launched at 11:59AM on Monday, Tuesday, Wednesday, Thursday and Friday.

Values intervals are admitted and defined using the minus character.

59 11 * * 1-5
This pattern is equivalent to the previous one.