Include levels of privacy of properties in their description

The privacy of the data contained in a property has been under discussion for the documentation of any property.

Now there is a first version on how to implement it.

The contribution manual has been updated for this possibility. See the specific slide about it.

Privacy clause: Privacy:’[high/medium/low]

Describes if the property has any kind of information related with personal data. Current options:

  • No clause: (default) this property does not contain personal data
  • Privacy:’high’: Those properties that refer to data on ideology, union affiliation, religion, beliefs, racial origin, health or sexual life.
  • Privacy:’medium’. Those properties related to the provision of financial solvency and credit services of people and those that contain definition of characteristics or personality and that allow evaluating certain aspects of personality or behavior of people.
  • Privacy:’low’.  Those properties that contains personal data different from the rest of types.

Example:

“refUserDevice” :{

“description”: “Property. Model:’http://schema.org/Text’. Privacy:’low’. An object representing the current device used by the User.”.

 

Instructions to be listed as a data model adopter of Smart Data Models

It has been updated the format of the list of adopters of the data models (formerly were CURRENT-ADOPTERS.md markdown files), now in it is rename into ADOPTERS.yaml based on this yaml template which allows an automatic processing. (Further announcements could be included in a future).

Further instructions in the page Data Models Adopters how to located in the menu option Data models -> Data Models Adopters How to

Improved the database of properties

The database for the searching on data models, properties and their descriptions has been expanded to allow filtering also by :

  • NGSI type (one of Property, Relationship or Geoproperty)
  • data type (string, number, boolean, array, object, etc)

Additionally, it has been updated containing more than 11.000 items

Accessible from the front page in this widget (Structured check)

You can export the results

Common Information Model (CIM) specified by the IEC61970 standard data models

There is a new subject focused on the data models, dataModel.EnergyCIM,  of the Common Information Model (CIM) specified by the IEC61970. It is inside the SmartEnergy domain.

Due to a large number of data models (403), the examples will be provided later. it’s in the process of generating the README.md for all of them.

Additionally, some of the properties could have some mismatch that it will be fixed as soon as detected (the lack of examples).

Thanks to the RWTH university for its contribution.

New data model for battery. StorageBattery

There is a new data model StorageBattery

The storage battery data model is intended to describe the technical characteristics of the battery and the charging and discharging conditions of the energy. The charging functionalities apply from a power source which can be an ‘on-board system, solar panel, wind turbine, generator, power supply’. Hydraulic sources are not included in this version. The discharge functions apply to all types of the system requiring energy consumption from a storage battery. *Remark* This Data Model can be used directly as the main entity to describe the device *Battery Storage* or as a sub-entity of the Data Model *DEVICE* using a reference by the *refDevice* attribute.

Specifications in languages in the readme of the data models

Now you can see the links to the specification in two languages, Spanish y French in the README.md of every data models. German and Japanese are in the queue.

See here an example

 

All specifications updated

All the specifications (the text descriptions of the data model located in the /doc directory of each daat model) for the different domains and languages (currently French and Spanish besides English) have been updated to the new format. See an example in Spanish and French.

All of them are generated automatically from the json schema (which is the unique source of truth for the data model)

The contribution manual explains further details.

Raise an issue for any point you find in the new format.

 

 

Check a schema validates a payload

If you want to check if a schema validates a payload  through this API call

Call: https://smartdatamodels.org/extra/validate_payload.php

Parameters: (Mandatories)

  • payloadUrl: The url of the payload in RAW version
  • schemaUrl: The link to the RAW version of the json schema (see example)

Example: https://smartdatamodels.org/extra/validate_payload.php?payloadUrl=https://raw.githubusercontent.com/smart-data-models/dataModel.Battery/master/Battery/examples/example.json&schemaUrl=https://raw.githubusercontent.com/smart-data-models/dataModel.Battery/master/Battery/schema.json

Output: A json payload with these properties

  • result: Boolean. if the schema validates the payload.
  • time: time stamp in ISO 8601 (CET) of the validation
  • payloadUrl: The url of the payload in RAW version submitted
  • schemaUrl: The link to the RAW version of the json schema submitted

on error

  • cause: The description of the cause for the rejection to the validation

updated the contribution manual

The contribution manual (link in the upper menu of main page) is updated due to the change in the approach for documenting the data models.

Main changes:

  • Properties’ definitions are now included as an attribute in the json schema
  • The specification is generated automatically based on the json schema
  • Json schema has to pass a test to be approved.

See the rest of changes in the link