Safety Rules

This page lists the rules for safe changes to configuration data.

When to use it

Read this page before you change data or run an import.

Required rules

Before any change, export a snapshot of the current configuration. The snapshot helps you restore the configuration manually.
The UI has no built-in rollback yet. To restore a configuration, import a known-good snapshot if the module supports it. Otherwise, ask your backend administrators to help you recover.

Choose MERGE or REPLACE

Many import dialogs let you choose the MERGE mode or the REPLACE mode. The mode decides how the import treats existing configuration.

MERGE (recommended default)

MERGE updates existing entries and creates new entries. It keeps all entries outside the uploaded file.

Use MERGE to:

  • apply small changes,

  • add or update specific entries,

  • lower the risk of data loss.

MERGE works in this way:

  • The import updates an existing entry from the file.

  • The import creates a new entry from the file.

  • An existing entry outside the file stays unchanged.

MERGE is the safest option. Use it as your default, unless you need to remove entries.

REPLACE (use with caution)

REPLACE updates and creates entries from the uploaded file. It can also delete existing entries outside the file.

Use REPLACE only if both conditions are true:

  • The uploaded file is the full and authoritative configuration.

  • You want to remove all entries outside the file.

REPLACE works in this way, and the exact behavior depends on the module:

  • The import updates an existing entry from the file.

  • The import creates a new entry from the file.

  • The import deletes an existing entry missing from the file.

REPLACE can remove configuration data permanently. Read the dry-run results before you confirm an import in REPLACE mode.

Run the dry-run

In all modes, the dry-run is required:

  • The UI always runs a dry-run first.

  • The import action stays disabled until the dry-run ends successfully.

  • If you change the file or switch between MERGE and REPLACE, the previous dry-run becomes invalid.

The dry-run shows:

  • what the import will create, update, or delete,

  • warnings for your attention,

  • blocking errors to fix before the import.

Import safety checklist

  1. Check the environment name.

  2. Check the selected client type. It must match the file.

  3. Export a snapshot before you change data.

  4. Run Dry-run and review:

    • the errors: you must fix them,

    • the warnings: you must understand them,

    • the create, update, and delete counts.

  5. If you use REPLACE, review the deletions in the dry-run plan. Continue only if you accept them.

  6. Apply the import.

  7. Refresh the page and open the changed entries to check them.

Role limits

  • VIEWER: you can read and export.

  • EDITOR and ADMIN: you can edit and import. Module rules can limit these actions.

If actions are disabled or hidden, ask an administrator to check your role. Ask the administrator for more access if you need it.

Related pages