Skip to main content
Version: Next

Document handling

Offering a more comprehensive approach to document handling, Camunda now provides efficient storage and retrieval of documents across both development and production environments.

Whether you are working across Connectors, Modeler, or Tasklist, document handling may be beneficial for users who want the following:

  • Use the default cloud storage to support, track, and manage documents.
  • AWS S3 storage and bucket creation per cluster to securely store and retrieve documents in an external, scalable storage solution, and to ensure storage is properly isolated and managed for each environment.
  • Support for the local file system as a storage option for development and testing purposes to set up and manage documents in local environments.

Modeler​

A form can display documents with the document preview component:

document preview for form

With the filepicker form element, you may also upload multiple files at once. This can be dynamically set using an expression.

Connectors​

Inbound (webhook) Connectors​

Access created documents in both the response expression and the result expression, where the documents object contains the references for created documents.

example payload inbound webhook connector

Outbound Connectors​

For the following outbound Connectors, you may include a Request body under Payload in the properties panel to send with your request:

  • REST - Supports storing the response as a document.
  • Email - Supports sending Camunda documents as attachments, or storing incoming attachments as Camunda documents.
  • Amazon Textract - Can read the input document directly from the Camunda document store.
  • Amazon Bedrock - Supports consuming documents as inputs for conversations.
  • Amazon S3 - Supports uploading documents from (or downloading documents to) the Camunda document store.
  • Box - Supports uploading documents from (or downloading documents to) the Camunda document store.

example REST configuration

Tasklist​

Tasklist users may view and download files displayed in the task's form.

note

If you change the Document URL under Download settings, this feature will not work for public start forms because there is no valid session.

document preview settings

Document limitations​

Document handling maintains the following guidelines:

  • Maximum file size: 10 MB per file.
  • File expiration time/time-to-live (TTL) policy: 30 days by default. Clients for Connectors and Forms may specify a custom expiration date when uploading documents.