sonar-export-report

Generates a report file based on a report template and saves it to the specified path.

Command properties

Item	Description
Command type	Driver query
Required permission	Login required
License usage	Not counted
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

sonar-export-report template=STR format={docx|html|pdf|hwpx} from=STR to=STR path=STR

Options

template=STR: GUID of the report template
format={docx|html|pdf|hwpx}: Report file format

docx: Microsoft Word document
html: HTML document
pdf: PDF document
hwpx: Hangul (HWP) document

from=STR: Start time of the report data range. Specify in yyyyMMddHHmmss format. Trailing digits can be omitted and are filled with zeros.
to=STR: End time of the report data range. Specify in yyyyMMddHHmmss format. Trailing digits can be omitted and are filled with zeros.
path=STR: Path where the report file will be saved

Output fields

Field	Type	Description
`file_path`	string	Path of the generated report file
`file_name`	string	Name of the generated report file
`file_size`	long	Size of the generated report file (bytes)

Error codes

Parse errors

Error code	Message	Description
300101	Invalid sonar session.	The session is invalid or the user cannot be found.
300111	Specify template option.	The `template` option is missing.
300112	Invalid template guid format.	The `template` option value is not in GUID format.
300113	Report template not found.	No report template exists for the specified GUID.
300114	Specify 'from' option in yyyyMMddHHmmss format.	The `from` option is missing or has an invalid format.
300115	Specify 'to' option in yyyyMMddHHmmss format.	The `to` option is missing or has an invalid format.
300116	Specify path option.	The `path` option is missing.
300117	Specify format option.	The `format` option is missing.

Runtime errors

Error code	Message	Description	Post-processing
-	report build task is cancelled	The report generation task was cancelled.	Aborts the query.
-	cannot find report	The result cannot be found after report generation.	Aborts the query.
-	cannot write report	An I/O error occurred while saving the report file.	Aborts the query.

Description

The sonar-export-report command generates a report based on the specified template and time range, then saves the result to the specified file path. Report generation is processed asynchronously; the command waits until generation is complete before rendering.

If the parent directory of the output path does not exist, it is created automatically.

Examples

Generate a PDF report

sonar-export-report template=550e8400-e29b-41d4-a716-446655440000 format=pdf from=20260301 to=20260401 path=/opt/logpresso/reports/monthly.pdf

Generates a PDF report for March 2026 using the specified template.

Generate a DOCX report

sonar-export-report template=550e8400-e29b-41d4-a716-446655440000 format=docx from=20260317000000 to=20260317235959 path=/opt/logpresso/reports/daily.docx

Generates a Word report for March 17, 2026 using the specified template.