Universal Configuration Console

Universal Configuration Console (UCC) is a Splunk-supported framework that simplifies the process of creating Splunk add-ons for developers. UCC provides a comprehensive solution for add-on development by automatically generating essential components that developers typically need to build manually.

With UCC, you can build add-ons that generate UI components, REST handlers, and modular inputs. You can also set up authentication and other configurations, as well as create monitoring dashboards with detailed health checks for ingested data. These checks cover volume, resource usage, and errors from connections, settings, permissions, and authentication.

Using only a few UCC commands, you can quickly initialize, build, and package your add-on to fully automate the add-on development process. UCC minimizes administrative overhead and helps you create professional, consistent add-ons with little Python coding.

Note: UCC is also the foundation for building add-ons that adhere to the set of best practices and guidelines promoted by Splunk. For more information, see Splunk Gold Standard for add-ons.

To see an example add-on built with UCC, see splunk-example-ta on GitHub. Watch the following video for a quick overview of what UCC can do for you:

Key benefits and features

UCC is more than a UI generator. It's a comprehensive framework that automatically generates a complete add-on structure with all the essential components needed for professional Splunk add-ons, while also providing extensibility for custom requirements.

Development efficiency

Reduces development time through automated code generation
Minimizes administrative overhead with only 3 commands needed to initialize, build, and package add-ons
Simplifies updates and modifications to existing add-ons
Maintains consistency by ensuring uniform look and feel across different add-ons

Standards and monitoring

Implements Splunk development standards and best practices
Provides a granular monitoring dashboard with volume, resource usage, and errors for the ingested data
Built-in performance monitoring for add-on health checks
Alert actions for triggered alerts

User interface and configuration

Web-based configuration interface for easy setup and management
Consistent UI components that follow Splunk design standards
User-friendly forms for configuring data inputs and settings
Support for complex input types like multiselect and radio buttons

Data collection and processing

Modular input mechanisms for collecting data from various sources
Helper modules that simplify data processing workflows
Python REST handlers to support UI operations
Properly formatted configuration files for Splunk platform integration

Integration and extensibility

REST API endpoints for programmatic configuration management
Automatically generated OpenAPI documentation
Support for custom validators and dynamic UI behavior
Extension capabilities for custom code and build processes
Lightweight .conf-only deployments for minimal overhead
Managed Python dependencies and metadata files

Core libraries

UCC-based add-ons rely on 3 key libraries that serve distinct but complementary purposes:


Library	Description
`addonfactory-ucc-generator`	The main UCC library with a developer toolkit for creating Splunk add-ons with standardized, UI-driven configuration, back-end logic, and packaging. The library provides a command-line tool that scaffolds, builds, and packages all the components needed for a fully functional Splunk add-on. It also relies on the other core libraries to provide shared logic, abstractions, and helpers used in generated add-ons. For more information, see addonfactory-ucc-generator on GitHub.
`solnlib`	A solutions library that provides common utility functions and classes for add-on development. This library simplifies essential tasks such as managing configuration files, handling modular inputs, and interacting with Splunk REST endpoints. The library handles configuration file operations like reading, writing, and validation. For modular inputs, it provides setup, parameter validation, and checkpointing capabilities. It also manages REST endpoint interactions and provides logging and error handling. These capabilities make `solnlib` essential for data collection, configuration management, and operational tasks in UCC-generated add-ons. For more information, see addonfactory-solutions-library-python on GitHub.
`splunktaucclib`	A library specifically designed to support UCC-generated add-ons. This library provides the Python classes that implement REST handlers, modular inputs, and helper modules for UCC add-ons. It ensures consistent integration with UCC-generated UI and standardizes add-on behavior. The library handles authentication, validation, and error handling for REST handlers and modular inputs, making it the backbone of UCC's framework functionality. For more information, see addonfactory-ucc-library on GitHub.

Next step

To start building add-ons with UCC, see the UCC Framework documentation.