Solution File Format (DATAFLOW Designer)
by Marco Wuelser
This Reference Article has been written for Version 2.1 of the DATAFLOW Software. For Previous Releases use the version selection in the navigation bar at the top of this page.
Starting with DATAFLOW Software V2.0 a single file solution format has been introduced. This uses a binary file to store all your solution data. We recommend to use the single file format for new solutions. The following article explains the multi file solution format that can be used as an alternative if a series of text files are preferred over a single binary file.
Solution Folder
A DATAFLOW Solution contains the following files in the root folder:
Solution Files and Folders
Path: ./
|
Element |
Description |
.Dataflow |
Solution Configuration Folder (see below). |
<ProjectName> |
Project folder (see below). |
snapshot |
Reserved for future extension, no function in V2.1. |
<SolutionName>.dfs |
The *.dfs file is the DATAFLOW Solution File. Double-click the file to open the solution directly from the Windows Explorer. This file contains the list of projects in the solution. |
Solution Configuration Folder
The Solution Configuration Folder contains the following files:
Solution Configuration Files and Folders
Path: ./.Dataflow/
|
Element |
Description |
<Project Name> |
Project configuration folder (see below). |
explorer.json |
This JSON file contains the current configuration of the explorer window inclusing view mode, sort order etc. This file can be omitted from version control so that every user can have its own local explorer configuration. |
lock.json |
Lock file to prevent a solution from being opened simultaneously in multiple instances of DATAFLOW Designer. This file only exists when the solution is opened. Do not add this file to version control ! |
macros.json |
This file contains solution wide path macros that can be used in all projects. |
toolbox.json |
This JSON file contains the current configuration of ther toolbox window inclusing created favorites, sort order etc. This file can be omitted from version control so that every user can have its own local toolbox configuration. |
user.json |
This JSON file contains the local paths for each mapped component project. Do not add this file to version control ! |
workspace.json |
This file contains the position of all windows in the UI elements. This file can be omitted from version control so that every user can have its own local UI configuration. |
Project Folder
The Project Folder contains the following files:
Project Files and Folders
Path: ./<ProjectName>/
|
Element |
Description |
elements |
Element folder that contains a JSON file for each element defined in the model. The files are named <GUID>.json. |
images |
Image folder that contains each image added to the model. |
tree.json |
A JSON file that contains the full tree structure of the project model. This includes references to every element in the project (see element folder). |
Project Configuration Folder
The Project Configuration Folder contains the following files:
Project Configuration Files and Folders
Path: ./Dataflow/<ProjectName>/
|
Element |
Description |
build-config |
Build Configuration folder that contains a JSON file for each build configuration defined in the model. The files are named <GUID>.json. |
toolchain |
Toolchain folder that contains a JSON file for each build toolchain configuration defined in the model. The files are named <GUID>.json. |
compiler.json |
This JSON file contains the list of validation messages that have been disabled for the whole project. |
docexport.json |
This JSON file contains the document export configuration. |
export.json |
This JSON file contains the general export configuration. |
macros.json |
This JSON file constains project-specific path macros that are limited to the scope of the project. |
project.dffProj |
The Project file. This file is used to identify the project type and version. |
templateexport.json |
Reserved for future extension, no function in V2.1. |
Required Module: DATAFLOW Studio
This Article has been written based on V2.1.1 of the DATAFLOW software.
Latest update 2023-06-01 by WUM.