en:infra-convert:dev:parameter
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
en:infra-convert:dev:parameter [2019/07/31 13:12] me |
en:infra-convert:dev:parameter [2019/08/09 15:59] me [Export quality test plans and stamped drawings] |
||
|---|---|---|---|
| Line 11: | Line 11: | ||
| ---- | ---- | ||
| - | The startup parameter file is opened by transferring adjacent request parameters by executing #@IC_HTML@#. The value of the parameter is the absolute or relative path to the startup parameter file, including the file name (example syntax: "C:/Windows/Temp/StartParameterFile.json"). Additional request parameters cannot be transferred at this point. | + | The startup parameter file is opened by transferring adjacent request parameter "parameter" by executing #@IC_HTML@#. The value of the parameter is the absolute or relative path*¹ to the startup parameter file, here as an example of the syntax: "C:/Windows/Temp/StartParameterFile.json" |
| - | + | ||
| - | > **Note** Up to program version 1.3.5.5, only absolute paths can be specified, both as values of the initial startup parameter and within the startup parameter file. | + | |
| <WRAP group> | <WRAP group> | ||
| Line 27: | Line 25: | ||
| </WRAP> | </WRAP> | ||
| - | > **Note** Use slash characters ("/") to separate directory names in paths. Not all operating systems support the backslash ("\"). | + | The start parameter file summarizes all available call parameters except for the following*². The "forceConfigDir" call parameter can be used to specify a different storage location for the directory with configuration and template files. This is created by default during installation under "%ProgramData%/ELIAS GmbH/infra-Convert" and searched there if the parameter "forceConfigDir" is not passed. |
| + | |||
| + | <WRAP group> | ||
| + | <WRAP indent> | ||
| + | <WRAP column 75%> | ||
| + | |||
| + | <code> | ||
| + | InfraConvertWPF.exe -forceConfigDir="C:/ProgramData/ELIAS GmbH/infra-Convert" | ||
| + | </code> | ||
| + | |||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | |||
| + | Both parameters can also be transferred at the same time: | ||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP indent> | ||
| + | <WRAP column 57%> | ||
| + | |||
| + | <code> | ||
| + | InfraConvertWPF.exe -parameter="..." -forceConfigDir="..." | ||
| + | </code> | ||
| + | |||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | |||
| + | > **Note to *¹** Up to program version 1.3.5.5, only absolute paths can be specified, both as values of the initial startup parameter and within the startup parameter file. | ||
| + | |||
| + | > **Note to *²** The configuration and template directory can only be defined from program version 1.3.7.0 with this call parameter. When using it, make sure that you also adapt the paths for the directory with Excel template files (parameter [[en:infra-convert:dev:settings#List of the settings|ExcelReportsPath]]) and the directory with tolerance tables (parameter [[en:infra-convert:dev:settings#List of the settings|ToleranceTablePath]]) in the configuration file "settings.json". | ||
| This chapter explains the structure of the startup parameter file. The file may contain any part of the transfer values presented here, but it must adhere to the provisions for setting up a JSON file. | This chapter explains the structure of the startup parameter file. The file may contain any part of the transfer values presented here, but it must adhere to the provisions for setting up a JSON file. | ||
| Line 256: | Line 284: | ||
| "Format":"JSONV1", | "Format":"JSONV1", | ||
| "LanguageCode":"de", | "LanguageCode":"de", | ||
| - | "Path":"C:/Temp/testplan.json" | + | "Path":"C:/Temp/testplan.json", |
| + | "InspectionPlanVersionExportMode": "Last" | ||
| }, | }, | ||
| { | { | ||
| Line 264: | Line 293: | ||
| { | { | ||
| "Format":"DFD", | "Format":"DFD", | ||
| - | "Path":"C:/Temp/DFD/" | + | "Path":"C:/Temp/DFD/", |
| + | "ExportHint": "MultiFileExport" | ||
| + | }, | ||
| + | { | ||
| + | "Format":"DFD", | ||
| + | "Path":"C:/Temp/DFD/testplan.dfd", | ||
| + | "ExportHint": "CombinedExport" | ||
| }, | }, | ||
| { | { | ||
| Line 293: | Line 328: | ||
| ^ LanguageCode | String | **de** German\\ **en** English | | ^ LanguageCode | String | **de** German\\ **en** English | | ||
| ^ Path | String | Path to the location with the file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | | ^ Path | String | Path to the location with the file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | | ||
| + | ^ InspectionPlanVersionExportMode | String | **Implicit** Export the test plan version addressed by the "InspectionPlanVersion" parameter when the start parameter is called (default behavior, is applied if the parameter is not specified).\\ **Last** The most recent inspection plan version at the time of export\\ \\ **Note** The "newest" inspection plan version is the inspection plan version with the highest lexical version number.\\ \\ **Note** This parameter is available as of program version 1.3.7.2 | | ||
| The following applies for the CSV quality test plan format: | The following applies for the CSV quality test plan format: | ||
| Line 300: | Line 336: | ||
| ^ Format | String | **CSV** | | ^ Format | String | **CSV** | | ||
| ^ Path | String | Path to the location with the file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | | ^ Path | String | Path to the location with the file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | | ||
| + | ^ InspectionPlanVersionExportMode | String | **Implicit** Export the test plan version addressed by the "InspectionPlanVersion" parameter when the start parameter is called (default behavior, is applied if the parameter is not specified).\\ **Last** The most recent inspection plan version at the time of export\\ \\ **Note** The "newest" inspection plan version is the inspection plan version with the highest lexical version number.\\ \\ **Note** This parameter is available as of program version 1.3.7.2 | | ||
| The following applies for the DFD quality test plan format: | The following applies for the DFD quality test plan format: | ||
| Line 307: | Line 344: | ||
| ^ Format | String | **DFD** | | ^ Format | String | **DFD** | | ||
| ^ Path | String | Path to the location without a file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | | ^ Path | String | Path to the location without a file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | | ||
| + | ^ InspectionPlanVersionExportMode | String | **Implicit** Export the test plan version addressed by the "InspectionPlanVersion" parameter when the start parameter is called (default behavior, is applied if the parameter is not specified).\\ **Last** The most recent inspection plan version at the time of export\\ \\ **Note** The "newest" inspection plan version is the inspection plan version with the highest lexical version number.\\ \\ **Note** This parameter is available as of program version 1.3.7.2 | | ||
| + | ^ ExportHint | String | **MultiFileExport** Export partial test plans to separate DFD files (default behavior, applied if parameter is not specified)\\ **CombinedExport** Export partial test plans to collective DFD file\\ \\ **Note** This parameter is available as of program version 1.3.7.2 | | ||
| This applies to drawing exports in PDF und SVG format: | This applies to drawing exports in PDF und SVG format: | ||
| Line 313: | Line 352: | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| ^ Format | String | **PDF** All drawing sheets each as a PDF file\\ **SVG** All drawing sheets each as a SVG file | | ^ Format | String | **PDF** All drawing sheets each as a PDF file\\ **SVG** All drawing sheets each as a SVG file | | ||
| - | ^ Path | String | Path to the location without a file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | | + | ^ Path | String | Path to storage location, for multiple export ("MultiFileExport") without file name, for combined export ("CombinedExport") with file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | |
| + | ^ InspectionPlanVersionExportMode | String | **Implicit** Export the test plan version addressed by the "InspectionPlanVersion" parameter when the start parameter is called (default behavior, is applied if the parameter is not specified).\\ **Last** The most recent inspection plan version at the time of export\\ \\ **Note** The "newest" inspection plan version is the inspection plan version with the highest lexical version number.\\ \\ **Note** This parameter is available as of program version 1.3.7.2 | | ||
| This applies to drawing exports in PNG, JPG, BMP, TIF und GIF format: | This applies to drawing exports in PNG, JPG, BMP, TIF und GIF format: | ||
| Line 322: | Line 362: | ||
| ^ Mode | String | **Drawing** Only drawing sheets\\ **Stamps** Only stamp graphics\\ \\ If **Mode** is not specified, drawing and stamp graphics are exported together | | ^ Mode | String | **Drawing** Only drawing sheets\\ **Stamps** Only stamp graphics\\ \\ If **Mode** is not specified, drawing and stamp graphics are exported together | | ||
| ^ Path | String | Path to the location without a file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | | ^ Path | String | Path to the location without a file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | | ||
| + | ^ InspectionPlanVersionExportMode | String | **Implicit** Export the test plan version addressed by the "InspectionPlanVersion" parameter when the start parameter is called (default behavior, is applied if the parameter is not specified).\\ **Last** The most recent inspection plan version at the time of export\\ \\ **Note** The "newest" inspection plan version is the inspection plan version with the highest lexical version number.\\ \\ **Note** This parameter is available as of program version 1.3.7.2 | | ||
| </WRAP> | </WRAP> | ||
en/infra-convert/dev/parameter.txt · Last modified: 2023/11/28 14:34 by me
Page Tools
