HCL Workload Automation, Version 9.4

The HCL Workload Automation response file properties

The following tables describe the properties that are used in the HCL Workload Automation response file:
Note:
  1. All values must be written between single quotation marks ('), for example: <data key='user.finalJob,com.ibm.tws' value='false'/>
  2. Properties are written in mixed case for ease of reading, but are not case-sensitive
  3. Keywords (for example, "true") used in values, are not case-sensitive.
Table 1. General information
Name Description Permitted values 
id
 The HCL Workload Automation profile ID.
Fresh installation
The value must be HCL Workload Automation. Do not modify this value.
 
installLocation
 The HCL Workload Automation installation directory. For more information about possible values for the installation directory , see Installation procedure for master domain manager and its backup or Installation procedure for a dynamic domain manager or its backup. 
user.offeringId
 The offering ID. The value must be com.ibm.tws. Do not modify this value. 
user.isSilentUpgrade
 The value that indicates if you are performing an upgrade or a fresh installation in silent mode.
true
Upgrade silent process
false
Installation silent process
Table 2. User information
Name Description Permitted values 
user.userName
 Specify the HCL Workload Automation user name. For more information about HCL Workload Automation user names, see HCL Workload Automation user information. 
user.password
 Specify the HCL Workload Automation encrypted password. For more information about password encryption, see Encrypting user passwords for response files. For more information about HCL Workload Automation user passwords, see HCL Workload Automation user information.
Table 3. Upgrade configuration (only for upgrade)
Name Description Permitted values 
user.backupDir
 Specify the fully qualified path of the backup directory where you back up the HCL Workload Automation instance data. The default value must be:
On Windows operating systems
The Administrator temporary directory.
On UNIX and Linux operating systems
$TEMP.
Table 4. Master configuration
Name Description Permitted values 
user.mdmIsBackup
 Specify if you want to install the instance as a master domain manager or a backup master domain manager.
true
the installation process configure the HCL Workload Automation installed as backup master domain manager.
false
the installation process configure the HCL Workload Automation installed as master domain manager.
By default, the value is set to false.		 
user.mdmCompany
 Company name. For information related to the master domain manager configuration, see HCL Workload Automation master configuration. 
user.mdmWorkstation
 The name of the workstation where you are installing the component. For information related to the master domain manager configuration, see HCL Workload Automation master configuration. 
user.mdmRemoteWorkstation
 The name of the master domain manager workstation. For information related to the master domain manager, see HCL Workload Automation master configuration. 
user.mdmPort
 The port used by the netman process of this workstation. For information related to the master domain manager configuration, see HCL Workload Automation master configuration. 
user.dynamicAgentHostname
 The fully qualified host name or IP address of the dynamic agent. For information related to the configuration of the dynamic scheduling, see HCL Workload Automation master configuration. 
dynamicAgentWorkstation
 The name of the dynamic agent workstation. For information related to the configuration of the dynamic scheduling, see HCL Workload Automation master configuration. 
dynamicAgentJobManagerPort
 The dynamic agent secure port number (SECUREADDR). For information related to the configuration of the dynamic scheduling, see HCL Workload Automation master configuration. 
user.finalJob
 Add the final job stream to the database. This option allows you to perform automatic production plan extension at the end of each current production plan processing. This option is available only if you are installing a master domain manager.
true
Add the final job stream
false
Do not add the final job stream
By default, the value is set to false. 
user.eventProcessorPort
 The port used by the event management processor to receive events. For information related to the configuration of the Event driven workload automation, see HCL Workload Automation master configuration. 
user.dwbWorkstation
 Use only if user.mdmIsBackup is set to false. The definition of the dynamic workload broker workstation created in the HCL Workload Automation database. The master domain manager name followed by _DWB. For information related to dynamic workload broker scheduling component configuration, see HCL Workload Automation master configuration. 
user.dwbPort
 Use only if user.mdmIsBackup is set to false. The port of the dynamic workload broker workstation that you will create in the HCL Workload Automation database. The HCL Workload Automation engine and the dynamic workload broker component communicate using this port. For information related to thedynamic workload broker scheduling component configuration, see HCL Workload Automation master configuration. 
user.dwbHostname
 Use only if user.mdmIsBackup is set to true. The fully qualified host name or IP address of the remote workstation where isdynamic workload broker. For information related to the dynamic workload broker scheduling component configuration, see HCL Workload Automation master configuration. 
user.dwbHttpsPort
 Use only if user.mdmIsBackup is set to true. The HTTPS port of the remote dynamic workload broker. For information related to the dynamic workload broker scheduling component configuration, see HCL Workload Automation master configuration. 
user.symbolicLink
 Only on UNIX operating systems. Choose whether to create symbolic links to /usr/bin directory (see Table 1 for more details).
true
Symbolic links are created.
false
Symbolic links are not created.
Table 5. Dynamic domain manager configuration
Name Description Permitted values 
user.ddmIsBackup
 Specify if you want to install the instance as dynamic domain manager or backup dynamic domain manager.
true
The installation process configure the HCL Workload Automation installed as backup dynamic domain manager.
false
The installation process configure the HCL Workload Automation installed as dynamic domain manager.
By default, the value is set to false.		 
user.ddm2ZosOnly
 Only for dynamic domain manager. Specify if you want to connect the dynamic domain manager only to the z/OS controller or to a master domain manager or to both a master domain manager and a z/OS controller.
true
You connect the dynamic domain manager only to the z/OS controller.
false
You connect the dynamic domain manager to the z/OS controller and master domain manager.
By default, the value is set to false.		 
user.ddmDomainName
 Only for both user.ddm2ZosOnly set to "false" and for user.ddmIsBackup set to "false". Specify the HCL Workload Automation domain name managed by the dynamic domain manager. The default value is DYNAMICDM. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.ddmWorkstation
 Only for user.ddm2ZosOnly set to "false". The name of the dynamic domain manager workstation. The user.ddmWorkstation and user.ddmMasterWorkstation values must not be the same. The default is the hostname of the workstation. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.ddmMasterWorkstation
 Only for user.ddm2ZosOnly set to "false". The name of the master domain manager. The user.ddmWorkstation and user.ddmMasterWorkstation values must not be the same. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.ddmPort
 Only for user.ddm2ZosOnly set to "false". The port used by Netman on the system on which the component is installed. The default value is 31111. The valid range is from 1 to 65535. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.dwbMasterHostname
 Only for both user.ddm2ZosOnly set to "false" and for user.ddmIsBackup set to "false". The fully qualified host name on which the dynamic domain manager contacts the master domain manager. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.dwbMasterHttpsPort
 Only for both user.ddm2ZosOnly set to "false" and for user.ddmIsBackup set to "false". The dynamic agent component installed on the dynamic domain manager instance uses this port to connect to the dynamic workload broker installed on the master domain manager instance. The default value is 31116. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.dynamicAgentHostname
 The fully qualified host name or IP address of the dynamic agent component installed on the dynamic domain manager instance. The agents contact the dynamic domain manager by using this address. The dynamic workload broker and the IBM Workload Scheduler for z/OS controller use this address to connect to the dynamic agent. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.dynamicAgentWorkstation
 The name of the dynamic agent workstation definition component installed on the dynamic domain manager instance. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.dynamicAgentJobManagerPort
 The JobManager secure port number. The HCL Workload Automation for z/OS controller and the Dynamic workload broker use this port to connect to the HCL Workload Automation dynamic agent. The default value is 31114. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.ddmEnableJobManagerHttps
 This option enables HTTPS communication between the local Dynamic workload broker and the dynamic agent. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.dwbWorkstation
 Only for dynamic domain manager. The definition of the Dynamic workload broker workstation created in the HCL Workload Automation database. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration. 
user.dwbPort
 Only for dynamic domain manager. The port used by the HCL Workload Automation dynamic domain manager to communicate with the local Dynamic workload broker component. The default value is 41114. The valid range is from 1 to 65535. For information related to the configuration of the dynamic domain manager, see HCL Workload Automation dynamic domain manager configuration.
Table 6. Database configuration
Name Description Permitted values 
user.dbType
 Choose which type of RDBMS support you want to use, DB2®, Oracle, or Other (Informix® Dynamic Server or Microsoft SQL Server).
DB2®
DB2 RDBMS
oracle
Oracle RDBMS
others
Informix® Dynamic Server or Microsoft SQL Server. See Database configuration for more information about configuration scripts you must run to complete the installation for these RDBMSs.
 
user.dbPath
 The installation directory of the DB2 or Oracle database. For more information about RDBMS configuration, see
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
Oracle
Installing for an Oracle database
 
user.db2IsClient
 Specify if the DB2 you use is a server edition or a client edition.
true
DB2 client
false
DB2 server
 
user.db2UserName
 The user name of the administrator of the DB2 server instance.
If the DB2 administrator already created the database tables using the procedure Creating or upgrading the database schema if you are using DB2, the user name is the one that the DB2 administrator specified in the DB_USER property in the customizeDB2SQL.properties file. The default value is:
On Windows operating systems
db2admin.
On UNIX and Linux operating systems
db2inst1.

If the DB2 administrator already upgraded the database tables using the procedure Creating or upgrading the database schema if you are using DB2, the user name is the one that the DB2 administrator specified in the DB_UPGRADE_USER field. You must assign SYSMON authority to the user you specified in the DB_UPGRADE_USER field.

 For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2Password
 The encrypted password of the DB2 server administrator user, or of the user with SYSADM or SYSCTRL authority. For more information about password encryption, see Encrypting user passwords for response files. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2Name
 The name of the DB2 database. The default is TWS. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2LocalAdminUserName
 Only if user.db2IsClient is set to true. The DB2 local admin user. For more information about DB2 configuration, see:
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2IsDifferentUser
 Only if user.db2IsClient is set to true. Specify if the HCL Workload Automation DB2 user is different from the DB2 Administrator user.
true
DB2 user is different from the DB2 Administrator user
false
DB2 user is NOT different from the DB2 Administrator user
 
user.db2TWSUserName
 Only if user.db2IsDifferentUser is set to true. The name of the HCL Workload Automation DB2 user different from the DB2 Administrator user. For more information about DB2 configuration, see:
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2TWSPassword
 Only if user.db2IsDifferentUser is set to true. The encrypted password of the HCL Workload Automation DB2 user different from the DB2 Administrator user. For more information about password encryption, see Encrypting user passwords for response files. For more information about DB2 configuration, see:
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2DataTableSpaceName
 The name of the DB2 instance tablespace for storing scheduling objects and event rules. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2DataTableSpacePath
 The relative path of the DB2 table space for storing scheduling objects and event rules. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2ReportTableSpaceName
 The name of the table space for storing report data. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2ReportTableSpacePath
 The path of the table space for storing report data. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2PlanTableSpaceName
 The name of the table space for storing planning data. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2PlanTableSpacePath
 The path of the table space for storing planning data. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2InstanceName
 The name of the DB2 server instance. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2InstancePort
 The TCP/IP port number used to communicate with the DB2 instance. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2Hostname
 Only if user.db2IsClient is set to true. The hostname of the workstation where the DB2 server is installed. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.db2Port
 Only if user.db2IsClient is set to true. The port of the remote workstation where the DB2 server is installed. For more information about DB2 configuration, see:
DB2 Server
Installing and upgrading for a DB2 database server
DB2 Client
Installing and upgrading for a DB2 database client
 
user.oracleNetServiceName
 The name used by clients to identify an Oracle Net server and the specific system identifier or database for the Oracle Net connection. For more information about Oracle configuration, see:Installing for an Oracle database. 
user.oracleUserName
 The database administrator user name (such as SYSTEM) required to authenticate to the Oracle database.

If the ORACLE administrator already created the database tables using the procedure Creating or upgrading the database tables if you are using Oracle, the user name is the one that the ORACLE administrator specified in the MDL_USER property of the customizeORACLESQL.properties file.

 For more information about Oracle configuration, see:Installing for an Oracle database. 
user.oraclePassword
 The database administrator user encrypted password required to authenticate to the Oracle database. For more information about password encryption, see Encrypting user passwords for response files. For more information about Oracle configuration, see:Installing for an Oracle database. 
user.oracleTWSUserName
 The owner of the HCL Workload Automation schema. For more information about Oracle configuration, see:Installing for an Oracle database. 
 user.oracleTWSPassword
 The database administrator user password required to authenticate to the Oracle database. For more information about Oracle configuration, see:Installing for an Oracle database. 
user.oraclePartitioningOption
 Specify whether the event-driven workload automation database schema is to be created using the Oracle Partitioning feature.
true
The Oracle Partitioning feature is used when creating the event-driven workload automation database schema.
false
The Oracle Partitioning feature is NOT used when creating the event-driven workload automation database schema.
 
user.oracleDataTableSpace
 The name that identifies the HCL Workload Automation data table space. For more information about Oracle configuration, see Installing for an Oracle database. 
user.oracleReportTableSpace
 The name that identifies the HCL Workload Automation table space where report data is to be stored. For more information about Oracle configuration, see Installing for an Oracle database. 
user.oraclePlanTableSpace
 The name that identifies the HCL Workload Automation table space where planning data is to be stored. For more information about Oracle configuration, see Installing for an Oracle database. 
user.oracleTempTableSpace
 The name that identifies the HCL Workload Automation temporary table space. For more information about Oracle configuration, see Installing for an Oracle database. 
user.dbJDBCHost
 Only for an upgrade. The host name or IP address of the remote workstation where the Oracle server is installed. For more information about Oracle configuration, see Installing for an Oracle database. 
user.dbJDBCPort
 Only for an upgrade. The port of the remote Oracle server. The default port number is: 1521 
user.dbJDBCOracleNetServiceName
 Only for an upgrade. The Oracle Service Name of the HCL Workload Automation database. The default value is orcl.
Table 7. WebSphere configuration
Name Description Permitted values 
user.wasInstallLocation
 The directory where you installed the WebSphere Application Server. For more information about the configuration of the WebSphere Application Server profile, see WebSphere Application Server profile configuration. 
user.createNewWasProfile
 Specify if you want to use an existent profile or you want create a new one.
true
Installation process create a new profile in theWebSphere Application Server.
false
Installation process uses a profile already created and used in the WebSphere Application Server.
The default is true.		 
user.wasProfileLocation
 The location where the WebSphere Application Server profile is saved. For more information about the configuration of the WebSphere Application Server profile, see WebSphere Application Server profile configuration. 
user.wasProfileName
 The name of the WebSphere Application Server profile you are using. For more information about the configuration of the WebSphere Application Server profile, see WebSphere Application Server profile configuration. 
user.wasHostname
 The IP address or fully qualified hostname of the WebSphere Application Server server related to the profile you are using. For more information about the configuration of the WebSphere Application Server profile, see WebSphere Application Server profile configuration. 
user.wasServerName
 The name of the WebSphere Application Server server related to the profile you are using. For more information about the configuration of the WebSphere Application Server profile, see WebSphere Application Server profile configuration. 
user.wasNodeName
 The name of the WebSphere Application Server node related to the profile you are using. For more information about the configuration of the WebSphere Application Server profile, see WebSphere Application Server profile configuration. 
user.wasCellName
 Supply the WebSphere Application Server cell name for the WebSphere Application Server profile that you are using. For more information about the configuration of the WebSphere Application Server profile, see WebSphere Application Server profile configuration. 
user.wasAdminConsolePort
 Administration HTTP transport port. For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration. 
user.wasAdminConsoleSecurePort
 Administration HTTPS transport port. For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration. 
user.wasHTTPPort
 HTTP transport port For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration. 
user.wasHTTPSPort
 HTTPS transport port For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration. 
user.
wasCSIV2ClientAuthListenerPort
 CSIv2 Client Authentication Listener port For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration. 
user.wasORBListenerPort
 ORB Listener port For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration. 
user.wasBootstrapPort
 Bootstrap port For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration. 
user.wasSASServerAuthPort
 SAS Server Authentication Listener port For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration. 
user.wasSOAPConnectorPort
 SOAP connector port For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration. 
user.
wasCSIV2ServerAuthListenerPort
 CSIv2 Server Authentication Listener port For more information about WebSphere configuration ports, see WebSphere Application Server ports configuration.
Table 8. Offering and features to install
Name Description Permitted values 
modify
 The following property is used by silent installation as-is, and must not be modified. This Boolean field specify if the installation process is modifying the product already installed. Do not modify the value in the response file. 
offering id
 The following property is used by silent installation as is, and must not be modified. The offering ID. Do not modify the value in the response file. 
profile
 The following property is used by silent installation as is, and must not be modified. The profile name.
Fresh installation
The value must be HCL Workload Automation. Do not modify this value.
 
feature
 The following property is used by silent installation as is, and must not be modified. The feature name. The value must be:
Master domain manager or backup master domain manager
tws.mdm
Dynamic domain manager or backup dynamic domain manager
tws.ddm
Do not modify the value in the response file.		 
installFixes
 The following property is used by silent installation as is, and must not be modified. This Boolean field specify if the installation process is installing fixes of the product. Do not modify the value in the response file.