~~NOTOC~~ > Administrator’s Guide #@IC_HTML@# > Introduction ====== Overview ====== ---- > {{:en:infra-convert:icon_preview.png?nolink&0x35}} Preview of #@IC_HTML@# v2 #@IC_HTML@# can be adapted very flexibly to the most diverse needs. Behaviour and appearance can be predefined with parameter files. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_beispiel_00.png?nolink&800 |}} \\ //**__Content__**//  • [[en:infra-convert:dev:intro_preview#The configuration and template files]]\\  • [[en:infra-convert:dev:intro_preview#The directories for configuration and template files]]\\  • [[en:infra-convert:dev:intro_preview#Behavior without start parameter call]]\\  • [[en:infra-convert:dev:intro_preview#Behavior at start parameter call]]\\  • [[en:infra-convert:dev:intro_preview#Installation/Uninstallation]] \\ ===== The configuration and template files ===== A distinction is made between configuration files, which influence the program behavior, and template files. Project templates are read in when a new project is created and stored in it. Other templates are read during runtime. Parameter files are written in the JavaScript Object Notation (JSON, see also [[http://www.json.org/json-en.html|here]]). ^ ^ File ^ Content ^ Description ^ ^ Transfer on program start ^^^^ ^ {{ :en:infra-convert:dev:icon_dev_einstellungen.png?nolink&80 }} ^ settings.json | Program or basic settings | Configuration and import > [[en:infra-convert:dev:settings|"Settings" Parameter file]] | ^ {{ :en:infra-convert:dev:icon_dev_uiaccess_2.png?nolink&80 }} ^ UiAccess.json | Accessibility of the user interface controls (lock or hide controls) | Configuration and import > [[en:infra-convert:dev:uiaccess|"UiAccess" Parameter file]] | ^ Transfer when creating a new project ^^^^ ^ {{ :en:infra-convert:dev:icon_dev_kategorien.png?nolink&80 }} ^ SpecialCategories.json | Categories | Configuration and import > [[en:infra-convert:dev:specialcategories|Parameter file "SpecialCategories"]] | ^ {{ :en:infra-convert:dev:icon_dev_kennzeichnungen.png?nolink&80 }} ^ CharacteristicTags.json | Tags | Configuration and import > [[en:infra-convert:dev:characteristictags|Parameter file "CharacteristicTags"]] | ^ {{ :en:infra-convert:dev:icon_dev_stempelvorlagen.png?nolink&80 }} ^ StampTemplates.json | Stamp templates | Configuration and import > [[en:infra-convert:dev:stamptemplates|Parameter file "StampTemplates"]] | ^ {{ :en:infra-convert:dev:icon_dev_klassen.png?nolink&80 }} ^ CharacteristicClasses.json | Classes | Configuration and import > [[en:infra-convert:dev:characteristicclasses|Parameter file "CharacteristicClasses"]] | ^ Read during runtime ^^^^ ^ {{ :en:infra-convert:dev:icon_dev_toleranztabellen.png?nolink&80 }} ^ *.json | Tolerance tables (several files) | Configuration and import > Parameter file "Settings" > [[en:infra-convert:dev:settings#list_of_the_settings|List of the settings]] > “Project settings > Tolerance tables” menu\\ \\ Configuration and import > [[en:infra-convert:dev:toltab|Tolerance tables]] | ^ {{ :en:infra-convert:dev:icon_dev_excel.png?nolink&80 }} ^ *.xltx\\ *.xltm\\ *.xlt | Excel test report templates | Configuration and import > Parameter file "Settings" > [[en:infra-convert:dev:settings#list_of_the_settings|List of the settings]] > “Settings > Export” menu\\ \\ User Manual > More > [[en:infra-convert:user:exceltemp|Create and customize Excel templates]] | \\ ===== The directories for configuration and template files ===== **ProgramData** The default directory for configuration and template files is %ProgramData%\ELIAS GmbH\infra-convert\ Here the files are assigned to the following directory levels: |< 100% 5% 25% 20% 40% >| ^ ^ File ^ Directory level ^ Note ^ ^ Configuration ^^^^ ^ {{ :en:infra-convert:dev:icon_dev_einstellungen.png?nolink&80 }} ^ settings.json | .\ | The storage location can be set by start parameter | ^ {{ :en:infra-convert:dev:icon_dev_uiaccess_2.png?nolink&80 }} ^ UiAccess.json | .\JsonData\ | The storage location can be set by start parameter\\ \\ Die Verwendung der Datei ist optional | ^ Projektvorlagen ^^^^ ^ {{ :en:infra-convert:dev:icon_dev_kategorien.png?nolink&80 }} ^ SpecialCategories.json | .\JsonData\ | The storage location can be set by start parater | ^ {{ :en:infra-convert:dev:icon_dev_kennzeichnungen.png?nolink&80 }} ^ CharacteristicTags.json | .\JsonData\ | The storage location can be set by start parameter | ^ {{ :en:infra-convert:dev:icon_dev_stempelvorlagen.png?nolink&80 }} ^ StampTemplates.json | .\JsonData\ | The storage location can be set by start parameter | ^ {{ :en:infra-convert:dev:icon_dev_klassen.png?nolink&80 }} ^ CharacteristicClasses.json | .\JsonData\ | The storage location can be set by start parameter | ^ Weitere Vorlagen ^^^^ ^ {{ :en:infra-convert:dev:icon_dev_toleranztabellen.png?nolink&80 }} ^ *.json | .\ExcelReports\ | The storage location is defined in the "settings.json | ^ {{ :en:infra-convert:dev:icon_dev_excel.png?nolink&80 }} ^ *.xltx\\ *.xltm\\ *.xlt | .\ToleranceTables\ | The storage location is defined in the "settings.json | For the standard configuration and template directory ("ProgramData") another directory can be specified with the special start parameter "forceConfigDir". See "Configuration and Import > [[en:infra-convert:dev:parameter|Startup parameter file]] (first paragraph)". \\ **AppData** User-specific configurations and templates are stored in the respective AppData directory of the user: %AppData%\ELIAS GmbH\infra-convert\ The same directory level hierarchy applies here as for ProgramData. In particular, if a user saves settings without administrator rights or write access to the ProgramData directory, the user's changes are written to the AppData directory. In the following, the handling of parameter files is explained step by step. First, using the example of a normal program run without a start parameter call, then with a start parameter call. \\ ===== Behavior without start parameter call ===== **Start the program** In the first scenario, #@IC_HTML@# is started regularly (without administrator rights). The program settings ("settings.json") are loaded from ProgramData. The "UiAccess.json" contains settings for locking or hiding individual controls. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_beispiel_01.png?nolink&800 |}} \\ **Change settings** If the user changes settings (**Edit** (menu bar) > **Settings**) and saves them, the changes are stored in his AppData directory. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_beispiel_02.png?nolink&800 |}} \\ From now on, the saved changes override the settings from ProgramData. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_beispiel_03.png?nolink&800 |}} \\ > **Note** To prevent a user from changing settings, the associated user interfaces can be locked via UiAccess. \\ **Create new project** The user creates a new project based on the project templates for categories, tags, stamp templates and classes. The available tolerance tables are listed for the user and are available for use. He then loads two drawing sheets, here from a "Workspace" directory. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_beispiel_04.png?nolink&800 |}} \\ The user can customize the definitions for categories, tags and stamp templates in the user interface (**Edit** (menu bar) > **Project Settings**). The changes are saved in the project. The definitions of classes cannot be changed afterwards. Saving the definitions in the project ensures the interchangeability of projects. \\ **Stamp and export** The user stamps the drawing and creates the test plan. He saves the project (*.icpx) and finally exports the completed test plan as Excel file (*.xlsx) and the stamped drawing sheets as PDF (*.pdf) to directories he has specified, for easier viewing here to "Workspace". The template for the test report is an Excel template file (*.xltx). {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_beispiel_05.png?nolink&800 |}} \\ **Operating the program in administrator mode** In the second scenario, #@IC_HTML@# is started with administrator rights. The administrator mode is intended to adjust configurations for all users. At startup, the settings are loaded as in regular mode. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_beispiel_06.png?nolink&800 |}} \\ When saving, however, the settings are written to the ProgramData directory. The "settings.json" in AppData will become invalid and will be deleted for the user who is working as administrator at that moment. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_beispiel_07.png?nolink&800 |}} \\ ===== Behavior at start parameter call ===== Start parameters can be used to implement automatisms that facilitate the work flow with always the same work processes. This administration is necessary if #@IC_HTML@# is integrated into a CAQ/MES system and is also useful if standard settings and workflows are to be given to the user. The available start parameters are, with the exception of "forceConfigDir", summarized in a start parameter file, see Configuration and Import > [[en:infra-convert:dev:parameter|Startup parameter file]]. The following example shows some possibilities for working with start parameter calls. The start parameter file refers to a "settings.json", a "UiAccess.json" and four project template files; the location for the tolerance tables is specified in the "settings.json". For a simpler representation, all files are loaded from a "Config" directory, this can be located on a company server, for example. However, the location and distribution of the storage locations are arbitrary. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_beispiel_08.png?nolink&800 |}} \\ The storage locations specified in the start parameter file are always preferred, the files located there are expected and read out. An exception is the "settings.json". First the "settings.json" is read from ProgramData. This is overlaid by the "settings.json" passed by the start parameter and then, if available, by the "settings.json" loaded from AppData. The last loaded definition is therefore the leading one. > **Note** If the "settings.json" passed by start parameter should have priority over the user-defined "settings.json" from AppData, this can be specified as an option at the start parameter command. See "Configuration and Import > Startup Parameter File > [[en:infra-convert:dev:parameter#einstellungen|Settings]]". \\ ===== Installation/Uninstallation ===== **Erst- oder Neuinstallation** During installation, the following configuration and template files are written to the ProgramData directory with default values. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_installation_01.png?nolink&800 |}} \\ **Overinstallation** When installing a new version over an older version (update) or a repair, template files in ProgramData are overwritten with standard templates, provided that the file name corresponds to the standard during installation. Renamed or specially created files are not changed or deleted. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_ueberinstallation_01.png?nolink&800 |}} \\ **Uninstallation** During uninstallation, the following configuration and template files are removed from the ProgramData directory Renamed or specially created files are not changed or deleted. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_deinstallation_01.png?nolink&800 |}} \\ **Install 64-bit over 32-bit version** Installing a 64-bit version (from program version 2.0.0.0) over a 32-bit version of #@IC_HTML@# behaves like a regular over-installation as described above. The 64-bit version is installed to " C:\Program Files", the installation directory of the 32-bit version from " C:\Program Files (x64)" is deleted. With regard to parameter files, only the following aspect must be observed: The first time the program is started by a user, it checks whether parameter files are located in the user's VirtualStore directory. If there are, they are copied to the AppData directory of the user. Only the difference between the two "settings.json" in AppData and ProgramData in AppData is stored. In most cases not all four project template files will be found in the VirtualStore, but only "SpecialCategories.json" and "CharacteristicTags.json". We generally recommend that you do not maintain the project template files in AppData, but centrally in ProgramData. With one user per computer, you can simply copy the parameter files manually from AppData to ProgramData, with multiple users you should agree accordingly. {{ :en:infra-convert:dev:arbeiten_mit_parameterdateien_v2_installation_64_ueber_32_01.png?nolink&800 |}} \\ > **Note** What is the VirtualStore? - The VirtualStore is automatically used by the Windows operating system as a replacement for 32-bit programs when a program is run by a user without write permission to the ProgramData directory and that user saves settings. This mechanism is called UAC (User Account Control) virtualization. Whether UAC virtualization is applied can be seen in the TaskManager on the **Details** page. Usually the column "UAC Virtualization" is hidden, but can be added simply by right-clicking on the header. The VirtualStore directory can be found under "%LocalAppData%\VirtualStore\ProgramData\ELIAS GmbH". The folder "ELIAS GmbH" is normally a hidden item. ---- **Go to previous page**\\ Introduction > [[en:infra-convert:dev:Wiki|Tips on the Administrator’s Guide]] **Go to next page**\\ Configuration and Import > [[en:infra-convert:dev:parameter|Startup parameter file]]