en:infra-convert:dev:export:jsonv1
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:jsonv1 [2019/11/25 14:29] me |
en:infra-convert:dev:export:jsonv1 [2023/02/10 11:29] (current) me |
||
|---|---|---|---|
| Line 7: | Line 7: | ||
| </WRAP> | </WRAP> | ||
| - | ====== Quality test plan format JSONV1 ====== | + | ====== Test plan format JSONV1 ====== |
| ---- | ---- | ||
| - | The quality test plan export format **JSONV1** ensures maximum compatibility with connected software packages. It is a JSON file (click [[http://www.json.org/json-de.html|here]] for a description) which contains all the information relevant to an inspection plan. JSON files can be read by all common programming languages. The suffix //V1// identifies the file structure as version 1. This file structure is described in this chapter. | + | The test plan export format **JSONV1** contains significantly more information than the CSV and DFD formats. The data format is "JSON" (a description can be found [[http://www.json.org/json-de.html||here]]]), the suffix "V1" indicates version 1 of the contained test plan data structure. JSON can be read with all common programming languages. |
| - | If implemented, your software can also import data from a later version. A later version can include additional information, for example. | + | The JSONV1 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 the start parameter file (see "Configuration and Import > Start Parameter File > [[en:infra-convert:dev:parameter#Export quality test plans and stamped drawings]]). |
| - | > **Info** We recommend that you use the JSONV1 format rather than the DFD format to connect to your software package. It includes more transferable information and supports all characteristics of #@IC_HTML@#. It also provides the advantage of later versions of the JSONV1 format (after implementation) will also be compatible with your software.\\ \\ You can trigger the export in the start parameter file; see Configuration and Import > Startup Parameter File > [[en:infra-convert:dev:parameter#Export quality test plans and stamped drawings]]. | + | \\ |
| - | + | ||
| - | <WRAP group> | + | |
| - | <WRAP column 61%> | + | |
| - | + | ||
| - | You can find an example of a JSONV1 export file here: Appendix > [[en:infra-convert:dev:export:jsonv1_beispiel|Example Quality test Plan Export File JSONV1]]. | + | |
| - | + | ||
| - | </WRAP> | + | |
| - | <WRAP column 33%> | + | |
| - | + | ||
| - | [[en:infra-convert:dev:export:jsonv1_beispiel|{{ :en:infra-convert:dev:json_exportdatei_beispiel.png?nolink&250 |}}]] | + | |
| - | + | ||
| - | </WRAP> | + | |
| - | </WRAP> | + | |
| <WRAP noprint> | <WRAP noprint> | ||
| Line 161: | Line 148: | ||
| "Version": "A", | "Version": "A", | ||
| "Description": "Test description", | "Description": "Test description", | ||
| + | "Attributes": [ | ||
| + | { | ||
| + | "Key": "Owner", | ||
| + | "Value": "" | ||
| + | } | ||
| + | ], | ||
| "Files": [ | "Files": [ | ||
| { | { | ||
| Line 167: | Line 160: | ||
| }, | }, | ||
| { | { | ||
| - | "Id": "803960e2-415f-4a56-b558-87036988c6fb", | + | "Id": "803960e2-415f-4a56-b558-87036988c6fb", |
| "Name": "B.dxf" | "Name": "B.dxf" | ||
| } | } | ||
| Line 177: | Line 170: | ||
| |< 100% 33% 12% 54% >| | |< 100% 33% 12% 54% >| | ||
| ^ Parameter ^ Type ^ Value/Content ^ | ^ Parameter ^ Type ^ Value/Content ^ | ||
| - | ^ Id | String | GUID of the inspection plan version | | + | ^ Id | String | GUID of the test plan version | |
| - | ^ Name | String | Name of the inspection plan version | | + | ^ Name | String | Name of the test plan version | |
| - | ^ Version | String | Version number of the inspection plan version | | + | ^ Version | String | Version number of the test plan version | |
| - | ^ Description | String | Description of the inspection 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) | | ||
| ^ Files | Feld | Associated drawing files or sheets | | ^ Files | Feld | Associated drawing files or sheets | | ||
| ^ └ Id | String | GUID of the drawing sheet\\ \\ (Available from program version 1.3.9.5) | | ^ └ Id | String | GUID of the drawing sheet\\ \\ (Available from program version 1.3.9.5) | | ||
| Line 198: | Line 194: | ||
| The sequence of the characteristics corresponds to the list item in the test plan. The drawing-sheet-related inspection plan sections are hung together according to the sheet sequence. | The sequence of the characteristics corresponds to the list item in the test plan. The drawing-sheet-related inspection plan sections are hung together according to the sheet sequence. | ||
| + | |||
| + | At the end of this section you will find a diagram that illustrates how the IDs are assigned. | ||
| > **See also** | > **See also** | ||
| Line 244: | Line 242: | ||
| }, | }, | ||
| "DrawingQuadrant": "B7", | "DrawingQuadrant": "B7", | ||
| + | "StampGraphicFile": "Test plan_A_1.jpg", | ||
| "PositionX": "0333", | "PositionX": "0333", | ||
| "PositionY": "0244", | "PositionY": "0244", | ||
| Line 266: | Line 265: | ||
| ^ SpecialCategoryId | String | GUID of the →[[en:infra-convert:user:terms#Kategorie (Merkmal-)|Characteristic category]] | | ^ SpecialCategoryId | String | GUID of the →[[en:infra-convert:user:terms#Kategorie (Merkmal-)|Characteristic category]] | | ||
| ^ CharacteristicTagIds | String | GUIDs of the tags assigned to the characteristic | | ^ CharacteristicTagIds | String | GUIDs of the tags assigned to the characteristic | | ||
| + | ^ Value | String | Text as read from the drawing entry. | | ||
| ^ Label | String | Title of the characteristic (long text) | | ^ Label | String | Title of the characteristic (long text) | | ||
| ^ NominalValue | String | Nominal value (number accuracy is maintained)\\ **null** No value assigned because parameter does not apply | | ^ NominalValue | String | Nominal value (number accuracy is maintained)\\ **null** No value assigned because parameter does not apply | | ||
| Line 274: | Line 274: | ||
| ^ ToleranceTable | String | Name of the tolerance table\\ **null** No value assigned because parameter does not apply | | ^ ToleranceTable | String | Name of the tolerance table\\ **null** No value assigned because parameter does not apply | | ||
| ^ ToleranceTableColumn | String | Column in the tolerance table\\ **null** No value assigned because parameter does not apply | | ^ ToleranceTableColumn | String | Column in the tolerance table\\ **null** No value assigned because parameter does not apply | | ||
| - | ^ MinMax | String | **min** Type of limit: Minimum size (the lower limit is given, the upper limit is naturally)\\ **max** Type of limits: Maximum size (the upper limit is given, the lower limit is naturally)\\ **None** Both limit sizes are specified or a limit size 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 limits: Maximum size (the upper limit is given, the lower limit is naturally determined)\\ **None** Both limit sizes are specified or a limit size specification is not applicable. | |
| ^ Fit | String | Tolerance class\\ **null** No value assigned because parameter does not apply | | ^ Fit | String | Tolerance class\\ **null** No value assigned because parameter does not apply | | ||
| ^ Conditions | String| Modifiers\\ **null** No value assigned because parameter does not apply | | ^ Conditions | String| Modifiers\\ **null** No value assigned because parameter does not apply | | ||
| Line 280: | Line 280: | ||
| ^ ReferenceSystem | String | References from a different reference system than according to DIN EN ISO 1101\\ **null** No value assigned because parameter does not apply | | ^ ReferenceSystem | String | References from a different reference system than according to DIN EN ISO 1101\\ **null** No value assigned because parameter does not apply | | ||
| ^ Comment | String | Comment\\ **null** No value assigned because parameter does not apply | | ^ Comment | String | Comment\\ **null** No value assigned because parameter does not apply | | ||
| + | ^ Count | Integer | Number of repetitions of the characteristic | | ||
| ^ Stamps | Field | Contains the properties of the stamp\\ \\ **Note** Exactly one stamp is assigned to each characteristic, even if it is in a field. | | ^ Stamps | Field | Contains the properties of the stamp\\ \\ **Note** Exactly one stamp is assigned to each characteristic, even if it is in a field. | | ||
| ^ └ Id | String | GUID of the stamp | | ^ └ Id | String | GUID of the stamp | | ||
| Line 287: | Line 288: | ||
| ^ └ Id | String | GUID of the drawing sheet\\ \\ (Available from program version 1.3.9.5) | | ^ └ Id | String | GUID of the drawing sheet\\ \\ (Available from program version 1.3.9.5) | | ||
| ^ └ File | String | File name of the drawing sheet | | ^ └ File | String | File name of the drawing sheet | | ||
| + | ^ └ StampGraphicFile | String | File name of the stamp graphic\\ \\ (Available as of programme version 2.5.1) | | ||
| ^ └ DrawingQuadrant | String | Key to the field in which the characteristic can be found on the drawing sheet | | ^ └ DrawingQuadrant | String | Key to the field in which the characteristic can be found on the drawing sheet | | ||
| ^ └ PositionX | String | X-coordinate of the stamp in pixels on the drawing graphic\\ (Available from program version 1.2.0.21) | | ^ └ PositionX | String | X-coordinate of the stamp in pixels on the drawing graphic\\ (Available from program version 1.2.0.21) | | ||
| Line 298: | Line 300: | ||
| \\ | \\ | ||
| + | |||
| + | > **Allocation of characteristic and stamp IDs** | ||
| + | > The following diagram illustrates the assignment of the Ids (Guids) across the inspection plan versions. In case 1, a characteristic is transferred from test plan version A to B and from B to C in the drawing comparison. For example, "Guid C1" is found in version B as a CompareSourceId and as a DirectCompareSourceId, in C consequently only as CompareSourceId. In case 2, inspection plan version B is omitted. | ||
| + | > | ||
| + | > {{ :de:infra-convert:user:terms:id-zuweisung_beim_zeichnungsvergleich.png?nolink&850 |}} | ||
| + | |||
| + | \\ | ||
| ====== Classes ====== | ====== Classes ====== | ||
| Line 425: | Line 434: | ||
| **Go to next page**\\ | **Go to next page**\\ | ||
| - | Export > [[en:infra-convert:dev:export:dfd|Quality test plan format DFD]] | + | Export > [[en:infra-convert:dev:export:jsonv2|Test plan format JSONV2]] |
| </WRAP> </WRAP> | </WRAP> </WRAP> | ||
| </WRAP> | </WRAP> | ||
en/infra-convert/dev/export/jsonv1.1574688593.txt.gz · Last modified: 2019/11/25 14:29 by me
Page Tools
