Properties Quick Reference

In alphabetical order. Properties that exist in the panl.properties file are:

panl.results.testing.urls
panl.status.404.verbose
panl.status.500.verbose
panl.collection.<solr_collection_name>
solrj.client
solr.search.server.url

All other properties are contained within the <panl_collection_url>.panl.properties file.

Property References Format Explained

Each of the properties referenced below will have a brief overview line, then a table that summarises the property, its values, and summarises its details.

Where the property key ends with <lpse_code> this is the LPSE code which MUST match the LPSE length that is set by the panl.lpse.length property. This does not affect the panl.param.* properties which ALWAYS have a LPSe length of 1.

Where the property key ends with <field_set> this is the field set .

Scope	One of Server, Collection, or Field Server - applies to the Panl server and every Panl collection URL that the server is registered to handle Collection - applies to the Panl collection URL that the file registers (including the FieldSets that are registered) Field - applies to a specific field with the registered LPSE code
Required	Either Yes, No, or Optional Yes - if this property is missing then the Panl server will refuse to start and will exit with an exception, or the field will not be registered and will not be active No - The configuration item that the property controls will be set to a default value Optional - Not required and does not have a default value
Value	One of Character, String, Integer, Decimal, Boolean, or List<Type> Character - a single alphanumeric character in the range a-z A-Z 0-9, or, where noted a + or - String - Multi character string Integer - Any integer number Decimal - Any decimal number to any number of decimal places Boolean - may be either true or false, in some instances the value is case sensitive and must be the exact lowercase true or lowercase false. It is recommended that lowercase values are always used. List<Type> - A comma separated list of values all of which are of type 'Type'. E.g. List<String> would be a comma separated list of Strings, List<Character> would be a comma separated list of Characters.
Default	If not set, this will be the default value, N/A indicates that there is no default.
Location	Either panl.properties file - the Panl server configuration file <panl_collection_url>.panl.properties - the individual Panl collection URL file
Notes	An list of notes with brief explanations
See also	Links to other section headings that are of note for this particular property.

For some properties, a further explanation is included, including examples.

panl.bool.<lpse_code>.false

Set the replacement text for a Solr boolean field for a 'false' value.

Scope	Field
Required	No
Value	String
Default	false
Location	<panl_collection_url>.panl.properties
Notes	If the type of the field (i.e. the panl.type.<lpse_code> property value) is not solr.BoolField, then this property will be silently ignored. If the value of this URL path part does not exactly match the replacement value, then this token will be marked as invalid and not passed through to the Solr server. A prefix and suffix can also be applied to the field, which will be prepended/appended to this value respectively.
See also	BOOLEAN Facet panl.type.<lpse_code> panl.bool.<lpse_code>.true panl.prefix.<lpse_code> panl.suffix.<lpse_code>

panl.bool.<lpse_code>.true

Set the replacement text for a Solr boolean field for a 'true' value.

Scope	Field
Required	No
Value	String
Default	true
Location	<panl_collection_url>.panl.properties
Notes	If the type of the field (i.e. the panl.type.<lpse_code> property value) is not solr.BoolField, then this property will be silently ignored. If the value of this URL path part does not exactly match the replacement value, then this token will be marked as invalid and not passed through to the Solr server. A prefix and suffix can also be applied to the field, which will be prepended/appended to this value respectively.
See also	BOOLEAN Facet panl.type.<lpse_code> panl.bool.<lpse_code>.false panl.prefix.<lpse_code> panl.suffix.<lpse_code>

panl.collection.<solr_collection_name>

The collection Panl property files either a single file path, or a comma separated list of file paths, to load configuration from that will return results from the <solr_collection_name>.

Scope	Server
Required	Yes
Value	List<String> - A comma separated list of property file names and paths which are relative to the panl.properties file that included it.
Default	N/A
Location	panl.properties
Notes	This will produce an ERROR if no properties start with panl.collection. are defined The <solr_collection_name> MUST match the Solr collection that you want to connect this CaFUP to. Multiple files should be comma separated and may be on new lines with the Java properties continuation of backslash \. The base directory for relative files paths is the directory that the panl.properties file resides.
See also

The file, or comma separated list of property files use the base directory of the panl.properties file as the starting the properties file for the collection to be registered with the Panl server. There is one property per collection that is to be served.

Example:

If you have a directory structure with multiple properties files:

/panl
/mechanical-pencils
/mechanical-pencils.panl.properties
/mechanical-pencils-or.panl.properties
/products
/products.panl.properties
/server
/panl.properties

And wanted to connect to two Solr connections (mechanical-pencils and products) with two separate CaFUPS then the panl.properties file would contain the following two properties:

panl.collection.mechanical-pencils=\
../mechanical-pencils-or/mechanical-pencils-or.panl.properties,\

../mechanical-pencils/mechanical-pencils.panl.properties
panl.collection.products=\

../products/base-products.panl.properties

If you start to server with the -properties panl/server/panl.properties command line option then the Panl server will read the panl.properties file, and then attempt to bind the Panl URL paths from reading the properties files relative to the current directory of the panl.properties file.

This would bind the following Panl collection URLs to the respective Solr collections

Bound URL of /mechanical-pencils/* would connect to the mechanical-pencils Solr collection
Bound URL of /mechanical-pencils-or/* would connect to the mechanical-pencils Solr collection
Bound URL of /products/* would connect to the base-products Solr collection

panl.date.<lpse_code>.days

The suffix that configures the searched date range for this field which is then parsed by Panl to generate the Solr search query based on days. The query is ALWAYS from NOW - as in the current time.

Scope	Field
Required	No
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	This property is ONLY available if the Solr field type is solr.DatePointField. This works in with conjunction with the next and previous prefixes for DATE range facets If this property is not set then NO date range searches will be available for daily ranges
See also	DATE Range Facet panl.date.<lpse_code>.next panl.date.<lpse_code>.previous panl.date.<lpse_code>.days panl.date.<lpse_code>.months panl.date.<lpse_code>.years

This property sets the suffix text that will indicate to Panl that this date range query is for daily date ranges. This creates a query that in the example URL paths below, the suffix is \ days (note the backslash encoded whitespace for the property). Below are using two example prefixes of previous+ and next+ to show the differences between the Solr query string that is generated - the %2B is a URL encoded + sign.

URL paths

/previous+5+years/S/

/next+5+years/S/

Canonical URL paths

/previous+5+years/S/

/next+5+years/S/

Solr query string

fq=solr_date:[NOW-5YEARS+TO+NOW]

fq=solr_date:[NOW+TO+NOW%2B5YEARS]

panl.date.<lpse_code>.hours

The suffix that configures the searched date range for this field which is then parsed by Panl to generate the Solr search query based on hours. The query is ALWAYS from NOW - as in the current time.

Scope	Field
Required	No
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	This property is ONLY available if the Solr field type is solr.DatePointField. This works in with conjunction with the next and previous prefixes for DATE range facets If this property is not set then NO date range searches will be available for hourly time ranges
See also	DATE Range Facet panl.date.<lpse_code>.next panl.date.<lpse_code>.previous panl.date.<lpse_code>.days panl.date.<lpse_code>.months panl.date.<lpse_code>.years

This property sets the suffix text that will indicate to Panl that this date range query is for hourly time ranges. This creates a query that in the example URL paths below, the suffix is \ hours (note the backslash encoded whitespace for the property). Below are using two example prefixes of previous+ and next+ to show the differences between the Solr query string that is generated - the %2B is a URL encoded + sign.

URL paths

/previous+48+hours/S/

/next+48+hours/S/

Canonical URL paths

/previous+48+hours/S/

/next+48+hours/S/

Solr query string

fq=solr_date:[NOW-48HOURS+TO+NOW]

fq=solr_date:[NOW+TO+NOW%2B48HOURS]

panl.date.<lpse_code>.months

The suffix that configures the searched date range for this field which is then parsed by Panl to generate the Solr search query based on months. The query is ALWAYS from NOW - as in the current time.

Scope	Field
Required	No
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	This property is ONLY available if the Solr field type is solr.DatePointField. This works in with conjunction with the next and previous prefixes for DATE range facets If this property is not set then NO date range searches will be available for monthly date ranges
See also	DATE Range Facet panl.date.<lpse_code>.next panl.date.<lpse_code>.previous panl.date.<lpse_code>.hours panl.date.<lpse_code>.days panl.date.<lpse_code>.years

This property sets the suffix text that will indicate to Panl that this date range query is for monthly date ranges. This creates a query that in the example URL paths below, the suffix is \ months (note the backslash encoded whitespace for the property). Below are using two example prefixes of previous+ and next+ to show the differences between the Solr query string that is generated - the %2B is a URL encoded + sign.

URL paths

/previous+12+months/S/

/next+12+months/S/

Canonical URL paths

/previous+12+months/S/

/next+12+months/S/

Solr query string

fq=solr_date:[NOW-12MONTHS+TO+NOW]

fq=solr_date:[NOW+TO+NOW%2B12MONTHS]

panl.date.<lpse_code>.next

The prefix to indicate that Panl should interpret this as a date range query for the following (or next) date period. The query is ALWAYS from NOW - as in the current time.

Scope	Field
Required	No
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	This property is ONLY available if the Solr field type is solr.DatePointField. This works in conjunction with the hours, days, months and years suffixes. If this property is not set then NO date range searches will be available for time periods from now
See also	DATE Range Facet panl.date.<lpse_code>.previous panl.date.<lpse_code>.hours panl.date.<lpse_code>.days panl.date.<lpse_code>.months panl.date.<lpse_code>.years

This property sets the prefix text that will indicate to Panl that this date range query is for time ranges from NOW until the indicated suffix. This creates a query that in the example URL paths below, the prefix is next (note the whitespace for the property). Below are using the example suffixes of \ hours, \ days, \ months, and \ years to show the differences between the Solr query string that is generated - the %2B is a URL encoded + sign.

URL paths

/next+48+hours/S/

/next+30+days/S/

/next+12+months/S/

/next+5+years/S/

Canonical URL paths

/next+48+hours/S/

/next+30+days/S/

/next+12+months/S/

/next+5+years/S/

Solr query string

fq=solr_date:[NOW+TO+NOW%2B48HOURS]

fq=solr_date:[NOW+TO+NOW%2B30DAYS]

fq=solr_date:[NOW+TO+NOW%2B12MONTHS]

fq=solr_date:[NOW+TO+NOW%2B5MONTHS]

panl.date.<lpse_code>.previous

The prefix to indicate that Panl should interpret this as a date range query for the previous date period. The query is ALWAYS from NOW - as in the current time.

Scope	Field
Required	No
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	This property is ONLY available if the Solr field type is solr.DatePointField. This works in conjunction with the hours, days, months and years suffixes. If this property is not set then NO date range searches will be available for time periods from now
See also	DATE Range Facet panl.date.<lpse_code>.next panl.date.<lpse_code>.hours panl.date.<lpse_code>.days panl.date.<lpse_code>.months panl.date.<lpse_code>.years

This property sets the prefix text that will indicate to Panl that this date range query is for time ranges from the indicated suffix until NOW. This creates a query that in the example URL paths below, the prefix is previous (note the whitespace for the property). Below are using the example suffixes of \ hours, \ days, \ months, and \ years to show the differences between the Solr query string that is generated - the %2B is a URL encoded + sign.

URL paths

/previous+48+hours/S/

/previous+30+days/S/

/previous+12+months/S/

/previous+5+years/S/

Canonical URL paths

/previous+48+hours/S/

/previous+30+days/S/

/previous+12+months/S/

/previous+5+years/S/

Solr query string

fq=solr_date:[NOW-48HOURS+TO+NOW]

fq=solr_date:[NOW-30DAYS+TO+NOW]

fq=solr_date:[NOW-12MONTHS+TO+NOW]

fq=solr_date:[NOW-5MONTHS+TO+NOW]

panl.date.<lpse_code>.years

The suffix that configures the searched date range for this field which is then parsed by Panl to generate the Solr search query based on years. The query is ALWAYS from NOW - as in the current time.

Scope	Field
Required	No
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	This property is ONLY available if the Solr field type is solr.DatePointField. This works in with conjunction with the next and previous prefixes for DATE range facets If this property is not set then NO date range searches will be available for yearly date ranges
See also	DATE Range Facet panl.date.<lpse_code>.next panl.date.<lpse_code>.previous panl.date.<lpse_code>.hours panl.date.<lpse_code>.days panl.date.<lpse_code>.months

This property sets the suffix text that will indicate to Panl that this date range query is for yearly date ranges. This creates a query that in the example URL paths below, the suffix is \ years (note the backslash encoded whitespace for the property). Below are using two example prefixes of previous+ and next+ to show the differences between the Solr query string that is generated - the %2B is a URL encoded + sign.

URL paths

/previous+5+years/S/

/next+5+years/S/

Canonical URL paths

/previous+5+years/S/

/next+5+years/S/

Solr query string

fq=solr_date:[NOW-5YEARS+TO+NOW]

fq=solr_date:[NOW+TO+NOW%2B5YEARS]

panl.decimal.point

Whether to use a decimal comma, or a decimal point as the separator between the integer and fractional point for decimal numbers (i.e. float or double).

Scope	Server
Required	No
Value	Boolean
Default	true
Location	<panl_collection_url>.panl.properties
Notes	If missing, or not set, the default is to use the decimal point separator.
See also

Example:

The number

1,234,567.89

uses the decimal point '.' as the separator between the integer and the fractional part, whereas the number

1.234.567,89

uses the decimal comma ',' as the separator between the integer and the fractional part.

panl.facet.<lpse_code>

Scope	Collection
Required	No
Value	Character - see the LPSE length as this may be multiple characters
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	MUST match a Solr field named in the Solr managed schema XML file. This is not checked at instantiation, however will cause a runtime exception if the value does not match a Solr field. The number of characters the <lpse_code> MUST match the LPSE length
See also	panl.field.<lpse_code> panl.or.facet.<lpse_code> panl.range.facet.<lpse_code> panl.prefix.<lpse_code> panl.suffix.<lpse_code>

This will configure Panl to serve this Solr field as a selectable facet. As a Regular facet Panl will automatically generate URL paths, including if this is a multi-valued field. There are additional configuration options which are dependent on the type of the Solr field (which would allow BOOLEAN and DATE Range facets), and whether this is configured to be an OR facet or a RANGE facet.

For regular facets selecting a multi-valued 'Colour' facet, firstly selecting a 'Blue' colour, then a 'Red' colour.

URL paths

/Blue/W/

/Blue/Red/WW/

Canonical URL paths

/Blue/W/

/Blue/Red/WW/

Solr query string

fq=colours:"Blue"

fq=colours:"Blue"&fq=colours:"Red"

panl.facetsort.<lpse_code>

Set the way that Solr will sort the returned facets.

Scope	Collection
Required	No
Value	index or count
Default	count
Location	<panl_collection_url>.panl.properties
Notes	If this property is not set to index (case sensitive) then this property will default to the value count.
See also

This affects the order in which the values and counts of a specific facet are returned. This does not affect the ordering of the LPSE code, or the order of the documents. If the value of this property is set to count, which is the default, then the facet is sorted by the number of documents that contain this facet value. If the property is set to index, then the facet is sorted by the value of the facet.

Below is an image showing the different sorting options for the facet.

Image: Images showing the difference between sorting on index (left), and count (right).

panl.field.<lpse_code>

Register a Solr field as a Panl field that can be returned within the document results. This field will only be returned in the document if it is part of the FieldSets defined in the properties file.

Scope	Collection
Required	No
Value	Character - see the LPSE length as this may be multiple characters
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	MUST match a Solr field named in the Solr managed schema XML file. This is not checked at instantiation, however will cause a runtime exception if the value does not match a Solr field. The number of characters the <lpse_code> MUST match the LPSE length This Solr field will not be returned as a facet, however it can be returned within the document results
See also	panl.facet.<lpse_code> panl.results.fields.<field_set>

Fields are never returned as the list of facets that are returned, however they can be returned in the resulting documents and used as a sorting option.

panl.form.query.respondto

The default query URL parameter that the Panl server will use to generate the text or phrase query to send through to the Solr search server.

Scope	Collection
Required	No
Value	String
Default	q
Location	<panl_collection_url>.panl.properties
Notes
See also

panl.include.same.number.facets

Whether to include facets in the available facet list if the value of the facet count is the same as the number of documents.

Scope	Collection
Required	No
Values	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes
See also	panl.include.same.number.facets

panl.include.single.facets

Whether to include facets that only have a single value, i.e. for a specific facet there is only one value and associated count for it.

Scope	Collection
Required	No
Value	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes
See also

panl.lpse.ignore

A comma separated list of LPSE codes to ignore when returning facets from the Solr search server.

Scope	Collection
Required	No
Value	List<Character> (or a list of LPSE codes)
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	This is a comma separated list of LPSE codes to be ignored
See also

Ignored LPSE codes will be ignored and not returned in either the active or available filters JSON object.

This is useful when you want to use a facet for a lookup, but not allow the facet to be removed or returned in the list of available or active facets. An example usage would be when generating a link to a single result (say with its id field) and the returned available facets would return all of the ids as facets, which would be unproductive.

panl.lpse.length

The length of the LPSE code for all facets and fields - this DOES NOT affect the length of Panl parameters or operands which are ALWAYS a length of 1.

Scope	Collection
Required	No
Values	Integer
Default	1
Location	<panl_collection_url>.panl.properties
Notes	a WARNING message will be printed to the console if this property is not set.
See also

The LPSE length will determine

The number of facets that the Panl server is able to use when communicating to the Solr search server.
The length of the LPSE code that is then placed in the URL path

panl.lpse.order

The order of the Panl LPSE codes to generate the URL path with.

Scope	Collection
Required	Yes
Value	List<String>
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	The Panl server will ERROR if this property does not exist, and exit. If one of the LPSE codes is contained within the list of values, but is not defined, then the Panl server will generate a WARNING message When the canonical URL path is being generated, the LPSE order is used. The list of LPSE codes must match the defined LPSE codes for the panl.facet.<lpse_code> definitions
See also	panl.lpse.length

panl.multivalue.<lpse_code>

This property is generated from the Solr managed schema file and configures the Panl field to be multivalued.

Scope	Field
Required	No
Value	Boolean
Default	false
Location	panl.properties
Notes	This value is taken from the Solr managed schema XML file and SHOULD NOT be altered unless the underlying data type in Solr has also changed. This property is used for single page search interface JSON response object.
See also

panl.name.<lpse_code>

The display name for the Solr field that will be presented to the user.

Scope	Collection
Required	No
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	If this is not included then the Solr field name will be used - i.e. the panl.facet.<lpse_code>.
See also	panl.facet.<lpse_code>

This is the Panl name of the field, as opposed to the Solr field name. This name can be used as nicer text to be displayed on the search page. For example with the Book Store collection, the solr_field is named first_published_year, however when rendered to the search page, the Panl name is used as 'First Published Year'.

Image: Showing the Panl field name that is rendered, which is distinct from the Solr field name.

panl.or.facet.<lpse_code>

Set this facet to be an OR facet, allowing multiple facet values to be selected for this facet.

Scope	Collection
Required	No
Value	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes	This value must be the lowercase value true for this property to be set.
See also	panl.or.always.<lpse_code>

panl.or.always.<lpse_code>

Set this facet to always return

Scope	Collection
Required	No
Value	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes	This value must be the lowercase value true for this property to be set. This will only be applicable to OR facets
See also	panl.or.facet.<lpse_code>

panl.param.numrows

The LPSE code for the number of rows of documents to return with the search.

Scope	Collection
Required	Yes
Value	Integer
Default	n
Location	<panl_collection_url>.panl.properties
Notes	On Panl Server property file generation, the default LPSE code is set to 'n', however, it may be changed to another single character value. For this to be active, this param must be set the in the comma separated list of the Panl LPSE order
See also	panl.param.numrows.prefix panl.param.numrows.suffix solr.numrows.default

panl.param.numrows.prefix

The prefix to put before the number of rows URL value.

Scope	Field
Required	Optional
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes
See also	panl.param.numrows panl.param.numrows.suffix solr.numrows.default

panl.param.numrows.suffix

The suffix to put after the number of rows URL value.

Scope	Field
Required	Optional
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes
See also	panl.param.numrows panl.param.numrows.prefix solr.numrows.default

panl.param.page

Set the LPSE code for page number for the results, the first page being page 1.

Scope	Field
Required	Optional
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	On Panl Server property file generation, the default value is set to 'p', however, it may be changed to another single character value. For this to be active, this param must be set the in the comma separated list of the Panl LPSE order
See also	panl.param.page.prefix panl.param.page.suffix panl.param.numrows panl.lpse.order

panl.param.page.prefix

The prefix to place before the page number value in the LPSE URL path.

Scope	Field
Required	Optional
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes
See also	panl.param.page panl.param.page.suffix

panl.param.page.suffix

The suffix to place before the page number value in the LPSE URL path.

Scope	Field
Required	Optional
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes
See also	panl.param.page panl.param.page.prefix panl.lpse.order

panl.param.passthrough

The LPSE code for URL values that are passed through the Panl server without any processing or sending through to the Solr search server - i.e. ignore it.

Scope	Collection
Required	No
Value	Character
Default	z
Location	<panl_collection_url>.panl.properties
Notes	On Panl Server property file generation, the default value is set to 'z', however, it may be removed from the properties file, or changed to another single character value. For this LPSE code to be active, this param must be set the in the comma separated list of the Panl LPSE order
See also	panl.lpse.order panl.param.passthrough.canonical

panl.param.passthrough.canonical

Whether to include the pass through value when the canonical URL is generated.

Scope	Collection
Required	Optional
Value	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes
See also	panl.lpse.order panl.param.passthrough

panl.param.query

The LPSE code for any user supplied queries (i.e. the text or phrase search query)

Scope	Collection
Required	Yes
Value	Character
Default	q
Location	<panl_collection_url>.panl.properties
Notes	On Panl Server property file generation, the default value is set to 'q', however, it may be removed from the properties file, or changed to another single character value. This will always be a single character. This DOES NOT conform to the LPSE length. If the LPSE length is set to 2, then this property value will still be one alphanumeric character long
See also	panl.lpse.length

panl.param.query.operand

The LPSE code that sets the Query Operand for the Solr search server.

Scope	Collection
Required	Yes
Value	Character
Default	o
Location	<panl_collection_url>.panl.properties
Notes	On Panl Server property file generation, the default value is set to 'o', however, it may be removed from the properties file, or changed to another single character value. The default value is the one that is assigned by the Panl generator and used throughout the book.
See also	solr.default.query.operand

panl.param.sort

Defines the LPSE code for the sorting of the documents

Scope	Server
Required	Yes
Value	Character
Default	s
Location	<panl_collection_url>.panl.properties
Notes	On Panl Server property file generation, the default value is set to 's', however, it may be removed from the properties file, or changed to another single character value. The default value is the one that is assigned by the Panl generator and used throughout the book.
See also

panl.prefix.<lpse_code>

Set the prefix for the facet value which is prepended to the value of the facet in the URL path.

Scope	Field
Required	Optional
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes
See also

panl.range.facet.<lpse_code>

Sets this Panl field to be a RANGE facet, allowing the user to select values that fall within an inclusive range.

Scope	Field
Required	No
Value	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes	RANGE facets also return the individual facets within the results.
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.infix.<lpse_code> panl.range.suffix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.value.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.<lpse_code> panl.range.max.value.<lpse_code> panl.range.max.wildcard.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.infix.<lpse_code>

Set the infix that appears between the minimum and maximum values that a range can have

Scope	Field
Required	No
Value	String
Default	~
Location	<panl_collection_url>.panl.properties
Notes	If the panl.range.facet.<lpse_code> is not set to true, then this field will be silently ignored. If not included, is an empty or blank value, it will default to the tilde character. This value CAN NOT be a hyphen/minus (i.e. '-') character.
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.suffix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.value.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.<lpse_code> panl.range.max.value.<lpse_code> panl.range.max.wildcard.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.max.<lpse_code>

Set the maximum selectable value for the range.

Scope	Field
Required	Yes
Value	Integer or Decimal
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	If the panl.range.facet.<lpse_code> is not set to true, then this field will be silently ignored.
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.infix.<lpse_code> panl.range.suffix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.value.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.value.<lpse_code> panl.range.max.wildcard.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.max.value.<lpse_code>

Set the replacement value if the range is the maximum value.

Scope	Field
Required	Optional
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	If the panl.range.facet.<lpse_code> is not set to true, then this field will be silently ignored.
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.infix.<lpse_code> panl.range.suffix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.value.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.<lpse_code> panl.range.max.wildcard.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.max.wildcard.<lpse_code>

Set whether the range will include values greater than the maximum value if the maximum value is passed through.

Scope	Field
Required	No
Value	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes	If the panl.range.facet.<lpse_code> is not set to true, then this field will be silently ignored.
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.infix.<lpse_code> panl.range.suffix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.value.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.<lpse_code> panl.range.max.value.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.min.<lpse_code>

Set the minimum selectable value for the range.

Scope	Field
Required	Yes
Value	Integer or Decimal
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	If the panl.range.facet.<lpse_code> is not set to true, then this field will be silently ignored.
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.infix.<lpse_code> panl.range.suffix.<lpse_code> panl.range.min.value.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.<lpse_code> panl.range.max.value.<lpse_code> panl.range.max.wildcard.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.min.value.<lpse_code>

Set the replacement value if the range is the minimum value.

Scope	Field
Required	Optional
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	If the panl.range.facet.<lpse_code> is not set to true, then this field will be silently ignored.
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.infix.<lpse_code> panl.range.suffix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.<lpse_code> panl.range.max.value.<lpse_code> panl.range.max.wildcard.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.min.wildcard.<lpse_code>

Set whether the range will include values less than the minimum value if the minimum value is passed through.

Scope	Field
Required	No
Value	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes	If the panl.range.facet.<lpse_code> is not set to true, then this field will be silently ignored.
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.infix.<lpse_code> panl.range.suffix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.value.<lpse_code> panl.range.max.<lpse_code> panl.range.max.value.<lpse_code> panl.range.max.wildcard.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.prefix.<lpse_code>

Set the prefix for the range which will be prepended to the URL path part.

Scope	Field
Required	No
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	If the panl.range.facet.<lpse_code> is not set to true, then this field will be silently ignored.
See also	RANGE Facet panl.range.infix.<lpse_code> panl.range.suffix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.value.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.<lpse_code> panl.range.max.value.<lpse_code> panl.range.max.wildcard.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.suffix.<lpse_code>

Set the suffix for the range which will be appended to the URL path part.

Scope	Field
Required	No
Value	String
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	If the panl.range.facet.<lpse_code> is not set to true, then this field will be silently ignored.
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.infix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.value.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.<lpse_code> panl.range.max.value.<lpse_code> panl.range.max.wildcard.<lpse_code> panl.range.suppress.<lpse_code>

panl.range.suppress.<lpse_code>

Sets whether to suppress the output of the range facet in the available filters response object

Scope	Field
Required	Optional
Value	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes
See also	RANGE Facet panl.range.prefix.<lpse_code> panl.range.infix.<lpse_code> panl.range.min.<lpse_code> panl.range.min.value.<lpse_code> panl.range.min.wildcard.<lpse_code> panl.range.max.<lpse_code> panl.range.max.value.<lpse_code> panl.range.max.wildcard.<lpse_code>

panl.results.fields.<field_set>

Define a FieldSet for the CaFUP which will configure the fields that are returned with the results.

Scope	Collection
Required	No
Value	List<String> - A comma separated list of Solr field names
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	There will ALWAYS be a FieldSet named 'default' which, if not defined, will include all of the fields.
See also	panl.results.fields.default panl.results.fields.empty

panl.results.fields.default

Define a FieldSet for the CaFUP which will configure the fields that are returned with the results.

Scope	Collection
Required	No
Value	List<String> - A comma separated list of Solr field names
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	There will ALWAYS be a FieldSet named 'default' which, if not defined, will include all of the fields.
See also	panl.results.fields.<field_set> panl.results.fields.empty

panl.results.fields.empty

A FieldSet which always returns no documents.

Scope	Collection
Required	No
Value	List<String> - A comma separated list of Solr field names
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes	There will ALWAYS be a FieldSet named 'empty' which returns no fields from the Panl server (and therefore no documents). If this FieldSet is defined, then the overriding definition will be ignored and no Solr fields will be returned.
See also	panl.results.fields.<field_set> panl.results.fields.default

panl.results.testing.urls

Whether to enable the in-built Panl Results Viewer, Panl Results Explainer, and Single Page Search web apps.

Scope	Server
Required	No
Value	Boolean
Default	false
Location	panl.properties
Notes	Setting this to false will disable Panl from serving up the testing web apps, i.e.: Panl Results Viewer Panl Results Explainer Panl Single Page Search It is recommended that this is set to false for production use.
See also

panl.results.sort.fields

Configure which fields are able to be used to sort the returned documents

Scope	Collection
Required	Optional
Value	List<String> - a list of Solr field names
Default	N/A
Location	panl.properties
Notes	The default sorting option in Solr is relevance descending, this will override the default sort Multiple, multi-level sorts are available.
See also

panl.status.404.verbose

Whether to return a verbose error message if an HTTP 404 (Not Found) status code occurs.

Scope	Server
Required	No
Value	Boolean
Default	false
Location	panl.properties
Notes
See also	panl.status.500.verbose

panl.status.500.verbose

Whether to return a verbose error message if an HTTP 500 (Internal Server Error) status code occurs.

Scope	Server
Required	No
Value	Boolean
Default	false
Location	panl.properties
Notes
See also	panl.status.404.verbose

panl.suffix.<lpse_code>

Set the suffix for the URL path value.

Scope	Field
Required	Optional
Value	String
Default	N/A
Location	panl.properties
Notes
See also	panl.suffix.<lpse_code>

panl.type.<lpse_code>

This is the Solr field type that is defined in the managed schema XML file.

Scope	Field
Required	Yes
Value	String
Default	N/A
Location	panl.properties
Notes	This value is taken from the Solr managed schema XML file and SHOULD NOT be altered unless the underlying data type in Solr has also changed. This property drives configuration options for the available Panl field.
See also

panl.when.<lpse_code>

Only display this facet if any of the LPSE code values have already been selected

Scope	Collection
Mandatory	Optional
Values	List<Character> - comma separated list of LPSE codes
Default	N/A
Location	<panl_collection_url>.panl.properties
Notes
See also

solr.default.query.operand

The default Solr query operand that acts on the search query, either - for OR, or + for AND.

Scope	Collection
Required	No
Value	Character
Default	-
Location	<panl_collection_url>.panl.properties
Notes	MUST be either a '-' (for OR) or '+' (for AND) character The Panl server will refuse to start if it is any other character is set
See also

solr.facet.limit

The maximum number of facets that will be returned for each individual facet.

Scope	Collection
Required	No
Value	Integer
Default	100
Location	<panl_collection_url>.panl.properties
Notes	Will output a WARN error on Panl server startup, or if the value cannot be parsed to an integer
See also

solr.facet.min.count

The minimum count value for a facet to be returned with the results.

Scope	Collection
Required	No
Value	Integer
Default	1
Location	<panl_collection_url>.panl.properties
Notes	Will output a WARN error on Panl server startup, or if the value cannot be parsed to an integer
See also

The minimum number that the count of results within a facet must contain to be returned with the results. For example, if search results are returned and there exist some facets where no results would exist if the facet was chosen

It is recommended to set this value to at least 1 (one), as setting it to zero would allow the selection of the facet to return 0 (zero) results which will not filter the results at all.

solr.highlight

Whether to return highlighted information with the results JSON.

Scope	Collection
Required	No
Value	Boolean
Default	false
Location	<panl_collection_url>.panl.properties
Notes
See also

solr.numrows.default

The default number of rows to return for this collection's search. This can be changed per search request by using the panl.param.numrows LPSE code in the URL path.

Scope	Collection
Required	No
Value	Integer
Default	10
Location	<panl_collection_url>.panl.properties
Notes	Will output a WARN error on Panl server startup, or if the value cannot be parsed to an int
See also	panl.param.numrows

solr.search.server.url

Defines the URL(s) that the SolrJ client will use to connect to the Solr server instance(s).

Scope	Server
Required	Yes
Value	List<String> - Either a single URL, or a comma separated list of URLs
Default	N/A
Location	panl.properties
Notes	The URL may also include a zookeeper: prefix if a connection to a zookeeper instance is required.
See also	solrj.client

solrj.client

Sets the SolrJ client that Panl will use to connect to the Solr server.

Scope	Server
Required	Yes
Value	String One of: Http2SolrClient HttpJdkSolrClient LBHttp2SolrClient CloudSolrClient
Default	N/A
Location	panl.properties
Notes	If not set, the Panl server will error and refuse to start The above values are relevant to Solr version 9.x.x, other versions of the Solr server may have different properties
See also	solr.search.server.url

The above property will influence the values that are appropriate for the solr.search.server.url property.

~ ~ ~ * ~ ~ ~

Synapticloop :: Panl

Welcome to the Panl Book

A Note On Page Generation

Properties Quick Reference

View this project on github

Properties Quick Reference

Property References Format Explained

panl.bool.<lpse_code>.false

panl.bool.<lpse_code>.true

panl.collection.<solr_collection_name>

panl.date.<lpse_code>.days

panl.date.<lpse_code>.hours

panl.date.<lpse_code>.months

panl.date.<lpse_code>.next

panl.date.<lpse_code>.previous

panl.date.<lpse_code>.years

panl.decimal.point

panl.facet.<lpse_code>

panl.facetsort.<lpse_code>

panl.field.<lpse_code>

panl.form.query.respondto

panl.include.same.number.facets

panl.include.single.facets

panl.lpse.ignore

panl.lpse.length

panl.lpse.order

panl.multivalue.<lpse_code>

panl.name.<lpse_code>

panl.or.facet.<lpse_code>

panl.or.always.<lpse_code>

panl.param.numrows

panl.param.numrows.prefix

panl.param.numrows.suffix

panl.param.page

panl.param.page.prefix

panl.param.page.suffix

panl.param.passthrough

panl.param.passthrough.canonical

panl.param.query

panl.param.query.operand

panl.param.sort

panl.prefix.<lpse_code>

panl.range.facet.<lpse_code>

panl.range.infix.<lpse_code>

panl.range.max.<lpse_code>

panl.range.max.value.<lpse_code>

panl.range.max.wildcard.<lpse_code>

panl.range.min.<lpse_code>

panl.range.min.value.<lpse_code>

panl.range.min.wildcard.<lpse_code>

panl.range.prefix.<lpse_code>

panl.range.suffix.<lpse_code>

panl.range.suppress.<lpse_code>

panl.results.fields.<field_set>

panl.results.fields.default

panl.results.fields.empty

panl.results.testing.urls

panl.results.sort.fields

panl.status.404.verbose

panl.status.500.verbose