Difference between revisions of "Common properties of Named Data"

From wiki.fine.cz
Jump to navigation Jump to search
m
(Master definition change)
Line 6: Line 6:
!Presence
!Presence
!Default
!Default
!Version
|-
|-
|GUID
|GUID
Line 11: Line 12:
|Unique GUID of the named data element, is written to the <code>ID</code> attribute, if an alternative text identifier is used in the <code>ID</code>, optionally specified in the <code>GUID</code> attribute
|Unique GUID of the named data element, is written to the <code>ID</code> attribute, if an alternative text identifier is used in the <code>ID</code>, optionally specified in the <code>GUID</code> attribute
|required
|required
|
|
|
|-
|-
Line 17: Line 19:
|Element name ([[Formatted text value|formatted text]]), can be translated into multiple languages (see [[Multilingual text]])
|Element name ([[Formatted text value|formatted text]]), can be translated into multiple languages (see [[Multilingual text]])
|required
|required
|
|
|
|-
|-
Line 24: Line 27:
|optional
|optional
|(empty)
|(empty)
|
|-
|-
|Item type
|Item type
Line 29: Line 33:
|Item type  {<sup>[[Legend of XML elements|[V]]]</sup> <code>[[Text string (Named Data Type)|String]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Number (Named Data Type)|Double]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Enumeration (Named Data Type)|Enum]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Set (Named Data Type)|Set]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Enumeration or Set Element (Named Data Type)|EnumItem]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Date and Time (Named Data Type)|DateTime]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Table (Named Data Type)|Table]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Group (Named Data Type)|Group]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Hatch and Color (Named Data Type)|SoilPattern]],  <sup>[[Legend of XML elements|[V]]]</sup> [[File (Named Data Type)|File]]</code>}
|Item type  {<sup>[[Legend of XML elements|[V]]]</sup> <code>[[Text string (Named Data Type)|String]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Number (Named Data Type)|Double]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Enumeration (Named Data Type)|Enum]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Set (Named Data Type)|Set]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Enumeration or Set Element (Named Data Type)|EnumItem]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Date and Time (Named Data Type)|DateTime]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Table (Named Data Type)|Table]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Group (Named Data Type)|Group]]</code>, <sup>[[Legend of XML elements|[V]]]</sup> <code>[[Hatch and Color (Named Data Type)|SoilPattern]],  <sup>[[Legend of XML elements|[V]]]</sup> [[File (Named Data Type)|File]]</code>}
|required
|required
|
|
|
|-
|-
Line 35: Line 40:
|Different for each element type
|Different for each element type
|required
|required
|
|
|
|-
|-
Line 42: Line 48:
|optional
|optional
|(empty)
|(empty)
|
|-
|-
|&nbsp;&nbsp;&nbsp;&nbsp;Read only
|&nbsp;&nbsp;&nbsp;&nbsp;Read only
Line 48: Line 55:
|optional
|optional
|<code>false</code>
|<code>false</code>
|
|-
|-
|Master
|Master
Line 54: Line 62:
|optional
|optional
|(empty)
|(empty)
|< 2024
|-
|-
|&nbsp;&nbsp;&nbsp;&nbsp;Master GUID
|&nbsp;&nbsp;&nbsp;&nbsp;Master GUID
Line 60: Line 69:
|(required)
|(required)
|
|
|< 2024
|-
|-
|&nbsp;&nbsp;&nbsp;&nbsp;Master elements
|&nbsp;&nbsp;&nbsp;&nbsp;Master elements
Line 67: Line 77:
|(required)
|(required)
|
|
|< 2024
|-
|-
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Master element GUID
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Master element GUID
Line 72: Line 83:
|(required)
|(required)
|
|
|< 2024
|-
|-
|Range
|Range
Line 77: Line 89:
|
|
|optional
|optional
|
|
|
|-
|-
Line 84: Line 97:
|optional
|optional
|<code>false</code>
|<code>false</code>
|
|}
|}
'''Example of Template XML'''
'''Example of Template XML'''
Line 107: Line 121:
<code></Item></code>
<code></Item></code>


'''Example of Template XML with Master specified'''
'''Example of Template XML with Master specified (version < 2024)'''


<code><Item ID="{EFEC9E11-6FFD-44B9-9FC8-AC6F1E892461}" ItemType="Enum"></code>
<code><Item ID="{EFEC9E11-6FFD-44B9-9FC8-AC6F1E892461}" ItemType="Enum"></code>

Revision as of 13:43, 3 October 2023

Template XML definition

Property XML Description Presence Default Version
GUID [A] STRING ID or GUID Unique GUID of the named data element, is written to the ID attribute, if an alternative text identifier is used in the ID, optionally specified in the GUID attribute required
Name [E] Name Element name (formatted text), can be translated into multiple languages (see Multilingual text) required
Comment [E] Comment Optional comment (formatted text), can be translated into multiple languages (see Multilingual text) optional (empty)
Item type [A] ENUM ItemType Item type {[V] String, [V] Double, [V] Enum, [V] Set, [V] EnumItem, [V] DateTime, [V] Table, [V] Group, [V] SoilPattern, [V] File} required
Settings [E] Settings Different for each element type required
    Identifier     [A] STRING Ident The optional identifier, used especially for libraries that have it prescribed, can then be reflected in the Mapping optional (empty)
    Read only     [A] BOOL ReadOnly Item is read-only - cannot be edited by user, is defined by formula and calculated from another elements - see list of read-only items optional false
Master [E] Master Master Named Data Element of type Enum, must be on the same level as current element, used to hide input of the current element (Enum or Set Element is not affected) optional (empty) < 2024
    Master GUID     [A] GUID MasterGUID GUID of the Master element (required) < 2024
    Master elements     [:E:] Item GUIDs of the master elements items of type EnumElement, means if the value of the master data input is one on these elements, current element input is visible

If the master element is also hidden by this rule, current elemeni is also hidden

(required) < 2024
        Master element GUID         [A] GUID Value (required) < 2024
Range [E] Range optional
    Unique     [A] BOOL Unique Entered data must be unique according to data on same input level - e. g. unique Name in column of table row optional false

Example of Template XML

<Item ID="{F12017FC-9AF4-4866-9FC2-BE7CF40B1A67}" ItemType="String">

  <Name>

    <Item Lang="CS" Text="Název zkoušky" />

    <Item Lang="EN" Text="Test name" />

  </Name>

  <Comment>

    <Item Lang="CS" Text="General / Fixed" />

  </Comment>

  <Settings Ident="ID123" />

</Item>

Example of Template XML with Master specified (version < 2024)

<Item ID="{EFEC9E11-6FFD-44B9-9FC8-AC6F1E892461}" ItemType="Enum">

  <Name Lang="CS" Text="Typ vzorku" />

  <Item ID="{F14426ED-878B-4B30-ACF0-EC7062DDEA80}" ItemType="EnumItem">

    <Name Lang="CS" Text="neporušený" />

  </Item>

  <Item ID="{A99658F7-FD21-4F12-B1B8-7159E8C78F34}" ItemType="EnumItem">

    <Name Lang="CS" Text="porušený" />

  </Item>

</Item>

<Item ID="{C0D1DD2F-7B85-48DF-B74B-F567CCA865BB}" ItemType="String">

  <Name Lang="CS" Text="Označení vzorku" />

  <Master MasterGUID="{EFEC9E11-6FFD-44B9-9FC8-AC6F1E892461}">

    <Item GUID="{A99658F7-FD21-4F12-B1B8-7159E8C78F34}" />

  </Master>

</Item>

Data XML definition

Property XML Description
Identifier [A] STRING ID ID can be either a GUID or a unique text identifier corresponding to ID / GUID attribute of Template Item

Example of Data XML

<Item ID="{B1DC392E-0C1A-4016-8B77-1CD25D89DC65}" StrValue="Pokus obsah" />

Retrieved from "https://wiki.fine.cz/index.php?title=Common_properties_of_Named_Data&oldid=513"