What You Will Need

Download The Resources

  1. Java Runtime Environment

Download your favourite JRE of at least version 11[13]. There are multiple locations to download the JRE and is left up to the reader to choose the implementation that you are comfortable with.

  1. An Apache Solr instance

https://solr.apache.org/downloads.html

Ensure that you have downloaded and unzipped/un-tgzed the Apache Solr binary instance - in this book the referenced version is 9.8.0, however later versions should  work especially with any 9.x.x Solr release. The version that is used with this book is the slim version - i.e. the binary release: solr-9.8.0-slim.tgz.

The location that you have unzipped/un-tgzed the Apache Solr package file is referred to as the SOLR_INSTALL_DIRECTORY and will be referenced throughout this book.  You will need to replace this value with your own installation directory.

  1. The Panl Server package

https://github.com/synapticloop/panl/releases

Download the Panl Server release package from github and unzip/un-tgz the file. The version that is used in this book is solr-panl-9-2.0.0, make sure that you download the binary package, not the source package.

The location that you have unzipped/un-tgzed the Panl server package file is referred to as the PANL_INSTALL_DIRECTORY, and will be referenced throughout this book.

The Panl Directory Structure

The release package has the following directory structure, note that both the sample and book directories are not required (and they are not used) to run the Panl server in production and may be safely deleted.

File Path

Explanation

/solr-panl-9-2.0.0/

The root install directory

bin/

The binary directories for starting the server

panl

The *NIX executable

panl.bat

The Windows executable

lib/

The library directory containing Java archive library files to run the Panl server

book/

Where you will find this book - you may safely delete this directory (after reading and saving a copy of the book for safekeeping of course)

sample/

The directory containing sample data and configuration for the Panl server - you may delete this directory

data/

Directory for testing/example data, including datasets for:

  • Mechanical Pencils
  • Simple Date
  • Bookstore (brief sample data)

panl/

Directory for testing/sample Panl configuration to start the Panl server with a variety of CaFUPs:

  • All sample CaFUPs
  • Mechanical Pencils CaFUPs with and without
  • OR Facets
  • More Facet values
  • Multivalued separators
  • Simple Date CaFUPs
  • Bookstore CaFUPs
  • With and without highlighting
  • Alphabetical author list

Note: For any CaFUPs which are not based on the Solr collection of mechanical pencils, you will need to create the Solr collection and index the datasets.  Instructions for this are included in this book.

solr/

Directory for testing/sample Solr configuration with managed schemas for the following collections:

  • Mechanical Pencils
  • Simple Date
  • Bookstore


~ ~ ~ * ~ ~ ~