Skip to content

AcuGIS CLI: Jasper reports

The acugis reports commands reuse the CLI's configured Central session and base URL. Authenticate first with:

acugis login https://reports.example.test

The client sends the resulting session cookie; it does not use bearer tokens, JWTs, API keys, or Jasper-specific credentials.

acugis reports list

acugis reports list
acugis reports list --json

Resolution order:

  1. Central GET /api/catalog, using its reports bucket.
  2. Jasper GET /jasper-report-services/api/discovery/index.php, then /api/discovery.
  3. Jasper GET /jasper-report-services/api/reports, then /api/reports/index.php.

Catalog and discovery rows are enriched with the registry's report name and datasource when possible. The human output contains ID and title, plus name when it differs. --json emits the selected/enriched list.

acugis reports info REPORT

acugis reports info sales-summary
acugis reports info sales-summary --json

REPORT is matched case-insensitively by exact ID, then name, then title across Central catalog, discovery, and registry. Ambiguous titles fail and require a unique ID. As a final fallback, report-like input is requested directly from:

GET /jasper-report-services/reports/get_report_config.php?report=REPORT

The command shows definition metadata and parameters, then fetches the registry to add its entry. --json emits a CLI-composed payload containing catalog/config/registry data, viewer and execution URLs; it is not the raw response from one server endpoint despite the option help text saying “raw API payloads.”

acugis reports run REPORT

acugis reports run sales-summary --format pdf
acugis reports run sales-summary \
  --param region=North \
  --param product_id=100 \
  --param product_id=200 \
  --format xlsx \
  --output sales-summary.xlsx \
  --force

Options:

  • --format FORMAT: html, pdf, xlsx, xls, csv, docx, rtf, odt, ods, pptx, or xml. The report definition's format/outputFormat is used when omitted, then html.
  • --param, -p KEY=VALUE: repeatable. Repeated keys remain repeated query parameters.
  • --output, -o PATH: destination; defaults to a sanitized report name plus format extension.
  • --force: replace an existing destination.
  • --quiet: suppress progress.
  • --json: suppress progress and emit local execution metadata after saving.

The CLI first performs the same resolution/config requests as info, validates submitted names and required parameters against the definition, and then streams:

GET /jasper-report-services/reports/execute_report.php
    ?_repName=...
    &_repFormat=...
    &_dataSource=...
    &<report parameters>

The server still controls authorization and execution. The CLI rejects unknown parameters when definition metadata is available. It also redacts parameters marked sensitive:true or typed password/secret from --json output.

acugis reports download REPORT

download accepts the same options and uses exactly the same implementation as run:

acugis reports download sales-summary --format pdf --output report.pdf

There is no separate pre-generated download endpoint. Both commands execute a fresh report and stream the response to disk through a temporary .part file.

Placeholders

The following commands are registered but call the CLI's not_implemented() helper and do not contact Jasper:

acugis reports publish
acugis reports delete

The service does have HTML form routes for publishing and deletion, but they are UI-only, not suitable command APIs. Deletion currently mutates state through a GET route.

Service endpoints not mapped by the CLI

The reports command group has no commands for:

  • Datasource registry or datasource administration.
  • Explicit discovery output or resource sync.
  • Raw report definition or thumbnail retrieval.
  • Interactive viewer or generated report images.
  • Report edit/publish/delete management.
  • Scheduling, execution history, recipients, or email-template actions.
  • Session and parameter-pipeline debug probes.

Use the documented HTTP integration endpoints directly where appropriate. Do not automate UI-only routes or the currently nonfunctional email-template action.

CLI error behavior

  • 401/403: shown as an expired/missing session prompt to run acugis login <url>; this can also mask a genuine report ACL denial.
  • 404: report not found.
  • 400: server error text/JSON is surfaced when available.
  • 502/503 or connection failure: Jasper service unavailable.
  • Empty execution body, interrupted transfer, invalid output path, and overwrite conflicts fail without replacing a completed destination.