The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
Skip to content

Structure

Work events within Senseye are composed of the following required attributes:

  • Timestamp: the date, time and time zone that the work took place
  • Message: A free text description of the work undertaken
  • Asset ID: Either the Senseye or External ID of the asset the work was performed on
  • Is Routine: Whether the event was routine or non-routine
  • Work Activity: The type of work undertaken

In addition to these required attributes, the following optional attribute can be provided:

  • Failure Mode: Identifies the failure encountered on the asset

Each will be described in more detail in the following sections.

Timestamp

The eventTime attribute should identify when the work was completed. This allows Senseye to learn how the failure evolved to the point of intervention and implies that any changes in data may be related to the recent work on the asset.

Ideally the date and time provided should be as close to the work being completed as possible. If an accurate timestamp is not available, the application prefers timestamps which are known to be after the work being completed, rather than before.

The timestamp should include date, time and time zone, see the timestamp documentation for more information on the required format.

Message

The message is a free text description which explains the work. It is shown within the application and often used as contextual information when exploring cases and root causes.

Asset ID

The asset which the work was performed on can be identified by either its Senseye ID or an External ID. Typically the External ID used in this case would be the ID of the asset within your maintenance system - you can read more about configuring and using External IDs here.

Is Routine

This boolean attribute identifies whether the work was planned or not. It is used in reporting to allow insight to be gained from your maintenance records.

Work Activity

Work activity explains what work was undertaken. The values are codified within Senseye, they rarely change and are common across all assets. The current list is:

NameID
Visual Inspectionvisualinspection
Minor Maintenanceminormaint
ReconfigurationprogramChange
Replacementreplacement
Major Maintenancemajormaint
Repairrepair

When interacting with the API, the ID of the work activity should be used.

Getting the latest list...

In most cases, we recommend hard coding the above list into your integration logic, but if required, you can gather the latest list from our GraphQL API. The following query uses the workActivities query on an asset to gather the latest list of work activities:

query
{
    assetByExternalID(id: "external-id-for-asset") {
        workActivities {
            id
            name
        }
    }
}

If you wish to use the Senseye asset ID, rather than an External ID, replace assetByExternalID with asset.

Failure Mode

Failure mode explains what went wrong. It is not required, but by providing this Senseye can learn more about your assets and their failures, resulting in better diagnostics and prognostics. The values are codified within Senseye, they change infrequently and are common across all assets. The current list is:

NameID
Abnormal noiseMaPS:FAILURE_MODE<Abnormal noise>
Abnormal wearMaPS:FAILURE_MODE<Abnormal wear>
Blocked/Plugged/ChokedMaPS:FAILURE_MODE<Blocked/Plugged/Choked>
ContaminatedMaPS:FAILURE_MODE<Contaminated>
Control malfunctionMaPS:FAILURE_MODE<Control malfunction>
CorrodedMaPS:FAILURE_MODE<Corroded>
Current IncorrectMaPS:FAILURE_MODE<Current Incorrect>
DamagedMaPS:FAILURE_MODE<Damaged>
Excessive wearMaPS:FAILURE_MODE<Excessive wear>
Fails test/checkMaPS:FAILURE_MODE<Fails test/check>
Fitted incorrectlyMaPS:FAILURE_MODE<Fitted incorrectly>
In/output incorrectMaPS:FAILURE_MODE<In/output incorrect>
Incomplete fillMaPS:FAILURE_MODE<Incomplete fill>
LeakingMaPS:FAILURE_MODE<Leaking>
Level incorrectMaPS:FAILURE_MODE<Level incorrect>
LooseMaPS:FAILURE_MODE<Loose>
MisalignedMaPS:FAILURE_MODE<Misaligned>
No fault foundMaPS:FAILURE_MODE<No fault found>
No rotationMaPS:FAILURE_MODE<No rotation>
Open CircuitMaPS:FAILURE_MODE<Open Circuit>
OtherMaPS:FAILURE_MODE<Other>
Out of adjustmentMaPS:FAILURE_MODE<Out of adjustment>
Out of BalanceMaPS:FAILURE_MODE<Out of Balance>
OverheatingMaPS:FAILURE_MODE<Overheating>
OverstressedMaPS:FAILURE_MODE<Overstressed>
Pressure incorrectMaPS:FAILURE_MODE<Pressure incorrect>
Replacement (Obsolete)MaPS:FAILURE_MODE<Replacement (Obsolete)>
RobbedMaPS:FAILURE_MODE<Robbed>
SeizedMaPS:FAILURE_MODE<Seized>
Sensor MalfunctionMaPS:FAILURE_MODE<Sensor Malfunction>
Short CircuitMaPS:FAILURE_MODE<Short Circuit>
Slow to operateMaPS:FAILURE_MODE<Slow to operate>
Temperature incorrectMaPS:FAILURE_MODE<Temperature incorrect>
VibrationMaPS:FAILURE_MODE<Vibration>
Voltage IncorrectMaPS:FAILURE_MODE<Voltage Incorrect>
Getting the latest list...

In most cases, we recommend hard coding the above list into your integration logic, but if required, you can gather the latest list from our GraphQL API. The following query uses the failureModes query on an asset to gather the latest list of failure modes:

query
{
    assetByExternalID(id: "external-id-for-asset") {
        failureModes {
            id
            name
        }
    }
}

If you wish to use the Senseye asset ID, rather than an External ID, replace assetByExternalID with asset.