Export and import configurations

Learn how to export and import Edge Portal configurations, understand what is merged, updated, skipped, or preserved, and resolve import and export errors.

+ More

Use configuration export and import to back up a SIA Connect setup, copy a setup to another unit, or deploy the same base configuration to several gateways.

An export is a JSON file containing configuration records. It is not a complete system image and does not contain stored historical item values.

Protect exported configuration files. The export contains user account records with stored password data and can contain Connector files, certificates, keys, and other sensitive configuration values.

Before you begin

Make sure your role has permission to read exports and edit imports.
Install every required Connector on the destination unit before importing.
Export the destination unit's current configuration as a backup.
Check whether the imported network settings could change the address used to reach the destination unit.
Use an unmodified JSON export from a compatible SIA Connect version whenever possible.

The import dialog states that existing configuration is not deleted or overridden. The current backend does not delete existing records, but it can update matching instances, items, editable system settings, and network interfaces.

Open the configuration tools

Sign in to the Edge Portal.
Expand Configuration in the sidebar.
Select System.
Expand Export and import configuration if the section is collapsed.

Export a configuration

Select Export.
Wait while the button displays Exporting....
Confirm that Configuration exported successfully. appears.
Save the downloaded JSON file in a secure location.

The Edge Portal names the file using this format:

YYYYMMDD_UUID_siaconnect.json

The date is the local date of the computer running the browser. Characters outside letters, numbers, underscores, and hyphens are removed from the UUID portion.

Understand what the export contains

Configuration area	Exported content
Connectors	Connector records together with their instances, items, mappings, and file records.
Connector files	Readable file content is included. Binary content is Base64 encoded. Missing, empty, or unreadable file content can be omitted.
Mapping groups	Mapping group names, enabled states, descriptions, and identifiers used to rebuild group references.
System settings	System setting records except `pairing_passphrase`.
Users	User records with stored password data.
Network interfaces	Configured interface values, including addressing information.

The export removes internal mapping and runtime helper fields such as buffered-message counts and caller or executor name helpers. Database record IDs can appear in the file, but imported records do not reuse those IDs.

Understand what the export does not contain

The unit PIN stored as pairing_passphrase
Stored historical item values
System diagnostic logs
Notification-history events
Connector installation packages
Internal mapping runtime fields removed during export
Content from Connector files that are missing, empty, or unreadable during export

An import cannot install a missing Connector. Install the required Connector package separately before importing its configuration.

Import a configuration

Select Import.
Select Select configuration file.
Choose a file with the .json extension.
Confirm that the filename appears in the dialog.
Select Import.
Keep the page open while the button displays Importing....
Wait for Configuration imported successfully.

After processing the configuration, the backend restarts the SIA Connect service and refreshes its configuration cache. The portal can be temporarily unavailable during this process.

If network settings change, reconnect using the imported address after the network configuration is applied.

Understand how existing configuration is matched

Record type	How an existing record is identified	Import behavior
Connector	Connector name	The Connector must already be installed. Missing Connectors and their dependent data are skipped.
Instance	UID when the imported record contains one. Name is used when no UID is present.	A matching instance is updated. A record with no match is created.
Item	UID when the imported record contains one. Name is used when no UID is present.	A matching item is updated. A record with no match is created.
Mapping	Mapping endpoints and configuration are compared with existing mappings.	An existing equivalent mapping is kept. A new mapping is added. Existing mappings are not edited by the import.
Mapping group	Group name	An existing group is reused without updating its enabled state or description. A missing group is created.
User	Username	An existing user is kept without changing its password or other fields. A missing user is created from the imported record.
Connector file	Filename within the Connector	An existing file is not overwritten. A missing file is created only when the import contains file content.
Network interface	Interface name	A matching interface is updated. An interface name that does not exist on the destination is not created.

No existing records are deleted. This means an import merges configuration into the destination. Resources that are present only on the destination remain there.

Understand which system settings are imported

The importer applies a system setting when it passes the exclusion rules and the destination permits it.

Setting condition	Import behavior
The setting does not exist on the destination	The setting is created using the imported name, value, description, and editable state. It is made visible.
The setting exists and is editable on the destination	Its value and description are updated. It is made visible. The existing editable state is kept.
The setting exists and is read-only on the destination	The imported value is ignored.
`pairing_passphrase`	Ignored. The destination PIN is preserved.
`uuid`	Ignored. The destination unit identity is preserved.
Any setting whose name contains `version`	Ignored. The destination software and component version values are preserved.

Other settings in the file can be imported when the destination setting is editable. Review values such as the system name, time zone, logging, advanced settings, and update preferences after the import.

Understand how network settings are imported

Network interfaces are exported and used during import. For each imported interface whose name exists on the destination, the backend updates all imported interface fields except the database ID.

If the address, subnet mask, or gateway changes, the backend requests a network restart and records the new address information. This can end the current browser connection.

Confirm that the destination has the same interface names and that you can reach the imported network before importing. Keep local access available when changing a remote unit.

What happens when a Connector is missing

If the destination does not have a Connector referenced by the file, the backend skips:

The missing Connector configuration
Instances and items belonging to that Connector
Mappings that use the missing Connector as sender or receiver

Everything else is imported before the warning is returned. The operation is therefore a partial import, not a rollback.

Write down every Connector named in the warning.
Install those Connectors on the destination.
Confirm that the installed Connector names match the export.
Import the same configuration file again.
Verify the previously skipped instances, items, files, and mappings.

Verify the imported configuration

Wait for the SIA Connect service and Edge Portal to become available.
Reconnect using the new address if network settings changed.
Open Configuration > Connectors and confirm that all required Connectors are installed and enabled.
Review the imported instances and items.
Review mappings and mapping groups.
Check users, editable system settings, and network interfaces.
Confirm that expected Connector files are available.
Check the Overview cockpit and notifications for errors.

Troubleshoot export errors

Message or condition	What to do
Failed to export configuration. Please try again.	Check the connection to the gateway, reload the page, and try again. Confirm that your role can read exports and that the UUID setting is available.
An API or authorization error is shown	Use the returned message to identify the problem. Sign in again if the session expired, or ask an administrator to grant export read permission.
The success message appears but no file is visible	Check the browser download list and download permissions, then run the export again.
An expected Connector file has no content in the export	Confirm that the source file exists and is readable by the SIA Connect service. Missing, empty, and unreadable file content can be omitted without a UI warning.

Troubleshoot import errors

Message or condition	What to do
Select a JSON configuration file.	Choose a file whose name ends in `.json`.
The selected file is not valid JSON.	Use a new export from SIA Connect. If the file was edited, validate its JSON syntax and restore missing brackets, commas, quotation marks, or values.
Select a JSON configuration file before importing.	Select and validate the file before starting the import.
Not installed Connector(s): [names]. These plugins and the data that belongs to them are skipped. Please install the plugins and try again. Everything else performed successfully.	The import completed partially. Install every named Connector, then import the same file again.
Failed to import configuration. Please try again.	Check the gateway connection and retry with an unmodified export from a compatible version. If the API provides a more specific message, correct that issue first.
An API or authorization error is shown	Confirm that your role has import edit permission. Sign in again if the session expired.
The portal disconnects during or after import	The service restarts after import. Network settings can also change. Wait for the restart, then reconnect using the imported address.
Only part of the configuration appears	Review any missing-Connector warning and install the required Connectors. Do not assume that an error rolled back changes already applied.
An existing user, mapping group, mapping, or Connector file did not change	This is expected merge behavior. Existing users, mapping groups, equivalent mappings, and Connector files are kept rather than overwritten.
An existing setting did not change	The destination setting may be read-only or excluded because it is the PIN, UUID, or a version setting.
An imported interface did not appear	Network interfaces are matched by name and are not created. Configure the destination interface separately if its name differs.

configuration backup configuration export configuration import edge portal json migration troubleshooting

Contact Us