Disclaimer
This repository is provided "AS-IS" with no warranty or support given. This is not an official or supported product/use case.
Download the extension package from
https://github.com/ptc-iot-sharing/SolrThing/releases/download/v6.0.137/Solr.zip
Description
Apache Lucene is a high-performance, full featured text search engine library written in Java.
Apache Solr is an enterprise search platform written using Apache Lucene. Major features include full-text search, index replication and sharding, and result faceting and highlighting.
This project is an extension for TWX that allows it to interface with Solr.
Services
ExecuteQuery(coreName, query, sortExpression, filterExpression, dataShape, maxItems): Returns matching records from the Solr server taking into account the name of the data core (coreName), the user input from the search box, as a string (query), according to the data model specified in the Thingworx DataShape (datashape). The maximum number of results can be limited by specifying a integer (maxItems). This is the default search method, implements this class.
ExecutePagedQuery(coreName, query, sortExpression, filterQuery, dataShape, startAtIndex, stopAtIndex):
Same as ExecuteQuery with the option to specify the index number, so within the entire result set you can start and stop at an arbitrary point. This enables the Next Page/Previous Page functionality within the search mashup CollectionView widget.
ExecutePHQuery(coreName, query, sortExpression, filterQuery, dataShape, startAtIndex, stopAtIndex):
Same as ExecutePagedQuery but returns the data with html tags highlighting the search term. This highlighting can be viewed in a html text area widget.
saveDatashape(coreName,dataShapeName):
Calls the getDatashape service to automatically generate the Thingworx DataShape from the Solr data model. This is run before the query and the result is used as a parameter on the Solr query services.
GetNumberOfResults(coreName,query, sortExpression, filterQuery, dataShape)
Returns the number of records matching a query, without the associated records. This is used to update the mashup labels describing how many results have been found.
IndexDocument(coreName, document-JSON) and IndexMultipleDocuments
This provides a facility to import data into the Solr server, if its formatted as JSON. This is not used in the current implementation.
ExecuteFuzzyQuery(currentTerm, maxEdits, prefixLen, maxExpansions, transpositions)
An implementation of the Apache Lucene Query Parser and Lucene Search Fuzzy Query class that allows to configure fuzzy querying parameters. Experimental, implements this class.
Configuration
password - the password if it is configured
serverName - the IP address or hostname of the Solr server
serverPort - the port that is configured to receive queries on the Solr server
userName - the username that will be used together with the password to authenticate, can be blank
timeout - after this interval if a response is not received the connection will time out, in miliseconds
useSSL - a boolean that indicates whether or not the connection is secured with SSL
This README file only contains basic setup instructions. For more comprehensive documentation, visit: