Category: Smart Energy domain

This a general review of the contributions’ manual with these changes:

• Recommendation how to document a property that is an object referencing to a shared schema
• Change order in the elements (schema recommendation is the most demanded documentation and it is being placed at the beginning)
• Minor reviews, contact point, etc.

Located in the upper menu of the site.

It has been updated the database for searching properties, two main improvements:

1.  Performance (now it is a database query instead of the former static file)
2.  The reference model of the property
3.  The format (uri, date-time, etc) for string properties.

This is an alpha version (so you can expect errors and not being complete). Use it at your own risk. Please report errors and suggestions at info@smartdatamodels.org

Call: https://smartdatamodels.org/extra/ngsi-ld_generator.php

Parameters: (Mandatories)

• schemaUrl: The link to the RAW version of the json schema (see example)
• email: your email

Example: https://smartdatamodels.org/extra/ngsi-ld_generator.php?schemaUrl=https://raw.githubusercontent.com/smart-data-models/dataModel.Streetlighting/f56f5a7933ab05d7fce1d5adc0847f25a099cdb4/StreetlightModel/schema.json&email=alberto.abella@fiware.org

Use any data model from Smart Data Models initiative and paste it into the form. Then you’ll get a page with a random payload compliant with the data model. Refresh for more.

You can also use this form

The context.jsonld for smart data models has been updated to meet json ld requirements. Now they are implementing geojson requirements.
It affects the terms of bbox and coordinates. It could impact those elements having a geoproperty (most of the data models).

NEW VERSION!!

This post became obsolete, go for the new master sheet

This is a resource, especially for those who have limited knowledge of JSON schema.

If you want to create a basic version of a data model (not all JSON schema is implemented), you can use a copy of this spreadsheet as template. This spreadsheet is always available at https://bit.ly/schema_sheet short name.

You need to fill the blue cells for these parameters:

• Subject: Official Subject where this data model should be allocated. (Check the official list)
• DataModel: Official data model name (Only one word i.e. WeatherForecast, no _).
• Title: use to be the name data model name with spaces. (i.e. Weather Forecast)
• Global Description: General text description of the data model. (2 lines is nice)
• Property name: Exactly this, the name of the property. Use camelCase. It would be good to check here whether this property already exists (you can copy and paste). Use those you need and leave one empty after those you filled. Properties below an empty property name are ignored.
• NGSI type: (Property, Relationship or Geoproperty)
• Data type: Type of data in the property. (array and object are not fully implemented)
• Other restrictions: If you are unfamiliar with JSON schema leave it empty.
• Description: Official description of the property.

Once you’ve got the schema, grab some examples (It is always good to review the contribution manual) and you can make a Pull Request on any of the subjects of any domain in Github. Or just use this form.

NOTE 1: The first option will be attended quicker than the second.

NOTE 2: Do not write out of the blue cells (it will be ignored). And do not add or remove cells. The converter script looks for these precise locations in blue.

NOTE 3: Your spreadsheet has to be made public. (anyone with the link), otherwise, the script will not be able to retrieve your data.

Call:

Parameters: (Mandatories)

• sheetUrl: The url of the spreadsheet (if not it takes default spreadsheet in the menu)

Output: A json schema based on the properties defined in the database. This is an alpha version so errors are not managed.

In case you are not an expert for creating a JSON schema (one of the elements of a data model)
On this page, you have a spreadsheet for helping with the first steps.

1.- Fill the spreadsheet with the names of the properties for your model

2.- fill the NGSI type (Property, Relationship or Geoproperty)

3.- In case of property, fill the data type (array and object types are currently not completely supported)

4.- Fill in the description

5.- Click the button, the page will reload

6.- voila! you have your json schema below the spreadsheet, just copy and paste into your favourite editor.

The python code for it is also made public in the utils directory in the data models repo.