This topic guides you through installing Logi Predict on a single computer under the Windows operating systems. It's intended for system administrators and application developers.
- About Logi Predict
- Preparing to Install
- Installing the Software
- Post-Installation Configuration
- Removing the Software
Logi Predict is an add-on module that enables specialized elements in Logi Info and adds a complete, pre-built Logi application to your computer.
The included Logi Predict application allows regular users, instead of data scientists, to model data and make predictive analyses at runtime. Developers can examine Logi Predict for educational purposes and can also customize its branding and other features, if desired. Logi Predict can be deployed to .NET and Java servers and we've provided a guide for end-users, Logi Predict Setup and Use.
Logi Predict works with these database servers:
- Microsoft SQL Server
- PostgreSQL v9.1+
in a 64-bit OS environment.
In use, Logi Predict connects to two kinds of databases: an analysis database, containing the data to be analyzed, and an operations database that's used to store the application's internal operations data.
When Logi Predict is run for the first time, it creates the operations database on the designated database server. Subse-quently, whenever a new Logi Predict user session is started, the application verifies the operations database to ensure that all internal application data tables are present and up-to-date.
Logi Predict uses the "R" environment for statistical analysis, which must also be installed. R is not distributed with Logi Predict, but you can either independently download and install the R Base System and Packages yourself, or allow the Logi Predict installer to do it for you.
As of this writing, Logi Predict works with R 3.4.1 - 3.4.4, but it does not work with 3.4.5.
If you're developing a Logi application for distribution that uses Logi Predict, you must adhere to the GPL license and you may not distribute R. You must allow your installer, Logi Predict's installer, or your customer, to independently download and install R.
It's critical that installation and configuration occur while running as the built-in "Administrator" account.
Even if your personal account has been added to the local Administrators Group, it may not have sufficient privileges, so don't rely on it.
As shown at left, the correct practice when running the Logi installation program or using the Command Line to make configuration adjustments is to start the tool by right-clicking its icon and selecting "Run as administrator" from the menu to start the program.
This ensures that appropriate permissions are provided for the installed components.
Don't see a "Run as administrator" option? If the system is in a network domain, your network admin may have created security policies that don't allow you to see this option, in which case you need to consult your IT staff for assistance.
For a first-time installation, the installer will ask you to choose between the version of the application that uses the .NET Framework and the version that uses Java libraries, under the Windows OS. Typically this is driven by your decision to use the IIS web server that comes with Windows or a Java-based web server such as Apache-Tomcat. The result is that a few different files are installed, a different installation location may be used, and a different web server configuration is required.
For example, for .NET and IIS, you can install the application anywhere, but for Java and the Apache-Tomcat server, you must install it in the Tomcat webapps folder, as shown above. The Java-ready version of the app includes special folders, like assemblies and WEB-INF, which are not found in the .NET version.
Your .NET or Java choice causes just a few differences in the installation sequence and they're noted below.
If you want to install the application on the Linux (or similar) OS, see Install Logi Predict - Linux.
The initial download and installation of the R libraries can take as long as 25 minutes, depending on your Internet connection speed, hard drive transfer rate, and other factors. During installation, a progress indicator shows that activity is occurring but not an accurate completion percentage. You may care to plan your time accordingly - this would be a great time to get a hot beverage.
If you're updating the software, the installer will detect the currently-installed version and prompt you to allow the update. You'll be asked to agree to the End-User License Agreement, and to start the update. There will be no other prompts and the update process usually takes less than a minute. You may need to restart IIS after the update and, when the application appears in your browser, you may be prompted to re-initialize the R library when necessary, which also takes less than a minute.
To start the installation, right-click the Logi product installation program icon and select "Run as administrator" to launch the installer. Allow it to complete the installation preparation. As usual, you can click Back at any time before the physical installation begins to go back to the previous screen.
- When the Welcome Screen appears, click Next.
- License Agreement - Select the "I accept the terms..." radiobutton after reading the license agreement and click Next to continue.
- Version Selection - Choose to install either the .NET or the Java version, as discussed in the previous section, and click Next to continue.
- R Setup - Select the appropriate action for downloading and installing the R environment. If you plan to install it yourself later, be sure to note the required installation location shown in the dialog box. Also, be aware that part of the R installation includes downloading library files, which can take as long as 25 minutes depending on your Internet connection speed. Select "No" if you already have an R installation that you'd like to use. Click Next to continue.
- Register Application - (.NET installation only) Choose whether or not to have the installer register Logi Predict with the IIS web server using a standard configuration. Most users will select Yes, but if you want to configure a special application pool, security settings, or other IIS options, select No now and add registering the application manually to your list of post-installation tasks.
- Installation Location - Click Next to accept the suggested installation location and continue. Optional - click the folder icon to specify an alternative installation location if you don't like the suggested location.
- Ready to Install - Click Next to start the physical installation.
The physical installation will begin and you'll see several progress indicators for different tasks.
- R Download - If you elected to install R now, the installer will begin that process by downloading it.
- R Installation - A separate set of dialog boxes will appear for the R installation wizard. Click Next to continue.
- R License Agreement - Click Next to agree to the terms and continue.
- Destination Location - Click Next to accept the default R installation location and continue. Optional - click Browse to select an alternative installation location.
If you enter an alternate R installation location that is not within the PredictGo application folder, you will need to specify that location later, using the constant rdScriptLocation, in the Logi Predict _Settings definition, as described in Configure Logi Predict.
- R Components - Use the default selections and click Next to continue.
- R Startup Options - Use the default selections and click Next to continue.
- R Start Menu Folder Options - Use the default selections and click Next to continue.
- R Additional Tasks - Use the default selections and click Next to continue.
The R physical installation will begin, as shown above, and you'll see several progress indicators for different tasks.
- R Installation Complete - Click Finish to complete the R installation.
- ASP.NET and IIS Configuration - (.NET installation only) The Logi Predict installer will continue to configure the IIS web server and you'll see a progress indicator.
- R Library Download - Downloading R libraries will begin automatically.
This can take as long as 25 minutes, depending on your Internet connection speed. The progress indicator shows that activity is occurring but not an accurate completion percentage. Please be patient.
- Installation is complete - Click Finish to exit the installer.
Currently, Logi Predict only works with special versions of the Logi Engine; these are denoted by a "-PA" suffix when you view the Engine Version in Studio or in a Debug page. An appropriate version is installed with the application. However, if you use Logi Studio or Server Manager to change to a non-"PA" engine version, Logi Predict will no longer work.
Once your .NET installation is complete, you can proceed directly to the application configuration tasks required before you can use Logi Predict. For more information, see Configure Logi Predict.
Once your Java installation is complete, you need to set some environment variables. This can be done using the standard Windows OS tools. For example, you may need to set:
CATALINA_HOME (Apache-Tomcat web server only) - Example value: C:\Program Files\Apache Software Foundation\apache-tomcat-9.0.8
JAVA_HOME - JDK installation location - Example value: C:\Program Files\Java\jdk.8.0_172
Special configuration values are required for use of Logi Info applications with Java servers. These can be set in a configuration file or, if your server was installed as a Windows service, with tools that come with the server. For example, for the Apache-Tomcat server, they can be included in the C:\Program Files\Apache Software Foundation\apache-tomcat-9.0.8\bin\setenv.bat file, as:
CATALINA_OPTS=-server -d64 -Xmx1280m -XX:MaxPermSize=256m -XX:-DisableExplicitGC -XX:CompileThreshold=8000 -Djava.awt.headless=true
If the server was installed as a Windows service, you could instead use this tool: C:\Program Files\Apache Software Foundation\apache-tomcat-9.0.8\bin\tomcat9w.exe (number will vary depending on server version) to set the options.
In any case, refer to Java Server Configurations for information about requirements for your specific Java server.
Once you've configured your Java web server, you can proceed to the application configuration tasks required before you can use Logi Predict. For more information, see Configure Logi Predict.
Should you ever need to, you can remove Logi Predict using Control PanelPrograms and Features.
Removing Logi Predict will remove the Logi Predict application and the R environment, but any Logi Predict definition or support files you've modified, and your existing models and prediction plans, will be left in place.