Funnelback logo

Documentation

CATEGORY

Develop

This page gives an overview of key resources and APIs for web developers who need to do advanced customisation or programmers developing applications on top of Funnelback.

Programming Options

Interfaces
Overview of the different search interfaces available (Modern UI including XML and JSON modes, and Classic UI including RSS and XML mode).
REST API using search.xml (Modern UI) or xml.cgi (Classic UI)
Integrate XML results from Funnelback into your application by making HTTP GET calls.
Workflow
Modify the Funnelback engine workflow to call your own programs and scripts at key points in the update sequence.
Funnelback Feeds
Develop your own adapters to control the content within Funnelback indexes..
User interface hook scripts
Insert Groovy scripts in the search process (Modern UI only).
XML documents
Process XML documents.
Indexer Options
Command line options for modifying the indexer.
Query Processor Options
Command line options for modifying the query processor.
Groovy Filters
Insert Groovy scripts in the filtering process
Result transforms (Classic UI)
Write Perl code to transform results at query time
Query transformations (Classic UI)
Write Perl code to transform queries.

Key Programs and scripts

PADRE
The core indexer and query processor and their associated binaries.
Webcrawler
The Funnelback web crawler.
cache controller (Modern UI) or cache.cgi (Classic UI)
Display cached copies of gathered data

Modern UI

search.html
The main search web interface of the Modern user interface
search.xml
Process raw XML results (XML search wrapper)
search.json
Process JSON results

Classic UI

search.cgi
The main search web interface of the Classic user interface
xml.cgi
Process raw XML results (XML search wrapper)
rss.cgi
Generate RSS feeds for search results.

Reference Documents

Configuration files
List of key configuration files
Collection.cfg parameters
Full list of all collection.cfg parameters
Data Model (Modern UI)
Data Model reference for the Modern UI
FreeMarker tags (Modern UI)
FreeMarker tag reference for the Modern UI
Geospatial search
A how-to for enabling geospatial search
General Scopes (gscopes)
Information on the 'gscopes' search scoping system
Numerical Metadata
How to work with numeric metadata.
Alternative Metadata Values
Handling metadata values which vary with another parameter
Search form tags (Classic UI)
Form tag reference for the Classic UI
Metadata classes
List of supported metadata classes
Query Language Help
Query language reference
Query operator
Modify queries
Query logs
Query log format
Click logs
Click log format
Funnelback Ranking Algorithms
Technical details on how Funnelback ranks documents
Character set
Details on how character sets are handled
Language support
Details on the various languages supported by Funnelback
Command line administration
An overview of various command line tools that may support integration

See also

top ⇑