Documentation Index

Fetch the complete documentation index at: https://learn.servitly.com/llms.txt

Use this file to discover all available pages before exploring further.

Product Registration

Prev Next

The Manufacturer can register products by providing the Product Model and the descriptive data (e.g., Serial Number,  Properties).
This operation can be done one product at a time, or in bulk through a CSV file. Both options are allowed from the API or from the UI by using the register-things-widget.

The following information must be provided during the product registration:

  • Product Model: the name of the Product Model associated with the product.

  • Serial Number: the number used by the manufacturer to identify the product.

Optional information:

  • Name: the name associated with the product (e.g., Boiler Auriga 100).

  • Properties: the additional properties (e.g,. properties.size).

This is an example of CSV, which can be used in bulk product registration.

serialNumber,prodcutModelName
BO-123,Boiler Auriga 100

This is an example of CSV with additional properties

name,serialNumber,prodcutModelName,properties.power
Auriga 100,BO-123,Boiler Auriga 100,24kw

You can leverage the DPS API to register things; for more details, refer to the Register Things  endpoint.

Things and Sub Things

This is an example of a CSV with a composite thing (root thing and sub-thing) registration.

serialNumber,name,productModelName,parentThingSerialNumber,productModelPartName
M-123,M-123,M-ABC,,
M-123_UNIT_1,Unit 1,,M-123,SUB-UNIT
M-123_UNIT_2,Unit 2,,M-123,SUB-UNIT
M-123_MOD_A,Module A,,M-123_UNIT_1,UNIT-MODULE
M-123_MOD_B,Module B,,M-123_UNIT_2,UNIT-MODULE
M-123_MOD_C,Module C,,M-123_UNIT_3,UNIT-MODULE

To activate a composite thing, it is sufficient to activate the root thing, and all recursive sub-things are also activated.
In case the Things Inventory Management is still by Thing Definition, instead of the name of the product model, you should provide the thingDefinitionName.

name,serialNumber,thingDefinitionName,properties.power
Auriga 100,BO-123,Boiler Auriga 100,24kw