Upgrading the database for the server components

Before you begin

Note: Before upgrading the database schema, ensure you have created a backup. Refer to the documentation related to your RDBMS for information about the backup procedure.

Ensure you have acquired information about the HCL Workload Automation tablespaces that were specified when the database tables were created and populated the first time. If values different from the default values were used, then your database administrator must provide them for this upgrade procedure. If default values were used, then they do not need to be specified during the upgrade procedure. The default values for the HCL Workload Automation data, log, and plan tablespaces are as follows:

--iwstsname TWS_DATA
- For Oracle only, the default is USERS
--iwslogtsname TWS_LOG
- For Oracle only, the default is USERS
--iwsplantsname TWS_PLAN
- For Oracle only, the default is USERS

For more information about all parameters and supported values of the configureDb command, see Database configuration - configureDb script.

About this task

You can run the configureDb command specifying a typical set of parameters. In this case, default values are used for all remaining parameters.

The script creates an SQL file with all the statements needed to upgrade the HCL Workload Automation database schema to the latest version and, by default, automatically applies it.

Default values are stored in the configureDb<database_vendor>.properties file, located in image_location/TWS/interp_name. For an example of a properties file, see What is the content of a database properties file?.

If you need to modify any of the default values, edit the configureDb<database_vendor>.properties file, but do not modify the configureDb<database_vendor>.template file located in the same path.

To upgrade the HCL Workload Automation database schema, perform the following steps:

Procedure

On the workstation where you plan to install the new backup master domain manager or backup dynamic domain manager, extract the HCL Workload Automation package at the latest version to a directory of your choice.
Browse to the image_location/TWS/interp_name path.
Type the following command to upgrade the HCL Workload Automation database schema to the latest version. Ensure that you use the same database administrator credentials you used when the HCL Workload Automation database schema objects were created. The new backup master domain manager or backup dynamic domain manager is configured to point to the existing database instance.
On Windows operating systems
```
cscript configureDb.vbs --rdbmstype db_vendor --dbhostname db_hostname --dbport db_port 
--dbname db_name --dbuser db_user  --componenttype server_component 
--dbadminuser db_administrator --dbadminuserpw db_administrator_password
--iwstsname tablespace_data --iwslogtsname tablespace_log --iwsplantsname tablespace_plan
```
On UNIX operating systems
```
./configureDb.sh --rdbmstype db_vendor --dbhostname db_hostname --dbport db_port 
--dbname db_name --dbuser db_user  --componenttype server_component   
--dbadminuser db_administrator --dbadminuserpw db_administrator_password
--iwstsname tablespace_data --iwslogtsname tablespace_log --iwsplantsname tablespace_plan
```
where:

--rdbmstype

The database vendor.

--dbhostname db_hostname

The host name or IP address of database server.

--dbport db_port

The port of the database server.

--dbname db_name

The name of the HCL Workload Automation database.

--dbuser db_user

The user that has been granted access to the HCL Workload Automation tables on the database server.

--dbpassword db_password

The password for the user that has been granted access to the HCL Workload Automation tables on the database server. Special characters are not supported.

--dbadminuser db_admin_user

The database administrator user that creates the HCL Workload Automation schema objects on the database server.

--dbadminuserpw db_admin_password

The password of the DB administrator user that creates the HCL Workload Automation schema objects on the database server. Special characters are not supported.

--componenttype MDM | DDM

The HCL Workload Automation component for which the database is installed. This parameter is optional. Supported values are:

MDM

master domain manager.

DDM

dynamic domain manager.

--iwstsname tablespace_data

The name of the tablespace for HCL Workload Automation data. The default value for all supported RDBMS is TWS_DATA, with the exception of Oracle where the default is USERS.

--iwslogtsname tablespace_log

The name of the tablespace for the HCL Workload Automation log. The default value for all supported RDBMS is TWS_LOG, with the exception of Oracle where the default is USERS.

--iwsplantsname db_port

The name of the tablespace for the HCL Workload Automation plan. The default value for all supported RDBMS is TWS_PLAN, with the exception of Oracle where the default is USERS.

--auth_type db_name

The MSSQL authentication mode. The default is SQLSERVER which uses native SQL authentication.
You can optionally point the backup master domain manager to different database residing on the sane workstation. For more information, see Connecting the master domain manager to a new database.
Note: The following parameters specified with the configureDb command are also required when you upgrade the server components with the serverinst command and their values must be the same:
- rdbmstype
- dbhostname
- dbport
- dbname
- dbuser
- dbpassword

Results

You have now successfully upgraded the database schema for the HCL Workload Automation database.

What to do next

You can now proceed to Installing a new dynamic domain manager configured as a backup or to Installing the new master domain manager configured as a backup.