Database configuration - configureDB script

This script creates and populates the HCL Workload Automation database

This script is typically used by the database administrator for creating and populating the HCL Workload Automation database. For a typical scenario, see Creating and populating the database.

This section lists and describes the parameters that you can use to create and populate the HCL Workload Automation database.

When running the command, you can type parameters and values from a properties file, type them in the command line, or use a combination of both properties file and command line. If a parameter is specified both in the properties file and in the command line, the command line value is used.

The log files generated from this command are located in the following path:

On Windows operating systems: TWA_home\logs
On UNIX operating systems: TWA_DATA_DIR/installation/logs

On z/OS operating system: TWA_DATA_DIR/installation/logs

Syntax for Windows operating systems

Show command usage

configureDb -? | --usage | --help

Retrieve the command parameters and values from a file

configureDb --propfile | -f  [property_file]

General information


       [--lang lang_id]
       [--work_dir working_directory]
       [--wlpdir wlp_directory]
       [--componenttype MDM | DDM]
       [--dbadminuser db_admin_user]
       --dbadminuserpw db_admin_password
       [--rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL]

The following configuration information for the data source is ignored if --rdbmstype is followed by DERBY:


       [--dbname db_name]
       [--dbuser db_user]
       [--dbport db_port]
       --dbhostname db_hostname
       [--dbdriverpath db_driver_path]
       --auth_type aythentication_type ]
       [--iwstsname table_space_name]
       [--iwstspath table_space_path]
       [--iwslogtsname log_table_space]
       [--iwslogtspath log_path_table_space]
       [--iwsplantsname plan_table_space]
       [--iwsplantspath plan_path_table_space]
       [--execsql execute_sql]

Configuration options when dbsslconnection=true or customized certificates are used for SSL connections


   [--sslkeysfolder  keystore_truststore_folder]
   [--sslpassword ssl_password]

Oracle-only configuration options


       --dbpassword db_password
       [--usePartitioning true | false ]
       [--Usage_TsTempName IWS_temp_path]
       [--skipdbcheck true | false]

DB2 for z/OS-only configuration options


       [--zlocationname zOS_location_containing_db]
       [--zbufferpoolname buffer_pool_in_zOS_location]

Syntax for UNIX operating systems

Show command usage

configureDb -? | --usage | --help

Retrieve the command parameters and values from a file

configureDb --propfile | -f  [property_file]

General information


       configureDb
       [--lang lang_id]
       [--work_dir working_directory]
       [--wlpdir wlp_directory]
       [--componenttype MDM | DDM]
       [--dbadminuser db_admin_user]
       --dbadminuserpw db_admin_password
       [--rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL | IDS | DERBY]

The following configuration information for the data source is ignored if --rdbmstype is followed by DERBY:


       [--dbname db_name]
       [--dbuser db_user]
       [--dbport db_port]
       --dbhostname db_hostname
       [--dbdriverpath db_driver_path]
       [--informixserver db_server_name
       [--iwstsname table_space_name]
       [--iwstspath table_space_path]
       [--iwslogtsname log_table_space]
       [--iwslogtspath log_path_table_space]
       [--iwsplantsname plan_table_space]
       [--iwsplantspath plan_path_table_space]
       [--execsql execute_sql ]

Oracle-only configuration options


       --dbpassword db_password
       [--usePartitioning true | false ]
       [--Usage_TsTempName IWS_temp_path]
       [--skipdbcheck true | false]

Informix-only configuration options


       [--iwssbspace blob_clob_table_space]

Configuration options when dbsslconnection=true or customized certificates are used for SSL connections


   [--sslkeysfolder  keystore_truststore_folder]
   [--sslpassword ssl_password]

DB2 for z/OS-only configuration options


       [--zlocationname zOS_location_containing_db]
       [--zbufferpoolname buffer_pool_in_zOS_location]

Syntax for z/OS operating system

Show command usage

configureDb -? | --usage | --help

Retrieve the command parameters and values from a file

configureDb --propfile | -f  [properties_file]

General information


       configureDb
       [--lang lang_id]
       [--work_dir working_directory]
       [--wlpdir wlp_directory]
       
       [--dbadminuser db_admin_user]
       --dbadminuserpw db_admin_password
       [--rdbmstype|-r DB2Z | DERBY]

The following configuration information for the data source is ignored if --rdbmstype is followed by DERBY:


       [--dbname db_name]
       [--dbuser db_user]
       [--dbport db_port]
       --dbhostname db_hostname
       [--dbdriverpath db_driver_path]
       [--iwstsname table_space_name]
       [--iwstspath table_space_path]
       [--iwslogtsname log_table_space]
       [--iwslogtspath log_path_table_space]
       [--iwsplantsname plan_table_space]
       [--iwsplantspath plan_path_table_space]
       [--execsql execute_sql ]

DB2 for z/OS-only configuration options


       [--zlocationname zOS_location_containing_db]
       [--zbufferpoolname buffer_pool_in_zOS_location]

Database configuration parameters

-? | --usage | --help

Displays the command usage and exits.

--propfile|-f [properties_file]

Optionally specify a properties file containing custom values for configureDb parameters. The default file for the master components is image_location/TWS/interp_name/configureDbdatabase_vendor.properties, while the default file for the Dynamic Workload Console is image_location/configureDbdatabase_vendor.properties. Specifying a properties file is suggested if you have a high number of parameters which require custom values. You can also reuse the file with minimal modification for several installations. If you create a custom properties file, specify its name and path with the -f parameter.

--lang lang_id

The language in which the messages returned by the command are displayed. If not specified, the system LANG is used. If the related catalog is missing, the default C language catalog is used. If neither -lang nor LANG are used, the default codepage is set to SBCS. For a list of valid values for these variables, see the following table:

Table 1. Valid values for -lang and LANG parameter
Language	Value
Brazilian Portuguese	pt_BR
Chinese (traditional and simplified)	zh_CN, zh_TW
English	en
French	fr
German	de
Italian	it
Japanese	ja
Korean	ko
Russian	ru
Spanish	es

Note: This is the language in which the installation log is recorded and not the language of the installed component instance. The command installs all languages as default.

--work_dir

The working directory where you extract the installation image. It also contains the output produced by the command, such as the SQL statements if you set the execsql parameter to false. The default value is /tmp on UNIX operating systems and C:\tmp on Windows operating systems.

[--wlpdir wlp_directory]

The path to WebSphere Application Server Liberty Base installation directory. WebSphere Application Server Liberty Base is used to decrypt the passwords you provide in encrypted form. This parameter is required only if you encrypt your passwords with the {xor} or {aes} encoding.

--componenttype

The HCL Workload Automation component for which the database is installed. This parameter is optional and applies only to master components. If you are installing the Dynamic Workload Console, the script detects this automatically and proceeds accordingly. The default value is calculated at run time. Supported values are.

MDM: master domain manager
DDM: dynamic domain manager

--dbadminuser db_admin_user

The database administrator user that creates the HCL Workload Automation or Dynamic Workload Console schema objects on the database server. This parameter is optional. The default varies, depending on the database vendor, as follows:

db2admin: when --rdbmstype is followed by DB2
system: when --rdbmstype is followed by ORACLE
sa: when --rdbmstype is followed by MSSQL
informix: when --rdbmstype is followed by IDS

--dbadminuserpw db_admin_password

The password for the DB administrator user that creates the HCL Workload Automation schema objects on the database server. This parameter is required. You can optionally encrypt the password. For more information, see Encrypting passwords (optional).

--rdbmstype|-r rdbms_type

The database type. This parameter is optional. Supported databases are:

DB2. This is the default value for the master components.
DB2Z
Oracle
IDS. Applies to Informix and OneDB.
MSSQL. Applies to MSSQL and Azure SQL.
DERBY. Only applies to the Dynamic Workload Console. This is the default value for the Dynamic Workload Console.

--dbname db_name

The name of the HCL Workload Automation or Dynamic Workload Console database. This parameter is optional. The default varies, depending on the component you are installing and the database vendor, as follows:

When installing the master components

the following defaults apply:

TWS: when --rdbmstype is followed by DB2
orcl: when --rdbmstype is followed by ORACLE
TWS: when --rdbmstype is followed by MSSQL
TWS: when --rdbmstype is followed by IDS

When installing the Dynamic Workload Console

if you are using a Derby database, this parameter is not required. If you are using a different database, the following defaults apply:

TDWC: when --rdbmstype is followed by DB2
TDWC: when --rdbmstype is followed by DB2Z
orcl: when --rdbmstype is followed by ORACLE
TDWC: when --rdbmstype is followed by MSSQL
TDWC: when --rdbmstype is followed by IDS

--dbuser db_user

The database user that has been granted access to the HCL Workload Automation or Dynamic Workload Console tables on the database server. This parameter is optional. The default varies, depending on the component you are installing and the database vendor, as follows:

When installing the master components

the following defaults apply:

db2tws: when --rdbmstype is followed by DB2
twsora: when --rdbmstype is followed by ORACLE
sa: when --rdbmstype is followed by MSSQL
idstws: when --rdbmstype is followed by IDS

When installing the Dynamic Workload Console

the following defaults apply:

db2dwc: when --rdbmstype is followed by DB2
root: when --rdbmstype is followed by DB2Z
twsora: when --rdbmstype is followed by ORACLE
sa: when --rdbmstype is followed by MSSQL
idsdwc: when --rdbmstype is followed by IDS

--dbport db_port

The port of the database server. This parameter is optional. The default varies, depending on the database vendor, as follows:

50000: when --rdbmstype is followed by DB2
446: when --rdbmstype is followed by DB2Z
1521: when --rdbmstype is followed by ORACLE
1433: when --rdbmstype is followed by MSSQL
16175: when --rdbmstype is followed by IDS

--dbhostname db_hostname

The host name or IP address of database server. This parameter is required.

--dbdriverpath db_driver_path

The path where the database drivers are stored. This parameter is optional. By default, the configuration script references the JDBC drivers supplied with the product images. If your database server is not compatible with the supplied drivers, then contact your database administrator for the correct version to use with your database server and specify the driver path using this parameter. Ensure you provide the same path in the configureDb, serverinst, and dwcinst commands. For more information, see What if my database server does not support the drivers supplied with the product images?.

--informixserver

Specifies the name of the Informix or OneDB database server. This parameter is required only if --rdbmstype is set to IDS and is supported only on UNIX operating systems.

--iwstsname|-tn table_space_name

The name of the tablespace for HCL Workload Automation data. This parameter is optional for all databases with the exception of the Oracle database. The default value for all databases other than Oracle is TWS_DATA.

--iwstspath|-tp table_space_path

The path of the tablespace for HCL Workload Automation data. This parameter is optional. The default value for all databases other than Oracle is TWS_DATA. Only on Windows systems hosting an MSSQL database, ensure the folder for the tablespace is already existing before running the configureDb command and specify the path using this parameter. Specify the path using forward slashes (/), for example: c:/<my_path>/TWS_DATA.

--iwslogtsname|-ln log_table_space

The name of the tablespace for HCL Workload Automation log. This parameter is optional for all databases with the exception of the Oracle database. The default value for all databases other than Oracle is TWS_LOG. This parameter applies only to the master components.

--iwslogtspath|-lp log_path_table_space

The path of the tablespace for HCL Workload Automation log. This parameter is optional. The default value for all databases other than Oracle is TWS_LOG. This parameter applies only to the master components. Only on Windows systems hosting an MSSQL database, ensure the folder for the tablespace is already existing before running the configureDb command and specify the path using this parameter. Specify the path using forward slashes (/), for example: c:/<my_path>/TWS_LOG.

--iwsplantsname|-pn plan_table_space

The name of the tablespace for HCL Workload Automation plan. This parameter is optional for all databases with the exception of the Oracle database. The default value for all databases other than Oracle is TWS_PLAN. This parameter applies only to the master components.

--iwsplantspath|-pp plan_path_table_space

The path of the tablespace for HCL Workload Automation plan. This parameter is optional.The default value for all databases other than Oracle is TWS_PLAN. This parameter applies only to the master components. Only on Windows systems hosting an MSSQL database, ensure the folder for the tablespace is already existing before running the configureDb command and specify the path using this parameter. Specify the path using forward slashes (/), for example: c:/<my_path>/TWS_PLAN.

--execsql|-es execute_sql

Set to true to generate and run the SQL file, set to false to generate the SQL statement without running it. The resulting files are stored in the path defined in the --work_dir parameter. This option is useful if you wan to review the file before running it. This parameter is optional. The default value is true.

--auth_type

This argument applies to Windows operating systems only. Specify the authentication type. Supported values are as follows:

SQLSERVER: Enables MSSQL authentication type. Only the user specified with the --dbadminuser argument has the grants to administer the HCL Workload Automation or Dynamic Workload Console database.
WINDOWS: Enables Windows authentication type. The Windows user you used to log on to the workstation is assigned the grants to administer the HCL Workload Automation or Dynamic Workload Console database.

The default value is SQLSERVER.

Oracle-only configuration syntax

--dbpassword db_password: The password for the user that has been granted access to the HCL Workload Automation or Dynamic Workload Console tables on the database server. This parameter is required only if you are using an Oracle database. You can optionally encrypt the password. For more information, see Encrypting passwords (optional).
--usePartitioning: Only applies when installing the master domain manager. Set to true if you want to use the Oracle partitioning feature, otherwise set it to false. This parameter is optional. The default value is true.
--Usage_TsTempName IWS_temp_path: Only applies when installing the master domain manager. The path of the tablespace for HCL Workload Automation temporary directory. This parameter is optional. The default value is TEMP.
--skipdbcheck: This parameter specifies whether the check on the existence of the Workload Automation schema for the Oracle user is performed or not. By default, the parameter is set to false and a check is performed on the Oracle user. If the user does not exist, the script then proceeds to create the user and the Workload Automation schema.
If you have already created your Oracle user, set this parameter to true. As a result, the check is skipped and the schema creation is performed also if the Oracle user is already existing.
This parameter is optional.

Informix-only configuration syntax

--iwssbspace blob_clob_table_space: The name of the table space for blob and clob data. The default value is twssbspace.

DB2-only configuration syntax

--sslkeysfolder

The name and path of the folder, containing either the keystore (TWSServerKeyFile.jks) , the key database (TWSClientKeyStore.kdb), and the truststore (TWSServerTrustFile.jks, TWSClientKeyStoreJKS.jks) files, you need to provide when supplying custom certificates (only on UNIX operating systems), or certificates in .PEM format:

Only on UNIX operating systems, if you provide the keystore and truststore files, these files are used to configure SSL communication using the passwords you provide with the --keystorepassword and --truststorepassword respectively.
Note: When installing using the keystore, key database, and truststore files, you are required to manually configure these files prior the installation setup. If providing custom .jks files, it is your responsibility to provide such .jks files equipped with all the CA certificates they need in the truststore. For these reasons, this procedure is not recommended.
If you provide .PEM certificates, the installation program automatically generates the keystore and truststore files using the password you specify with the --sslpassword parameter. The folder must contain the following files:
- ca.crt
  
  The Certificate Authority (CA) public certificate.
- tls.key
  
  The private key for the instance to be installed.
- tls.crt
  
  The public part of the previous key.

You can optionally create a subfolder to contain one or more *.crt files to be added to the server truststore as trusted CA. This can be used for example to add to the list of trusted CAs the certificate of the LDAP server or DB2 server. Additionally, you can store here any intermediate CA certificate to be added to the truststore. The subfolder must be named additionalCAs.

This parameter is required if you set the --dbsslconnection parameter to true.

--sslpassword

If you provide .PEM certificates with the --sslkeysfolder parameter, this is the password for the certificates automatically generated by the installation program. This parameter is mutually exclusive with the keystorepassword and truststorepassword parameters, which apply when you provide the keystore and truststore files using the sslkeysfolder parameter.

DB2 for z/OS-only configuration syntax

--zlocationname zos_location_containing_db: The name of an already existing location in the z/OS environment that will contain the new database. The default value is LOC1.
--zbufferpoolname buffer_pool_in zos_location: The name of an already existing buffer pool created in the location specified by -zlocationname. The default value is BP32K.

Comments

Note: The following parameters are also required when installing the master components and their values must be the same:

--rdbmstype
--dbhostname
--dbport
--dbname
--dbuser