User Tools

Site Tools


en:infra-convert:dev:parameter

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
en:infra-convert:dev:parameter [2019/04/05 15:02]
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 full 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"​
  
 <WRAP group> <WRAP group>
Line 25: 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 140: Line 170:
   "​Name":"​Beispiel Projekt",​   "​Name":"​Beispiel Projekt",​
   "​Action":"​Open"​   "​Action":"​Open"​
-},+}
 </​code>​ </​code>​
  
 |< 100% 33% 12% 54% >| |< 100% 33% 12% 54% >|
 ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^
-^ Path | String | Full path to the location with the file name |+^ Path | String | Path to the location with the file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). ​|
 ^ Name | String | Project title (ignored when opening) | ^ Name | String | Project title (ignored when opening) |
 ^ Action | String | **Open** Opens an existing project\\ **Create** Creates a new project | ^ Action | String | **Open** Opens an existing project\\ **Create** Creates a new project |
Line 174: Line 204:
   "​Version":​ "​0",​   "​Version":​ "​0",​
   "​Action":​ "​Create"​   "​Action":​ "​Create"​
-},+}
 </​code>​ </​code>​
  
Line 216: Line 246:
   {   {
   "​Path":"​C:/​Users/​user1/​Desktop/​drawing_4.icp"​   "​Path":"​C:/​Users/​user1/​Desktop/​drawing_4.icp"​
 +  },
 +  {
 +  "​Path":"​https://​ftp.elias-gmbh.de/​fictional_path/​example.dwg"​
   }   }
-],+]
 </​code>​ </​code>​
  
 |< 100% 33% 12% 54% >| |< 100% 33% 12% 54% >|
 ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^
-^ Path | String | Full path to the location with the file name |+^ Path | String | Path to the location with the file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​).\\ \\ **Note** It is possible to specify the path in URL notation, beginning with "​https"​ and "​http",​ from program version 1.3.5.7 onwards. ​|
  
 </​WRAP>​ </​WRAP>​
Line 259: Line 292:
   {   {
     "​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 278: Line 317:
     "​Mode":"​Stamps"​     "​Mode":"​Stamps"​
   }   }
-],+]
 </​code>​ </​code>​
  
Line 287: Line 326:
 ^ Format | String | **JSONV1** | ^ Format | String | **JSONV1** |
 ^ LanguageCode | String | **de** German\\ **en** English | ^ LanguageCode | String | **de** German\\ **en** English |
-^ Path | String | Full path to the location with the file name |+^ Path | String | Path to the location with the file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). | 
 +^ Inspection​Plan​Version​Export​Mode | 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 294: Line 334:
 ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^
 ^ Format | String | **CSV** | ^ Format | String | **CSV** |
-^ Path | String | Full path to the location with the file name |+^ Path | String | Path to the location with the file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). | 
 +^ Inspection​Plan​Version​Export​Mode | 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 301: Line 342:
 ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^
 ^ Format | String | **DFD** | ^ Format | String | **DFD** |
-^ Path | String | Full path to the location without a file name |+^ Path | String | Path to the location without a file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). | 
 +^ Inspection​Plan​Version​Export​Mode | 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 308: Line 351:
 ^  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 | Full path to the location without ​file name |+^ 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 ("​\\"​). | 
 +^ Inspection​Plan​Version​Export​Mode | 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 316: Line 360:
 ^ Format | String | **Png** All drawing sheets and/or all stamped characteristics in extracts as PNG files\\ **Jpg** All drawing sheets and/or all stamped characteristics in extracts as JPG files\\ **Bmp** All drawing sheets and/or all stamped characteristics in extracts as BMP files\\ **Tif** All drawing sheets and/or all stamped characteristics in extracts as TIF files\\ **Gif** All drawing sheets and/or all stamped characteristics in extracts as GIF files | ^ Format | String | **Png** All drawing sheets and/or all stamped characteristics in extracts as PNG files\\ **Jpg** All drawing sheets and/or all stamped characteristics in extracts as JPG files\\ **Bmp** All drawing sheets and/or all stamped characteristics in extracts as BMP files\\ **Tif** All drawing sheets and/or all stamped characteristics in extracts as TIF files\\ **Gif** All drawing sheets and/or all stamped characteristics in extracts as GIF files |
 ^ 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 | Full path to the location without a file name |+^ Path | String | Path to the location without a file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). | 
 +^ Inspection​Plan​Version​Export​Mode | 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>​
Line 344: Line 389:
   "​Name":​ "​AddCharacteristicTag",​   "​Name":​ "​AddCharacteristicTag",​
   "​ItemId":​ "​{5D1110CA-6093-4381-B372-CF983D515044}"​   "​ItemId":​ "​{5D1110CA-6093-4381-B372-CF983D515044}"​
-},+}
 </​code>​ </​code>​
  
Line 461: Line 506:
 The path to the parameter file //​Settings.json//​ is specified in the **Settings** field. #@IC_HTML@# obtains the global settings from this file. The path to the parameter file //​Settings.json//​ is specified in the **Settings** field. #@IC_HTML@# obtains the global settings from this file.
  
-> **Please note** Changes made by the user in the user interface are not written to the "​settings.json"​ loaded here, but to the "​settings.json"​ in the local default ​directory ​%ProgramData%.+> **Please note** Changes made by the user in the user interface are not written to the "​settings.json"​ loaded here, but to the "​settings.json"​ in the CommonAppData ​directory ​whose path is defined in the "​settings.json"​ with the parameter "​CommonAppDataPath"​.
  
 > **See also** > **See also**
 > Administrator’s Manual #@IC_HTML@# > Run program > [[en:​infra-convert:​dev:​settings|Parameter file "​Settings"​]] > Administrator’s Manual #@IC_HTML@# > Run program > [[en:​infra-convert:​dev:​settings|Parameter file "​Settings"​]]
 +
 +> Administrator’s Manual #@IC_HTML@# > Configuration and Import > "​Settings"​ Parameter file > [[en:​infra-convert:​dev:​settings#​list_of_the_settings|List of the settings]] > Settings with no control elements in user interfaces ​
  
 > User’s Manual #@IC_HTML@# > Settings > Settings > [[en:​infra-convert:​user:​config:​general|General]] > User’s Manual #@IC_HTML@# > Settings > Settings > [[en:​infra-convert:​user:​config:​general|General]]
Line 474: Line 521:
 "​Settings":​ { "​Settings":​ {
   "​Path":​ "​C:/​ProgramData/​ELIAS GmbH/​infra-CONVERT/​Settings.json",​   "​Path":​ "​C:/​ProgramData/​ELIAS GmbH/​infra-CONVERT/​Settings.json",​
-},+}
 </​code>​ </​code>​
  
 |< 100% 33% 12% 54% >| |< 100% 33% 12% 54% >|
 ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^
-^ Path | String | Full path to the location and file name |+^ Path | String | Path to the location and file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). ​|
  
 </​WRAP>​ </​WRAP>​
Line 506: Line 553:
 "​CharacteristicTagsDefinition":​ { "​CharacteristicTagsDefinition":​ {
   "​Path":​ "​C:/​Users/​user1/​AppData/​CharacteristicTags.json",​   "​Path":​ "​C:/​Users/​user1/​AppData/​CharacteristicTags.json",​
-},+}
 </​code>​ </​code>​
  
 |< 100% 33% 12% 54% >| |< 100% 33% 12% 54% >|
 ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^
-^ Path | String | Full path to the location and file name |+^ Path | String | Path to the location and file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). ​|
  
 </​WRAP>​ </​WRAP>​
Line 536: Line 583:
 "​CharacteristicClassesDefinition":​ { "​CharacteristicClassesDefinition":​ {
   "​Path":​ "​C:/​Users/​user1/​AppData/​CharacteristicClasses.json"​   "​Path":​ "​C:/​Users/​user1/​AppData/​CharacteristicClasses.json"​
-},+}
 </​code>​ </​code>​
  
 |< 100% 33% 12% 54% >| |< 100% 33% 12% 54% >|
 ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Type  ^  Value/​Content ​ ^
-^ Path | String | Full path to the location and file name |+^ Path | String | Path to the location and file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). ​|
  
 </​WRAP>​ </​WRAP>​
Line 566: Line 613:
 "​SpecialCategoriesDefinition":​ { "​SpecialCategoriesDefinition":​ {
   "​Path":​ "​C:/​Users/​user1/​AppData/​SpecialCategories.json"​   "​Path":​ "​C:/​Users/​user1/​AppData/​SpecialCategories.json"​
-},+}
 </​code>​ </​code>​
  
 |< 100% 33% 12% 54% >| |< 100% 33% 12% 54% >|
 ^  Parameter ​ ^  Typ  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Typ  ^  Value/​Content ​ ^
-^ Path | String | Full path to the location and file name |+^ Path | String | Path to the location and file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). ​|
  
 </​WRAP>​ </​WRAP>​
Line 595: Line 642:
 "​StampTemplatesDefinition":​ { "​StampTemplatesDefinition":​ {
   "​Path":​ "​C:/​Users/​user1/​AppData/​StampTemplates.json"​   "​Path":​ "​C:/​Users/​user1/​AppData/​StampTemplates.json"​
-},+}
 </​code>​ </​code>​
  
 |< 100% 33% 12% 54% >| |< 100% 33% 12% 54% >|
 ^  Parameter ​ ^  Typ  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Typ  ^  Value/​Content ​ ^
-^ Path | String | Full path to the location and file name |+^ Path | String | Path to the location and file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). ​|
  
 </​WRAP>​ </​WRAP>​
Line 625: Line 672:
 "​UiAccessDefinition":​ { "​UiAccessDefinition":​ {
   "​Path":​ "​C:/​Users/​user1/​AppData/​UiAccess.json",​   "​Path":​ "​C:/​Users/​user1/​AppData/​UiAccess.json",​
-},+}
 </​code>​ </​code>​
  
 |< 100% 33% 12% 54% >| |< 100% 33% 12% 54% >|
 ^  Parameter ​ ^  Typ  ^  Value/​Content ​ ^ ^  Parameter ​ ^  Typ  ^  Value/​Content ​ ^
-^ Path | String | Full path to the location and file name |+^ Path | String | Path to the location and file name; the directory names must be separated by slash characters ("/"​) or double backslash characters ("​\\"​). ​|
  
 </​WRAP>​ </​WRAP>​
en/infra-convert/dev/parameter.txt · Last modified: 2023/11/28 14:34 by me