Schedules

Owned by Petrescu, Ioana (FT D EU RO BP)
Last updated: Oct 05, 2023 by Ricky Villa
9 min read

Schedules

The Schedules app allows the user to create, edit or check out schedules.

 

Using Schedules

To use the Schedules:

1. Select the Schedules app on the menu. 

2. When the Schedules app is selected, it will open the Schedule view where it will display the schedules based on the context of where the user is in in the navigation level. So if the user navigated to an AHU, it'll display any schedules on the AHU.

3. From there the user can select to View All, create new, refresh, download/upload, organize, and view/edit schedules.

Schedules App View Options

Below are the available options when in the Schedule View.

View All Schedules

If the user would like to view all schedules instead of one, they can select the View All Schedules option.

1. The user will have to select on the tool gear located on the left-hand corner of the schedule view.

2. The user will be displayed with different options of tools.

3. Select on the View All Schedules

Create a New Schedule

If the user wants to create a new schedule, they would just select the Create New Schedule option.

1. The user will have to select on the tool gear  located on the left-hand corner of the schedule view.

2. The user will be displayed with different options of tools.

3. Select on the Create New Schedule  

4. Once selected, a Create a New Schedule pop up will appear.

The required fields in the pop up are:

  • Schedule Name: User selects a name for the schedule

  • Schedule Type: User selects a schedule type from the dropdown, It can be between boolean/number/string/enum

  • TimeZone: User can select the timezone in which they want the schedule to be configured on. By default, it defaults to the system timezone that FIN runs on.

  • Has Default Value: User specifies if the schedule will have a default value or not (selected by default to have a value)

 

5. Once the user is done, they select OK, which will bring up a pop up to set the Default Value if selected. It will be based on the schedule type selected.

6. Then once the default value is selected, the Add Points to Schedule will pop up so that the user can select which points the schedule will affect. If a point is already linked to a schedule, they will have the schedule name in parenthesis next to it.

Schedulable

In order for the points to appear in the Add Points to Schedule, they must already be configured as schedulable. They need to have the number property tag called schedulable and level of 2-7 or 9-16 to be written too. Recommended level is 15, which is the default.

That can be done on the point itself in the Schedule section or by clone/batch tagging points that need to be scheduled as schedulable:15.

7. Once the user assigns the selected points to the schedule, they get a Schedule Created pop up.

Now the schedule will show up in the Schedule View and ready to be edited.

Refresh

If changes were made but don't appear changed. The user can select the Refresh option to refresh the Schedule View.

1. The user will have to select on the tool gear located on the left-hand corner of the schedule view.

2. The user will be displayed with different options of tools.

3. Select on the Refresh

Backup

This allows the user to download the schedules to be able to upload to a project.

Location

1. The user will have to select on the tool gear  located on the left-hand corner of the schedule view.

2. The user will be displayed with different options of tools.

3. Select on the Backup

Tool

  1. Once selected, a pop up will appear to download.

    1. Here is more information on this Download tool.

Restore

This allows the user to upload schedules to a project.

Location

1. The user will have to select on the tool gear  located on the left-hand corner of the schedule view.

2. The user will be displayed with different options of tools.

3. Select on the Restore

Tool

  1. Once selected, a pop up will appear to upload.

    • Here is more information on this Upload tool.

Organize

If the user would like to organize their schedules, they can do so with the Organize option.

Location

1. The user will have to select on the tool gear located on the left-hand corner of the schedule view.

2. The user will be displayed with different options of tools.

3. Select on the Restore

Tool

1. Once selected, it'll bring up the below popup that will display all schedules.

2. From there the user can select which schedules they would like to organize together.

3. Then they would type in a name for the folder path.

Example:

1. The user will select Normal Work Week and Sport Weekend.

2. Then enter "Example" as the folder path.

3. Now when you look at it, the schedule will be nested under "Example"..

4. If you go to View All Schedules, you'll see both schedules we selected under "Example".

 

Schedule Options

Below are the available options on the slider menu when selecting a schedule.

Edit

If the user would like to edit the schedule weekly events, holiday events, and/or points found on a particular schedule, they would select the Edit option.

Weekly view

In this view, the user can add/remove/edit weekly events and modify part of the schedule itself like name, whether it has a default value, and/or default value.

Note: If the user wants to change the week start day, they can change this via the Host → Settings → scroll down to the Host section to find the Week Start Day setting to change it.

Editing basic schedule info

To rename a schedule, change whether it has a default value, and/or change the default value, the user will select the edit icon at the top right corner of the weekly view.

Adding weekly event

To add a weekly event:

1. The user will select the  at the top left corner of the weekly view

2. Once they select that, they can select on which day they would like to add an event too and adjust it accordingly

3. They can either cancel or apply those changes at the top of the schedule.

4. If the user applies the weekly event, they will be prompted by an Event Value popup so they can set what the value is for that event.

 

Modifying or removing weekly event

To modify an existing weekly event:

1. The user will select and long hold the weekly event until they see the handlebars to adjust it.

  • From there, the user can adjust the weekly event, move it, or delete it.

2. The user has the option to Cancel, Delete, or Apply changes at the top of the schedule.

 

Events view

In this view, the user can add/remove/edit Events and/or re-arrange the order.

Adding Event

To add an Event:

1. The user will select the  at the top left of the Events view.

2. Once they select that, the New Event popup will appear

  • They can either cancel by clicking on 'x' top left corner or applying by clicking on '✓' top right corner.

Modifying Events

Modifying Events such as editing, re-arranging, or deleting:

1. The user needs to click on the edit icon top right of the Events view.

2. Then once that is selected, the user will have the options to:

  • Edit by clicking on the edit icon on left to the event

  • Deleting by clicking on the x on the right of the event

  • Re-arranging by selecting and dragging the hamburger icon to the right of the event

3. If the user decides to cancel to exist out of that view, they would select the 'x' at the top left corner of that view

4. If the user made changes and wants to apply them, they would select the '✓' top right corner of that view.

Points view

In this view, the user can add/remove/move points.

Adding points

If the user wants to add a point:

1. The user would select the  at the top left corner of the points view

2. Then if any schedulable points are found, they can be selected and added

  • To cancel, select the 'x' at the top left corner

  • To apply, select the '✓' top right corner of that view.

Removing or moving points to another schedule

If the user wants to remove or move points to another schedule:

1. They would select the point(s) they want to remove or move

2. Then select the arrow button at the top right corner of that view.

3. Once that icon is selected, the user will be prompted to either cancel, delete, or move those selected points.

  • To cancel, simply select the Cancel option

  • To delete, simply select the Delete option

  • To move the points to a different schedule of the same type, select one available schedules, then select the Move options.

    • The Move option won't be available until a schedule is selected.

Tools

If the user would like to clone and/or add points to a schedule, they would select Tools option to find the appropriate tool to do what it is they want. Here are all the documented Schedule Tools.

Delete

If the user would like to delete a schedule, they can select the Delete option found on the schedule slider menu to remove the schedule.