GetOEEValue Method
- Last UpdatedNov 06, 2025
- 1 minute read
The GetOEEValue() method retrieves the current OEE value for the specified KPI. The KPI can be specified using duration, time unit, start time, and end time filter items.
'Declaration
Public Shared Function GetOEEValue( _
ByVal entID As Integer, _
ByVal kpiType As KPIType, _
ByVal filterType As FilterType, _
ByVal filterDuration As Nullable(Of Integer), _
ByVal filterTimeUnit As FilterTimeUnit, _
ByVal filterStartTime As Nullable(Of Integer), _
ByVal filterEndTime As Nullable(Of Integer) _
) As Double
public static double GetOEEValue(
int entID,
KPIType kpiType,
FilterType filterType,
Nullable<int> filterDuration,
FilterTimeUnit filterTimeUnit,
Nullable<int> filterStartTime,
Nullable<int> filterEndTime
)
Parameters
- entID
- Required. Hold the ID of the entity whose OEE value is being retrieved.
- kpiType
- Required. Holds the KPI Type: OEE, QUALITY, AVAILABILITY, or PERFORMANCE.
- filterType
- Required. Holds the FilterType property, which specifies which filter to use, including a custom filter.
- filterDuration
- Optional. Holds the FilterDuration property, which allows the user to specify the N in the Last N Hours.
- filterTimeUnit
- Required. Holds the FilterTimeUnit property, which allows the user to specify the time unit for a custom filter.
- filterStartTime
- Optional. Holds the FilterStartTime property, which specifies the start of the filter period relative to now.
- filterEndTime
- Optional. Holds the FilterEndTime property, which specifies the end of the filter period relative to now.
Return Value
Returns the current OEE value for the specified KPI type.