Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen gezeigt.

@@ Zeile 1: / Zeile 1: @@
+~~NOTOC~~
+<WRAP noprint>
+> Administratorhandbuch #@IC_HTML@# > Aufrufparameter
+</WRAP>
+====== Startparameterdatei ======
+----
+Die Aufrufparameter für #@IC_HTML@# werden in Form einer JSON Datei übergeben. Es gibt nur noch einen Startparameter, der übergeben werden kann, um die Parameterdatei zu spezifizieren:
+<code>
+InfraConvertWPF.exe -parameter="vollständiger Pfad zur Parameterdatei"
+</code>
+In diesem Dokument werden die einzelnen Parameter innerhalb der JSON Datei erklärt. Die Datei kann einen beliebigen Teil der hier vorgestellten Übergabewerte beinhalten, muss sich aber an die Bestimmungen zum Aufbau einer JSON Datenbank halten.
+Eine vollständiges Beispiel kann [[de:infra-convert:dev:parameter_beispiel|hier]] angesehen werden.
+<WRAP noprint>
+<WRAP group>
+<WRAP column 32%>
+//**__Inhalt__**//
+ • [[de:infra-convert:dev:parameter#Sprache einstellen]]\\
+ • [[de:infra-convert:dev:parameter#Projekt öffnen/erzeugen]]\\
+ • [[de:infra-convert:dev:parameter#Prüfplan öffnen/erzeugen]]\\
+ • [[de:infra-convert:dev:parameter#Zeichnungen übergeben]]\\
+ • [[de:infra-convert:dev:parameter#Prüfpläne speichern]]\\
+ • [[de:infra-convert:dev:parameter#Funktionsaufruf]]\\
+ • [[de:infra-convert:dev:parameter#Einstellungen (global)]]\\
+ • [[de:infra-convert:dev:parameter#Einstellungen (Benutzer)]]\\
+ • [[de:infra-convert:dev:parameter#Definitionsdatei für Merkmals Tags]]\\
+ • [[de:infra-convert:dev:parameter#Definitionsdatei für Merkmalsklassen]]\\
+ • [[de:infra-convert:dev:parameter#Definitionsdatei für Merkalskategorien]]\\
+ • [[de:infra-convert:dev:parameter#Definitionsdatei für Stempelvorlagen]]\\
+ • [[de:infra-convert:dev:parameter#Merkmale bearbeiten]]\\
+ • [[de:infra-convert:dev:parameter#Tags bearbeiten]]
+\\
+</WRAP>
+</WRAP>
+</WRAP>
+===== Sprache einstellen =====
+<code javascript>
+"LanguageCode":"de",
+</code>
+<table>
+<caption>**Unterstützte Sprachen** (im Aufbau)</caption>
+^ Sprache ^ Code ^
+| Deutsch | de |
+| Englisch | en |
+</table>
+Der Code für die Sprache, in der #@IC_HTML@# gestartet wird. Ohne diesen Code wird automatisch die Systemsprache benutzt. Falls die Systemsprache nicht unterstützt ist, wird immer Englisch als Sprache benutzt.
+\\
+===== Projekt öffnen/erzeugen =====
+<code javascript>
+"Project": {
+    "Path": "C:/Users/user1/Desktop/test.icpx",
+    "Name":"Beispiel Projekt",
+    "Action":"Open"
+  },
+</code>
+<table>
+<caption>**Projekte** - unterstützte Optionen</caption>
+^ Parameter ^ Typ ^ Inhalt neues Projekt ^ Inhalt vorhandenes Projekt ^
+| Path | String | Vollständiger Pfad zum Projektfile (wird angelegt) | Vollständiger Pfad zum Projektfile (wird modifiziert) |
+| Name | String | Name des Projektes | --- |
+| Action | String | **Open** - Öffnet ein vorhandenes Projekt ||
+| :::    | :::    | **Create** - Legt ein neues Projekt an      ||
+</table>
+Wenn #@IC_HTML@# beim Start ein Projekt öffnen oder anlegen soll, können an dieser Stelle die passenden Parameter übergeben werden.
+\\
+===== Prüfplan öffnen/erzeugen =====
+<code javascript>
+ "InspectionPlanVersion": {
+    "Name": "Version 2",
+    "Version": "1.0",
+    "Action": "Create"
+  },
+</code>
+<table>
+<caption>**Prüfplan** - unterstützte Optionen</caption>
+^ Parameter ^ Typ ^ Inhalt neues Projekt ^ Inhalt vorhandenes Projekt ^
+| Name | String | Name des zu erzeugenden Prüfplans | Name des zu bearbeitenden Prüfplans |
+| Version | Dezimal | Versionsnummer des zu erzeugenden Prüfplans | Versionsnummer des zu bearbeitenden Prüfplans |
+| Action | String | **Open** - Öffnet einen vorhandenen Prüfplan ||
+| :::    | :::    | **Create** - Legt einen neuen Prüfplan an      ||
+</table>
+Wenn #@IC_HTML@# beim Start einen Prüfplan öffnen oder anlegen soll, können an dieser Stelle die passenden Parameter übergeben werden.
+\\
+===== Zeichnungen übergeben =====
+<code javascript>
+  "Files": [
+    {
+    "Path":"C:/Users/user1/Desktop/1.dxf"
+    },
+    {
+    "Path":"C:/Users/user1/Desktop/2.dwg"
+    },
+    {
+    "Path":"C:/Users/user1/Desktop/3.dxf"
+    }
+  ],
+</code>
+Eine beliebig Anzahl von Zeichnungen, die in **einen Prüfplan** importiert werden sollen. Jeder Eintrag beinhaltet den vollständigen Pfad zu einer Zeichnung.
+Die möglichen Zeichnungsformate sind im Handbuch für Benutzer gelistet.
+<WRAP important 500px>Zeichnungen können mehrseitig sein!</WRAP>
+\\
+===== Prüfpläne speichern =====
+<code javascript>
+"Targets": [
+    {
+      "Format":"JSONV1",
+      "LanguageCode":"de",
+      "Path":"C:/Temp/project.json"
+    },
+    {
+      "Format":"PDF",
+      "Path":"C:/Temp/project.pdf"
+    },
+    {
+      "Format":"GraphicsPng",
+      "Path":"C:/Temp/Graphics/"
+    }
+</code>
+<table>
+<caption>**Exportformate** unterstützte Speicherformate</caption>
+^ Format ^ Typ ^ Inhalt ^ Verwendung ^
+| [[de:infra-convert:dev:export|JSONV1]] | String | Primäres Exportformat | Dieses Exportformat ist für den Import der Daten in Ihre Software unbedingt zu bevorzugen! |
+| [[de:infra-convert:dev:export|CSV]] | String | Comma-separated values | Das Exportformat, wenn die Daten mit Excel weiter verarbeitet werden sollen. |
+| [[de:infra-convert:dev:export|DFD]] | String | Q-DAS ASCII Transferformat | Prüfpläne an Messmaschinen übertragen, sollte mit GraphicsPng benutzt werden. |
+| PDF | String | Die gestempelte Zeichnung als PDF  | #@IC_HTML@# speichert PDF Dateien der gestempelten Zeichnung direkt unter Berücksichtigung der Zeichnungsgröße. |
+| Png | String | Die Merkmale als PNG-Grafik  | Die Grafiken können in Partnersysteme importiert werden, welche den Viewer von #@IC_HTML@# nicht nutzen |
+</table>
+<table>
+<caption>**Exportformate** unterstützte Optionen</caption>
+^ Parameter ^ Typ ^ Inhalt ^ Gültig bei Format ^
+| LanguageCode | String | Die Sprache in der der Prüfplan exportiert werden soll. Zulässige Optionen: siehe [[de:infra-convert:dev:parameter#Sprache|Abschnitt Sprache]] | JSONV1, DFD, CSV |
+| Path | String | Der vollständige Pfad und Dateiname beim Export von Prüfplänen. | JSONV1, DFD, CSV |
+| Path | String | Der vollständige Pfad beim Speichern von Grafiken. | GraphicsPng |
+</table>
+Dieser Parameter steuert die Ausgabe der erzeugten Daten. Wenn der Benutzer "Speichern" aufruft oder #@IC_HTML@# beendet, werden alle hier aufgeführten Formate gespeichert. Bitte beachten Sie die Links zu den weiterführenden Dokumenten.
+<WRAP info 750px>Sollten Sie #@IC_HTML@# neu anbinden, nutzen Sie bitte unbedingt das **JSONV1** Format, da dieses alle Features der Software unterstützt. Andere Exportformate unterliegen Beschränkungen:\\ **CSV:** Kein Export von Zeilenumbrüchen.\\ **DFD**: Beschränkung der Länge von Texten.</WRAP>
+\\
+===== Funktionsaufruf =====
+<code javascript>
+  "Mode": {
+    "Name": "AddCharacteristicTag",
+    "ItemId": "{5D1110CA-6093-4381-B372-CF983D515044}"
+  },
+</code>
+<table>
+<caption>**Funktionsaufruf** unterstützte Optionen (im Aufbau)</caption>
+^ Name ^ Funktion ^ ItemID ^
+| AddCharacteristicTag| Alle Merkmale selektieren, die einem Tag zugeordnet werden sollen| GUID des Tags|
+</table>
+Dieser Parameter legt fest welche Funktion nach dem Start von #@IC_HTML@# aufgerufen werden soll.
+\\
+===== Einstellungen (global) =====
+<code javascript>
+ "Settings": {
+    "Path": "C:/ProgramData/ELIAS GmbH/infra-CONVERT/Settings.json",
+  },
+</code>
+<table>
+<caption>**Globale Einstellungen**</caption>
+^ Parameter ^ Typ ^ Inhalt ^
+| Path | String | Kompletter Pfad und Dateiname für die globale Konfigurationsdatei. |
+</table>
+Mit diesem Parameter wird die globale Konfigurationsdatei festgelegt. Aus dieser Datei bezieht #@IC_HTML@# die Einstellungen für alle Optionen. Sollte die Datei nicht existieren, so wird sie mit den üblichen Voreinstellungen angelegt.
+\\
+===== Einstellungen (Benutzer) =====
+<code javascript>
+ "UserSettings": {
+    "Path": "C:/Users/user1/AppData/Settings.json",
+  },
+</code>
+<table>
+<caption>**Benutzerenstellungen**</caption>
+^ Parameter ^ Typ ^ Inhalt ^
+| Path | String | Kompletter Pfad und Dateiname für die Konfigurationsdatei des Benutzers. |
+</table>
+Mit diesem Parameter wird die Konfigurationsdatei des Benutzers festgelegt. Aus dieser Datei bezieht #@IC_HTML@# die Einstellungen für alle Optionen. Sollte die Datei nicht existieren, so wird sie mit den üblichen Voreinstellungen angelegt.
+<WRAP info 750px>Wenn dieser Parameter nicht gesetzt wird, dann nutzt #@IC_HTML@# das Verzeichnis "%AppData%\ELIAS GmbH\infra-CONVERT" zum Speichern! FIXME</WRAP>
+\\
+===== Definitionsdatei für Merkmals Tags=====
+<code javascript>
+  "CharacteristicTagsDefinition": {
+    "Path": "C:/Users/user1/AppData/CharacteristicTags.json",
+  },
+</code>
+<table>
+<caption>**CharacteristicTagsDefinition**</caption>
+^ Parameter ^ Typ ^ Inhalt ^
+| Path | String | Kompletter Pfad und Dateiname für die Definitionsdatei der Tags für Merkmale. |
+</table>
+Mit diesem Parameter wird die Definitionsdatei für die Tags der Merkmale festgelegt. Aus dieser Datei bezieht #@IC_HTML@# die Einstellungen für alle Tags beim Erstellen eines Projekts. Sollte die Datei nicht existieren, so wird sie mit den üblichen Voreinstellungen angelegt.
+\\
+===== Definitionsdatei für Merkmalsklassen =====
+<code javascript>
+  "CharacteristicClassesDefinition": {
+    "Path": "C:/Users/user1/AppData/CharacteristicClasses.json"
+  },
+</code>
+<table>
+<caption>**CharacteristicClassesDefinition**</caption>
+^ Parameter ^ Typ ^ Inhalt ^
+| Path | String | Kompletter Pfad und Dateiname für die Definitionsdatei der Merkmalsklassen. |
+</table>
+Mit diesem Parameter wird die Definitionsdatei für die Merkmalsklassen festgelegt. Aus dieser Datei bezieht #@IC_HTML@# die Einstellungen für alle Merkmalsklassen beim Erstellen eines Projekts.
+\\
+===== Definitionsdatei für Merkalskategorien =====
+<code javascript>
+  "SpecialCategoriesDefinition": {
+    "Path": "C:/Users/user1/AppData/SpecialCategories.json"
+  },
+</code>
+<table>
+<caption>**SpecialCategoriesDefinition**</caption>
+^ Parameter ^ Typ ^ Inhalt ^
+| Path | String | Kompletter Pfad und Dateiname für die Definitionsdatei der Merkalskategorien . |
+</table>
+Mit diesem Parameter wird die Definitionsdatei für die Merkalskategorien festgelegt. Aus dieser Datei bezieht #@IC_HTML@# die Einstellungen für alle Merkalskategorien beim Erstellen eines Projekts.
+\\
+===== Definitionsdatei für Stempelvorlagen =====
+<code javascript>
+  "StampTemplatesDefinition": {
+    "Path": "C:/Users/user1/AppData/StampTemplates.json"
+  },
+</code>
+<table>
+<caption>**StampTemplatesDefinition**</caption>
+^ Parameter ^ Typ ^ Inhalt ^
+| Path | String | Kompletter Pfad und Dateiname für die Definitionsdatei der Stempelvorlagen . |
+</table>
+Mit diesem Parameter wird die Definitionsdatei für die Stempelvorlagen festgelegt. Aus dieser Datei bezieht #@IC_HTML@# die Einstellungen für alle Stempelvorlagen beim Erstellen eines Projekts.
+\\
+===== Merkmale bearbeiten =====
+FIXME
+<code javascript>
+  "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}"
+      }
+    ]
+</code>
+Dieser Parameter erlaubt es #@IC_HTML@# mitzuteilen welche Merkmale sich seit der letzten Bearbeitung verändert haben. Dies kann dazu benutzt werden Merkmale, welche in der CAQ Software neuen Tags zugewiesen wurden, beim nächsten Aufruf von #@IC_HTML@# ebenfalls im Projektfile neu zuzuweisen.
+\\
+===== Tags bearbeiten =====
+FIXME
+<code javascript>
+  "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": "TagFour",
+        "Color": {
+          "Type": "RGB",
+          "R": 0,
+          "G": 0,
+          "B": 255
+        },
+        "LocalizedProperties": [
+          {
+            "Name": "Tag Four ",
+            "Description":"",
+            "LanguageCode": "en"
+          },
+          {
+            "Name": "Kennzeichnung Vier",
+            "Description": "",
+            "LanguageCode": "de"
+          }
+        ]
+      }
+    }
+  ]
+</code>
+Dieser Parameter erlaubt es #@IC_HTML@# mitzuteilen welche Tags sich seit der letzten Bearbeitung verändert haben. Dies kann dazu benutzt werden Tags, welche in der CAQ Software hinzugefügt wurden, beim nächsten Aufruf von #@IC_HTML@# ebenfalls im Projektfile hinzuzufügen.
+<WRAP noprint>
+----
+<WRAP group>
+<WRAP col2>
+<WRAP rightalign>
+**Zurückblättern**\\
+Einleitung > [[de:infra-convert:dev:intro|Übersicht]]
+</WRAP>
+**Weiterblättern**\\
+Prüfplanexportformate > [[de:infra-convert:dev:export:jsonv1|JSONV1: JavaScript Object Notation]]
+</WRAP>
+</WRAP>
+</WRAP>

ELIAS GmbHProduktdokumentationen

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Unterschiede

Seiten-Werkzeuge

ELIAS GmbH
Produktdokumentationen