Difference between revisions of "Common properties of Named Data"

From wiki.fine.cz
Jump to navigation Jump to search
m
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
==== Template XML definition ====
{| class="wikitable"
{| class="wikitable"
!Property
!Property
!Template XML
!XML
!Description
!Description
!Presence
!Default
!Version
|-
|-
|GUID
|GUID
|<sup>[[Legend of XML elements|[A]]]</sup> STRING <code>ID</code> or <code>GUID</code>
|<sup>[[Legend of XML elements|[A]]]</sup> STRING <code>ID</code> or <code>GUID</code>
|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
|
|
|-
|-
|Name
|Name
|<sup>[[Legend of XML elements|[E]]]</sup>  <code>Name</code>
|<sup>[[Legend of XML elements|[E]]]</sup>  <code>Name</code>
|Element name, 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
|
|
|-
|-
|Comment
|Comment
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Comment</code>
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Comment</code>
|Optional comment, can be translated into multiple languages (see [[Multilingual text]])
|Optional comment ([[Formatted text value|formatted text]]), can be translated into multiple languages (see [[Multilingual text]])
|optional
|(empty)
|
|-
|-
|Item type
|Item type
|<sup>[[Legend of XML elements|[A]]]</sup> ENUM <code>ItemType</code>
|<sup>[[Legend of XML elements|[A]]]</sup> ENUM <code>ItemType</code>
|Item type  {<sup>[[Legend of XML elements|[V]]]</sup> String, Double, Enum, Set, EnumItem, DateTime, Table, Group, SoilPattern}
|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
|
|
|-
|-
|Settings
|Special
|<sup>[[Legend of XML elements|[A]]]</sup> ENUM <code>Special</code>
|Special type (see [[Special named data types]])
|required
|<code>None</code>
|2024
|-
|Settings  
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Settings</code>
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Settings</code>
|Different for each element type
|Different for each element type
|required
|
|
|-
|-
|&nbsp;&nbsp;&nbsp;&nbsp;Identifier
|&nbsp;&nbsp;&nbsp;&nbsp;Identifier  
|&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[A]]]</sup> STRING <code>Ident</code>
|&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[A]]]</sup> STRING <code>Ident</code>
|&nbsp;&nbsp;&nbsp;&nbsp;The optional identifier, used especially for libraries that have it prescribed, can then be reflected in the [[Mapping]]
|The optional identifier, used especially for libraries that have it prescribed, can then be reflected in the [[Mapping]]
|optional
|(empty)
|
|-
|&nbsp;&nbsp;&nbsp;&nbsp;Read only
|&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[A]]]</sup> BOOL <code>ReadOnly</code>
|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
|<code>false</code>
|
|-
|Master
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Master</code>
|Master Named Data Element of type <code>[[Enumeration (Named Data Type)|Enum]]</code>, 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
|-
|&nbsp;&nbsp;&nbsp;&nbsp;Master GUID
|&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[A]]]</sup> GUID <code>MasterGUID</code>
|GUID of the Master element
|(required)
|
|< 2024
|-
|&nbsp;&nbsp;&nbsp;&nbsp;Master elements
|&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[:E:]]]</sup> <code>Item</code>
| rowspan="2" |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 element is also hidden
|(required)
|
|< 2024
|-
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Master element GUID
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[A]]]</sup> GUID <code>Value</code>
|(required)
|
|< 2024
|-
|Master
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Master</code>
|Master Named Data Element of type <code>[[Enumeration (Named Data Type)|Enum]]</code>, used to hide input of the current element
|optional
|(empty)
|2024
|-
|&nbsp;&nbsp;&nbsp;&nbsp;Master enumeration
|&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[E]]]</sup> <code>EnumNesting</code>
|Master enumeration
|(required)
|
|2024
|-
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Master element nesting
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[A]]]</sup> String <code>Nesting</code>
|<nowiki>Nesting from the root of Template - GUIDs separated by "|" character e.g. </nowiki><code><nowiki>{2C17B508-E9B4-409B-956E-9A516AC1DFFB}|{FE390082-8C4B-4F04-A6FA-49344F03C60C}</nowiki></code>
|(required)
|
|2024
|-
| &nbsp;&nbsp;&nbsp;&nbsp;Master elements
|&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[:E:]]]</sup> <code>EnumItem</code>
| rowspan="2" |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 element is also hidden
|(required)
|
|2024
|-
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Master element GUID
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[A]]]</sup> GUID <code>Value</code>
|(required)
|
|2024
 
|-
|Range
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Range</code>
|
| optional
|
|
|-
|&nbsp;&nbsp;&nbsp;&nbsp;Unique
|&nbsp;&nbsp;&nbsp;&nbsp;<sup>[[Legend of XML elements|[A]]]</sup> BOOL <code>Unique</code>
|Entered data must be unique according to data on same input level - e. g. unique Name in column of table row
| optional
|<code>false</code>
|
|}
|}
'''Example of Template XML'''


====Example of the Template XML====
<code><Item ID="{F12017FC-9AF4-4866-9FC2-BE7CF40B1A67}" ItemType="String"></code>
<code><Item ID="{F12017FC-9AF4-4866-9FC2-BE7CF40B1A67}" ItemType="String"></code>


Line 49: Line 163:


<code></Item></code>
<code></Item></code>
'''Example of Template XML with Master specified'''
<code><Item ID="{2C17B508-E9B4-409B-956E-9A516AC1DFFB}" ItemType="String"></code>
<code>  <Name Lang="CS" Text="Blokující organizace" /></code>
<code>  <Settings Ident="" EmptyText="" UnitNameMetric="" Multiline="false" /></code>
<code>  <Range Unique="false" AllowEmpty="true" MaxLength="0" /></code>
<code>  <Master></code>
<code>    <EnumNesting Value="{FE390082-8C4B-4F04-A6FA-49344F03C60C}" /></code>
<code>    <EnumItem GUID="{4ACE40EE-735E-4EA9-A7BF-AF9687D6C37C}" /></code>
<code>  </Master></code>
<code></Item></code>
'''Example of Template XML with Master specified (version < 2024)'''
<code><Item ID="{EFEC9E11-6FFD-44B9-9FC8-AC6F1E892461}" ItemType="Enum"></code>
<code>  <Name Lang="CS" Text="Typ vzorku" /></code>
<code>  <Item ID="{F14426ED-878B-4B30-ACF0-EC7062DDEA80}" ItemType="EnumItem"></code>
<code>    <Name Lang="CS" Text="neporušený" /></code>
<code>  </Item></code>
<code>  <Item ID="{A99658F7-FD21-4F12-B1B8-7159E8C78F34}" ItemType="EnumItem"></code>
<code>    <Name Lang="CS" Text="porušený" /></code>
<code>  </Item></code>
<code></Item></code>
<code><Item ID="{C0D1DD2F-7B85-48DF-B74B-F567CCA865BB}" ItemType="String"></code>
<code>  <Name Lang="CS" Text="Označení vzorku" /></code>
<code>  <Master MasterGUID="{EFEC9E11-6FFD-44B9-9FC8-AC6F1E892461}"></code>
<code>    <Item GUID="{A99658F7-FD21-4F12-B1B8-7159E8C78F34}" /></code>
<code>  </Master></code>
<code></Item></code>
====Data XML definition====
{| class="wikitable"
!Property
!XML
!Description
|-
|Identifier
|<sup>[[Legend of XML elements|[A]]]</sup> STRING <code>ID</code>
|<code>ID</code> can be either a GUID or a unique text identifier corresponding to <code>ID</code> / <code>GUID</code> attribute of Template Item
|}
'''Example of Data XML'''
<code><Item ID="{B1DC392E-0C1A-4016-8B77-1CD25D89DC65}" StrValue="Pokus obsah" /></code>

Latest revision as of 17:03, 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
Special [A] ENUM Special Special type (see Special named data types) required None 2024
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 element is also hidden

(required) < 2024
        Master element GUID         [A] GUID Value (required) < 2024
Master [E] Master Master Named Data Element of type Enum, used to hide input of the current element optional (empty) 2024
    Master enumeration     [E] EnumNesting Master enumeration (required) 2024
        Master element nesting         [A] String Nesting Nesting from the root of Template - GUIDs separated by "|" character e.g. {2C17B508-E9B4-409B-956E-9A516AC1DFFB}|{FE390082-8C4B-4F04-A6FA-49344F03C60C} (required) 2024
    Master elements     [:E:] EnumItem 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 element 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

<Item ID="{2C17B508-E9B4-409B-956E-9A516AC1DFFB}" ItemType="String">

  <Name Lang="CS" Text="Blokující organizace" />

  <Settings Ident="" EmptyText="" UnitNameMetric="" Multiline="false" />

  <Range Unique="false" AllowEmpty="true" MaxLength="0" />

  <Master>

    <EnumNesting Value="{FE390082-8C4B-4F04-A6FA-49344F03C60C}" />

    <EnumItem GUID="{4ACE40EE-735E-4EA9-A7BF-AF9687D6C37C}" />

  </Master>

</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=522"