Installation Properties in the Response File
This section provides a description of the properties in the response file used by the Code Insight silent installation. It also includes the contents of a sample response file for reference.
Property Descriptions
Refer to the following table for a description of the properties that should be included in the response file.
| Category | Property | Description |
|---|---|---|
| Installation directories | These properties identify the directory in the Code Insight installer resides and the directory in which to install Code Insight. | |
| INSTALLER_LAUNCH_ DIR | The path in which the downloaded Code Insight installer resides on your instance. (For more information, see Downloading the Code Insight Installer.) Examples: INSTALLER_LAUNCH_DIR=/tmp/codeinsight_install_files INSTALLER_LAUNCH_DIR=D:/CodeInsight/InstallationFiles/2023R1 | |
| USER_INSTALL_DIR | The directory in which to install the Code Insight on your instance. Best practice is to provide an absolute path for the installation location. Examples: USER_INSTALL_DIR=/opt/CodeInsight/2023R1 USER_INSTALL_DIR=D:/CodeInsight/2023R1 | |
| Database connector file | The following properties identify the path and name of downloaded JDBC driver that enables Code Insight to connect with the MySQL or SQL Server database. (For more information, see SQL Server Required Components or SQL Server Required Components.) During installation, the Code Insight installer copies the driver to tomcat/lib in your Code Insight installation directory. | |
| USER_JDBC_DRIVER | The name of the downloaded JDBC driver file for your database. Examples: USER_JDBC_DRIVER=mysql-connector-java-8.0.21.jar USER_JDBC_DRIVER=mssql-jdbc-6.4.0.jre8.jar | |
| PATH_OF_USER_JDBC_ DRIVER_FILE | The path of the downloaded JDBC driver file. Examples: PATH_OF_USER_JDBC_DRIVER_FILE=/tmp/codeinsight_install_files PATH_OF_USER_JDBC_DRIVER_FILE=D:/CodeInsight/InstallationFiles/2023R1 | |
| DRIVER_PATH | The path and name of the downloaded JDBC driver. Examples: DRIVER_PATH=/tmp/codeinsight_install_files/mysql-connector-java-8.0.21.jar DRIVER_PATH=D:/CodeInsight/InstallationFiles/2021R4/mysql-connector-java-8.0.21.jar | |
| Name of the Code Insight license key | The following properties Identify the file name and path of the Code Insight license key that Revenera has provided you. If you do not have a license key file, contact Revenera Support. | |
| USER_PALAMIDA_KEY_ FILE | The name of the file containing the Code Insight license key. Example: USER_PALAMIDA_KEY_FILE=codeinsight.key | |
| PATH_OF_PALMIDAKEY_FILE | The path of the file containing the Code Insight key. Example PATH_OF_PALMIDAKEY_FILE=D:/CodeInsight/InstallationFiles/2023R1 | |
| Database configuration | Details about the database that Code Insight will use. | |
| SELECTED_DB | The database type that Code Insight will use: MYSQL or SQLSERVER. Examples: SELECTED_DB=MYSQL SELECTED_DB=SQLSERVER | |
| DB_HOST | The host ID for the database. Examples: DB_HOST=localhost DB_HOST=http://ABC\-r7mysql.com DB_HOST=http://11.11.1.111 | |
| DB_PORT | The port used by Code Insight to communicate with the database. See Code Insight Ports. Examples: DB\_PORT=3306 (default for MySQL) DB\_PORT=1433 (default for SQL Server) | |
| EXISTING_SCHEMA | The name of the schema for the Code Insight database. Example: EXISTING_SCHEMA=codeinsight | |
| DB_USER | The name of the database user that Code Insight uses to access the database. The installation process automatically identifies this user (in core.db.properties ) as the one that Code Insight will use internally to access and manage the database during Code Insight operations. Example: DB_USER=codeinsight_user | |
| DB_PASS | The password of the database user identified for DB\_USER . Example: DB_PASS=codeInsight%1234 | |
| SCHEMA_POPULATED_ WARNING | The option that determines whether the Code Insight database (if it already exists) is overwritten during the installation. If the installer determines that the value for this property is missing, it rolls back the installation. 0—The installation overwrites the current database 1—The installation does not overwrite the current database. no value—The installer rolls back the installation (that is, no installation occurs). Example: SCHEMA_POPULATED_WARNING=0 | |
| Type of Code Insight deployment | The following three fields specify how the installer should deploy Code Insight on the given instance. Use the same value for all three fields. | |
| CHOSEN_FEATURE_LIST CHOSEN_INSTALL_ FEATURE_LIST CHOSEN_INSTALL_SET | The type of Code Insight deployment that the installer should perform. For more information, see Types of Code Insight Deployment. Standalone—Deploy Code Insight as both the Core Server and a Scan Server. Core—Deploy the Code Insight as the Core Server only. Scanner—Deploy the Code Insight as a Scanner only. Example: CHOSEN_FEATURE_LIST=Standalone CHOSEN_INSTALL_FEATURE_LIST=Standalone CHOSEN_INSTALL_SET=Standalone | |
| Automatic startup after installation completes | These properties are used to automatically start Tomcat and launch Code Insight once the installation completes. Ignore the ia.startTomcatFlagcmd property that is included in the generated response.Info: Tomcat should not run under elevated privileges. Therefore, the user who installs Code Insight should not have elevated privileges because this same user also installs and starts Tomcat. | |
| ia.startTomcatFlag | Specify true if you want the installer to automatically start Tomcat (which in turn starts Code Insight) once the installation completes. Otherwise, specify false . (Tomcat can be started manually as described in Starting and Stopping Tomcat.) If you want to installer to also launch the Code Insight Web user interface in a browser, configure the next property. Example: ia.startTomcatFlag=true | |
| ia.startBrowserFlag | If i a.startTomcatFlag is true , do either: Specify true for this option if you want the installer to automatically open the Code Insight Web user interface in a browser once the installation completes. Specify false if you want to manually open the Code Insight Web user interface in a browser after the installation completes. (To launch the Web user interface in browser manually, see in Opening the Code Insight Web User Interface.) If i a.startTomcatFlag is false , you must both start Tomcat and open the Code Insight user interface in a browser manually after the installation completes. Example: ia.startBrowserFlag=true | |
| Variables | You can provide explicit values for the following properties. However, best practice is to set up these properties as variables since they are based on other values in the response file. Once these variables are defined, you are strongly advised not to modify them. | |
| CATALINA_HOME | The path of the Catalina home directory for Code Insight. Variable: CATALINA_HOME=$USER_INSTALL_DIR$/tomcat | |
| TOMCAT_STARTUP_FILE | The path and name of the Tomcat startup file. Variable: TOMCAT_STARTUP_FILE=$CATALINA_HOME$/bin/startup.bat | |
| JAVA_HOME | The path of the Java home directory for Code Insight. Variable: JAVA_HOME=$USER_INSTALL_DIR$/jre | |
| JRE_HOME | The path of the JRE home directory for Code Insight. Variable: JRE_HOME=$USER_INSTALL_DIR$/jre | |
| USER_DB_IP_ADDR | The host name of the Code Insight database. Variable: USER_DB_IP_ADDR=$DB_HOST$ | |
| USER_DB_PORT | The port used by Code Insight to communicate with the database. Variable: USER_DB_PORT=$DB_PORT | |
| USER_DB_SCHEMA_ NAME | The schema name for the Code Insight database. Variable: USER_DB_SCHEMA_NAME=$EXISTING_SCHEMA$ | |
| USER_DB_USER_NAME | The name of the database user that will install the Code Insight database and that Code Insight will use internally to access and manage the database. Variable: USER_DB_USER_NAME=$DB_USER$ | |
| USER_DB_USER_ PASSWORD | The password of the database user. Variable: USER_DB_USER_PASSWORD=$DB_PASS$ |
Sample Response File Content
The following is an example of the response file content.
#Choose Install Set
#------------------
CHOSEN_FEATURE_LIST=Standalone
CHOSEN_INSTALL_FEATURE_LIST=Standalone
CHOSEN_INSTALL_SET=Standalone
#Choose Install Folder
#---------------------
USER_INSTALL_DIR=/home/qaadmin/codeinsight
USER_PALAMIDA_KEY_FILE=codeinsight.key
PATH_OF_PALMIDAKEY_FILE=/home/qaadmin/Installer
USER_JDBC_DRIVER=mysql-connector-java-5.1.41-bin.jar
PATH_OF_USER_JDBC_DRIVER_FILE=/home/qaadmin/Installer
SELECTED_DB=MYSQL
DB_HOST=10.75.116.108
DB_PORT=3306
EXISTING_SCHEMA=vnext_dummy
DB_USER=root
DB_PASS=Root%123
USER_DB_IP_ADDR=10.75.116.108
USER_DB_PORT=3306
USER_DB_SCHEMA_NAME=vnext_dummy
USER_DB_USER_NAME=root
USER_DB_USER_PASSWORD=Root%123
INSTALLER_LAUNCH_DIR=/home/qaadmin/codeinsight
DRIVER_PATH=/home/qaadmin/Installer/mysql-connector-java-5.1.41-bin.jar
SCHEMA_POPULATED_WARNING=1
TOMCAT_STARTUP_FILE=/home/qaadmin/codeinsight/tomcat/bin/startup.bat
ia.startTomcatFlag=false
ia.startBrowserFlag=false
ia.startTomcatFlagcmd=false
CATALINA_HOME=/home/qaadmin/codeinsight/tomcat
JAVA_HOME=/home/qaadmin/codeinsight/jre
JRE_HOME=/home/qaadmin/codeinsight/jre
#Install