en:infra-convert:dev:export:jsonv2
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:infra-convert:dev:export:jsonv2 [2021/07/13 14:55] me [Basic Structure] |
en:infra-convert:dev:export:jsonv2 [2022/06/22 17:18] (current) me |
||
|---|---|---|---|
| Line 9: | Line 9: | ||
| <WRAP group> | <WRAP group> | ||
| <WRAP column 75%> | <WRAP column 75%> | ||
| - | ====== Quality test plan format JSONV2 ====== | + | ====== Test plan format JSONV2 ====== |
| ---- | ---- | ||
| Line 18: | Line 18: | ||
| </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 versions of the JSON test plan format in the overview: | ||
| + | |||
| + | |< 100% 10% 15% 75% >| | ||
| + | ^ 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. ||| | ||
| + | |||
| + | 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]] | ||
| - | 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 quality test plans and stamped drawings]]). | ||
| \\ | \\ | ||
| Line 50: | Line 62: | ||
| <WRAP column 40%> | <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 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. | + | 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> | </WRAP> | ||
| Line 59: | Line 71: | ||
| "ExportFormatVersion": { | "ExportFormatVersion": { | ||
| "Major": 2, | "Major": 2, | ||
| - | "Minor": 0 | + | "Minor": 1 |
| }, | }, | ||
| "InfraConvertVersion": "2.7.9", | "InfraConvertVersion": "2.7.9", | ||
| Line 114: | Line 126: | ||
| "Version": "A", | "Version": "A", | ||
| "Description": "", | "Description": "", | ||
| + | "Attributes": [ | ||
| + | { | ||
| + | "Key": "Owner", | ||
| + | "Value": "" | ||
| + | } | ||
| + | ], | ||
| "Documents": [ | "Documents": [ | ||
| { | { | ||
| Line 141: | Line 159: | ||
| ^ Version | String | Version number of the test plan version | | ^ Version | String | Version number of the test plan version | | ||
| ^ Description | String | Description of the test plan version | | ^ Description | String | Description of the test plan version | | ||
| + | ^ Version | String | Version number of the test plan version | | ||
| + | ^ Description | String | Description of the test plan version | | ||
| + | ^ Attributes | Feld | Additional test plan attributes\\ \\ (Available from program version 2.10.0) | | ||
| ^ Documents | Field | Contains all drawing sheets of the test plan version | | ^ 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 | | ||
| Line 176: | Line 197: | ||
| <code javascript> | <code javascript> | ||
| "Characteristics": [ | "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": "Length 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", |
| - | "Position": { | + | "Field":{ |
| - | "X": 166.57601430037806, | + | "Column": "8", |
| - | "Y": 232.21485376832985, | + | "Row": "A" |
| - | "Z": 0.0 | + | |
| }, | }, | ||
| - | "Target": { | + | "Position": { |
| - | "X": 166.4193231832, | + | "X": 166.57601430037806, |
| - | "Y": 225.87109451380002, | + | "Y": 232.21485376832985, |
| - | "Z": 0.0 | + | "Z": 0.0 |
| - | }, | + | }, |
| - | "StampGraphicFiles":: [ | + | "Target": { |
| - | "C:\\Users\\user1\\Desktop\\test.icpx\\JPG\\Example test plan_A_1.JPG", | + | "X": 166.4193231832, |
| - | "C:\\Users\\user1\\Desktop\\test.icpx\\PNG\\Example test plan_A_1.PNG" | + | "Y": 225.87109451380002, |
| - | ] | + | "Z": 0.0 |
| + | }, | ||
| + | "StampGraphicFiles": [ | ||
| + | "C:\\Users\\user1\\Desktop\\test.icpx\\JPG\\Example test plan_A_1.JPG", | ||
| + | "C:\\Users\\user1\\Desktop\\test.icpx\\PNG\\Example test plan_A_1.PNG" | ||
| + | ] | ||
| } | } | ||
| } | } | ||
| Line 269: | Line 294: | ||
| ^ └ Y | String | Y-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 | | ^ └ 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 | | + | ^ └ StampGraphicFiles | Field | Stamp graphics exported for this stamp, specified as a file path. All exports that have been run during a session are chronologically listed (first export, second export, …). 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> | </WRAP> | ||
| Line 454: | Line 479: | ||
| <WRAP rightalign> | <WRAP rightalign> | ||
| **Go to previous page**\\ | **Go to previous page**\\ | ||
| - | Configuration and Import > [[en:infra-convert:dev:export:jsonv1|Quality test plan format JSONV1]] | + | Configuration and Import > [[en:infra-convert:dev:export:jsonv1|Test plan format JSONV1]] |
| </WRAP> | </WRAP> | ||
| **Go to next page**\\ | **Go to next page**\\ | ||
| - | Export > [[en:infra-convert:dev:export:dfd|Quality test plan format DFD (ASCII)]] | + | Export > [[en:infra-convert:dev:export:dfd|Test plan format DFD (ASCII)]] |
| </WRAP> | </WRAP> | ||
en/infra-convert/dev/export/jsonv2.1626180917.txt.gz · Last modified: 2021/07/13 14:55 by me
Page Tools
