Documentation v2.9

Welcome to the Documentation page for LUX Version 2.9. This page contains the most recent guides and manuals for LUX administrators and developers. Links to documentation for prior releases of LUX is also available at the bottom of this page.


LUX Installation Guide

Instructions for installing the LUX UI, Engine, Databases, and all prerequisite software.

LUX Upgrade Guide

Instructions for upgrading both the LUX UI & Engine components to LUX v2.9 from v2.8.

LUX Operations Guide

System Administrator’s Guide for stopping, starting, and performing other common tasks for all LUX components.

Engine Administration Console Guide

Instructions for using the EAC to monitor the health and status of LUX, as well as how to make real-time changes to the Engine.

Engine and Plugins Configuration Guide

Configuration options for the Engine and all standard Plugins.

Rule Form Creation Guide

Instructions for creating custom Rule Forms for data sources in the LUX UI.

Event Query Syntax Guide

Guide for writing LUX Event Queries used in Rule Forms and plugin configuration.

LUX Entity Manager Setup Guide

Reference Material for Entity Manager Configurations.

Entity Features & Configuration Guide

Reference material describing features & configuration of LUX Entity Layers.


PDK Guide

Instructions for using the Plugin Development Kit to develop new LUX Plugins.

Adding a Data Source and Rule Form

Guide to adding a new data source to LUX, both Engine and UI.

LUX Integration Options

Software architecture diagrams displaying several patterns for LUX integration.


Interface Control Document for LUX REST services.


Collection of macros and functions that provide the building blocks for developing templates that display the properties and attributes in a series of collapsible tables.


© 2020 Illumina Consulting Group, Inc. All rights reserved. | Built by Englund Studio