Skip to Content
User GuideExport & Import

Export & Import

Inspire lets you export components, themes, and scenes as portable JSON files. You can then import them into another Inspire instance or tenant, making it easy to share designs across environments.

What can be exported?

TypeWhat’s included
ComponentComponent definition, input schema, sizing constraints, and all theme-specific designs
ThemeTheme style definitions (colours, fonts, spacing) and all component designs linked to this theme
SceneScene settings, layout definition, zone contents (both component placements and freeform content), and schedule rules
Zone ContentA single zone content item — either a component placement (with input values and bindings) or freeform content design data

Exporting

Open the component, theme, or scene you want to export.

Click Export

  • Components: Open the component detail page and click the Export button in the header.
  • Themes: Open the theme editor and click the Export button in the header.
  • Scenes: In the endpoint’s Scenes tab, click the download icon on the scene row.

Save the file

Your browser downloads a .inspire-{type}.json file. This is a standard JSON file that can be shared, version-controlled, or backed up.

Importing

Go to the Components, Themes, or Scenes page where you want to import.

Click Import

Click the Import button in the page header. A dialog appears with a file drop zone.

Select the file

Drag and drop the .inspire-*.json file onto the drop zone, or click to browse. The dialog shows a preview of the package contents.

Choose a conflict strategy

If an item with the same name or slug already exists, choose how to handle it:

StrategyBehaviour
RenameAdds a suffix (e.g. -imported) to avoid conflicts. This is the default.
OverwriteReplaces the existing item with the imported data.
SkipLeaves the existing item unchanged and does not import.

Import

Click Import to create the item. Any warnings (e.g. missing themes or components that could not be linked) are shown after the import completes.

Scene imports

When importing a scene, you must be on an endpoint’s Scenes tab. The imported scene is added to that endpoint. If the layout referenced in the package does not exist, it is created automatically.

Zone content exports

You can export and import individual zone content items, making it easy to reuse a component placement or freeform design across different scenes or endpoints.

Export a zone content item

In the endpoint’s Scenes tab, expand a scene to see its zones. Each zone content item has a download icon — click it to export that single item as a .inspire-zone.json file.

Import into a zone

In the zone header, click the import icon next to the Add button. Select a .inspire-zone.json file. The content is added to the end of the zone’s rotation.

You can import into a different zone index than the original — the import dialog handles the mapping automatically.

Triggers

If exported content references triggers (via triggerIds on elements), the full trigger definitions are included in the export package. During import, you can choose how to handle them:

StrategyBehaviour
Create newCreates fresh trigger records on the target system from the exported definitions. Element trigger references are updated to point to the new IDs. This is the default.
Reuse existingMatches triggers by name. If a trigger with the same name exists on the target, elements are linked to it. Triggers not found by name are removed from elements.
Remove assignmentsStrips all trigger references from imported elements. Use this if you do not need the trigger logic on the target.

Data bindings

Export packages also record all DataPool paths referenced by element bindings, component input bindings, and grid stream sources. During import, these paths are listed so you can verify they exist on the target system.

If a path does not exist on the target (or has a different name), you can enter a replacement path in the import dialog. Leave the field blank to keep the original binding unchanged.

Cross-tenant sharing

Export files are tenant-independent. They reference themes by name and components by slug rather than by database ID, so they work across different tenants and instances.

Theme designs and component designs are linked by name/slug during import. If the target tenant does not have a matching theme or component, the design link is skipped and a warning is shown.

File format

Export files use the .inspire-{type}.json naming convention:

  • kpi-card.inspire-component.json
  • corporate-blue.inspire-theme.json
  • welcome-screen.inspire-scene.json
  • sales-gauge.inspire-zone.json

The JSON structure includes a type field (component, theme, scene, or zone), a version number for future compatibility, and the exported data.

Last updated on