Versions Compared

Old Version 1

changes.mady.by.user Megan Ellis

Saved on

compared with

New Version Current

changes.mady.by.user Megan Ellis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...


Section


Column

Insight Server

The Insight server is a document-oriented database (Apache Lucene Solr) that is used for  frevvo Reports and Task/Submission searches. The software is included in the tomcat frevvo tomcat bundle. The Insight Server works in conjunction with and frevvo and a web app (insight.war embedded in frevvo.war) to retrieve the information for the  reportsthe frevvo reports. administratorsfrevvo administrators, designers and users assigned form/flow Edit permissions can run the Insight Data Batch Job to refresh submissions when changes are made to Searchable Fields in a form/flow.

Here is how it works:


  • users frevvo users initiate a form or a workflow process.
  • The repository frevvo repository and the Insight server are updated with the information real-time.
  • The Insight service (insight.war) is a batch job that runs automatically on upgrade but can also be performed manually. The batch job takes the existing  submissions existing frevvo submissions and creates Solr documents for them.
  • The Reports query the Insight Server.

Tip

Always use a fresh Insight instance for frevvo. Multiple databases should never point to the same Insight instance.



Column
width300px

On This Page:

Table of Contents
maxLevel1


...

The default server and port are localhost:8983. The Insight Server URL configuration parameter is located in the <frevvo-home>\tomcat\conf\Catalina\localhost\context.xml.default file. Configuring the location of the Insight Server in this file makes it available to the insight and frevvo web application warfiles. Modify the insight.server.url parameter in the <frevvo-home>\tomcat\conf\frevvo-config.properties file if the Insight Server is running on a different machine than frevvo.

Code Block
# Insight settings 
insight.enabled=true
insight.server-url=http://localhost:8983/solr

Starting the Insight Server from the command line

requires frevvo requires Insight software for the Reporting and Submissions View feature. The Insight software is included in the tomcat bundle. The Insight server MUST be started BEFORE starting starting frevvo. Instructions for Windows and Linux operating systems are listed here:

Section


Column

 Windows:

  1. Open a command prompt. Navigate to <frevvo-home>\solr. Type bin\solr.cmd start to run the Insight server in the background, listening on the default port 8983.

    You will see this message: 

  2. Browse http:<your server:port>/solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change <your server>  to the server name and <your port> to the port the Insight server is running on if they are different than the defaults. Do not include the angle brackets <>. You will see the Insight server (Solr) dashboard with the current status:

Warning

If you close the Insight server (Solr) startup window, the server will stop running. Leave the window open or set up frevvo and the Insight Server to run as Windows services.



Column

Linux:

  1. Ensure that the scripts are executable: chmod 755 <frevvo-home>/tomcat/bin/*.sh
  2. Navigate to <frevvo-home>/solr/bin. Run this command to make the solr startup file executable:

    chmod +x solr
  3. Navigate back to the solr directory.
  4. Start the Insight server by typing bin/solr start - this starts the Insight server in the background, listening on the default port 8983.
  5. Browse http:<your server:port>/solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change <your server>  to the server name and <your port> to the port the Insight server is running on if they are different than the defaults. Do not include the angle brackets <>. You will see the Insight server (Solr) dashboard with the current status.


You do not have to restart the Insight server every time you restart frevvo.

Stopping the Insight Server from the command line

...

The Insight Server must be started BEFORE  from frevvo from a command prompt, or you will see a Configuration Checklist warning and you will not be able to proceed. If you close the Insight Server startup window, on a Windows system, the server will stop running. You can leave the window open or set up frevvo and the Insight Server to run as Windows services.

...

  1. Extract the NSSM zipfile to a Program Files\nssm directory
  2. Open a command prompt. Run as an administrator

  3. Navigate to the directory under c:\Program Files\nssm\ that contains the nssm.exe file for Windows64 or Windows32

    Code Block
    For example, the path in Windows 7 would be C:\Program Files\nssm\nssm-2.24\win64


  4. Type: nssm install <service name> - Replace <service name> with the name you want to use for the Insight Server service.

    Code Block
    Ex: nssm install insightserver


  5. Browse to the location of the solr.cmd script by clicking on the three dots to the right of the Application Path field. This should be in <frevvo-home>\solr\bin.

  6. Click on the solr.cmd file, then click Open.  The Application Path field will populate.

  7. Notice the Startup directory field also populates. REMOVE bin from the Startup directory field. The Startup directory should be: c:\<frevvo-home>\solr\

  8. Enter these Arguments:

    start -f -p 8983

    • the -f option starts the Insight Server in the foreground so NSSM can kill it when it needs to be stopped or started
    • the -p option specifies the port that the Insight Server is running on. The default is 8983. Change 8983 to the port number for your installation if necessary.

  9. Optionally, click the Details tab to specify a Display Name and Description - Ex: Insight Server, Script to Stop/Start Solr5. Notice the Startup type is set to Automatic.

  10. Click the Install service button. A success message displays:

  11. Start the Insight Server service from the Computer Management Services pane.


  12. Browse http://<your server:port>/solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change <your server>  to the server name and <your port> to the port the Insight server is running on if they are different than the defaults. Do not include the angle brackets <>. You will see the Insight server dashboard with the current status:
    Image RemovedImage Added

Install frevvo as a Windows service

There are batch files in the <frevvo-home> directory to Install/Configure as frevvo as a Windows service. Refer to Installing frevvo as a Windows Service for more details and troubleshooting tips.

  1. Navigate to <frevvo-home>. Run the Install-Service batch file as an administrator to install as frevvo as a service.

  2. Configure the service frevvo service if you are using Windows 64 bit by clicking on the Configure Service batch file. You must run the Configure-Service batch file as an administrator.

    1. Change the Startup type to Automatic. Save the changes.

  3. will frevvo will appear under Windows services with the name frevvoforms with a Startup type of Manual. Change Startup Type to Automatic (Delayed Start), then start the service.

...