User Tools

Site Tools


en:infra-convert:dev:parameter

This is an old revision of the document!


Administrator’s Manual infra CONVERT > Configuration and Import

Startup parameter file


The startup parameter file is opened by transferring adjacent request parameter “parameter” by executing infra CONVERT. 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”

InfraConvertWPF.exe -parameter="C:/Windows/Temp/StartParameterFile.json"

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.

InfraConvertWPF.exe -forceConfigDir="C:/ProgramData/ELIAS GmbH/infra-Convert"

Both parameters can also be transferred at the same time:

InfraConvertWPF.exe -parameter="..." -forceConfigDir="..."
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 ExcelReportsPath) and the directory with tolerance tables (parameter 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.

Examples for start parameter files

You can find a complete example of a startup parameter file here: Appendix > Example startup parameter file


A compilation of different start parameter scenarios can be downloaded here: 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.

Start with specific parameter files
  10 - Start with specific parameter files

The user starts after starting infra CONVERT 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.

Create project and export when closing
  20 - Create project and export

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”.

Create new test plan version and start drawing comparison
  30 - Compare drawings

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.

Zoom to stamp via GUID
  40 - Zoom to stamp via GUID

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”.

Zoom to stamp via ICP-ID
  41 - Zoom to stamp via ICP-ID

A (temporary) project is created and an ICP file (project file from infra - CONVERT) is loaded. Only the ID (“ICP-ID”) of the characteristic or the stamp in the ICP file is known.

Zoom to stamp via CompareSourceId
  42 - Zoom to stamp via CompareSourceId

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.

Setting the language

Use the LanguageCode field to specify the language of the user interface of infra CONVERT.

Without this code, the default language set in the operating system will automatically be used. If it is not supported by infra CONVERT, English will always be set.

See also
User’s Manual infra CONVERT > Settings > Settings > General > “Language” Group
"LanguageCode":"de",
Parameter Type Value/Content
LanguageCode String de German
en English
fr French
it Italian
es Spanish
ru Russian


Open or create project

With the Project field, specify that an existing project should open or a new project be created when infra CONVERT is launched.

See also
User’s Manual infra CONVERT > Functions > Projects > Create new project

User’s Manual infra CONVERT > Functions > Projects > Open project

User’s Manual infra CONVERT > Functions > Projects > Save project
"Project": {
  "Path": "C:/Users/user1/Desktop/test.icpx",
  "Name":"Beispiel Projekt",
  "Action":"Open"
}
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 (“\\”).
Name String Project title (ignored when opening)
Action String Open Opens an existing project
Create Creates a new project


Open or create quality test plan

With the InspectionPlanVersion field, specify that an existing quality test plan should open or a new quality test plan be created when infra CONVERT is launched.

A new quality test plan can only be created when a project has already been created.

See also
User’s Manual infra CONVERT > Functions > Quality test Plans > Create quality test plan
"InspectionPlanVersion": {
  "Name": "Zeichnungsstand",
  "Version": "0",
  "Action": "Create"
}
Parameter Type Value/Content
Name String Quality test plan title (ignored when opening)
Version Decimal Version of the quality test plan (ignored when opening)
Action String Open Opens an existing quality test plan
Create Creates a new quality test plan


Transfer drawing

Use the Files field to import any number of drawing sheets in a quality test plan when infra CONVERT is launched.

See also
User’s Manual infra CONVERT > Functions > Drawings > Import drawings

User’s Manual infra CONVERT > More > Terms > Drawing date format
"Files": [
  {
  "Path":"C:/Users/user1/Desktop/drawing_1.dxf"
  },
  {
  "Path":"C:/Users/user1/Desktop/drawing_2.dwg",
  "ImportBehavior": "Ask"
  },
  {
  "Path":"C:/Users/user1/Desktop/drawing_3.igs"
  },
  {
  "Path":"C:/Users/user1/Desktop/drawing_4.pdf",
  "ImportBehavior": "ImportAllPages"
  },
  {
  "Path":"C:/Users/user1/Desktop/drawing_5.icp"
  },
  {
  "Path":"https://ftp.elias-gmbh.de/fictional_path/example.dwg"
  }
]

This applies to all imported drawings:

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.

This applies to drawing imports in PDF format:

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

This applies to drawing imports in DXF and DWG format:

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


Export quality test plans and stamped drawings

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 infra CONVERT should be exported.

Note We recommend you use the quality test plan format JSONV1 because it supports all the characteristics of infra CONVERT.
See also
Administrator’s Manual infra CONVERT > Export > Quality test plan format JSONV2

Administrator’s Manual infra CONVERT > Export > Quality test plan format JSONV1

Administrator’s Manual infra CONVERT > Export > Quality test plan format DFD
"Targets": [
  {
    "Format":"JSONV1",
    "LanguageCode":"de",
    "Path":"C:/Temp/testplan.json",
    "InspectionPlanVersionExportMode": "Last"
  },
  {
    "Format":"CSV",
    "Path":"C:/Temp/CSV/testplan.csv"
  },
  {
    "Format":"DFD",
    "Path":"C:/Temp/DFD/",
    "ExportHint": "MultiFileExport"
  },
  {
    "Format":"DFD",
    "Path":"C:/Temp/DFD/testplan.dfd",
    "ExportHint": "CombinedExport"
  },
  {
    "Format":"PDF",
    "Path":"C:/Temp/PDF/"
  },
  {
    "Format":"Png",
    "Path":"C:/Temp/Graphics/",
  {
    "Format":"Jpg",
    "Path":"C:/Temp/Graphics/",
    "Mode":"Drawing"
  },
  {
    "Format":"Bmp",
    "Path":"C:/Temp/Graphics/",
    "Mode":"Stamps"
  }
]

The following applies for the JSONV2 quality test plan format (available from program version 1.4.2.1):

Parameter Type Value/Content
Format String JSONV2
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 (“\\”).

The following applies for the JSONV1 quality test plan format:

Parameter Type Value/Content
Format String JSONV1
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 (“\\”).
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:

Parameter Type Value/Content
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 (“\\”).
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:

Parameter Type Value/Content
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 (“\\”).
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:

Parameter Type Value/Content
Format String PDF All drawing sheets each as a PDF file
SVG All drawing sheets each as a SVG file
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:

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
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 (“\\”).
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
All Export all test plan versions contained in the project; the files are written to a subdirectory for each test plan version

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


Invoke function

With the Mode field, call up a function in infra CONVERT when it is launched. The function will not be executed, but it will be opened and is thus directly available to the user. The following functions are currently available (more will follow):

  • Tag tool
    AddCharacteristicTag
    Calls up the tag tool function, see User’s Manual > Functions > characteristics > Tag.

The following applies for the Tag tool function:

"Mode": {
  "Name": "AddCharacteristicTag",
  "ItemId": "{5D1110CA-6093-4381-B372-CF983D515044}"
}
Parameter Type Value/Content
Name String AddCharacteristicTag
ItemId String GUID of the tag

The following applies for the Drawing comparison function:

"Mode":{  
   "Name":"CompareDocuments",
   "SourceInspectionPlanVersion":{  
      "Name":"Neuer Prüfplan",
      "Version":"A"
   },
   "TargetInspectionPlanVersion":{  
      "Name":"Neuer Prüfplan",
      "Version":"B"
   },
   "SourceDocumentOriginalFileName":"ez-29002675001-84-0_1.dxf",
   "TargetDocumentOriginalFileName":"ez-29002675001-84-a_1.dxf"
}
Parameter Type Value/Content
Name String CompareDocuments
Source​Inspection​Plan​Version Field
└ Name String Name of the source test plan version
└ Version String Version number of the source test plan version
Target​Inspection​Plan​Version Field
└ Name String Name of the target test plan version
└ Version String Version number of the target test plan version
Source​Document​Original​File​Name String File name of the source drawing sheet
Target​Document​Original​File​Name String File name of the target drawing sheet


Zoom on stamp

Available from
program version 1.2.0.21

When opening a project, you can set the view in the drawing window to a specific stamp. infra CONVERT focuses the stamp and zooms in so far that the corresponding drawing entry including the surrounding area is fitted into the window.

Each stamp in an ICPX file is assigned a GUID. Pass it in the field ZoomToStampGuid. If characteristics have been linked by transfer or merge in the drawing comparison, you can also transfer the ID of the original stamp, then the system zooms to the corresponding stamp of the latest inspection plan version.

If ICP files are loaded into a project, the GUIDs of the stamps may not be known. In this case, you can also pass the stamp ID. Use the field ZoomToStampIcpId. In this field you must also specify the test plan version and the name of the ICP file, because the ID from infra - CONVERT is only valid within an ICP project.

Note
infra CONVERT can also be used as a viewer with the zoom functionality. Disable user interface controls (see “Configuration and Import > Parameter file "UiAccess"”) to prevent data corruption. To view ICP files, temporarily create an ICPX project and load the ICP file into a test plan version.

The GUID of the stamp is known:

"ZoomToStampGuid":{  
   "Id":"{56422575-2376-497f-b633-8dbe06626fab}"
}
Parameter Type Value/Content
Id String GUID of the stamps

Only the ID of the stamp in the ICP file is known:

"ZoomToStampIcpId":{
   "InspectionPlanVersion":{  
      "Name":"Neuer Prüfplan",
      "Version":"A"
   },
   "DocumentName":"ez-29002675001-84-0_1.icp",
   "Id":"3"
}
Parameter Type Value/Content
InspectionPlanVersion Feld
└ Name String Title of the test plan version
└ Version String Version number
DocumentName String Name of the ICP file
Id String ICP ID


Settings

The path to the parameter file Settings.json is specified in the Settings field. infra CONVERT 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 CommonAppData directory whose path is defined in the “settings.json” with the parameter “CommonAppDataPath”.
See also
Administrator’s Manual infra CONVERT > Run program > Parameter file "Settings"

Administrator’s Manual infra CONVERT > Configuration and Import > “Settings” Parameter file > List of the settings > Settings with no control elements in user interfaces

User’s Manual infra CONVERT > Settings > Settings > General
"Settings": {
  "Path": "C:/ProgramData/ELIAS GmbH/infra-CONVERT/Settings.json",
}
Parameter Type Value/Content
Path String Path to the location and file name; the directory names must be separated by slash characters (“/”) or double backslash characters (“\\”).


Parameter file for tags

The path to the parameter file CharacteristicTags.json is specified in the CharacteristicTagsDefinition field. infra CONVERT obtains the definitions for tags with which the project is saved from this file.

If this file does not exist, it will be created with the default settings.

See also
Administrator’s Manual infra CONVERT > Run program > Parameter file "CharacteristicTags"

User’s Manual infra CONVERT > Settings > Project settings > Tags
"CharacteristicTagsDefinition": {
  "Path": "C:/Users/user1/AppData/CharacteristicTags.json",
}
Parameter Type Value/Content
Path String Path to the location and file name; the directory names must be separated by slash characters (“/”) or double backslash characters (“\\”).


Parameter file for characteristic classes

The path to the parameter file CharacteristicClasses.json is specified in the CharacteristicClassesDefinition field. infra CONVERT obtains the definitions for characteristic classes with which the project is saved from this file.

See also
Administrator’s Manual infra CONVERT > Configuration and Import > Parameter file "CharacteristicClasses"

User’s Manual infra CONVERT > More > Terms > Class (characteristic-)
"CharacteristicClassesDefinition": {
  "Path": "C:/Users/user1/AppData/CharacteristicClasses.json"
}
Parameter Type Value/Content
Path String Path to the location and file name; the directory names must be separated by slash characters (“/”) or double backslash characters (“\\”).


Parameter file for feature categories

The path to the parameter file SpecialCategories.json is specified in the SpecialCategoriesDefinition field. infra CONVERT obtains the definitions for characteristic categories with which the project is saved from this file.

See also
User’s Manual infra CONVERT > Settings > Project settings > Categories

User’s Manual infra CONVERT > More > Terms > Category (characteristic)
"SpecialCategoriesDefinition": {
  "Path": "C:/Users/user1/AppData/SpecialCategories.json"
}
Parameter Typ Value/Content
Path String Path to the location and file name; the directory names must be separated by slash characters (“/”) or double backslash characters (“\\”).


Parameter file for stamp templates

The path to the parameter file StampTemplates.json is specified in the StampTemplatesDefinition field. infra CONVERT obtains the definitions for stamp templates which are saved with the project, from this file.

See also
Administrator’s Manual infra CONVERT > Configuration and Import > Parameter file "StampTemplates"

User’s Manual infra CONVERT > Settings > Project settings > Stamp templates
"StampTemplatesDefinition": {
  "Path": "C:/Users/user1/AppData/StampTemplates.json"
}
Parameter Typ Value/Content
Path String Path to the location and file name; the directory names must be separated by slash characters (“/”) or double backslash characters (“\\”).


Parameter file for showing/hiding/locking control elements

The UiAccessDefinition field sets the path to the UiAccess.json parameter file. It can be used to control which control elements in the infra CONVERT user interface should be visible, locked or hidden.

If the file does not exist, it will be created with the usual default settings.

See also
Administrator's Manual infra CONVERT > Configuration and Import > Parameter file "UiAccess"
"UiAccessDefinition": {
  "Path": "C:/Users/user1/AppData/UiAccess.json",
}
Parameter Typ Value/Content
Path String Path to the location and file name; the directory names must be separated by slash characters (“/”) or double backslash characters (“\\”).


Editing characteristics

The Characteristics field allows you to communicate to infra CONVERT which characteristics have changed in an existing project since it was last edited. If new tags were assigned in a CAQ system, for instance, this method allows them to also be reassigned in the project.

See also
User’s Manual infra CONVERT > User interface > Function window > characteristic properties
"Characteristics": [
  {
    "CharacteristicId": "66a58671-5b11-4135-8210-32701be6f4a5",
    "Action":"Update",
    "CharacteristicTags": [
      "5D1110CA-6093-4381-B372-CF983D515044",
      "24C41CA8-871C-456E-B082-22EC2A20216D"
    ],
    "SpecialCategory":"{3E298F8F-02F1-49CD-82BF-BCDF26DA11FE}"
  },
  {
    "CharacteristicId": "b29bfa80-294a-4ca6-ae8f-81f4e63a39be",
    "Action":"Update",
    "CharacteristicTags": [ "5D1110CA-6093-4381-B372-CF983D515044" ],
    "SpecialCategory":"{3E298F8F-02F1-49CD-82BF-BCDF26DA11FE}"
  }
]
Parameter Type Value/Content
CharacteristicId String GUID of the characteristic
Action String Update Action: update
CharacteristicTags String GUID of the tag
SpecialCategory String GUID of the category


Editing tags

The CharacteristicTags field allows you to communicate to infra CONVERT which tags have been added or changed since the last time a project was edited.

See also
User’s Manual infra CONVERT > Settings > Project settings > Tags
"CharacteristicTags": [
  {
    "Action": "AddOrUpdate",
    "CharacteristicTag":{
      "Id": "69A6290C-89E2-438B-A2D7-F0AA645409CA",
      "Priority": 2,
      "FriendlyName": "TagThree",
      "Color": {
        "Type": "RGB",
        "R": 0,
        "G": 255,
        "B": 0
      },
      "LocalizedProperties": [
        {
          "Name": "Tag Three ",
          "Description":"",
          "LanguageCode": "en"
        },
        {
          "Name": "Kennzeichnung Drei",
          "Description": "",
          "LanguageCode": "de"
        }
      ]
    }
  },
  {
    "Action": "AddOrUpdate",
    "CharacteristicTag":{
      "Id": "5D1110CA-6093-4381-B372-CF983D515044",
      "Priority": 2,
      "FriendlyName": "",
      "Color": {
        "Type": "RGB",
        "R": 0,
        "G": 0,
        "B": 255
      },
      "LocalizedProperties": [
        {
          "Name": "Tag Four ",
          "Description":"",
          "LanguageCode": "en"
        },
        {
          "Name": "Kennzeichnung Vier",
          "Description": "",
          "LanguageCode": "de"
        }
      ]
    }
  }
]
Parameter Type Value/Content
Action String AddOrUpdate Add or change a tag, depending on whether or not the tag exists
CharacteristicTag Feld Contains all the properties of the tag
└ Id String GUID of the tag
└ Priority Integer Rank in the order of existing tags
└ FriendlyName String Name of the tag
└ Color Feld Stamp color of a characteristic with this tag
 └ Type String RGB “RGB” color system
 └ R Integer Color value for red: 0…255
 └ G Integer Color value for green: 0…255
 └ B Integer Color value for blue: 0…255
└ LocalizedProperties Feld Name of the tag (possible for multiple languages)
 └ Name String User-friendly name of the tag
 └ Description String Description of the tag (optional)
 └ LanguageCode String de German
en English

Go to previous page
Introduction > Overview

Go to next page
Configuration and Import > Parameter file "Settings"

en/infra-convert/dev/parameter.1579186321.txt.gz · Last modified: 2020/01/16 15:52 by me