User Tools

Site Tools


en:infra-convert:dev:export:jsonv2_neu

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
en:infra-convert:dev:export:jsonv2_neu [2020/07/23 15:24]
me removed
— (current)
Line 1: Line 1:
-~~NOTOC~~ 
  
-<WRAP noprint> 
- 
-> Administrator'​s Manual #@IC_HTML@# > Export 
- 
-</​WRAP>​ 
- 
-<WRAP group> 
-<WRAP column 75%> 
-====== Quality test plan format JSONV2 ====== 
- 
----- 
-</​WRAP>​ 
-<WRAP column 20%> 
-> **Available from**\\ Program version 1.4.2.1 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-The test plan export format **JSONV2** is the further development of the JSONV1 format, see Export > [[en:​infra-convert:​dev:​export:​jsonv1|Test plan format JSONV1]]. The data format is "​JSON"​ (for a description see [[http://​www.json.org/​json-en.html|at this place]]), the addition "​V2"​ indicates the version 2 of the contained test plan data structure. JSON can be read with all common programming languages. 
- 
-Compared to JSONV1, JSONV2 maps all test plan versions in an overall structure. JSONV1 is still maintained, but we recommend that you prefer JSONV2. The CSV and DFD test plan formats contain only a small part of the data generated in a project. 
- 
-The JSONV2 export can be initiated either from the user interface (see User Manual > Functions > Export > [[en:​infra-convert:​user:​functions:​cplanexport|Export test plan]]) or via a start parameter file (see Configuration and Import > Start Parameter File > [[en:​infra-convert:​dev:​parameter#​Export test plans and stamped drawings]]). 
- 
-<WRAP group> 
-<WRAP column 61%> 
- 
-An example of a JSONV2 export file can be found here: Attachment>​ [[en:​infra-convert:​dev:​export:​jsonv2_beispiel|Example Test plan export file JSONV2]]. 
- 
-</​WRAP>​ 
-<WRAP column 33%> 
- 
-[[en:​infra-convert:​dev:​export:​jsonv2_beispiel|{{ :​en:​infra-convert:​dev:​json_exportdatei_beispiel.png?​nolink&​250 |}}]] 
- 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-<WRAP noprint> 
-<WRAP group> 
-<WRAP column 20%> 
-//​**__Inhalt__**//​ 
- 
- • [[en:​infra-convert:​dev:​export:​jsonv2#​Basic Structure]]\\ ​ 
- • [[en:​infra-convert:​dev:​export:​jsonv2#​Quality test plan version]]\\ ​ 
- • [[en:​infra-convert:​dev:​export:​jsonv2#​Characteristics]]\\ ​ 
- • [[en:​infra-convert:​dev:​export:​jsonv2#​Classes]]\\ ​ 
- • [[en:​infra-convert:​dev:​export:​jsonv2#​Categories]]\\ 
- • [[en:​infra-convert:​dev:​export:​jsonv2#​Stamp templates]]\\ 
- • [[en:​infra-convert:​dev:​export:​jsonv2#​Labels]] 
- 
-</​WRAP>​ 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-\\  
- 
-====== Basic Structure====== 
- 
-<WRAP group> 
-<WRAP column 40%> 
- 
-A JSONV2 file is a closed export, meaning that no external resources or tables are required. "​ExportFormatVersion and InfraConvertVersion identify the export format and the exporting system. The directory tree with the root "​Project"​ contains the project data. The field "​InspectionPlanVersions"​ lists the inspection plan versions with the respective drawing sheets and characteristics. The cross-project definitions for classes, categories, stamp templates and labels are expanded in the fields "​Classes",​ "​Categories",​ "​StampTemplates"​ and "​CharacteristicTags"​. They are assigned to the characteristics using reference IDs (GUIDs). The structure within the fields is explained in detail in the following sections. 
- 
-</​WRAP>​ 
-<WRAP column 55%> 
- 
-<code javascript>​ 
-{ 
-  "​ExportFormatVersion":​ { 
-    "​Major":​ 2, 
-    "​Minor":​ 0 
-  }, 
-  "​InfraConvertVersion":​ "​1.4.2.0",​ 
-  "​Project":​ { 
-    "​Name":​ "​Beispielprojekt",​ 
-    "​Description":​ "",​ 
-    "​InspectionPlanVersions":​ [], 
-    "​Classes":​ [], 
-    "​Categories":​ [], 
-    "​StampTemplates":​ [], 
-    "​CharacteristicTags":​ [] 
-  } 
-} 
-</​code>​ 
- 
-|< 100% 40% 12% 47% >| 
-^  Parameter ​ ^  Typ  ^  Wert/​Inhalt ​ ^ 
-^ Export​Format​Version | Field | Contains the version number of the JSON test plan format | 
-^ └ Major | Integer | Main version number| 
-^ └ Minor | Integer | Minor version number| 
-^ Infra​Convert​Version | String | Program version of #@IC_HTML@# | 
-^ Project | String | Contains the project data | 
-^ └ Name | String | Name bzw. Titel des Projekts | 
-^ └ Description | String | Description of the project | 
-^ └ Inspection​Plan​Versions | Field | Contains the test plan versions with the characteristics | 
-^ └ Classes | Field | Contains the class definitions | 
-^ └ Categories | Field | Contains the categroy deifinitions | 
-^ └ Stamp​Templates | Field | Contains the definitions for the stamp templates | 
-^ └ Characteristic​Tags| Field | Contains the label definitions| 
- 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-\\  
- 
-====== Quality test plan version====== 
- 
-<WRAP group> 
-<WRAP column 40%> 
- 
-The field **test plan versions** lists all the test plan versions contained in a project with the respective assigned drawing sheets and characteristics. 
- 
-> **See also** 
-> User manual #@IC_HTML@# > User interface > Function window > [[en:​infra-convert:​user:​interface:​pexplorer|Project overview]] 
- 
-</​WRAP>​ 
-<WRAP column 55%> 
- 
-<code javascript>​ 
-"​InspectionPlanVersions":​ [ 
-  { 
-    "​Id":​ "​7b80d8ef-6eef-4be1-af57-cca058828124",​ 
-    "​Name":​ "​Beispielprüfplan",​ 
-    "​Version":​ "​A",​ 
-    "​Description":​ "",​ 
-    "​Documents":​ [ 
-      { 
-        "​Id":​ "​2755a199-752c-427e-aa7a-d0d19ee86007",​ 
-        "​Name":​ "​ez-29002675001-84-0_1.dwg",​ 
-        "​Extents":​ { 
-          "​MinX":​ 0.0, 
-          "​MinY":​ 0.0, 
-          "​MinZ":​ 0.0, 
-          "​MaxX":​ 420.0, 
-          "​MaxY":​ 297.0, 
-          "​MaxZ":​ 0.0, 
-          "​RotationAngle":​ 0.0 
-        }, 
-        "​Characteristics":​ [] 
-      } 
-    } 
-  } 
-], 
-        ​ 
-</​code>​ 
- 
-|< 100% 33% 12% 54% >| 
-^  Parameter ​ ^  Type  ^  Value/​Content^ 
-^ Id | String | Globally unique identifier (GUID) of the project | 
-^ Name | String | Name or itle of the test plan version | 
-^ Version | String | Version number of the test plan version | 
-^ Description | String | Description of the test plan version | 
-^ Documents | Field | Enthält alle Zeichnungsblätter der Prüfplanversion | 
-^ └ Id | String | GUID of the Drawing sheet | 
-^ └ Name | String | Name of the drawing sheet | 
-^ └ Extents | Field | Contains the outer dimensions of the drawing sheet | 
-^  └ MinX | Double | X-coordinate of the lower left corner in drawing units | 
-^  └ MinY | Double | Y-coordinate of the lower left corner in drawing units | 
-^  └ MinZ | Double | Z-coordinate of the lower left corner in drawing units | 
-^  └ MaxX | Double | X-Coordinate of the upper right corner in drawing units | 
-^  └ MaxY | Double | Y-Coordinate of the upper right corner in drawing units | 
-^  └ MaxZ | Double | Z-Coordinate of the upper right corner in drawing units | 
-^  └ Rotation​Angle | Double ​ | Rotation angle of the drawing sheet in degrees | 
-^ └ Characteristics | Field | Contains the characteristics assigned to a drawing sheet | 
- 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-\\  
- 
-====== Characteristics====== 
- 
-<WRAP group> 
-<WRAP column 40%> 
- 
-The field **Characteristics** contains all characteristics assigned to a drawing sheet with their properties. The sequence of the characteristics corresponds to the list position in the inspection plan. 
- 
-> **See also** 
-> User manual #@IC_HTML@# > User interface > Function window > [[en:​infra-convert:​user:​interface:​feature|Characteristics]] 
-> 
-> User Manual #@IC_HTML@# > Further > Terms > [[en:​infra-convert:​user:​terms#​Stempel/​Stempeln|Stamp/​Stamps]] 
- 
-</​WRAP>​ 
-<WRAP column 55%> 
- 
-<code javascript>​ 
-"​Characteristics":​ [ 
-   { 
-  "​Id":​ "​23553146-b049-4875-80e4-33a40a0d5d1f",​ 
-  "​SourceId":​ "​00000000-0000-0000-0000-000000000000",​ 
-  "​CompareSourceId":​ "​00000000-0000-0000-0000-000000000000",​ 
-  "​DirectCompareSourceId":​ "​00000000-0000-0000-0000-000000000000",​ 
-  "​IcpId":​ "​1",​ 
-  "​CharacteristicType":​ "​Variable",​ 
-  "​ClassId":​ "​bea94ebe-84de-4653-86a5-dd600a45070e",​ 
-  "​SpecialCategoryId":​ "​6e626731-625f-4f71-a471-2a267d511e18",​ 
-  "​CharacteristicTagIds":​ [ 
-    "​24c41ca8-871c-456e-b082-22ec2a20216d"​ 
-  ], 
-  "​Label":​ "​Länge 8", 
-  "​Value":​ "​8",​ 
-  "​NominalValue":​ "​8",​ 
-  "​UpperTolerance":​ "​0.2",​ 
-  "​LowerTolerance":​ "​-0.2",​ 
-  "​ToleranceTable":​ "DIN ISO 2768-1:​1991-06",​ 
-  "​ToleranceTableColumn":​ "​m",​ 
-  "​MinMax":​ "​None",​ 
-  "​Fit":​ "",​ 
-  "​Conditions":​ "",​ 
-  "​Reference":​ "",​ 
-  "​ReferenceSystem":​ "",​ 
-  "​Comment":​ "",​ 
-  "​Count":​ 1, 
-  "​Stamp":​ { 
-     "​Id":​ "​61094ab8-c467-49ac-927d-0ef6333f7139",​ 
-     "​CompareSourceId":​ "​00000000-0000-0000-0000-000000000000",​ 
-     "​Text":​ "​1",​ 
-     "​Field":​{ 
-       "​Column":​ "​8",​ 
-       "​Row":​ "​A"​ 
-     }, 
-     "​Position":​ { 
-        "​X":​ 166.57601430037806,​ 
-        "​Y":​ 232.21485376832985,​ 
-        "​Z":​ 0.0 
-      }, 
-      "​Target":​ { 
-        "​X":​ 166.4193231832,​ 
-        "​Y":​ 225.87109451380002,​ 
-        "​Z":​ 0.0 
-      } 
-    } 
-  } 
-], 
-</​code>​ 
- 
-|< 100% 33% 12% 54% >| 
-^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ 
-^ Id | String | GUID of the characteristic | 
-^ SourceId | String | GUID of the characteristic from which the characteristic was created by duplication | 
-^ └ CompareSourceId | String | Original GUID of the feature from which the Characteristic was created by transferring or merging during drawing comparison. For several test plan versions, always refers to the very first characteristic in a link chain | 
-^ └ Direct​Compare​SourceId | String | GUID of the characteristic from which the charactaristic was created by transfer or merge during drawing comparison. Always refers to the direct predecessor characteristic | 
-^ IcpId | Integer | ID of the feature if it was imported from an ICP project file ("​*.icp"​ is the file format of the predecessor software #​@IC_OLD_HTML@#​). | 
-^ Characteristic​Type | String | **Variable** →[[en:​infra-convert:​user:​terms#​Characteristic (test-, quality-)|Variable characteristics]]\\ **Attributive** →[[en:​infra-convert:​user:​terms#​Characteristic (test-, quality-)|Attributive characteristics]] | 
-^ ClassId | String | GUID of →[[en:​infra-convert:​user:​terms#​Class (characteristic-)|Characteristic class]] | 
-^ Special​Category​Id | String | GUID of →[[en:​infra-convert:​user:​terms#​Category (characteristic-)|Characteristic category]] | 
-^ Characteristic​Tag​Ids | String | GUIDs of the labels assigned to the characteristic | 
-^ Value | String | Text as read from the drawing entry. | 
-^ Label | String | Title of the characteristic | 
-^ Nominal​Value | String | Nominal value (Numerical accuracy is maintained) | 
-^ Upper​Tolerance | String | Upper dimension or limit value (Numerical accuracy is maintained) |  
-^ LowerTolerance | String | lower dimension or limit value (Numerical accuracy is maintained) | 
-^ Tolerance​Table | String | Name of the tolerance table\\ **null** No value assigned, because paramter soes not apply| 
-^ Tolerance​Table​Column | String | Column in the tolerance table | 
-^ MinMax | String | **min** Type of limit: Minimum size (the lower limit is given, the upper limit is naturally determined)\\ **max** Type of limit: Maximum size (The upper limit is given, the lowe limit is naturally determined)\\ **None** Both limit dimensions are specified or a limit dimension specification is not applicable. | 
-^ Fit | String | Tolerance class| 
-^ Conditions | String| Modifiers | 
-^ Reference | String | References from a reference system according to DIN EN ISO 1101 | 
-^ Reference​System | String | References from reference systems other than DIN EN ISO 1101 ("B system"​) | 
-^ Comment | String | Comment |, 
-^ Count | Integer | Number of repetitions of the characteristic | 
-^ Stamps | Feld | Contains the characteristics of the stamp | 
-^ └ Id | String | GUID of the stamp | 
-^ └ CompareSourceId | String | Original GUID of the stamp from which the stamp was created by transfer or merge when comparing drawings. For multiple test plan versions, always refers to the very first stamp in a link chain | 
-^ └ Text | String | →[[en:​infra-convert:​user:​terms#​stempel_stempeln|Stamp inscription]] | 
-^ └ Field | String | Contains the key of the field in which the characteristic stamp is located\\ \\ **null** Field key is not assigned | 
-^  └ Column | String | Value for the column | 
-^  └ Row | String | Value of the series | 
-^ └ Position | Feld | Contains the coordinates of the position of the stamp on the drawing sheet\\ \\  **See also** Function > Characteristics > [[en:​infra-convert:​user:​functions:​balloonspos|Repositioning and aligning stamps]] | 
-^  └ X | String | X-coordinate of the stamp in drawing units | 
-^  └ Y | String | Y-coordinate of the stamp in drawing units | 
-^  └ Z | String | Z-coordinate of the stamp in drawing units | 
-^ └ Target | Field | Contains the coordinates of the reference point of the stamp on the drawing sheet\\ \\ **See also** Function > Characteristic > [[en:​infra-convert:​user:​functions:​balloonspos|Reposition and align stamp]] | 
-^  └ X | String | X-Coordinate of the stamp reference point in drawing units | 
-^  └ Y | String | Y-Coordinate of the stamp reference point in drawing units | 
-^  └ Z | String | Z-Coordinate of the stamp reference point in drawing units | 
- 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-\\  
- 
-====== Classes ====== 
- 
-<WRAP group> 
-<WRAP column 40%> 
- 
-The **Classes** field lists all the characteristics classes defined in the project. 
- 
-> **See also** 
-> Configuration and import > [[en:​infra-convert:​dev:​characteristicclasses|Parameter file "​CharacteristicClasses"​]] 
-> 
-> User Manual #@IC_HTML@# > More > Terms > [[en:​infra-convert:​user:​terms#​Class (characteristic-)|Class (characteristic-)]] 
- 
-</​WRAP>​ 
-<WRAP column 55%> 
- 
-<code javascript>​ 
-"​Classes":​ [ 
-  { 
-    "​Id":​ "​e5391b02-6657-4b4e-adc4-200547aed6e9",​ 
-    "​FriendlyName":​ "​Chamfer",​ 
-    "​Name":​ "​Fase",​ 
-    "​Description":​ "",​ 
-    "​QdasClass":​ 0, 
-    "​OldEliasId":​ 33, 
-    "​NominalUnit":​ "​None",​ 
-    "​ToleranceUnit":​ "​None"​ 
-  } 
-], 
-</​code>​ 
- 
-|< 100% 33% 12% 54% >| 
-^  Parameter ​ ^  Type  ^  Value/​COntent ^ 
-^ Id | String | GUID of the Characteristic class | 
-^ FriendlyName | String | Description of the characteristics class in short form without spaces | 
-^ Name | String | Description of the characteristics class in long form | 
-^ Description | String | Detailed description of the characteristics class | 
-^ QdasClass | String | Value of the Q-DAS-Class | 
-^ OldEliasId | String | ID of the characteristic class | 
-^ NominalUnit | String | The nominal dimension assigned →[[en:​infra-convert:​user:​terms#​mass_groessen|Unit of measurement]] | 
-^ ToleranceUnit | String | The tolerance assigned →[[en:​infra-convert:​user:​terms#​mass_groessen|Unit of measurement]] | 
- 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-\\  
- 
-====== Category ====== 
- 
-<WRAP group> 
-<WRAP column 40%> 
- 
-The **Categories** field lists all characteristic categories defined in the project. 
- 
-> **See also** 
-> Configuration and import > [[en:​infra-convert:​dev:​specialcategories|Parameter file "​StampTemplates"​]] 
-> 
-> User manual #@IC_HTML@# > More > Terms > [[en:​infra-convert:​user:​terms#​Category (characteristic-)|Category (characteristic-)]] 
- 
-</​WRAP>​ 
-<WRAP column 55%> 
- 
-<code javascript>​ 
-"​Categories":​ [ 
-  { 
-    "​Id":​ "​2bfa891e-ab74-4097-863d-ab5e5019abd7",​ 
-    "​FriendlyName":​ "​AuxiliaryDimension",​ 
-    "​Name":​ "​Hilfsmaß",​ 
-    "​Description":​ "",​ 
-    "​StampTemplateId":​ "​4a9aa00c-1297-411b-994e-033db76f127b"​ 
-  } 
-], 
-</​code>​ 
- 
-|< 100% 33% 12% 54% >| 
-^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ 
-^ Id | String | GUID of the characteristic category | 
-^ FriendlyName | String | Description of the characteristic category in short form without spaces ​ | 
-^ Name | String | Description of the characteristic category in long form | 
-^ Description | String | Detailed description of the characteristic category | 
- 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-\\  
- 
-====== Stamp templates ====== 
- 
-<WRAP group> 
-<WRAP column 40%> 
- 
-The **STampTemplates** field lists all stamp templates defined in the > **Siehe auch** 
-> Konfiguration und Import > [[en:​infra-convert:​dev:​stamptemplates|Parameterdatei "​StampTemplates"​]] 
- 
-</​WRAP>​ 
-<WRAP column 55%> 
- 
-<code javascript>​ 
-"​StampTemplates":​ [ 
-   { 
-    "​Id":​ "​6929b308-651b-45b8-9967-6befeeb5e2d8",​ 
-    "​Radius":​ 2.0, 
-    "​Form":​ 0, 
-    "​DefaultPosition":​ 0, 
-    "​MinDistanceForConnectionLine":​ 10.0, 
-    "​DistanceToText":​ 2.0, 
-    "​FillStamp":​ true, 
-    "​ColorString":​ "#​FFD65532",​ 
-    "​Name":​ "​VDA-Stempel in Rot", 
-    "​Description":​ ""​ 
-  } 
-], 
-</​code>​ 
- 
-|< 100% 33% 12% 54% >| 
-^  Parameter ​ ^  Typ  ^  Wert/​Inhalt ​ ^ 
-^ Id | String | GUID of the Stamp template | 
-^ Radius | Double | Size of the stamp | 
-^ Form | Double | Form of the stamp | 
-^ Default​Position | Double | Orientation of the stamp | 
-^ Min​Dinstance​For​Connection​Line | Double | Minimum distance od the STamp to the reference point from which a connecting line is drawn | 
-^ DistanceToText | Double | Distance od the Stamp from the reference point | 
-^ FillStamp | String | Stamp filling\\ **true** Yes\\ **false** No | 
-^ ColorString | String | Colour of the stamp, hexadecimal with value for the alpha channel (ARGB) | 
-^ Name | String | Name of the stamp template | 
-^ Description | String | Description of the stamp template | 
- 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-\\  
- 
-====== Label====== 
- 
-<WRAP group> 
-<WRAP column 40%> 
- 
-In the field **CharacteristicTags** all characteristic tags defined in the project are defined. 
- 
-> **See also** 
-> Configuration und import > [[en:​infra-convert:​dev:​characteristictags|Parameter file "​CharacteristicTags"​]] 
- 
-</​WRAP>​ 
-<WRAP column 55%> 
- 
-<code javascript>​ 
-"​CharacteristicTags":​ [ 
-  { 
-    "​Id":​ "​24c41ca8-871c-456e-b082-22ec2a20216d",​ 
-    "​FriendlyName":​ "​TagOne",​ 
-    "​Priority":​ 1, 
-    "​ColorString":​ "#​FFF7931E",​ 
-    "​Name":​ "​Kennzeichnung Eins", 
-    "​Description":​ ""​ 
-  } 
-] 
-</​code>​ 
- 
-|< 100% 33% 12% 54% >| 
-^  Parameter ​ ^  Type  ^  Value/​Content ​ ^ 
-^ Id | String | GUID of the label | 
-^ FriendlyName | String | Name of the label in short form, without spaces | 
-^ Priority | Double | Priority of the label| 
-^ ColorString | String | Color of the label, hexadecimal with value for the alpha channel (ARGB) | 
-^ Name | String | Name of the label in long form | 
-^ Description | String | Description of the label  | 
- 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-<WRAP noprint> 
- 
----- 
- 
-<WRAP group> 
-<WRAP col2> 
- 
-<WRAP rightalign>​ 
-**Go to previous page**\\ ​ 
-Konfiguration und Import > [[en:​infra-convert:​dev:​export:​jsonv1|Quality test plan format JSONV1]] 
-</​WRAP>​ 
- 
-**Go to next page**\\ ​ 
-Export > [[en:​infra-convert:​dev:​export:​dfd|Quality test plan format (ASCII Transferformat)]] 
- 
-</​WRAP>​ 
-</​WRAP>​ 
- 
-</​WRAP>​