Backing up Altium On-Prem Enterprise Server with an Oracle Backend

Parent page: Altium On-Prem Enterprise Server with Oracle Backend

This document is intended for an IT administrator who is backing up the Altium On-Prem Enterprise Server when using an Oracle Database Backend. It contains details about the Enterprise Server, its backup procedure within the context of using Oracle, important information on system requirements, as well as an example.

Backup Process Overview

Backing-up the Enterprise Server when using an Oracle backend depends on how your company manages its Oracle Databases. Some companies run Oracle Databases on top of Windows Server Operating Systems, while others have entire Oracle datacenters. The backup process typically involves three steps, as illustrated in the following image.

High level overview of the Enterprise Server and Oracle database backup procedure.

Assumptions Made Throughout this Document

1. An IT admin performs the installation. At a very minimum, the user performing Enterprise Server installation should have administrative rights to the host machine.
2. The Oracle Schema and Oracle application credentials used on the source and destination Oracle servers must be the same.

High-level Overview of the Enterprise Server Architecture

Similar to other software designed to run on Microsoft Windows, the Enterprise Server is a multi-threaded, multi-service server application. Since this document solely focuses on parts of the Enterprise Server that may interact with an Oracle Database, the following image is simplified to represent the overall Enterprise Server Backend Architecture.

High level overview of the Enterprise Server architecture. The Backend Storages of Enterprise Server contains most of the customer binary data, while the Windows Services is a collection of supporting services.

This document focuses on the Backend Storages since the data within this block is what gets backed up, potentially migrated to another machine, then restored either on the same or different machine. Within the Backend Storages, the following items can be found:

• Databases – contains metadata such as component footprint and schematic symbol association, parameters, file paths, links to component supply chain data sources and more. This information could reside inside a Firebird or Oracle database.
• File Storage – this File Storage area holds binary data inside the Enterprise Server’s VCS repository. This binary data includes information such as PCB and Schematic Project documents, footprints, symbols, Draftsman and other native or non-native Enterprise Server documents.

High-level Overview of the Altium Backup Tool

The Altium backup tool is called avbackup.exe. This is a command line utility that IT administrators can execute to backup their Enterprise Server data. avbackup.exe is the same utility used for backup purposes when the Enterprise Server is configured with a default Firebird database backend, or when using the Oracle database as a backend.

When using avbackup.exe on an Enterprise Server implementation that uses an Oracle Database, administrators should be mindful of the following:

1. avbackup.exe does NOT support backing up your Oracle Database. This feature only works on Enterprise Server implementations using a Firebird database backend that was originally auto-configured by the Enterprise Server Installer.
2. avbackup.exe will generate a Zip file containing all Enterprise Server binary data.
3. avbackup.exe will automatically shut down all Enterprise Server services (including IIS services) during data backup, then restart all services it shut down, after a successful backup.

Example Backup of Enterprise Server with Oracle backend on the Windows Platform

In this example, the instructions also cater to smaller businesses who may not have a dedicated Oracle Database Administrator (DBA), but still have the need to backup their Enterprise Server and associated Oracle data on their network. The following steps show how a basic backup of the Enterprise Server and the Oracle database can be performed.

Required Items

• Backup folders – folders where you plan to store Enterprise Server and Oracle data need to already exist.
• Admin access to the Enterprise Server Host machine. This is required to properly run the Enterprise Server backup Command utility (avbackup.exe).
• Appropriate DBA access to the Oracle server (i.e. Add user’s Windows account to DBA role in Windows environment).

Backup Procedure

1. On the Enterprise Server Host machine:
   1. Create a backup folder (it helps to have common file paths, for example: C:\Backups).
   2. Backup your Enterprise Server data by running the avbackup.exe tool as Admin. The tool is located in the C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool folder.

2. On the Oracle Database Server Host machine:
   1. Create a backup folder (it helps to have common file paths, for example: C:\Backups).
   2. Backup your Oracle data (this section assumes that the user account and schemas are both named AESUSER313 and have password Altium):
      1. Launch a command prompt with Admin privileges.
      2. Stop IIS Servers using command: net stop WAS.
      3. Temporarily elevate involved schema to DBA status before backup.
      4. Backup/Export the schema associated with the Enterprise Server. An example of an export command is:

exp AESUSER313/Altium@xe owner=AESUSER313 file=c:\Backups\AESUSER313.dmp log=c:\Backups\AESUSER313_export.log statistics=none

where,

AESUSER313 – user that has full privileges on scheme and rights to access the DB.

Altium – password for Oracle user account associated with the Enterprise Server.

xe – network service name of target DB contained in tnsnames.ora.

owner = AESUSER313 – name of the schema.

file = c:\Backups\AESUSER313.dmp – backup location.

log = c:\Backups\AESUSER313_export.log – backup log (optional).

Conclusion

Although the aforementioned example includes additional details pertaining to the handling of an Oracle Database, there are only three key steps to backing up your Enterprise Server data:

1. Step 1 is to stop the IIS services and Enterprise Server IIS Application Pools.
2. Step 2 is to backup the Enterprise Server data.
3. Step 3 is to backup the Oracle data associated with the Enterprise Server.

Performing this procedure in the order described greatly reduces the likelihood of data corruption due to Oracle database and Enterprise Server binary data mismatch.