Configure the Schema Fields – Minimum Viable Schema
Last updated
Last updated
The minimum viable schema is detailed here:
The minimum viable schema contains:
· The DCH schema reference. Refer to the examples below for the reference.
· Point name. This is generally the point name as it is in the Gateway.
· Current Value. This is a number. Strings and enumerated values are not permitted, refer to other schemas that contain enumerated entries.
· Parent Name. This is optional but is required when multiple points with the same name are being uploaded to the same data source, e.g. power meter points. When the data stream is created in DCH the data stream name contains the parent folder name and point name, e.g. dsapi-faithful-adorable-tax-Clayton.ClaytonB000.B127Mech125.TotActEnergyExp
The format of this schema is:
{
"$schema": "http://csiro.au/dch/bms-json/schema-draft-07.json",
"point": {
"pointName": "CS.EC.OFF.AHU 02.HW VALVE",
"currentValue": 0,
"parentName": "AHU02"
}
Refer to Appendix A for the Niagara configuration of this schema.
Note that this minimum viable schema does not have an included timestamp. Adding a timestamp field is recommended as discussed in the previous section on timestamps.