docs-v2/content/flux/v0/stdlib/experimental/oee/apq.md

title	description	menu	weight
oee.APQ() function	`oee.APQ()` computes availability, performance, quality (APQ) and overall equipment effectiveness (OEE) in producing parts.	flux_v0_ref name parent identifier oee.APQ experimental/oee experimental/oee/APQ	201

oee.APQ() computes availability, performance, quality (APQ) and overall equipment effectiveness (OEE) in producing parts.

Provide the required input schema to ensure this function successfully calculates APQ and OEE.

Required input schema

Input tables must include the following columns:

• _stop: Right time boundary timestamp (typically assigned by range() or window()).
• _time: Timestamp of the production event.
• state: String that represents start or stop events or the production state.
• partCount: Cumulative total of parts produced.
• badCount: Cumulative total of parts that do not meet quality standards.

Output schema

For each input table, oee.APQ outputs a table with a single row that includes the following columns:

• _time: Timestamp associated with the APQ calculation.
• availability: Ratio of time production was in a running state.
• oee: Overall equipment effectiveness.
• performance: Ratio of production efficiency.
• quality: Ratio of production quality.
• runTime: Total nanoseconds spent in the running state.

Function type signature

(
    <-tables: stream[D],
    idealCycleTime: A,
    plannedTime: B,
    runningState: C,
) => stream[{
    E with
    runTime: G,
    quality: float,
    performance: float,
    oee: float,
    availability: float,
    _time: F,
    _stop: F,
}] where C: Equatable, D: Record

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

runningState

({{< req >}}) State value that represents a running state.

plannedTime

({{< req >}}) Total time that equipment is expected to produce parts.

idealCycleTime

({{< req >}}) Ideal minimum time to produce one part.

tables

Input data. Default is piped-forward data (<-).