From 45a48a83eb1e8a677c47cce4e01152ad57747292 Mon Sep 17 00:00:00 2001
From: watts <benjamin.watts@psi.ch>
Date: Wed, 10 Jun 2026 22:27:57 +0200
Subject: [PATCH] Update ZMQ Publisher Reference

---
 ZMQ-Publisher-Reference.md | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/ZMQ-Publisher-Reference.md b/ZMQ-Publisher-Reference.md
index fca5a23..54ee9b5 100644
--- a/ZMQ-Publisher-Reference.md
+++ b/ZMQ-Publisher-Reference.md
@@ -18,6 +18,16 @@ Example:
 ['beamShutterStatus', 'red']
 ```
 
+## 'filename'
+
+Indicates where scan data will be saved during the measurement. Follows after a 'scanStarted' message. Depending on the scan archive status pf the scan type, the scan data file may be moved out of the "discard" subdirectory after the scan has finished.
+
+
+```
+['filename', 'Sample_Image_2026-06-10_034.hdf5', '/home/control/LocalData/2026-06-10/discard']
+```
+
+
 ## 'focalStatus'
 
 Provides the maximum OSA gap (distance between sample and OSA) that would fit the current FZP focal length and OSA diameter.
@@ -49,7 +59,7 @@ Example:
 
 ## 'scanFinished'
 
-These messages are published to indicate that a scan has completed and no further 'scanLineData' will be coming. The data provides info on where the data was saved and a flag that indicates why the scan finished.
+These messages are published to indicate that a scan has completed and no further 'scanLineData' will be coming. The data provides info on where the data file was saved/moved to and a flag that indicates why the scan finished. Scan data is typically saved in the 'neXusDiscardSubDirectory' during the scan and then may be moved (depending on the archive status of the scan type) out of this subdirectory.
 
 | Flag Value | Condition |
 | ---------- | --------- |
@@ -126,9 +136,10 @@ Example:
 ## 'scanTypeArchive'
 
 
+
 Example:
 ```
-['scanTypeArchive', {'attrActual': '', 'attrNew': ''}]
+['scanTypeArchive', {'attrActual': 'archive', 'attrNew': 'locked'}]
 
 ```