en:infra-convert:dev:parameter_neu
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:infra-convert:dev:parameter_neu [2021/12/10 12:46] me |
en:infra-convert:dev:parameter_neu [2021/12/10 13:02] me removed |
||
|---|---|---|---|
| Line 11: | Line 11: | ||
| ---- | ---- | ||
| - | 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" | + | The startup parameter file summarizes parameters to be passed when starting #@IC_HTML@# in a file in JSON format. This page describes under [[#Basics]] the call, the basic requirements, the start parameter "forceConfigDir" and in the following sections the individual parts of the start parameter file. Examples of start parameter scenarios can be found in section [[#Examples of start parameter calls]]. |
| + | <WRAP noprint> | ||
| <WRAP group> | <WRAP group> | ||
| - | <WRAP indent> | + | <WRAP column 48%> |
| - | <WRAP column 70%> | + | //**__Content__**// |
| - | <code> | + | • [[#Basics]]\\ |
| - | InfraConvertWPF.exe -parameter="C:/Windows/Temp/StartParameterFile.json" | + | • [[#Setting the language]]\\ |
| - | </code> | + | • [[#Open or create project]]\\ |
| + | • [[#Open or create quality test plan]]\\ | ||
| + | • [[#Transfer drawing]]\\ | ||
| + | • [[#Export quality test plans and stamped drawings]]\\ | ||
| + | • [[#Invoke function]]\\ | ||
| + | • [[#Zoom on stamp]]\\ | ||
| + | • [[#Settings]]\\ | ||
| + | • [[#Parameter file for tags]]\\ | ||
| + | • [[#Parameter file for characteristic classes]]\\ | ||
| + | • [[#Parameter file for characteristic categories]]\\ | ||
| + | • [[#Parameter file for stamp templates]]\\ | ||
| + | • [[#Parameter file for showing/hiding/locking control elements]]\\ | ||
| + | • [[#Editing characteristics]]\\ | ||
| + | • [[#Editing tags]]\\ | ||
| + | • [[#Examples for start parameter files]] | ||
| + | |||
| + | \\ | ||
| </WRAP> | </WRAP> | ||
| Line 25: | Line 42: | ||
| </WRAP> | </WRAP> | ||
| - | 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. | + | ===== Basics ===== |
| - | <WRAP group> | + | **Call up** |
| - | <WRAP indent> | + | |
| - | <WRAP column 75%> | + | |
| - | <code> | + | The path to the start parameter file is passed to the command to run #@IC_HTML@# with "parameter". Example with any file path: |
| - | 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 group> | ||
| <WRAP indent> | <WRAP indent> | ||
| - | <WRAP column 57%> | + | <WRAP column 70%> |
| <code> | <code> | ||
| - | InfraConvertWPF.exe -parameter="..." -forceConfigDir="..." | + | InfraConvertWPF.exe -parameter="C:/Windows/Temp/StartParameterFile.json" |
| </code> | </code> | ||
| Line 53: | Line 60: | ||
| </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** Note that special characters in the name/path of the startup parameter file will only be passed correctly to #@IC_HTML@# if they have been encoded correctly. This can be ensured in a batch file saved as UTF-8, for example, by specifying the code page CHCP 65001 for UTF-8. Example: |
| + | > <code>chcp 65001 | ||
| + | InfraConvertWpf.exe -parameter="Démarrer.json"</code> | ||
| - | > **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". | + | **Basic requirements for the startup parameter 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. | + | * The character encoding UTF-8 is expected. |
| + | * Paths can be specified absolute or relative.\\ (Relative paths are possible from programme version 1.3.5.5.) | ||
| + | * The file can contain any part of the parameters presented here. | ||
| + | * The file must adhere to the [[https://json.org/json-en.html|provisions of the JSON format]]. | ||
| - | **Examples for start parameter files** | + | **Startup parameter »forceConfigDir«** |
| + | |||
| + | Outside the start parameter file another call up parameter can be used (Available from program version 1.3.7.0). With "forceConfigDir" another location for the directory with configuration and template files can be defined than the directory "%ProgramData%/ELIAS GmbH/infra-Convert" created by default during installation. | ||
| <WRAP group> | <WRAP group> | ||
| - | <WRAP column 61%> | + | <WRAP indent> |
| + | <WRAP column 75%> | ||
| - | You can find a complete example of a startup parameter file here: Appendix > [[en:infra-convert:dev:parameter_beispiel|Example startup parameter file]] | + | <code> |
| + | InfraConvertWPF.exe -forceConfigDir="C:/ProgramData/ELIAS GmbH/infra-Convert" | ||
| + | </code> | ||
| </WRAP> | </WRAP> | ||
| - | <WRAP column 33%> | ||
| - | |||
| - | [[en:infra-convert:dev:parameter_beispiel|{{ :en:infra-convert:dev:startparameterdatei_beispiel.png?nolink&250 |}}]] | ||
| - | |||
| </WRAP> | </WRAP> | ||
| </WRAP> | </WRAP> | ||
| - | \\ | + | It is also possible to pass both parameters at the same time: |
| - | + | ||
| - | A compilation of different start parameter scenarios can be downloaded here: {{:en:infra-convert:dev:infra_CONVERT_Parametertest.zip|infra_CONVERT_Parametertest.zip}}, size: 2 MB. The examples are designed in such a way that you can execute each scenario directly with the included BAT file. All examples are at least compatible with program version 1.4.2.2. | + | |
| - | + | ||
| - | > **Important** Please check all file contents before executing an example. Save the "settings.json" in your default program directory in advance. Settings passed by start parameter call overwrite any settings made in this folder. | + | |
| <WRAP group> | <WRAP group> | ||
| - | <WRAP column 33%> | + | <WRAP indent> |
| - | **Start with specific parameter files**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 10 - Start with specific parameter files | + | <WRAP column 57%> |
| - | </WRAP> | + | |
| - | <WRAP column 61%> | + | |
| - | The user starts after starting #@IC_HTML@# on the start page. A selection of settings ("settings.json") are set at start-up. If the user creates a project, the transferred templates (stamp templates, categories, tags and classes) are used. | + | |
| - | </WRAP> | + | |
| - | </WRAP> | + | |
| - | <WRAP group> | + | <code> |
| - | <WRAP column 33%> | + | InfraConvertWPF.exe -parameter="..." -forceConfigDir="..." |
| - | **Create project and export when closing**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 20 - Create project and export | + | </code> |
| - | </WRAP> | + | |
| - | <WRAP column 61%> | + | |
| - | After the start a new project "Project-001" with two drawing files in a test plan version "Test plan A" is automatically created. If the user saves the project, a test plan "Test plan-001" in JSON format and drawing and stamp views are exported in JPG format in a subdirectory "Export". | + | |
| - | </WRAP> | + | |
| - | </WRAP> | + | |
| - | <WRAP group> | ||
| - | <WRAP column 33%> | ||
| - | **Create new test plan version and start drawing comparison**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 30 - Compare drawings | ||
| </WRAP> | </WRAP> | ||
| - | <WRAP column 61%> | ||
| - | An already existing project "Project-001" is loaded. The project contains two stamped drawing sheets in a test plan version "Test plan A". At startup, a new test plan version "Test plan B" is created with a new version of each of the two drawing sheets. The user starts the drawing comparison with sheet 1. | ||
| </WRAP> | </WRAP> | ||
| </WRAP> | </WRAP> | ||
| - | <WRAP group> | + | > **Note to** When using "forceConfigDir", 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". |
| - | <WRAP column 33%> | + | |
| - | **Zoom to stamp via GUID**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 40 - Zoom to stamp via GUID | + | |
| - | </WRAP> | + | |
| - | <WRAP column 61%> | + | |
| - | A stamp in an existing project is zoomed in by specifying the GUID of the stamp. In the example, the GUID was read from the previously exported test plan "Test plan-001.json". | + | |
| - | </WRAP> | + | |
| - | </WRAP> | + | |
| - | <WRAP group> | ||
| - | <WRAP column 33%> | ||
| - | **Zoom to stamp via ICP-ID**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 41 - Zoom to stamp via ICP-ID | ||
| - | </WRAP> | ||
| - | <WRAP column 61%> | ||
| - | A (temporary) project is created and an ICP file (project file from #@IC_OLD_HTML@#) is loaded. Only the ID ("ICP-ID") of the characteristic or the stamp in the ICP file is known. | ||
| - | </WRAP> | ||
| - | </WRAP> | ||
| - | |||
| - | <WRAP group> | ||
| - | <WRAP column 33%> | ||
| - | **Zoom to stamp via CompareSourceId**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 42 - Zoom to stamp via CompareSourceId | ||
| - | </WRAP> | ||
| - | <WRAP column 61%> | ||
| - | A stamp in the more recent of two test plan versions is zoomed in. Only the GUID of the stamp in the original version of the test plan versions is known. This GUID is transferred to the transferred or merged characteristic during the drawing comparison using the CompareSourceId. | ||
| - | </WRAP> | ||
| - | </WRAP> | ||
| - | |||
| - | <WRAP noprint> | ||
| - | <WRAP group> | ||
| - | <WRAP column 48%> | ||
| - | //**__Content__**// | ||
| - | |||
| - | • [[en:infra-convert:dev:parameter#Setting the language]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Open or create project]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Open or create quality test plan]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Transfer drawing]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Export quality test plans and stamped drawings]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Invoke function]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Zoom on stamp]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Settings]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Parameter file for tags]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Parameter file for characteristic classes]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Parameter file for characteristic categories]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Parameter file for stamp templates]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Parameter file for showing/hiding/locking control elements]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Editing characteristics]]\\ | ||
| - | • [[en:infra-convert:dev:parameter#Editing tags]] | ||
| \\ | \\ | ||
| - | |||
| - | </WRAP> | ||
| - | </WRAP> | ||
| - | </WRAP> | ||
| - | |||
| ===== Setting the language ===== | ===== Setting the language ===== | ||
| Line 953: | Line 897: | ||
| ^ └ LanguageCode | String | **de** German\\ **en** English | | ^ └ LanguageCode | String | **de** German\\ **en** English | | ||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | |||
| + | \\ | ||
| + | |||
| + | ===== Examples for start parameter files ===== | ||
| + | |||
| + | A compilation of different start parameter scenarios can be downloaded here: {{:en:infra-convert:dev:infra_CONVERT_Parametertest.zip|infra_CONVERT_Parametertest.zip}}, size: 2 MB. The examples are designed in such a way that you can execute each scenario directly with the included BAT file. All examples are at least compatible with program version 1.4.2.2. | ||
| + | |||
| + | > **Important** Please check all file contents before executing an example. Save the "settings.json" in your default program directory in advance. Settings passed by start parameter call overwrite any settings made in this folder. | ||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP column 33%> | ||
| + | **Start with specific parameter files**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 10 - Start with specific parameter files | ||
| + | </WRAP> | ||
| + | <WRAP column 61%> | ||
| + | The user starts after starting #@IC_HTML@# on the start page. A selection of settings ("settings.json") are set at start-up. If the user creates a project, the transferred templates (stamp templates, categories, tags and classes) are used. | ||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP column 33%> | ||
| + | **Create project and export when closing**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 20 - Create project and export | ||
| + | </WRAP> | ||
| + | <WRAP column 61%> | ||
| + | After the start a new project "Project-001" with two drawing files in a test plan version "Test plan A" is automatically created. If the user saves the project, a test plan "Test plan-001" in JSON format and drawing and stamp views are exported in JPG format in a subdirectory "Export". | ||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP column 33%> | ||
| + | **Create new test plan version and start drawing comparison**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 30 - Compare drawings | ||
| + | </WRAP> | ||
| + | <WRAP column 61%> | ||
| + | An already existing project "Project-001" is loaded. The project contains two stamped drawing sheets in a test plan version "Test plan A". At startup, a new test plan version "Test plan B" is created with a new version of each of the two drawing sheets. The user starts the drawing comparison with sheet 1. | ||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP column 33%> | ||
| + | **Zoom to stamp via GUID**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 40 - Zoom to stamp via GUID | ||
| + | </WRAP> | ||
| + | <WRAP column 61%> | ||
| + | A stamp in an existing project is zoomed in by specifying the GUID of the stamp. In the example, the GUID was read from the previously exported test plan "Test plan-001.json". | ||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP column 33%> | ||
| + | **Zoom to stamp via ICP-ID**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 41 - Zoom to stamp via ICP-ID | ||
| + | </WRAP> | ||
| + | <WRAP column 61%> | ||
| + | A (temporary) project is created and an ICP file (project file from #@IC_OLD_HTML@#) is loaded. Only the ID ("ICP-ID") of the characteristic or the stamp in the ICP file is known. | ||
| + | </WRAP> | ||
| + | </WRAP> | ||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP column 33%> | ||
| + | **Zoom to stamp via CompareSourceId**\\ {{:en:infra-convert:dev:ordner_leer.png?nolink&18}} 42 - Zoom to stamp via CompareSourceId | ||
| + | </WRAP> | ||
| + | <WRAP column 61%> | ||
| + | A stamp in the more recent of two test plan versions is zoomed in. Only the GUID of the stamp in the original version of the test plan versions is known. This GUID is transferred to the transferred or merged characteristic during the drawing comparison using the CompareSourceId. | ||
| </WRAP> | </WRAP> | ||
| </WRAP> | </WRAP> | ||
Page Tools
