What You Will Need
Download The Resources
- Java Runtime Environment
Download your favourite JRE of at least version 11. There are multiple locations to download the JRE and is left up to the reader to choose the implementation that you are comfortable with.
- 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.6.1, 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.6.1-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.
- 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-1.2.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-1.2.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 |
||
|
|
|
|
mechanical-pencils.json |
Mechanical pencils example data |
|
|
|
|
|
simple-date.json |
Simple Date example data |
|
|
|
|
|
book-store.json |
Book Store example data |
|
|
|
|
panl/ |
Directory for testing/sample Panl configuration |
||
|
|
|
|
all/ |
The directory that contains the Panl configuration for all Solr collections and Panl collection URL bindings for testing across all CaFUPs.
NOTE: This includes configurations for the mechanical-pencils, simple-date, and book-store Solr collections. You will need to index the underlying datasets for this configuration to work. |
|
|
|
|
|
|
mechanical-pencils/ |
The directory that contains the Panl configuration for the Mechanical Pencils Panl collection URL bindings
NOTE: To run examples in this book you MUST create and populate the Solr mechanical-pencils collection. The process for this will be explained in the following chapters.
NOTE: This directory also contains an example implementation of the 'More Facets' functionality which is not registered in the panl.properties file. |
|
|
|
|
|
mechanical-pencils-or/ |
The directory that contains the Panl configuration for the Mechanical Pencils Panl collection URL bindings with the brand Solr field configured to be an OR Facet |
|
|
|
|
|
simple-date/ |
The directory that contains the Panl configuration for the Simple Date Solr Panl collection URL bindings |
|
|
|
|
|
book-store/ |
The directory that contains the Panl configuration for the Book Store Panl collection URL bindings.
NOTE: Only brief sample data is included for this collection |
|
|
|
|
solr/ |
Directory for testing/sample Solr configuration |
|
|
|
|
|
|
mechanical-pencils/ |
The directory for the Solr configuration XML file and managed schema file for the Mechanical Pencils collection |
|
|
|
|
|
simple-date/ |
The directory for the Solr configuration XML file and managed schema file for the Simple Date collection |
|
|
|
|
|
book-store/ |
The directory for the Solr configuration XML file and managed schema file for the Book Store collection.
NOTE: Only brief sample data is included for this collection |
~ ~ ~ * ~ ~ ~