Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
rdms:metadata:metadatatemplates [2023/09/12 14:54] 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 ====== | ====== 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: | + | As described in the previous sections, every user of the RDMS can easily add metadata to their objects and collections either via the [[rdms: |
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", " | 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", " | ||
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. | 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 118: | Line 118: | ||
==== Examples of Template Usage ==== | ==== 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 '' | + | 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 |
- | For the '' | + | For the example |
++++ Click to display example | | ++++ Click to display example | | ||
- | Entries: | + | |
- | | + | {{ :rdms: |
- | * '' | + | |
- | * '' | + | < |
- | * '' | + | < |
- | | + | Figure 7 |
- | - Last name | + | < |
- | - First name | + | </ |
- | - Affiliation | + | |
- | - Address | + | The template displayed in Figure 7 shows an example where only the basic types are used to create a '' |
- | - Role @ Affiliation | + | |
- | - Role in RDMS | + | {{ :rdms: |
+ | |||
+ | < | ||
+ | < | ||
+ | Figure 8 | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | Then click the drop-down menu and select | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | < | ||
+ | < | ||
+ | Figure 9 | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | Finally, compile the template and confirm your input by clicking on '' | ||
+ | |||
+ | {{ :rdms: | ||
+ | |||
+ | < | ||
+ | < | ||
+ | Figure 10 | ||
+ | < | ||
+ | </ | ||
++++ | ++++ | ||
- | For the use of '' | + | 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 | | ++++ 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 '' |
- | * Instrument name | + | |
- | * Settings | + | {{ :rdms: |
- | * Conditions | + | |
+ | < | ||
+ | < | ||
+ | Figure 11 | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | 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 '' | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | < | ||
+ | < | ||
+ | Figure 12 | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | Finally, we can once again navigate to the object we wish to attach metadata to and right-click it. Select '' | ||
+ | |||
+ | **Note**: | ||
+ | The web portal will display one value more than the minimum for non-mandatory entries. In our case, '' | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | < | ||
+ | < | ||
+ | Figure 13 | ||
+ | < | ||
+ | </ | ||
++++ | ++++ |