Schedule widget - Metasys - LIT-12011953 - Server - Metasys UI - 7.0.50

Metasys UI Help

Brand
Metasys
Product name
Metasys UI
Document type
User Guide
Document number
LIT-12011953
Version
7.0.50
Revision date
2024-03-19
Product status
Active
Language
English

How do I add a Weekly Schedule?

Note: You require Modify Items permission to the authorization category of the schedule object to add a weekly schedule.
  1. Click the ADJUST WEEKLY SCHEDULE button to open the Breakout Schedule view with Weekly Schedule selected.
  2. Drag your cursor anywhere in the calendar. The Add Event window opens.
  3. Complete the fields as required.
    Note: Existing events during the defined times are modified or replaced when you save your changes.
  4. Click SAVE.

How do I edit a Weekly Schedule?

Note: You require Modify Items permission to the authorization category of the schedule object to edit a weekly schedule.
You can edit a Weekly Schedule by dragging an existing event:
  1. Click the ADJUST WEEKLY SCHEDULE button to open the Breakout Schedule view with Weekly Schedule selected.
  2. Go to the event that you want to edit.
  3. Drag your cursor to expand or reduce the existing event, or drag an entire event block to another location. The Edit Event window opens.
  4. Edit the fields as required.
    Note: Existing events during the defined times are modified or replaced when you save your changes.
  5. Click SAVE.
You can also edit a Weekly Schedule by clicking the Edit icon:
  1. Click the ADJUST WEEKLY SCHEDULE button to open the Breakout Schedule view with Weekly Schedule selected.
  2. Click the event that you want to edit. Click the Edit icon in the schedule event pop-up.
  3. Edit the fields in the Edit Event window as required.
    Note: Existing events during the defined times are modified or replaced when you save your changes.
  4. Click SAVE.

How do I add a scheduled item to a schedule?

  1. Open the schedule that you want to add a scheduled item to.
  2. Click or tap the Scheduled Items tab in the lower left of the Schedule widget.
  3. Click or tap the Edit icon. The Edit Scheduled Items window opens.
  4. Click or tap +. The Add Item(s) window opens.
  5. Select one or more items from the Network tree or Views. You can select more than one item by clicking the Shift key.
  6. Select an attribute from the Attribute list. If you select more than one item from the All Items tree, the default attribute of the individual objects is selected. You can edit the attributes in the Edit Scheduled Items window later.
  7. Click or tap OK.
  8. The new item displays in the Edit Scheduled Items window.
  9. Click or tap SAVE to add the new scheduled item.
  10. The new scheduled item displays in the list in the Scheduled Items tab.
    Note: Associated spaces and equipment are listed only if the added object is mapped to spaces and equipment.

How do I delete a scheduled item?

  1. Open the schedule from which you want to delete a scheduled item.
  2. Click or tap the Scheduled Items tab in the lower left of the Schedule widget.
  3. Click or tap the Edit icon. The Edit Scheduled Items window opens.
  4. Select the item that you want to delete.
  5. Click or tap the Delete icon. If you remove the last item or the key item from the list, you get a warning message.
  6. Click or tap OK.
  7. The deleted scheduled item no longer appears in the Edit Scheduled Items. Click or tap SAVE to complete the deletion.
  8. The deleted scheduled item and the associated spaces and equipment no longer display in the list in the Scheduled Items tab.

How do I edit the attribute of a scheduled item?

  1. Open the schedule that you want to edit.
  2. Click or tap the Scheduled Items tab in the lower left of the Schedule widget.
  3. Click or tap the Edit icon. The Edit Scheduled Items window opens.
  4. Go to the item that you want to edit and select another attribute from the Scheduled Attribute list.

How do I designate a scheduled item as the key item?

A schedule can only apply values of one data type to all items in its list of scheduled items; therefore, the first item in the Scheduled Items list becomes the key item. The key item determines the data type of the values that the schedule writes to the attributes of all scheduled items. To designate a scheduled item as the key item, complete the following steps:
  1. Open the schedule that you want to edit.
  2. Click or tap the Scheduled Items tab in the lower left of the Schedule widget.
  3. Click or tap the Edit icon. The Edit Scheduled Items window opens.
  4. If no scheduled items are present, add a new item. That new item automatically becomes the key item.
  5. If several scheduled items are present, select the item that you want to nominate as the key item and click the key icon.

How do I reorder my scheduled items?

  1. Open the Breakout Schedule view for the schedule that you want to edit.
  2. Click or tap the Scheduled Items tab in the lower left of the Schedule widget.
  3. Click or tap the Edit icon. The Edit Scheduled Items window opens.
  4. Select the item that you want to move up or down and click the relevant arrow. You can move one item at a time only.

How do I define the execution details of a scheduled item?

  1. Open the Breakout Schedule view for the schedule that you want to edit.
  2. Click or tap the Scheduled Items tab in the lower left of the Schedule widget.
  3. Click or tap the Edit icon. The Edit Scheduled Items window opens.
  4. If no scheduled items are defined, the default values are populated in the Execution section. When you then add a scheduled item, that item becomes the key item and the Schedule Output Type field changes to Derived From Key Item.
    Note: If you need to change the data type of a key item from analog to binary, remove the defined weekly schedule completely and create a new one with the required data type, rather than changing the execution details.

How do I disable or enable a schedule?

  1. Open the Detail widget of the schedule.
  2. Click on the value, which is the first item listed in the Detail widget. The Commanding window opens.
  3. From the Command list, select Disable or Enable, as required.
Note: When you disable a schedule, you see the following message: This schedule failed to write to one or more scheduled items.

How do I configure the Effective Period for a schedule?

To configure the effective period for a schedule:
  1. Open the schedule that you want to edit.
  2. Click or tap the Details tab in the lower left of the Schedule widget.
  3. Click or tap the value for Effective Period. The Effective Period Range window opens.
  4. Configure the Month, Day, Year, and Day of Week for the start and end of the Effective Period. See below for details.
  5. Click or tap SAVE.
To comply with BACnet rules, the Effective Period range must use either fully specified dates, with all fields defined, completely unspecified dates, with all fields set to Any, or a combination of a fully specified date and a completely unspecified date. See Table 3 for examples.
Note: When fully specifying a date, choose the specific Month, Day, and Year. For the Day of Week field, set it to Any to have Metasys UI calculate the matching day of the week. Alternatively, manually specify the matching day of the week. If Day of Week does not match the Month, Day, and Year, the save will fail.
Table 3. Examples of valid Effective Periods
No. Duration Month Day Year Day of Week Description
1 From Any Any Any Any Starts immediately with no end.
To Any Any Any Any
2 From January 1 2024 Any or Monday Starts Monday, January 1, 2024, and ends Tuesday, April 30, 2024.
To April 30 2024 Any or Tuesday
3 From Any Any Any Any Starts immediately and ends Tuesday, July 4, 2023.
To July 4 2023 Any or Tuesday
4 From August 30 2023 Any or Wednesday Starts August 30, 2023, with no end.
To Any Any Any Any
Do not use partially specified dates for the start or end of the Effective Period. A partially specified date is where the Month, Day, and Year fields are set to a combination of Any and specific value(s). For example, the following are partially specified dates, which are invalid for Effective Period:
  • Month = Any; Day = Any; Year = 2023; Day of Week = Thursday
  • Month = January; Day = Any; Year = Any; Day of Week = Any
  • Month = Any; Day = Any; Year = Any; Day of Week = Sunday

How does Effective Period affect schedules and the Schedule widget?

The effective period for a schedule defines the timeframe in which the schedule is active. On dates outside of the schedule’s effective period, the schedule will have an Inactive status and will not execute.

If the effective period is configured with an invalid range, the schedule may not operate as expected. When this is the case, Metasys UI displays a warning message in the schedule widget.

When you view the schedule widget, Metasys UI will not display schedule data for dates outside of the schedule’s effective period. As a result, you cannot see the weekly schedule configuration if you are viewing dates outside of the effective period. To view and modify events in the weekly schedule, use the date picker to display a week that falls entirely within the schedule’s effective period.
Note: The date picker in the schedule widget will not allow you to view past weeks. If the schedule’s effective period ended in a past week, use Site Management Portal or SCT to view and edit the Weekly Schedule.