From 2ac83cea1a80755fe7f7bd31a4754e875b5ac0db Mon Sep 17 00:00:00 2001
From: Jeffrey Douangpaseuth <11084623+Nephery@users.noreply.github.com>
Date: Wed, 5 Jun 2024 14:13:21 -0400
Subject: [PATCH] add docs for CorrelationData with batched messages

---
 .../solace-spring-cloud-stream-starter/README.adoc   | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/solace-spring-cloud-starters/solace-spring-cloud-stream-starter/README.adoc b/solace-spring-cloud-starters/solace-spring-cloud-stream-starter/README.adoc
index 6915dade..b3fc1192 100644
--- a/solace-spring-cloud-starters/solace-spring-cloud-stream-starter/README.adoc
+++ b/solace-spring-cloud-starters/solace-spring-cloud-stream-starter/README.adoc
@@ -1107,6 +1107,18 @@ public void send(String payload, long timeout, TimeUnit unit) {
     }
 }
 ----
+
+.CorrelationData with Batched Messages
+[NOTE]
+====
+When using <<Batch Producers>>, the `SolaceBinderHeaders.CONFIRM_CORRELATION` header must be set at the root of the batched message, and **not** in the `SolaceBinderHeaders.BATCHED_HEADERS` header.
+
+The `CorrelationData.getFuture()` will be resolved:
+
+* Successfully once all messages in the batch have been successfully delivered to the destination.
+* Failed upon the first delivery error encountered while publishing the batch of messages.
+====
+
 == Solace Binder Health Indicator
 Solace binders can report health statuses via the https://docs.spring.io/spring-cloud-stream/docs/{scst-version}/reference/html/spring-cloud-stream.html#_health_indicator[Spring Boot Actuator health endpoint]. To enable this feature, add Spring Boot Actuator to the classpath. To manually disable this feature, set `management.health.binders.enabled=false`.