This document describes how to install the Search Analytics software contained in the search-analytics package. The following topics can be found in this section:

System Requirements

The Search Analytics software was developed using JavaScript. This section details the system requirements for installing and operating the Search Analytics software.

Java Application Server

The Search Analytics software requires a Java application server for hosting the web application. The suggested application server for this release is Apache Tomcat with a minimal version of 7.0.X. Consult the local system administrator for installation of this software. For the do-it-yourself crowd, see the Tomcat Deployment document for installation and configuration details. If viewing this document from the search-analytics package, view the Tomcat Deployment document from the Engineering Node site.

The top-level directory where Apache Tomcat is installed (i.e. the directory containing the webapps and conf sub-directories) will be referenced in these instructions as $TOMCAT_HOME.

Unpacking the Package

Download the search-analytics package from the PDS FTP site. The binary distribution is available in identical zip or tar/gzip packages. The installation directory may vary from environment to environment but in UNIX-based environments it is typical to install software packages in the /usr/local directory and in Windows-based environments it is typical to install software packages in the C:\Program Files directory. Unpack the selected binary distribution file with one of the following commands:

% unzip
% tar -xzvf search-analytics-2.0.0-bin.tar.gz

Note: Depending on the platform, the native version of tar may produce an error when attempting to unpack the distribution file because many of the file paths are greater than 100 characters. If available, the GNU version of tar will resolve this problem. If that is not available or cannot be installed, the zipped package will work just fine in a UNIX environment.

The commands above result in the creation of the search-analytics-2.0.0 directory with the following directory structure:

  • README.txt

    A README file directing the user to the available documentation for the project.

  • LICENSE.txt

    The copyright notice from the California Institute of Technology detailing the restrictions regarding the use and distribution of this software. Although the license is strictly worded, the software has been classified as Technology and Software Publicly Available (TSPA) and is available for anyone to download and use.

  • search-analytics.war

    This is the Web ARchive (WAR) file containing the Search Analytics software including all dependent JAR files.

  • doc/

    This directory contains a local web site with the Search Analytics documentation and other configuration management related information. Just point the desired web browser to the index.html file in this directory.

Deploying the Application

The Search Analytics web application is packaged as a WAR file and is intended for installation under a standard Java Application Server. For a Tomcat server deployment, the WAR file is normally copied directly to the webapps directory within the Tomcat installation or installed via the Manager interface. Once this step is complete, the application is ready for operation.

Configuring the Application

Search Service Configuration

By default, the Search Analytics web application is configured to access the Search Service at /search-service/ on the localhost. This works great in development and test environments but should be modified for an operations environment. For example to modify the configuration for the EN operations environment, edit the $TOMCAT_HOME/webapps/search-analytics/config.js file as follows:

    solr: "/search-service/",
    solr: "",

In addition, edit the $TOMCAT_HOME/webapps/search-analytics/app/dashboard/default.json file as follows:

    "server": "/search-service/",
    "server": "",

Dashboard Configuration

By default, the Search Analytics web application comes with a dashboard configuration intended to be used with a Search Service populated with PDS Context products (pds-context.json). The application also includes a dashboard configuration intended to be used with PDS Data products (pds-data.json). To modify the configuration for PDS Data product content, copy the pds-data.json file located in the $TOMCAT_HOME/webapps/search-analytics/app/dashboards directory to default.json and then refresh the page in your browser. If you changed the Search Service Configuration in the section above, you will need to do it again for the newly copied default.json file.