Versions Compared

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  Reports. The Insight Server software is included in the tomcat bundle. The Insight Server works in conjunction with and a web app (insight.war embedded in frevvo.war) to retrieve the information for the  reports.

...

Here is how it works:

Image Modified

  • users initiate a form or a workflow process.
  • The 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 and creates Solr documents for them.
  • The Reports query the Insight Server.
Tip

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

Column
width300px

On This Page:

Table of Contents
maxLevel1

Insight Server Files

When you unzip the tomcat bundle, you will see a new <frevvo-home>\solr-56.46.1 2 directory that contains the Insight Server software.

...

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

Starting

...

the Insight Server from the command line

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 . Instructions for Windows and Linux operating systems are listed here:

Section
Use the bin\solr-cmd -all command to stop all instances of the Insight Server. The -p option allows you to specify the port number for the instance you want to stop 

Image Added

You will see this message:
 

 

Image RemovedImage Added
  • Browse http;<your server:your 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:
  • Column

     Windows:

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

      Image Removed

    Note
    Warning

    If you close the Insight server (Solr) startup window, the server will stop running. Leave the window open or set up Live Forms 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-56.46.12/bin. Run this command to make the solr startup file executable:

      chmod +x solr
    3. Navigate back to the solr-6.6.0 2 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:your 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 .

    Stopping the Insight Server from the command line

    Use the bin\solr.cmd -all command to stop all instances of the Insight Server.

    Follow these steps:

    1. Navigate to <frevvo-home>\solr-6.6.2.
    2. Type bin\solr.cmd stop -all

      Image Added

    To stop a particular instance of the Insight Server, use the -p option to specify the port number that the Insight Server process is running on. Ex: bin\solr.cmd stop -p 8983

    Image Added

    Running Live Forms and the Insight Server 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.



    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-5.4.1\

    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:

    ...

    1. From the administrative command prompt, type the following command with the name you gave to the Insight Server service:

      Code Block
      sc config frevvoforms depend= <name of the Insight Server service>



    2. Check the Dependencies tab of your Insight Server service in the Windows Services list, It should list frevvoforms as a system component that depends on the Insight service



    3. If you manually stop the Insight Server service, it will ask you if you want to stop Live Forms.

    Troubleshooting

    ...

    If you see this error after trying to stop the frevvo service refer to this Microsoft Support article for a resolution

    ...

    Tips

    Insight Server Log

    Indexing related messages are captured in the <frevvo-home>\tomcat\logs\frevvo.YYYY-MM-DD file. For example, if you run the Insight Data Batch process manually or if it runs automatically during an upgrade, messages from the process are found in the frevvo.log.