Report Server Automation

Automate Report Server

Use the REST API, command line, and SDKs to integrate reporting into applications, scripts, and operational workflows.

Automation is a capability of AcuGIS Report Server. It is the same reporting platform you run yourself, not a separate Report Designer edition.

Explore Report Server View Documentation

Automation Overview

Automate the same reporting platform you run yourself. Generate reports, pass parameters, integrate reporting into applications, and automate server-side workflows using the REST API and command line.

REST API

Call Report Server from applications and scripts through the versioned REST API and the report execute gateway.

OpenAPI Documentation

A running server serves an OpenAPI 3.0 document and Swagger UI for the same API contract the SDKs and CLI use.

Command-Line Automation

Use acugis-report from shell scripts, cron, and CI to publish, run, and inspect reports.

Application Integration

Keep reporting on Report Server and call it from the applications and operational systems you already run.

Parameterized Execution

Supply JRXML parameters when a report runs from the REST API, an SDK, or the command line.

Server-Side Workflows

Run reports on demand from your own jobs, or on a schedule configured in the Report Server administration UI.

REST API

Applications and scripts interact with Report Server programmatically. The versioned API lives under /api/v1. Report execution uses the execute gateway at /reports/execute.

On a running server, Swagger UI is at /swagger. The OpenAPI document is at /api/openapi.yaml and /api/openapi.json.

REST API Documentation

Authenticated access with a Bearer API token or the jrs_session cookie
Report catalog, configuration, and execution
Report parameters, including repeated keys for multi-value parameters
Output formats documented for report execution, including PDF, HTML, XLSX, XLS, and CSV
OpenAPI documentation shipped with the server

Authenticated execute request from the parameters and execute documentation. _repName, _repFormat, and the report’s own parameters are query fields.

REST API

curl -sS -H "Authorization: Bearer $ACUGIS_REPORT_TOKEN" \
  -o invoice.pdf \
  "$ACUGIS_REPORT_URL/reports/execute?_repName=Invoice&_repFormat=pdf&InvoiceID=123"

SDKs

Official SDKs wrap the Report Server OpenAPI contract. Python, .NET, Java, and Go share ACUGIS_REPORT_URL, ACUGIS_REPORT_TOKEN, and the same report operations. JavaScript embedding is covered with Embedded Analytics, not as one of these clients.

Python

Install acugis-report from PyPI for the Python SDK and Report Server CLI.

Python SDK documentation View on PyPI

.NET

Package AcuGIS.Report. Repository path sdk/dotnet.

.NET SDK documentation

Java

Package com.acugis.report. Repository path sdk/java.

Java SDK documentation

Go

Repository path sdk/go. Use the module path published in that module.

Go SDK documentation

Language guides and the shared client workflow are in the SDK overview.

Command Line

acugis-report is the Report Server command-line client. Install it from PyPI with pip, then use it from shell scripts, cron, CI/CD, and other operational workflows.

INSTALL

pip install acugis-report

CLI

acugis-report reports run Invoice \
  --param InvoiceID=123 \
  --output invoice.pdf

Parameters

Repeat --param for multi-value parameters, or pass --params with a JSON file.

Formats

HTML, PDF, XLSX, XLS, CSV, DOCX, RTF, ODT, ODS, PPTX, and XML. Set --format when the file name should not decide it.

Scripts and CI

Use environment variables or profiles, --output json before the subcommand, and doctor or whoami in a pipeline.

Binary results are written to --output or --stdout. Place global --output json before the subcommand.

CLI Reports CLI Automation GitHub Actions

Common Automation Workflows

Use the API and command line for on-demand runs. Use the administration UI for schedules and email delivery. Those schedule screens are not part of the REST API or CLI yet.

Scheduled Reports

Run reports on a schedule configured in the administration UI. Docker uses the report scheduler service. The native package uses systemd timers.

Email Delivery

Scheduled jobs can email report output when SMTP is configured. Recipients are managed in the administration UI.

Output Files

Generate PDF, HTML, XLSX, XLS, CSV, and the other execution formats. The CLI writes a file. The execute API returns the same bytes for your application to store.

External Systems

Integrate Report Server into other applications and operational systems with the REST API, SDKs, or CLI. Calls use the authenticated user’s existing permissions.

Schedule and mail settings are described in the reports guide, Docker scheduling, and SMTP configuration. Execution formats are listed in supported formats.

Automation, Embedded Analytics, and MCP Server

Report Server has three integration options. Choose the one that matches how another system should use your reports.

Automation

Use APIs, SDKs, and the CLI to run Report Server from applications and workflows.

Embedded Analytics

Embed Report Server reports, charts, maps, or analytics experiences into applications.

Embedded Analytics

MCP Server

Allow compatible AI clients to discover and query governed Report Server datasets through MCP. This is a Professional capability.

MCP Server

Automate the reporting platform you already control.

Use Report Server APIs and command-line tools to integrate reporting into your applications and operational workflows.

Explore Report Server View Documentation