Skip to main content

Import / Export

OpSee supports bulk import and export of equipment data through Excel files (.xlsx). This is useful for initial setup, migration from other systems, backup, and bulk updates.

Accessing import / export​

In the equipment grid toolbar, two buttons are available:

ButtonIconDescription
ImportUploadOpen the import dialog to upload an Excel file
ExportDownloadOpen the export dialog to download equipment as Excel

Import/Export buttons in toolbar

Exporting equipment​

Steps​

  1. Click the Export button in the toolbar
  2. In the export dialog, configure options:
    • Filename -- the default filename is pre-filled with a translated name; customize if needed
    • Include Disabled -- toggle to include inactive equipment in the export (off by default)
  3. Click Export

An Excel file downloads to your browser with all equipment matching the selected options.

Export dialog

Exported columns​

The Excel file contains the following columns:

ColumnDescription
IDEquipment ID (read-only, used for updates)
NameEquipment name
DescriptionEquipment description
Parent IDID of the parent equipment
Type IDID of the equipment type
Type NameEquipment type name (read-only, for reference)
IconIcon identifier (e.g., mdi:cog)
ColorColor hex code (e.g., #1976d2)
EnabledActive status (true/false)
tip

Export your current equipment before making bulk changes. This gives you a backup you can restore from if needed.

Importing equipment​

Steps​

  1. Click the Import button in the toolbar
  2. In the import dialog, upload an Excel file (.xlsx)
  3. OpSee validates the file and shows a preview of the data
  4. Review the preview and confirm the import
  5. Equipment items are created or updated based on the data

File format​

The import file must follow the same column structure as the export. The easiest way to get the correct format is to export first, modify the file, and re-import.

Import behavior​

ScenarioBehavior
Row has no IDA new equipment item is created
Row has an existing IDThe existing equipment is updated
Row has an unknown IDAn error is reported for that row
Required field (Name) is emptyAn error is reported for that row

Validation​

Before processing, OpSee validates:

  • Required fields -- Name must be present
  • Parent references -- Parent IDs must refer to existing equipment
  • Type references -- Type IDs must refer to existing equipment types
  • Duplicate detection -- warns if the import would create duplicates
info

Import operations are logged in the Audit Trail. Each created or updated equipment generates an audit entry with the user, timestamp, and the old/new values.

Template​

If you are starting from scratch without any equipment to export, you can create a blank Excel file with the correct column headers:

IDNameDescriptionParent IDType IDType NameIconColorEnabled
Filling Line 1Main filling line15Unitmdi:cog#1976d2true
Mixer APrimary mixer15Unitmdi:mixer#2e7d32true
tip

Leave the ID column empty for new equipment. OpSee will assign IDs automatically. The Type Name column is ignored during import -- only Type ID is used.

Clean duplicates​

If an import creates duplicate equipment (same name, parent, and type), use the Clean Duplicates button in the toolbar. This tool:

  1. Groups equipment by name, parent ID, and type ID
  2. Identifies groups with more than one entry
  3. Keeps the oldest item (lowest ID) and permanently deletes the rest
  4. Reports how many duplicates were removed
warning

Clean Duplicates performs a hard delete on duplicate entries. This cannot be undone. Always export your equipment first as a backup before running this tool.

Best practices​

  1. Export before import -- always create a backup export before bulk importing.
  2. Use export as template -- export existing equipment to get the correct file structure, then add new rows.
  3. Small batches -- for large plants, import in batches (e.g., per area) to make it easier to review and troubleshoot.
  4. Verify parent IDs -- ensure parent equipment exists before importing child items. Import top-level items first, then children.
  5. Clean up after import -- run the Clean Duplicates tool after bulk imports to catch any accidental duplicates.

Prerequisites​

Next steps​