Generate project documentation (silent mode)
You can also generate the project documentation by using the command line of your operating system. An interaction with the software user interface of the Project Builder is not required in that case. Start your EPLAN Platform via the command line and perform the action
Specify parameters
By entering the parameters you specify which elements are used for the generation of the project documentation.
| Parameter | Meaning |
|---|---|
|
|
The personal access token is required to identify yourself to the software. |
|
|
The name of the library in which the element is located for which you want to generate a project documentation. |
|
|
The name of the configurator in which the element is located for which you want to generate a project documentation. |
|
|
The storage location of your target project. This variable is only required if you want to generate a new target project. |
|
|
The name of the target project in which the project documentation is generated. |
|
|
The template that you want to use for your project. This variable is only required if you want to generate a new target project. |
|
|
Path specification for the XML file that is used for configuration. |
|
|
Path specification to the XML file or XLSX file used for configuration. |
|
|
If you want to overwrite an existing project, enter the value "1". If you enter the value "0" in the command line, an existing project is not overwritten. This variable is only required if you want to generate a new target project. |
Note
- The parameter
/importfile is only supported as of EPLAN Platform version 2022. - In this parameter, you can specify an XML file as well as an XLSX file. If you specify the parameters
/importfile and/xmlfile in a call, only the path specification regarding the XML file is observed.
Example: Entry in the command line
To provide a better overview each parameter is listed in a new line. When entering in the command lines, the elements of the command must be separated with a blank only.
Proceed as follows if you want to generate a project in an existing target project:
"C:\Program Files\EPLAN\Electric P8\2024.0.3\Bin\W3u.exe"
/NoSplash
/Frame:"0"
/Auto
ExecuteCogineerProjectBuilderAction
/token:"Silent mode token"
/libraryName:"Name of the library"
/configuratorName:"Name of the configurator"
/targetProjectName:"Name of the target project"
/xmlfile:"Path to the XML or XLSX file that is used for the configuration" Proceed as follows if you want to generate a project in a new target project:
"C:\Program Files\EPLAN\Electric P8\2024.0.3\Bin\W3u.exe"
/NoSplash
/Frame:"0"
/Auto
ExecuteCogineerProjectBuilderAction
/token:"Silent mode token"
/libraryName:"Name of the library"
/configuratorName:"Name of the configurator"
/storagelocation:"C:\Path\to\targetproject"
/targetProjectName:"Name of the target project"
/template:"C:\Path\to\template\IEC_bas003.zw9"
/xmlfile:"Path to the XML or XLSX file that is used for the configuration"
/overwrite:"0" Tip
You do not have to manually create the XML file or XLSX file that is used for configuration. Export an XML template file or XLSX template file for the element for which you want to generate the project documentation. Then just specify those values for the variables that you require for the configuration in the configuration file.
Note
The value that you specify for a parameter only has to be in quotation marks if there is a space in it.
Request personal access token
To identify yourself to the software you require a personal access token