How to Use this Documentation

Audience and Scope

This guide is intended for search application developers and administrators who want to use the LucidWorks Platform to create world class search applications for their websites.

While the LucidWorks Platform is built on Solr, and many of its features are implementations of Solr and Lucene features, this Guide does not cover basic Solr or Lucene configuration. We do, however, point out where the LucidWorks Platform, and LucidWorks Enterprise or LucidWorks Cloud specifically, deviates from Solr or Lucene standard configuration practices, and have provided links to Solr and Lucene documentation where possible for further explanation if the functionality in the LucidWorks Platform is identical to Solr or Lucene. One important note to remember is that LucidWorks is multi-core enabled by default, with collection1 as the default core. This means that standard Solr paths such as http://localhost:port/solr/*, as shown in Solr documentation, would be http://localhost:port/solr/collection1/* in LucidWorks Enterprise or LucidWorks Cloud.

Conventions

Special notes are included throughout these pages.

Note Type

Look & Description

Information

Notes with a blue background are used for information that is important for you to know.

Notes

Notes are further clarifications of important points to keep in mind while using LucidWorks Enterprise.

Tip

Notes with a green background are Helpful Tips.

Warning

Notes with a red background are warning messages.

Some features of the LucidWorks Platform are available for LucidWorks Enterprise only. The following panel will appear on any page or section that is for LucidWorks Enterprise users only:

This functionality is available in LucidWorks Enterprise but not LucidWorks Cloud.

API Conventions

Parameters

Parameters shown in paths that need to be modified for your installation and specific configuration are indicated in italics.

For example, getting the status of a data source is shown as:

GET /api/collection/collection/datasources/id.

If you were using 'collection1' and data source '3', you would enter:

GET /api/collection/collection1/datasources/3.

Getting Support

Lucid Imagination has created two forums for users to ask questions and get help from other users and Lucid Imagination developers and technical experts. LucidWorks Enterprise users are invited to access http://www.lucidimagination.com/forum/lwe, while LucidWorks Cloud customers can access http://www.lucidimagination.com/forum/cloud. Please note that the LucidWorks Cloud forum is currently restricted to Cloud customers only; access is provided when your instances are provisioned.

Premium support for both flavors of LucidWorks is available with a subscription.