DC-UI Kickstart Guide
A beginner-friendly, hands-on introduction to DC-UI—the web-based experience plugin for managing DataCollector. Get comfortable before the deep dive in Week 5.
📖What is DC-UI and Why We Need It
DC-UI (DataCollector UI) is a web-based Experience Platform plugin that provides a complete interface for managing DataCollector. It's the primary way administrators and developers interact with data collection systems without touching configuration files or APIs directly.
Brief Overview
DC-UI is loaded as an Experience Platform plugin and integrates with DataCollector's REST API. All configuration edits, inventory triggers, entity browsing, and health monitoring happen through the UI—either via visual forms or direct YAML editing with validation.
Key Capabilities at a Glance
| Capability | What It Does |
|---|---|
| Inventories | View systems, monitor real-time status, trigger inventory runs |
| Entities Explorer | Browse collected entities (users, groups, etc.) with filtering |
| Admin Events | Track health checks, triggers, config changes |
| Configuration | Manage systems, credentials, schemas (view in this kickstart) |
| Analytics | Analyze past inventory runs (covered in Week 5) |
This kickstart covers read-only exploration and basic workflows. Week 5 Day 27 covers configuration editing, schema designers, debugging, and advanced features in full detail.
🚀Getting Started with DC-UI
How to Access DC-UI
DC-UI is available through the Experience Platform. Use the following URL pattern:
https://<experience-host>/dc-ui/
For example, in the EmpowerNow lab environment:
https://experience.self.empowernow.ai/dc-ui
The /dc-ui path is the plugin's root. Sub-routes include /dc-ui/systems (Inventories page — the path is /systems, the breadcrumb label is "Inventories"), /dc-ui/entities-explorer, /dc-ui/analytics (Past Inventory Runs list), /dc-ui/analytics/admin-events, /dc-ui/config/systems, etc.
Main Navigation Areas
- Inventories – Systems list, per-stream status, trigger runs, commands
- Entities Explorer – Browse collected entities by system
- Past Inventory Runs – Detailed run analysis with multiple drill-down tabs (Week 5)
- Cross-Inventory View – Multi-run analysis across time (Week 5)
- Admin Events – Audit trail of operations
- Config – Systems, System Types, Strategies, Connectors, Schemas, Credentials
DC-UI Layout Diagram
🗺️Interactive Guided Tour
Follow these step-by-step workflows to get hands-on with DC-UI. Each workflow ends with a "Try it yourself" exercise.
- Navigate to Inventories page – Click "Inventories" in the main nav (or go to
/dc-ui). - Understand the system list columns:
- System Name – Identifier for the data source
- System Type – Template (e.g., LDAP, SCIM)
- Inventory Status – Running, Not Running, or Stopping
- Health mini-graph – 24-hour timeline of success/failure bars
- Entities – Count with eye icon linking to Entity Explorer
- Click on the Health mini-graph – Opens a view of admin events for that system (filtered to
category=health_check).
Multi-stream systems show their streams as sub-rows under the parent system, each with its own status, controls, and (when applicable) command buttons. A system with one stream looks like a flat single row — same as before streams existed. Commands are buttons that run administrative actions (like "Force Full Sync") without starting a full inventory; they appear on stream rows or system rows depending on how the strategy declared them. Day 26 covers the underlying concepts.
✋ Try it yourself
Hands-on exercise: Find a system in the Inventories list and check its health status. Click the health mini-graph and note what admin events appear. If the system has multiple streams, expand it and observe the per-stream controls.
What are entities?
Entities are the collected data objects from your systems—users, groups, accounts, etc. Each entity has transformed_data (the mapped fields) and metadata (keys, timestamps, hash).
- Navigate to Entities Explorer – Click "Entities" in the nav.
- Select a system from the dropdown.
- Choose entity type – e.g., users, groups, accounts.
- Filter by date ranges – Updated On, Last Confirmed, Created, Store Updated (four independent ranges).
- Click the eye icon on a row to view full entity details (transformed_data JSON, keys, timestamps).
✋ Try it yourself
Hands-on exercise: Find and inspect 5 users from a specific system. Use the date filter to narrow results if needed.
What is an inventory?
An inventory is a run that connects to a system, collects entities, and optionally persists or publishes changes. Each inventory belongs to a stream — a multi-stream system can have its streams running concurrently. You can trigger inventories manually from DC-UI.
Five Trigger Modes
DC has five engine-level trigger modes. The Trigger Type modal in DC-UI surfaces them as four cards — Replay and Readonly Replay share one card with a Mode Switch. Day 27 covers the modal mechanics in detail.
| Mode | Description | Use Case |
|---|---|---|
| New Writable | Production run with persistence | Normal scheduled runs |
| Existing Readonly | Resume from DB without modifications | Inspect interrupted runs |
| Detached Readonly | In-memory test, no persistence | Safe for testing—does not affect production |
| Replay | Re-publish stored entity data to destinations | Recover when a downstream consumer missed events |
| Readonly Replay | Like Replay but no destination publishing | Preview what a replay would publish |
When learning or validating config changes, always use Detached Readonly. It runs in memory and does not persist to the database—perfect for safe experimentation. Day 26 covers all five modes in depth.
- On Inventories page, find a system and click the trigger button.
- Select Detached Readonly mode.
- Choose inventory_input – Empty or from previous run.
- Trigger and watch real-time status updates.
- View results after completion (steps, connector calls, changes).
✋ Try it yourself
Hands-on exercise: Trigger a Detached Readonly inventory on a system and observe the status changes. Note when it completes and what summary is shown.
What are admin events?
Admin events are an audit trail of operations: health checks (automatic and manual), inventory triggers, configuration changes, system enable/disable, and DC lifecycle events.
- Navigate to Admin Events page – Click "Admin Events" in the nav.
- Filter by category – Health checks, triggers, config changes.
- Filter by system – Narrow to a specific system.
- Click an event to view full details (timing, errors, YAML diffs for config changes).
✋ Try it yourself
Hands-on exercise: Find the last 3 health check events for a system. Note the timestamp and outcome (success/failure) for each.
In this kickstart we only view configuration—editing is covered in Week 5.
- Navigate to Config > Systems – Opens the systems configuration list.
- View system details – Click a system to see its configuration (connection, destinations, etc.).
- See credential pointer – Each system references credentials via a pointer (e.g.,
openbao+kv2://secret/datacollector/system-name). - Check diff destinations – Where changes are published. The three destination types are EmpowerID (API sync), Kafka (streaming), and File (local YAML, mainly for debugging).
- Per-stream
next_inventory_input– Each stream has its own NII (the JSON state passed forward to its next inventory). You'll edit it routinely; for now, just notice it exists per stream, not per system.
✋ Try it yourself
Hands-on exercise: Find a system's credential pointer. Note the vault path format.
🎨UI Components Quick Reference
A visual guide to the common UI elements you'll see in DC-UI.
Entity Badges
System System Type Strategy Connector Credential SchemaThe six entity badge types are the canonical visual identity in DC-UI (colors come straight from ENTITY_CONFIGS: System blue, System Type purple, Strategy green, Connector teal, Credential amber, Schema pink). You'll meet all of them on day one — System and System Type on the Inventories page, Strategy and Connector inside system editors, Credential in the credential picker, Schema on schema-mapping pages.
Status Indicators
● Running ● Success ● FailureRunning = active; Success/Failure = completed state.
Health Mini-Graph
24-hour timeline: green bars = success, red bars = failure. Click to see admin events.
Entity Count Tags
Shows count per entity type (e.g., "users: 150"). Eye icon links to Entity Explorer filtered to that type.
❓Common Questions & Troubleshooting
Check that DataCollector is running and has systems configured. Systems are defined in Config. If you're in a lab environment, ensure the DataCollector service and configs are deployed. Also verify your user has the right role for DC-UI access — typically app_user for read-only, app_admin for editing systems and triggering inventories, or platform_admin for strategy management. Day 26 covers the auth model in detail.
The Inventories page polls status on the interval declared in the plugin manifest (currently ~2 seconds). For systems with one stream, the Inventory Status appears on the system row. For multi-stream systems, each stream has its own status as a sub-row, with its own instance_id (which DC pod is running it) and Stop button. The status updates automatically—no refresh needed.
It shows the last 24 hours of health check results. Each bar is a check: green = success, red = failure. Automatic health checks run on a schedule (default ~15 min). Click the graph to see the underlying admin events with timestamps and error messages.
Use the Entities Explorer. Select a system, choose an entity type (users, groups, etc.), and browse. You can filter by date, export to CSV/JSON, and click the eye icon to inspect full entity details including transformed_data.
➡️Next Steps
- Week 5 Deep Dive: Day 27 covers DC-UI in comprehensive detail—configuration designers, schema mapping editors, debugging with DETACHED_READONLY, analytics tabs, and more.
- Practice the workflows: Revisit each workflow until you're comfortable. The hands-on exercises build muscle memory.
- Explore Admin Events: Get familiar with the audit trail—it's invaluable when troubleshooting.
You've completed the DC-UI kickstart. You can now navigate Inventories, browse Entities, trigger test inventories, view Admin Events, and inspect system configuration. Week 5 will take you into editing, debugging, and advanced analytics.
📝Day 16 Checkpoint
- Understand what DC-UI is and its key capabilities
- Know how to access DC-UI via
/dc-ui/ - Can view systems and health status on Inventories page
- Can browse entities in Entities Explorer
- Can trigger a DETACHED_READONLY inventory
- Can find admin events and filter by category
- Can view system configuration (credential pointer, diff destinations)
- Recognize UI components (badges, status indicators, health mini-graphs)