In earlier versions of SuperSTAR, the user catalogue (details of users, permissions and passwords) was stored in an XML file. If you installed to the default location, this was saved in C:\ProgramData\STR\SuperADMIN\server\data\.repository\userCatalog.xml.
The use of XML can cause performance issues if you have a large number of user accounts. As a result, from version 9.9 onwards, SuperADMIN uses a relational database to store all user data.
When you upgrade to version 9.9 or later, SuperADMIN will automatically convert the user data from userCatalog.xml to a relational database (RDBMS). By default, it will store user data in an H2 database (located in C:\ProgramData\STR\SuperADMIN\server\data\superadmin.db), but you can switch to any of the following relational databases if you prefer:
- MySQL / MariaDB
- SQL Server
What Will Be Stored in the RDBMS
From 9.9 onwards, the following are stored in the RDBMS after the migration:
- Configuration server data
- User registration details
- Users and passwords
Step 1 - Export the Configuration Server Settings
Before starting the migration, you are strongly recommended to export any existing configuration server data to a text file. This step is only required when you have an existing SuperSTAR system running version 9.0 or higher. Run the following command in SuperADMIN:
<filename> with the full path to a file on disk where you want to save the settings. Do not use quotes even if the path contains spaces.
After you run the command, check that the file has been created in the specified location. You will need to use this file in a later step to reimport your configuration settings.
Step 2 - Create a Database and User
The first step is to create a database for the user data in your chosen RDBMS. To complete this step you may need to install a suitable database server or obtain access to an existing database server.
Create a new database. For example, you might call the database SuperSTAR_Users.
Create a dedicated database user account and set the account password.
- Grant your new user account full privileges over your new database.
Step 3 - Install a JDBC Driver
JDBC (Java Database Connectivity) is a programming interface that lets Java applications access a relational database. You need to install a JDBC driver for your RDBMS, so that SuperWEB2 can communicate with the User Data Repository database.
Download the appropriate JDBC driver for your database:
RDBMS Recommended Driver Example of JAR File Driver Class Download From MariaDB Connector/J mariadb-java-client-2.5.4.jar org.mariadb.jdbc.Driver https://mariadb.com/downloads/#connectors MySQL Connector/J mysql-connector-java-5.1.41-bin.jar com.mysql.jdbc.Driver http://www.mysql.com/downloads/connector/j/ Oracle ojdbc7.jar ojdbc7.jar oracle.jdbc.driver.OracleDriver http://www.oracle.com/technetwork/database/features/jdbc/jdbc-drivers-12c-download-1958347.html SQL Server Microsoft JDBC Driver sqljdbc42.jar com.microsoft.sqlserver.jdbc.SQLServerDriver http://www.microsoft.com/en-au/download/details.aspx?id=11774 DB2 DB2 JDBC Driver db2jcc4.jar com.ibm.db2.jcc.DB2Driver http://www-01.ibm.com/software/data/db2/linux-unix-windows/downloads.html PostgreSQL PostgreSQL JDBC 4.2 Driver, 42.0.0 postgresql-42.0.0.jar org.postgresql.Driver https://jdbc.postgresql.org/download.html
- Copy the driver .jar file to C:\Program Files\STR\SuperADMIN\server\lib\endorsed (or equivalent directory if you installed to a non-default location). You will need to create this directory if it does not already exist.
Step 4 - Configure SuperADMIN
Configure SuperADMIN to use your preferred RDBMS by adding the following section to the local.conf configuration file.
If you installed to the default directory, this file is located in C:\ProgramData\STR\SuperADMIN\server\config\local.conf.
Replace the following with the relevant values:
The JDBC connection string for your chosen RDBMS. The following are typical connection strings:
|USERNAME||The username for the account you created in Step 1.|
|PASSWORD||The password for the account you created in Step 1.|
One of the following strings:
For example, the following section might be used to connect to SQL Server:
Step 5 - Check SuperADMIN Migration Settings
- Make sure that the following XML files are present in the server data repository directory: userCatalog.xml and accountCatalog.xml (if you installed to the default location, check that the files exist in the C:\ProgramData\STR\SuperADMIN\server\data\.repository\ directory).
Run the following command in SuperADMIN:
This will ensure that the catalogue is migrated from XML on the next restart.
Step 6 - Restart SuperSERVER
You will need to restart the SuperADMIN/SuperSERVER service to apply this change. When the service has started, verify that the tables have been created in your RDBMS. For example:
Step 7 - Reimport your Configuration
If you exported your existing configuration settings at the start of the process, run the following command in SuperADMIN to reimport your settings:
<filename> with the full path to a file on disk containing your saved settings. Do not use quotes even if the path contains spaces.