Install and Configure the Experience Service > Installation > Unattended Mode
  
Unattended Mode
Installation Options
The following table describes options used to control the behavior of the installer.
Option
Default Value
Description
authType
twxUser
Type of authentication method.
Allowed values are:
twxUser
openidUser
dbDatafileDir
C:\ptc\studio-es-store
Data file directory.
dbDatafileName
db.sqlite
Data file name.
debugtrace
None
Name of the debug file.
debuglevel
2
Determines the amount of information that is written to the installer log file. Valid values are:
0
1
2
3
4
0 corresponds to the least verbose setting and 4 corresponds to the most.
dbUseSsl
false
PostgreSQL Server requires TLS
help
None
Displays the list of valid options
httpsCertType
pem
Allowed values are:
pem
pem pfx
installer-language
en
Allowed values are:
en
ja
de
fr
ko
zh_CN
zh_TW
es
it
installDir
Linux: /opt/ptc/studio-es
Windows: C:\ptc\studio-es
The directory where the software is installed.
installType
new
The allowed values are as follows:
new—a new installation is created. In this case, – installDir must specify an empty directory
upgrade—an existing installation is upgraded. In this case, – installDir must specify a directory containing an existing installation of the Experience Service
isEncryptedPem
0
Encrypts the private key.
mode
win32
Allowed values are:
win32
unattended
mtgEnable
false
Enables Model Target generation.
pemPassphrase
None
Passphrase for PEM certificate.
protocol
https
Allowed values are:
https
http
twxAdminPwd
None
The password for the username specified in twxAdminUser.
twxAdminToken
None
This is only applicable if configuring for SSO.
twxAdminUser
Administrator
The username for an account that has Administrative permissions on your ThingWorx Server.
twxConfigurePublicAccess
true
The allowed values are as follows:
true—the ThingWorx server is configured to support public access
false—the ThingWorx server is not configured to support public access. For more information, see Configuring Public Access to ThingWorx.
unattendedmodeui
none
The following are allowed values:
none—no user interaction is required and no output is shown
minimal—no user interaction is required and a progress pop-up is displayed showing the installation progress
minimalWithDialogs—may require some user interaction depending on the specific installer logic
useSsl
true
The allowed values are as follows:
true—the installer configures the Experience Service to use the secure HTTPS protocol. In this case, the - sslKeyFile and sslCertFile options must specify paths to valid private key and public cert files
false—the Experience Service is configured to use the insecure HTTP protocol
version
None
Displays product information.
Configuration Options
The following table describes the options that are used to specify the values for configuration parameters requested by the installer. The last column provides the name of the equivalent configuration parameter. For more information, see Configuration Parameters.
Option
Default Value
Configuration Parameter
clientId
studio-es
clientSecret
dbDatafile
Linux: /srv/ptc/studio-es/db.sqlite
Windows: C:\ptc\studio-es-store\db.sqlite
db.datafile
dbHost
localhost
db.connectionString
dbName
None
db.connectionString
dbPort
5432
db.connectionString
dbPwd
None
db.connectionString
dbType
SQLiteHandler
dbHandler
dbUser
None
db.connectionString
defaultDomainName
<hostname>.local
defaultDomainName
esPort
2019
port
isEncryptedPfx
0
issuer
None
openidSessionTimeout
480 (minutes)
pfxCertFile
None
pfxPassphrase
None
projectsDir
Linux: /srv/ptc/studio-es/projects
Windows: C:\ptc\studio-es-store\projects
projects.store
redirectUri
None
repsDir
Linux: /srv/ptc/studio-es/reps
Windows: C:\ptc\studio-es-store\reps
reps.store
sslCaFile
(empty)
https_ca
sslCertFile
Linux: /opt/ptc/studio-es/cert/STAR_thingserver.crt
Windows: C:\ptc\studio-es\cert\STAR_thingserver.crt
http_crt
sslKeyFile
Linux: /opt/ptc/studio-es/cert/STAR_thingserver.key
Windows: C:\ptc\studio-es\cert\STAR_thingserver.key
https_key
twxUrl
http://localhost:8080/Thingworx
proxies.0.target
upgradeDir
Linux: /srv/ptc/studio-es/upgrade
Windows: C:\ptc\studio-es-store\upgrade
upgrade.store
Specify Options on the Command Line
As noted above, the installation options can be specified on the command line when running the installer in Unattended mode. In this case, two dashes (--) precede the name of the option. For example, to run the installer in Unattended mode with default values for all options, except the ThingWorx administrator password, use a command like the following:
Linux: $ <name of installer file>.run --mode unattended --twxAdminPwd secret
Windows: start /W <name of installer file>.exe --mode unattended --twxAdminPwd secret
Default values are used for options that are not specified on the command line.
Specify Options in an Options File
Instead of specifying the installation options on the command line when running the installer in Unattended mode, you can specify the options in an option file. An option file is a properties file that contains all of the parameters that are to be configured. The value for each option is specified on a separate line with the name of the option followed by an equals sign (=), then followed by the value of the option. The following is an example:
debuglevel=3
installDir=/opt/es
twxAdminUser=SuperUser
twxAdminPwd=secret
esPort=443
dbType=postgresHandler
dbHost=db.example.com
dbName=ES
dbUser=esdbuser
dbPwd=secret
Default values are used for options that are not specified in the option file.
To run the installer in Unattended mode, with options coming from an option file named install.options, use the following command:
Linux: $ <Name of installer file>.run --mode unattended --optionfile install.options
Windows: start /W <name of installer file>.exe --mode unattended --optionfile install.options