Recurrence rules
The following recurrence rules are supported by default if the rrule.json
fixture is loaded.
name |
freq |
interval |
by_set_pos |
count |
by_weekdays |
notes |
---|---|---|---|---|---|---|
once |
0 |
1 |
||||
daily |
3 |
|||||
weekly |
2 |
1 |
||||
business days |
2 |
1 |
0,1,2,3,4 |
|||
weekends |
2 |
1 |
5,6 |
|||
bi-weekly |
2 |
2 |
||||
four-weekly |
2 |
4 |
||||
monthly on the first |
1 |
1 |
1 |
|||
monthly on the second |
1 |
1 |
2 |
|||
monthly on the third |
1 |
1 |
3 |
|||
monthly on the fourth |
1 |
1 |
4 |
|||
monthly on the fifth |
1 |
1 |
5 |
|||
monthly on the last |
1 |
1 |
-1 |
|||
bi-monthly on the first |
1 |
2 |
1 |
|||
bi-monthly on the second |
1 |
2 |
2 |
|||
bi-monthly on the third |
1 |
2 |
3 |
|||
bi-monthly on the fourth |
1 |
2 |
4 |
|||
bi-monthly on the fifth |
1 |
2 |
5 |
|||
bi-monthly on the last |
1 |
2 |
-1 |
|||
three-monthly on the first |
1 |
3 |
1 |
|||
three-monthly on the second |
1 |
3 |
2 |
|||
three-monthly on the third |
1 |
3 |
3 |
|||
three-monthly on the fourth |
1 |
3 |
4 |
|||
three-monthly on the fifth |
1 |
3 |
5 |
|||
three-monthly on the last |
1 |
3 |
-1 |
|||
four-monthly on the first |
1 |
4 |
1 |
|||
four-monthly on the second |
1 |
4 |
2 |
|||
four-monthly on the third |
1 |
4 |
3 |
|||
four-monthly on the fourth |
1 |
4 |
4 |
|||
four-monthly on the fifth |
1 |
4 |
5 |
|||
four-monthly on the last |
1 |
4 |
-1 |
The actual IDs are not hard-coded in any way in steering
, only the parameters of the recurrence
rules are used to create the repetitions.
The only requirement is that the recurrence rule ID in your API call, or the dashboard, matches the
recurrence rules store in the steering
database.
If the frequency is either weekly or monthly, the weekday of the first date in the schedule determines the weekday of the repetition.