Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
rdms:metadata:metadatawebportal [2024/09/09 08:35] – changed images to direct link giuliordms:metadata:metadatawebportal [2026/05/20 07:07] (current) – [Delete Metadata in the Web Portal] burcu
Line 1: Line 1:
-====== Metadata Management via the Web Portal ======+====== Metadata Management via the Web Interface ======
  
-Using the [[https://research.web.rug.nl/rdmswebapp/rdms.login.page?next=/rdmswebapp/|web portal]] you will have access to basic metadata functionality using a GUI. Specifically, you will be able to create, read, update, and delete (CRUD) metadata attached to your data. The web portal also allows for more complex handling of your metadata, but we will describe this in a different section when we talk about [[rdms:metadata:metadatatemplates|metadata templates]]. Below we show the data browser of the web portal and where you can see the metadata generated by the system. +Using the [[https://research.web.rug.nl/rdmswebapp/rdms.login.page?next=/rdmswebapp/|web interface]]you will have access to basic metadata functionality using a GUI. Specifically, you will be able to create, read, update, and delete (CRUD) metadata attached to your data. The web portal also allows for more complex handling of your metadata, but we will describe this in a different section when we talk about [[rdms:metadata:metadatatemplates|metadata templates]]. Belowwe show the data browser of the web portalwhere you can see the metadata generated by the system. 
  
 {{ :rdms:webapp:meta_crud_0.png?direct&800 |}} {{ :rdms:webapp:meta_crud_0.png?direct&800 |}}
  
-==== Create Metadata in the Web Portal====+==== Create Metadata in the Web Interface ====
 <hidden> <hidden>
-When you first upload a file to the RDMS, all the metadata attached to it will be related to system information, such as upload time and file size, as shown above. You can easily attach new metadata to your data by right-clicking the object or collection you wish to add metadata to and then selecting ''Add Metadata''. If you click any of the {{:rdms:webapp:interface_info_button.png?direct&20|}} icons highlighted in the screenshot below, the web portal will open a side menu containing all information about the selected data. There you can easily check what metadata is already attached to the data you selected, as described in the [[https://wiki.hpc.rug.nl/rdms/metadata/metadatawebportal#read_metadata|Read Metadata section]].+When you first upload a file to the RDMS, all the metadata attached to it will be related to system information, such as upload time and file size, as shown above. You can easily attach new metadata to your data by right-clicking the object or collection you wish to add metadata to and then selecting ''Add Metadata''. If you click any of the {{:rdms:webapp:interface_info_button.png?direct&20|}} icons highlighted in the screenshot below, the web portal will open a side menu containing all information about the selected data. Thereyou can easily check what metadata is already attached to the data you selected, as described in the [[https://wiki.hpc.rug.nl/rdms/metadata/metadatawebportal#read_metadata|Read Metadata section]].
  
 {{ :rdms:webapp:meta_crud_1.png?direct&800 |}} {{ :rdms:webapp:meta_crud_1.png?direct&800 |}}
  
-Once you select ''Add Metadata'', the menu on the left will open as shown below. This way of inserting metadata is very much free form. The red boxes are mandatory, whereas the blue box can be used to provide additional information that did not fit into the ''Value*'' box. The ''Name*'' box is your metadata tag or label, while the ''Value*'' box is the value you are inputting for the tag. This value can be text, as shown in the example, or it can be numerical. Once again, this method of inputting metadata is free form and the decision of what the different values are is entirely up to you. Of course, the input for ''Extra Value'' can also be a string or numerical.+Once you select ''Add Metadata'', the menu on the left will open as shown below. This way of inserting metadata is very much free-form. The red boxes are mandatory, whereas the blue box can be used to provide additional information that did not fit into the ''Value*'' box. The ''Name*'' box is your metadata tag or label, while the ''Value*'' box is the value you are inputting for the tag. This value can be text, as shown in the example, or it can be numerical. Once again, this method of inputting metadata is free-formand the decision of what the different values are is entirely up to you. Of course, the input for ''Extra Value'' can also be a string or a number.
  
 An example of the usage of the three different fields could be: An example of the usage of the three different fields could be:
Line 35: Line 35:
  
  
-==== Read Metadata in the Web Portal ====+==== Read Metadata in the Web Interface ====
 <hidden> <hidden>
-Once you created metadata related to your data, you will always be able to display that information by clicking on the {{:rdms:webapp:interface_info_button.png?direct&20|}} icon next to the respective entry in the web portal. In the screenshot below, clicking on the icon in the red box will display the metadata for the selected object, while clicking on the icon in the blue box will display the information of the current collection, in this case the user's home collection. +Once you have created metadata related to your data, you will always be able to display that information by clicking on the {{:rdms:webapp:interface_info_button.png?direct&20|}} icon next to the respective entry in the web portal. In the screenshot below, clicking on the icon in the red box will display the metadata for the selected object, while clicking on the icon in the blue box will display the information of the current collection, in this casethe user's home collection. 
  
 {{ :rdms:webapp:meta_crud_4.png?direct&800 |}} {{ :rdms:webapp:meta_crud_4.png?direct&800 |}}
Line 49: Line 49:
 </hidden> </hidden>
  
-==== Update Metadata in the Web Portal ====+==== Update Metadata in the Web Interface ====
 <hidden> <hidden>
 Whether it be because you do not always have all the details related to certain data at the time of its storage in the RDMS or because you spot an error, you can change or update metadata you attached to an object or collection in the way described below.  Whether it be because you do not always have all the details related to certain data at the time of its storage in the RDMS or because you spot an error, you can change or update metadata you attached to an object or collection in the way described below. 
Line 57: Line 57:
 {{ :rdms:webapp:meta_crud_6.png?direct&800 |}} {{ :rdms:webapp:meta_crud_6.png?direct&800 |}}
  
-This will open up a window similar to the window you would get when adding metadata for the first time, as displayed below. Make the desired changes, then click the blue ''Add/Edit metadata'' button to save your changes. The window will close and the system will then reload the right-side menu and display updated metadata.+This will open up a window similar to the window you would get when adding metadata for the first time, as displayed below. Make the desired changes, then click the blue ''Add/Edit metadata'' button to save your changes. The window will closeand the system will then reload the right-side menu and display updated metadata.
  
 {{ :rdms:webapp:meta_crud_7.png?direct&800 |}} {{ :rdms:webapp:meta_crud_7.png?direct&800 |}}
 </hidden> </hidden>
  
-==== Delete Metadata in the Web Portal ====+==== Delete Metadata in the Web Interface ====
 <hidden> <hidden>
-During your data's life cycle, errors can occur or metadata tags can become irrelevant. For those cases, you can easily delete a metadata tag by selecting the {{:rdms:webapp:interface_info_button.png?direct&20|}} icon once again and clicking on the {{:rdms:webapp:delete_icon.png?direct&30|}} button next to a metadata entry in the metadata tab in the right-side window. +During your data's life cycle, errors can occuror metadata tags can become irrelevant. For those cases, you can easily delete a metadata tag by selecting the {{:rdms:webapp:interface_info_button.png?direct&20|}} icon once again and clicking on the {{:rdms:webapp:delete_icon.png?direct&30|}} button next to a metadata entry in the metadata tab in the right-side window. 
  
 {{ :rdms:webapp:meta_crud_8.png?direct&800 |}} {{ :rdms:webapp:meta_crud_8.png?direct&800 |}}
Line 75: Line 75:
 ===== Automatic Extraction of Metadata ===== ===== Automatic Extraction of Metadata =====
  
-What we described above is the functionality of the web portal to let the user add metadata entries by hand. However, there are files which require a large amount of metadata to be properly described. Such data often has the information needed to describe  stored as metadata in their file header. The web portal offers the user the possibility to extract and import the metadata contained in the file header directly into the RDMS. +What we described above is the functionality of the web portal to let the user add metadata entries by hand. However, there are files that require a large amount of metadata to be properly described. Such data often has the information needed to describe the stored data as metadata in its file header. The web portal offers the user the possibility to extract and import the metadata contained in the file header directly into the RDMS. 
  
 To access this functionality, right-click the file you wish to extract metadata from, then scroll down the menu to ''Extract metadata''. To access this functionality, right-click the file you wish to extract metadata from, then scroll down the menu to ''Extract metadata''.
Line 89: Line 89:
 ==== Supported File Formats for automated Metadata Extraction ==== ==== Supported File Formats for automated Metadata Extraction ====
  
-Below you can find the list of file extension for which automatic extraction is supported: +Below you can find the list of file extensions for which automatic extraction is supported: 
  
   *    ''.dcm'' , ''.dcm30'': DICOM (Digital Imaging and Communications in Medicine) images (dicomstandard.org)   *    ''.dcm'' , ''.dcm30'': DICOM (Digital Imaging and Communications in Medicine) images (dicomstandard.org)
Line 109: Line 109:
 Metadata can also be imported from a local file using the web portal. The ''Name'', ''Value'', and ''Extra Value'' are called AVUs for  Attribute, Value, Unit combinations in this context. AVUs are defined in a so-called JSON structure as a ''.txt'' file or a ''.json'' file. Multiple AVUs can be added at once with this approach.  Metadata can also be imported from a local file using the web portal. The ''Name'', ''Value'', and ''Extra Value'' are called AVUs for  Attribute, Value, Unit combinations in this context. AVUs are defined in a so-called JSON structure as a ''.txt'' file or a ''.json'' file. Multiple AVUs can be added at once with this approach. 
  
-The structure of the file should be as followed:+The structure of the file should be as follows:
 <code> <code>
 [ [
Line 127: Line 127:
 </code> </code>
  
-Metadata from a local file can be added to both collections and objects by right clicking the target of interest and selecting the ''Load metadata'' option.+Metadata from a local file can be added to both collections and objects by right-clicking the target of interest and selecting the ''Load metadata'' option.
  
 {{ :rdms:metadata:import_1_new.png?direct&800 |}} {{ :rdms:metadata:import_1_new.png?direct&800 |}}
  
-Upon selecting a file with AVUs in a JSON structure as indicated above, the metadata is automatically recognized and can be added by selecting the ''Load metadata'' button. In this example a .txt file was used. **Please note that multiple AVUs can be added at once.**+Upon selecting a file with AVUs in a JSON structure as indicated above, the metadata is automatically recognized and can be added by selecting the ''Load metadata'' button. In this examplea .txt file was used. **Please note that multiple AVUs can be added at once.**
  
 {{ :rdms:metadata:import_2_new.png?direct&800 |}} {{ :rdms:metadata:import_2_new.png?direct&800 |}}
  
-Upon loading the AVU file the metadata is displayed for the selected data.+Upon loading the AVU filethe metadata is displayed for the selected data.
  
 {{ :rdms:metadata:import_3_new.png?direct&800 |}} {{ :rdms:metadata:import_3_new.png?direct&800 |}}