Structure of the CSV import file
To be able to correctly import devices and machines into the device portal, the CSV file for the import must satisfy the following boundary parameters:
-
Formatting:
-
File extension.csv
-
Semicolon used as a separator between columns
-
Encoding: UTF-8 (with Excel, save as CSV UTF-8)
-
Maximum file size 5MB
-
-
Content:
-
Maximum 1000 rows
-
Maximum of 255 characters per value
-
The "device_communication_id" column must be present for devices communicating with the Device Portal
-
Characters permitted for device_communication_id: A-Z a-z 0-9 - _. ::
-
Characters permitted for the other values: A-Z a-z 0-9 ä Ä ö Ö ü Ü ß ? + - _. : / ( ) * = # %
-
Date format: YYYY-MM-DD, example: 2021-08-21
-
Time stamp format: ISO 8601 format (example: 2023-12-03T10:15:30Z)
-
Country format: Two-letter ISO 3166 country code (example: DE for Germany, FR for France…)
-
-
The following columns must be filled:
-
To create a new machine: machine_name
-
To create a new device: both device_type and device_name
-
Insert new devices
The CSV file may contain the following columns with appropriate entries:
| Column name | Description |
|---|---|
device_type (mandatory) |
Valid device type |
device_name (mandatory) |
Device name that appears in the Machine Overview view and can be searched for in the Device Portal. |
device_description |
Device description |
device_communication_id |
The Communication ID is mandatory for devices that communicate with the Device Portal. Each device type has its defined format — contact support if necessary. |
device_categories_without_attribute |
List of device categories, without set attributes. Each device category must be separated by #. |
DEVICE$serialNumber |
Serial Number attribute from the device category. |
DEVICE$partNumber |
Part Number attribute from the device category. |
DEVICE$partNumberCode |
Part Number Code attribute from the device category. |
DEVICE$manufacturingOrder |
Manufacturing Order attribute from the device category. |
DEVICE$manufacturingDate |
Manufacturing Date attribute from the device category. Format: YYYY-MM-DD |
device_topology_reference |
To create a device hierarchy, you must specify an ID here for the hierarchy reference for each device. The ID must be unique within the CSV file. |
device_topology_parent |
Reference ID of the device to be configured as a parent element in the hierarchy. The parent element must be created above the child elements/devices. |
To add more attributes:
If the device type has different or more attributes than those listed, additional columns can be added in the CSV file using the format CATEGORY_NAME$attribute_name.
For example, MOBILE$imei can be used to set the value of the imei attribute from the MOBILE category.
Example:
device_ |
device_ |
device_ |
device_cate |
DEVICE |
DEVICE$ |
MOBIL |
device_ |
device_ |
Control (EC) |
My first |
Created |
ADMINISTRATION# |
123456 |
2021-08-27 |
87945678 |
ABC123 |
|
Drive (EC) |
My first |
Created |
234567 |
2021-08-28 |
DEF321 |
ABC123 |
||
Motor (EC) |
My motor |
Created |
DIAGNOSIS#TEMPERATURE |
345678 |
2021-09-22 |
85546754 |
DEF321 |
|
Drive (EC) |
My |
Created |
456789 |
2021-08-31 |
ABC123 |
The hierarchy is saved as follows
__ : My first control
-
__ : My first drive
-
__ : My motor
-
-
__ : My second drive
|
Topology information is not currently visible in the web interface but can be saved for future applications to avoid the need for updates. |
Insert new machines
The CSV file may contain the following columns with appropriate entries:
|
The machine_id column must not be used for new machines, only to link existing machines to new devices. |
| Column name | Description |
|---|---|
machine_name (mandatory) |
The name appears in the Machine Overview view and can be used to browse the list. |
machine_description |
Description of the machine |
machine_type |
The machine type is displayed in the Machine Overview view and can be used to browse the list. |
machine_number |
Machine identifier in the system |
machine_control_system |
Machine control system example: Control plus |
machine_software_version |
Version of the machine software |
machine_manufacturing_date |
Manufacturing date of the machine: YYYY-MM-DD |
machine_sop_date |
Start of production: YYYY-MM-DD |
machine_topology |
Elements above the machine, separated by "#": Stuttgart#Plant 1#Building XYZ#Production Line A The information is not currently visible in the web interface but can be saved for future applications to avoid the need for updates. |
user_company_id |
ID of the company used by the machine. See below how to reuse an existing company. |
user_company_name |
Name of the company used by the machine |
user_company_country |
Country of the company used by the machine. Two-letter ISO 3166 country code (example: DE for Germany, FR for France…) |
user_company_zip |
ZIP code of the company used by the machine. |
user_company_city |
City of the company used by the machine. |
user_company_street |
Street of the company used by the machine. |
manufacturer_company_id |
ID of the machine manufacturer. See below how to reuse an existing company. |
manufacturer_company_name |
Name of the machine manufacturer |
manufacturer_company_country |
Country of the machine manufacturer. Two-letter ISO 3166 country code (example: DE for Germany, FR for France…) |
manufacturer_company_zip |
ZIP code of the machine manufacturer |
manufacturer_company_city |
City of the machine manufacturer |
manufacturer_company_street |
Machine manufacturer’s street |
If you want to specify the manufacturer or user of a new machine, there are two options:
Option 1 — The company already exists in the tenant
Fill in only the user_company_id or manufacturer_company_id column with the company ID.
The company ID is located in the Device Portal in the Machine Overview view in the extended machine information.
Example:
machine_name |
user |
user |
user |
user |
user |
user |
New machine 1 |
465546132 |
|||||
New machine 2 |
465546132 |
Option 2 — The company does not exist yet and must be created
Complete all the columns that are relevant for the machine manufacturer/user information.
If the machine manufacturer/user has several new machines, only the company ID must be repeated.
Example:
machine |
manufacturer |
manufacturer |
manufacturer |
manufacturer |
manufacturer |
manufacturer |
New machine 1 |
48846543 |
Robert Bosch GmbH |
Germany |
70839 |
Gerlingen- |
Robert-Bosch- |
New machine 2 |
48846543 |
|||||
New machine 3 |
48846543 |
Add new devices to a new machine
To create a new machine that is linked to new devices, the CSV file must be created as follows:
-
One line per new machine
-
One line per new device
-
The name of the machine to be linked must be entered in the machine_name column in each device row.
Example:
| machine_name | machine_type | manufacturer_company_id | device_type | device_name |
|---|---|---|---|---|
New machine 1 |
Injection molding |
48846543 |
||
New machine 1 |
Control (EC) |
Control 1 |
||
New machine 1 |
Control (EC) |
Control 2 |
||
New machine 2 |
Press |
48846543 |
||
New machine 2 |
Control (EC) |
My control |
||
New machine 2 |
Drive (EC) |
My first drive |
||
New machine 2 |
Drive (EC) |
My second drive |
||
New machine 3 |
Crane |
48846543 |
||
New machine 3 |
Drive (EC) |
Drive 2 |
||
New machine 3 |
Accessory (EC) |
Accessory 1 |
Add new devices to an existing machine
To add a new device to an existing machine, the machine ID of the corresponding machine must be entered for each device in the machine_id column.
The machine ID is located in the Device Portal in the Machine Overview view in the extended machine information.
Example:
| machine_id | device_type | device_name |
|---|---|---|
w7Yc4GU7EeulAu7uCv8QXw |
Control (EC) |
My first control |
w7Yc4GU7EeulAu7uCv8QXw |
Drive (EC) |
My first drive |
w7Yc4GU7EeulAu7uCv8QXw |
Accessory (EC) |
My first accessory |