Report Builder and Analytics Guide

Overview

The Report Builder is a powerful, low-code tool for creating custom reports and analytics. Build reports by dragging fields, applying filters, querying related data (collections), and using pivot tables for interactive analysis.

Prerequisites:

• Permission: Permission.Report.View (for viewing reports)
• Permission: Permission.Report.Create (for creating reports)
• Permission: Permission.Report.Edit (for editing reports and managing folders)

1. Report Builder Basics

Path: Reports ? “Create Report” OR “Edit Report”

1.1 User Interface Overview

Three-Panel Layout:

Left Panel: Available Fields

• Accordion organized by category
• Search box to filter fields
• Drag fields to add to report
• Shows field data types
• Badges for custom fields

Main Panel: Report Configuration

• Report Settings (name, description, category)
• Selected Fields list (reorderable)
• Filters section
• Collection Queries section (related data)
• Preview area

Top Toolbar:

• Preview button: Run report and see results
• Save Report button: Save configuration

1.2 Choosing an Entity Type

First Step: Select what you want to report on.

Entity Type Dropdown (top of left panel):

Core Entities:

• Cases: Individual disease cases
• Contacts: Contact tracing records
• Outbreaks: Outbreak investigations
• Patients: Patient demographics (multiple cases per patient)
• Tasks: Task management records
• Locations: Physical locations
• Events: Time-bound gatherings

Flattened Views (Advanced):

• Case Tasks + Transmission Chains: Cases with all tasks (multi-row per case)
• Outbreak Tasks (Sub-Outbreaks): Outbreak tasks including child outbreaks
• Case Timeline (All Events): All case activity timeline
• Network Nodes (for graphs): Contact tracing network data
• Network Edges (for graphs): Contact relationships
• Contacts List (Simple): Simplified contact list view

What are Flattened Views?

• Special pre-configured database views
• One entity can generate multiple rows
• Example: One case with 5 tasks ? 5 rows in report
• Useful for detailed analysis and exports