Why backup Axon Ivy Engine
- Backups protect case, business and process data, deployed applications, configuration, certificates that the engine and portal need to run.
- Plan backups so you can restore to a working state (not just files) — that usually means backing up the database(s) plus related files and services.
What to back up
- System database - The Axon Ivy system database that stores engine runtime data, case and task state, and configuration.
- Deployed applications - Application artifacts (Ivy Projects) deployed through the Engine Cockpit; required to re-deploy the exact runtime artifacts.
- Engine configuration - Configuration files containing global settings, security contexts, global variables, REST clients, SOAP services, external database connections, etc.
- Portal settings, dashboards, and Express processes — Portal configuration files that store portal settings, user-created dashboards, and Express process definitions.
- TLS keystore/truststore and SSL certificates — Private keys, SSL certificates, keystores, and truststores used by the engine for HTTPS; store these securely (for example, encrypted at rest).
- License File - The file of the current license that is installed via the Engine Cockpit.
- Documents and files — Attachments and documents associated with cases or uploaded by users; these may be stored locally on the Axon Ivy Engine host or in an external S3 bucket.
- OpenSearch indices — Indices used for statistics and business-data search. They can usually be rebuilt from the system database, but include them if you store project-specific data in OpenSearch.
- Project-specific external data — Any data stored by your projects in external systems (databases, filesystems, document-management systems, etc.); include both the data and any connection/configuration information.
How to back up each item
For a normally configured Axon Ivy Engine:
- System databases: - Back up using the database's native tools.
- Axon Ivy directories: - Back up the installation directory (configuration, applications, data) by copying or exporting to external storage.
- Project-specific data: Back up external databases, file directories, and other systems using their respective backup procedures.
More details:
- System database: - Use database-native backup tools (dump/snapshot) for your RDBMS (Postgres, MySQL, MariaDB, Microsoft SQL Server, Oracle). Ensure consistency (quiesce the engine or use transactional snapshots). Keep schema and data backups and the DB user/privileges used by the engine (privileges required at install/update are documented in the setup wizard).
- Deployed applications: - Deployed applications are stored in the
applications directory of the Axon Ivy installation directory by default (see configuration Data.AppDirectory). See the next chapter on how to back up and restore different version of application artifacts and project files.
- Engine configuration: - Engine configuration files are stored in the
configuration and 'applications' directory by default. Back up the configuration directory. The applications directory is already backed up (see point 2).
- Portal settings/dashboards/Express: Portal stores configuration JSON files in the
applications directory by default; this directory should already be backed up (see point 3). Additionally, you can use the Portal export/import functions to restore configuration.
- TLS keystore / SSL certificates: - Keystore and truststore are stored in the
configuration directory by default; this directory should already be backed up (see point 3). If stored elsewhere or if you use the system keystore/truststore, back those up too.
- License: The current license file is stored in the
configuration directory by default; this directory should already be backed up (see point 3).
- Documents/files: Files, attachments and documents are stored in the
data directory by default (see configuration Data.Directory). Back up the data directory. If using external S3, ensure it is backed up as well.
- OpenSearch: Bundled OpenSearch data files are stored in
data/_/opensearch by default (see configuration SearchEngine.BundledServer.DataPath). This directory should already be backed up (see point 3). If using an external OpenSearch service, back it up as well.
- Project-specific data: Ensure all project-specific data is backed up (databases, file directories, other external system, etc.).
How to back up your applications and project files
- Check your Axon Ivy projects and files into a source repository such as Git.
- Ensure each build artifact has a unique version.
- Publish built artifacts to an artifact repository (e.g., Nexus).
This lets you revert to any application version.
Practical backup procedure (high level)
- Schedule a maintenance window if needed for consistent snapshots.
- Stop or quiesce the engine if you cannot guarantee database consistency while it’s running.
- Verify backups by restoring to a test environment periodically. Store backups offsite or in immutable, secure storage.
Restore checklist (quick)
- Verify the engine and Java runtime versions match the expected versions.
- Restore the database to the matching schema version, then restore application artifacts.
- Restore configuration, application, and data directories.
Frequency, retention and testing (guidance)
- Frequency: Daily for database and file changes; take a snapshot before upgrades.
- Retention: Keep a rolling set (e.g., 7 daily, 4 weekly, 12 monthly) per compliance needs.
- Testing: Test restores regularly (quarterly or before major upgrades).
Security and operational tips
- Encrypt backups in transit and at rest; restrict access to backup stores.
- Automate backups and monitor success/failure.
- Document exact restore steps and store them with the backups.
- Check engine health in the Engine Cockpit before performing backups.
