<< Click to Display Table of Contents >> Navigation:  PlantReporter > How to use > Command line

It is only necessary to read through this chapter if you wish to use/start PlantReporter by means of command line parameter. Otherwise you may skip the following explanations.

When using parameters during the startup of PlantReporter, the command will look e.g. like the following:

"C:\ProgramData\Autodesk\ApplicationPlugins\AqaPlantReporter.bundle\Contents\Windows\PlantReporter.exe" /PROJECT “C:\...\project.xml” /DWG “C:\Projects\AUF-2345\Drawings\PID-0010.dwg, C:\Projects\AUF-2345\Drawings\PID-0020.dwg” /CONFIG “Equipment” /HIDDEN /PREVIEW

Not all parameters need to be used. If a parameter is used, the corresponding object in the user interface of the PlantReporter will be deactivated. Of course, this is only so long as /HIDDEN is not used, since otherwise the user interface of PlantReporter would be no longer visible.

/PROJECT shows the project from which data should be used. You will find the file “Project.xml” in each project from AutoCAD® P&ID/Plant 3D. The complete path to the file “Project.xml” must be given.

/DWG lists one or more drawings from which data should be used for the report. These parameters are typically used if the user wishes to create reports that are drawing-related and not related to the entire project.

If the parameter /DWG is used, but not /PROJECT, then the information from /DWG is ignored, since PlantReporter would then not know to which project the drawings belong.

The DWG name of the drawing including path must be given.

/CONFIG sets which report configuration should be used. In this case, simply input the name of the report configuration. The report configuration must already exist.

If PlantReporter is configured so that “Project” has been selected in the settings, then /PROJECT must also be used along with the use of /CONFIG, since otherwise PlantReporter will not find the report configuration.

/HIDDEN is used if the user interface should not appear. This also means that at least /PROJECT and /CONFIG must be set, since the user will otherwise have no possible way to adjust these settings.

After the creation of the report, PlantReporter will close automatically.

/QUIET suppresses error messages. Error codes will be generated in their place. These are, in detail:

/PREVIEW first opens the report in the preview window. This also assumes that /PROJECT and /CONFIG are set. The preview is displayed even if /HIDDEN is set.