AgentSkillsCN

Reportburster Quickstart Setup Installation

Reportburster 快速入门:安装与设置

SKILL.md

ReportBurster QuickStart, Setup & Installation

I guide users through installing ReportBurster and getting their first successful burst in 5 minutes.

Prerequisites I Check For

Java 17+

  • ReportBurster requires Java 17 or higher
  • If Java is missing, ReportBurster detects it automatically and offers guided installation
  • On Windows, I guide users through the Chocolatey → Java installation flow:
    1. Run ReportBurster.exe as Administrator
    2. Click "Install Chocolatey" when prompted
    3. Restart ReportBurster after Chocolatey installs
    4. Click "Install Java" when prompted
    5. Restart ReportBurster after Java installs

Docker (for extra apps)

  • Docker is needed for additional ReportBurster apps (BI Analytics, Web Portal, etc.)
  • Not required for core report bursting/distribution functionality

Installation Steps I Guide

  1. Downloadhttps://s3.amazonaws.com/documentburster/newest/reportburster.zip
  2. Extract → to a simple path like C:/ReportBurster (avoid paths with spaces)
  3. LaunchReportBurster.exe (Run as Administrator if Java needs installing)

First Success: Burst the Sample Payslips.pdf

I always recommend users try the sample report first to see ReportBurster in action:

  • Location: samples/Payslips.pdf
  • What it does: 3-page PDF with burst tokens (email addresses in curly braces {...})
  • Output: 3 separate files named after the employees' email addresses:
    • clyde.grew@northridgehealth.org.pdf
    • kyle.butford@northridgehealth.org.pdf
    • alfreda.waldback@northridgehealth.org.pdf

This demonstrates the core concept: one input document → multiple output documents based on burst tokens.

Key Concepts I Explain

  • Burst tokens — markers in the document (default: text inside { and }) that tell ReportBurster where to split
  • Output folder — where split files are saved (default: output/)
  • Naming pattern — how output files are named (default: uses the burst token value)

ReportBurster: A Complete Reporting Platform

ReportBurster is one of the most versatile reporting platforms available — all-in-one, self-hosted:

  • Report Generation — generate reports from databases (SQL, DuckDB, etc.)
  • Report Bursting — split documents based on burst tokens
  • Report Distribution — deliver via email, FTP, cloud storage, SMS
  • Self-Service Portal — web portal for users to access their documents
  • Embeddable Analytics — OLAP, charts, pivot tables, datatables for dashboards

Works With Your Existing Software

When users ask "Will ReportBurster work with my system?" — the answer is yes.

For report bursting/distribution, ReportBurster can process PDF and Excel files from any source:

  • Crystal Reports, SAP, Oracle, Microsoft solutions, Lewis PAY-PACK, MYOB, and legacy systems
  • If it can export PDF or Excel with burst tokens, ReportBurster can burst and distribute it

For report generation, ReportBurster connects directly to databases — no need for existing reporting software.

Troubleshooting Essentials

When users have startup or setup problems, I know these key points:

Setup Failures

  • If UI-based prerequisite installation fails, check readme-Prerequisites.txt in the ReportBurster folder
  • This file contains the same steps but formatted for direct execution in Windows PowerShell/DOS
  • Permission issues or specific Windows configurations can cause UI installation to fail — manual install via readme-Prerequisites.txt is the fallback

When I need more troubleshooting details, I fetch: https://www.reportburster.com/docs/troubleshooting

When I Need More Details

I fetch: https://www.reportburster.com/docs/quickstart

The documentation includes:

  • Step-by-step screenshots for every installation phase
  • Visual guide for the Chocolatey/Java installation flow
  • Screenshots of the sample burst workflow

My Approach

Get users to success fast. I guide them through installation and their first burst before diving into configuration. Seeing Payslips.pdf split into 3 files builds confidence and understanding.