Configuring HCL Workload Automation using templates

Starting from version 9.5, HCL Workload Automation has moved from WebSphere Application Server to WebSphere Application Server Liberty Base. As a result, the utilities known as wastools have been replaced with a number of templates addressing widely used configurations.

Starting from version 10.2, HCL Workload Automation supports both WebSphere Application Server Liberty Base and Open Liberty. In this topic, the term WebSphere Application Server Liberty is used to indicate both products.

You can now configure WebSphere Application Server Liberty to work with HCL Workload Automation using the templates provided or define your custom .xml files containing your own configuration settings. Templates are available for both the master domain manager and the Dynamic Workload Console.

See Correspondence between wastools and templates to find the mapping between wastools and templates. The table indicates both the file containing the current configuration in use, as well as the template files available to modify the current configuration.

Templates for the master domain manager are stored in the following paths:
On UNIX operating systems
TWA_home/usr/servers/engineServer/configDropins/templates
On Windows operating systems
TWA_home\usr\servers\engineServer\configDropins\templates
Templates for the Dynamic Workload Console are stored in the following paths:
On UNIX operating systems
DWC_home/usr/servers/dwcServer/configDropins/templates
On Windows operating systems
DWC_home\usr\servers\dwcServer\configDropins\templates
When you edit the file with your customized settings for the master domain manager, move it to the following paths:
On UNIX operating systems
TWA_DATA_DIR/usr/servers/engineServer/configDropins/overrides
On Windows operating systems
TWA_home\usr\servers\engineServer\configDropins\overrides
When you edit the file with your customized settings for the Dynamic Workload Console, move it to the following paths:
On UNIX operating systems
DWC_DATA_dir/usr/servers/dwcServer/configDropins/overrides
On Windows operating systems
DWC_home\usr\servers\dwcServer\configDropins\overrides
Note: Do not edit the files in the templates directory because they will be overwritten when upgrading to new version or fix pack.

To configure WebSphere Application Server Liberty to work with HCL Workload Automation, use the template files provided in the templates folder or create your custom .xml files containing your configuration settings. WebSphere Application Server Liberty retrieves the .xml files from the overrides folder and applies the configuration settings defined in each file. The file name is irrelevant, because WebSphere Application Server Liberty analyzes each .xml file for its contents.

The template files provided refer to commonly used configurations. If you want to implement different configurations, for example a custom authorization mechanism, you can create a custom.xml file, containing your configuration settings in this section: 
<server description="My custom configuration description">
    
    </server>

Ensure you remove any obsolete .xml files, to prevent WebSphere Application Server Liberty from parsing unwanted files.

If you use the provided templates, ensure you follow this procedure:
  1. Copy the template file from the templates folder to a working folder.
  2. Edit the template file in the working folder with the desired configuration.
  3. Optionally, create a backup copy of the relevant configuration file present in the overrides directory in a different directory. Ensure you do not copy the backup file in the path where the template files are located.
  4. Copy the updated template file to the overrides folder. Maintaining the original folder structure is not required.
  5. Changes are effective immediately.
Table 1. Correspondence between wastools and templates
Function Current configuration file in use Template file for customization wastool
Datasource settings overrides/datasource.xml templates/datasources/datasource_vendor.xml

changeDataSourceProperties

showDataSourceProperties
Hostname and port settings
  • overrides/host_variables.xml
  • overrides/ports_variables.xml
  • Not applicable. The host_variables.xml file is very simple and therefore is located only in the overrides folder.
  • templates/ports_variables.xml

changeHostProperties

showHostProperties
Authentication settings overrides/wauser_variables.xml Not applicable. The wauser_variables.xml file is very simple and therefore is located only in the overrides folder. changePassword
Trace settings Traces are disabled by default, so no file is present in the overrides folder. Copy the trace.xml file to the overrides folder to enable traces. templates/trace.xml changeTraceProperties
z/OS engine settings for the Dynamic Workload Console overrides/connectionFactory.xml zconnector/connectionFactory.xml createZosEngine (Dynamic Workload Console installation only)
SSL connections and certificates
  • overrides/authentication_config.xml
  • overrides/ssl_variables.xml
File-based:
authentication/auth_basicRegistry_config.xml
IBM® Directory Server:
authentication/auth_IDS_config.xml
OpenLDAP:
authentication/auth_OpenLDAP_config.xml
Microsoft Server Active Directory:
authentication/auth_AD_config.xml
OpenID:
authentication/openid_connect.xml
ssl_variables.xml

showSecurityProperties

changeSecurityProperties
Json Web Token (JWT) management overrides/jwt_variables.xml Not applicable Not applicable
Templates are divided into the following directories:
defaults (files used by the installation process)
  • ports_config.xml
  • ports_variables.xml
  • ssl_config.xml
  • ssl_variables.xml
overrides (configuration files)
  • authentication_config.xml
  • connectionFactory.xml (Dynamic Workload Console installation only)
  • datasource.xml
  • host_variables.xml
  • jvm.options
  • ports_variables.xml
  • ssl_variables.xml
  • wauser_variables.xml
templates (templates available for customization)
authentication
  • auth_AD_config.xml
  • auth_basicRegistry_config.xml
  • auth_IDS_config.xml
  • auth_OpenLDAP_config.xml
  • openid_connect.xml
datasources
  • datasource_db2.xml
  • datasource_derby.xml (Dynamic Workload Console installation only)
  • datasource_ids.xml (also for oneDB)
  • datasource_mssql.xml
  • datasource_oracle.xml
zconnectors (Dynamic Workload Console installation only)
  • connectionFactory.xml
  • ports_variables.xml
  • ssl_variables.xml
  • trace.xml
  • adminCenter.xml (Not recommended for production environment)

For information about how to change database properties, see Changing the properties for the database.

For information about authentication settings, see Configuring authentication.

For information about configuring a z/OS engine, see Defining a z/OS engine in the Z connector.