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 | ||
|
en:infra-convert:dev:parameter [2020/07/29 16:40] me [Settings] |
en:infra-convert:dev:parameter [2023/11/28 14:34] (current) me [Setting the language] |
||
|---|---|---|---|
| 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 for start parameter files]]. |
| + | <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. | ||
| + | * 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. 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 183: | Line 128: | ||
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ LanguageCode | String | **de** German\\ **en** English\\ **fr** French\\ **it** Italian\\ **es** Spanish\\ **ru** Russian | | + | ^ LanguageCode | String | **de** German\\ **en** English\\ **fr** French\\ **it** Italian\\ **es** Spanish\\ **zh** Chinese\\ **cs** Czech\\ **bg** Bulgarian | |
| </WRAP> | </WRAP> | ||
| Line 217: | Line 162: | ||
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ 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 ("\\") (Mandatory information) | |
| - | ^ Name | String | Project title (ignored when opening) | | + | ^ Name | String | Project title\\ \\ **Note** This is required when creating ("Create"), ignored when opening ("Open"). | |
| ^ 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 251: | Line 196: | ||
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ Name | String | Quality test plan title (ignored when opening) | | + | ^ Name | String | Quality test plan title (Mandatory information) | |
| - | ^ Version | Decimal | Version of the quality test plan (ignored when opening) | | + | ^ Version | Decimal | Version of the quality test plan (Mandatory information) | |
| ^ Action | String | **Open** Opens an existing quality test plan\\ **Create** Creates a new quality test plan | | ^ Action | String | **Open** Opens an existing quality test plan\\ **Create** Creates a new quality test plan | | ||
| Line 300: | Line 245: | ||
| </code> | </code> | ||
| - | This applies to all imported drawings: | + | This applies to **all** imported drawings: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ 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. | | + | ^ Path | String | Path to the location with the file name; the directory names must be separated by slash characters ("/") or double backslash characters ("\\"). | |
| - | This applies to drawing imports in PDF format: | + | This applies to drawing imports in **PDF** format: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ ImportBehavior | String | Behaviour when importing multi-page PDF files:\\ **Ask** Allways ask before import\\ **ImportAllPages** Allways import all sheets\\ \\ **Note** The parameter is optional. If it is not specified, all sheets are imported. Available from program version 1.4.1.17 | | + | ^ ImportBehavior | String | Behaviour when importing multi-page PDF files:\\ **Ask** Allways ask before import\\ **ImportFirstPage** Import first page only\\ **ImportAllPages** Allways import all sheets | |
| - | This applies to drawing imports in DXF and DWG format: | + | This applies to drawing imports in **DXF** and **DWG** format: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ ImportBehavior | String | Behaviour when importing DXF and DWG files:\\ **Ask** Allways ask before import\\ **ImportModel** Always import model space only\\ **ImportPaperSpaces** Always import all sheets from paper space\\ **ImportAllLayouts** Allways import all sheets\\ \\ **Note** The parameter is optional. If it is not specified, the sheet is imported from model space. Available from program version 1.4.1.17 | | + | ^ ImportBehavior | String | Behaviour when importing DXF and DWG files:\\ **Ask** Allways ask before import\\ **ImportModel** Always import model space only\\ **ImportPaperSpaces** Always import all sheets from paper space\\ **ImportAllLayouts** Allways import all sheets | |
| - | This applies to the import of ICP project files: | + | This applies to the import of **ICP** project files: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ ImportBehavior | String | Behavior when importing ICP files:\\ **Ask** When reloading PDF, DXF and DWG drawing files, ask the user to select the page or sheet in the file\\ **ImportModel** When reloading DXF and DWG files, always import the model space only\\ \\ **Note** The parameter is optional. If it is not specified, the first page is automatically selected from a PDF file or the model space is selected in a DXF and DWG file. Available from program version 1.5.1.1 | | + | ^ ImportBehavior | String | Behavior when importing ICP files:\\ **Ask** When reloading PDF, DXF and DWG drawing files, ask the user to select the page or sheet in the file\\ **ImportModel** When reloading DXF and DWG files, always import the model space only\\ \\ **Note** The parameter is optional. If it is not specified, the first page is automatically selected from a PDF file or the model space is selected in a DXF and DWG file. | |
| </WRAP> | </WRAP> | ||
| Line 336: | Line 281: | ||
| With the **Targets** field, specify that when the **Save project** command is executed in quality test plans and/or stamped drawings and/or drawing details in #@IC_HTML@# should be exported. | With the **Targets** field, specify that when the **Save project** command is executed in quality test plans and/or stamped drawings and/or drawing details in #@IC_HTML@# should be exported. | ||
| - | > **Note** We recommend you use the quality test plan format JSONV1 because it supports all the characteristics of #@IC_HTML@#. | + | Exports are done in list order (from programme version 2.7.9). Test plans should be exported at the end. At least in JSONV2 format, the storage paths for stamp graphics are only listed if the target export has run beforehand. |
| + | |||
| + | > **Note** We recommend you use the quality test plan format JSONV2 because it supports all the characteristics of #@IC_HTML@#. | ||
| > **See also** | > **See also** | ||
| Line 350: | Line 297: | ||
| <code javascript> | <code javascript> | ||
| "Targets": [ | "Targets": [ | ||
| + | { | ||
| + | "Format":"PDF", | ||
| + | "ColorOption":"MonoColorStamp", | ||
| + | "ExportOnSaveOnly": false, | ||
| + | "Path":"Export/PDF/" | ||
| + | }, | ||
| + | { | ||
| + | "Format":"Png", | ||
| + | "ExportOnSaveOnly": true, | ||
| + | "Path":"Export/Graphics/" | ||
| + | "ImageOptions":{ | ||
| + | "Width":5000, | ||
| + | "Height":3500, | ||
| + | "Bit":24, | ||
| + | "SupersamplingAlgorithm":"Bilinear", | ||
| + | "SupersamplingFactor":3 | ||
| + | }, | ||
| + | { | ||
| + | "StampImageOptions":{ | ||
| + | "Width":1500, | ||
| + | "Height":1000, | ||
| + | "Bit":24, | ||
| + | "SupersamplingAlgorithm":"Bilinear", | ||
| + | "SupersamplingFactor":2 | ||
| + | }, | ||
| + | { | ||
| + | "Format":"Tif", | ||
| + | "Path":"Export/Graphics/", | ||
| + | "Mode":"Drawing", | ||
| + | "ImageOptions":{ | ||
| + | "SupersamplingFactor":3, | ||
| + | "SupersamplingAlgorithm":"Lanczos3" | ||
| + | } | ||
| + | }, | ||
| + | { | ||
| + | "Format":"Bmp", | ||
| + | "ExportOnSaveOnly": true, | ||
| + | "Path":"Export/Graphics/", | ||
| + | "Mode":"Stamps" | ||
| + | }, | ||
| { | { | ||
| "Format":"JSONV2", | "Format":"JSONV2", | ||
| "LanguageCode":"de", | "LanguageCode":"de", | ||
| - | "Path":"Export/prüfplan.json" | + | "Path":"Export/test plan.json" |
| }, | }, | ||
| { | { | ||
| Line 363: | Line 350: | ||
| { | { | ||
| "Format":"CSV", | "Format":"CSV", | ||
| - | "Path":"Export/prüfplan.csv" | + | "Path":"Export/test plan.csv" |
| }, | }, | ||
| { | { | ||
| Line 374: | Line 361: | ||
| "Path":"Export/prüfplan.dfd", | "Path":"Export/prüfplan.dfd", | ||
| "ExportHint": "CombinedExport" | "ExportHint": "CombinedExport" | ||
| - | }, | ||
| - | { | ||
| - | "Format":"PDF", | ||
| - | "ColorOption":"MonoColorStamp", | ||
| - | "Path":"Export/PDF/" | ||
| - | }, | ||
| - | { | ||
| - | "Format":"Png", | ||
| - | "Path":"Export/Graphics/" | ||
| - | }, | ||
| - | { | ||
| - | "Format":"Jpg", | ||
| - | "Path":"Export/Graphics/", | ||
| - | "Mode":"Drawing" | ||
| - | }, | ||
| - | { | ||
| - | "Format":"Bmp", | ||
| - | "Path":"Export/Graphics/", | ||
| - | "Mode":"Stamps" | ||
| } | } | ||
| ] | ] | ||
| </code> | </code> | ||
| - | The following applies for the JSONV2 quality test plan format (available from program version 1.4.2.1): | + | The following applies for the **JSONV2** quality test plan format: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| Line 403: | Line 371: | ||
| ^ Format | String | **JSONV2** | | ^ Format | String | **JSONV2** | | ||
| ^ LanguageCode | String | **de** German\\ **en** English | | ^ LanguageCode | String | **de** German\\ **en** English | | ||
| + | ^ ExportOnSaveOnly | String | When closing the programme, or closing the project, …\\ **true** … do //not// trigger this export if no changes have been made to the project.\\ **false** … trigger this export if no changes have been made to the project. (Default behaviour, applied if the parameter is not specified).\\ \\ **Note** Available from programme version 2.7.5 | | ||
| ^ 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 ("\\"). | | ||
| - | The following applies for the JSONV1 quality test plan format: | + | The following applies for the **JSONV1** quality test plan format: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| Line 411: | Line 380: | ||
| ^ Format | String | **JSONV1** | | ^ Format | String | **JSONV1** | | ||
| ^ LanguageCode | String | **de** German\\ **en** English | | ^ LanguageCode | String | **de** German\\ **en** English | | ||
| + | ^ ExportOnSaveOnly | String | When closing the programme, or closing the project, …\\ **true** … do //not// trigger this export if no changes have been made to the project.\\ **false** … trigger this export if no changes have been made to the project. (Default behaviour, applied if the parameter is not specified).\\ \\ **Note** Available from programme version 2.7.5 | | ||
| ^ 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 | | + | ^ 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. | |
| - | The following applies for the CSV quality test plan format: | + | The following applies for the **CSV** quality test plan format: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| ^ Format | String | **CSV** | | ^ Format | String | **CSV** | | ||
| + | ^ ExportOnSaveOnly | String | When closing the programme, or closing the project, …\\ **true** … do //not// trigger this export if no changes have been made to the project.\\ **false** … trigger this export if no changes have been made to the project. (Default behaviour, applied if the parameter is not specified).\\ \\ **Note** Available from programme version 2.7.5 | | ||
| ^ 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 | | + | ^ 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. | |
| + | ^ ExportHint | String | **AskForHeader** Before export, show the export dialog to allow data entry for the header and export the header.\\ \\ **Note** This parameter is available from program version 2.2.8. | | ||
| - | The following applies for the DFD quality test plan format: | + | The following applies for the **DFD** quality test plan format: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| ^ Format | String | **DFD** | | ^ Format | String | **DFD** | | ||
| + | ^ ExportOnSaveOnly | String | When closing the programme, or closing the project, …\\ **true** … do //not// trigger this export if no changes have been made to the project.\\ **false** … trigger this export if no changes have been made to the project. (Default behaviour, applied if the parameter is not specified).\\ \\ **Note** Available from programme version 2.7.5 | | ||
| ^ 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 | | + | ^ 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. | |
| - | ^ 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 | | + | ^ 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 | |
| - | This applies to drawing exports in PDF format: | + | This applies to drawing exports in **PDF** format: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| ^ Format | String | **PDF** | | ^ Format | String | **PDF** | | ||
| + | ^ ExportOnSaveOnly | String | When closing the programme, or closing the project, …\\ **true** … do //not// trigger this export if no changes have been made to the project.\\ **false** … trigger this export if no changes have been made to the project. (Default behaviour, applied if the parameter is not specified).\\ \\ **Note** Available from programme version 2.7.5 | | ||
| ^ 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 ("\\"). | | ^ 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 ("\\"). | | ||
| ^ ColorOption | String | Controls the color representation of the drawing and the stamps:\\ **NoPolicy** Stamps as shown in the program, drawing as native\\ **Mono** Stamps and drawing sheet in black and white\\ **Grayscale** Stamps and drawing in grayscale\\ **MonoColorStamp** Stamp as shown in the program, drawing monochrome | | ^ ColorOption | String | Controls the color representation of the drawing and the stamps:\\ **NoPolicy** Stamps as shown in the program, drawing as native\\ **Mono** Stamps and drawing sheet in black and white\\ **Grayscale** Stamps and drawing in grayscale\\ **MonoColorStamp** Stamp as shown in the program, drawing monochrome | | ||
| - | ^ 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\\ **All** Export all test plan versions contained in the project; the files are written to a subdirectory for each test plan version; the directory is named with the GUID of the test plan\\ \\ **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\\ \\ **Note** The value "All" is available from program version 1.5.1.1 | | + | ^ 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\\ **All** Export all test plan versions contained in the project; the files are written to a subdirectory for each test plan version; the directory is named with the GUID of the test plan\\ \\ **Note** The "newest" inspection plan version is the inspection plan version with the highest lexical version number. | |
| - | This applies to drawing exports in SVG format: | + | This applies to drawing exports in **SVG** format: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| ^ Format | String | **SVG** | | ^ Format | String | **SVG** | | ||
| + | ^ ExportOnSaveOnly | String | When closing the programme, or closing the project, …\\ **true** … do //not// trigger this export if no changes have been made to the project.\\ **false** … trigger this export if no changes have been made to the project. (Default behaviour, applied if the parameter is not specified).\\ \\ **Note** Available from programme version 2.7.5 | | ||
| ^ 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 ("\\"). | | ^ 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\\ **All** Export all test plan versions contained in the project; the files are written to a subdirectory for each test plan version; the directory is named with the GUID of the test plan\\ \\ **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\\ \\ **Note** The value "All" is available from program version 1.5.1.1 | | + | ^ 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\\ **All** Export all test plan versions contained in the project; the files are written to a subdirectory for each test plan version; the directory is named with the GUID of the test plan\\ \\ **Note** The "newest" inspection plan version is the inspection plan version with the highest lexical version number. | |
| - | 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: |
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ 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\\ **Tif** All drawing sheets and/or all stamped characteristics in extracts as TIF 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\\ **Gif** All drawing sheets and/or all stamped characteristics in extracts as GIF files\\ \\ **Note** The use of PNG and TIF file formats is recommended, especially the JPG format is not suitable for technical drawings | |
| - | ^ 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** Export only drawing sheets\\ **DrawingWithoutStamps** Export only drawing sheets without stamps\\ **Stamps** Export only stamp graphics\\ \\ If **Mode** is not specified, drawing and stamp graphics are exported together | |
| + | ^ ImageOptions | Field | Controls the rendering of the drawing graphics\\ \\ If **ImageOptions** is not specified, the current export settings (**Settings** > **Export** > **[[en:infra-convert:user:config:export#drawing_graphic_format_group|Drawing graphic]]**) are used | | ||
| + | ^ └ Width | Integer | Width of the image in number of pixels | | ||
| + | ^ └ Height | Integer | Height of the image in number of pixels | | ||
| + | ^ └ Bit | Integer | Colour depth:\\ **8** 8 Bit\\ **24** 24 Bit (not at GIF) | | ||
| + | ^ └ SupersamplingAlgorithm | String | Supersampling method (→[[en:infra-convert:user:terms#antialiasing|Antialiasing]]):\\ **None** Do not apply supersampling\\ **Box** Average\\ **Bilinear** Linear\\ **Bicubic** Cubic\\ **Bspline** B-Spline\\ **Catmullrom** Catmull-Rom\\ **Lanczos3** Lanczos 3\\ \\ **Note** Available from program version 2.2.4 | | ||
| + | ^ └ SupersamplingFactor | Integer | Quality level for supersampling (→[[en:infra-convert:user:terms#antialiasing|Antialiasing]]):\\ **1** Do not apply supersampling\\ **2** to **5** Levels 2 to 5\\ \\ **Note** Available from program version 2.2.4 | | ||
| + | ^ StampImageOptions | Field | Controls the rendering of the stamp graphic\\ \\ If **StampImageOptions** is not specified, the current export settings (**Settings** > **Export** > **[[en:infra-convert:user:config:export#stamp_graphic_format_group|Stamp graphic]]**) are used | | ||
| + | ^ └ Width | Integer | Width of the image in number of pixels | | ||
| + | ^ └ Height | Integer | Height of the image in number of pixels | | ||
| + | ^ └ SupersamplingAlgorithm | String | Supersampling method (→[[en:infra-convert:user:terms#antialiasing|Antialiasing]]):\\ **None** Do not apply supersampling\\ **Box** Average\\ **Bilinear** Linear\\ **Bicubic** Cubic\\ **Bspline** B-Spline\\ **Catmullrom** Catmull-Rom\\ **Lanczos3** Lanczos 3\\ \\ **Note** Available from program version 2.2.4 | | ||
| + | ^ └ SupersamplingFactor | Integer | Quality level for supersampling (→[[en:infra-convert:user:terms#antialiasing|Antialiasing]]):\\ **1** Do not apply supersampling\\ **2** to **5** Levels 2 to 5\\ \\ **Note** Available from program version 2.2.4 | | ||
| + | ^ ExportOnSaveOnly | String | When closing the programme, or closing the project, …\\ **true** … do //not// trigger this export if no changes have been made to the project.\\ **false** … trigger this export if no changes have been made to the project. (Default behaviour, applied if the parameter is not specified).\\ \\ **Note** Available from programme version 2.7.5 | | ||
| ^ 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\\ **All** Export all test plan versions contained in the project; the files are written to a subdirectory for each test plan version; the directory is named with the GUID of the test plan\\ \\ **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\\ \\ **Note** The value "All" is available from program version 1.4.2.1 | | + | ^ 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\\ **All** Export all test plan versions contained in the project; the files are written to a subdirectory for each test plan version; the directory is named with the GUID of the test plan\\ \\ **Note** The "newest" inspection plan version is the inspection plan version with the highest lexical version number. | |
| </WRAP> | </WRAP> | ||
| Line 472: | Line 459: | ||
| - | * **Drawing comparison**\\ (Available from program version 1.2)\\ //Compare Documents//\\ Calls up the drawing comparison, see User's manual > User interface > Function window > [[en:infra-convert:user:interface:drwcomp|Drawing comparison]] and User’s Manual > Functions > [[en:infra-convert:user:functions:drwcompsimple|Zeichnungen vergleichen (Basic version)]] respectively [[en:infra-convert:user:functions:drwcomp|Drawing comparison (Pro version)]]. | + | * **Drawing comparison**\\ //Compare Documents//\\ Calls up the drawing comparison, see User's manual > User interface > Function window > [[en:infra-convert:user:interface:drwcomp|Drawing comparison]] and User’s Manual > Functions > [[en:infra-convert:user:functions:drwcompsimple|Zeichnungen vergleichen (Basic version)]] respectively [[en:infra-convert:user:functions:drwcomp|Drawing comparison (Pro version)]]. |
| </WRAP> | </WRAP> | ||
| Line 526: | Line 513: | ||
| \\ | \\ | ||
| - | <WRAP group> | ||
| - | <WRAP column 66.5%> | ||
| ===== Zoom on stamp ===== | ===== Zoom on stamp ===== | ||
| - | |||
| - | </WRAP> | ||
| - | <WRAP column 25%> | ||
| - | > **Available from**\\ program version 1.2.0.21 | ||
| - | </WRAP> | ||
| - | <WRAP column 15%> | ||
| - | </WRAP> | ||
| - | |||
| - | </WRAP> | ||
| - | |||
| <WRAP group> | <WRAP group> | ||
| Line 613: | Line 588: | ||
| "Settings": { | "Settings": { | ||
| "Path": "C:/ProgramData/ELIAS GmbH/infra-CONVERT/Settings.json", | "Path": "C:/ProgramData/ELIAS GmbH/infra-CONVERT/Settings.json", | ||
| + | "Force": true | ||
| } | } | ||
| </code> | </code> | ||
| Line 812: | Line 788: | ||
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ CharacteristicId | String | GUID of the characteristic | | + | ^ CharacteristicId | String | GUID of the characteristic\\ \\ **Note** The GUID of the characteristic from which the characteristic searched for in the drawing comparison emerged ("DirectCompareSourceId") or originally emerged ("CompareSourceId") can also be transferred. | |
| ^ Action | String | **Update** Action: update | | ^ Action | String | **Update** Action: update | | ||
| ^ CharacteristicTags | String | GUID of the tag | | ^ CharacteristicTags | String | GUID of the tag | | ||
| Line 894: | Line 870: | ||
| |< 100% 34% 12% 53% >| | |< 100% 34% 12% 53% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ Action | String | **AddOrUpdate** Add or change a tag, depending on whether or not the tag exists | | + | ^ Action | String | **AddOrUpdate** Add or change a tag, depending on whether or not the tag exists\\ **Add** Add a tag that does not exist ("AddOrUpdate" should be used preferentially)\\ **Remove** Delete a tag\\ **ResetDefault** Set a tag added or addressed with this as the new default. Existing tags are deleted. All characteristics are assigned this tag | |
| ^ CharacteristicTag | Feld | Contains all the properties of the tag | | ^ CharacteristicTag | Feld | Contains all the properties of the tag | | ||
| ^ └ Id | String | GUID of the tag | | ^ └ Id | String | GUID of the tag | | ||
| Line 909: | Line 885: | ||
| ^ └ 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. | ||
| + | |||
| + | <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> | ||
en/infra-convert/dev/parameter.1596033629.txt.gz · Last modified: 2020/07/29 16:40 by me
Page Tools
