Differences

This shows you the differences between two versions of the page.

--- rdms:metadata:metadatatemplates [2023/09/12 14:52]
giulio [How to Create Metadata Types]
+++ rdms:metadata:metadatatemplates [2023/09/13 11:11] (current)
jelte WebApp to web portal (consistency)
@@ Line 1: / Line 1: @@
 ====== Metadata Templates ======
-As described in the previous sections, every user of the RDMS can easily add metadata to their objects and collections either via the [[rdms:metadata:metadatawebportal|functionality in the WebApp]] or using [[rdms:metadata:cli|iCommands]]. Described here is another functionality of the web portal related to metadata management: the use of metadata templates.\\
+As described in the previous sections, every user of the RDMS can easily add metadata to their objects and collections either via the [[rdms:metadata:metadatawebportal|functionality in the web portal]] or using [[rdms:metadata:cli|iCommands]]. Described here is another functionality of the web portal related to metadata management: the use of metadata templates.\\
 As the name suggests, metadata templates are pre-configured metadata entry forms that the user can define in order to have **a consistent way of recording metadata** for a given data object or collection. For example, you could have a template attached to a collection recording the "Name of the PI", "Starting date", "Publication state", "Funding agency", etc. Such a template could be used to record information on the projects of a research group, such that the same information is always reliably recorded. Another example would be a template attached to a data object recording the "Acquisition method", "Instrument used", "Temperature", "Humidity", "Reagents", "Researcher responsible", or other values. Such a template could be used to record the instrument settings used to obtain the data object.\\
 The advantage of a template over manual entry of metadata is that the user has a pre-defined list of entries. This reduces the risk of forgetting to record a given value or to have objects with different metadata entries, even though they should have been matching.
@@ Line 53: / Line 53: @@
 The user-created metadata types are as follows:
-</hidden>
+<hidden>
-++++ Click to display section |
 The ''Simple metadata type'' is the standard entry type and closely resembles the kind of entry you can have when manually inputting your metadata. It can, however, be slightly more detailed than a simple blank field. In fact, the ''simple type'' can be used to restrict possible values in the templates you create, such as introducing a minimum or a maximum value, or to restrict which values you can choose by creating a drop-down list.
@@ Line 94: / Line 94: @@
 The second sub-part we call ''Element'' and it is an entry that can be characterized by a ''Complex Type'' or a ''Simple Type''. Contrary to an ''Attribute'', this type of entry can have a minimum number of occurrences or a maximum number of them. Ultimately, we would suggest you use ''Attributes'', unless the use of ''Elements'' is required.
-++++
+</hidden>
-</>
 ===== How to Create Metadata Templates =====
@@ Line 119: / Line 118: @@
 ==== Examples of Template Usage ====
-Metadata templates can be used to record many different things about your data and the way you use them is ultimately up to you. We give two brief examples of how to set up a template using both ''Simple'' and ''Complex Metadata Types''.
+Metadata templates can be used to record many different things about your data and the way you use them is ultimately up to you. We give two brief examples of how to set up a template using both the standard and user-defined types.
-For the ''Simple'' example, we want to attach metadata to a collection in order to record all the collaborators that worked on that project. Remember, you can always do this by manually inputting all the metadata fields yourself, but a template makes this part of the data management so much easier.
+For the example using the standard types, we want to attach metadata to a collection in order to record all the collaborators that worked on that project. Remember, you can always do this by manually inputting all the metadata fields yourself, but a template makes this part of the data management so much easier.
 ++++ Click to display example |
-Entries:
-  * ''Name*'': Collaborator_Template
+{{ :rdms:metadata:meta_webtemplate_7.png?direct&800 |}}
-  * ''Description'': Metadata recording the collaborators working on the project.
-  * ''Visibility*'': Public
+<html>
-  * ''Template Version'': 1.0
+<center></html>
-  * ''Elements'':
+Figure 7
-  - Last name
+<html>
-  - First name
+</center></html>
-  - Affiliation
-  - Address
+The template displayed in Figure 7 shows an example where only the basic types are used to create a ''Metadata Template''. To compile this template and attach metadata to a collection, right-click the collection and click ''Add metadata template'' in the menu that will appear (see Figure 8).
-  - Role @ Affiliation
-  - Role in RDMS
+{{ :rdms:metadata:meta_webtemplate_8.png?direct&800 |}}
+<html>
+<center></html>
+Figure 8
+<html>
+</center></html>
+Then click the drop-down menu and select the template you wish to compile, as shown in Figure 9.
+{{ :rdms:metadata:meta_webtemplate_9.png?direct&800 |}}
+<html>
+<center></html>
+Figure 9
+<html>
+</center></html>
+Finally, compile the template and confirm your input by clicking on ''Submit'' (at the bottom of your template) to attach the metadata to your collection (see Figure 10).
+{{ :rdms:metadata:meta_webtemplate_10.png?direct&800 |}}
+<html>
+<center></html>
+Figure 10
+<html>
+</center></html>
 ++++
-For the use of ''Complex Types'' in the creation of a template, we want to create a metadata entry that records what instrument was used to record a certain set of data. We also want to record the instrument settings and put restrictions on certain fields. We also want to make sure that certain metadata entries are always recorded when this specific template is used.
+For the use of user-defined types in the creation of a template, we want to create a metadata entry that records what instrument was used to record a certain set of data. We also want to record the instrument settings and put restrictions on certain fields. We also want to make sure that certain metadata entries are always recorded when this specific template is used.
 ++++ Click to display example |
-Entries:
+First we need to create a user-defined type to select our instrument from. Figure 11 shows how to create a ''Simple Type'' that will result in a drop-down menu with three options.
-  * Instrument name
-  * Settings
+{{ :rdms:metadata:meta_webtemplate_11.png?direct&800 |}}
-  * Conditions
+<html>
+<center></html>
+Figure 11
+<html>
+</center></html>
+Next, we need to create our template. Figure 12 shows how to do so, while using our own type for the choice of instrument. Please also notice that we restrict the input of all our variables to just one entry, except for the ''Researcher present'' variable, where we allow for up to five entries. The restriction can be applied either by specifying the number of ''Minimum number of Occurrences'' and ''Maximum number of Occurrences'', or by simply leaving the fields blank. Leaving the fields blank will not make the entry mandatory, however.
+{{ :rdms:metadata:meta_webtemplate_12.png?direct&800 |}}
+<html>
+<center></html>
+Figure 12
+<html>
+</center></html>
+Finally, we can once again navigate to the object we wish to attach metadata to and right-click it. Select ''Add metadata template'' in the menu, as for the previous example, then select the template you want to use. Figure 13 shows how the ''Instrument*'' value, now mandatory because of our restrictions, appears as a drop down menu from which you can select the instrument your data has been generated by. The ''Researcher present'' value will also appear five times in this template, starting from ''Researcher present 0'' and going to ''Researcher present 4''.
+**Note**:\\
+The web portal will display one value more than the minimum for non-mandatory entries. In our case, ''Researcher present 0'' and ''Researcher present 1'' are immediately displayed in the input form. Instead, ''Researcher 2'', ''Researcher 3'', and ''Researcher 4'' will appear only if the previous fields are filled out, the form saved and then edited again.
+{{ :rdms:metadata:meta_webtemplate_13.png?direct&800 |}}
+<html>
+<center></html>
+Figure 13
+<html>
+</center></html>
 ++++