Skip to end of metadata
Go to start of metadata

Description

A component that displays OEE downtime events for an active production run at the line or cell level and allows the operator to select more specific downtime reasons for the event. It also allows the operator to split downtime events at the line level. (Events cannot be split at the cell level.) This accommodates downtime events that have multiple reasons. For example, if a production line goes down because of a mechanical failure and when maintenance finishes the repair, it is time for break. The operator can split the downtime event into two events. One for mechanical failure and the other for break.

 

Changes made to downtime events at the cell level are visible at line level and vice versa.

Example

If you change downtime reason from 'Malfunction' to 'Jam' at the line level, then downtime reason at the cell level will show 'Jam' as well.


User Error Example

If you change a downtime event by altering downtime equipment through scripting to an equipment item under a different line than the line pointed to by the OEE Downtime Table, the component will not return the event.

Watch the Video


Component Palette


 

Component Properties

Properties are provided that can be set to affect the operation and look of the component. They can be set through the Property Editor in the Designer or through scripting.

Example
event.source.parent.getComponent('OEE Downtime Table').downtimeReasonListViewType = 0

If the Rollup Time Span is set to roll up multiple events and each event has a note, then the notes will be concatenated together.

 

 Behavior
NameScriptingPropertyTypeDescription
Downtime Reason List View TypedowntimeReasonListViewTypeintType of the downtime reason list view to show. Choices are 0 (Grid) and 1 (Tree). The 'Change Equipment' button in the list view can change a downtime reason to a new downtime reason with other equipment.
 Data
NameScriptingPropertyTypeDescription
Equipment PathequipmentPathStringEquipment path to show or edit downtime reasons for. If the equipment path points to the Line, all events that are considered to cause line downtime are shown. If the equipment path points a cell under a line, all downtime events for that cell will be shown.
Excluded Equipment PathexcludedEquipmentPathStringBeginning part of a path to exclude from the displayed equipment paths. If the property is blank, then it will default to the line path.
Run Look Back CountrunLookBackCountInteger

Number of runs to show downtime events for within the selected date range. Set to 0 to see all runs within the date range. Set to 1 to see only the current run. Greater numbers are additive: 2 will show you events from the last 2 runs, 3 from the last 3 runs, et cetera.

If set to 1 or greater, the date range will not be used.

Rollup Time SpanrollupTimeSpanIntegerRollup time span in seconds to combine events by.
Start DatestartDateDateStart date of downtime events to show.
End DateendDateDateEnd date of downtime events to show.
EditableeditablebooleanDetermines whether downtime reasons are edited.
Enable NotesenableNotesbooleanDetermines whether notes are shown or edited for downtime reasons.
Activity TimeoutactivityTimeoutIntegerNumber of seconds to wait after user activity before update.
Column Attribute DatacolumnAttributesDataDatasetDataset containing the data attributes
DatadataDatasetData for this table.
Selected RowselectedRowintIndex of the first selected row, or -1 if none.
 Appearance
NameScriptingProperty TypeDescription
Selection Foreground ColorselectionForegroundColorForeground color of a selected row in the table.
Selection Background ColorselectionBackgroundColorBackground color of a selected row in the table.
Vertical Scrollbar WidthverticalScrollbarWidthintWidth of a vertical scrollbar.
Horizontal Scrollbar HeighthorizontalScrollbarHeightintHeight of a horizontal scrollbar.
Header FontheaderFontFontFont to use for the table header.
Header Background ColorheaderBackgroundColorBackground color of the table header.
Header Foreground ColorheaderForegroundColorForeground color of the table header.
Grid Line ColorgridColorColorColor of grid lines in the table.
Show Horizontal Grid Lines?showHorizontalLinesbooleanDetermines whether horizontal grid lines are shown in the table.
Show Vertical Grid Lines?showVerticalLinesbooleanDetermines whether vertical grid lines are shown in the table.
Table Background ColortableBackgroundColorBackground color of the table body.
Title FonttitleFontFontFont to use for the title bar.
Title Foreground ColortitleForegroundColorForeground color of the title bar.
Title Background ColortitleBackgroundColorBackground color of the title bar.
Slide FontslideFontFontFont to use for the slide panel.
Slide Foreground ColorslideForegroundColorForeground color of the slide panel.
Slide Background ColorslideBackgroundColorBackground color of the slide panel.
Slide TypeslideTypeintType of the slide panel to open it. Options: Over, Out.
Slide DirectionslideDirectionintDirection of the slide panel to open it. Options: Left, Right, Top, Bottom.
Maximum Slide PositionmaximumSlidePositionfloatMaximum position of the slide panel to open it.
Auto Row Height EnabledautoRowHeightEnabledbooleanIf true, the row height of the downtime table will be adjusted automatically.
Row HeightrowHeightintRow height of the downtime table and the equipment list.
Downtime Reason Button WidthdowntimeReasonButtonWidthintWidth of downtime reason buttons in the downtime reason grid view.
Downtime Reason Button HeightdowntimeReasonButtonHeightintHeight of downtime reason buttons in the downtime reason grid view.
Vertical Scrollbar WidthverticalScrollbarWidthintWidth of the vertical scroll bar.
Horizontal Scrollbar HeighthorizontalScrollbarHeightintHeight of the horizontal scrollbar.
Slider Knob Icon PathsliderKnobIconPathStringRelative path of the slider knob icon image in the Split Downtime Reason view.
Left Arrow Icon PathleftArrowIconPathStringRelative path of the left arrow icon image in the Split Downtime Reason view.
Right Arrow Icon PathrightArrowIconPathStringRelative path of the right arrow icon image in the Split Downtime Reason view.

The following appearance properties are deprecated but exist only for backwards compatibility. Use the loadIcon extension function instead.

Equipment State Class Icon PathequipmentStateClassIconPathStringRelative path of the 'Equipment State Class' icon image of the downtime reason list view. The recommended icon size is 16x16 pixels.
Equipment State Icon PathequipmentStateIconPathStringRelative path of the 'Equipment State' icon image of the downtime reason list view. The recommended icon size is 16x16 pixels.
Change Equipment Icon PathchangeEquipmentIconPathStringRelative path of the 'Change Equipment' icon image. The recommended icon size is 16x16 pixels.
Revert to Original Code Icon PathrevertToOriginalCodeIconPathStringRelative path of the 'Revert to Original Code' icon image. The recommended icon size is 16x16 pixels.
Split Downtime Reason Icon PathsplitDowntimeReasonIconPathStringRelative path of the 'Split Downtime Reason' icon image. The recommended icon size is 16x16 pixels.
Note Downtime Reason Icon PathnoteDowntimeReasonIconPathStringRelative path of the 'Note Downtime Reason' icon image. The recommended icon size is 16x16 pixels.
Slider Knob Icon PathsliderKnobIconPathStringRelative path of the slider knob icon image in the Split Downtime Reason view.
Left Arrow Icon PathleftArrowIconPathStringRelative path of the left arrow icon image in the Split Downtime Reason view.
Right Arrow Icon PathrightArrowIconPathStringRelative path of the right arrow icon image in the Split Downtime Reason view.

 

Event Handlers

Event handlers provide the ability to add custom script when a user interacts with a component.

 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

PropertyDescription
.sourceThe component that fired this event.
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyNameThe name of the property that changed. NOTE: Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

 


 

Extension Functions

 configureCell
  • Description

Provides a chance to configure the contents of each cell.

  • Parameters

self - A reference to the component that is invoking this function.

value - The value in the dataset at this cell.

textValue - The text the table expects to display at this cell (may be overridden by including 'text' attribute in returned dictionary).

selected - A boolean indicating whether this cell is currently selected.

rowIndex - The index of the row in the underlying dataset.

colIndex - The index of the column in the underlying dataset.

colName - The name of the column in the underlying dataset.

rowView - The index of the row, as it appears in the table view (affected by sorting).

colView - The index of the column, as it appears in the table view (affected by column re-arranging and hiding).

  • Returns

Return a dictionary of name-value pairs with the desired attributes. Available attributes include: 'background', 'border', 'font', 'foreground', 'horizontalAlignment', 'iconPath', 'text', 'toolTipText', 'verticalAlignment'

You may also specify the attribute 'renderer', which is expected to be a javax.swing.JComponent which will be used to render the cell.

  • Scope

Client

Example
# This example will use the default row configuration settings defined in the initialize extension function:
ds = self.getData()
reason = ds.getValueAt(rowIndex, 'Reason')
if reason == "Unplanned Downtime":
   return {'background' : '#FF0000', 'foreground' : '#FFFFFF'}
else:    
   return self.getDefaultRowConfiguration(rowIndex)
 onColumnsCreate
  • Description

Called when columns are created in the table. Provides a chance to add custom columns to the table.

  • Parameters

self - A reference to the component that is invoking this function.

  • Returns

Returns a dictionary of custom column name-type pairs.

  • Scope

Client

 onRowAdd
  • Description

Called when a row is added in the table. Provides a chance to insert values to custom columns in the table.

  • Parameters

reason - Downtime reason of a row.

code - Downtime code of a row.

  • Returns

Returns a dictionary of custom column name-value pairs.

  • Scope

Client

 configureHeaderStyle
  • Description

Provides a chance to configure the style of each colummn header. Return a dictionary of name-value pairs with the desired attributes. Available attributes include: 'font', 'foreground', 'background', 'border', 'toolTipText'.

  • Parameters

self - A reference to the component that is invoking this fucntion.

colIndex - The index of the column in the underlying dataset.

colName - The name of the column in the underlying dataset.

  • Returns

Returns a dictionary of name-value pairs with the desired attributes.

  • Scope

Client

 initialize
  • Description

Called when the window containing this table is opened, or the template containing it is loaded. Provides a chance to initialize the table further, for example, setting the default row configuration.

  • Parameters

self - A reference to the component that is invoking this fucntion.

  • Returns

Nothing

  • Scope

Client

 loadIcon
  • Description

Provides a chance to change an icon. Based on the icon name parameter, return the image path to the icon to use in place of the default icon.

  • Parameters

self - A reference to the component that is invoking this function.

iconName - The name of the icon.

  • Returns

Nothing

  • Scope

Client

Example
# This example will return a path to a different image to replace the default delete image:
if iconName == 'remove':
	return 'Builtin/icons/24/delete2.png'

 


 

Custom Methods

Custom methods allow you to add your own component functions to a component that can be called through scripting. This is a useful and clean method of re-using script that is specific to the component (say you want to update a visual aspect of the component in the same way whether a user clicks on the component or a window property value changes). See Component Custom Methods in the Ignition Help Manual for more information.

 


 

Customizers

Table Customizer

Table Customizer manages the data entered into the OEE Downtime Table. It will allow you to modify the data which is stored inside the OEE Downtime Table. Thus the formatting and alignments are made easy.

A table customizer is available by right clicking the Downtime table in the designer and selecting "Customizers" -> "Table Customizer". It is similar to the table customizer in a standard Ignition table. Table Customizer shown below manages the data entered into the Downtime Table.

Column Configuration

Header - Provide a custom name to the column header.

Hide? - Hides the column.

Editable - Allows the editing of the cell pertaining to the column.

Sortable - To make a column filter the data on user's demand.

Sortable - Allows the user to sort the table according to the selected column.

Horiz Align - Aligns the contents of the column.

Vert Align - Aligns the contents of the column.

Wrap Text? - Data in the cell wraps to fit the column width. When you change the column width, data wrapping adjusts automatically.

Prefix - A custom text that proceeds the contents of each cell.

Suffix - A custom text that follows the contents of each cell.

Number Format - A format of the cell is the contents of the cell are number types.

Date Format -  Used if the contents of the cell are date types.

Boolean? - Changes the contents of the cell to reflect a 'check box' look and feel.

Custom Properties

The custom properties can be used to add user defined properties.

 

  • No labels