Skip to main content
Version: 8.8 (unreleased)

Upload a document to a BPMN process

You can implement document uploads in your BPMN processes using forms, inbound connectors, and the Camunda 8 REST API.

Build a form for document upload​

When building a form for a process, you can use the Filepicker form component to allow users to upload files.

In the Filepicker configuration, you can specify whether users can upload a single file or multiple files and define the list of supported file formats.

Form with Filepicker

A designed form can be linked to a user task or used to start a process. Documents uploaded with the form can then be referenced later in the process.

Upload a document from a user task in Tasklist​

When the process is deployed and running, users can access and complete user tasks that include a form with the Filepicker component in Tasklist:

document handling in tasklist

Upload a document to start a process​

You can configure a form with the Filepicker for a start event of a BPMN process to allow users to upload documents when initiating the process. This is supported in Tasklist and is available to logged-in users.

note

Only logged-in users can upload files. Publicly accessible processes with a start form do not support file upload using the Filepicker.

Get reference to an uploaded document​

Uploaded documents can be referenced later in the process.

Filepicker's output variable is an array of objects with document metadata. It always returns an array of objects, whether a user uploads a single document or multiple documents.

Single document uploads are accessible using value[1] (since FEEL uses 1-based indexing).

Upload a document via inbound webhook connector​

Documents can be added to a process using the inbound HTTP webhook connector.

You can pass the documents in both the response expression and the result expression, where the documents object contains the references for created documents. Below, review an example of a webhook configuration:

Example payload of inbound webhook connector

In this example, the result expression may look as follows, where applicationDocument can be later used by the process to retrieve documents:

{
  applicationDocument: documents[1]
}

The document reference received as an output of one connector should be stored in process variables by using the result expression or result variable.

To call the webhook sending a file, for example:

curl --location 'https://some.dev.environment/uploadDocument' \
--form 'file=@"/path-to-file/file.pdf"'

The result variable will have the following structure:

{
 "request": {
   "body": {},
   "headers": {
     "host": "lpp-1.connectors.camunda.io",
     "x-request-id": "335843238a709273200e2055f89147ad",
     "x-real-ip": "109.78.172.42",
     "x-forwarded-host": "lpp-1.connectors.camunda.io",
     "x-forwarded-port": "443",
     "x-forwarded-proto": "https",
     "x-forwarded-scheme": "https",
     "x-scheme": "https",
     "content-length": "70484",
     "user-agent": "PostmanRuntime/7.43.0",
     "accept": "*/*",
     "cache-control": "no-cache",
     "postman-token": "b9d78973-b33f-43a4-8d55-c5ac8b2de656",
     "accept-encoding": "gzip, deflate, br",
     "content-type": "multipart/form-data; boundary=--------------------------300742796701946745140414"
   },
   "params": {}
 },
 "connectorData": {},
 "documents": [
   {
     "storeId": "gcp",
     "documentId": "130ad52a-f90a-4e07-9cfa-0d9abb0b6a68",
     "contentHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
     "metadata": {
       "contentType": "application/pdf",
       "size": 70266,
       "fileName": "file.pdf"
     },
     "camunda.document.type": "camunda"
   }
 ]
}