Installing 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 configuring the Altium On-Prem Enterprise Server to use an Oracle Database backend. It contains details about the Enterprise Server, its installation procedure, important information on system requirements, as well as an example.

To follow this guide, you should have a general understanding of Oracle database concepts and the operating system environment.

Installation Process Overview

Configuring the Enterprise Server to use 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 process of installation typically involves three steps, as illustrated in the following image.

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

Assumptions Made Throughout this Document

While Oracle configurations can vary from site to site, a few assumptions are 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 Enterprise Server is installed and running on a full Microsoft Windows OS.
3. The Oracle Client Connector is installed and running on the same machine hosting the Enterprise Server Application.
4. Microsoft .NET 6  is installed and running on the same machine hosting the Enterprise Server Application – if not available, these are automatically installed during the Enterprise Server installation.
5. The Oracle Server should be running on a physically different host machine than the Enterprise Server application.
6. The Oracle Schema and Oracle application credentials used on the source and destination Oracle servers must be the same, if this installation is being performed as part of a data migration process.

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.

Example Setup 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 implement an Enterprise Server-Oracle configuration on their network. The following steps show how a basic installation of Enterprise Server and Oracle can be deployed.

It is assumed the installation is done using the internal Oracle SYSTEM account, and that no custom SCHEMA is created. However, it is recommended that more experienced users, or DBAs, create an appropriate user account, with associated SCHEMA that is granted proper permissions.

Required Items

• Oracle Database Server Host machine, running Windows 7 Professional or newer.

• Enterprise Server Host machine, running Windows Server 2016 Standard Edition (64-bit) or newer.

• Oracle Database version 19c.
• Oracle Data Access Components (ODAC) client connector, such as ODTwithODAC122011 (see below).
• Altium On-Prem Enterprise Server.

Installation Procedure

1. On the Oracle DB server Host machine:
   1. Install Oracle Database 19c. Write down the name/password you choose.
   2. Ensure that the NLS_CHARACTERSET configuration is set to AL32UTF8.
   3. Optional: Setup a database user account for use with the Enterprise Server as an alternative to the default SYSTEM account. Write down the User name and login info you choose. A new database user account and files can be created with the Oracle SQL Developer application using the following SQL commands for example (where the name/password for the new user account is ENTERPRISESERVERUSER/ENTERPRISESERVERPASS):

create tablespace ENTERPRISESERVERUSER datafile 'C:\app\odb19\oradata\orcl\ENTERPRISESERVER.dbf' size 100M autoextend on;
create tablespace TEMP datafile 'C:\app\odb19\oradata\orcl\TEMP.dbf' size 100M autoextend on;
CREATE USER ENTERPRISESERVERUSER IDENTIFIED BY ENTERPRISESERVERPASS DEFAULT TABLESPACE ENTERPRISESERVERUSER;
GRANT CONNECT TO ENTERPRISESERVERUSER;
GRANT CONNECT, RESOURCE, DBA TO ENTERPRISESERVERUSER;
GRANT CREATE SESSION TO ENTERPRISESERVERUSER;
GRANT UNLIMITED TABLESPACE TO ENTERPRISESERVERUSER;
GRANT ALL PRIVILEGES TO ENTERPRISESERVERUSER;

2. On the Enterprise Server Host machine:
   1. First, install the Oracle Data Access Components (ODAC) software: ODTwithODAC122011.
   2. Copy the tnsnames.ora file from the Oracle DB Server Host Machine to the Enterprise Server Host machine.
      1. The file is typically found in the %ORACLE_HOME%\Network\Admin directory, where the ORACLE_HOME environment variable is determined by the Oracle installation location – for example: C:\app\odb19\product\19.x.x\dbhome_1
      2. The target location on the Enterprise Server machine is again %ORACLE_HOME%\Network\Admin, where the ORACLE_HOME path is the ODAC installation location – for example: C:\app\product\12.2.0\client_1\Network\Admin

3. Install Enterprise Server.
4. During Enterprise Server installation, enter the following:
   1. TNS Alias: default is ORCL. If you performed step 1-a, enter the appropriate TNS Name that you defined here.
   2. Username: default is SYSTEM. If you performed step 1-c, enter the appropriate Username that you defined here (ENTERPRISESERVERUSER in the example).
   3. Password: the same that was defined in step 1-a, or 1-c.
5. Proceed with Enterprise Server installation and configuration as described in the document Installing Altium On-Prem Enterprise Server.

Conclusion

Although the aforementioned example includes additional details pertaining to the handling of an Oracle Database, there are only three key steps to configuring your Enterprise Server to work with an Oracle backend:

1. Step 1 is to create an Oracle account and SCHEMA.
2. Step 2 is to establish the tnsnames.ora parameters.
3. Step 3 is to install the Enterprise Server.