GenerateDocumentStep - bluesoft-rnd/aperte-workflow-core GitHub Wiki

This step implementation is part of Report Step plugin. It provides means to generate documents using Jasper Reports template engine and store results into CMIS repository.

Parameters

Please note that documents are stored in ${rootFolderPath}/${newFolderPrefix}${ProcessInstance.internalId}/${subFolder} directory.

Parameter name Type Required Default value Description
reportName String True Name of the report that is going to be used.
defaultLocaleName String False Deprecated.
localeAttributeKey String False java.util.Locale The name of the process instance attribute that hold the locale definition.
format String False PDF Generated report file format. Supported values: PDF, HTML, XLS, CSV.
locale Locale False Locale.ENGLISH Generated report file locale. It can be overwritten with localeAttributeKey parameter.
encoding String False Cp1250 Generated report file encoding.
outputFileName String False report.pdf Generated report file name.
mimeType String False application/pdf Report file MIME Type. Important for uploading inside the CMIS repository.
repositoryAtomUrl String True CMIS repository Atom URL.
repositoryUser String True CMIS repository user.
repositoryPassword String True CMIS repository password.
repositoryId String True CMIS repository id.
rootFolderPath String False / CMIS repository root folder path. This path should already exist inside CMIS repository.
subFolder String False CMIS subfolder name. If no value is given then no subfolder is going to be created and documents will be stored directly into process instance directory.
newFolderPrefix String False Prefix used when creating a folder dedicated to a process instance on CMIS.
popup String False Should the uploaded content be displayed by CMIS DocumentList Wiget as popup window. Allowed values are: ALWAYS, ONCE. If no value is given this won't be used.

Example

<java auto-wire="true" cache="false" class="pl.net.bluesoft.rnd.pt.ext.jbpm.JbpmStepAction" method="invoke"
      name="PRINT" var="result" g="1003,984,80,40">
    <field name="stepName">
        <string value="GenerateDocumentStep"/>
    </field>
    <field name="params">
        <map>
            <entry>
                <key><string value="reportName"/></key>
                <value><string value="summary"/></value>
            </entry>
            <entry>
                <key><string value="repositoryUser"/></key>
                <value><string value="Administrator"/></value>
            </entry>
            <entry>
                <key><string value="repositoryPassword"/></key>
                <value><string value="Administrator"/></value>
            </entry>
            <entry>
                <key><string value="repositoryId"/></key>
                <value><string value="6f37b3de-310d-46f8-a6f6-78ac16888c78"/></value>
            </entry>
            <entry>
                <key><string value="repositoryAtomUrl"/></key>
                <value><string value="http://localhost:8080/alfresco/service/cmis"/></value>
            </entry>
            <entry>
                <key><string value="rootFolderPath"/></key>
                <value><string value="/aw/samples"/></value>
            </entry>
            <entry>
                <key><string value="subFolder"/></key>
                <value><string value="businesstrip_summary"/></value>
            </entry>
            <entry>
                <key><string value="newFolderPrefix"/></key>
                <value><string value=""/></value>
            </entry>
            <entry>
                <key><string value="popup"/></key>
                <value><string value="once"/></value>
            </entry>
            <entry>
                <key><string value="outputFileName"/></key>
                <value><string value="sample #{processId} #{datetime}.pdf"/></value>
            </entry>
            <entry>
                <key><string value="format"/></key>
                 <value><string value="pdf"/></value>
            </entry>
        </map>
    </field>
    <transition name="WAITING_FOR_DOCS" to="WAITING_FOR_DOCS" g="992,926:-75,-32"/>
</java>

Aperte Workflow
http://www.aperteworkflow.org

⚠️ **GitHub.com Fallback** ⚠️