Administratorhandbuch infra CONVERT > Export

Prüfplanformat JSONV1

Das Prüfplan-Exportformat JSONV1 enthält deutlich mehr Informationen als die Formate CSV und DFD. Das Datenformat ist »JSON« (eine Beschreibung finden Sie an dieser Stelle), der Zusatz »V1« kennzeichnet den Versionsstand 1 der enthaltenen Prüfplandatenstruktur. JSON kann mit allen gängigen Programmiersprachen gelesen werden.

Der JSONV1-Export kann entweder aus der Benutzeroberfläche heraus (siehe Benutzerhandbuch > Funktionen > Export > Prüfplan exportieren) oder per Startparameterdatei angestoßen werden (siehe Konfiguration und Import > Startparameterdatei > Prüfpläne und gestempelte Zeichnungen exportieren).

Inhalt

• Grundstruktur
• Projekt
• Prüfplanversion
• Merkmale
• Klassen
• Kategorien
• Kennzeichnungen

Grundstruktur

Bei einer JSONV1-Datei handelt es sich immer um einen geschlossenen Export, d. h. es werden keine externen Ressourcen oder Tabellen benötigt. Die in der Merkmalsliste Characteristics verwendeten eindeutigen Referenz-IDs (GUID) für Klassen, Kategorien und Kennzeichnungen werden innerhalb der Exportdatei referenziert. Sie werden am Ende der Datei unter der entsprechenden GUID aufgelöst.

Die Grundstruktur des JSONV1-Formats setzt sich aus den nebenstehenden Feldern zusammen. Die Struktur innerhalb der Felder wird in den folgenden Abschnitten ausführlich erklärt.

{
  "Project": {},
  "InspectionPlanVersion": {},
  "Characteristics": [],
  "Classes": [],
  "Categories": [],
  "CharacteristicTags": []
}

Parameter	Typ	Wert/Inhalt
Projekt	Feld	Grundlegende Informationen zum exportierten Projekt
InspectionPlanVersion	Feld	Grundlegende Informationen zum exportierten Prüfplan
Characteristics	Feld	Alle Merkmale und Stempel
Classes	Feld	Alle verwendeten Merkmalsklassen
Categories	Feld	Alle verwendeten Merkmalskategorien
CharacteristicTags	Feld	Alle verwendeten Kennzeichnungen für Merkmale

Projekt

Im Feld Project werden allgemeine Informationen zur Projektdatei ausgegeben.

Siehe auch
Benutzerhandbuch infra CONVERT > Benutzeroberfläche > Funktionsfenster > Projektübersicht

"Project": {
  "Id": "be6d7da6-8e3c-4752-8029-534e3cf4ca3a",
  "Path": null,
  "Name": "Testprojekt",
  "Description": "Testbeschreibung",
  "InspectionPlanVersions": [
    {
      "Id": "743b56e7-e352-4c01-9dc5-69bdcc68d986",
      "Name": "Testprüfplan",
      "Version": "A",
      "Description": "Testbeschreibung",
      "Attributes": [
        {
          "Key": "Owner",
          "Value": ""
        }
      ],
      "Files": [
        {
          "Id": "d5a413e5-a329-4021-8cbb-7e174990d5ad",
          "Name": "A.dwg"
        },
        {
          "Id": "803960e2-415f-4a56-b558-87036988c6fb",
          "Name": "B.dxf"
        }
      ]
    }
  ]
},

Parameter	Typ	Wert/Inhalt
ID	String	Eindeutige Identifikationsnummer (GUID) des Projekts
Path	String	Pfad zur Projektdatei, aus welcher der Prüfpan exportiert wurde
Name	String	Titel des Projekts
Description	String	Beschreibung
InspectionPlanVersions	Feld	Listet alle Prüfplanversionen mit enthaltenen Zeichnungsdateien
└ Id	String	GUID der Prüfplanversion
└ Name	String	Name der Prüfplanversion
└ Version	String	Versionsnummer der Prüfplanversion
└ Description	String	Beschreibung zu der Prüfplanversion
└ Files	Feld	Zugeordnete Zeichnungsdateien bzw. -blätter
└ Id	String	GUID des Zeichnungsblattes (Verfügbar ab Programmversion 1.3.9.5)
└ Name	String	Dateiname des Zeichnungsblattes

Prüfplanversion

Im Feld InspectionPlanVersion werden grundlegende Informationen zum Prüfplan ausgegeben.

"InspectionPlanVersion": {
  "Id": "743b56e7-e352-4c01-9dc5-69bdcc68d986",
  "Name": "Testprüfplan",
  "Version": "A",
  "Description": "Testbeschreibung",
  "Files": [
    {
      "Id": "d5a413e5-a329-4021-8cbb-7e174990d5ad",
      "Name": "A.dwg"
    },
    {
      "Id": "803960e2-415f-4a56-b558-87036988c6fb",
      "Name": "B.dxf"
    }
  ]
},
},

Parameter	Typ	Wert/Inhalt
Id	String	GUID der Prüfplanversion
Name	String	Name der Prüfplanversion
Version	String	Versionsnummer 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
└ Id	String	GUID des Zeichnungsblattes
└ Name	String	Dateiname des Zeichnungsblattes

Merkmale

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.

Am Ende dieses Abschnitts finden Sie ein Schaubild, welches die Vergabe der Ids veranschaulicht.

Siehe auch
Benutzerhandbuch infra CONVERT > Benutzeroberfläche > Funktionsfenster > Merkmalseigenschaften

Benutzerhandbuch infra CONVERT > Weiteres > Begriffe > Stempel/Stempeln

"Characteristics": [
  {
    "Id": "77170b5d-ec65-4748-97f2-72e0b9db4275",
    "SourceId": null,
    "CompareSourceId": "00000000-0000-0000-0000-000000000000",
    "DirectCompareSourceId": "00000000-0000-0000-0000-000000000000"
    "CharacteristicType": "Variable",
    "ClassId": "5ebc991e-8b53-4d15-8c2b-358b793228d8",
    "SpecialCategoryId": "3e298f8f-02f1-49cd-82bf-bcdf26da11fe",
    "CharacteristicTagIds": [],
    "Label": "Gemittelte Rautiefe Rz 63",
    "Value": "Rz  63",
    "NominalValue": "",
    "NominalUnit": "Micrometer",
    "UpperTolerance": "63",
    "LowerTolerance": "",
    "ToleranceUnit": "Micrometer",
    "ToleranceTable": null,
    "ToleranceTableColumn": null,
    "MinMax": "None",
    "Fit": null,
    "Conditions": "None",
    "Reference": null,
    "ReferenceSystem": null,
    "Comment": "",
    "Count": "1",
    "Stamps": [
      {
        "Id": "f2b0386f-fb4a-47ca-a6d3-e4afacb576b4",
        "CompareSourceId": "00000000-0000-0000-0000-000000000000",
        "Text": "2B",
        "File": {
          "Id": "d5a413e5-a329-4021-8cbb-7e174990d5ad",
          "Name": "A.dwg"
        },
        "StampGraphicFile": "Test plan_A_1.jpg",
        "DrawingQuadrant": "B7",
        "PositionX": "0333",
        "PositionY": "0244",
        "TargetX": "0320",
        "TargetY": "0241",
        "Radius": "0019"
      }
    ]
  }
],

Parameter	Typ	Wert/Inhalt
Id	String	GUID des Merkmals
SourceId	String	GUID des Merkmals, aus dem das Merkmal durch Duplizieren erstellt wurde null Kein Wert zugewiesen, weil Parameter nicht zutreffend
└ 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)
IcpId	Integer	ID des Merkmals, wenn es aus einer ICP-Projektdatei importiert wurde (».icp« ist das Dateiformat der Vorgängersoftware infra -* CONVERT).
CharacteristicType	String	Variable →Variables Merkmal Attributive →Attributives Merkmal
ClassId	String	GUID der →Merkmalsklasse
SpecialCategoryId	String	GUID der →Merkmalkategorie
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)
NominalValue	String	Nennmaß (Zahlengenauigkeit wird eingehalten) null Kein Wert zugewiesen, weil Parameter nicht zutreffend
NominalUnit	String	Millimeter Einheit des Nennmaßes: Millimeter Micrometer Einheit des Nennmaßes: Mikrometer Inch Einheit des Nennmaßes: Inch/Zoll Degree Einheit des Nennmaßes: Grad None Kein Wert ausgewählt null Kein Wert zugewiesen, weil Parameter nicht zutreffend
UpperTolerance	String	Oberes Abmaß oder Grenzmaß (Zahlengenauigkeit wird eingehalten) null Kein Wert zugewiesen, weil Parameter nicht zutreffend
LowerTolerance	String	Unteres Abmaß oder Grenzmaß (Zahlengenauigkeit wird eingehalten) null Kein Wert zugewiesen, weil Parameter nicht zutreffend
ToleranceUnit	String	Millimeter Einheit des Toleranzmaßes: Millimeter Micrometer Einheit des Toleranzmaßes: Mikrometer Inch Einheit des Toleranzmaßes: Inch/Zoll Degree Einheit des Toleranzmaßes: Grad None Kein Wert ausgewählt null Kein Wert zugewiesen, weil Parameter nicht zutreffend
ToleranceTable	String	Name der Toleranztabelle null Kein Wert zugewiesen, weil Parameter nicht zutreffend
ToleranceTableColumn	String	Spalte in der Toleranztabelle null Kein Wert zugewiesen, weil Parameter nicht zutreffend
MinMax	String	min Art der Grenze: Mindestmaß (Das untere Grenzmaß ist angegeben, die obere Grenze ist natürlich bestimmt) max Art der Grenze: Höchstmaß (Das obere Grenzmaß ist angegeben, die untere Grenze ist natürlich bestimmt) None Beide Grenzmaße sind angegeben oder eine Grenzmaßangabe ist nicht zutreffend.
Fit	String	Toleranzklasse null Kein Wert zugewiesen
Conditions	String	Modifikatoren null Kein Wert zugewiesen
Reference	String	Bezüge aus einem Bezugssystem 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
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.
└ 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)
└ Text	String	Merkmalnummer (inklusive Präfix und Suffix)
└ File	String	Zeichnungsblatt, auf welchem sich der Stempel befindet
└ Id	String	GUID des Zeichnungsblattes (Verfügbar ab Programmversion 1.3.9.5)
└ Name	String	Dateiname des Zeichnungsblattes
└ DrawingQuadrant	String	Schlüssel des Feldes, in welchem sich das Merkmal auf dem Zeichnungsblatt befindet
└ StampGraphicFile	String	Dateiname der Stempelgrafik (Verfügbar ab Programmversion 2.5.1)
└ PositionX	String	X-Koordinate 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)
└ TargetX	String	X-Koordinate des Bezugspunkts (Zielpunkt, Ursprungspunkt) 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)
└ Radius	String	Größe des Stempels, angegeben als Radius in Pixeln auf der Zeichnungsgrafik (Verfügbar ab Programmversion 1.2.0.21)

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.

Klassen

Im Feld Classes werden alle im Prüfplan verwendeten Merkmalsklassen ausgegeben. Alle verfügbaren Klassen sind in der Parameterdatei CharacteristicClasses.json gespeichert.

Siehe auch
Konfiguration und Import > Parameterdatei »CharacteristicClasses«

Benutzerhandbuch infra CONVERT > Weiteres > Begriffe > Klasse (Merkmals-)

"Classes": [
  {
    "Id": "e5391b02-6657-4b4e-adc4-200547aed6e9",
    "FriendlyName": "Chamfer",
    "Name": "Chamfer",
    "Description": ""
  }
]

Parameter	Typ	Wert/Inhalt
Id	String	GUID der Merkmalsklasse
FriendlyName	String	Bezeichnung der Merkmalsklasse in Kurzform ohne Leerzeichen
Name	String	Bezeichnung der Merkmalsklasse in Langform
Description	String	Ausführliche Beschreibung der Merkmalsklasse

Kategorien

Im Feld Categories werden alle im Prüfplan verwendeten Merkmalskategorien ausgegeben. Alle verfügbaren Kategorien sind in der Parameterdatei SpecialCategories.json gespeichert.

Siehe auch
Konfiguration und Import > Parameterdatei »StampTemplates«

Benutzerhandbuch infra CONVERT > Weiteres > Begriffe > Kategorie (Merkmal-)

"Categories": [
  {
    "Id": "2bfa891e-ab74-4097-863d-ab5e5019abd7",
    "UserId": 1,
    "Id": "6e626731-625f-4f71-a471-2a267d511e18",
    "FriendlyName": "CommonCharacteristic",
    "Name": "Standard-Merkmal",
    "Description": ""  }
]

Parameter	Typ	Wert/Inhalt
UserId	String	Benutzerfreundliche ID der Merkmalskategorie
Id	String	GUID der Merkmalskategorie
FriendlyName	String	Bezeichnung der Merkmalskategorie in Kurzform ohne Leerzeichen
Name	String	Bezeichnung der Merkmalskategorie in Langform
Description	String	ausführliche Beschreibung der Merkmalskategorie

Kennzeichnungen

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
Konfiguration und Import > Parameterdatei »CharacteristicTags«

"CharacteristicTags": [
  {
    "Id": "24c41ca8-871c-456e-b082-22ec2a20216d",
    "FriendlyName": "TagOne",
    "Name": "Tag One",
    "Description": ""
  },
]

Parameter	Typ	Wert/Inhalt
Id	String	GUID der Kennzeichnung
FriendlyName	String	Bezeichnung der Kennzeichnung in Kurzform, ohne Leerzeichen
Name	String	Bezeichnung der Kennzeichnung in Langform
Description	String	Ausführliche Beschreibung der Kennzeichnung

Zurückblättern
Konfiguration und Import > Toleranztabellen

Weiterblättern
Export > Prüfplanformat JSONV2