Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Schedules

...

Schedules Tree

Table of Contents

The Schedules tree allows you to quickly view existing schedules and any points linked to them. However, to edit the schedule Although you can create and edit schedule information in the Schedule tree, a schedule’s weekly and holiday events , the user will have to use the schedule app itself for that.

Using Schedules

To use the Schedules tree, the user will want to make sure they set it as visible in the Select Tree... drop-down. Once visible, the user can select it in the Available Trees panel.

Image Removed

New Schedule/Add

To create a schedule, the user would select the parent tree and then either click on the plus sign (plus) and then selecting "New Schedule" or the Add button on the grid view side. The user can also create a new one while having a schedule selected.

Image Removed

Once selected, the user will be prompted with the below popup that they need to fill out or cancel.

  • Schedule Name: pick a name for the schedule
  • Schedule Type: pick a schedule type from the dropdown, It can be between boolean/number/string/enum
  • Has Default Value: specifies if the schedule will have a default value or not (selected by default to have a value)

Image Removed

If default is selected, the user will be prompted with one of the below popups depending on the type of the schedule. The user would pick the default value.

Image Removed Image Removed Image Removed

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.

Image Removed

Info
titleSchedulable

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 default.

Image Removed

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

Image Removed

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

Image Removed

Once done, it will display the schedule in the grid view where they can see quick info on it or any they may have.

Image Removed

Delete

To delete a schedule, the user can accomplish this a few ways and they are below. 

Image Removed

  • Select parent tree and then clicking on the minus sign (minus), which will prompt a popup below for the user to select available schedule(s) to delete.
    Image Removed
  • Another is to select the schedule under the parent tree and clicking the minus sign (minus), which will prompt a warning popup if the user wants to continue to delete the select schedule if no points are linked to it.
  • The third option is to select the schedule from the grid view and clicking on the Delete button, which will prompt a warning popup like above to confirm deletion.

When trying to delete a schedule with points linked to it, the user will get a pop up like below prompting them to choose to assign those points another schedule, else leave them without scheduleRefs.

Image Removed

Edit

To edit a schedule info, the user can accomplish this a few ways and they are below. 

Image Removed

Image Removed

  • Select parent tree and then clicking on the edit icon will prompt the below popup to select from available schedules to edit. Then after selecting one, they will be prompted with similar popup when first creating one.
    Image Removed Image Removed
  • Another is to select the schedule under the parent tree and clicking the edit icon either on the Available Trees Tools Menu or Grid View Tools Menu.
  • The third option is to select the schedule from the gird view and clicking the Edit button, which will prompt the edit popup like above.

New Folder

If the user has a lot of Schedules, they can use the "New Folder" option to organize them.

The user can find that option in the Available Trees Tools Menu by clicking on the plus (plus) and selecting New Folder when having the parent tree selected.

Image Removed

Once selected, the user will be prompted with the below popup to select a folder name.

Image Removed

Once created, the folder will appear under the parent Schedules tree, where the user can then select and drag and drop schedules onto the folder to nest them in there.

Image Removed Image Removed Image Removed

If the user selects the schedules first to be included in the same folder, then clicking to create a new folder, it will put them all in the same folder. The user won't have to drag and drop them in there.

The rest of the tool properties apply to the folder as well such as editing and deleting.

To find all the schedulable points that aren't linked to any schedules, the user would use the Search button. This button can be found when selecting the parent tree.

Image Removed

Once selected, the schedules list will shift down and another list of schedulable points with not schedule references will appear on the top half.

Image Removed

From here, the user can decide to add points to schedules by drag and dropping them onto a schedule of the same type. That will assign them to a schedule.

Image Removed

If the point(s) and schedule aren't of the same type, an error message will appear. If they are, then the list of points will update to exclude those since they now have a scheduleRef.

Image Removed

Make Unschedulable

Make Unschedulable button can be found when in the split view of the Search window. This option will allow the user to make points unschedulable so that they can't be written too.

Image Removed

The user would first select the point(s) to be made unschedulable, the click on the button. Once executed, they will no longer be listed since they are no longer schedulable.

Image Removed

Grid View Results

In the Grid View, the user can view all the schedules available in the project and move points around to different schedules when having selected the parent tree itself.

Image Removed

To view the points associated to a schedule, the user can expand the schedule from the left side on the arrow.

Image Removed

Then from here, the user can select any points to drag onto another schedule if they want to move them. They will only be moved if the schedule type matches the point type.

Image Removed

Once dropped onto another schedule, the user will be prompted with one of the below popups depending if it was applied to correct type or not.

Image Removed Image Removed

If the user selected the schedule itself on the tree, then the grid view will display the points associated to that schedule.

Image Removed

Point Priority

In the grid view after having selected a schedule from under the parent tree, the user will also be able to find the Point Priority option. This will allow the user to change the point priority from here instead of the point itself in point essentials or Property Editor.

The user would select the point and select Point Priority button to get the below pop up. Then just apply the new priority and thats it.

Image Removed

Image Removed

Unlink from Schedule

In the grid view after having selected a schedule from under the parent tree, the user will also be able to find the Unlink from Schedule option. This will allow the user to unlink any points from a schedule. The points will still be schedulable, just not linked to that specific schedule anymore.

The user would select the point and select Unlink from Schedule button to unlink from schedule. Once selected, the point will no longer exist in that schedule list.

Image Removedmust be edited in the Schedules app.

View List of Schedules in the Project

  • To view a list of all schedules used in the project, select Schedules from the Available Trees menu.
    A list of schedules is displayed.

Image Added

The number on next to Schedules indicates the number of schedules in the project. For example, the project in the screenshot contains four (4) schedules.

View Points Assigned to a Schedule

To view points assigned to a specific schedule:

  1. Select Schedules from the Available Trees menu.
    A list of schedules is displayed.
  2. Open the schedule's drop-down menu.
    Individual points of the schedule are displayed as tiles.

Image Added

The number next to the schedule name indicates the number of points in the schedule. This is the same number of tiles for the schedule. For example, the project in the screenshot (Sport Weekend) contains ten (10) schedules, and the associated ten tiles are displayed under the Sports Weekend schedule in the SCHEDULES section.

Reassign Points Between Schedules

To assign points from one schedule to a different schedule:

  1. Select Schedules from the Available Trees menu.
    A list of schedules is displayed on the main page.
    Image Added
  2. Open the schedule's drop-down menu.
    Individual points of the schedule are displayed as tiles.
  3. Select and drag a tile to the Schedule heading within the main window.
    The schedule's heading turns from light to medium blue. Release the mouse, placing the tile in the new schedule.
  4. A warning window pops up, confirming the placement of the point in the new schedule.

    Image Added

  5. Select APPLY.
    The point is now assigned to the new schedule.

Create a New Schedule

To create a schedule:

  1. Select Schedules from the Available Trees menu.
    A list of schedules is displayed.
    Image Added
  2. Select Add.
    The Create New Schedule window is displayed.
    Image Added
  3. Enter a Schedule Name.
  4. Select a Schedule Type from the drop-down menu; choose between Boolean, Number, String, or Enum schedule types.
  5. Select or clear the Has Default Value checkbox.
  6. Select OK
    If the Has Default Value checkbox is NOT selected, the new schedule will be created and will appear in your list of Schedules.
    If the Has Default Value checkbox is selected, the Has Default Value window will appear.
    Image Added
  7. Select a default value from the Has Default Value drop-down menu.
  8. Select OK.

Edit Schedule

To create a schedule:

  1. Select Schedules from the Available Trees menu.
    A list of schedules is displayed.
    Image Added
  2. Select the schedule to be edited.
    The schedule heading turns from light to medium blue.
  3. Select Edit.
    The Edit Schedule window is displayed.
    Image Added
  4. Modify any combination of the following fields:
    -Schedule Name
    -Default Value: select to indicate this schedule is the default
    -Tag Editor
    -Value: select a value from the drop-down menu
  5. Select APPLY

Delete Schedule

To delete a schedule:

  1. Select Schedules from the Available Trees menu.
    A list of schedules is displayed.
    Image Added
  2. Select the Schedule to be deleted.
    The schedule heading turns from light to medium blue.
  3. Select Delete.
    The Delete Schedule window is displayed. When a schedule is deleted, the points assigned to the deleted schedule must be reassigned to an existing schedule. 

    Image Added
  4. Use the drop-down menu to select the replacement schedule for the deleted schedule's points.
  5. Select APPLY.

Find and Assign Unassigned Points

  1. Select Schedules from the Available Trees menu.
    A list of schedules is displayed.
    Image Added
  2. Select the Search button.
    FIN Stack queries the database and returns a list of points that are schedulable but do not have a referenced schedule. These points display in the top section of the main window.
  3. To assign returned points to a schedule, select and drag a tile to the Schedule heading in the bottom section of the main window. A badge appears, confirming the item or number of items that are selected; see an example in the screenshot below.
    Image Added
    The schedule heading turns from light blue to medium blue. Release the mouse.
    A warning window pops up, confirming the placement of the point in the schedule.
  4. Select APPLY.
    Image Added
    The points are removed from the schedulable list and assigned to the indicated schedule.

Unlink a Point from a Schedule

You can use the Unlink from Schedule button to unlink points from a schedule, after which the points' status will be schedulable.

  1. Open the Schedules drop-down from the Available Trees menu.
    A list of schedules is displayed.
    Image Added
  2. Select a schedule.
    A list of points associated with the schedule is displayed.
  3. Select the point to unlink or unassign from the schedule.
  4. Select the Unlink from Schedule button.
    The button turns gray, indicating that the point has been unlinked from the schedule.

Change the Priority of the Schedule 

You can change the point priority in the Schedules tree instead of changing the information in Point Essentials or the Property Editor.

  1. Open the Schedules drop-down from the Available Trees menu.
    A list of schedules is displayed.
    Image Added
  2. Select a schedule.
    A list of points associated with the schedule is displayed.
  3. Select the point to change.
  4. Select the Schedule Point Priority button.
    The Schedule Point Priority window appears.
  5. Select a new point priority from the Select Point Priority drop-down menu.
    Image Added

  6. Select APPLY to assign the new point priority.
    Image Added