Command Line Interface (DATAFLOW Designer)
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.
Command Line Interface
The DATAFLOW Studio application that contains the DATAFLOW Designer provides a command line interface (CLI). This can be used for automation of certain tasks.
The Binary is installed at the following path:
C:\Program Files\Dataflow\Studio v2.1\Dataflow.Studio.App.exe
This table describes the supported command line arguments:
|
Argument |
Description |
Required Module(s) |
| <None> |
Starts the DATAFLOW Designer normally. |
- |
| -Action <Action> |
Performs the given action on on the solution given with the -SolutionFile argument and exits. The following actions are supported:
|
See below |
| -Action export-image |
Exports all diagrams in the solution given with the -SolutionFile argument as PNG images and exits. The -Target argument must be provided and defines the directory the images will be generated in. If the -Project argument is provided, the action is limited to the given project instead of the whole solution. If the -Overwrite argument is provided, existing files in the target directory will be overwritten. |
DATAFLOW Document
|
| -Action export-document |
Exports all projects in the solution given with the -SolutionFile argument to PDF documents and exits. The -Target argument must be provided and defines the directory the files will be generated in. If the -Project argument is provided, the action is limited to the given project instead of the whole solution. If the -Overwrite argument is provided, existing files in the target directory will be overwritten. |
DATAFLOW Document |
| -Action generate |
Executes code generation for the solution given with the -SolutionFile argument and exits. If the -Overwrite argument is provided, existing files in the target directory will be overwritten. |
DATAFLOW Code DATAFLOW Frames |
|
-Help |
Prints a list of available command line arguments to the standard output and exits. |
- |
| -Overwrite
|
Used with -Action to overwrite existing files in the directory given with the -Target argument. |
- |
|
-Project [Name] |
Used with -Action to limit the action on a given project instead of executing it for the whole solution. |
- |
|
-RootConfig [Path] |
Starts the DATAFLOW Designer with a application persistency directory that differs from the default one. This is normally not required outside of testing scenarios. |
- |
|
-SolutionFile [Path] |
Absolute path to an existing solution (see -Start). |
- |
| -Start | Starts the DATAFLOW Designer and opens the solution given with the -SolutionFile argument. | - |
| -Target [Path] | Defines the target directory for the action performed with the -Action argument. | - |
| -Verbose |
Writes the log output of the DATAFLOW Designer to standard output while the application runs. This will not return until the application is closed. |
- |
| -Version | Writes the version of the DATAFLOW Designer to the standard output and exits. | - |
Required Module: DATAFLOW Studio
This Article has been written based on V2.1.1 of the DATAFLOW software.
Latest update 2023-05-31 by WUM.
Comments
0 comments
Please sign in to leave a comment.