Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 4.42 KB

README.md

File metadata and controls

70 lines (46 loc) · 4.42 KB
Raw

Community badge: Incubating Community extension badge Compatible with: Camunda Platform 8

camunda-8-connector-officetopdf

This connector creates a PDF from an Microsoft Office or an Open Office document.

Principle

A Process Variable provides the document, as a File Reference File Storage. or via a Load Connector.

The connector transform the document in PDF. It may be a multi page PDF.

Inputs

Name Description Class Default Level
sourceFileVariableFileVariable For the file to convert java.lang.Object REQUIRED
destinationFileName Destination file name java.lang.String REQUIRED
destinationStorageDefinition Storage Definition use to describe how to save the file. If not provided, the Source file's storage definition is used. java.lang.String JSON OPTIONAL

The sourceFileVariable file is accessible via a reference. Visit File Storage library. The file can be saved as a process variable in JSON, or in an external Folder, a CMIS repository, etc...

Connectors to load and save files are available in the repository Cherry Framework Component LoadFileFromDisk load a file from a disk, and SaveFileToDisk save the file on a disk.

The destinationStorageDefinition indicates where the PDF file is produced. According to the File Storage library, If the destinationStorageDefinition is not provided, then the storage of the source file is used.

Output

Name Description Class Level
pdfFileVariable FileVariable converted (a File Variable Reference) java.lang.Object REQUIRED

BPMN Errors

Name Explanation
LOAD_FILE_ERROR Load File error
CONVERSION_ERROR Conversion error

Manipulating file

Via the File Storage library, The process variable contains only a reference. The core document, which may be saved in a Folder, Temporary Folder, or CMIS or any repository available via the library.

The result is saved in the File Storage: this is why the connetor ask for a StorageDefinition. The result process variable will contains only the reference to the file. If no "destinationStorageDefinition" is provided, the PDF is saved in the same storage than the source document.

To get the result of the file on a file system, use any connector or application using the File Storage API.

Find the user documentation in our Camunda Platform 8 Docs.

Build

mvn clean package

Two jars are produced. The jar with all dependency can be upload in the Cherry Framework

Element Template

The element templates can be found in the element-templates/office-to-PDF.json file.