Folder upload module

The folder upload module watches one folder on the capture workstation and publishes every file created in it while a session is running. It is the way to get a file a simulator or a third-party tool writes to disk, screenshots, logs, exported telemetry, anything with no capture module of its own, into the same session as everything else HEAT Capture records.

There is no vendor SDK, driver or hardware involved: the module reads local files with the .NET filesystem watcher. Package name in the module registry: HEAT.FolderUploadModule.

What it captures

The module watches its configured folder from the start of a session. Each file created in that window is read in full and published as a FolderUploadData message, HEAT ProtoLib’s wrapper for an opaque byte payload: one field, content, the raw bytes of the file.

The original file name, extension and any other metadata are not published. If which file produced which payload matters downstream, encode that inside the file’s own content, or give the folder exactly one file at a time.

What you need

HEAT Capture installed. See Install a capture module for how to add this module to it.
A folder on the capture workstation that the whatever process writes the files can reach, and that HEAT Capture can read. The module creates the folder if it does not already exist.
Built against HEAT.Capture.ModuleSDK 2.0.5; check Configure HEAT Capture for the installed application’s own compatibility range.

Limits

The watch window is the session, plus a grace period. The module starts watching when the session starts and keeps watching through the configured delay before upload, even after the session has ended. A file written before the session starts, or after that grace period has elapsed, is never captured. See Configure for exact timing.
One file, one message, no metadata. A large number of files in the folder during a session publishes the same number of messages; there is no batching and no manifest tying a message back to a specific file name.
A file that is still being written when the grace period ends may be read incomplete, or fail to read at all if it is still locked by its writer; a locked file is logged and skipped, not retried. Size the delay before upload to comfortably outlast whatever writes the files.
The module declares no capabilities. HEAT Capture does not mediate or sandbox its filesystem access beyond the configured folder path; see Capabilities.

Interface Control Document

See Interface control document for file eligibility, watcher timing, whole-file read behavior, payload shape, stop-time upload and failure semantics.