View Source

h3. {anchor:export}confluence-reporting:export
{quote}
Export a confluence page either in PDF or DOC
{quote}

h4. Mojo Attributes
* Since version: {{3.4.3}}

h4. Optional Parameters

||Name||Type||Description||
|[endPoint|#endPoint]|String|Confluence end point url Default value is http://localhost:8080/rpc/xmlrpc|
|[failOnError|#failOnError]|boolean|Indicates whether the build will continue even if there are clean errors. Default value is true|
|[outputFile|#outputFile]|File|output file - if missing it will be $\{project.build.directory\}/$\{title\}.$\{outputType\}|
|[outputType|#outputType]|String|type of output - either 'pdf' or 'doc' Default value is pdf|
|[pageTitle|#pageTitle]|String|title of pageTitle that will be deleted Default value is $\{project.build.finalName\}|
|[parentPageId|#parentPageId]|String|Confluence parent page id.
If set it is possible to avoid specifying parameters spaceKey and parentPageTitle|
|[parentPageTitle|#parentPageTitle]|String|Confluence parent page title Default value is Home|
|[password|#password]|String|Confluence password|
|[properties|#properties]|Map|additional properties pass to template processor|
|[serverId|#serverId]|String|Issue 39
Server's {{id}} in {{settings.xml}} to look up username and password.
Defaults to {{$\{url\}}} if not given.|
|[spaceKey|#spaceKey]|String|Confluence target confluence spaceKey|
|[sslCertificate|#sslCertificate]|SSLCertificateInfo|if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).
Below the Template
{noformat}
< sslCertificate>
< ignore>true|false</ignore> // default false
< hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
< trustManagerClass>FQN</trustManagerClass> // default null
< /sslCertificate>
{noformat}|
|[username|#username]|String|Confluence username|
h4. Parameter Details

h5. {anchor:endPoint}endPoint
Confluence end point url
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.endPoint\}|
||Default|http://localhost:8080/rpc/xmlrpc|
h5. {anchor:failOnError}failOnError
Indicates whether the build will continue even if there are clean errors.
||Type|boolean|
||Since|5.0-rc1|
||Required|No|
||Expression|$\{confluence.failOnError\}|
||Default|true|
h5. {anchor:outputFile}outputFile
output file - if missing it will be $\{project.build.directory\}/$\{title\}.$\{outputType\}
||Type|java.io.File|
||Since|3.4.3|
||Required|No|
h5. {anchor:outputType}outputType
type of output - either 'pdf' or 'doc'
||Type|java.lang.String|
||Since|3.4.3|
||Required|No|
||Expression|$\{outputType\}|
||Default|pdf|
h5. {anchor:pageTitle}pageTitle
title of pageTitle that will be deleted
||Type|java.lang.String|
||Since|3.4.3|
||Required|No|
||Expression|$\{confluence.page\}|
||Default|$\{project.build.finalName\}|
h5. {anchor:parentPageId}parentPageId
Confluence parent page id.
If set it is possible to avoid specifying parameters spaceKey and parentPageTitle
||Type|java.lang.String|
||Since|4.10|
||Required|No|
||Expression|$\{confluence.parentPageId\}|
h5. {anchor:parentPageTitle}parentPageTitle
Confluence parent page title
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.parentPage\}|
||Default|Home|
h5. {anchor:password}password
Confluence password
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.password\}|
h5. {anchor:properties}properties
additional properties pass to template processor
||Type|java.util.Map|
||Required|No|
h5. {anchor:serverId}serverId
Issue 39

Server's {{id}} in {{settings.xml}} to look up username and password.
Defaults to {{$\{url\}}} if not given.
||Type|java.lang.String|
||Since|3.1.1|
||Required|No|
||Expression|$\{confluence.serverId\}|
h5. {anchor:spaceKey}spaceKey
Confluence target confluence spaceKey
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.spaceKey\}|
h5. {anchor:sslCertificate}sslCertificate
if using a https url, configure if the plugin accepts every certifactes or
respects hostnameVerifierClass and trustManagerClass (if set).

Below the Template

{noformat}

< sslCertificate>
< ignore>true|false</ignore> // default false
< hostNameVerifierClass>FQN</hostNameVerifierClass> //default null
< trustManagerClass>FQN</trustManagerClass> // default null
< /sslCertificate>

{noformat}
||Type|org.bsc.ssl.SSLCertificateInfo|
||Since|4.1.0|
||Required|No|
h5. {anchor:username}username
Confluence username
||Type|java.lang.String|
||Required|No|
||Expression|$\{confluence.userName\}|