KPI Data Model
At a high level, the KPI data model is made up of the following components:
• KPI scheduler (PTC.SCA.SCO.KPIScheduler)—Triggers the calculation of KPI elements and KPIs at scheduled intervals.
• KPI manager (PTC.SCA.SCO.DefaultKPIManager)—Holds the services and threshold definitions to manage and calculate the KPI elements and KPI values.
• KPI element thing shape (PTC.SCA.SCO.KPIElementThingShape)—Holds the services for calculating the KPI elements.
• A thing shape for each KPI (PTC.SCA.SCO.EffectivenessThingShape, PTC.SCA.SCO.AvailabilityThingShape, PTC.SCA.SCO.QualityRatioThingShape, PTC.SCA.SCO.OEEThingShape)—Holds the properties and services for each KPI. These thing shapes are implemented by the thing templates for equipment types which use the KPI functionality.
• Shift manager (PTC.SCA.SCO.DefaultShiftManager)—Holds the services to create and manage the shifts, shift schedules and sites that are used as the time periods for calculating KPIs and KPI elements.
• Data shapes for shift schedules (PTC.SCA.SCO.ShiftSchedule), shifts (PTC.SCA.SCO.Shift), and sites (PTC.SCA.SCO.Site)—Hold the field definitions necessary for the shift schedules, shifts, and sites created by the shift manager.
The current value for each KPI is stored on the individual equipment thing in ThingWorx. The KPI definition itself and historical data are stored in database tables.
By default, the scheduler triggers the KPI manager to calculate the KPI elements and KPI values every 5 minutes. KPI element and KPI calculations are also triggered by changes to relevant data. The calculation services retrieve the necessary information from properties on the individual equipment thing, perform the calculations, and set the current KPI values for each individual equipment thing.
You can configure or customize the KPI functionality in the following ways:
• Create your own KPI manager which implements the KPI manager thing template (
PTC.SCA.SCO.KPIManagerThingTemplate) and overriding its services.