Import and export items
Learn how to download item templates, export item configuration, import items from semicolon-separated CSV files, and resolve validation and import errors.
Use Import / Export items to download item configuration, prepare a bulk-edit template, and import multiple items into one instance from a CSV file.
This tool works with item configuration such as names, addresses, read settings, logging settings, templates, and Connector-specific fields. It does not import or export stored historical values.
Before you begin
- Open the destination instance and confirm that it uses the required Connector.
- Download the item template from the destination instance. Item fields differ between Connectors.
- Use a semicolon-separated CSV file. Comma-separated files are rejected.
- Export the current items before making a large bulk change.
- Check that the license has capacity for any new items.
Use the template or an item export from the same Connector version whenever possible. Do not copy a CSV between unrelated Connectors because their item columns and accepted values can differ.
Open the item import and export tools
- In the sidebar, expand Instances.
- Open All instances or the relevant instance category.
- Open the instance you want to work with.
- Open its items view.
- Select Import / Export items.
The dialog provides three actions:
| Action | What it does |
|---|---|
| Template | Downloads a semicolon-separated CSV template containing the item configuration columns for the selected Connector and instance. |
| Export all | Downloads all current item configuration rows for the selected instance. |
| Import items | Validates and imports item configuration rows from a semicolon-separated CSV file. |
Download an item template
- Open Import / Export items.
- Under Item template, select Template.
- Wait while the button displays Downloading....
- Confirm that Item template downloaded successfully. appears.
- Open the downloaded CSV file and keep the header row unchanged.
The fallback filename uses this format:
instance_name_item_template.csv
Use the template when creating items in bulk. Add one item per row below the header.
Export configured items
- Open Import / Export items.
- Under Export items, select Export all.
- Wait while the button displays Exporting....
- Confirm that Items exported successfully. appears.
- Store the downloaded CSV as a backup or use it as the starting point for bulk edits.
The fallback filename uses this format:
instance_name_items_export.csv
Export all exports the item configuration for the current instance. It does not export items from other instances.
Prepare the CSV file
Keep the file structure compatible with the selected Connector:
- Use the first row as the header.
- Keep the original column names and their order.
- Separate columns with a semicolon character:
; - Use one item per row.
- Keep the same number of columns in every row.
- Save the file with the
.csvextension. - Preserve values containing semicolons, quotation marks, or line breaks as correctly quoted CSV cells.
Spreadsheet applications can change the separator to a comma when saving. Check the saved file in a text editor and confirm that the header and data rows use semicolons.
A file containing only the header can pass the initial validation, but it can import zero items.
Import item configuration
- Open Import / Export items on the destination instance.
- Under Import items, select Import items.
- Choose the prepared
.csvfile. - Review the filename and any warning in the Import items confirmation.
- Select Import.
- Keep the dialog open while it displays Importing....
- Wait for All items imported to the instance.
- Review the item list and confirm that every expected row was applied.
After a successful import, the Edge Portal refreshes the instance, item list, and latest item values.
A success message confirms that the import request completed. Review any warning and compare the resulting item count with the CSV because invalid rows can be skipped for some Connectors.
Understand how imported rows are handled
The available columns and backend import behavior depend on the Connector. The exported items file from the destination is the safest basis for an update.
For the OPC UA Server Connector, the current Edge Portal applies these rules:
- An existing item is matched by UID first and then by name.
- A matching item is updated.
- A row with no matching item creates a new item.
- A row without an item name is skipped.
- A row whose number of columns does not match the header is skipped.
- The columns
id,device,last_error,mappings,mapping,postscript_error, andprescript_errorare ignored.
For OPC UA Server numeric fields, an empty or invalid numeric value becomes 0. Boolean fields accept 1, true, yes, or on as enabled. They accept 0, false, no, off, or an empty value as disabled.
Review numeric and Boolean cells before importing an OPC UA Server CSV. A typing error can be converted to 0 instead of stopping the import.
Verify imported items
- Compare the displayed item count with the number of data rows in the CSV.
- Search for several imported item names.
- Open a new item and confirm its address and Connector-specific parameters.
- Open an updated item and confirm that the intended fields changed.
- Check that enabled items receive new values or timestamps.
- Review active warnings and item event history.
- Confirm that the licensed item capacity has not been exceeded.
If an item is created but cannot communicate, correct it using the normal item editor or Setup view.
Do not confuse item configuration with data-value export
Import / Export items works with item definitions and settings. The separate Export data values action works with stored values.
| Tool | Content | Selection |
|---|---|---|
| Import / Export items | Item configuration rows | One instance |
| Export data values | Stored values and timestamps | Selected items and a date range |
Troubleshoot template and item export errors
| Message or condition | What to do |
|---|---|
| The item template is unavailable until a plugin is selected. | Open the tools from a complete instance whose Connector information has loaded. |
| The item template is unavailable until a device is selected. | Open the item view for a specific instance and try again. |
| Item export is unavailable until a plugin is selected. | Reload the instance and confirm that its Connector is installed and available. |
| Item export is unavailable until a device is selected. | Open a specific instance before exporting. |
| Choose both a plugin and device before downloading the item template. | Reload the instance item view and try again after its Connector and instance identifiers have loaded. |
| Choose both a plugin and device before downloading the item export. | Reload the instance item view and try again after its Connector and instance identifiers have loaded. |
| The server returned an empty item template. | Confirm that the Connector exposes an item structure. Update or reinstall the Connector if its item metadata is unavailable. |
| The server returned an empty item export. | Confirm that the instance contains items, refresh the item list, and try again. |
| Failed to download the item template. or Failed to download the item export. | Check the gateway connection and any more specific API message. Reload the page and retry. |
| The success message appears but no file is visible | Check the browser download list and download permissions, then try again. |
Troubleshoot item import errors
| Message or warning | What to do |
|---|---|
| Item import is unavailable until a plugin is selected. | Reload the instance and confirm that its Connector information has loaded. |
| Item import is unavailable until a device is selected. | Open the item view for a specific instance. |
| Choose a CSV file to import. | Select a file before starting the import. |
| Choose a valid .csv file to import items. | Use a file with the .csv extension or CSV content type. |
| The selected CSV file is empty. | Add the template header and at least one complete item row. |
This CSV looks comma-separated. Re-save it with semicolons (;) before importing.
|
Save or export the file as a semicolon-separated CSV. Excel and Google Sheets can change the delimiter to commas when saving. |
The CSV header does not appear to use semicolon (;) separators.
|
Start with the downloaded template or an exported items file. Keep the header row and its semicolon separators. |
| Only a header row was detected in the CSV preview. The backend may import zero item rows. | Add at least one complete item row below the header before continuing. |
| The CSV rows look comma-separated instead of semicolon-separated. | Export the file again with semicolons (;) before importing. |
| Double-check the delimiter before importing. This file contains more commas than semicolons in the header preview. | Confirm that semicolons separate the columns. Commas may still appear inside quoted text values. |
| Choose both a plugin and device before importing items. | Reload the item view for the destination instance and wait for its Connector and instance information to load. |
| Some columns are not supported by this import and were skipped automatically: [columns]. | Review the named columns. Configure those values after import if they are still required. |
| [number] row or rows were skipped because their column count did not match the CSV header. | Make sure every data row has the same number of semicolon-separated cells as the header. Also check quotes around values that contain semicolons or line breaks. |
| No items were imported. | Confirm that the file contains data rows, that every item has a name, and that each row has the same number of columns as the header. |
| Failed to import items. or Failed to import items. Please try again. | Read any more specific message returned by the API. Check the gateway connection, confirm that the Connector is available, and retry with an unmodified template. |
| The backend returned an unexpected import response. | Reload the page and retry. If the error continues, confirm that the Edge Portal, API, and Connector versions are compatible, then review the system logs. |
| The import completes but fewer items appear than expected | Review any skipped-row or unsupported-column warning. Compare the number of complete data rows with the item count, then correct and import the file again. |