Created page with "This is a step-by-step user guide on the ARIS app. It contains information on what each feature does and instructions on how to use them. right|thumb|Logo of the app ==Log in page== The first step to work with ARIS, once the software is properly downloaded, installed and executed (see Installation and Upgrades), is for the user to identify themselves. This is done through the use of a username and password, personal for each individual. Fi..."
This is a step-by-step user guide on the ARIS app. It contains information on what each feature does and instructions on how to use them.
[[Category:User Guide]]
[[File:Image_here.png|right|thumb|Logo of the app]]
<languages/>
==Log in page==
<translate>
The first step to work with ARIS, once the software is properly downloaded, installed and executed (see [[Installation and Upgrades]]), is for the user to identify themselves. This is done through the use of a username and password, personal for each individual.
<!--T:1-->
This is a step-by-step user guide on the ARIS system. It contains information on what each functionality does and instructions on how to use them.
To gain access to the application, the individual's username, unique for every user, must be typed out on the top box, where it is indicated. Then, the password corresponding to the username used must be typed out in the box below. Once all the information is filled in, the ''log in now'' orange button must be pressed, and if the information provided is correct, the screen will show the main page of the app.
<!--T:2-->
==Log in page==
[[File:Main page of the app.png|right|thumb|Main page of the app]]
The first step to work with ARIS, once the software is properly downloaded and installed (see [[Installation and Upgrades|Installation and Upgrades]]), the users have to create each an identity (username and password). Entering these both credentials will allow the access to the software and the screen will show now the main page of the system.
If the username or password is incorrect, a red information box will pop up above the ''log in now'' button.
If the username or password is incorrect, a red information box will pop up above the ''log in now'' button.
[[File:Username_and_password_do_not_match.png|centre|thumb|Username and password do not match]]
<!--T:4-->
It is crucial to remember that the system has three different [[System administration#Roles|roles]] with different and complementary functionalities.
Video
Consequently, at least three users need to exist, one with each different role ''System Administrator'', ''Laboratory Technician'' and ''Laboratory Supervisor''.
==General features==
<!--T:5-->
Since the interface is through a browser, we have all of its typical features.
Among others saving usernames and passwords (some browsers even do it by default).
Notice that in this case, this is not a good practice and should be avoided.
</br>
</br>
===Arrow===
<!--T:6-->
[[File:Arrow.png|left|50px]]
This downward arrow is present when there is a choice between options, instead of needing a written down response. It is also present in the sidebar, where there is more than one action offered.
===Asterisk===
[[File:Asterisk.png|left|50px]]
The red asterisk represents a mandatory field. In other words, if a box contains an asterisk, it must be filled in order to keep doing the desired task. The current action in progress will not conclude until all of the corresponding fields are filled.
===Language===
[[File:Language.png|left|50px]]
With this icon, found in the top right corner of the page, the user is able to change the language of the application depending on their preference. There are currently two options of language for this app; English and Spanish.
===Profile===
[[File:Profile.png|left|50px]]
When clicking on this icon, found in the top right corner of the page, two options will show up. The first, is the log-out option, when pressing on this option, the page will change to the [[#Log in page]], through which the user will be able to change the account they are using.
==Sidebar==
==Sidebar==
Video
[[File:Sidebar.PNG|right|thumb|Sidebar found on the left side of the interface]]
[[File:Sidebar.png|right|thumb|Sidebar found on the left side corner of the app setup]]
The sidebar contains information about the user's account and is a tool to navigate between the different functionalities of the system. </br>
At the very top of the orange sidebar, the software's name is displayed in a bold white font.
The sidebar contains information about the user's account and is a tool for navigation between the different functions of the app. </br>
<!--T:7-->
At the very top of the orange sidebar, the software's name is displayed in a bold white font. When these letters are clicked, the screen changes to the home page display.
[[File:Main page of the app.png|left|200px|thumb|Main page of the app]]
Just below the title, there is a small box that informs the user of the account currently in use, by means of the user's name and role corresponding to this username. </br>
Just below the title, there is a small box that informs the user of the account currently in use, by means of the user's name and role corresponding to this username. </br>
Separated by a line, there is a list of the different functions listed below.
Underneath, there is a list of the different functionalities listed below.
<!--T:8-->
{| class="wikitable" style="margin:auto"
{| class="wikitable" style="margin:auto"
|+ Caption text
|+ Functionalities of the system
|-
|-
! Function !! Description
! Functionality !! Description
|-
|-
| [[Patients]] || Create and edit patients, as well as navigate through the patients list.
| [[Patients|Patients]] [[File:Patients.PNG|25px|right]] || Create and edit patients, as well as navigate through the patients list.
|-
|-
| [[Requests]] || Create and edit requests, as well as different types of search.
| [[Requests|Requests]] [[File:Requests.PNG|25px|right]] || Create and edit requests, as well as different types of search.
|-
|-
| [[Data analysis]] || Basic statistics on the performance of the laboratory.
| [[Data analysis|Data analysis]] [[File:Data_Analysis.PNG|25px|right]] || Basic statistics on the performance of the laboratory.
|-
|-
| [[Configuration]] || Options offered by the system in the different dropboxes of the forms.
| [[Configuration|Configuration]] [[File:Configuration.PNG|25px|right]] || Options offered by the system in the different dropboxes of the forms.
|-
|-
| [[System administration]] || User administration and edition of software parameters.
| [[System administration|System administration]] [[File:System_administration.PNG|25px|right]] || User administration and edition of software parameters.
|-
|-
| [[System information]] || Software version and credits.
| System information [[File:System_Information.PNG|25px|right]] || Software license, version and credits.
|}
|}
Most of these functions have sub actions, accessed through the small downward arrow to the right of the name. To change between actions, simply click on the desired function and the display will change.
<!--T:9-->
Most of these functionalities have subsets of actions that can be accessed through the small downward arrow to the right of the name. To change between actions, simply click on the desired functionality and the display will change.
<!--
<!--T:10-->
==Users==
==General features==
There are four roles within the app, decided by what their tasks consist of in the laboratories. Each role has different actions restricted within the application, chosen due to the tasks they are required to carry out.
; Arrow
:[[File:Arrow.PNG|left|50px]] This downward <u>arrow</u> is present when there is a menu with different options to choose from. The user can filter the options by typing out normally in the box. The options displayed can be manipulated through the [[Configuration|Configuration]] functionality.<BR/>
{| class="wikitable" style="margin:auto"
<!--T:11-->
|+ Caption text
; Asterisk
|-
:[[File:Asterisk.PNG|left|50px]] The red <u>asterisk</u> represents a mandatory field. In other words, if a box contains an asterisk, it must be filled in order to keep doing the desired task. The current action in progress will not conclude until all the corresponding fields are filled.<BR/>
! Role !! Description
|-
<!--T:12-->
| Administrator || Example
; Delete
|-
:[[File:Delete.PNG|left|50px]] This button is generally found in the [[Configuration|Configuration]] functionality. It allows the user to delete predefined instances of the different concepts, such as the regions or locations available in the creation of patients. There are exceptions to this action, the instances of some concepts are not deletable. For example, it is not possible to delete patients, requests or users.<BR/>
| Laboratory Supervisor|| Example
|-
<!--T:13-->
| Laboratory Technician|| Example
; Editing
|-
:In general, there is not any icon associated to the edition of elements. By simply clinking on the corresponding row, its details are displayed. These are then editable, except in the case of patients, that are read-only until a button to enable modifications is pressed.<BR/>
| System administrator || Example
|}
-->
<!--T:14-->
:[[File:Patientinfo.PNG|left|50px]] The exception to this rule is the details of a test. In this case, this icon corresponds to the possibility of showing and potentially changing the results and notes of the test, as well as more information about the corresponding sample. This happens in the ''Analytical tests'' tab reached through either [[Requests#Introduce results|Introduce results]], [[Requests#Validate results|Validate results]] or [[Requests#Search historic|Historical requests]].<BR/>
<!--T:15-->
; Search bar
:[[File:Searchpatients.PNG|centre|750px]] There is a search box at the top of most of the forms that contain tables with lists of elements, like the [[Patients#Search and Edition|''search patients'']] or [[Requests#Create|''create requests'']] tabs. This search box allows the user to filter by different fields like name, phone, health facility ID, creation date or last modification date. To choose one of these, the user must click on the downwards arrow found to the right of ''search field'' and pick the desired field (this possibility is not available if the table contains only one column to be searched). Once the field is chosen, the user can type out the information corresponding to the search field in the box on the left.<BR/>
<!--T:16-->
:There is a system parameter that establishes the minimum number of elements required for the search box to be shown (i.e., tables with a small number of elements may not require a search functionality).
<!--T:17-->
; Locked item
:[[File:Lock.PNG|left|50px]] This icon appears attached to elements of a list that cannot be directly selected or deselected. This happens with groups of tests or profiles. Thus, choosing a group of tests does not allow removing any of its components, as they are an indivisible set.<BR/>
==Navigation bar== <!--T:18-->
<!--T:19-->
; Language
[[File:Language1.PNG|left|50px]]
:The <u>language</u> in use is displayed in the top right corner of the page, the user is able to change it depending on their preference by clicking on the text and choosing the language desired. There are currently two options of language for the system; English and Spanish.
<!--T:20-->
; Profile
[[File:Profile.PNG|left|50px]]
:When clicking on this icon, found in the top right corner of the page, two options will show up. The first, is the <u>log-out</u> option, when pressing on this option, the page will change to the [[#Log in page|log in]] page, through which the user will be able to change the account they are using. The second icon, called <u>change password</u>, when clicked will produce a pop-up window where the user might change their password.
:; ''Change password''
::There are two ways of changing the password associated with the username:
::# The password can be changed by the user. All they have to do is press on the [[#Navigation bar|profile]] icon, click on change password, and a screen will come up with the title '''Change password'''. Next, the user must just fill in the required boxes with their current password, their desired password and, finally, confirm their new password.
::# Another method to change the password would involve accessing the [[System administration|system administration]] functionality and going to the [[System administration#Users|users]] tab. Once in this tab, the administrator can choose any other user, and click on edit user. Then, at the bottom of the page, the administrator can find two non-obligatory fields named ''password'' and ''repeat password''. These must be filled in order to change the password.
<!--T:21-->
; Bluetooth (not visible by default)
[[File:Bluetooth.PNG|left|50px]]
:By default, this icon is hidden, because most laboratories are not going to use this functionality (only those participating in the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]).
To make it visible, the value of the corresponding system parameter needs to be modified.
For this, a ''System Administrator'' needs to log in and go to [[System_administration#Parameters|Parameters]].
There, they need to set 'bluetooth_enabler' to ''Enable''.
This will make the icon visible to all 'Laboratory Technicians'.
<!--T:22-->
:When a ''Laboratory Technician'' clicks this icon, the system will enable the [[Bluetooth|Bluetooth connection]] of the system, and the users will be able to connect their mobile device to ARIS. This capability is used to transfer images from the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App] in case of automatic tests. When Bluetooth is active, the icon will turn orange. From the moment the icon is orange, all the behaviour is managed from the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App] (i.e., from ARIS interface, you can only enable or disable the Bluetooth and everything happens in the background). On clicking again, the feature will be disabled and the icon will be grey.
The first step to work with ARIS, once the software is properly downloaded and installed (see Installation and Upgrades), the users have to create each an identity (username and password). Entering these both credentials will allow the access to the software and the screen will show now the main page of the system.
If the username or password is incorrect, a red information box will pop up above the log in now button.
It is crucial to remember that the system has three different roles with different and complementary functionalities.
Consequently, at least three users need to exist, one with each different role System Administrator, Laboratory Technician and Laboratory Supervisor.
Since the interface is through a browser, we have all of its typical features.
Among others saving usernames and passwords (some browsers even do it by default).
Notice that in this case, this is not a good practice and should be avoided.
The sidebar contains information about the user's account and is a tool to navigate between the different functionalities of the system.
At the very top of the orange sidebar, the software's name is displayed in a bold white font.
Just below the title, there is a small box that informs the user of the account currently in use, by means of the user's name and role corresponding to this username.
Underneath, there is a list of the different functionalities listed below.
User administration and edition of software parameters.
System information
Software license, version and credits.
Most of these functionalities have subsets of actions that can be accessed through the small downward arrow to the right of the name. To change between actions, simply click on the desired functionality and the display will change.
This downward arrow is present when there is a menu with different options to choose from. The user can filter the options by typing out normally in the box. The options displayed can be manipulated through the Configuration functionality.
Asterisk
The red asterisk represents a mandatory field. In other words, if a box contains an asterisk, it must be filled in order to keep doing the desired task. The current action in progress will not conclude until all the corresponding fields are filled.
Delete
This button is generally found in the Configuration functionality. It allows the user to delete predefined instances of the different concepts, such as the regions or locations available in the creation of patients. There are exceptions to this action, the instances of some concepts are not deletable. For example, it is not possible to delete patients, requests or users.
Editing
In general, there is not any icon associated to the edition of elements. By simply clinking on the corresponding row, its details are displayed. These are then editable, except in the case of patients, that are read-only until a button to enable modifications is pressed.
The exception to this rule is the details of a test. In this case, this icon corresponds to the possibility of showing and potentially changing the results and notes of the test, as well as more information about the corresponding sample. This happens in the Analytical tests tab reached through either Introduce results, Validate results or Historical requests.
Search bar
There is a search box at the top of most of the forms that contain tables with lists of elements, like the search patients or create requests tabs. This search box allows the user to filter by different fields like name, phone, health facility ID, creation date or last modification date. To choose one of these, the user must click on the downwards arrow found to the right of search field and pick the desired field (this possibility is not available if the table contains only one column to be searched). Once the field is chosen, the user can type out the information corresponding to the search field in the box on the left.
There is a system parameter that establishes the minimum number of elements required for the search box to be shown (i.e., tables with a small number of elements may not require a search functionality).
Locked item
This icon appears attached to elements of a list that cannot be directly selected or deselected. This happens with groups of tests or profiles. Thus, choosing a group of tests does not allow removing any of its components, as they are an indivisible set.
The language in use is displayed in the top right corner of the page, the user is able to change it depending on their preference by clicking on the text and choosing the language desired. There are currently two options of language for the system; English and Spanish.
Profile
When clicking on this icon, found in the top right corner of the page, two options will show up. The first, is the log-out option, when pressing on this option, the page will change to the log in page, through which the user will be able to change the account they are using. The second icon, called change password, when clicked will produce a pop-up window where the user might change their password.
Change password
There are two ways of changing the password associated with the username:
The password can be changed by the user. All they have to do is press on the profile icon, click on change password, and a screen will come up with the title Change password. Next, the user must just fill in the required boxes with their current password, their desired password and, finally, confirm their new password.
Another method to change the password would involve accessing the system administration functionality and going to the users tab. Once in this tab, the administrator can choose any other user, and click on edit user. Then, at the bottom of the page, the administrator can find two non-obligatory fields named password and repeat password. These must be filled in order to change the password.
Bluetooth (not visible by default)
By default, this icon is hidden, because most laboratories are not going to use this functionality (only those participating in the IMAGING project).
To make it visible, the value of the corresponding system parameter needs to be modified.
For this, a System Administrator needs to log in and go to Parameters.
There, they need to set 'bluetooth_enabler' to Enable.
This will make the icon visible to all 'Laboratory Technicians'.
When a Laboratory Technician clicks this icon, the system will enable the Bluetooth connection of the system, and the users will be able to connect their mobile device to ARIS. This capability is used to transfer images from the Mobile App in case of automatic tests. When Bluetooth is active, the icon will turn orange. From the moment the icon is orange, all the behaviour is managed from the Mobile App (i.e., from ARIS interface, you can only enable or disable the Bluetooth and everything happens in the background). On clicking again, the feature will be disabled and the icon will be grey.
