Running the Breeding View Analysis Tools Locally - IntegratedBreedingPlatform/Documentation GitHub Wiki

Introduction

The BMS is a primarily a web-based application that can run either on a central web server, or locally on an individual desktop machine or laptop. Most of the BMS modules are web applications that users access using a web browser, with the exception of the Breeding View analysis tools. These tools are a Windows client application that runs on the user's local computer.

If the user is running the BMS locally, then integration between the other BMS modules and the BV analysis tools is possible, and the handoff of data to be analyzed and the analysis results between the two applications is automated. For users of a server installation of the BMS, it is necessary to manually download data from the BMS, run the desired analysis in Breeding View, then upload the results back to the BMS.

Using the BV Analysis tools with a Server Installation of the BMS

By default, the BMS is configured to operate in server mode. The relevant configuration parameter is workbench.is.server.app, and it can be found in the Workbench configuration file located at:

[INSTALL_DIR]\infrastructure\tomcat\webapps\IBPWorkbench\classes\workbench.properties (default INSTALL_DIR = C:\BMS4)

When the BMS is running on a server, the value of this parameter should be set to "true."

In order for users to work with the BV Analysis tools, they will need to download and install the Breeding View application, and also request a license account and file from VSNi, the provider of the analysis tools.

Please refer to the BMS User Manual for more information on these steps.

Once you have the BV Analysis tools installed and licensed, you will be able to use them to conduct single-site and multi-site analysis on data you have collected in the BMS. The basic steps for either type of analysis are:

  1. Use the Single-Site Analysis or Multi-Site Analysis tools under the Statistical Analysis menu to select and export data for analysis.
  2. Launch Breeding View on your local computer.
  3. Upload the exported data file to Breeding view and run the analysis.
  4. Return to the Single-Site Analysis or Multi-Site Analysis screen to upload the results to the BMS.

The BMS User Manual provides detailed instructions for the analysis process.

Using the BV Analysis tools with a Local Installation of the BMS

If you are running the BMS on a local computer, rather than on a server, you will need to change the value of the configuration parameter workbench.is.server.app from "true" to "false". This parameter can be found in the Workbench configuration file located at:

[INSTALL_DIR]\infrastructure\tomcat\webapps\IBPWorkbench\classes\workbench.properties (default INSTALL_DIR = C:\BMS4)

When the BMS is installed locally, the installer should place the Breeding View application in the correct directory automatically. As with the server scenario described above, you will need to request a license account and license file in order to use the BV Analysis tools. Please refer to the BMS User Manual for further details.

Once you have BV Analysis tools licensed, you will be able to use them to conduct single-site and multi-site analysis on data you have collected in the BMS. In this setup, the process is somewhat more streamlined:

  1. Use the Single-Site Analysis or Multi-Site Analysis tools under the Statistical Analysis menu to select and send data for analysis.
  2. The BMS will automatically launch Breeding View on your local computer and pass the data files to it.
  3. Run the analysis
  4. Return to the Single-Site Analysis or Multi-Site Analysis screen to upload the results to the BMS.