PreEmptive Analytics Workbench User Guide

Plugins

Customizing the Computation Service requires creating Microsoft .NET Framework binaries as Plugins. A Sample Plugin project, written in C#, has been included in the Sample folder, <Installation Folder>\Samples. This project includes examples of each type of component that can be included in a plugin:

  • Indexer: extracts data from analytics messages to temporary storage, and defines how data is output to permanent storage
  • Server Query: defines data from permanent storage to be exposed via the Query API
  • Custom Data Filter: an enhanced API for creating indexers and queries that only focuses on custom data
  • Pattern: an enhanced API that modifies all installed Indexers and Queries, enabling organization of all data by a specific set of fields

By deploying a custom Plugin, Workbench can be extended to aggregate and/or report on additional data. Alternatively, Plugins (including default ones) can be removed to disable existing aggregations and/or reports. This can help limit disk usage and/or improve scalability.

To deploy a Plugin:

  1. Build the Plugin project.
  2. Locate the Plugin folder, <Installation Folder>\PreEmptive Analytics Workbench\config\Plugins\, on your Workbench host.
  3. Copy your Plugin DLL into <Plugin folder>\local. This folder is reserved for custom Plugins and will not be overwritten by any future update.
    • Alternatively, you can create a new folder within the Plugin folder, and copy your Plugin there instead.
    • Note that all the default Plugins provided by PreEmptive can be found in <Plugin folder>\preemptive. Contents of this folder might be overwritten by a future update.
  4. If your plugin depends on other DLLs, copy them into <Plugin folder>\local\Dependencies.
    • If you created your own folder, you can create a Dependencies folder within your new folder and copy the dependency DLLs there instead.
  5. Restart the PreEmptive Analytics Workbench Computation Service (from Run > services.msc).
  6. Restart the PreEmptive Analytics Workbench Endpoint and PreEmptive Analytics Workbench Portal IIS websites (from Run > inetmgr).

To remove a Plugin:

  1. Locate the Plugin folder, <Installation Folder>\PreEmptive Analytics Workbench\config\Plugins\, on your Workbench host.
  2. Stop the PreEmptive Analytics Workbench Computation Service (from Run > services.msc).
  3. Stop the PreEmptive Analytics Workbench Endpoint and PreEmptive Analytics Workbench Portal IIS websites (from Run > inetmgr).
  4. Remove your plugin DLL from <Plugin folder>\local and all relevant dependency DLLs from <Plugin folder>\local\Dependencies.
    • If you created a separate folder for your Plugin, you can just remove that entire folder.
    • Note that all the default plugins provided by PreEmptive can be found in <Plugin folder>\preemptive. It is possible to remove plugins from this folder, but be aware that they may be re-added by a future update.
  5. Start the PreEmptive Analytics Workbench Computation Service (from Run > services.msc).
  6. Start the PreEmptive Analytics Workbench Endpoint and PreEmptive Analytics Workbench Portal IIS websites (from Run > inetmgr).

Please see Troubleshooting if you encounter any issues.

Default Plugin reference:

Source code for all default Plugins is available from PreEmptive Solutions. While the Sample Plugin is useful to understand the basics of creating Plugins, the Advanced Topics and Full Pipeline pages assume access to this source code for demonstrating more advanced situations.



Workbench Version 1.2.0. Copyright © 2016 PreEmptive Solutions, LLC