doc/UserGuide/src/200_GeneralFunctions.adoc

== The openMDM Web Client

=== Structure

The openMDM web client the graphical user interface for the openMDM application. If you start the client, you get the following view:

image::structure_client.png[title="openMDM web client",float="center"]

*Elements*:

- _Menu bar_: Menus for language In this section general, About and Login / Logout, see  
<<general_functions, this section>>.
There is also the Administration menu, see <<admin_function, this section>>.

- _Navigator_: Navigation in the openMDM data structures (e.g. project, pool, test, teststep, etc.), see <<navigator, this section>>.
- Data Area: +
In this area all data related functions can be found. These functions are divided into five tabs: 
.. _Details_: The Metadata for a selected node in the Navigator are shown, see <<detail_viewer, this section>>.
.. _MDM Search_: Different kinds of search are available like full text search, advanced search (attribute based), defining search filters and a result view, see <<search, this section>>.
.. _Qick Viewer_: A simple X/Y ChartViewer to visualize the data of a measurement, see <<quick_viewer, this section>>.
.. _X/Y ChartViewer_: A more sophisticated viewer that can represent the data of a measurement in different views, see <<xychart_viewer, this section>>.
.. _Files_: Upload new files and/or download, update, preview or delete existing files, see <<export_files, this section>>.


NOTE: The openMDM5 main elements are written in _italic font_ in this document.

=== Roles

For the web client three different roles for users are available:

* _DescriptiveDataAuthor_: users in this role can view, edit and update data. We denote users in this role just as _user_.
* _Admin_: additional rights for configuring / customize the web client for all users. See <<admin_function, here>>.
* _Guest_: restricted to read only. 

NOTE: When we talk about admin / administration in this document, we mean users in the _Admin_ role. There are further configuration options, that can be only done on server side, we refer to this as _system administration_.


[[general_functions]]
== General Functions and Common Controls

In this section general functions from the _Menu Bar_ are described, also common control elements and buttons that are used.

=== Login

A user name and password are required to log in to the openMDM Application. The user name and password is the same as for the related ASAM ODS user. Please ask your administrator when you aren't able to connect to the system.

image::login.png[title="openMDM5 login"]

After successful login, the start page of the openMDM5 Web Client appears.

NOTE: It is possible to include single-sign-on functionality to the openMDM5 application. Please ask your administrator for this feature.

=== Logout

Logging out will end all of your ASAM ODS user sessions / connections.

=== Language

Select a language for text and labels. Currently available languages are English and German (Deutsch).
New languages can be defined and added by the system administration.

=== About

All necessary legal information for the open source software is listed, this includes: Trademarks, Copyright, Declared Project Licenses, Source Code location, Third-party Content and Cryptography.

=== Control elements
image::hide.png[float="left"]
**Hide element**

To hide the associated element.

image::show.png[float="left"]
**Open element**

To open / show the associated element.

=== Buttons

image::refresh.png[float="left"]
**Refresh**

To refresh the actually selected element.

image::copyLink.png[float="left"]
**Copy link**

To copy the link of actually selected element.

image::shoppingBasket_logo.png[float="left"]
image::shoppingBasket_logo2.png[float="left"]
**Shopping Basket**

To add the selection to the _Shopping Basket_.

image::edit.png[float="left"]
**Edit**

To edit the associated attributes.

image::save.png[float="left"]
**Save**

To save the associated changed/edited component. It can be a view or a filter or the _Shopping Basket_.

image::delete.png[float="left"]
**Delete**

To delete selected or associated component.

image::clear.png[float="left"]
**Clear**

To reset changed/edited components (search conditions), or clear components (search results, _Shopping Basket_).

image::download.png[float="left"]
image::downloadWithCondition.png[float="left"]
**Download and download with options**

To download the selected component. Some components have many options for download.

image::upload.png[float="left"]
**Upload**

To upload the selected component (file, _Shopping Basket_).

image::open.png[float="left"]
**Open**

To open the associated component.

image::link.png[float="left"]
image::unlink.png[float="left"]
**Link and unlink**

To link or unlink the selected component to the associated component.