ct-reporting-maven-plugin

The ct-reporting-maven-plugin provides tools to manage report template deployment. This section describes the configuration properties. This plugin is available since version 1.2.3 of ct-reporting.

Goals

help

Display help for the ct-reporting-maven-plugin.

> mvn de.conterra.reporting:ct-reporting-maven-plugin:<version>:help -Ddetail=true

Set <version> to your current ct-reporting version, for example 1.2.3

Parameter Default Description

Parameter	Default	Description
`detail`	`false`	If true, display all settable properties for each goal.
`goal`	`-`	The name of the goal for which to show help. If unspecified, all goals are displayed.
`indentSize`	`2`	The number of spaces per indentation level, should be positive.
`lineLength`	`80`	The maximum length of a display line, should be positive.

detail

false

If true, display all settable properties for each goal.

goal

-

The name of the goal for which to show help. If unspecified, all goals are displayed.

indentSize

2

The number of spaces per indentation level, should be positive.

lineLength

80

The maximum length of a display line, should be positive.

deployReport

Can be used to deploy a report template to the report service.

Binds by default to the package lifecycle.

deployReport Sample

<plugin>
    <groupId>de.conterra.reporting</groupId>
    <artifactId>ct-reporting-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>deploy-report</id>
            <goals>
                <goal>deployReport</goal>
            </goals>
            <configuration>
                <!-- report file or directory -->
                <file>${basedir}/target/my-report.zip</file>
                <!-- the report server endpoint definition -->
                <reportsEndpoint>http://www.mapapps.de/mapapps/resources/reports</reportsEndpoint>
                <!-- username and password -->
                <username>admin</username>
                <password>admin</password>
                <!-- or a token e.g. if security.mode=OAUTH -->
                <token>ab3434hab3434j00b3j34</token>
            </configuration>
        </execution>
    </executions>
</plugin>

Parameter Default Description

Parameter	Default	Description
`file`	`${project.build.directory}/report.zip`	The file to upload (zip) or a directory which is zipped before upload.
`reportId`	the filename	The ID of the report. If not provided, the filename is used.
`reportTitle`	the reportId	The title of the report. If not provided the reportId is used.
`reportDescription`	`-`	The description of the report
`reportsEndpoint`	`http://localhost:8080/resources/reports`	URL pointing to the report server.
`username`	`-`	Username for authentication at the server.
`password`	`-`	Password for authentication at the server.
`token`	`-`	Access token for authentication at the server. If configured, username and password are ignored.
`outputDirectory`	`${project.build.directory}/reports`	Output directory is only used if file points to a directory. In this folder the zip is created.
`sslTrustAnyServer`	`true`	Defines if the plugin trusts any SSL servers without checking a trust store.
`useChunkedRequestEncoding`	`true`	Defines if content upload uses chunked request encoding. If set to false uploads are buffered in memory to calculate the content length.

file

${project.build.directory}/report.zip

The file to upload (zip) or a directory which is zipped before upload.

reportId

the filename

The ID of the report. If not provided, the filename is used.

reportTitle

the reportId

The title of the report. If not provided the reportId is used.

reportDescription

-

The description of the report

reportsEndpoint

http://localhost:8080/resources/reports

URL pointing to the report server.

username

-

Username for authentication at the server.

password

-

Password for authentication at the server.

token

-

Access token for authentication at the server. If configured, username and password are ignored.

outputDirectory

${project.build.directory}/reports

Output directory is only used if file points to a directory. In this folder the zip is created.

sslTrustAnyServer

true

Defines if the plugin trusts any SSL servers without checking a trust store.

useChunkedRequestEncoding

true

Defines if content upload uses chunked request encoding. If set to false uploads are buffered in memory to calculate the content length.