Vision - Equipment Schedule
Component Palette Icon:
Description​
The Equipment Schedule component is a mix between the Status Chart, Gantt Chart, and Calendar components. It conveys a lot of information about equipment, including current status, production schedule, production status, scheduled and unexpected downtime.
The equipment schedule is powered by four datasets. Information is retrieved from the datasets by column name, case-insensitive. The order of the columns is not important. Optional columns may be omitted.
The Items Dataset​
Describes the "items" or "cells" to display schedules for. Each entry in this dataset will become a row of the chart.
| Name | Type | Optional | Description |
|---|---|---|---|
| ID | Any | N | The identifier for this item. May be any type, will referenced by each entry in the Scheduled Events dataset. |
| Label | String | N | The text to display in the header. |
| Foreground | Color | Y | Text color |
| Background | Color | Y | Background color |
| StatusImagePath | String | Y | A path to an image to display to the right of the header label. |
The Scheduled Items Dataset​
Lists the scheduled events for each item described in the "Items" dataset. Each scheduled event can have a colored lead, or change-over time, a label, a background color, and a progress.
| Name | Type | Optional | Description |
|---|---|---|---|
| EventId | String | Y | An identifier for the event, used for event selection. |
| ItemId | Any | N | The ID of the item to correlate this event with. If no such item is found, the event won't be shown. |
| Label | String | N | The text to display in the event's box. |
| StartDate | Date | N | The start-time for the event. |
| EndDate | Date | N | The end-time for the event. |
| Foreground | Color | Y | The text color of the event. |
| Background | Color | Y | The background color of the event. |
| LeadTime | Integer | Y | Time, in seconds, to display as lead time. |
| LeadColor | Color | Y | The color for the lead time, if any. |
| PctDone | Number | Y | A value from 0 to 100 to be displayed as a progress bar, use -1 to hide progress bar. |
The Downtime Dataset​
Entries in this dataset will be displayed as simple colored overlays on top of the events, correlated against an item defined in the "Items" dataset.
| Name | Type | Optional | Description |
|---|---|---|---|
| ItemId | Any | N | The ID of the item to correlate this downtime event with. If no such item is found, the downtime event won't be shown. |
| StartDate | Date | N | The start time for the downtime event. |
| EndDate | Date | N | The end time for the downtime event. |
| Color | Color | Y | The color to use, typically transparent. |
| Layer | Integer | Y | 0 or 1, with 0 meaning that the rectangle gets painted below the events, and 1 means it will be painted above the events. |
The Breaks Dataset​
Entries in this dataset will be displayed as colored underlays beneath all events.
| Name | Type | Optional | Description |
|---|---|---|---|
| StartDate | Date | N | The start time for the break event. |
| EndDate | Date | N | The end time for the break event. |
| Color | Color | Y | The color to use. |
Properties​
| Name | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Border | The border surrounding this component. Options are No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), and Field Border. Note: The border is unaffected by rotation. Changed in 8.1.21 As of 8.1.21, the "Button Border" and "Other Border" options are removed. | Border | .border | Common |
| Break Events | Scheduled breaks, which will appear as downtime for all items. | Dataset | .breakEvents | Data |
| Current Time Color | The color of the current time indicator. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector. | Color | .nowColor | Appearance |
| Downtime Events | Downtime events correlated to a specific item. | Dataset | .downtimeEvents | Data |
| Drag Enabled | Controls whether or not scheduled events can be dragged for rescheduling. | boolean | .dragEnabled | Behavior |
| Enabled | If disabled, a component cannot be used. | boolean | .componentEnabled | Common |
| End Date | The end of the time range to display. | Date | .endDate | Data |
| Event Border | The normal border for a scheduled event. | Border | .eventBorder | Appearance |
| Event Font | The font to use for the event labels. | Font | .eventFont | Appearance |
| Event Margin | The margin to leave visible above and below a scheduled event. | int | .scheduledEventMargin | Appearance |
| Header Background | The color of the background for the header timeline. See Color Selector. | Color | .headerBackground | Appearance |
| Header Font | The font of the text in the header timeline. | Font | .headerFont | Appearance |
| Header Item Font | The font to use for the header items' labels. | Font | .itemFont | Appearance |
| Header Text Color | The color of the text in the header timeline. See Color Selector. | Color | .headerTextColor | Appearance |
| Items | The cells, or equipment items, to have their schedules displayed. | Dataset | .items | Data |
| Line Color | The color of separating lines in the schedule. | Color | .lineColor | Appearance |
| Name | The name of this component. | String | .name | Common |
| Progress Bar Background | The background color for the event progress bars. See Color Selector. | Color | .progressBackground | Appearance |
| Progress Bar Border | The border color for the event progress bars. See Color Selector. | Color | .progressBorder | Appearance |
| Progress Bar Fill | The color for 'done' portion the event progress bars. See Color Selector. | Color | .progressFill | Appearance |
| Resize Enabled | Controls whether or not scheduled events resized for duration changes. | boolean | .resizeEnabled | Behavior |
| Row Height | The height of each event's schedule row. | int | .lineHeight | Appearance |
| Schedule Background | The background color of the schedule area. See Color Selector. | Color | .scheduleBackground | Appearance |
| Scheduled Events | The scheduled events for all configured items. | Dataset | .scheduledEvents | Data |
| Selected Event Border | The border for a selected scheduled event. | Border | .selectedEventBorder | Appearance |
| Selected Event ID | The ID of the selected event. | String | .selectedEvent | Data |
| Start Date | The beginning of the time range to display. | Date | .startDate | Data |
| Visible | If disabled, the component will be hidden. | boolean | .visible | Common |
Scripting​
See the Vision - Equipment Schedule Scripting Functions page for the full list of scripting functions available for this component.
Event Handlers​
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page
Customizers​
Examples​
The Equipment Schedule contains a lot information about Machines 1-4 from May 18 through May 20 such as equipment status, the production schedule, production status, and schedule and unscheduled downtime. It provides a view into the status of equipment on the production floor in realtime and scheduled work planned for three days. It uses four datasets: Items, Scheduled Events, Downtime Events, and Break Events. Each dataset is shown below with it's associated raw data.
You'll notice each piece of equipment has a lead time or change-over time, a unique Order number for the run, background color and displays a progress bar. Equipment downtime entries are displayed as colored overlays on top of the events. Break events with a start and end time are displayed as colored underlays beneath the events.
Equipment Schedule - Items Dataset​
Equipment Schedule - Items Raw Data
"#NAMES"
"ID","Label","StatusImagePath","Foreground","Background"
"#TYPES"
"I","str","str","clr","clr"
"#ROWS","4"
"1","Machine 1","Builtin/icons/24/media_play.png","color(0,0,0,255)","color(0,255,0,255)"
"2","Machine 2","Builtin/icons/24/media_stop_red.png","color(0,0,0,255)","color(192,192,192,255)"
"3","Machine 3","Builtin/icons/24/media_play.png","color(0,0,0,255)","color(0,255,0,255)"
"4","Machine 4","Builtin/icons/24/media_play.png","color(0,0,0,255)","color(0,255,0,255)"
Equipment Schedule - Scheduled Items Dataset​
Equipment Schedule - Scheduled Items Raw Data
"#NAMES"
"EventID","ItemID","StartDate","EndDate","Label","Foreground","Background","LeadTime","LeadColor","PctDone"
"#TYPES"
"str","I","date","date","str","clr","clr","I","clr","D"
"#ROWS","24"
"evt-1-0","1","2020-05-18 03:30:29.002","2020-05-18 10:09:29.002","Ord#B041","color(0,0,0,255)","color(214,255,198,255)","120","color(255,255,0,255)","100.0"
"evt-1-1","1","2020-05-18 12:15:29.002","2020-05-18 17:44:29.002","Ord#8F3","color(0,0,0,255)","color(255,220,198,255)","660","color(255,255,0,255)","100.0"
"evt-1-2","1","2020-05-18 19:34:29.002","2020-05-19 01:48:29.002","Ord#8F3","color(0,0,0,255)","color(255,220,198,255)","3600","color(255,255,0,255)","100.0"
"evt-1-3","1","2020-05-19 03:05:29.002","2020-05-19 07:25:29.002","Ord#E9A6","color(0,0,0,255)","color(198,255,242,255)","360","color(255,255,0,255)","100.0"
"evt-1-4","1","2020-05-19 08:35:29.002","2020-05-19 17:56:29.002","Ord#87BE","color(0,0,0,255)","color(255,198,207,255)","3060","color(255,255,0,255)","0.0"
"evt-1-5","1","2020-05-19 19:05:29.002","2020-05-20 05:06:29.002","Ord#8F3","color(0,0,0,255)","color(255,220,198,255)","4740","color(255,255,0,255)","0.0"
"evt-2-0","2","2020-05-18 03:20:29.002","2020-05-18 10:56:29.002","Ord#8F3","color(0,0,0,255)","color(255,220,198,255)","3180","color(255,255,0,255)","100.0"
"evt-2-1","2","2020-05-18 13:33:29.002","2020-05-18 19:18:29.002","Ord#8F3","color(0,0,0,255)","color(255,220,198,255)","840","color(255,255,0,255)","100.0"
"evt-2-2","2","2020-05-18 21:30:29.002","2020-05-19 06:06:29.002","Ord#8F3","color(0,0,0,255)","color(255,220,198,255)","1380","color(255,255,0,255)","100.0"
"evt-2-3","2","2020-05-19 08:27:29.002","2020-05-19 14:01:29.002","Ord#87BE","color(0,0,0,255)","color(255,198,207,255)","2400","color(255,255,0,255)","87.0"
"evt-2-4","2","2020-05-19 15:18:29.002","2020-05-19 21:37:29.002","Ord#87BE","color(0,0,0,255)","color(255,198,207,255)","2520","color(255,255,0,255)","0.0"
"evt-2-5","2","2020-05-19 23:47:29.002","2020-05-20 09:48:29.002","Ord#E9A6","color(0,0,0,255)","color(198,255,242,255)","5040","color(255,255,0,255)","0.0"
"evt-3-0","3","2020-05-18 02:00:29.002","2020-05-18 09:00:29.002","Ord#B041","color(0,0,0,255)","color(214,255,198,255)","3360","color(255,255,0,255)","100.0"
"evt-3-1","3","2020-05-18 10:29:29.002","2020-05-18 20:41:29.002","Ord#E9A6","color(0,0,0,255)","color(198,255,242,255)","1800","color(255,255,0,255)","100.0"
"evt-3-2","3","2020-05-18 23:38:29.002","2020-05-19 09:16:29.002","Ord#87BE","color(0,0,0,255)","color(255,198,207,255)","2580","color(255,255,0,255)","64.0"
"evt-3-3","3","2020-05-19 10:28:29.002","2020-05-19 20:45:29.002","Ord#E9A6","color(0,0,0,255)","color(198,255,242,255)","5820","color(255,255,0,255)","0.0"
"evt-3-4","3","2020-05-19 23:11:29.002","2020-05-20 05:26:29.002","Ord#87BE","color(0,0,0,255)","color(255,198,207,255)","3060","color(255,255,0,255)","0.0"
"evt-3-5","3","2020-05-20 06:27:29.002","2020-05-20 13:17:29.002","Ord#B041","color(0,0,0,255)","color(214,255,198,255)","3900","color(255,255,0,255)","0.0"
"evt-4-0","4","2020-05-18 02:35:29.002","2020-05-18 09:51:29.002","Ord#87BE","color(0,0,0,255)","color(255,198,207,255)","3060","color(255,255,0,255)","100.0"
"evt-4-1","4","2020-05-18 12:30:29.002","2020-05-18 17:18:29.002","Ord#87BE","color(0,0,0,255)","color(255,198,207,255)","2220","color(255,255,0,255)","100.0"
"evt-4-2","4","2020-05-18 18:47:29.002","2020-05-19 04:48:29.002","Ord#E9A6","color(0,0,0,255)","color(198,255,242,255)","4980","color(255,255,0,255)","100.0"
"evt-4-3","4","2020-05-19 06:37:29.002","2020-05-19 11:44:29.002","Ord#87BE","color(0,0,0,255)","color(255,198,207,255)","1920","color(255,255,0,255)","47.0"
"evt-4-4","4","2020-05-19 14:14:29.002","2020-05-19 21:18:29.002","Ord#8F3","color(0,0,0,255)","color(255,220,198,255)","1080","color(255,255,0,255)","0.0"
"evt-4-5","4","2020-05-20 00:00:29.002","2020-05-20 07:49:29.002","Ord#8F3","color(0,0,0,255)","color(255,220,198,255)","1500","color(255,255,0,255)","0.0"
Equipment Schedule - Downtime Events Dataset​
Equipment Schedule - Downtime Events Raw Data
"#NAMES"
"ItemID","StartDate","EndDate","Color","Layer"
"#TYPES"
"I","date","date","clr","I"
"#ROWS","18"
"1","2020-05-18 13:25:29.002","2020-05-18 13:37:29.002","color(212,49,49,75)","1"
"1","2020-05-18 14:11:29.002","2020-05-18 14:49:29.002","color(212,49,49,75)","1"
"1","2020-05-18 20:34:29.002","2020-05-18 21:12:29.002","color(212,49,49,75)","1"
"1","2020-05-18 21:48:29.002","2020-05-18 22:09:29.002","color(212,49,49,75)","1"
"1","2020-05-19 03:42:29.002","2020-05-19 04:07:29.002","color(212,49,49,75)","1"
"1","2020-05-19 04:55:29.002","2020-05-19 05:13:29.002","color(212,49,49,75)","1"
"1","2020-05-19 06:09:29.002","2020-05-19 06:46:29.002","color(212,49,49,75)","1"
"2","2020-05-18 04:00:29.002","2020-05-18 04:31:29.002","color(212,49,49,75)","1"
"2","2020-05-18 05:02:29.002","2020-05-18 05:39:29.002","color(212,49,49,75)","1"
"2","2020-05-18 22:08:29.002","2020-05-18 22:45:29.002","color(212,49,49,75)","1"
"3","2020-05-18 02:56:29.002","2020-05-18 03:34:29.002","color(212,49,49,75)","1"
"3","2020-05-18 04:21:29.002","2020-05-18 04:56:29.002","color(212,49,49,75)","1"
"3","2020-05-18 05:26:29.002","2020-05-18 05:40:29.002","color(212,49,49,75)","1"
"4","2020-05-18 03:11:29.002","2020-05-18 03:26:29.002","color(212,49,49,75)","1"
"4","2020-05-18 04:14:29.002","2020-05-18 04:50:29.002","color(212,49,49,75)","1"
"4","2020-05-18 05:35:29.002","2020-05-18 06:01:29.002","color(212,49,49,75)","1"
"4","2020-05-18 13:39:29.002","2020-05-18 13:50:29.002","color(212,49,49,75)","1"
"4","2020-05-18 14:29:29.002","2020-05-18 14:57:29.002","color(212,49,49,75)","1"
Equipment Schedule - Breaks Events​
Equipment Schedule - Breaks Events Raw Data
"#NAMES"
"StartDate","EndDate","Color"
"#TYPES"
"date","date","clr"
"#ROWS","9"
"2020-05-18 08:30:00.002","2020-05-18 09:15:00.002","color(55,120,55,50)"
"2020-05-18 12:00:00.002","2020-05-18 13:00:00.002","color(55,120,55,50)"
"2020-05-18 16:15:00.002","2020-05-18 17:00:00.002","color(55,120,55,50)"
"2020-05-19 08:30:00.002","2020-05-19 09:15:00.002","color(55,120,55,50)"
"2020-05-19 12:00:00.002","2020-05-19 13:00:00.002","color(55,120,55,50)"
"2020-05-19 16:15:00.002","2020-05-19 17:00:00.002","color(55,120,55,50)"
"2020-05-20 08:30:00.002","2020-05-20 09:15:00.002","color(55,120,55,50)"
"2020-05-20 12:00:00.002","2020-05-20 13:00:00.002","color(55,120,55,50)"
"2020-05-20 16:15:00.002","2020-05-20 17:00:00.002","color(55,120,55,50)"