TimeSummary

Summarise the amount of time spent in different states.

Parameters

NameDefaultMeaning
insideThe word used to describe the amount of time spent inside the current timeframes
outsideThe word used to describe the time not within the current timeframes
splitbyThe attribute to split the times across
whereLimit the splitby to only certain values.

Description

This is most often used in performance, utilisation and OEE calculations, where you want to understand the total amount of time equipment has been active, available and running.

Using 'Inside'

If using inside, the total time spent in any time frame is added up and will be available as four attributes. If the value of inside was 'running', you'd get…

  • Running Seconds: xx
  • Running Percentage: xx
  • Not Running Seconds: xx
  • Not Running Percentage: xx

You can customise the name of 'Not Running' using the outside parameter. For example, you could have 'Stopped' instead of 'Not Running'.

Using 'splitby'

When using 'split by' instead, the totals are taken based on attributes of the frames.

For example, you might have the following time frames…

StartEndMode
10:00AM11:00AMOffline
11:00AM12:00AMOnline
12:00PM01:00PMError
01:00PM02:00PMError

If you chose to split this by mode, your results would be…

  • Offline Total & Percentage,
  • Online Total & Percentage,
  • Error Total & Percentage

Example

If the following frames are available…

StartEndMode
10:00AM11:00AMOffline
11:00AM12:00AMOnline
12:00PM01:00PMError
01:00PM02:00PMError
{
   "type": "timesummary",
   "splitby": "Mode"
}

The final results will be…

NameValue
StartTime10:00AM
EndTime02:00PM
Offline Seconds3600
Offline Percentage33%
Online Seconds3600
Online Percentage33%
Error Seconds3600
Error Percentage33%