Oracle
Requirements
A list of supported Oracle Versions can be found here: System Requirements
To run the scripts Oracle SQL*Plus® is required. This tool can be downloaded for your platform from the Oracle websites directly.
A full installation of the Oracle Client is not necessary. All HAKOM Products include their own copy of Oracles portable driver libraries.
Depending on whether a new HAKOM database is to be created or an existing one is to be updated, please refer to the sections below.
Path to install package
All neccessary scripts for Oracle can be found under the following path: HAKOM TSM Standard_3.9.x.x\_Database Scripts
\Oracle
New installation
This section describes how to set up a fresh HAKOM database on an existing Oracle instance.
Preparing scripts
Basic components
The file install.sql under ...\Database Scripts\Oracle
represents the main script. It contains several sections for different components of the HAKOM database system. Commenting-in or out individual sections determines which of these components are installed when executing the scripts.
For a fresh install, the sections
- Creating HAKOM tablespaces and user
- Creating HAKOM ACL objects,
- Creating HAKOM TSM objects and
- Creating HAKOM Framework objects
should be activated. (remove the "--" preceding each relevant line)
In the next step, each compontent enabled in the previous must be configured. Comment-in the initial scripts from version 3.8.0 up to the latest version in the respective SQL scripts.
Component | Script |
---|---|
ACL (User Management and Access Control) | HAKOM_ACL_Update.sql |
Time Series Storage | HAKOM_Framework_Update.sql |
Logging | HAKOM_Protocol_Update.sql |
Additional Storage required by TSM APP | HAKOM_TSM_Update.sql |
Configuring install.ini
Finally, under ...\Database Scripts\Oracle
the file install.ini must be configured. Using a text editor, assign values to the defined variables that are used in the scripts (note: the values must be inserted between single quotes (' '). )
Executing the scripts
Now go to the local script directory and set the parameters for SQLPlus as followed:
SET ORACLE_HOME= (Oracle client path)
CHCP 65001 (UTF-8 code page required for UTF-8 scripts)
Then start SQLPlus and install.sql in the folder with the scripts:
sqlplus /nolog
@install.sql
HAKOM Compressed Storage
In order to view compressed data on the Database directly, Java is required on the Database server, and has to be activated:
loadjava –user [Schema]/[Password][@Database] commons-codec-1.6.jar
This is optional and in no way required for using and interacting with compressed time series through the TSM or other HAKOM solutions.
Update
This section describes how to upgrade an existing database which already has some HAKOM components installed to a more recent version.
Preparation
At first the current database version of ACL, FW, Protocol and TSM objects has to be checked. To do that, check the entries in the table DBVERSION. The interpretation of the entries is explained in the following example:
- Table DBVERSION:
ID | NAME | DESCRIPTION | CREATIONDATE | REVISION | PATCH | MAJOR | MINOR |
---|---|---|---|---|---|---|---|
1 | HAKOM TSM | - | 01.07.2022 | 5 | 0 | 3 | 8 |
2 | HAKOM Framework | - | 01.07.2022 | 0 | 0 | 3 | 9 |
- Interpretation:
Version HAKOM TSM 3.8.5.0
Version HAKOM Framework 3.9.0.0
Manual check scripts
Before the update scripts are installed, it is important to check if manual check scripts have to be installed. You can find them under ...\Database Scripts\Oracle\V3.x.x\V3.x.x.x\_manual check script
and, if necessary, run them manually and follow the instructions within the scripts.
Preparing scripts
Basic components
The file install.sql under ...\Database Scripts\Oracle
represents the main script. Commenting in or out determines which sub-scripts are called.
In install.sql the sections Create HAKOM-ACL Objects, Create HAKOM-TSM Objects and Create HAKOM-Framework Objects must be activated.
Comment all lines in the update scripts up to (and including) the currently installed version.
Example for an update from 3.8.7 to 3.9.2
Component | Script |
---|---|
ACL (User Management and Access Control) | HAKOM_ACL_Update.sql |
Time Series Storage | HAKOM_Framework_Update.sql |
Logging | HAKOM_Protocol_Update.sql |
Additional Storage required by TSM APP | HAKOM_TSM_Update.sql |
Configuring install.ini
Finally, under ...\Database Scripts\Oracle
the file install.ini must be configured. Using a text editor, assign values to the defined variables which will then be used in the other scripts (note: the values must be inserted between ' '. )
Executing the scripts
Now go to the local script directory and set the following environment variables:
SET ORACLE_HOME= (Oracle client path)
CHCP 65001 (UTF-8 code page required for UTF-8 scripts)
Then start SQLPlus and install.sql in the folder with the FW scripts:
sqlplus /nolog
@install.sql