Skip to main content

File Flow data items

A file Flow data item combines a shared File Definition with the File Connection that supplies its runtime paths and name. It can act as inbound source, generated destination, report/Transport source or another step's structured file data.

Properties and dependencies

SettingDefaultEffect
Data Item / SourceNameNew File Definition ItemFlow-local role name.
Definition / SourceFIDSEmptyReference to the file structure/serialisation contract.
File Connection / FileConFIDSEmpty unless supplied by the DefinitionRuntime path, input mask and output naming authority. A missing reference prevents file access.
Source typeFileMakes the item available to file-compatible steps and file monitoring.
Runtime popupClearedOptional runtime selection path where supported; do not rely on it for service execution.
Current file / file number / engineRuntime stateAssigned while loading or writing. These are not saved choices.

For an inbound monitor, the manager supplies the dequeued monitor file path to the Flow before execution. For manually run file data, the Designer test/load path chooses or derives the source according to the File Connection and setup form.

Completion lifecycle

In live execution, a successful file-source Flow moves eligible source files to Audit or Transport; setting transport movement suppresses normal audit movement so only the intended path should act. A failed Flow moves eligible sources to Error. A cancelled deadlock path can leave the file in place for later processing. Transport-owned files are audited by Transport processing rather than the normal source-file loop.

In test mode, normal source-file movement and outbound Transport sending are suppressed, and database work is rolled back. Other steps—scripts, command-line programs, reports and external calls—can still have effects.

Configure and test

  1. Attach a sanitised test File Connection to the reviewed Definition.
  2. Add a File Definition data item and give it a clear source/destination role name.
  3. Confirm the input mask, output name, audit/error/transport folders and service-account permissions.
  4. Assign it only to steps that accept file data.
  5. Test valid, invalid, empty, locked, duplicate-name and encoding cases.
  6. Verify parsed records, generated bytes, log file events and final folder—not only Flow status.

Never point a design test at an active inbound production directory. Use file lifecycle guidance before enabling an automated trigger.