User Guide/en - Revision history

FuzzyBot: Updating to match new version of source page

2025-05-08T07:20:07Z

Updating to match new version of source page

← Older revision		Revision as of 09:20, 8 May 2025
Line 1:		Line 1:
	[[Category:User Guide]]		[[Category:User Guide]]
	<languages/>		<languages/>

	~~[[Category:Printed Manual]]~~

	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.		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.
	<div style="float:right; margin: 0px 0px 0px 0px">		<div style="float:right; margin: 0px 0px 0px 0px">

FuzzyBot: Updating to match new version of source page

2025-05-08T06:53:59Z

Updating to match new version of source page

← Older revision		Revision as of 08:53, 8 May 2025
Line 1:		Line 1:
	[[Category:User Guide]]		[[Category:User Guide]]
	<languages/>		<languages/>

			[[Category:Printed Manual]]

	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.		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.
	<div style="float:right; margin: 0px 0px 0px 0px">		<div style="float:right; margin: 0px 0px 0px 0px">

FuzzyBot: Updating to match new version of source page

2024-09-06T10:15:45Z

Updating to match new version of source page

← Older revision		Revision as of 12:15, 6 September 2024
Line 89:		Line 89:
	==General features==		==General features==
	; Arrow		; 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 ~~writing down~~ normally in the box. The options displayed can be manipulated through the [[Configuration\|Configuration]] functionality.		:[[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/>

	; Asterisk		; 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 of the corresponding fields are filled.		:[[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/>

	; Delete		; Delete
	:[[File:Delete.PNG\|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, ~~for instance. Not~~ instances of ~~every concept~~ are deletable. For example, it is not possible to delete patients, requests or users.		:[[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/>

	; Editing		; Editing
	:In general, there is not any icon associated to 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.		: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/>

	:[[File:Patientinfo.PNG\|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 at either [[Requests#Introduce results\|Introduce results]], [[Requests#Validate results\|Validate results]]~~, as well as the~~ [[Requests#Search historic\|Historical requests]].
			:[[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/>

	; Search bar		; 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 the information corresponding to the search field in the box on the left.		:[[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/>

	: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).		: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		; Locked item
	:[[File:Lock.PNG\|50px]] This icon appears attached to elements of a list that cannot be directly selected or deselected. This happens ~~whit~~ groups of tests or profiles. Thus, choosing a group of tests does not allow ~~to remove~~ any of its components, as they are an indivisible set.		:[[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==		==Navigation bar==
Line 118:		Line 119:
	; Profile		; Profile
	[[File:Profile.PNG\|left\|50px]]		[[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> will produce a pop-up window ~~when clicked,~~ where the user might change their password.		: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''		:; ''Change password''
	::There are two ways of changing the password associated with the username.		::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, ~~repeat~~ their new password.		::# 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 ~~user~~ can choose ~~a patient~~, and click on edit ~~patient~~. Then, at the bottom of the page, the ~~user is able to~~ find two non-obligatory fields named ''password'' and ''repeat password''. These must be filled in order to change the 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.

	; Bluetooth (not visible by default)		; Bluetooth (not visible by default)
Line 129:		Line 130:
	To make it visible, the value of the corresponding system parameter needs to be modified.		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]].		For this, a ''System Administrator'' needs to log in and go to [[System_administration#Parameters\|Parameters]].
	There, ~~s/he needs~~ to set 'bluetooth_enabler' to ''Enable''.		There, they need to set 'bluetooth_enabler' to ''Enable''.
	This will make the icon visible to all 'Laboratory ~~Technitians~~'.		This will make the icon visible to all 'Laboratory Technicians'.

	:When a ''Laboratory ~~Technitian~~'' 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. From the moment the icon is orange, all the ~~behavior~~ 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)~~. When Bluetooth is active, the icon will turn orange~~. On clicking again, the feature will be disabled and the icon will be grey.		: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.

FuzzyBot: Updating to match new version of source page

2024-01-31T17:16:20Z

Updating to match new version of source page

← Older revision		Revision as of 19:16, 31 January 2024
Line 41:		Line 41:
	</graphviz>		</graphviz>
	</div>		</div>
	~~__TOC__~~

	~~<div lang="en" dir="ltr" class="mw-content-ltr">~~
	__TOC__		__TOC__
	~~</div>~~

	==Log in page==		==Log in page==
	[[File:Login_-_Made_with_Clipchamp.mp4\|right\|500px]]		[[File:Login_-_Made_with_Clipchamp.mp4\|right\|500px]]

FuzzyBot: Updating to match new version of source page

2024-01-23T08:47:00Z

Updating to match new version of source page

New page

[[Category:User Guide]]
<languages/>
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.
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph FunctionalitiesDiagram {
node [shape="oval" style=filled fillcolor="orange" fontsize="9pt"];
//----- Main graph
// Nodes
ARIS [label="ARIS"];
//----- Patients graph
// Nodes
Patients [label="Patients" URL="[[Patients]]"];
// Edges
ARIS -> Patients;
//----- Requests graph
// Nodes
Requests [label="Requests" URL="[[Requests]]"];
// Edges
ARIS -> Requests;
//----- Data Analysis graph
// Nodes
DataAnalysis [label="Data Analysis" URL="[[Data_analysis]]"];
// Edges
ARIS -> DataAnalysis;
//----- Configuration graph
// Nodes
Configuration [label="Configuration" URL="[[Configuration]]"];
// Edges
ARIS -> Configuration;
//----- System Administration graph
// Nodes
SystemAdministration [label="System Administration" URL="[[System_administration]]"];
// Edges
ARIS -> SystemAdministration;
//----- System Information graph
// Nodes
SystemInformation [label="System Information"];
// Edges
ARIS -> SystemInformation;}
</graphviz>
</div>
__TOC__

<div lang="en" dir="ltr" class="mw-content-ltr">
__TOC__
</div>

==Log in page==
[[File:Login_-_Made_with_Clipchamp.mp4|right|500px]]

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.

It is crucial to remember that the system has three different [[System administration#Roles|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.
</br>
</br>

==Sidebar==
[[File:Sidebar.PNG|right|thumb|Sidebar found on the left side of the interface]]
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.

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>
Underneath, there is a list of the different functionalities listed below.

{| class="wikitable" style="margin:auto"
|+ Functionalities of the system
|-
! Functionality !! Description
|-
| [[Patients|Patients]] [[File:Patients.PNG|25px|right]] || Create and edit patients, as well as navigate through the patients list.
|-
| [[Requests|Requests]] [[File:Requests.PNG|25px|right]] || Create and edit requests, as well as different types of search.
|-
| [[Data analysis|Data analysis]] [[File:Data_Analysis.PNG|25px|right]] || Basic statistics on the performance of the laboratory.
|-
| [[Configuration|Configuration]] [[File:Configuration.PNG|25px|right]] || Options offered by the system in the different dropboxes of the forms.
|-
| [[System administration|System administration]] [[File:System_administration.PNG|25px|right]] || User administration and edition of software parameters.
|-
| System information [[File:System_Information.PNG|25px|right]] || 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.

==General features==
; 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 writing down normally in the box. The options displayed can be manipulated through the [[Configuration|Configuration]] functionality.

; 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 of the corresponding fields are filled.

; Delete
:[[File:Delete.PNG|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, for instance. Not instances of every concept are deletable. For example, it is not possible to delete patients, requests or users.

; Editing
:In general, there is not any icon associated to 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.

:[[File:Patientinfo.PNG|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 at either [[Requests#Introduce results|Introduce results]], [[Requests#Validate results|Validate results]], as well as the [[Requests#Search historic|Historical requests]].

; 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 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
:[[File:Lock.PNG|50px]] This icon appears attached to elements of a list that cannot be directly selected or deselected. This happens whit groups of tests or profiles. Thus, choosing a group of tests does not allow to remove any of its components, as they are an indivisible set.

==Navigation bar==

; 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.

; 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> will produce a pop-up window when clicked, 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, repeat 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 user can choose a patient, and click on edit patient. Then, at the bottom of the page, the user is able to 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)
[[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, s/he needs to set 'bluetooth_enabler' to ''Enable''.
This will make the icon visible to all 'Laboratory Technitians'.

:When a ''Laboratory Technitian'' 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. From the moment the icon is orange, all the behavior 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). When Bluetooth is active, the icon will turn orange. On clicking again, the feature will be disabled and the icon will be grey.