Skip to main content

Data Management

This page covers two addon modules for managing your system data: Data Import/Export and Backup & Restore.

Data Import/Export​

Addon Required

This feature requires the Data Import/Export addon to be enabled. Go to Settings > Addons to activate it.

Navigate to Data Import/Export from the main menu to access the data transfer tools.

The Data Import/Export module allows you to bulk import data into the system from spreadsheet files and export existing data for reporting or migration purposes. The available data types are determined by a transfer registry that detects which modules are active.

Available Data Types​

The page displays a list of all available data types that support import and/or export. Each data type indicates whether it supports:

  • Import: Upload a file to create or update records
  • Export: Download existing data as a spreadsheet

The available types depend on which modules are enabled in your system.

Exporting Data​

  1. Navigate to Data Import/Export
  2. Find the data type you want to export
  3. Click Export
  4. The system generates an XLSX file with a timestamped filename (e.g., 2026-02-19_143025_employees.xlsx)
  5. The file downloads automatically

Downloading an Import Template​

Before importing data, download the template file to ensure your data is in the correct format:

  1. Navigate to Data Import/Export
  2. Find the data type you want to import
  3. Click Download Template
  4. The system downloads an XLSX template file with the correct column headers

Importing Data​

  1. Navigate to Data Import/Export
  2. Find the data type you want to import
  3. Click Import
  4. Select your prepared file (CSV or XLSX format)
  5. Click Upload

The system processes the file and creates or updates records accordingly. If errors occur during import, an error message is displayed with details.

tip

Always download and use the template file before importing to ensure your column headers and data formats match what the system expects.

Backup & Restore​

Addon Required

This feature requires the System Backup addon to be enabled. Go to Settings > Addons to activate it.

The Backup & Restore module provides tools for creating system backups, restoring from previous backups, and scheduling automatic backups.

Backups​

Navigate to Backup & Restore > Backups to view and manage system backups.

Backup List​

The backup list displays all backups in a DataTable with the following information:

  • Name (with badges showing included items: Database, Files, Modules)
  • Type (Manual or Scheduled)
  • Status (Completed, In Progress, or Failed)
  • Size (formatted file size)
  • Provider (storage location, e.g., Local)
  • Created By (user avatar and name)
  • Created At (date and time)

You can search and sort the list by name, type, status, or creation date.

Creating a Backup​

  1. Click Create Backup
  2. Configure the backup:
    • Name (optional, auto-generated if not provided using the format Backup_YYYY-MM-DD_HH-mm-ss)
    • Storage Provider (select from available providers)
    • Include (select one or more):
      • Database: Full database backup
      • Files: Uploaded files and media
      • Modules: Module files and configurations
  3. Click Create

The backup is created and its progress can be tracked.

Viewing Backup Details​

Click View Details from the actions menu to see comprehensive backup information, including:

  • Backup metadata
  • Included items with icons
  • Whether the backup can be restored or deleted

Restoring from a Backup​

  1. Find the backup you want to restore from in the list
  2. Click Restore from the actions menu
  3. Optionally select which items to restore (defaults to all items included in the backup):
    • Database
    • Files & Uploads
    • Modules
  4. Confirm the restore operation

The system restores the selected items and provides feedback on what was restored.

warning

Restoring a database backup replaces your current database with the backed-up version. Ensure you have a current backup before performing a restore.

Downloading a Backup​

Click Download from the actions menu to download the backup file as a ZIP archive.

Deleting a Backup​

Click Delete from the actions menu to remove the backup. This deletes both the backup record and the stored file from the storage provider.

Schedules​

Navigate to Backup & Restore > Schedules to manage automatic backup schedules.

Schedule List​

The schedule list shows all configured backup schedules with their settings and status.

Creating a Schedule​

  1. Click Add Schedule
  2. Configure the schedule:
    • Name (required)
    • Frequency: Choose from:
      • Daily: Runs once per day at the specified time
      • Weekly: Runs on selected days of the week at the specified time
      • Monthly: Runs on a specific day of the month at the specified time
      • Custom: Define a cron expression for advanced scheduling
    • Time (required for daily, weekly, and monthly)
    • Days of Week (required for weekly frequency)
    • Day of Month (required for monthly frequency, 1-31)
    • Cron Expression (required for custom frequency)
    • Storage Provider (select where backups are stored)
    • Included Items (select Database, Files, and/or Modules)
    • Retention Days (required, how many days to keep scheduled backups)
  3. Click Save

The system calculates and displays the next scheduled run time.

Editing a Schedule​

Click Edit to update the schedule configuration. The next run time is recalculated after saving.

Enabling/Disabling a Schedule​

Toggle a schedule's active status to temporarily pause or resume automatic backups without deleting the schedule configuration.

Running a Schedule Manually​

Click Run Now to immediately trigger a backup using the schedule's configuration. This creates a backup tagged as "scheduled" and updates the schedule's last run timestamp.

Deleting a Schedule​

Click Delete to permanently remove the backup schedule.

Last updated on