Skip to main content
Version: 8.7

Document preview

A form element to preview and download documents.

Form Document preview Symbol

Configurable properties​

General​

  • Title: Title displayed on top of the element.
  • Document reference: Data used to render documents.
    • Accepts an array of objects with document metadata.
    • Can only be an expression.
    • The resulting value must have the following structure:
[
  {
    "documentId": "u123",
    "endpoint": "https://api.example.com/documents/u123",
    "metadata": {
      "fileName": "Document.pdf",
      "contentType": "application/pdf"
    }
  }
]
note

When previewing documents that were uploaded via Filepicker in Tasklist, document references are handled automatically:

  • Modifying the document’s metadata after upload may prevent the preview from working correctly.
  • To use Camunda's document service without Filepicker, you must include the contentHash, endpoint, and documentId values.

Condition​

Layout​

  • Columns: Space the field will use inside its row.
    • Auto means it will automatically adjust to available space in the row. Read more about the underlying grid layout in the Carbon Grid documentation.

Appearance​

  • Max height of preview container: A number which will define the maximum height of each document preview. Any document with a bigger height will display a scroll bar.

Additional guides​

Design process applications for document handling with the Document preview component.