Skip to Content
This documentation is provided with the HEAT environment and describes this HEAT instance.

Configure the folder upload module

Settings are edited in HEAT Capture’s module settings UI, the same as any other module, under the section name HEAT.FolderUploadModule.

Settings

SettingTypeDefaultEffectWhen to change
EnabledbooleantrueWhether the module runs at allDisable when the folder is not in use for a deployment
FolderstringC:\FolderToUploadThe folder watched for new files. Created automatically if it does not existAlways, at deployment time. The default is a placeholder path
DelayBeforeUploadduration30 secondsHow long the module keeps watching, and waits, after the session ends before it stops and reads the accumulated filesLonger, if whatever writes the files can lag behind the end of a session; shorter to get files into the session sooner
OverrideNodeIdbooleanfalseWhether NodeId below is usedWhen the platform template needs this module’s data on a specific input node
NodeIdinteger0HEAT input node the data is attributed to, when OverrideNodeId is trueWith OverrideNodeId

Every row is backed by Config/FolderUploadSettings.cs. Two further members exist on that class, Interval and Timeout, but both carry a [HideSetting] attribute: they are not shown in the settings UI and are not meant to be changed directly.

Timing

The module’s watch window does not end when the session does. On session end, the module first waits out DelayBeforeUpload, still watching for new files, then stops watching and reads whatever was created during the whole window: session start through the end of that delay. A file written after the delay elapses is never seen.

[session start]───watching───[session end]───still watching for DelayBeforeUpload───[stop, read files]

Example configuration

{ "HEAT.FolderUploadModule": { "Enabled": true, "Folder": "D:\\Exports\\SimTelemetry", "DelayBeforeUpload": "00:01:00" } }

A one-minute delay for a source that writes its export file shortly after being told the exercise has ended, rather than during it.

Opens your browser's print dialog. Choose "Save as PDF" as the destination.