Skip to main content

ARIS Technical Help

Backup and restore data

Before you perform an update installation, please make sure to save all tenant's important data before starting the setup process. Administrators can save tenant data in different ways.

  • Using the Tenant Management tool is a way to backup and restore the infrastructure tenant (master) as well as all productive tenants.

    By default, backups are stored in the ARIS server installation directory (..\server\bin\work\work_umcadmin_<s, m or l>\backup). If you have not yet defined a different folder on a physical drive, make sure to save the backup folder. As the default backup folder is overwritten by the update, all backups are lost.

  • Using the ACC command backup tenant will save all important data of a specific tenant at once. Tenants can be restored using the restore tenant co mmand.

If you use an external database management system, backup these systems before running an update setup. If the update process fails all ARIS runnables will be restored automatically. In case of a failed update you will be able to restore the ARIS content managed from the external database systems, too. We recommend making a backup of your ARIS related relational database management system.

You can also save data individually:

Database

In ARIS, click Application launcher Application launcher > Administration Administration > Databases, select the database, and click Export Back up. In ARIS Architect on the Administration tab, use the Backup Backup functionality.

On the command line tool ARIS Server Administrator, using the backup or backupasn commands.

In ARIS Server Administrator, use the backupsystemdb command to backup filters, method modifications (such as user-defined attributes, model types etc.), configuration, queries, report scripts, macros and semantic checks. Alternatively, you can back up the data mentioned before individually as follows.

Filter

In ARIS, click Application launcher Application launcher > Administration Administration > Conventions > Filters, select a filter and click Export Export. In ARIS Architect on the 'Administration' tab, use the function Export Export.

Method and configuration

In ARIS Server Administrator, using the backupsystemdb command.

Report scripts and macros

In ARIS, click Application launcher Application launcher > Administration Administration > Evaluations, select a report or macro, and click Export Export. In ARIS Architect on the Administration tab individually backup scripts with the function Export in the pop-up menu for a script. If you have adapted standard scripts and standard files instead of copies the individual backup is mandatory. All standard scripts and standard files, except XML files, will be overwritten by an updated. Modifications will be lost.

In ARIS Server Administrator, using the backupsystemdb command.

Queries and ad hoc analyses

In ARIS Architect on the Administration tab with the Back up anaysis data Back up analysis data function.

When you perform an update installation, add languages, or uninstall a component, the relevant files and directories are backed up automatically. A selection of files is listed here to provide examples for server installations:

  • <ARIS installation directory>\server\backup

  • <ARIS installation directory>\server\data (saved databases after uninstallation)

  • <ARIS installation directory>\server\sysconfig

  • <ARIS installation directory>\server\templates

Configuration and modification sets

You can back up the configurations that you configured via the graphical user interface in ARIS Administration on the Configuration tab with the Download Backup function (Publication settings > Manage configuration sets).

The default and the classic configuration set must not be modified. These sets, holding all new features, are used as template for all future modification sets. The default and the classic configuration sets are automatically updated.

If the default or the classic configuration set was modified on file level, all changes are lost after the update. To keep the modifications, proceed as follows:

Copy the folders of the modified default or custom configuration sets from <ARIS installation path>\server\bin\work\, for example:

  • work_copernicus_<s, m or l>\base\webapps\ROOT\WEB-INF\config\default

  • work_abs_<s, m or l>\base\webapps\abs\WEB-INF\config\default

  • If a Heavy-duty Server (HDS) is in use, the related folder of the hds_<s, m or l> runnable must be copied as well.

After the update, the content of the default and the classic folders are updated, and your modifications are lost. Paste the copied folders into the <ARIS installation path>\server\bin\work\ subfolders, for example:

  • work_copernicus_<s, m or l>\base\webapps\ROOT\WEB-INF\config\<name of the customized default configuration set>

  • work_abs_<s, m or l>\base\webapps\abs\WEB-INF\config\<name of the customized default configuration set>

  • If a Heavy-duty Server (HDS) is in use, the related folder of the hds_<s, m or l> runnable must be copied as well.

Warning

To make the content update-proof, the folder must be named other than default, for example, customized_default.

New ARIS functionality will not be available in the copied configuration sets. You can manually copy additional lines from the updated default or classic configuration sets and paste them to the related customized configuration sets. This advanced configuration requires high knowledge on XML configuration, that can be acquired in the instructor-led ARIS Connect Portal Configuration training course, which is available to partners and customers at ARIS Academy. Errors in XML configuration files may cause strong impact. You might not be able to start ARIS again.

Depending on the level of customization, you are recommend using a prepared customization package obtained by the original customizer. If you need help, contact SAG ARIS GmbH for a customization request. Customization and training services are not subject to the standard software maintenance agreement. Configuration changes can only be performed by SAG ARIS GmbH if you requested and agreed on them.