Difference between revisions of "Common properties of Named Data"
Petr.Bures (talk | contribs) m |
Petr.Bures (talk | contribs) m |
||
(9 intermediate revisions by the same user not shown) | |||
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 | ||
| | |||
| | | | ||
|- | |- | ||
|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 | |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 | |optional | ||
|(empty) | |(empty) | ||
| | |||
|- | |- | ||
|Item type | |Item type | ||
Line 30: | Line 34: | ||
|required | |required | ||
| | | | ||
| | |||
|- | |||
|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 | |Settings | ||
Line 35: | Line 47: | ||
|Different for each element type | |Different for each element type | ||
|required | |required | ||
| | |||
| | | | ||
|- | |- | ||
Line 42: | Line 55: | ||
|optional | |optional | ||
|(empty) | |(empty) | ||
| | |||
|- | |- | ||
| Read only | | Read only | ||
Line 48: | Line 62: | ||
|optional | |optional | ||
|<code>false</code> | |<code>false</code> | ||
| | |||
|- | |- | ||
|Master | |Master | ||
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Master</code> | |<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 | |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 | |optional | ||
|(empty) | |(empty) | ||
|< 2024 | |||
|- | |- | ||
| Master GUID | | Master GUID | ||
Line 60: | Line 76: | ||
|(required) | |(required) | ||
| | | | ||
|< 2024 | |||
|- | |- | ||
| Master elements | | Master elements | ||
| <sup>[[Legend of XML elements|[:E:]]]</sup> <code>Item</code> | | <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 | | 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 | If the master element is also hidden by this rule, current element is also hidden | ||
|(required) | |(required) | ||
| | | | ||
|< 2024 | |||
|- | |- | ||
| Master element GUID | | Master element GUID | ||
Line 72: | Line 90: | ||
|(required) | |(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 | |||
|- | |||
| Master enumeration | |||
| <sup>[[Legend of XML elements|[E]]]</sup> <code>EnumNesting</code> | |||
|Master enumeration | |||
|(required) | |||
| | |||
|2024 | |||
|- | |||
| Master element nesting | |||
| <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 | |||
|- | |||
| Master elements | |||
| <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 | |||
|- | |||
| Master element GUID | |||
| <sup>[[Legend of XML elements|[A]]]</sup> GUID <code>Value</code> | |||
|(required) | |||
| | |||
|2024 | |||
|- | |- | ||
|Range | |Range | ||
|<sup>[[Legend of XML elements|[E]]]</sup> <code>Range</code> | |<sup>[[Legend of XML elements|[E]]]</sup> <code>Range</code> | ||
| | | | ||
|optional | | optional | ||
| | |||
| | | | ||
|- | |- | ||
Line 82: | Line 138: | ||
| <sup>[[Legend of XML elements|[A]]]</sup> BOOL <code>Unique</code> | | <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 | |Entered data must be unique according to data on same input level - e. g. unique Name in column of table row | ||
|optional | | optional | ||
|<code>false</code> | |<code>false</code> | ||
| | |||
|} | |} | ||
'''Example of Template XML''' | '''Example of Template XML''' | ||
Line 106: | 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==== | ====Data XML definition==== | ||
{| class="wikitable" | {| class="wikitable" |
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" />