Developing your first plugin

Plugins intended for use in the SXC or Funnelback 16 Cloud require a review before they can be used and this is currently only available to internal Squiz developers.

Introduction

This guide will walk you through the steps to create your first Funnelback plugin. Upon completion you will have a plugin that can be deployed onto a Funnelback instance. The plugin in this guide changes the title of every search result that a user performs, replacing a common prefix if it appears.

Part 1. Setting up your development environment

A suitable development environment should be setup before attempting to write any Funnelback plugins. This guide covers installing the third-party tools that are required for plugin development that do not belong to Funnelback. The plugin guide assumes that these tools are installed and being used to develop the plugin.

Part 2. Generating a plugin

Part 3. Writing your plugin

Part 4. Packaging and deploying your plugin

Troubleshooting plugins

Source files

The source code for the title prefix plugin is available from github at https://github.com/FunnelbackPtyLtd/funnelback-plugin-examples/tree/master/title-prefix-plugin.

© 2015- Squiz Pty Ltd