Database configuration - configureDb script

This script creates and populates the IBM Workload Scheduler database

This script is typically used by the database administrator for creating and populating the IBM Workload Scheduler 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 IBM Workload Scheduler database.

You can specify values in the properties file, type them in the command line, or use both methods. If a parameter is specified both in the properties file and in the command line, the command line value takes precedence.

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 | DWC ]
       [--dbadminuser db_admin_user]
       --dbadminuserpw db_admin_password
       --rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL | POSTGRESQL
       [--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]

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


       [--lang lang_id]
       [--work_dir working_directory]
       [--wlpdir wlp_directory]
       [--componenttype MDM | DDM | DWC ]
       [--dbadminuser db_admin_user]
       --dbadminuserpw db_admin_password
       --rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL  | POSTGRESQL
       [--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 ]

Oracle-only configuration options


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

DB2- and PostgreSQL-only security options


   [--sslkeysfolder  keystore_truststore_folder]
   [--sslpassword ssl_password]
   [--dbsslconnection true | false]

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


       [--lang lang_id]
       [--work_dir working_directory]
       [--wlpdir wlp_directory]
       [--dbadminuser db_admin_user] 
       [--componenttype DWC ]
       --dbadminuserpw db_admin_password
       --rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL | POSTGRESQL
       [--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 server components is image_location/TWS/interp_name/configureDb.properties, while the default file for the Dynamic Workload Console is image_location/configureDb.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 MDM | DDM | DWC

The IBM® Workload Scheduler component for which the database is installed. This parameter is optional. Supported values are:

MDM: master domain manager. Applies only to distributed operating systems.
DDM: dynamic domain manager. Applies only to distributed operating systems.
DWC: Dynamic Workload Console (it comprises the Federator).

--dbadminuser db_admin_user

The database administrator user who creates the IBM Workload Scheduler or Dynamic Workload Console schema objects on the database server. This parameter is optional. Depending on the database vendor, the default values are as follows:

db2admin: when --rdbmstype is set to DB2
sysadm: when --rdbmstype is set to DB2Z
system: when --rdbmstype is set to ORACLE
sa: when --rdbmstype is set to MSSQL

--dbadminuserpw db_admin_password

The password for the DB administrator user who creates the IBM Workload Scheduler schema objects on the database server. This parameter is required. Special characters are not supported. You can optionally encrypt the password. For more information, see Encrypting passwords (optional).

--rdbmstype|-r rdbms_type

The database type. Supported databases are:

DB2
ORACLE
MSSQL This value applies to MSSQL and supported MSSQL cloud-based databases.
POSTGRESQL

This parameter is required and has no default value.

--dbname db_name

The name of the IBM Workload Scheduler or Dynamic Workload Console database. This parameter is optional and case sensitive. Depending on the component that you are installing and the database vendor, the default values are as follows:

When installing the server components

TWS: when --rdbmstype is set to DB2
orcl: when --rdbmstype is set to ORACLE
TWS: when --rdbmstype is set to MSSQL
null: when --rdbmstype is set to DB2z
TWS: when --rdbmstype is set to POSTGRESQL

When installing the Dynamic Workload Console

This parameter is optional and case sensitive. Depending on the component that you are installing and the database vendor, the default values are as follows:

TDWC: when --rdbmstype is set to DB2
TDWC: when --rdbmstype is set to DB2Z
orcl: when --rdbmstype is set to ORACLE
TDWC: when --rdbmstype is set to MSSQL
TDWC: when --rdbmstype is set to POSTGRESQL

--dbuser db_user

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

When installing the server components

db2tws: when --rdbmstype is set to DB2
twsora: when --rdbmstype is set to ORACLE
sa: when --rdbmstype is set to MSSQL
null: when --rdbmstype is set to DB2Z
postgres: when --rdbmstype is set to POSTGRESQL

When installing the Dynamic Workload Console

db2dwc: when --rdbmstype is set to DB2
root: when --rdbmstype is set to DB2Z
twsora: when --rdbmstype is set to ORACLE
sa: when --rdbmstype is set to MSSQL

--dbport db_port

The port of the database server. This parameter is optional. Depending on the database vendor, the default values are as follows:

50000: when --rdbmstype is set to DB2
446: when --rdbmstype is set to DB2Z
1521: when --rdbmstype is set to ORACLE
1433: when --rdbmstype is set to MSSQL
5432: when --rdbmstype is set to POSTGRESQL

--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.

--iwstsname|-tn table_space_name

The name of the tablespace for IBM Workload Scheduler or Dynamic Workload Console 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:

For all operating systems, except z/OS: TWS_DATA
For z/OS operating system: TWSDATA

--iwstspath|-tp table_space

The path of the tablespace for IBM Workload Scheduler or Dynamic Workload Console data. This parameter is optional. The default value for all databases other than Oracle is:

For all operating systems, except z/OS: TWS_DATA
For z/OS operating system: TWSDATA

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 IBM Workload Scheduler 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 server components.

--iwslogtspath|-lp log_path_table_space

The path of the tablespace for IBM Workload Scheduler log. This parameter is optional. The default value for all databases other than Oracle is TWS_LOG. This parameter applies only to the server 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 IBM Workload Scheduler 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 server components.

--iwsplantspath|-pp plan_path_table_space

The path of the tablespace for IBM Workload Scheduler plan. This parameter is optional. The default value for all databases other than Oracle is TWS_PLAN. This parameter applies only to the server components.

Only on Windows systems hosting an MSSQL database, ensure that 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 parameter applies only to Windows operating systems. Specify the authentication type. Supported values are as follows:

SQLSERVER: Enables MSSQL authentication type. Only the user specified with the --dbadminuser parameter has the grants to administer the IBM Workload Scheduler 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 IBM Workload Scheduler 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 IBM Workload Scheduler or Dynamic Workload Console tables on the database server. This parameter is required only if you are using an Oracle database. Special characters are not supported. 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 IBM Workload Scheduler 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.

DB2- and PostgreSQL-only security options

--sslkeysfolder keystore_truststore_folder

The name and path of the folder containing certificates in .PEM format. The installation program automatically processes 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. Note that if certificates being installed are part of a chain consisting of 3 or more certificates (one Root CA, followed by one or more Intermediate CAs, followed by the end user certificate), then this file must contain the Root CA certificate only. Any Intermediate CA certificates must be stored in the additionalCAs subfolder, which therefore becomes a mandatory subfolder. Each Intermediate CA must be stored in the additionalCAs subfolder in its own file.
Note: From V10.2.3, if certificates being installed are part of a chain, the ca.crt can contain also the intermediate CAs. In this case, it must begin with one or more intermediate CA certificates and end with the Root ca.
tls.key

The private key of the end user certificate for the instance to be installed.
tls.crt

The public part of the previous key, that is the end user certificate.

For UNIX systems, ensure that all the files have the ownership of the user who installed the master domain manager and the correct permissions (644).

You can optionally create a subfolder to contain one or more *.crt files to be added to the server truststore as trusted CA, whose name must be additionalCAs. 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. Note that if the end user certificate being installed in the instance is part of a chain consisting of 3 or more certificates (one Root CA, followed by one or more Intermediate CAs, followed by the end user certificate), then the Intermediate CAs certificates must be stored in the additionalCAs subfolder, which therefore becomes a mandatory subfolder. Each Intermediate CA must be stored in the additionalCAs subfolder in its own file.

For further information about how to generate custom certificates, see Managing certificates using Certman.

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

--sslpassword ssl_password

The password for the custom certificates and the path to the folder containing certificates in .PEM format with the sslkeysfolder parameter.

For more information, see sslkeysfolder.

You can optionally encrypt the password using the secure script. For more information, see Optional password encryption - secure script.

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

--dbsslconnection: Specify whether you want to enable SSL connection to the database. Supported values are true and false. The default value is false. If you set this parameter to true, the sslkeysfolder and sslpassword parameters become mandatory.

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