Spectrum Visual Insights™ Repository Setup

Note: If the Spectrum™ Technology Platform server is running, stop it. To stop the server, right-click the Spectrum™ Technology Platform icon in the Windows system tray and select Stop Server.
  1. Go to <Spectrum installation directory>/server/modules/svi/repositoryinstaller.
  2. Open install.properties and configure it for the required database. For example, SQLServer, DB2, Oracle.
    Property Key Value
    DatabaseType The database type for the Spectrum Visual Insights™ configuration database. For more information, see the table Table 1.
    DatabaseHostname The server hostname for the Spectrum Visual Insights™ configuration database.
    DatabasePort The server port for the Spectrum Visual Insights™ configuration database.
    DatabaseName The database name for the Spectrum Visual Insights™ configuration database.
    DatabaseUser The database username for the Spectrum Visual Insights™ configuration database.

    This user is the owner of the database created and uses the username and password combination on the Spectrum Visual Insights™ web interface to access the configuration database.

    DatabasePassword The database user's password for the Spectrum Visual Insights™ configuration database
    CreateYellowfinDB A flag that indicates whether to create a new database for the Spectrum Visual Insights™ configuration database
    Note: If the repository already exists, you must specify a new database name as this script is for installation purposes only. It is not meant for upgrade.

    If a database exists with the same name, you have these options:

    1. Delete the already existing database created using the installer script.
    2. Specify a new database with a unique name in the install.properties.
    CreateYellowfinDBUser Specifies whether to create a new database user
    Note: To use an existing user, CreateYellowfinDBUser must be set to false.
    DatabaseDBAUser The database admin username
    DatabaseDBAPassword The database admin user password
    LicenceFilePath The location of the Spectrum Spectrum Visual Insights™ license file.
    Note: To use backward slash for path, type double backslash. For example:

    LicenceFilePath=E:\\​Spectrum\\​LicenseFile.lic

    To use forward slash for path, type a single forward slash. For example:

    LicenceFilePath=​E:/Spectrum/LicenseFile.lic

    Note: To set-up the repository, you must obtain the license.
    • In case of a valid license: It is recommended to upload the license when setting up the repository by specifying the license file in install.properties.
    • In case of expired license or license acquired after repository set-up: You can upload the license by opening the Spectrum Visual Insights™ web page on the host machine. After login, the system prompts you for the license file. Select the license file from your file system using the Browse button. Once selected, click Next to continue.
      Note: You must open the browser on the host machine only. The License upload feature works only when used on the same machine on which Spectrum Visual Insights™ is running.
    InstallTutorialDatabase Set this to True to install sample reports and tutorial database along with the configuration database. The default is False for this property key.
    Table 1. Accepted Values for Supported Databases
    Database Accepted Value
    PostgreSQL DB PostgreSQL
    Microsoft SQL Server sqlserver
    Oracle oracle
    MySQL MySQL
    IBM DB2 db2
    Note:
    1. In case of PostgreSQL DB, uppercase in database name is not supported. This is a Postgres limitation.
    2. In case of Microsoft SQL Server, if the password policy is enabled, then the password in install.properties must comply with the policy.
    3. In case of Oracle and IBM DB2, the database name and database user must be created at the database level. Remember to set the properties CreateYellowfinDB and CreateYellowfinDBUser to false, in order to use these pre-created database name and database user values while creating the repository.
  3. Open command prompt from the location: <Spectrum Installation Directory>/modules/svi/repositoryinstaller.
  4. Run repository.setup.bat batch file to setup the repository based upon the database settings performed in install.properties.
    In case of repository setup success, this repository configuration script is displayed: 
    Configuring Spectrum Visual Insights repository
Starting post-installation configuration updates..
Connecting to Configuration database : <jdbcurl> as user :<user>
Completed post-installation configuration updates..
Deploying Spectrum Visual Insights war file
Completed cleanup,exiting...

    In case of repository set-up failure, this error message is returned along with batch script error level:

    Terminated installer due to error # %errorlevel%. Refer log file in logs folder for additional information
    Note: The log file setupscript.log mentions the state at which the script execution reached or failed. It contains the logs of the script and not of the installer.
  5. The svi.war file is created at the location: <Spectrum installation directory>/server/app/deploy.
  6. Start the Spectrum™ Technology Platform server.
  7. Once the server is started, you can access the Spectrum Visual Insights™ Module using the URL construct: <server>:<port>/svi.
    Note: The detailed logs generated for the SVI module can be accessed here: <Spectrum Installation Directory>\server\modules\svi\logs.