Export & Import

MaestroHub lets you export selected entities to a portable .mhub.json file and import them back into the same instance or a different one. This is useful for migrating configurations between environments (development to production), creating backups of key assets, or sharing reusable building blocks across teams.

Open the page from System Management > Export & Import tab.

tip

What can be exported? Connections, functions, topics, pipelines, and dashboards. The export file captures entity definitions and their relationships — not historical time-series data.

Export

Clicking Start Export opens a guided wizard that walks through entity selection, dependency analysis, and file generation.

Step 1 — Select Entities

Browse five collapsible sections — Connections, Functions, Topics, Pipelines, and Dashboards — and tick the items you want to include. Each section shows a count badge with the number of selected items out of the total available.

• Use the search bar to filter entities by name across all sections.
• Connections expand to show their child functions so you can include related items together.
• Topics are displayed as a hierarchical tree that mirrors the UNS structure.
• Toggle Select All or None per section, or pick items individually.

Step 2 — Review Dependencies

The wizard analyses the selected entities and lists any dependencies that should travel with them. For example, a pipeline that references a specific connection will flag that connection as a required dependency.

• Required dependencies are automatically included — removing them would break the exported entities.
• Optional dependencies can be included or excluded at your discretion.

A summary at the bottom shows the total entity count including dependencies.

Step 3 — Configure Export

Before generating the file you can fine-tune a few options:

Option	Description
Export Description	Free-text note stored inside the file as metadata.
File Name	Name of the .mhub.json file. Auto-populated with a pattern that includes the entity count and current date.
Exclude Credentials	When enabled, passwords and API keys are replaced with placeholders. This is the recommended option when the file will be shared or stored outside a secure vault.

An export summary grid shows the final breakdown by entity type.

Step 4 — Download

The file is generated and ready to download. Click Download to save the .mhub.json file to your local machine.

Import

Clicking Start Import opens a guided wizard that validates the file, shows its contents, resolves conflicts, and executes the import.

Step 1 — Upload File

Drag and drop a .mhub.json file onto the upload area or click Browse to select one. The maximum file size is 50 MB. The wizard validates the file format before proceeding.

Step 2 — Review Contents

The wizard displays a summary of what the file contains:

• File info — schema version, export date, source instance, and description.
• Entity counts — number of connections, functions, topics, pipelines, and dashboards in the file.
• Conflict preview — a warning if any entities in the file already exist in the current instance.
• Credentials required — an info banner listing how many connections need credentials to be entered before they can function.

Step 3 — Resolve Conflicts

This step appears only when the file contains entities that already exist in the target instance. For each conflict you choose one of three resolutions:

Resolution	Effect
Skip	Keep the existing entity unchanged. The imported version is ignored.
Rename	Import the entity under a new name so both versions coexist.
Update	Replace the existing entity with the imported version.

Topics are resolved in bulk — you choose a single strategy (skip all or update all) that applies to every conflicting topic. Connections, pipelines, and dashboards are resolved individually.

When a connection conflict is resolved with Rename, its child functions are automatically carried over under the new name.

Step 4 — Enter Credentials

This step appears only when the file contains connections that require credentials (either because they were excluded during export or because the target instance does not have them). For each connection, fill in the required fields such as passwords or API keys. You can also Skip a connection to import it without credentials — it will be created but will not connect until credentials are provided later.

Step 5 — Confirm & Execute

The final screen shows a summary of what will happen: total entities to create, conflicts resolved, and credentials provided.

• Enable pipelines after import — by default, imported pipelines are created in a disabled state. Enable this option to activate them immediately after import.

warning

Import creates new entities in your system and may update existing ones if you chose the Update resolution. Review the summary carefully before confirming.

After confirmation the import runs asynchronously. A progress indicator shows the current phase, percentage, and processed count. Once complete, a result screen lists every entity with its outcome — created, skipped, or failed.

Export & Import History

The main page displays two history tables below the action cards:

• Recent Export Activity — date, file name, status (success, partial, or failed), entity count, and the user who triggered the export.
• Recent Import Activity — date, file name, status, number of entities created and failed, and the user who triggered the import.

Use these tables to audit past operations or to re-download a previous export file.

File Format

The .mhub.json file is a self-contained JSON document. It includes:

• A schema version so the target instance can validate compatibility.
• Metadata — export date, source instance identifier, and user-provided description.
• Entity definitions grouped by type, preserving relationships and ordering.

The file does not contain historical time-series data, user accounts, or system settings. It is designed to be portable, human-readable, and safe to store in version control.