User Guide

From ECRIN-MDR Wiki
Revision as of 14:33, 13 January 2021 by Admin (talk | contribs) (Created page with "User guide Main page On the images below you can see the main page of the web-portal. The menu is hidden by default, but you can 'pin' it by clicking on necessary icon (see d...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

User guide

Main page On the images below you can see the main page of the web-portal. The menu is hidden by default, but you can 'pin' it by clicking on necessary icon (see details in the 'Menu' section below).

On the main page of the web-portal, you can see the header, the subheader, the search panel, the content area and the footer.

The UI (user interface) is self-explanatory, but by navigating on each icon you'll see a tooltip with a description of each icon or element on the page.




Header

The 'Header' section on our web-portal contains three icons.

The first icon is a 'User guide' icon. By clicking on this icon you'll be redirected to the 'User guide' page, where you can find all necessary and main information about the structure and different components of our web-portal.

The second icon is a 'Language' icon. By clicking on it, you'll see a dropdown list with the languages we support. When you select a language, all User Interface (UI) elements, tooltips and filters will be translated to the selected language. We use the i18n module to implement this functionality.

The third icon is a link to the 'Help page'. There you can find the detailed information on how to use the different types of search we provide on our web-portal.


Subheader

The 'Subheader' section is represented by four icons: 'Upload', 'Download', 'Save as PDF' and 'Clear'. Sometimes you may see, that all or some of these icons are disabled (with a grey background). It means that on the current section of the web-portal these icons are not available. Below you can find a description of all of these icons:

The 'Upload' icon provides a possibility to upload the user's previously downloaded session in a JSON format. The uploaded file must follow our system's data structure, which is used by default, when you download your session. Please, do not modify the JSON file if you want to keep it workable and compatible with our web-portal.


The 'Download' button provides the possibility to download the current filtered user's session in a JSON format. The JSON scheme of this user's session must follow our system's data structure. Please, do not modify the JSON file if you want to keep it workable and compatible with our web-portal.

The 'Save as PDF' button makes it possible to generate and download a PDF file with the current filtered user's session results. For big data sets it takes some time to generate a PDF file, so, please, be patient. Also, you can use this function to download a PDF with the selected study information, when you're on the landing page of the selected study.

The 'Clear' button just removes all fetched results.


The 'Menu' section contains a basic navigation on our web-portal.


By clicking on this button you can pin and unpin the menu. By default it's hidden, unpinned. Filters 'Filters' are one of the core functionalities of the web-portal.


To show the 'Filters' panel (which is hidden by default) you have to click on the filters button on the right of the search button on the search panel of the web-portal.


Once you have clicked on the filters button, the filters panel will be shown. It's hidden by default. The filters panel has 2 sections - with Studies and Data objects filters.



Each filter section contains menus with expandable panels with relevant options. By selecting/deselecting of the different options, selected/deselected filters will be shown/removed from the Active filters panel. Active filters On this panel all deselected filters are displayed.



By clicking on this button (which is on the top right side of the 'Active filters panel') all active filters will be removed.

Start panel You will see this panel once you've entered on the web-portal and after clearing of all the fetched results.



By clicking on this button the uploaded user's session results will be shown. Search panel The 'Search panel' is quite simple and self-explanatory. You can find all detailed information on how to use the different search options in the Help page section.


Content Each record is represented as an expandable panel. The header of the panel contains the study's title. By clicking on the panel, you will see the description of the study and the list of related data objects.


If you want to see more detailed information about a study, you can click on the 'Show study details' button. Once you have clicked on it, the new tab with study information will be opened in your browser.