View on GitHub

SHOP4CF Data Models

Documentation of FIWARE data models used in SHOP4CF

Alert

This model is based on FIWARE Alert.

This entity models an alert and could be used to send alerts related to (…) [specific categories of alerts]. The purpose of the model is to support the generation of notifications for a user or trigger other actions, based on such alerts.

An alert is generated by a specific situation. The main features of an alert is that it is not predictable and it is not a recurrent data. That means that an alert could be an accident (…).

The required attributes are: id, type, category, dateIssued, alertSource.

Example for maintenance alert for skid (car-body platform) no. 12345:

{
    "id": "urn:ngsi-ld:Alert:company-xyz:pred-maint-3x29md89",
    "type": "Alert",
    "category": {
        "type": "Property",
        "value": "predictiveMaintenance"
    },
    "subCategory": {
        "type": "Property",
        "value": "incorrectPaintingProcessInKTL"
    },
    "validTo": {
        "type": "Property",
        "value": {
            "@type": "DateTime",
            "@value": "2017-01-02T10:25:55.00Z"
        }
    },
    "description": {
        "type": "Property",
        "value": "Skid no. 12345 needs maintenance"
    },
    "location": {
        "type": "GeoProperty",
        "value": {
            "type": "Point",
            "coordinates": [-3.712247222222222, 40.423852777777775]
        }
    },
    "dateIssued": {
        "type": "Property",
        "value": {
            "@type": "DateTime",
            "@value": "2017-01-02T09:25:55.00Z"
        }
    },
    "alertSource": {
        "type": "Relationship",
        "object": "urn:ngsi-ld:Asset:company-xyz:skid-12345"
    },
    "source": {
        "type": "Property",
        "value": "PMADAI"
    },
    "validFrom": {
        "type": "Property",
        "value": {
            "@type": "DateTime",
            "@value": "2017-01-02T09:25:55.00Z"
        }
    },
    "severity": {
        "type": "Property",
        "value": "high"
    },
    "humanVerified": {
        "type": "Property",
        "value": false
    },
    "@context": [
        "https://smartdatamodels.org/context.jsonld"
    ]
}

Notes: