This feature allows you to modify properties in bulk (e.g. add all battery levels of LoRaWAN equipment) in a single operation, without going through the console interface using xlsx files.
How to proceed ?
This module is accessible via the console Configuration Tab / Actions / Bulk edit configuration :
Select the type of data you want to export based the content you want to update. You can choose between:
- Equipment
- Properties
- Redirected Properties
Then click “Export File”.
Note that all equipment/properties of the Box are exported. If you want to make changes to specific items, you will need to apply the filter/search functions in Excel.
1) Export file contents
Once the files are exported, they are available in the standard download directory. You can access them through the System File Explorer. Their names are based on the following convention :
Equipment |
Properties |
Redirected properties (gateway) |
export-bulk-equipment.xlsx
|
export-bulk-properties.xlsx |
export-bulk-redirected-properties.xlsx |
Once downloaded, you can open them with excel and make the changes you want.
Be careful however to these restrictions :
|
- Some ID columns must not be changed (in order to successfully complete the import process). The details are explained in the paragraphs below.
- The xlsx format must be preserved
- When multiple worksheets are present in the file, only one is intended to be edited. The others contain libraries such as the unit list.
|
1.1) Equipment file (export-bulk-equipment.xlsx)
Here are the columns of the Equipment file. The first column Equipment Id is very important and should not be changed. It will be used as the reference in the import process.
You can edit and change all the green columns marked as RW (Read / Write)
|
Some columns are read-only, meaning that there are in the export for information only and if you change the value in the file, it will not be considered during the import. |
|
Other columns (read write) can be modified to change your configuration. |
|
To bulk delete equipment, please return to the console, select multiple equipment and choose the "Delete" option under "Actions". If you delete rows in the Excel file, it will not delete the equipment. |
Here is the detail information about each column in the excel file :
Column name |
Description |
Value type |
Editable
value
|
Example |
Equipment ID |
Unique identifier of the equipment in database. Do not change this value.
|
Alphanumeric ID |
No |
Nv3tDsx4J7F2e4cb |
Equipment Name |
Name of the equipment |
text |
Yes |
My LoRaWAN sensor |
Equipment Description |
Description of the equipment |
text |
Yes |
1st floor electricity meter |
Equipment Protocol |
Description of the equipment |
text |
No
|
LORAWAN_V1_0 |
Equipment Synchronized |
Indicates if the equipment is synchronized with the box. |
"- CURRENT if the equipment is synchronized with the box, - DRAFT otherwise."
|
No
|
CURRENT |
Equipment Group |
Name of group to which the piece of equipment belongs. If it does not exist, a new group will be created. |
text |
Yes
|
1st floor |
DevEUI |
Device ID. For LoRaWAN equipment only. |
64-bit value in hexadecimal |
Yes
|
1122AABBCCDDEEFF |
AppEUI |
Application ID. For LoRaWAN equipment only. |
64-bit value in hexadecimal |
Yes
|
1122AABBCCDDEEFF |
Application Key |
Root key for the device. For LoRaWAN equipment only. |
128-bit value in hexadecimal |
Yes
|
1122AABBCCDDEEFF
1122AABBCCDDEEFF
|
1.2) Equipement properties (export-bulk-properties.xlsx)
Two worksheets are present in this file, Properties and UNITS.
The UNITS worksheet shoud not be modified, it contains a library for the Property Unit field (Properties worksheet).
The Properties worksheet contains the columns below. The first column Property Id is very important and should not be changed. It will be used as the reference in the import process.
You can edit and change all the green columns marked as RW.
Here is the detail information about each column in the excel file :
Column name |
Description |
Value type |
Editable
value
|
Example |
Property ID |
Unique identifier of the property in database. Do not change this value.
|
Alphanumeric ID |
No |
Nv3tDsx4J7F2e4cb |
Property Equipment |
Name of equipment to which property belongs |
text |
No
|
My LoRaWAN sensor |
Property Name |
Name of the property |
text |
Yes
|
Consumption |
Property Description |
Description of the property |
text |
Yes
|
Track total amount of electrical energy consumed |
Property Slug |
URL-friendly identifier |
text |
Yes
|
nv3tdsx4j7f2e4cb-frame-counter-rb97effckf |
Property Access Type |
"Indicates if the property is read and/or write or if it is local (not sent to the cloud). You can choose the appropriate value using the drop-down list in the cell."
|
"drop-down list : - REMOTE_READ_ONLY - REMOTE_WRITE_ONLY - REMOTE_READ_WRITE - LOCAL"
|
Yes |
REMOTE_READ_ONLY |
Property Interval |
"The number of seconds between two polls of data. This is used by the box when reading data from the equipment. Minimum is 600 for REMOTE properties and 60 for LOCAL."
|
integer |
Yes |
600 |
Property Unit |
"The engineering unit of the property. Choose the correct value using the drop-down list in the cell."
|
drop-down list |
Yes |
kWH |
Property Scaling A |
If scaling is apply for this property, a value of the formula : a*x + b |
decimal |
Yes |
0.1 |
Property Scaling B |
If scaling is apply for this property, b value of the formula : a*x + b |
decimal |
Yes |
5 |
Redirect to |
If the property redirects to a gateway, name of the redirected property |
text |
No |
Redirected property name |
Property Synchronized |
Indicates if the property is synchronized with the box. |
"- CURRENT if the equipment is synchronized with the box, - DRAFT otherwise."
|
No |
DRAFT |
Property Activation Status |
"Indicates if the property is activated or not. Choose the correct value using the drop-down list in the cell. Use this field to remove or disable multiple properties at once from your configuration."
|
"drop-down list : - ENABLE - DISABLE"
|
Yes |
ENABLE |
equipmentCodecId |
Internal information. Do not change this value. |
|
No |
|
propertyCodecId |
Internal information. Do not change this value. |
|
No |
|
equipmentId |
Internal information. Do not change this value. |
|
No |
|
1.3) Redirected properties (gateway) (export-bulk-redirected-properties.xlsx)
Three worksheets are present in this file, Redirected properties, UNITS and BACnetObjectTypes :
UNITS and BACnetObjectTypes worksheets shoud not be modified, they contain libraries for the Redirected properties worksheet.
The Redirected properties worksheet contains the columns below. The first column Redirected property Id is very important and should not be changed. It will be used as the reference in the import process.
You can edit and change all the green columns marked as RW.
Here is the detail information about each column in the excel file :
Column name |
Description |
Value type |
Editable
value
|
Example |
Redirected property ID |
Unique identifier of the redirected property in database. Do not change this value.
|
Alphanumeric ID |
No |
Nv3tDsx4J7F2e4cb |
Redirected property Gateway |
Name of gateway to which property belongs |
text |
No |
MQTT Broker |
Redirected property Name |
Name of the redirected property |
text |
Yes |
Sensor temperature
|
Redirected property Description |
Description of the redirected property |
text |
Yes
|
Data point of the last read temperature |
Redirected property Slug |
"URL-friendly identifier. Different than the MQTT slug, see below."
|
text |
Yes |
sgs2wiyjzk-wtgybegnvj1nvjpg-sensor-temperature |
Redirected property Access Type |
"Indicates if the redirected property is read and/or write or if it is local (not sent to the cloud). You can choose the appropriate value using the drop-down list in the cell."
|
"drop-down list : - REMOTE_READ_ONLY - REMOTE_WRITE_ONLY - REMOTE_READ_WRITE - LOCAL"
|
Yes
|
REMOTE_READ_ONLY |
Redirected property From |
Name of the property from which it is redirected |
text
|
No
|
Sensor temperature (my equipment) |
Redirected property To |
Name of the property to which it is redirected |
text
|
No
|
Target temperature |
Redirected property Unit |
"The engineering unit of the property. Choose the correct value using the drop-down list in the cell."
|
drop-down list |
Yes |
°C |
Redirected property Synchronized |
Indicates if the property is synchronized with the box. |
"- CURRENT if the equipment is synchronized with the box, - DRAFT otherwise."
|
No |
DRAFT |
Redirected property Register Address |
Register address of the property. For Modbus gateways only. |
integer |
Yes |
66 |
Redirected property Register Type |
"Type of register to use. For Modbus gateways only. Choose the correct value using the drop-down list in the cell."
|
"drop-down list : - INPUT_DISCRETE - INPUT_REGISTER - HOLDING_REGISTER - COIL"
|
Yes |
INPUT_REGISTER |
Redirected property Data Format |
"Format of the data. For Modbus gateways only. Choose the correct value using the drop-down list in the cell."
|
drop-down list |
Yes |
int32_abcd |
Redirected property Raw Register |
Raw register to use. For Modbus gateways only. |
integer |
Yes |
60 |
Redirected property Object Type |
"Type of the object. For BACnet gateways only. Choose the correct value using the drop-down list in the cell."
|
drop-down list |
Yes |
OBJ_INTEGER_VALUE |
Redirected property Object Instance |
The object instance ID. For BACnet gateways only. |
integer |
Yes |
2 |
Redirected property MQTT Slug |
Slug used as identifier of the property value on MQTT. For MQTT gateways only |
text |
Yes |
adeunis-arf8275a-comfort-humidity-3hq11strs1 |
2) Reimport data
Once the data have been modified according to your wishes (step 2 on the interface), you can re-import the .xlsx.
Return to the console and proceed to step 3. You can drag and drop your file into the grey area or Choose a file with the dedicated button, and navigate with the file explorer.
And finally click on Update Configuration.
3) Examples
3.1) Move some equipments to a new group "Second floor"
The first step is to export the file via the Equipement button, and then change the Equipement group in the xlsx file :
Save and reimport the file :
The equipements have been moved to the Second floor as requested :
Don’t forget to save the configuration :
3.2) Adding the battery property to all the LoRaWAN devices
The first step is to export the file via the Equipment properties button, and then change the Property Activation Status (DISABLE -> ENABLE) in the xlsx file :
Save and reimport the file.
The properties "Battery Level" are enabled in the console configuration for all equipments modified in the xlsx file.
If you need any additional information, please contact us here.