Benutzer-Werkzeuge
de:infra-convert:dev:export:jsonv1
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen gezeigt.
| Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
|
de:infra-convert:dev:export:jsonv1 [2019/11/25 14:26] me [Merkmale] |
de:infra-convert:dev:export:jsonv1 [2023/02/10 11:27] (aktuell) me |
||
|---|---|---|---|
| Zeile 11: | Zeile 11: | ||
| ---- | ---- | ||
| - | Das Prüfplan-Exportformat **JSONV1** gewährleistet eine größtmögliche Kompatibilität mit angeschlossenen Softwarepaketen. Es handelt sich um eine JSON-Datei (eine Beschreibung finden Sie [[http://www.json.org/json-de.html|an dieser Stelle]]), welche alle für einen Prüfplan relevanten Informationen enthält. JSON-Dateien können von allen gängigen Programmiersprachen gelesen werden. Der Namenszusatz //V1// kennzeichnet die Dateistruktur mit dem Versionsstand 1. Diese Dateistruktur wird in diesem Kapitel beschrieben. | + | Das Prüfplan-Exportformat **JSONV1** enthält deutlich mehr Informationen als die Formate CSV und DFD. Das Datenformat ist »JSON« (eine Beschreibung finden Sie [[http://www.json.org/json-de.html|an dieser Stelle]]), der Zusatz »V1« kennzeichnet den Versionsstand 1 der enthaltenen Prüfplandatenstruktur. JSON kann mit allen gängigen Programmiersprachen gelesen werden. |
| - | Bei einer entsprechenden Implementierung kann Ihre Software auch Daten einer späteren Version importieren. Eine spätere Version kann z. B. zusätzliche Informationen beinhalten. | + | Der JSONV1-Export kann entweder aus der Benutzeroberfläche heraus (siehe Benutzerhandbuch > Funktionen > Export > [[de:infra-convert:user:functions:cplanexport|Prüfplan exportieren]]) oder per Startparameterdatei angestoßen werden (siehe Konfiguration und Import > Startparameterdatei > [[de:infra-convert:dev:parameter#Prüfpläne und gestempelte Zeichnungen exportieren]]). |
| - | > **Hinweise** Wir empfehlen, das JSONV1-Format gegenüber dem DFD-Format zur Anbindung an Ihr Softwarepaket zu bevorzugen. Es beinhaltet den größeren Umfang an übertragbaren Informationen und unterstützt alle Features von #@IC_HTML@#. Weiterhin haben Sie den Vorteil, dass auch spätere Versionen des JSONV1-Formats (nach Implementierung) mit Ihrer Software kompatibel sein werden.\\ \\ Den Export können Sie in der Startparameterdatei anstoßen, siehe Konfiguration und Import > Startparameterdatei > [[de:infra-convert:dev:parameter#Prüfpläne und gestempelte Zeichnungen exportieren]]. | + | \\ |
| - | + | ||
| - | <WRAP group> | + | |
| - | <WRAP column 61%> | + | |
| - | + | ||
| - | Ein Beispiel für eine JSONV1-Exportdatei finden Sie an dieser Stelle: Anhang > [[de:infra-convert:dev:export:jsonv1_beispiel|Beispiel Prüfplan-Exportdatei JSONV1]]. | + | |
| - | + | ||
| - | </WRAP> | + | |
| - | <WRAP column 33%> | + | |
| - | + | ||
| - | [[de:infra-convert:dev:export:jsonv1_beispiel|{{ :de:infra-convert:dev:json_exportdatei_beispiel.png?nolink&250 |}}]] | + | |
| - | + | ||
| - | </WRAP> | + | |
| - | </WRAP> | + | |
| <WRAP noprint> | <WRAP noprint> | ||
| Zeile 68: | Zeile 55: | ||
| "Classes": [], | "Classes": [], | ||
| "Categories": [], | "Categories": [], | ||
| - | "CharacteristicTags": {} | + | "CharacteristicTags": [] |
| } | } | ||
| </code> | </code> | ||
| Zeile 91: | Zeile 78: | ||
| <WRAP column 40%> | <WRAP column 40%> | ||
| - | Im Feld **Project** werden allgemeine Informationen zur Projektdatei hinterlegt. | + | Im Feld **Project** werden allgemeine Informationen zur Projektdatei ausgegeben. |
| > **Siehe auch** | > **Siehe auch** | ||
| Zeile 111: | Zeile 98: | ||
| "Version": "A", | "Version": "A", | ||
| "Description": "Testbeschreibung", | "Description": "Testbeschreibung", | ||
| + | "Attributes": [ | ||
| + | { | ||
| + | "Key": "Owner", | ||
| + | "Value": "" | ||
| + | } | ||
| + | ], | ||
| "Files": [ | "Files": [ | ||
| { | { | ||
| Zeile 151: | Zeile 144: | ||
| <WRAP column 40%> | <WRAP column 40%> | ||
| - | Im Feld **InspectionPlanVersion** werden grundlegende Informationen zum Prüfplan hinterlegt. | + | Im Feld **InspectionPlanVersion** werden grundlegende Informationen zum Prüfplan ausgegeben. |
| </WRAP> | </WRAP> | ||
| Zeile 182: | Zeile 175: | ||
| ^ Version | String | Versionsnummer der Prüfplanversion | | ^ Version | String | Versionsnummer der Prüfplanversion | | ||
| ^ Description | String | Beschreibung zu der Prüfplanversion | | ^ Description | String | Beschreibung zu der Prüfplanversion | | ||
| + | ^ Attributes | Feld | Zusätzliche Prüfplanattribute\\ \\ (Verfügbar ab Programmversion 2.10.0) | | ||
| + | ^ └ Key | String | Schlüssel des Prüfplanattributs | | ||
| + | ^ └ Value | String | Wert des Prüfplanattributs | | ||
| ^ Files | Feld | Zugeordnete Zeichnungsdateien bzw. -blätter | | ^ Files | Feld | Zugeordnete Zeichnungsdateien bzw. -blätter | | ||
| - | ^ └ Id | String | GUID des Zeichnungsblattes\\ \\ (Verfügbar ab Programmversion 1.3.9.5) | | + | ^ └ Id | String | GUID des Zeichnungsblattes | |
| ^ └ Name | String | Dateiname des Zeichnungsblattes | | ^ └ Name | String | Dateiname des Zeichnungsblattes | | ||
| Zeile 196: | Zeile 192: | ||
| <WRAP column 40%> | <WRAP column 40%> | ||
| - | Im Feld **Characteristics** werden alle Merkmale des Prüfplans mit ihren Eigenschaften hinterlegt. | + | Im Feld **Characteristics** werden alle Merkmale des Prüfplans mit ihren Eigenschaften ausgegeben. |
| Die Reihenfolge der Merkmale entspricht der Listenposition im Prüfplan. Die zeichnungsblattbezogenen Prüfplanabschnitte werden entsprechend der Blattreihenfolge aneinander gehangen. | Die Reihenfolge der Merkmale entspricht der Listenposition im Prüfplan. Die zeichnungsblattbezogenen Prüfplanabschnitte werden entsprechend der Blattreihenfolge aneinander gehangen. | ||
| + | |||
| + | Am Ende dieses Abschnitts finden Sie ein Schaubild, welches die Vergabe der Ids veranschaulicht. | ||
| > **Siehe auch** | > **Siehe auch** | ||
| Zeile 244: | Zeile 242: | ||
| "Name": "A.dwg" | "Name": "A.dwg" | ||
| }, | }, | ||
| + | "StampGraphicFile": "Test plan_A_1.jpg", | ||
| "DrawingQuadrant": "B7", | "DrawingQuadrant": "B7", | ||
| "PositionX": "0333", | "PositionX": "0333", | ||
| Zeile 262: | Zeile 261: | ||
| ^ └ CompareSourceId | String | Ursprüngliche GUID des Merkmals, aus welchem das Merkmal durch Übertragen oder Zusammenfügen beim Zeichnungsvergleich erstellt wurde. Bezieht sich bei mehreren Prüfplanversionen immer auf das allererste Merkmal einer Verknüpfungskette\\ (Verfügbar ab Programmversion 1.3.0.1) | | ^ └ CompareSourceId | String | Ursprüngliche GUID des Merkmals, aus welchem das Merkmal durch Übertragen oder Zusammenfügen beim Zeichnungsvergleich erstellt wurde. Bezieht sich bei mehreren Prüfplanversionen immer auf das allererste Merkmal einer Verknüpfungskette\\ (Verfügbar ab Programmversion 1.3.0.1) | | ||
| ^ └ DirectCompareSourceId | String | GUID des Merkmals, aus welchem das Merkmal durch Übertragen oder Zusammenfügen beim Zeichnungsvergleich erstellt wurde. Bezieht sich immer auf das direkte Vorgängermerkmal\\ (Verfügbar ab Programmversion 1.3.0.3) | | ^ └ DirectCompareSourceId | String | GUID des Merkmals, aus welchem das Merkmal durch Übertragen oder Zusammenfügen beim Zeichnungsvergleich erstellt wurde. Bezieht sich immer auf das direkte Vorgängermerkmal\\ (Verfügbar ab Programmversion 1.3.0.3) | | ||
| - | ^ IcpId | Integer | ID des Merkmals, wenn es aus einer ICP-Projektdatei importiert wurde ("*.icp" ist das Dateiformat der Vorgängersoftware #@IC_OLD_HTML@#). | | + | ^ IcpId | Integer | ID des Merkmals, wenn es aus einer ICP-Projektdatei importiert wurde (»*.icp« ist das Dateiformat der Vorgängersoftware #@IC_OLD_HTML@#). | |
| ^ CharacteristicType | String | **Variable** →[[de:infra-convert:user:terms#Merkmal (Prüf-, Qualitäts-)|Variables Merkmal]]\\ **Attributive** →[[de:infra-convert:user:terms#Merkmal (Prüf-, Qualitäts-)|Attributives Merkmal]] | | ^ CharacteristicType | String | **Variable** →[[de:infra-convert:user:terms#Merkmal (Prüf-, Qualitäts-)|Variables Merkmal]]\\ **Attributive** →[[de:infra-convert:user:terms#Merkmal (Prüf-, Qualitäts-)|Attributives Merkmal]] | | ||
| ^ ClassId | String | GUID der →[[de:infra-convert:user:terms#Klasse (Merkmals-)|Merkmalsklasse]] | | ^ ClassId | String | GUID der →[[de:infra-convert:user:terms#Klasse (Merkmals-)|Merkmalsklasse]] | | ||
| ^ SpecialCategoryId | String | GUID der →[[de:infra-convert:user:terms#Kategorie (Merkmal-)|Merkmalkategorie]] | | ^ SpecialCategoryId | String | GUID der →[[de:infra-convert:user:terms#Kategorie (Merkmal-)|Merkmalkategorie]] | | ||
| ^ CharacteristicTagIds | String | GUIDs der Kennzeichnungen, welche dem Merkmal zugewiesen sind | | ^ CharacteristicTagIds | String | GUIDs der Kennzeichnungen, welche dem Merkmal zugewiesen sind | | ||
| + | ^ Value | String | Wert (Text, wie er aus einer Zeichnungseintragung gelesen wird.) | | ||
| ^ Label | String | Titel des Merkmals (Langtext) | | ^ Label | String | Titel des Merkmals (Langtext) | | ||
| ^ NominalValue | String | Nennmaß (Zahlengenauigkeit wird eingehalten)\\ **null** Kein Wert zugewiesen, weil Parameter nicht zutreffend | | ^ NominalValue | String | Nennmaß (Zahlengenauigkeit wird eingehalten)\\ **null** Kein Wert zugewiesen, weil Parameter nicht zutreffend | | ||
| Zeile 281: | Zeile 281: | ||
| ^ ReferenceSystem | String | Bezüge aus anderen Bezugssystemen als nach DIN EN ISO 1101.\\ **null** Kein Wert zugewiesen | | ^ ReferenceSystem | String | Bezüge aus anderen Bezugssystemen als nach DIN EN ISO 1101.\\ **null** Kein Wert zugewiesen | | ||
| ^ Comment | String | Bemerkung\\ **null** Kein Wert zugewiesen | | ^ Comment | String | Bemerkung\\ **null** Kein Wert zugewiesen | | ||
| + | ^ Count | Integer | Anzahl der Wiederholungen des Merkmals | | ||
| ^ Stamps | Feld | Enthält die Eigenschaften des Stempels\\ \\ **Anmerkung** Jedem Merkmal wird genau ein Stempel zugeordnet, auch wenn sich dieser in einem Feld befindet. | | ^ Stamps | Feld | Enthält die Eigenschaften des Stempels\\ \\ **Anmerkung** Jedem Merkmal wird genau ein Stempel zugeordnet, auch wenn sich dieser in einem Feld befindet. | | ||
| ^ └ Id | String | GUID des Stempels | | ^ └ Id | String | GUID des Stempels | | ||
| - | ^ └ CompareSourceId | String | Ursprüngliche GUID des Stempels, aus welchem der Stempel durch Übertragen oder Zusammenfügen beim Zeichnungsvergleich erstellt wurde. Bezieht sich bei mehreren Prüfplanversionen immer auf den allerersten Stempel einer Verknüpfungskette\\ (Verfügbar ab Programmversion 1.2.0.21) | | + | ^ └ CompareSourceId | String | Ursprüngliche GUID des Stempels, aus welchem der Stempel durch Übertragen oder Zusammenfügen beim Zeichnungsvergleich erstellt wurde. Bezieht sich bei mehreren Prüfplanversionen immer auf den allerersten Stempel einer Verknüpfungskette\\ \\ (Verfügbar ab Programmversion 1.2.0.21) | |
| ^ └ Text | String | Merkmalnummer (inklusive Präfix und Suffix) | | ^ └ Text | String | Merkmalnummer (inklusive Präfix und Suffix) | | ||
| ^ └ File | String | Zeichnungsblatt, auf welchem sich der Stempel befindet | | ^ └ File | String | Zeichnungsblatt, auf welchem sich der Stempel befindet | | ||
| Zeile 289: | Zeile 290: | ||
| ^ └ Name | String | Dateiname des Zeichnungsblattes | | ^ └ Name | String | Dateiname des Zeichnungsblattes | | ||
| ^ └ DrawingQuadrant | String | Schlüssel des Feldes, in welchem sich das Merkmal auf dem Zeichnungsblatt befindet | | ^ └ DrawingQuadrant | String | Schlüssel des Feldes, in welchem sich das Merkmal auf dem Zeichnungsblatt befindet | | ||
| - | ^ └ PositionX | String | X-Koordinate des Stempels in Pixeln auf der Zeichnungsgrafik\\ (Verfügbar ab Programmversion 1.2.0.21) | | + | ^ └ StampGraphicFile | String | Dateiname der Stempelgrafik\\ \\ (Verfügbar ab Programmversion 2.5.1) | |
| - | ^ └ PositionY | String | Y-Koordinate des Stempels in Pixeln auf der Zeichnungsgrafik\\ (Verfügbar ab Programmversion 1.2.0.21) | | + | ^ └ PositionX | String | X-Koordinate des Stempels in Pixeln auf der Zeichnungsgrafik\\ \\ (Verfügbar ab Programmversion 1.2.0.21) | |
| - | ^ └ TargetX | String | X-Koordinate des Bezugspunkts (Zielpunkt, Ursprungspunkt) des Stempels in Pixeln auf der Zeichnungsgrafik\\ (Verfügbar ab Programmversion 1.2.0.21) | | + | ^ └ PositionY | String | Y-Koordinate des Stempels in Pixeln auf der Zeichnungsgrafik\\ \\ (Verfügbar ab Programmversion 1.2.0.21) | |
| - | ^ └ TargetY | String | Y-Koordinate des Bezugspunkts des Stempels in Pixeln auf der Zeichnungsgrafik\\ (Verfügbar ab Programmversion 1.2.0.21) | | + | ^ └ TargetX | String | X-Koordinate des Bezugspunkts (Zielpunkt, Ursprungspunkt) des Stempels in Pixeln auf der Zeichnungsgrafik\\ \\ (Verfügbar ab Programmversion 1.2.0.21) | |
| - | ^ └ Radius | String | Größe des Stempels, angegeben als Radius in Pixeln auf der Zeichnungsgrafik\\ (Verfügbar ab Programmversion 1.2.0.21) | | + | ^ └ TargetY | String | Y-Koordinate des Bezugspunkts des Stempels in Pixeln auf der Zeichnungsgrafik\\ \\ (Verfügbar ab Programmversion 1.2.0.21) | |
| + | ^ └ Radius | String | Größe des Stempels, angegeben als Radius in Pixeln auf der Zeichnungsgrafik\\ \\ (Verfügbar ab Programmversion 1.2.0.21) | | ||
| </WRAP> | </WRAP> | ||
| </WRAP> | </WRAP> | ||
| + | |||
| + | \\ | ||
| + | |||
| + | > **Vergabe der Merkmal- und Stempel-IDs** | ||
| + | > Das folgende Schaubild soll die Vergabe der Ids (Guids) über die Prüfplanversionen hinweg verdeutlichen. In Fall 1 wird ein Merkmal von Prüfplanversion A nach B und von B nach C im Zeichnungsvergleich übertragen. Zum Beispiel findet sich »Guid C1« in Version B als CompareSourceId und als DirectCompareSourceId wieder, in C folglich nur noch als CompareSourceId. In Fall 2 wird Prüfplanversion B ausgelassen. | ||
| + | > | ||
| + | > {{ :de:infra-convert:user:terms:id-zuweisung_beim_zeichnungsvergleich.png?nolink&850 |}} | ||
| \\ | \\ | ||
| Zeile 305: | Zeile 314: | ||
| <WRAP column 40%> | <WRAP column 40%> | ||
| - | Im Feld **Classes** werden alle im Prüfplan verwendeten Merkmalsklassen hinterlegt. Alle verfügbaren Klassen sind in der Parameterdatei CharacteristicClasses.json gespeichert. | + | Im Feld **Classes** werden alle im Prüfplan verwendeten Merkmalsklassen ausgegeben. Alle verfügbaren Klassen sind in der Parameterdatei CharacteristicClasses.json gespeichert. |
| > **Siehe auch** | > **Siehe auch** | ||
| - | > Konfiguration und Import > [[de:infra-convert:dev:characteristicclasses|Parameterdatei "CharacteristicClasses"]] | + | > Konfiguration und Import > [[de:infra-convert:dev:characteristicclasses|Parameterdatei »CharacteristicClasses«]] |
| > | > | ||
| > Benutzerhandbuch #@IC_HTML@# > Weiteres > Begriffe > [[de:infra-convert:user:terms#Klasse (Merkmals-)|Klasse (Merkmals-)]] | > Benutzerhandbuch #@IC_HTML@# > Weiteres > Begriffe > [[de:infra-convert:user:terms#Klasse (Merkmals-)|Klasse (Merkmals-)]] | ||
| Zeile 343: | Zeile 352: | ||
| <WRAP column 40%> | <WRAP column 40%> | ||
| - | Im Feld **Categories** werden alle im Prüfplan verwendeten Merkmalskategorien hinterlegt. Alle verfügbaren Kategorien sind in der Parameterdatei SpecialCategories.json gespeichert. | + | Im Feld **Categories** werden alle im Prüfplan verwendeten Merkmalskategorien ausgegeben. Alle verfügbaren Kategorien sind in der Parameterdatei SpecialCategories.json gespeichert. |
| > **Siehe auch** | > **Siehe auch** | ||
| - | > Konfiguration und Import > [[de:infra-convert:dev:specialcategories|Parameterdatei "StampTemplates"]] | + | > Konfiguration und Import > [[de:infra-convert:dev:specialcategories|Parameterdatei »StampTemplates«]] |
| > | > | ||
| > Benutzerhandbuch #@IC_HTML@# > Weiteres > Begriffe > [[de:infra-convert:user:terms#Kategorie (Merkmal-)|Kategorie (Merkmal-)]] | > Benutzerhandbuch #@IC_HTML@# > Weiteres > Begriffe > [[de:infra-convert:user:terms#Kategorie (Merkmal-)|Kategorie (Merkmal-)]] | ||
| Zeile 356: | Zeile 365: | ||
| "Categories": [ | "Categories": [ | ||
| { | { | ||
| - | | ||
| "Id": "2bfa891e-ab74-4097-863d-ab5e5019abd7", | "Id": "2bfa891e-ab74-4097-863d-ab5e5019abd7", | ||
| "UserId": 1, | "UserId": 1, | ||
| Zeile 384: | Zeile 392: | ||
| <WRAP column 40%> | <WRAP column 40%> | ||
| - | Im Feld **CharacteristicTags** werden alle im Prüfplan verwendeten Kategorien für Merkmale hinterlegt. Alle verfügbaren Kategorien sind in der Parameterdatei CharacteristicTags.json gespeichert. | + | Im Feld **CharacteristicTags** werden alle im Prüfplan verwendeten Kennzeichnungen für Merkmale ausgegeben. Alle verfügbaren Kennzeichnungen sind in der Parameterdatei CharacteristicTags.json gespeichert. |
| > **Siehe auch** | > **Siehe auch** | ||
| - | > Konfiguration und Import > [[de:infra-convert:dev:characteristictags|Parameterdatei "CharacteristicTags"]] | + | > Konfiguration und Import > [[de:infra-convert:dev:characteristictags|Parameterdatei »CharacteristicTags«]] |
| </WRAP> | </WRAP> | ||
| Zeile 426: | Zeile 434: | ||
| **Weiterblättern**\\ | **Weiterblättern**\\ | ||
| - | Export > [[de:infra-convert:dev:export:dfd|Prüfplanformat DFD (ASCII Transferformat)]] | + | Export > [[de:infra-convert:dev:export:jsonv2|Prüfplanformat JSONV2]] |
| </WRAP> | </WRAP> | ||
de/infra-convert/dev/export/jsonv1.1574688406.txt.gz · Zuletzt geändert: 2019/11/25 14:26 von me
Seiten-Werkzeuge
