Configuring the PTC RV&S Client Properties File
The mksclient.properties file is located in the serverinstalldir/config/install directory. Review the following properties and update as required. Once the file is configured, make it accessible to all clients from a shared location.
 |
Since the silent installation is intended to be used without any user intervention, it is important that all information provided in the mksclient.properties file be valid.
|
|
Property
|
Description
|
||
|---|---|---|---|
|
INSTALLER_UI
|
Specifies what mode to use for installation. By default,+ property is set to silent, which installs client based on values in this properties file. To run GUI installation and display prompts for server installation parameters, set property to gui.
|
||
|
MKS_LICENSE_AGREEMENT
|
Specifies whether you accept terms of license agreement. Copy of license agreement can be found on DVD in support/install-properties folder. By default, property is set to false.
|
||
|
MKS_JAVA_EXECUTABLE
|
Specifies the path along with the name of the Java executable file.
The path of the Java executable file is:
For Windows: <jdk_installdir>\\bin\\java.exe
For Linux /usr/bin/java
|
||
|
MKS_CREATE_INTEGRITY_CLIENT_SHORTCUT
MKS_CREATE_ADMIN_CLIENT_SHORTCUT
|
Specifies whether to create shortcuts for PTC RV&S client and PTC RV&S Administration Client on Windows desktop. By default,
MKS_CREATE_INTEGRITY_CLIENT_SHORTCUT=trueMKS_CREATE_ADMIN_CLIENT_SHORTCUT=false
|
||
|
USER_INSTALL_DIR
|
Where to install PTC RV&S client. If client is running Windows, use double backslashes for paths in properties. Spaces in path should be preceded by backslash. For example, the default install location on Windows is C:\\Program\ Files\\PTC\\RVSClient13.
|
||
|
INSTALL_OVERWRITE
|
Specifies whether to overwrite any existing files in installation directory. Certain files are backed up in installation location. By default, property is set to true.
|
||
|
MKS_USE_SAME_SERVER
|
Specifies whether to use same PTC RV&S server for workflows and documents, and configuration management. If set to true, you must also specify MKS_COMMON_HOST and MKS_COMMON_PORT. By default, property is set to true.
|
||
|
MKS_COMMON_HOST=localhost
MKS_COMMON_PORT=7001
|
If MKS_USE_SAME_SERVER=true, these properties specify host name and port number of common server used for workflows and documents, and configuration management. By default,
MKS_COMMON_PORT=7001
Valid port numbers range from 1 to 65535.
|
||
|
MKS_IM_HOST
MKS_IM_PORT
|
If MKS_USE_SAME_SERVER=false, these properties specify host name and port number of server used for workflows and documents. Valid port numbers range from 1 to 65535.
|
||
|
MKS_SI_HOST
MKS_SI_PORT
|
If MKS_USE_SAME_SERVER=false, these properties specify host name and port number of server used for configuration management. Valid port numbers range from 1 to 65535.
|
||
|
MKS_PROXY_SAME_USER
MKS_PROXY_CONFIRM_USER
MKS_PROXY_GLOBAL_USER
MKS_PROXY_USE_DEFAULT
MKS_PROXY_HOST
MKS_PROXY_PORT
|
Specifies default credentials and server information for connecting to a proxy server.
MKS_PROXY_SAME_USER specifies to use the same username and password for the proxy and server.
MKS_PROXY_CONFIRM_USER specifies to always confirm the proxy username and password.
MKS_PROXY_GLOBAL_USER specifies to reuse the current proxy username and password for all connections.
MKS_PROXY_USE_DEFAULT specifies to use the default proxy for all unlisted connections.
MKS_PROXY_HOST and MKS_PROXY_PORT specify host name and port number of the proxy server.
By default, MKS_PROXY_HOST are MKS_PROXY_PORT are blank. All other properties are set to true.
|
||
|
MKS_PRODUCT_LANGUAGE
|
Specifies the language of the PTC RV&S user interface. Currently the following languages are supported: Chinese Simplified, English, German, Japanese, Korean, and French..
When using PTC RV&S on a non-English system, it is possible to display the user interface in English and retain locale-specific formatting for time, number, and currency values.
Set this property to a valid two-letter ISO-639 code to specify how to display the user interface.
Options are as follows:
• If the ISO-639 code corresponds to a supported language, then both user interface and formatting appear in that language.
• If the ISO-639 code corresponds to an unsupported language, then user interface displays in English and formatting appear according to the ISO–639 code specified.
• If the property is left blank or set to an invalid ISO-639 code, then user interface and formatting appear in the system language, if supported. If not supported, then user interface displays in English and formatting appear according to the system language.
For example:
◦ If MKS_PRODUCT_LANGUAGE=jaja, then both user interface and formatting display in Japanese because it is a supported language.
◦ If MKS_PRODUCT_LANGUAGE=cy, then user interface displays in English because Welsh is not a supported language, but formatting displays according to Welsh rules.
◦ If MKS_PRODUCT_LANGUAGE=invalid_code, then user interface displays in system language, if supported. If not supported, then user interface displays in English. In either case, formatting displays according to the system language.
|
||
|
MKS_RMI_TRANSPORT_PROTOCOL
|
Specifies the transport protocol to be used by the PTC RV&S client.
Valid values are:
• http
• websocket
• beep
Leaving this property blank or specifying an invalid value will default to beep which is the default transport protocol. Contact your administrator before setting this value.
For instance, if the server is configured to use the http protocol such as http2, set this property as MKS_RMI_TRANSPORT_PROTOCOL=http. If the server is configured to use websocket, set this property as MKS_RMI_TRANSPORT_PROTOCOL=websocket.
|
||
|
MKS_IC_SSL_PROVIDER
|
Specifies the SSL provider to be used by the PTC RV&S client. The only valid value is mscapi. Leaving this property blank or specifying an invalid value, will result in the property being ignored.
|
Running Silent Installation
1. Copy mksclient.properties from the directory specified by your administrator to a temporary location on your computer.
2. Install the PTC RV&S client by doing one of the following:
◦ If the location of mksclient.properties is not in the same directory as the mksclient.exe, run:
mksclient -f mksclient.properties
or
./mksclient -f mksclient.properties
where --f flags the location of mksclient.properties.
◦ If the location of mksclient.properties is in the same directory as mksclient.exe run, as appropriate for your platform, either mksclient.exe or mksclient.bin.