update document handling content (#4907)

* update-document-handling-content * remove tabs * update assets * a few more tweaks * add connectors note * add email connector details * clarify connectors details * resolve marks comments * add marcos details * resolve a few comments * resolve remaining comments * backport to 8.7 * resolve volodymyrs comment
camunda · Mar 6, 2025 · 0803430 · 0803430
1 parent ef35c4f
commit 0803430
Show file tree

Hide file tree

Showing 14 changed files with 368 additions and 68 deletions.
diff --git a/docs/components/concepts/assets/document-handling-tasklist.png b/docs/components/concepts/assets/document-handling-tasklist.png
diff --git a/docs/components/concepts/document-handling.md b/docs/components/concepts/document-handling.md
diff --git a/docs/components/connectors/out-of-the-box-connectors/amazon-bedrock.md b/docs/components/connectors/out-of-the-box-connectors/amazon-bedrock.md
@@ -129,5 +129,5 @@ The current implementation supports the assistant's responses only in text forma
 Ideally, the message's history must transit within the process and be the input of this `Converse` task with the new message.
 
 :::note
-Starting from version 8.7.0, the Amazon Bedrock Connector supports consuming documents as inputs for conversations. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the Amazon Bedrock Connector supports consuming documents as inputs for conversations. Review the **Document** field in the properties panel where the document reference can be provided. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
diff --git a/docs/components/connectors/out-of-the-box-connectors/amazon-s3.md b/docs/components/connectors/out-of-the-box-connectors/amazon-s3.md
@@ -93,7 +93,7 @@ The following JSON response is returned after a successful document upload opera
 - `link`: The document link.
 
 :::note
-Starting from version 8.7.0, the Amazon S3 Connector supports uploading documents from (or downloading documents to) the Camunda document store. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the Amazon S3 Connector supports uploading documents from (or downloading documents to) the Camunda document store. Review the **Document** field in the properties panel where the document reference can be provided. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
 
 #### Example Response

diff --git a/docs/components/connectors/out-of-the-box-connectors/amazon-textract.md b/docs/components/connectors/out-of-the-box-connectors/amazon-textract.md
@@ -138,7 +138,7 @@ The response from the **Amazon Textract Connector** mirrors the AWS Textract ser
 - **[Asynchronous Execution Response](https://docs.aws.amazon.com/textract/latest/dg/API_StartDocumentAnalysis.html#API_StartDocumentAnalysis_ResponseSyntax)**: Used for batch processing where results are returned later through job completion.
 
 :::note
-Starting from version 8.7.0, the Amazon Textract Connector can read the input document directly from the Camunda document store. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the Amazon Textract Connector can read the input document directly from the Camunda document store. Review the **Document** field in the properties panel where the document reference can be provided. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
 
 ### Use the Textract Connector response in your process

diff --git a/docs/components/connectors/out-of-the-box-connectors/box.md b/docs/components/connectors/out-of-the-box-connectors/box.md
@@ -49,7 +49,7 @@ The Box Connector supports two methods for locating items stored in your Box acc
 :::
 
 :::note
-Starting from version 8.7.0, the Box Connector supports uploading documents from (or downloading documents to) the Camunda document store. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the Box Connector supports uploading documents from (or downloading documents to) the Camunda document store. Review the **Document** field in the properties panel where the document reference can be provided. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
 
 ### Create Folder

diff --git a/docs/components/connectors/out-of-the-box-connectors/email.md b/docs/components/connectors/out-of-the-box-connectors/email.md
@@ -127,7 +127,11 @@ The task returns a JSON object containing detailed information about the email:
 - `receivedDateTime`: The email's reception datetime
 
 :::note
-Starting from version 8.7.0, the email Connector supports sending Camunda documents as attachments, or storing incoming attachments as Camunda documents. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the outbound email Connector supports sending Camunda documents as attachments.
+
+For example, the **Attachment** field in the properties panel may look as `=[ document1, document2]`.
+
+See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
 
 #### Example Response

diff --git a/...oned_docs/version-8.7/components/concepts/assets/document-handling-tasklist.png b/...oned_docs/version-8.7/components/concepts/assets/document-handling-tasklist.png
diff --git a/versioned_docs/version-8.7/components/concepts/document-handling.md b/versioned_docs/version-8.7/components/concepts/document-handling.md
diff --git a/...s/version-8.7/components/connectors/out-of-the-box-connectors/amazon-bedrock.md b/...s/version-8.7/components/connectors/out-of-the-box-connectors/amazon-bedrock.md
@@ -129,5 +129,5 @@ The current implementation supports the assistant's responses only in text forma
 Ideally, the message's history must transit within the process and be the input of this `Converse` task with the new message.
 
 :::note
-Starting from version 8.7.0, the Amazon Bedrock Connector supports consuming documents as inputs for conversations. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the Amazon Bedrock Connector supports consuming documents as inputs for conversations. Review the **Document** field in the properties panel where the document reference can be provided. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
diff --git a/...d_docs/version-8.7/components/connectors/out-of-the-box-connectors/amazon-s3.md b/...d_docs/version-8.7/components/connectors/out-of-the-box-connectors/amazon-s3.md
@@ -93,7 +93,7 @@ The following JSON response is returned after a successful document upload opera
 - `link`: The document link.
 
 :::note
-Starting from version 8.7.0, the Amazon S3 Connector supports uploading documents from (or downloading documents to) the Camunda document store. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the Amazon S3 Connector supports uploading documents from (or downloading documents to) the Camunda document store. Review the **Document** field in the properties panel where the document reference can be provided. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
 
 #### Example Response

diff --git a/.../version-8.7/components/connectors/out-of-the-box-connectors/amazon-textract.md b/.../version-8.7/components/connectors/out-of-the-box-connectors/amazon-textract.md
@@ -138,7 +138,7 @@ The response from the **Amazon Textract Connector** mirrors the AWS Textract ser
 - **[Asynchronous Execution Response](https://docs.aws.amazon.com/textract/latest/dg/API_StartDocumentAnalysis.html#API_StartDocumentAnalysis_ResponseSyntax)**: Used for batch processing where results are returned later through job completion.
 
 :::note
-Starting from version 8.7.0, the Amazon Textract Connector can read the input document directly from the Camunda document store. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the Amazon Textract Connector can read the input document directly from the Camunda document store. Review the **Document** field in the properties panel where the document reference can be provided. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
 
 ### Use the Textract Connector response in your process

diff --git a/versioned_docs/version-8.7/components/connectors/out-of-the-box-connectors/box.md b/versioned_docs/version-8.7/components/connectors/out-of-the-box-connectors/box.md
@@ -49,7 +49,7 @@ The Box Connector supports two methods for locating items stored in your Box acc
 :::
 
 :::note
-Starting from version 8.7.0, the Box Connector supports uploading documents from (or downloading documents to) the Camunda document store. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the Box Connector supports uploading documents from (or downloading documents to) the Camunda document store. Review the **Document** field in the properties panel where the document reference can be provided. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
 
 ### Create Folder

diff --git a/...ioned_docs/version-8.7/components/connectors/out-of-the-box-connectors/email.md b/...ioned_docs/version-8.7/components/connectors/out-of-the-box-connectors/email.md
@@ -127,7 +127,11 @@ The task returns a JSON object containing detailed information about the email:
 - `receivedDateTime`: The email's reception datetime
 
 :::note
-Starting from version 8.7.0, the email Connector supports sending Camunda documents as attachments, or storing incoming attachments as Camunda documents. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+Starting from version 8.7.0, the outbound email Connector supports sending Camunda documents as attachments.
+
+For example, the **Attachment** field in the properties panel may look as `=[ document1, document2]`.
+
+See additional details and limitations in [document handling](/components/concepts/document-handling.md).
 :::
 
 #### Example Response
-Original file line number
+Diff line change
@@ Expand Up @@
     :::
     :::note
-    Starting from version 8.7.0, the Box Connector supports uploading documents from (or downloading documents to) the Camunda document store. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
+    Starting from version 8.7.0, the Box Connector supports uploading documents from (or downloading documents to) the Camunda document store. Review the **Document** field in the properties panel where the document reference can be provided. See additional details and limitations in [document handling](/components/concepts/document-handling.md).
     :::
     ### Create Folder
@@ Expand Down @@