Differences

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

--- en:infra-convert:dev:export:jsonv2_neu [2020/07/23 15:24]
me removed
+++ en:infra-convert:dev:export:jsonv2_neu [2021/07/15 11:08] (current)
me
@@ Line 14: / Line 14: @@
 </WRAP>
 <WRAP column 20%>
-> **Available from**\\ Program version 1.4.2.1
+> **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.
+The test plan export format **JSONVx** is based on the data exchange format [[http://www.json.org/json-en.html|JSON]], which can be read by all common programming languages. Compared to exchange formats such as CSV and DFD, it represents a larger scope of test plan information created with #@IC_HTML@#.
-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.
+**Vx** indicates the version status of the included test plan data structure. The current version is **JSONV2**. JSONV1 will continue to be maintained. However, we recommend to prefer JSONV2.
-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]]).
+The versions of the JSON test plan format in the overview:
-<WRAP group>
+|< 100% 10% 15% 75% >|
-<WRAP column 61%>
+^  Version*  ^  Available  ^  Main characteristic / changes compared to the previous version  ^
+^  1    |  as of v1.0.0.0  | A specific test plan version of a project is shown. |
+^  2.0  |  as of v1.4.2.1  | All test plan versions of a project are displayed in an overall structure. |
+^  2.1  |  as of v2.7.9  | Optional single characteristics formed on the basis of the number of repetitions are no longer exported as individual characteristic copies identical except for the stamp text. Instead, only one feature object is exported with a list of the assigned stamp texts ("MultiCharacteristicSplitStampTexts").\\  **See** User manual > Settings > Settings > Characteristics > [[en:infra-convert:user:config:features#dimensions_with_details_of_repetitions_group|„Dimensions with details of repetitions“ group]] |
+| * – Main and minor version number. The latest main version is used for the corresponding JSONVx export. |||
-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]].
+The JSONV2 export can be triggered either from the user interface or via start parameter call.\\
+ **See** User manual > Functions > Export > [[en:infra-convert:user:functions:cplanexport|Export test plan]]\\
+ **See** Configuration and import > Start parameter file > [[en:infra-convert:dev:parameter#export_quality_test_plans_and_stamped_drawings| Export quality test plans and stamped drawings]]
-</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>
@@ Line 61: / Line 62: @@
 <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.
+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 test plan versions with the respective drawing sheets and characteristics. The cross-project definitions for classes, categories, stamp templates and tags 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>
@@ Line 70: / Line 71: @@
   "ExportFormatVersion": {
     "Major": 2,
-    "Minor": 0
+    "Minor": 1
   },
-  "InfraConvertVersion": "1.4.2.0",
+  "InfraConvertVersion": "2.7.9",
   "Project": {
-    "Name": "Beispielprojekt",
+    "Name": "Example project",
     "Description": "",
     "InspectionPlanVersions": [],
@@ Line 122: / Line 123: @@
   {
     "Id": "7b80d8ef-6eef-4be1-af57-cca058828124",
-    "Name": "Beispielprüfplan",
+    "Name": "Example test plan",
     "Version": "A",
     "Description": "",
@@ Line 149: / Line 150: @@
 ^  Parameter  ^  Type  ^  Value/Content^
 ^ Id | String | Globally unique identifier (GUID) of the project |
-^ Name | String | Name or itle of the test plan version |
+^ Name | String | Name or title 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 |
+^ Documents | Field | Contains all drawing sheets of the test plan version |
-^ └ Id | String | GUID of the Drawing sheet |
+^ └ Id | String | GUID of the drawing sheet |
 ^ └ Name | String | Name of the drawing sheet |
 ^ └ Extents | Field | Contains the outer dimensions of the drawing sheet |
@@ Line 175: / Line 176: @@
 <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.
+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 test 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]]
+> User Manual #@IC_HTML@# > Further > Terms > [[en:infra-convert:user:terms#Stamp/stamps|Stamp/Stamps]]
 </WRAP>
@@ Line 187: / Line 188: @@
 <code javascript>
 "Characteristics": [
-   {
+  {
-  "Id": "23553146-b049-4875-80e4-33a40a0d5d1f",
+    "Id": "23553146-b049-4875-80e4-33a40a0d5d1f",
-  "SourceId": "00000000-0000-0000-0000-000000000000",
+    "SourceId": "00000000-0000-0000-0000-000000000000",
-  "CompareSourceId": "00000000-0000-0000-0000-000000000000",
+    "CompareSourceId": "00000000-0000-0000-0000-000000000000",
-  "DirectCompareSourceId": "00000000-0000-0000-0000-000000000000",
+    "DirectCompareSourceId": "00000000-0000-0000-0000-000000000000",
-  "IcpId": "1",
+    "IcpId": "1",
-  "CharacteristicType": "Variable",
+    "CharacteristicType": "Variable",
-  "ClassId": "bea94ebe-84de-4653-86a5-dd600a45070e",
+    "ClassId": "bea94ebe-84de-4653-86a5-dd600a45070e",
-  "SpecialCategoryId": "6e626731-625f-4f71-a471-2a267d511e18",
+    "SpecialCategoryId": "6e626731-625f-4f71-a471-2a267d511e18",
-  "CharacteristicTagIds": [
+    "CharacteristicTagIds": [
-    "24c41ca8-871c-456e-b082-22ec2a20216d"
+      "24c41ca8-871c-456e-b082-22ec2a20216d"
-  ],
+    ],
-  "Label": "Länge 8",
+    "Label": "Length 8",
-  "Value": "8",
+    "Value": "8",
-  "NominalValue": "8",
+    "NominalValue": "8",
-  "UpperTolerance": "0.2",
+    "UpperTolerance": "0.2",
-  "LowerTolerance": "-0.2",
+    "LowerTolerance": "-0.2",
-  "ToleranceTable": "DIN ISO 2768-1:1991-06",
+    "ToleranceTable": "DIN ISO 2768-1:1991-06",
-  "ToleranceTableColumn": "m",
+    "ToleranceTableColumn": "m",
-  "MinMax": "None",
+    "MinMax": "None",
-  "Fit": "",
+    "Fit": "",
-  "Conditions": "",
+    "Conditions": "",
-  "Reference": "",
+    "Reference": "",
-  "ReferenceSystem": "",
+    "ReferenceSystem": "",
-  "Comment": "",
+    "Comment": "",
-  "Count": 1,
+    "Count": 2,
-  "Stamp": {
+    "MultiCharacteristicSplitStampTexts": [
-     "Id": "61094ab8-c467-49ac-927d-0ef6333f7139",
+       "1.1",
-     "CompareSourceId": "00000000-0000-0000-0000-000000000000",
+       "1.2"
-     "Text": "1",
+    ],
-     "Field":{
+    "Stamp": {
-       "Column": "8",
+      "Id": "61094ab8-c467-49ac-927d-0ef6333f7139",
-       "Row": "A"
+      "CompareSourceId": "00000000-0000-0000-0000-000000000000",
+      "Text": "1",
+      "Field":{
+        "Column": "8",
+        "Row": "A"
+      },
+     "Position": {
+       "X": 166.57601430037806,
+       "Y": 232.21485376832985,
+       "Z": 0.0
      },
-     "Position": {
+     "Target": {
-        "X": 166.57601430037806,
+       "X": 166.4193231832,
-        "Y": 232.21485376832985,
+       "Y": 225.87109451380002,
-        "Z": 0.0
+       "Z": 0.0
-      },
+     },
-      "Target": {
+     "StampGraphicFiles": [
-        "X": 166.4193231832,
+       "C:\\Users\\user1\\Desktop\\test.icpx\\JPG\\Example test plan_A_1.JPG",
-        "Y": 225.87109451380002,
+       "C:\\Users\\user1\\Desktop\\test.icpx\\PNG\\Example test plan_A_1.PNG"
-        "Z": 0.0
+     ]
-      }
     }
   }
@@ Line 240: / Line 249: @@
 ^ 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 |
+^ └ CompareSourceId | String | Original GUID of the characteristic 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 |
 ^ └ DirectCompareSourceId | 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@#). |
+^ IcpId | Integer | ID of the characteristic if it was imported from an ICP project file ("*.icp" is the file format of the predecessor software #@IC_OLD_HTML@#). |
 ^ CharacteristicType | 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]] |
 ^ SpecialCategoryId | String | GUID of →[[en:infra-convert:user:terms#Category (characteristic-)|Characteristic category]] |
-^ CharacteristicTagIds | String | GUIDs of the labels assigned to the characteristic |
+^ CharacteristicTagIds | String | GUIDs of the tags assigned to the characteristic |
-^ Value | String | Text as read from the drawing entry. |
+^ Value | String | Text as read from the drawing entry |
 ^ Label | String | Title of the characteristic |
 ^ NominalValue | String | Nominal value (Numerical accuracy is maintained) |
 ^ UpperTolerance | String | Upper dimension or limit value (Numerical accuracy is maintained) |
-^ LowerTolerance | String | lower dimension or limit value (Numerical accuracy is maintained) |
+^ LowerTolerance | String | Lower dimension or limit value (Numerical accuracy is maintained) |
-^ ToleranceTable | String | Name of the tolerance table\\ **null** No value assigned, because paramter soes not apply|
+^ ToleranceTable | String | Name of the tolerance table\\ **null** No value assigned, because paramter soes not apply |
 ^ ToleranceTableColumn | 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. |
+^ 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|
+^ Fit | String | Tolerance class |
 ^ Conditions | String| Modifiers |
 ^ Reference | String | References from a reference system according to DIN EN ISO 1101 |
 ^ ReferenceSystem | String | References from reference systems other than DIN EN ISO 1101 ("B system") |
-^ Comment | String | Comment |,
+^ Comment | String | Comment |
 ^ Count | Integer | Number of repetitions of the characteristic |
-^ Stamps | Feld | Contains the characteristics of the stamp |
+^ Stamps | Field | 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]] |
+^ └ Text | String | →[[en:infra-convert:user:terms#stamp_inscription|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 |
+^  └ Row | String | Value of the row |
-^ └ 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]] |
+^ └ Position | Field | 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 |
@@ Line 276: / Line 285: @@
 ^  └ Y | String | Y-Coordinate of the stamp reference point in drawing units |
 ^  └ Z | String | Z-Coordinate of the stamp reference point in drawing units |
+^ └ StampGraphicFiles | Field | Stamp graphics exported for this stamp, specified as a file path. All exports that have been run during a session are listed. For stamp graphics exported via start parameter call: The JSONV2 target definition must follow **after** the stamp graphic target definitions\\ \\  **Note** Available as from programme version 2.7.5 |
 </WRAP>
@@ Line 302: / Line 312: @@
     "Id": "e5391b02-6657-4b4e-adc4-200547aed6e9",
     "FriendlyName": "Chamfer",
-    "Name": "Fase",
+    "Name": "Chamfer",
     "Description": "",
     "QdasClass": 0,
@@ Line 313: / Line 323: @@
 |< 100% 33% 12% 54% >|
-^  Parameter  ^  Type  ^  Value/COntent ^
+^  Parameter  ^  Type  ^  Value/Content ^
 ^ Id | String | GUID of the Characteristic class |
 ^ FriendlyName | String | Description of the characteristics class in short form without spaces |
@@ Line 320: / Line 330: @@
 ^ 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]] |
+^ NominalUnit | String | The nominal dimension assigned →[[en:infra-convert:user:terms#measurement_sizes|Unit of measurement]] |
-^ ToleranceUnit | String | The tolerance assigned →[[en:infra-convert:user:terms#mass_groessen|Unit of measurement]] |
+^ ToleranceUnit | String | The tolerance assigned →[[en:infra-convert:user:terms#measurement_sizes|Unit of measurement]] |
 </WRAP>
@@ Line 372: / Line 382: @@
 <WRAP column 40%>
-The **STampTemplates** field lists all stamp templates defined in the > **Siehe auch**
+The **StampTemplates** field lists all stamp templates defined in the > **See also**
-> Konfiguration und Import > [[en:infra-convert:dev:stamptemplates|Parameterdatei "StampTemplates"]]
+> Configuration and Import > [[en:infra-convert:dev:stamptemplates|Parameter file "StampTemplates"]]
 </WRAP>
@@ Line 389: / Line 399: @@
     "FillStamp": true,
     "ColorString": "#FFD65532",
-    "Name": "VDA-Stempel in Rot",
+    "Name": "VDA stamp in red",
     "Description": ""
   }
@@ Line 396: / Line 406: @@
 |< 100% 33% 12% 54% >|
-^  Parameter  ^  Typ  ^  Wert/Inhalt  ^
+^  Parameter  ^  Type  ^  Value/Content  ^
 ^ Id | String | GUID of the Stamp template |
 ^ Radius | Double | Size of the stamp |
 ^ Form | Double | Form of the stamp |
 ^ DefaultPosition | Double | Orientation of the stamp |
-^ MinDinstanceForConnectionLine | Double | Minimum distance od the STamp to the reference point from which a connecting line is drawn |
+^ MinDinstanceForConnectionLine | 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 |
+^ DistanceToText | Double | Distance of 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) |
@@ Line 413: / Line 423: @@
 \\
-====== Label======
+====== Tag ======
 <WRAP group>
@@ Line 433: / Line 443: @@
     "Priority": 1,
     "ColorString": "#FFF7931E",
-    "Name": "Kennzeichnung Eins",
+    "Name": "Tag One",
     "Description": ""
   }
@@ Line 441: / Line 451: @@
 |< 100% 33% 12% 54% >|
 ^  Parameter  ^  Type  ^  Value/Content  ^
-^ Id | String | GUID of the label |
+^ Id | String | GUID of the tag |
-^ FriendlyName | String | Name of the label in short form, without spaces |
+^ FriendlyName | String | Name of the tag in short form, without spaces |
-^ Priority | Double | Priority of the label|
+^ Priority | Double | Priority of the tag |
-^ ColorString | String | Color of the label, hexadecimal with value for the alpha channel (ARGB) |
+^ ColorString | String | Color of the tag, hexadecimal with value for the alpha channel (ARGB) |
-^ Name | String | Name of the label in long form |
+^ Name | String | Name of the tag in long form |
-^ Description | String | Description of the label  |
+^ Description | String | Description of the tag |
 </WRAP>
@@ Line 460: / Line 470: @@
 <WRAP rightalign>
 **Go to previous page**\\
-Konfiguration und Import > [[en:infra-convert:dev:export:jsonv1|Quality test plan format JSONV1]]
+Configuration and 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)]]
+Export > [[en:infra-convert:dev:export:dfd|Quality test plan format DFD (ASCII)]]
 </WRAP>

ELIAS GmbHProduktdokumentationen

User Tools

Site Tools

Differences

Page Tools

ELIAS GmbH
Produktdokumentationen