ARIS - User contributions [en]

MediaWiki:Common.css

2025-05-08T10:24:24Z

Wikiroot:

/* CSS placed here will be applied to all skins */
#catlinks { display: none; }

Printed Manual

2025-05-08T08:52:00Z

Wikiroot:

__TOC__

<hr style="page-break-before: always;">

= User Guide =
{{:User Guide/en}}

<hr style="page-break-before: always;">

= Patients =
{{:Patients/en}}

<hr style="page-break-before: always;">

= Requests =
{{:Requests/en}}

Printed Manual

2025-05-08T08:48:51Z

Wikiroot:

__TOC__

<hr style="page-break-before: always;">

= User Guide =
{{:User Guide}}

<hr style="page-break-before: always;">

= Patients =
{{:Patients}}

<hr style="page-break-before: always;">

= Requests =
{{:Requests}}

MediaWiki:Common.css

2025-05-08T08:48:46Z

Wikiroot:

/* CSS placed here will be applied to all skins */
#catlinks { display: none; }

/* This hides translate tags in printing */
@media print {
translate {
display: none;
}
}

Printed Manual

2025-05-08T08:46:25Z

Wikiroot:

__TOC__

<hr style="page-break-before: always;">

= User Guide =
{{:User Guide}}

<hr style="page-break-before: always;">

= Patients =
{{:Patients}}

<div class="print-pagebreak"></div>

= Requests =
{{:Requests}}

MediaWiki:Common.css

2025-05-08T08:42:35Z

Wikiroot:

/* CSS placed here will be applied to all skins */
#catlinks { display: none; }

/* This enables pagebreaks in printing */
@media print {
.print-pagebreak {
page-break-before: always;
break-before: page; /* For modern browsers */
}
}

WiFi Connection

2025-01-31T10:10:14Z

Wikiroot:

[[Category:WiFi Connection]]

<languages/>
<translate>

<div style="float:left; margin: 0px 20px 0px 0px">__TOC__</div>
[[File:localhost.png|300px|thumb|right|Default ARIS url]]


ARIS allows other devices in the same network as the laptop/PC acting as server (i.e., the one where it was installed, and actually running the application) to connect to the system and work concurrently.
However, ARIS executes by default on “localhost” (i.e., the server itself, which is a way to access services or resources on your own machine without going over the network), and thus not allowing other devices to connect (even if they are in the same network).
Hence, this should be properly reconfigured to the right URL (or IP address).


To make ARIS available through the WiFi connection, the first thing necessary is actually a WiFi.
Just notice that this is different from having Internet connection, which is not really necessary at this point.
There are actually two cases here.
The first one is when the network already exists, and the second is when the network must be created in the same server in the form of a HotSpot.

==Pre-existing network== 


In cases where WiFi or Ethernet connections are already available, there is the option to run the system in any of these networks. In order to be able to connect multiple devices on the same network to use ARIS concurrently, you will need to set the IP address as follows:


# Look for the IP address (the unique number that identifies where the device is located in the network) of the server executing ARIS. Note that this IP address must be the one of the active network where both the server and the other devices MUST connect. To find out which is the IP address of the server, you should:
## Open Settings: Click on the Start menu (Windows icon) located at the bottom-left corner of your screen. Then click on the gear icon labeled "Settings" to open the Windows Settings menu.
## Navigate to Network & Internet Settings: In the Windows Settings menu, click on the "Network & Internet" option. This will take you to settings related to your network connections.
## View Network Status: In the Network & Internet settings, you'll see various options on the left side. Click on "Status". This will show you an overview of your network status.
## Change Adapter Options: Under the "Status" section, find and click on the "Change adapter options" link. This will open a window displaying all the network adapters available on your computer.
## Find Active Network Connection: In the Network Connections window, you'll see a list of network adapters. Identify the available network connection (one from these three in the following example: Ethernet, WiFi or Local Area Connection - a.k.a. HotSpot) where ARIS needs to run. Note that the chosen network MUST be also available for the other devices to connect too (i.e., visible from those devices). Right-click on the active network connection and select "Status" from the context menu (right button in the mause or touch pad).[[File:Netconnections.png|900px|thumb|center|Network Connections example]]
## Check Connection Status: In the Status window for your network connection, click on the "Details" button. This will open a new window displaying detailed information about your network connection.
## Find the IP address: In the Network Connection Details window, look for the "IPv4 Address" field. This field will display your active IP address.[[File:Ncdetails.png|300px|thumb|center|Network Connection details example]]
## Note Down the IP address: Take note of the IP address displayed next to "IPv4 Address." This is the active IP address of your PC in the network.
# Copy this IP address in the 'ARIS\Frontend\build\server_ip.txt' file:
## Navigate to 'C:\Users\Public' folder and find the 'ARIS\Frontend\build\server_ip.txt' file.
## Copy the selected IP address to this file, removing the previous content.[[File:Server_ip_file.png|200px|thumb|center|Editing server_ip.txt]]
## Save the changes and close the file.


Now, the next time ARIS starts, it will run in the desired URL.
[[File:Url.png|300px|thumb|right|ARIS on network URL]]
Hence, you can type the URL (192.168.1.111:3000 in the example) in a browser of this or any other device connected to the same network and access ARIS concurrently. In this example, the selected network to run ARIS was "MiFibra-842E” (WiFi). So all devices connected to this network, can thus access the application as in the server.

==HotSpot network== 


In cases where neither WiFi nor Ethernet networks are available, the initialization of a Local Area Network (known as HotSpot) from the laptop/PC acting as server allows to create an access point in which other devices can connect and thus work concurrently with ARIS, even without any Internet connection. In order to set up and run ARIS in a HotSpot network, you must do the following:


#Download and install [https://mypublicwifi.com/publicwifi/en/index.html MyPublicWiFi software], an assistant which will enable the creation of the HotSpot.
#Once successfully installed, open the application. You will see the main configuration page.
#In this page, select “WLAN Hotspot” tab and set the following options:
#:Network Access: Router Mode (NAT)
#:Internet Connection: WiFi (0.0.0.0)
#:Network name (SSID): arisWiFi (can be anything else)
#:Network key: arisnetwork (can be anything else)
#When finished, click the “Start Hotspot” button. In case of success, the IP address in which the HotSpot is running will be shown, alongside with the previously configured name of the network. At this point, nearby devices will be capable of connecting to the “arisWiFi” by selecting this network and introducing the key.[[File:Publicwifirunning.png|300px|thumb|center|Setting the HotSpot configuration.]]
#Find the 'C:\Users\Public folder and open the ARIS\Frontend\build\server_ip.txt' file.
#Copy the IP address where the HotSpot is running (192.168.5.1 in the example) into this file, removing the previous content.[[File:Serverfilehp.png|200px|thumb|center|Editing server_ip.txt]]
#Save the changes and close the file.


The next time ARIS starts, it will run in the HotSpot network URL. Hence, you can type the URL (192.168.5.1:3000 in the example) in a browser of this or any other device connected to the HotSpot and access ARIS concurrently.
[[File:Urlhp.png|300px|thumb|right|ARIS on HotSpot network URL]]
Note that for this type of networks there is the option to set a custom server name instead of the numeric IP address, making it easier to access the system in the browser. The steps to set up this feature are explained in detail below.

===Setting custom server name in the 'hosts' file=== 


Furthermore, '''only for HotSpot connections (in case of WiFi and Ethernet connections the server name cannot be configured this way, but must be done by the network administrator)''', there is the option to set a server name instead of the numeric IP address so it can be easier to remember. For this purpose, we must edit the Windows hosts file:


#Open Notepad as an Administrator:
##Click on the Start menu (Windows icon) located at the bottom-left corner of your screen.
##Type "Notepad" into the search bar.
##Right-click on Notepad in the search results.
##Select "Run as administrator" from the context menu. If prompted for permission, click "Yes."
#Open the Hosts File:
##In Notepad, click on "File" in the top-left corner.
##Choose "Open."
##In the file explorer window, navigate to the following location: C:\Windows\System32\drivers\etc
##Change the file type dropdown menu to "All Files (*.*)" (in the bottom-right corner of the window) to make sure you can see the hosts file.
##Select the file named "hosts" and click "Open".
#Edit the Hosts File:
##The hosts file will open in Notepad.
##You'll see some comments at the beginning of the file (lines starting with a "#" symbol).
##To add an entry, go to the end of the file on a new line.
##Enter the IP address you want to assign (such as "192.168.5.1") followed by a space and then the servern name you want to map to that IP address. For example: "192.168.5.1 aris" [[File:Hosts_new.png|500px|thumb|center|Editing hosts file]]
#Save the Changes:
##After making your changes, click on "File" in the top-left corner.
##Choose "Save" to save the changes to the hosts file.
#Close Notepad:
##Close Notepad once you've saved the changes.


After these steps, you must set the 'ARIS/Frontend/build/server_ip.txt' with the same name as in the hosts file, instead of the IP address, as explained in the previous section.[[File:ArisURL.png|150px|thumb|center|Editing server_ip.txt]]


Once you start ARIS, it will be accessible through the “aris” URL as set before. Accessing this in the browser of the devices connected to the HotSpot will access the application as in the server itself.[[File:ArisURL2.png|300px|thumb|right|Custom ARIS URL]]

</translate>

WiFi Connection

2025-01-31T10:08:04Z

Wikiroot:

[[Category:WiFi Connection]]

<translate>

<div style="float:left; margin: 0px 20px 0px 0px">__TOC__</div>
[[File:localhost.png|300px|thumb|right|Default ARIS url]]


ARIS allows other devices in the same network as the laptop/PC acting as server (i.e., the one where it was installed, and actually running the application) to connect to the system and work concurrently.
However, ARIS executes by default on “localhost” (i.e., the server itself, which is a way to access services or resources on your own machine without going over the network), and thus not allowing other devices to connect (even if they are in the same network).
Hence, this should be properly reconfigured to the right URL (or IP address).


To make ARIS available through the WiFi connection, the first thing necessary is actually a WiFi.
Just notice that this is different from having Internet connection, which is not really necessary at this point.
There are actually two cases here.
The first one is when the network already exists, and the second is when the network must be created in the same server in the form of a HotSpot.

==Pre-existing network== 


In cases where WiFi or Ethernet connections are already available, there is the option to run the system in any of these networks. In order to be able to connect multiple devices on the same network to use ARIS concurrently, you will need to set the IP address as follows:


# Look for the IP address (the unique number that identifies where the device is located in the network) of the server executing ARIS. Note that this IP address must be the one of the active network where both the server and the other devices MUST connect. To find out which is the IP address of the server, you should:
## Open Settings: Click on the Start menu (Windows icon) located at the bottom-left corner of your screen. Then click on the gear icon labeled "Settings" to open the Windows Settings menu.
## Navigate to Network & Internet Settings: In the Windows Settings menu, click on the "Network & Internet" option. This will take you to settings related to your network connections.
## View Network Status: In the Network & Internet settings, you'll see various options on the left side. Click on "Status". This will show you an overview of your network status.
## Change Adapter Options: Under the "Status" section, find and click on the "Change adapter options" link. This will open a window displaying all the network adapters available on your computer.
## Find Active Network Connection: In the Network Connections window, you'll see a list of network adapters. Identify the available network connection (one from these three in the following example: Ethernet, WiFi or Local Area Connection - a.k.a. HotSpot) where ARIS needs to run. Note that the chosen network MUST be also available for the other devices to connect too (i.e., visible from those devices). Right-click on the active network connection and select "Status" from the context menu (right button in the mause or touch pad).[[File:Netconnections.png|900px|thumb|center|Network Connections example]]
## Check Connection Status: In the Status window for your network connection, click on the "Details" button. This will open a new window displaying detailed information about your network connection.
## Find the IP address: In the Network Connection Details window, look for the "IPv4 Address" field. This field will display your active IP address.[[File:Ncdetails.png|300px|thumb|center|Network Connection details example]]
## Note Down the IP address: Take note of the IP address displayed next to "IPv4 Address." This is the active IP address of your PC in the network.
# Copy this IP address in the 'ARIS\Frontend\build\server_ip.txt' file:
## Navigate to 'C:\Users\Public' folder and find the 'ARIS\Frontend\build\server_ip.txt' file.
## Copy the selected IP address to this file, removing the previous content.[[File:Server_ip_file.png|200px|thumb|center|Editing server_ip.txt]]
## Save the changes and close the file.


Now, the next time ARIS starts, it will run in the desired URL.
[[File:Url.png|300px|thumb|right|ARIS on network URL]]
Hence, you can type the URL (192.168.1.111:3000 in the example) in a browser of this or any other device connected to the same network and access ARIS concurrently. In this example, the selected network to run ARIS was "MiFibra-842E” (WiFi). So all devices connected to this network, can thus access the application as in the server.

==HotSpot network== 


In cases where neither WiFi nor Ethernet networks are available, the initialization of a Local Area Network (known as HotSpot) from the laptop/PC acting as server allows to create an access point in which other devices can connect and thus work concurrently with ARIS, even without any Internet connection. In order to set up and run ARIS in a HotSpot network, you must do the following:


#Download and install [https://mypublicwifi.com/publicwifi/en/index.html MyPublicWiFi software], an assistant which will enable the creation of the HotSpot.
#Once successfully installed, open the application. You will see the main configuration page.
#In this page, select “WLAN Hotspot” tab and set the following options:
#:Network Access: Router Mode (NAT)
#:Internet Connection: WiFi (0.0.0.0)
#:Network name (SSID): arisWiFi (can be anything else)
#:Network key: arisnetwork (can be anything else)
#When finished, click the “Start Hotspot” button. In case of success, the IP address in which the HotSpot is running will be shown, alongside with the previously configured name of the network. At this point, nearby devices will be capable of connecting to the “arisWiFi” by selecting this network and introducing the key.[[File:Publicwifirunning.png|300px|thumb|center|Setting the HotSpot configuration.]]
#Find the 'C:\Users\Public folder and open the ARIS\Frontend\build\server_ip.txt' file.
#Copy the IP address where the HotSpot is running (192.168.5.1 in the example) into this file, removing the previous content.[[File:Serverfilehp.png|200px|thumb|center|Editing server_ip.txt]]
#Save the changes and close the file.


The next time ARIS starts, it will run in the HotSpot network URL. Hence, you can type the URL (192.168.5.1:3000 in the example) in a browser of this or any other device connected to the HotSpot and access ARIS concurrently.
[[File:Urlhp.png|300px|thumb|right|ARIS on HotSpot network URL]]
Note that for this type of networks there is the option to set a custom server name instead of the numeric IP address, making it easier to access the system in the browser. The steps to set up this feature are explained in detail below.

===Setting custom server name in the 'hosts' file=== 


Furthermore, '''only for HotSpot connections (in case of WiFi and Ethernet connections the server name cannot be configured this way, but must be done by the network administrator)''', there is the option to set a server name instead of the numeric IP address so it can be easier to remember. For this purpose, we must edit the Windows hosts file:


#Open Notepad as an Administrator:
##Click on the Start menu (Windows icon) located at the bottom-left corner of your screen.
##Type "Notepad" into the search bar.
##Right-click on Notepad in the search results.
##Select "Run as administrator" from the context menu. If prompted for permission, click "Yes."
#Open the Hosts File:
##In Notepad, click on "File" in the top-left corner.
##Choose "Open."
##In the file explorer window, navigate to the following location: C:\Windows\System32\drivers\etc
##Change the file type dropdown menu to "All Files (*.*)" (in the bottom-right corner of the window) to make sure you can see the hosts file.
##Select the file named "hosts" and click "Open".
#Edit the Hosts File:
##The hosts file will open in Notepad.
##You'll see some comments at the beginning of the file (lines starting with a "#" symbol).
##To add an entry, go to the end of the file on a new line.
##Enter the IP address you want to assign (such as "192.168.5.1") followed by a space and then the servern name you want to map to that IP address. For example: "192.168.5.1 aris" [[File:Hosts_new.png|500px|thumb|center|Editing hosts file]]
#Save the Changes:
##After making your changes, click on "File" in the top-left corner.
##Choose "Save" to save the changes to the hosts file.
#Close Notepad:
##Close Notepad once you've saved the changes.


After these steps, you must set the 'ARIS/Frontend/build/server_ip.txt' with the same name as in the hosts file, instead of the IP address, as explained in the previous section.[[File:ArisURL.png|150px|thumb|center|Editing server_ip.txt]]


Once you start ARIS, it will be accessible through the “aris” URL as set before. Accessing this in the browser of the devices connected to the HotSpot will access the application as in the server itself.[[File:ArisURL2.png|300px|thumb|right|Custom ARIS URL]]

</translate>

Terminology

2024-04-27T02:49:10Z

Wikiroot:

;AI:Artificial Intelligence
;Arduino:[https://www.arduino.cc Open source project]
;ARIS:Analytical Requests Information System
;Bluetooth:[https://en.wikipedia.org/wiki/Bluetooth Bluetooth wireless technology]
;CSV:[https://en.wikipedia.org/wiki/Comma-separated_values Comma Separated Values]
;GLI:[https://www.fundacionprobitas.org/en/what-is-gli-model Global Laboratory Initiative]
;IP address:[https://en.wikipedia.org/wiki/IP_address Internet Protocol address]
;JSON:[https://en.wikipedia.org/wiki/JSON JavaScript Object Notation]
;Node.js:[https://en.wikipedia.org/wiki/Node.js Node.js (sever-side execution environment)]
;NTD:[https://en.wikipedia.org/wiki/Neglected_tropical_diseases Neglected Tropical Diseases]
;PDF:[https://es.wikipedia.org/wiki/PDF Portable Document Format]
;Probitas-GLI:[https://www.fundacionprobitas.org/en/what-is-gli-model Probitas Global Laboratory Initiative]
;Python:[https://en.wikipedia.org/wiki/Python_(programming_language) Python (programming language)]
;ULR:[https://en.wikipedia.org/wiki/URL Uniform Resource Location]
;ZIP:[https://en.wikipedia.org/wiki/ZIP_(file_format) Compressed file format]

MediaWiki:Breadcrumbs

2024-04-19T14:44:41Z

Wikiroot:

MediaWiki:Breadcrumbs

2024-04-19T14:43:25Z

Wikiroot:

Backup and Restore

2024-01-13T16:51:27Z

Wikiroot:

<languages/>
<translate>

[[Category:Backup and Restore]]
ARIS provides a powerful and simple mechanism to keep data safe.
Thus, in case of disk failure they can be easily recovered.
However, is it crucial to remember that this mechanism is absolutely useless if the backup is not regularly extracted from the hard drive of the computer to a safe external storage device. This is the responsibility of the system administrator.


__TOC__

==Backup== 


The backup process for ARIS application involves regularly creating backups of the application's database to ensure data safety and the ability to restore the system in case of any issues. Here is a step-by-step guide on how the the backup is perfomred and how to customize it:


1.'''Access technical administration page:''' Log in to the application as an administrator and go to the Technical Administration section, then find the parameters tab. This section provides access to the backup-related parameters and settings.


2. '''Set Backup Frequency:''' In the parameters tab, locate the backup_frequency parameter. This parameter determines how often the backups will be created. Modify this parameter according to your requirements. For example, if you set it to "6", a backup will be created every six hours. By default it will be set as 23 so it will create a backup daily.


3. '''Set Backup History:''' Locate the backup_history parameter in the same tab. This parameter defines the number of backups to retain. Modify this parameter to specify how many backups you want to keep. For instance, if you set it to "5", the system will retain the most recent five backups. By default the parameter is set to three, so the system will only preserve the three most recent backups.


[[File:backup_parameters.png|center|600px|thumb| Parameters of backup settings inside the parameters tab]]


4. '''Find the Backup Folder:''' The backup files will be stored in the ''ARIS/Backend/Database/Backups'' folder. Here you will find all the backup files with the creation date as name.


[[File:backup_folder.png|center|600px|thumb| Backup folder with three backup files]]


The backup process will be done automatic, you just need to modify, if you see it necessary, the parameters presented above. Every time ARIS is launched, it will generate a backup depending on the ''backup_frecuency'' parameter and keep as many as the ''backup_history'' parameter indicates.


IMPORTANT NOTICE: You should realize that creating backups is absolutely useless if you do not regularly copy them out of your machine (e.g., to a USB).

==Restore== 


In case of system failure or hard disk crash, you can restore the system from the latest backup file you extracted, following the next steps:


0. '''Stop de application:''' Remember that closing the browser is not enough, but you need to really [[Installation_and_Upgrades#Closing_ARIS|stop the services running in the background]].


1. '''Locate the last available backup:''' You should have extracted it to some external storage device, but if the hard disk didn't fail, you will find it in the backup folder ''C:/Users/Public/ARIS/Backend/Database/Backups'' (by default).


2. '''Delete Existing Database:''' Ensure that the "sql_app.db" file in the ''Database'' folder is either deleted or moved out of the folder. This step ensures that the restored backup will replace the existing database.


[[File:sql_app.png|center|600px|thumb| sql_app.db file at the end of the folder]]


3. '''Locate the Desired Backup:''' In the Backup folder (''ARIS/Backend/Database/Backups''), locate the backup file you want to restore (filename indicates the date with format ''yymmddhhmmss.db''). Choose the most recent backup or the one that suits your needs.


4. '''Copy Backup File:''' Copy the selected backup file.


5. '''Paste and Rename:''' Paste the copied backup file into the ''Database'' folder. Rename the backup file to ''sql_app.db''. This step ensures that the restored backup file becomes the active database file for the application.


6. '''Restart ARIS'''


By following these steps, you can perform regular backups of your application's database and restore the system using any of the previously created backup files. It is important to review and update the ''backup_frequency'' and ''backup_history'' parameters in the Technical Administration section to align with your data retention and backup requirements.
</translate>

Backup and Restore

2024-01-13T16:45:57Z

Wikiroot:

<languages />
<translate>

ARIS provides a powerful and simple mechanism to keep data safe.
Thus, in case of disk failure they can be easily recovered.
However, is it crucial to remember that this mechanism is absolutely useless if the backup is not regularly extracted from the hard drive of the computer to a safe external storage device. This is the responsibility of the system administrator.


__TOC__

==Backup== 


The backup process for ARIS application involves regularly creating backups of the application's database to ensure data safety and the ability to restore the system in case of any issues. Here is a step-by-step guide on how the the backup is perfomred and how to customize it:


1.'''Access technical administration page:''' Log in to the application as an administrator and go to the Technical Administration section, then find the parameters tab. This section provides access to the backup-related parameters and settings.


2. '''Set Backup Frequency:''' In the parameters tab, locate the backup_frequency parameter. This parameter determines how often the backups will be created. Modify this parameter according to your requirements. For example, if you set it to "6", a backup will be created every six hours. By default it will be set as 23 so it will create a backup daily.


3. '''Set Backup History:''' Locate the backup_history parameter in the same tab. This parameter defines the number of backups to retain. Modify this parameter to specify how many backups you want to keep. For instance, if you set it to "5", the system will retain the most recent five backups. By default the parameter is set to three, so the system will only preserve the three most recent backups.


[[File:backup_parameters.png|center|600px|thumb| Parameters of backup settings inside the parameters tab]]


4. '''Find the Backup Folder:''' The backup files will be stored in the ''ARIS/Backend/Database/Backups'' folder. Here you will find all the backup files with the creation date as name.


[[File:backup_folder.png|center|600px|thumb| Backup folder with three backup files]]


The backup process will be done automatic, you just need to modify, if you see it necessary, the parameters presented above. Every time ARIS is launched, it will generate a backup depending on the ''backup_frecuency'' parameter and keep as many as the ''backup_history'' parameter indicates.


IMPORTANT NOTICE: You should realize that creating backups is absolutely useless if you do not regularly copy them out of your machine (e.g., to a USB).

==Restore== 


In case of system failure or hard disk crash, you can restore the system from the latest backup file you extracted, following the next steps:


0. '''Stop de application:''' Remember that closing the browser is not enough, but you need to really [[Installation_and_Upgrades#Closing_ARIS|stop the services running in the background]].


1. '''Locate the last available backup:''' You should have extracted it to some external storage device, but if the hard disk didn't fail, you will find it in the backup folder ''C:/Users/Public/ARIS/Backend/Database/Backups'' (by default).


2. '''Delete Existing Database:''' Ensure that the "sql_app.db" file in the ''Database'' folder is either deleted or moved out of the folder. This step ensures that the restored backup will replace the existing database.


[[File:sql_app.png|center|600px|thumb| sql_app.db file at the end of the folder]]


3. '''Locate the Desired Backup:''' In the Backup folder (''ARIS/Backend/Database/Backups''), locate the backup file you want to restore (filename indicates the date with format ''yymmddhhmmss.db''). Choose the most recent backup or the one that suits your needs.


4. '''Copy Backup File:''' Copy the selected backup file.


5. '''Paste and Rename:''' Paste the copied backup file into the ''Database'' folder. Rename the backup file to ''sql_app.db''. This step ensures that the restored backup file becomes the active database file for the application.


6. '''Restart ARIS'''


By following these steps, you can perform regular backups of your application's database and restore the system using any of the previously created backup files. It is important to review and update the ''backup_frequency'' and ''backup_history'' parameters in the Technical Administration section to align with your data retention and backup requirements.
</translate>

[[Category:Backup and Restore]]

Backup and Restore

2024-01-13T16:38:17Z

Wikiroot: Marked this version for translation

<languages />
<translate>

[[Category:Backup and Restore]]


ARIS provides a powerful and simple mechanism to keep data safe.
Thus, in case of disk failure they can be easily recovered.
However, is it crucial to remember that this mechanism is absolutely useless if the backup is not regularly extracted from the hard drive of the computer to a safe external storage device. This is the responsibility of the system administrator.


__TOC__

==Backup== 


The backup process for ARIS application involves regularly creating backups of the application's database to ensure data safety and the ability to restore the system in case of any issues. Here is a step-by-step guide on how the the backup is perfomred and how to customize it:


1.'''Access technical administration page:''' Log in to the application as an administrator and go to the Technical Administration section, then find the parameters tab. This section provides access to the backup-related parameters and settings.


2. '''Set Backup Frequency:''' In the parameters tab, locate the backup_frequency parameter. This parameter determines how often the backups will be created. Modify this parameter according to your requirements. For example, if you set it to "6", a backup will be created every six hours. By default it will be set as 23 so it will create a backup daily.


3. '''Set Backup History:''' Locate the backup_history parameter in the same tab. This parameter defines the number of backups to retain. Modify this parameter to specify how many backups you want to keep. For instance, if you set it to "5", the system will retain the most recent five backups. By default the parameter is set to three, so the system will only preserve the three most recent backups.


[[File:backup_parameters.png|center|600px|thumb| Parameters of backup settings inside the parameters tab]]


4. '''Find the Backup Folder:''' The backup files will be stored in the ''ARIS/Backend/Database/Backups'' folder. Here you will find all the backup files with the creation date as name.


[[File:backup_folder.png|center|600px|thumb| Backup folder with three backup files]]


The backup process will be done automatic, you just need to modify, if you see it necessary, the parameters presented above. Every time ARIS is launched, it will generate a backup depending on the ''backup_frecuency'' parameter and keep as many as the ''backup_history'' parameter indicates.


IMPORTANT NOTICE: You should realize that creating backups is absolutely useless if you do not regularly copy them out of your machine (e.g., to a USB).

==Restore== 


In case of system failure or hard disk crash, you can restore the system from the latest backup file you extracted, following the next steps:


0. '''Stop de application:''' Remember that closing the browser is not enough, but you need to really [[Installation_and_Upgrades#Closing_ARIS|stop the services running in the background]].


1. '''Locate the last available backup:''' You should have extracted it to some external storage device, but if the hard disk didn't fail, you will find it in the backup folder ''C:/Users/Public/ARIS/Backend/Database/Backups'' (by default).


2. '''Delete Existing Database:''' Ensure that the "sql_app.db" file in the ''Database'' folder is either deleted or moved out of the folder. This step ensures that the restored backup will replace the existing database.


[[File:sql_app.png|center|600px|thumb| sql_app.db file at the end of the folder]]


3. '''Locate the Desired Backup:''' In the Backup folder (''ARIS/Backend/Database/Backups''), locate the backup file you want to restore (filename indicates the date with format ''yymmddhhmmss.db''). Choose the most recent backup or the one that suits your needs.


4. '''Copy Backup File:''' Copy the selected backup file.


5. '''Paste and Rename:''' Paste the copied backup file into the ''Database'' folder. Rename the backup file to ''sql_app.db''. This step ensures that the restored backup file becomes the active database file for the application.


6. '''Restart ARIS'''


By following these steps, you can perform regular backups of your application's database and restore the system using any of the previously created backup files. It is important to review and update the ''backup_frequency'' and ''backup_history'' parameters in the Technical Administration section to align with your data retention and backup requirements.
</translate>

Backup and Restore

2024-01-13T16:37:56Z

Wikiroot:

<languages />
<translate>
[[Category:Backup and Restore]]


ARIS provides a powerful and simple mechanism to keep data safe.
Thus, in case of disk failure they can be easily recovered.
However, is it crucial to remember that this mechanism is absolutely useless if the backup is not regularly extracted from the hard drive of the computer to a safe external storage device. This is the responsibility of the system administrator.


__TOC__

==Backup== 


The backup process for ARIS application involves regularly creating backups of the application's database to ensure data safety and the ability to restore the system in case of any issues. Here is a step-by-step guide on how the the backup is perfomred and how to customize it:


1.'''Access technical administration page:''' Log in to the application as an administrator and go to the Technical Administration section, then find the parameters tab. This section provides access to the backup-related parameters and settings.


2. '''Set Backup Frequency:''' In the parameters tab, locate the backup_frequency parameter. This parameter determines how often the backups will be created. Modify this parameter according to your requirements. For example, if you set it to "6", a backup will be created every six hours. By default it will be set as 23 so it will create a backup daily.


3. '''Set Backup History:''' Locate the backup_history parameter in the same tab. This parameter defines the number of backups to retain. Modify this parameter to specify how many backups you want to keep. For instance, if you set it to "5", the system will retain the most recent five backups. By default the parameter is set to three, so the system will only preserve the three most recent backups.


[[File:backup_parameters.png|center|600px|thumb| Parameters of backup settings inside the parameters tab]]


4. '''Find the Backup Folder:''' The backup files will be stored in the ''ARIS/Backend/Database/Backups'' folder. Here you will find all the backup files with the creation date as name.


[[File:backup_folder.png|center|600px|thumb| Backup folder with three backup files]]


The backup process will be done automatic, you just need to modify, if you see it necessary, the parameters presented above. Every time ARIS is launched, it will generate a backup depending on the ''backup_frecuency'' parameter and keep as many as the ''backup_history'' parameter indicates.


IMPORTANT NOTICE: You should realize that creating backups is absolutely useless if you do not regularly copy them out of your machine (e.g., to a USB).

==Restore== 


In case of system failure or hard disk crash, you can restore the system from the latest backup file you extracted, following the next steps:


0. '''Stop de application:''' Remember that closing the browser is not enough, but you need to really [[Installation_and_Upgrades#Closing_ARIS|stop the services running in the background]].


1. '''Locate the last available backup:''' You should have extracted it to some external storage device, but if the hard disk didn't fail, you will find it in the backup folder ''C:/Users/Public/ARIS/Backend/Database/Backups'' (by default).


2. '''Delete Existing Database:''' Ensure that the "sql_app.db" file in the ''Database'' folder is either deleted or moved out of the folder. This step ensures that the restored backup will replace the existing database.


[[File:sql_app.png|center|600px|thumb| sql_app.db file at the end of the folder]]


3. '''Locate the Desired Backup:''' In the Backup folder (''ARIS/Backend/Database/Backups''), locate the backup file you want to restore (filename indicates the date with format ''yymmddhhmmss.db''). Choose the most recent backup or the one that suits your needs.


4. '''Copy Backup File:''' Copy the selected backup file.


5. '''Paste and Rename:''' Paste the copied backup file into the ''Database'' folder. Rename the backup file to ''sql_app.db''. This step ensures that the restored backup file becomes the active database file for the application.


6. '''Restart ARIS'''


By following these steps, you can perform regular backups of your application's database and restore the system using any of the previously created backup files. It is important to review and update the ''backup_frequency'' and ''backup_history'' parameters in the Technical Administration section to align with your data retention and backup requirements.
</translate>

ARIS:About

2024-01-12T15:35:02Z

Wikiroot:

<languages/>
<translate>


This project is a joint effort between [https://www.fundacionprobitas.org/en/home ''Fundació Probitas''] and [http://www.upc.edu ''Universitat Politècnica de Catalunya'' (UPC)]


[[File:LogoProbitas.png|250px|link=https://www.fundacionprobitas.org/en/home]][[File:LogoUPC.png|250px|link=http://www.upc.edu]]
</translate>

MediaWiki:Breadcrumbs

2024-01-12T15:15:49Z

Wikiroot:

System administration

2024-01-12T15:12:16Z

Wikiroot:

[[Category:System administration]]
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border="frame" format="svg">
digraph AdministrationDiagram {
node [shape=oval style=filled fillcolor=orange fontsize="9pt"];
//----- System Administration graph
// Nodes
SystemAdministration [label="System Administration"];
Generic [label="Generic" URL="#Generic"];
Technical [label="Technical" URL="#Technical"];
Users [label="Users" shape=tab URL="#Users"];
AccessLog [label="Access Log" shape=tab URL="#Access_log"];
DownloadedFields [label="Downloaded Fields" shape=tab URL="#Downloaded_fields"];
SummaryOfInstances [label="Summary of Instances" shape=tab URL="#Summary_of_instances"];
Roles [label="Roles" shape=tab URL="#Roles"];
Parameters [label="Parameters" shape=tab URL="#Parameters"];
// Edges
SystemAdministration -> Generic;
SystemAdministration -> Technical;
// Edges
Generic -> Users;
Generic -> AccessLog;
Generic -> DownloadedFields;
// Edges
Technical -> SummaryOfInstances;
Technical -> Roles;
Technical -> Parameters;
}
</graphviz>
</div>

This groups all knobs that allow to manage and adapt the behavior of ARIS to the needs of the laboratory and user preferences.
They are grouped in two to facilitate their access.
The first one is more generic and allows both laboratory supervisor and system administration to access some basic stuff.
The second one is only available to the system administrator, since it is considered to require more advance technological skills.

==Generic==
This groups all the basic administration functionalities.
They are available for both the system administration and the laboratory supervisor.
===Users===
[[File:Newuser.PNG|right|thumb|750px|User creation form]]
When clicking on the edit or ''New user'' buttons, a form pops up on the screen. The information necessary to create a user consists of a ''Username'', ''Name'', ''Middle name'', ''password'' and the person's [[#Roles|Role]] within the system.
This Role will determine the functionalities available to the user.
A note, without any effect in the behavior of the application can be added to indicate any relevant information to the system administrator.

This same form allows the system administrator to modify the password of any other user.
For security reasons, this password must contain some number, some capital letter, some small letter, and at least eight characters.

Since they are used to audit changes in patients and requests, the users cannot be deleted from the system.
However, they can be declared not to be active, which would prevent them from logging in, but still keep track in the database of all their past actions.

===Access log===
The ''access log'' shows the user which user has done an action within the system and exactly when. The timestamp is in the format '''Year-Month-Day Hour:Minute:Second'''
[[File:Accesslog.PNG|right|thumb|600px|Example of access log]]</br>
There are three actions recorded by the access log, ''successful log in'', ''wrong user'' and ''failed log in''. This last action refers to the wrong password being used.

===Downloaded fields===
ARIS allows the laboratory supervisor to download all the information in the database into a single file in their computer.
There are two possible download options, depending of the format of the generated file being plain CSV, or compressed and password protected ZIP.
These documents will contain information on the requests, and by extension, on the corresponding patients.
Thus, due to patient confidentiality, not all of the personal data should be in the downloaded file.
The checkboxes in this form allow the laboratory supervisor as well as the system administrator to decide which fields will be downloaded in each one of the formats.

==Technical==
This groups all the more advanced administration functionalities.
They are available only for the system administration.

===Summary of instances===
[[File:Summaryofinstancessmol.PNG|right|250px|thumb|Summary of instances]]
This tab displays information about the different existing instances in the application.
Some examples are: the number of patients, users, requests or genders.
This information comes directly from the database and is automatically updated after every modification in the system.
It can be useful to investigate potential performance problems is case of extremely large numbers.
To facilitate the reading and identification of the different kinds of instances, the information is divided into three sections: ''Data'', ''Administration'' and ''Configuration''.

===Roles===
This tab is displayed and works, in the same way as the [[Configuration#State of the request|State of the request]] tab in the [[Configuration|Configuration]] functionality.
The roles are unchangeable, but their labels (not the corresponding functionality) can be customized.

Each role has different actions allowed within the application, chosen due to the tasks the people are expected to carry out.
Thus, there are three roles within the system, which indicate the functionalities that a user can perform, as can be seen in the following table.

{| class="wikitable" style="margin:auto; text-align: center;"
|+ Allowed functionalities per role
|-
!colspan="2"| Functionalities !! Laboratory Technician !! Laboratory Supervisor !! System administrator
|-
| style="text-align:left;" rowspan="2" | Patient || style="text-align:left;" | Create || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Search || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" rowspan="6" | Request || style="text-align:left;" | Create || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Change information || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Deliver samples || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Introduce results || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Validate results || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Search historic || [[File:Tick.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" colspan="2" | Data analysis || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" rowspan="2" | Configuration || style="text-align:left;" | Generic || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Tick.png|frameless|25px]]
|-
| style="text-align:left;" | Technical || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" rowspan="2" | Administration || style="text-align:left;"| Generic || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Tick.png|frameless|25px]]
|-
| style="text-align:left;" | Technical || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]]
|}

===Parameters===
Parameters determine the behavior of some functionalities.
Thus, they cannot be created or deleted.
However, their values can be updated to customize the system.
At this point it is important to highlight the on updating them, the data type must be respected.
Providing a value of the wrong data type (e.g., a string instead of an integer) can provoke the malfunction of the whole application.

The following table contains the list of existing parameters together with the corresponding data type and a brief description.

{| class="wikitable" style="margin:auto; text-align: left;"
|+ System parameters
|-
! Name !! Data type !! Description
|-
| ''version'' || String || Version of the system
|-
| ''name'' || String || Caption to appear at the top of the screen, in the navigation bar
|-
| ''default_language'' || String || Language set by default on logging in (the same for all users)
|-
| ''timeout'' || Integer || Time (in minutes) after wich the connection to the backend requires a new log in
|-
| ''table_default_paging'' || Integer || This indicates the initial paging of all the tables (accepted values are 5, 10 or 25)
|-
| ''table_min_rows_for_search'' || Integer || This is the minimum number of rows a table must have to show the corresponding search field
|-
| ''attribute_reserved1'' || String || Label of the first field of free use in the requests (write 'DoNotShow' to hide it)
|-
| ''attribute_reserved2'' || String || Label of the second field of free use in the requests (write 'DoNotShow' to hide it)
|-
| ''attribute_reserved3'' || String || Label of the third field of free use in the requests (write 'DoNotShow' to hide it)
|-
| ''filename_background'' || String || File containing the image displayed in the background
|-
| ''filename_sidebarlogo'' || String || File containing the logo displayed at the bottom of the sidebar
|-
| ''filename_favicon'' || String || Icon of the system used in the browser tab
|-
| ''bluetooth_enabler'' || String || Indicates the availability of automatic tests through Bluetooth connection (accepted values are 'Enabled' and 'Disabled'), which is only used in the [[Main_Page|IMAGING project]]
|-
| ''zip_password'' || String || This is the password that will be used to generate the downloaded zip file
|-
| ''log_history'' || Integer || Maximum number of days to keep registries in the access log (those older than this will be automatically deleted)
|-
| ''backup_frequency'' || Integer || Minimum amount of hours that need to pass for the system to generate a new copy of the database
|-
| ''backup_history'' || Integer || Maximum number of copies of the database kept (once reached, oldest copy in the folder is deleted)
|-
| ''max_image_volume'' || Integer || Maximum number of megabytes used to store images (once reached, oldest ones in the folder are deleted)
|-
| ''filename_worklistlogo'' || String || Logo used in the worklist reports
|}

Configuration

2024-01-12T15:11:37Z

Wikiroot:

[[Category:Configuration]]

The configuration functionality allows the user to manipulate ARIS, adding or changing some of its aspects for a better customization.
These have been divided into two groups, depending on the knowledge needed to use them.
The first group is absolutely generic and both laboratory supervisor and system administrator should be able to provide the required information.
However, for the second group, more specific biomedical knowledge will be needed, and consequently only the laboratory supervisor is allowed to do it.

<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph ConfigurationDiagram {
nodesep=0.05;
node [shape=oval style=filled fillcolor=orange fontsize="9pt" margin="0.01, 0.01"];

Configuration [label="Configuration"];
ConfGeneric [label="Generic", URL="#Generic_configuration"];
ConfTechnical [label="Technical", URL="#Technical_configuration"];

Configuration -> ConfGeneric;
Configuration -> ConfTechnical;

Regions [label="Regions", shape=tab, URL="#Generic_configuration"];
Locations [label="Locations", shape=tab, URL="#Generic_configuration"];
Units [label="Units", shape=tab, URL="#Generic_configuration"];
HealthFacilities [label="Health, Facilities" shape=tab, URL="#Generic_configuration"];
Physicians [label="Physicians", shape=tab, URL="#Generic_configuration"];
Gender [label="Gender", shape=tab, URL="#Generic_configuration"];
IdentificationCards [label="Identification Cards", shape=tab, URL="#Generic_configuration"];
StateOfTheRequest [label="State of the Request", shape=tab URL="#State_of_the_request"];

ConfGeneric -> Regions;
ConfGeneric -> Locations;
ConfGeneric -> Units;
ConfGeneric -> HealthFacilities;
ConfGeneric -> Physicians;
ConfGeneric -> Gender;
ConfGeneric -> IdentificationCards;
ConfGeneric -> StateOfTheRequest;

LaboratoryAreas [label="Laboratory Areas", shape=tab, URL="#Technical_configuration"];
AnalyticalTests [label="Analytical Tests", shape=tab URL="#Analytical_tests"];
AnalyticalTestsGroups [label="Analytical Tests Groups", shape=tab URL="#Analytical_tests_groups"];
AnalyticalProfiles [label="Analytical Profiles", shape=tab URL="#Analytical_profiles"];
KindsOfSamples [label="Kinds of Samples", shape=tab, URL="#Technical_configuration"];
SampleIncidents [label="Sample Incidents", shape=tab, URL="#Technical_configuration"];
SampleOrigins [label="Sample Origins", shape=tab, URL="#Technical_configuration"];
PregnancyPhases [label="Pregnancy Phases", shape=tab, URL="#Technical_configuration"];
DataTypes [label="Datatypes", shape=tab, URL="#Datatypes"];
ReportingOrder [label="Reporting Order", shape=tab, URL="#Reporting_order"];

ConfTechnical -> LaboratoryAreas;
ConfTechnical -> AnalyticalTests;
ConfTechnical -> AnalyticalTestsGroups;
ConfTechnical -> AnalyticalProfiles;
ConfTechnical -> KindsOfSamples;
ConfTechnical -> SampleIncidents;
ConfTechnical -> SampleOrigins;
ConfTechnical -> PregnancyPhases;
ConfTechnical -> DataTypes;
ConfTechnical -> ReportingOrder;

{ rank=same; Regions Units Physicians IdentificationCards LaboratoryAreas AnalyticalTestsGroups KindsOfSamples SampleOrigins DataTypes}
{ rank=same; ConfGeneric ConfTechnical}
{ rank=sink; Locations HealthFacilities Gender StateOfTheRequest AnalyticalTests AnalyticalProfiles SampleIncidents PregnancyPhases ReportingOrder}}
</graphviz>
</div>

__TOC__

==Generic configuration==
[[File:Genericconfiguration.PNG|right|600px|thumb|Editing the labels used for the states]]
This form controls the values of all non-free text fields (i.e., those that appear when clicking on an [[User Guide#Arrow|arrow]]) within the system. Through each tab, the user is able to create, edit and delete the values of one of these fields.
If the laboratory is not interested in one of the values, but the user does not wish to delete the information from the system, it can be simply disabled, so it will not be shown in the corresponding drop-down menu. This is done by unticking the ''Active'' checkbox. </br> [[File:Activecheckbox.PNG|75px|Activated checkbox]] ⇔ [[File:Deactivatedcheckbox.PNG|75px|Deactivated checkbox]] </br>
List of tabs:
*Regions (initially empty)
*Locations (initially empty)
*Units
*Health Facilities (initially empty)
*Physicians (initially empty)
*Gender
*Identification cards
*State of the request

Some of them also include hierarchical information. Thus, physicians point to health facilities, health facilities point to locations and these to regions. This information is used in the forms to show the right available values depending on the parent choice in the hierarchy.

===State of the request===
From the ''state of the request'' tab, only the ''label'' field can be edited. Notice that this indicates the different phases a request goes through in the application during its lifecycle, and not only a passive value to be stored.

==Technical configuration==
The ''Laboratory areas'', ''Kinds of sample'', ''Sample incidents'', ''Sample origins'' and ''Pregnancy phases'' tabs, have exactly the same effect as the ones under the [[#Generic configuration|generic configuration]] (i.e., they simply provide the available values in drop boxes).
However, the following tabs have further effects in the behaviour of the forms.

===Analytical tests===
[[File:Analyticalprofile.PNG|right|thumb|700px| Editing analytical profiles]]
This is without doubt the most crucial concept in the configuration, since it defines the available kinds of tests in the laboratory.
They are identified by a name, but also contain a code that will always be shown next to the name.
To facilitate the management of the laboratory, kinds of tests are assigned to a laboratory area, which will be used both in the generation of reports for the patients, as well as in the analysis of data regarding the performance of the laboratory itself.

Each kind of test is then related to a kind of sample.
Only after that kind of sample is provided by the patient, the corresponding test will be allowed to have an associated result.

Each test must have a [[#Datatypes|datatype]], which indicates the kind of result it will accept, this being either numerical (integer or real) or enumerate.
For numerical test results, units of the test can be indicated for informative purposes, together with upper and lower bounds of the result can be defined.
These will be automatically checked.
Only results within the declared boundaries will get a green tick next to them.
Those outside the boundaries will be detected and automatically marked with a red cross.
Validating the value will rely anyway on the laboratory supervisor.
However, a note can be provided here to indicate exceptions to the boundaries or any information that is considered relevant to either the technician or the supervisor.

Finally, there are two specific boolean fields:
* Referred → Indicates that an action or test is performed in another hospital. The option marked in the configuration only determines the default of this field for each test. It does not impede the laboratory supervisor from choosing differently in the [[Requests|Requests]] forms.
* Automatic → Enables the kind of test to be partially automated. The result of the test is not manually obtained by a person, but by an AI. If this option is disabled in the configuration, the laboratory supervisor will not be able to mark it otherwise in the [[Requests|Requests]] forms. However, if it is enabled, the laboratory supervisor will be able to choose if she desires for the test to be done automatically or not in the [[Requests|Requests]] forms.

===Analytical tests groups===
In this tab, groups of tests can be formed for a quicker selection when choosing which tests to perform on a patient. When creating or editing a new group, a ''Group Of Tests Information'' form must be filled in or modified. In this form, the group must be given a name and the laboratory supervisor must choose the tests included in the group from the box provided. In the left-hand side list, the groups are in alphabetical order and if the laboratory supervisor wishes for a quicker option, there is a search bar on top of the box to write down and filter the tests.
Simply clicking on the name of a test adds it to the group, hence appearing in the right-hand side list.

The analytical tests groups are also used to sort the tests in the generated report of a request.

===Analytical profiles===
In this tab, profiles of tests can be formed for a quicker selection when choosing which groups of tests or individual tests to perform on a patient.
When creating or editing a new profile, an ''Analytical Profile Information'' form must be filled in or modified.
In this form, the profile must be given a name and the laboratory supervisor must choose the tests and the groups included in the profile from the lists provided.
The groups and tests are in alphabetical order and if the laboratory supervisor wishes for a quicker option, there is a search bar on top of the box to write down and filter the tests and groups.

Choosing a group selects in the corresponding list all the tests belonging to it.
Then, these cannot be individually removed from the profile, but only by removing the group.
Moreover, a test added later to the group will automatically appear as part of any profile containing that group, which is indicated by a lock icon next to the test name.

Analytical profiles do not have any effect in the report generated for a request.

===Datatypes===

Enumerate datatypes can be defined here (integer and real numbers are always available).
These are simply lists of potential results that can be used in any kind of test.

===Reporting order===
[[File:Reportingorder.PNG|Centre|500px|thumb|Editing the laboratory areas order from the reporting areas tab]]
This tab allows ordering the elements in the PDF worklist and in the report of a request.
The tests appearing in them will be firstly sorted by laboratory area, then groups of tests, and finally individual tests.
This is done by choosing one of the three elements, which will lead to another form with a list and two vertical arrows on the left side of the image.
Any number of elements can be simultaneously selected by simply clicking on them.
Then, the arrows will allow to move them up or down in the list, and hence in the generated PDF documents.

Data analysis

2024-01-12T15:10:44Z

Wikiroot:

[[Category:Data analysis]]
<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"];
//----- Data Analysis graph
// Nodes
DataAnalysis [label="Data Analysis"];
GlobalIndicators [label="Global Indicators" shape=tab URL="#Global_indicators" ];
TestsPerLaboratoryArea [label="Tests Per Laboratory Area" shape=tab URL="#Tests_per_laboratory_area"];
TestsPerKind [label="Tests Per Kind" shape=tab URL="#Tests_per_kind"];
// Edges
DataAnalysis -> GlobalIndicators;
DataAnalysis -> TestsPerLaboratoryArea;
DataAnalysis -> TestsPerKind;
}
</graphviz>
</div>

This provides a very basic analytical functionality based on counters.
It basically allows the laboratory supervisor to keep track of the number of tests performed (potentially grouped) and some basic elements related to the requests.

==Database queries==
[[File:DataAnalysis.PNG|350px|right|thumb|Data analysis form]]
This form contains a filter at the top of the screen, which allows the laboratory supervisor to choose the parameter for the database search.
There are nine filter fields available, at most (only those being used in the existing requests are shown).
#From (request's creation date): the data taken will only contain requests created after this date.
#Until (request's creation date): the data taken will only contain requests created before this date.
#Test request state
#Laboratory area
#Requesting centre
#Requesting unit
#Patient's gender
#Patient's provenance region
#Patient's provenance location

Not all filters are always visible. If the ARIS database does not contain values for a specific element, the filter for this element will not be shown to the laboratory supervisor.

===Global indicators===
This tab contains a table with counters, which shows the laboratory supervisor the number of certain elements that are in the ARIS database.

===Tests per laboratory area===
This tab groups together all of the tests that belong to each laboratory area and shows the laboratory supervisor the number of each one.</br>
At the bottom left of this tab, there is a download button. When clicked, this button will download every piece of information found in the screen, into the laboratory supervisor's computer.

===Tests per kind===
This tab groups together all of the kinds of tests and shows the laboratory supervisor the number of each one. It also informs the laboratory supervisor as to which laboratory area each kind of test belongs to.</br>
At the bottom left of this tab, there is a download button. When clicked, this button will download every piece of information found in the screen, into the laboratory supervisor's computer.

===Tests per gender===
This tab groups together all of the tests that belong to each gender and shows the laboratory supervisor the number of each one.</br>
At the bottom left of this tab, there is a download button. When clicked, this button will download every piece of information found in the screen, into the laboratory supervisor's computer.

Requests

2024-01-12T15:10:17Z

Wikiroot:

[[Category:Requests]]

Requests are the most important entities in ARIS, whose main purpose is to manage them.
They are always associated to a given patient, who must have been created before hand.
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph RequestsDiagram {
node [shape="oval" style=filled fillcolor="orange" fontsize="9pt"];
//edge [minlen=2];
//----- Requests graph
// Nodes
Requests [label="Requests" ];
Create [label="Create", URL="#Create" ];
ChangeInformation [label="Change Information", URL="#Change_information"];
PatientsData [label="Patients' Data", shape="tab", URL="#Create"];
AdditionalInformation [label="Additional Information", shape="tab", URL="#Create"];
BiologicalSamples [label="Biological Samples", shape="tab", URL="#Create" ];
AnalyticalTests [label="Analytical Tests", shape="tab", URL="#Create" ];
DeliverSamples [label="Deliver Samples", URL="#Deliver_samples" ];
IntroduceResults [label="Introduce Results", URL="#Introduce_results" ];
ValidateResults [label="Validate Results", URL="#Validate_results"];
SearchHistoric [label="Search Historic", URL="#Search_historic"];
// Edges
Requests -> Create;
Requests -> ChangeInformation;
Create -> PatientsData;
ChangeInformation -> PatientsData;
PatientsData -> AdditionalInformation [dir=both minlen=2];
AdditionalInformation -> BiologicalSamples [dir=both minlen=2];
BiologicalSamples -> AnalyticalTests [dir=both minlen=2];
Requests -> DeliverSamples
DeliverSamples -> BiologicalSamples;
Requests -> IntroduceResults;
IntroduceResults -> AnalyticalTests;
Requests -> ValidateResults;
ValidateResults -> AnalyticalTests;
Requests -> SearchHistoric;

{ rank=same; Create ChangeInformation DeliverSamples ValidateResults IntroduceResults SearchHistoric}
{ rank=same; PatientsData AdditionalInformation BiologicalSamples AnalyticalTests}
}
</graphviz>
</div>
__TOC__

==Request Lifespan==
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph StatesDiagram {
node [shape=rectangle style=rounded fontsize="9pt"];
edge [fontsize="7pt"];
//----- Main graph
// Nodes
Begin [label="" shape="circle" style=filled fillcolor=black fixedsize=true width=0.2 height=0.2];
Registered [label="Registered"];
Processing [label="Processing"];
WithResults [label="WithResults"];
Validated [label="Validated"];
Cancelled [label="Cancelled"];
End [label="" shape="doublecircle" style=filled fillcolor="black" fixedsize=true width=0.2 height=0.2];
// Edges
Begin -> Registered [constraint=false];
Registered -> Processing [label="Some sample delivered" constraint=false];
Processing -> WithResults [label="All results provided" constraint=false];
WithResults -> Validated [label="All tests validated" constraint=false];
Validated -> End [constraint=false];
Registered -> Cancelled [label="Cancel"];
Processing -> Cancelled [label="Cancel"];
WithResults -> Cancelled [label="Cancel"];
Cancelled -> End [constraint=false];

{ rank=same; Begin Registered Processing WithResults Validated}
{ rank=same; Cancelled End}
}
</graphviz>
</div>
During their lifespan, requests go through some different states that determine the functionalities offered for them in the system.
These states are depicted in the diagram, and their labels are configurable at [[Configuration#State_of_the_request|State of the request]].

On creation, the state of the request is ''Registered'', and allows to provide the basic information, as well as associate different tests to it.
After indicating that some of the samples has been delivered, the state changes to ''Processing'' and the data of the request cannot be modified anymore.
Other samples can be delivered later, but at this point, results can be provided for the tests whose sample was already delivered.
Once all non-cancelled tests have a result, the state of the request changes to ''WithResults''.
At this state, results can still be modified, but they are expected to be eventually validated.
A request with all its non-cancelled tests being validated is considered ''Validated''.

At any time, a request, its samples or its tests can be cancelled.
A sample with all its tests cancelled is considered cancelled, and a request with all samples cancelled is considered cancelled, too.

During the lifespan of a request, it is available to the laboratory technicians, except for the validation, which can only be done by a laboratory supervisor.

==Create==
[[File:Selectpatient.PNG|350px|right|thumb|Create request form]]

This form is divided into steps. The step the laboratory technician is on is indicated by the number of the step turning orange.
Once the step is filled with the required information, the circle marking the step will stay orange and the number in said circle will change into a check mark (&check;) [[File:Tick.PNG|30px]].
#Select a patient → The first step involves searching and selecting a patient. The search grid can be narrowed down with the search field. Once a patient is selected, the main and important information about this patient will be displayed at the bottom of the form in a table. Until the patient has been selected, the laboratory technician cannot continue to the next step. To continue to the next step, the laboratory technician must press the ''next'' button found at the bottom right of the form.
#Basic information → To complete this step, only the requesting center is required, but other optional fields are provided like requesting unit and physician, or the room and bed of the patient. Additional information like a diagnostic orientation or the pregnancy status can also be indicated. At the bottom right of the page, on top of the ''Next'' button, there is a checkbox labelled '''Urgent''', check this box if this request must be prioritized. [[File:Urgent.PNG|100px]]
#Analytical tests → In this step, the laboratory technician must choose which tests, groups or profiles are requested for the patient. More than one element from each list may be chosen, but at least one test must be requested one way or another. Tests selected as part of a group or profile (highlighted in purple) cannot be deselected individually.
#Biological samples → This step informs the laboratory technician of the type of sample that must be taken, depending on the tests chosen in the previous step. There are no required fields in this step, but if the laboratory technician wants to add a comment, there is a comment box for each sample. [[File:Comments.PNG|1000px]]

At any moment, the ''next'' button cannot be used if any of the required fields is not filled in.
In every step, there is a ''Previous'' button for the laboratory technician to be able to navigate back and forth between steps and alter the information they contain.

==Change information==
[[File:SearchRequest.PNG|350px|right|thumb|Change information form]]

This form is for editing requests whose samples were not yet delivered.
Clicking on any part of the row will bring the laboratory technician to a form similar to the [[#Create|create]] one, with all of its tabs and similar format and behavior.

==Deliver samples==
Similarly to the previous form, this also displays a list of either ''Registered'' or ''Processing'' requests, for the laboratory technician to choose one of them.
[[File:DeliverSamples.PNG|350px|right|thumb|Deliver samples form]]
Once a request is chosen, five tabs are shown with the patient's data, the request data, its list of biological samples, and potentially analytical already done in this request, and tests in previous requests.
The first and last two are read-only (if enabled at all).
Just the biological samples allows some interaction.

Each of the samples shown contains a field to provide comments, and it can be either checked as delivered or cancelled by click the corresponding red button.
On the delivering of a sample, its origin or incident can be optionally provided.
On cancelling, a pop-up dialog allows to provide some justification for this.

It is important to notice that the tests associated to the request cannot be changed once the first sample as been delivered.

==Introduce results==
As in the previous cases, a list of requests is shown.
In this case, this list contains all requests in ''Processing'' state.
Clicking the corresponding button at the bottom, it is possible to download a worklist with all pending tests in these requests, to work on them off-line.

[[File:IntroduceResults.PNG|350px|right|thumb|IntroduceResults form]]

Once the laboratory technician has chosen a request, five tabs are shown with the patient's data, the request data, its list of biological samples, its list of analytical tests, and potentially previous tests of the same patient.
The first tree and last one are read-only.
Just the analytical tests allows some interaction.
Besides the same search box present in all the tables in the system, there is also the possibility of filtering the tests by group of tests (if any was chosen for this request).
A red button in the top right corner allows to cancel the request.

The table of tests contains the following columns
#Name → Shows the name and the code of the kind of test. It is colored red if either the test or its sample was cancelled.
#Result → Allows to introduce the result of the test.
#Generic test note → Shows the informative note associated to the kind of test, if any.
#Result within range → Indicates whether the result of the test is in the expected range of values for the kind of test (green check) or not (red cross).
#Referred → Indicates whether the test is done or expected to be done in another laboratory (green check) or not (red cross).
#Automatic (not visible by default) → Indicates whether the test is done or expected to be done automatically (green check) or not (red cross). Automatic tests are done by means of the [[Microscope:Main|Robotized microscope]] and the [[MobileApp:Main|Mobile App]]. Their results should not be typed manually, but uploaded through Bluetooth. This feature is enabled through the corresponding [[System_administration#Parameters|system parameter]]. If enabled, the field is editable here to allow overwriting the automatic results.
#The test has some note → Indicates whether the test has some associated note (green check) or not (red cross). Tests whose results were generated automatically will always have an associated note.
#Test details → This should show an icon to navigate to further details of the test. However, if the test or its corresponding sample was cancelled, the corresponding message in red will be shown.

[[File:TestDetails.PNG|350px|right|thumb|Test details]]

On the laboratory technician accessing the details of the test, we gain access to visualize many other things (i.e., units of the result, inferior reference measure, superior reference measure, the use who introduced the results, as well as details provided for the corresponding sample on delivering it).
Moreover, this also allows to change if the test is automatic or deferred, indicate some incidence on the sample, of provide some note.
It is important to notice that any of the information provided in this form will not be persisted in the disk until back in the list and saved from there.

If the result of the test was provided automatically (which is not enabled by default and only available in the context of the [[Main_Page|IMAGING]] project), the corresponding image and its associated note will be shown at the bottom of the details of the test.

==Validate results==
[[File:Validateresults.mp4|left]]
This functionality, available only to the laboratory supervisor, uses exactly the same interface as introducing results, but the table shows one more column ''Validated'' with a checkbox for each test.
These can be checked one by one, or all at once by choosing a concrete group of tests in the dropbox at the top.
On doing the latter, a button to check all the tests of the group will appear.

Besides doing it in the list, the results can be overwritten and the test validated from the details of the test.
Together with displaying all the information related to the test in read-only mode, the corresponding form also offers the possibility of adding a note to the test, as well as changing whether the test is automatic/referred or not, cancelling the test or the whole request.

It is important to notice that the tests will not be really validated until the bottom right button is pressed to save the changes.

==Search historic==
[[File:Download.mp4|left]]
This functionality, available to both laboratory technician and supervisor allows to see any request in the history of the laboratory.
They can be filtered out by the state and the date of the request.
By clicking on the corresponding row, all the details of the request can be visualized.

At the bottom left of this form, there are two download buttons.
Clicking any of them will generate and download the corresponding file (i.e., CSV or ZIP).
The checkboxes in the [[System administration#Downloaded fields|Downloaded fields]] tab indicate which fields will be included in each of these files.
Moreover, the ZIP file is password protected.
The password used is indicated by the system parameter ''zip_password'', whose value can be seen and modified from [[System administration#Parameters|Parameters]] tab.

Patients

2024-01-12T15:09:32Z

Wikiroot:

[[Category:Patients]]

The basic information unit is the patient.
Before creating any analytical request, the corresponding patient record must exist.
This will survive the livespan of the request, and will contain all their history.

<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg' rendered='dot'>
digraph FunctionalitiesDiagram {
node [shape=oval style=filled fillcolor=orange fontsize="9pt"];
//----- Patients graph
// Nodes
Patients [label="Patients"];
P_Create [label="Create", URL="#Create"];
P_Search [label="Search", URL="#Search"];
P_BasicInformation [label="Basic Information", shape="tab", URL="#Create"];
P_BirthData [label="Birth Information", shape="tab", URL="#Create"];
P_ContactData [label="Contact Information", shape="tab", URL="#Create"];
P_ResidenceData [label="Residency Information", shape="tab", URL="#Create"];
P_AdditionalInformation [label="Extra Information", shape="tab", URL="#Create"];
P_Requests [label="Requests", shape="tab", URL="#Create"];
// Edges
Patients -> P_Create;
Patients -> P_Search;
P_Create -> P_BasicInformation;
P_Search -> P_BasicInformation;
P_Search -> P_Requests;
P_BasicInformation -> P_BirthData [dir=both minlen=2];
P_BirthData -> P_ContactData [dir=both minlen=2];
P_ContactData -> P_ResidenceData [dir=both minlen=2];
P_ResidenceData -> P_AdditionalInformation [dir=both minlen=2];

{ rank=same; P_BasicInformation P_BirthData P_ContactData P_ResidenceData P_AdditionalInformation P_Requests}
}
</graphviz>
</div>

__FORCETOC__
==Create==
This form is divided into steps. The step the laboratory technician is on is marked by the number of the step turning orange.
[[File:Createpatientssection.PNG|center|750px]]
Once the step is filled with the required information, the circle marking the step will stay orange and the number in said circle will change into a check mark (&check;) [[File:Tick.PNG|30px]]
#Basic information of the patient → The first step involves the obligatory entry of the name, last name and gender of the patient, as indicated by the asterisk, [[File:Asterisk.PNG|30px]]. Further information is optional. To continue to the next step, the laboratory technician must press the ''next'' button found at the bottom right of the form.
#Birth information → To complete this step, only the birthdate is required. To input this information, the laboratory technician has two options. They can fill in the information with the format given, or they can click on the little calendar icon, [[File:Calendar.PNG|30px]], and select the correct date. Once this information is filled in, the box next to it will automatically be filled with the patient's current age.
#Contact information → One phone number must be assigned to a patient for further contact.
#Residency information → This step has no required fields, but it contains a checkbox at the bottom, ''Add provenance region?''. This option is for when a patient, although local, has come from outside the country. When the box is ticked, two more boxes appear on the forms, ''Provenance region'' and ''Provenance city''. [[File:Addprovenanceregion.PNG|750px]]
#Extra information → This step has no required fields. The ''Reserved 1, 2 and 3'' are boxes whose names can be modified through the [[System administration|System administration]] if the laboratory requires any specific information from the patients.
#Requests → This actually not a step in the creation or update of the patient, but just a read-only tab containing all the requests of the patient.

The ''next'' button cannot be used if any of the required fields are not filled in. In every step, apart from step 1, there is a ''Previous'' button for the laboratory technician to be able to navigate back and forth between steps and alter the information they contain.

==Search and Edition==

{| class="wikitable" style="margin:auto"
|+ Table found in the Search function of the system
|-
! Name !! Phone !! Identification !! Creation Date !! Last Modification Date
|-
| The first column shows the patient's name || The patient's contact number is listed in this column || Here, the internal, automatically generated identification number can be found || This column informs about when the patient's information was first inputted into the system || The last time the patient's information was altered in the system is shown here
|}

Arrows appear next to each heading in the table when the mouse is hovered over them to manipulate the order the information is showed in for each heading.

On clicking on any row, a new form will appear with the age, gender, phone and internal identifier of the patient as well as tabs with the information on the patient's documentation information, birth information, contact information, residency information, extra information and requests. From this page, the laboratory technician can also edit the patient through the edit patient button at the bottom left of the page. To return to the search patients page, there is a Return button at the top left of the screen

Notice that to avoid inconsistences in the system, patients once created cannot be deleted.

==Duplicate Detection==
[[File:Duplicate_detection_-_Made_with_Clipchamp.mp4|right|500px]]
The e-mail address, as well as the Identifier document number optionally identify a patient.
Besides this, to guarantee the existence of an identifier for each patient, a consecutive number is always automatically generated and internally assigned by the system.
Moreover, patients of similar name, age and telephone number are detected as potential duplicates at creation time.
On happening, a warning is displayed, and the laboratory technician can either modify the corresponding data or move ahead with the creation.

User Guide

2024-01-12T15:08:55Z

Wikiroot:

[[Category:User Guide]]
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__

==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|''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 [[#Profile|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 [[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 [[MobileApp:Main|Mobile App]] in case of automatic tests. From the moment the icon is orange, all the behavior is managed from the [[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.

Backup and Restore

2024-01-12T15:06:54Z

Wikiroot:

[[Category:Backup and Restore]]

==Backup==

The backup process for ARIS application involves regularly creating backups of the application's database to ensure data safety and the ability to restore the system in case of any issues. Here is a step-by-step guide on how the the backup is perfomred and how to customize it:

1.'''Access technical administration page:''' Log in to the application as an administrator and go to the Technical Administration section, then find the parameters tab. This section provides access to the backup-related parameters and settings.

2. '''Set Backup Frequency:''' In the parameters tab, locate the backup_frequency parameter. This parameter determines how often the backups will be created. Modify this parameter according to your requirements. For example, if you set it to "6", a backup will be created every six hours. By default it will be set as 23 so it will create a backup daily.

3. '''Set Backup History:''' Locate the backup_history parameter in the same tab. This parameter defines the number of backups to retain. Modify this parameter to specify how many backups you want to keep. For instance, if you set it to "5", the system will retain the most recent five backups. By default the parameter is set to three, so the system will only preserve the three most recent backups.

[[File:backup_parameters.png|center|600px|thumb| Parameters of backup settings inside the parameters tab]]

4. '''Find the Backup Folder:''' The backup files will be stored in the ''ARIS/Backend/Database/Backups'' folder. Here you will find all the backup files with the creation date as name.

[[File:backup_folder.png|center|600px|thumb| Backup folder with three backup files]]

The backup process will be done automatic, you just need to modify, if you see it necessary, the parameters presented above. Every time ARIS is launched, it will generate a backup depending on the ''backup_frecuency'' parameter and keep as many as the ''backup_history'' parameter indicates.

IMPORTANT NOTICE: You should realize that creating backups is absolutely useless if you do not regularly copy them out of your machine (e.g., to a USB).

==Restore==

In case of system failure or hard disk crash, you can restore the system from the latest backup file you extracted, following the next steps:

0. '''Stop de application:''' Remember that closing the browser is not enough, but you need to really [[Installation_and_Upgrades#Closing_ARIS|stop the services running in the background]].

1. '''Locate the last available backup:''' You should have extracted it to some external storage device, but if the hard disk didn't fail, you will find it in the backup folder ''C:/Users/Public/ARIS/Backend/Database/Backups'' (by default).

2. '''Delete Existing Database:''' Ensure that the "sql_app.db" file in the ''Database'' folder is either deleted or moved out of the folder. This step ensures that the restored backup will replace the existing database.

[[File:sql_app.png|center|600px|thumb| sql_app.db file at the end of the folder]]

3. '''Locate the Desired Backup:''' In the Backup folder (''ARIS/Backend/Database/Backups''), locate the backup file you want to restore (filename indicates the date with format ''yymmddhhmmss.db''). Choose the most recent backup or the one that suits your needs.

4. '''Copy Backup File:''' Copy the selected backup file.

5. '''Paste and Rename:''' Paste the copied backup file into the ''Database'' folder. Rename the backup file to ''sql_app.db''. This step ensures that the restored backup file becomes the active database file for the application.

6. '''Restart ARIS'''

By following these steps, you can perform regular backups of your application's database and restore the system using any of the previously created backup files. It is important to review and update the ''backup_frequency'' and ''backup_history'' parameters in the Technical Administration section to align with your data retention and backup requirements.

Define new language

2024-01-12T15:06:29Z

Wikiroot:

[[Category:Define new language]]

In this section you will find the information that will help you to add new languages to the ARIS application.

==Introducction==
The multilanguage system of ARIS is implemented through some files, but to add a new language you will only need to know about two of them: ''languageList.json'' and the language JSON files.
You will find these files in the ''lang'' folder in ARIS system files (under "C:\Users\Public\ARIS\Frontend\build" by default in MSWindows).

===''languageList.json''===
This file contains a list of all the languages that the multilanguage system of the ARIS application can handle. All the languages it contains will appear in the dropdown menu on the ARIS navigation bar.
[[File:LanguageList.PNG|none|400px|thumb| ''languageList.json'']]

===Language JSON files===
By default, the ARIS system contains language JSON files that correspond to the Spanish and English languages.
These files contain all the translations of the messages displayed in ARIS interface, following a JSON structure where the key has to be the same in all the language files, you can see the example in the images below.
[[File:EnJson.png|none|400px|thumb| English JSON file]]
[[File:EsJson.png|none|400px|thumb| Spanish JSON file. Notice that the keys for the same words are the same as in both files]]

==How to add a new language?==
Thanks to how the multilanguage system is implemented, in order to add a new language not provided by default in the distribution, you only have to follow two simple steps that we explain below.

· '''Step 1:''' Add a new language JSON file. Remember that it must follow the same structure as the files for other languages, so they must all contain the same keys. We recommend naming the new files as the [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO 639-1] code of the new language.

· '''Step 2:''' Add the new language to the ''languageList.json'' file just as the other languages already listed.
''{"fileName": "NewLanguageCode", "label": "NewLanguageName"},''

You don't have to worry about modifying any other file, if you have followed the above two steps you have successfully added a new language to the ARIS system, that will automatically be added to the [[User Guide#Language|Language]] in the [[User Guide#Navigation bar|Navigation bar]].

Installation and Upgrades

2024-01-12T15:05:30Z

Wikiroot:

[[Category:Installation and Upgrades]]
<div style="float:left; margin: 0px 20px 0px 0px">__TOC__</div>
This is a step-by-step guide on how install and run the ARIS application. It contains information about its requirements, installation and upgrades.
<BR/><BR/><BR/><BR/><BR/><BR/><BR/>

==Installing ARIS==
[[File:Warning.png|left|70px|]]
It is possible that when installing or running the application for the first time an administrator permissions window or a firewall windows will pop up. You should not worry much about it, and just accept it since the application will need the permissions to connect to internet to write the necessary files on your hard disk.

To start the installation, you have to execute the ''ARIS_Setup'' file, which is the installer of the application, available in different languages (notice that this is different from the language of the application itself).
This will open a window where you can select the language of the installation instructions.
Simply choose the language you are most familiar with.
[[File:ARIS1.png|none|400px|thumb| ARIS installer language selector]]

Once you select the language and click on the accept button, on the following screens you only have to click on the ''Next'' button. Notice that the ''Create a desktop shortcut'' is selected by default, we recommend selecting it.
[[File:ARIS21.png|none|400px|thumb| Select ''Create a desktop shortcut'' for easy access to the application]]

The next step is to click on the install button in the next window. This will install all the necessary files for the application to function properly.
[[File:ARIS31.png|none|400px|thumb| Click ''Install'' to start the application installation ]]

If everything went well a final window will show a satisfactory message, as it can be observed in the following image. To finalize the installation press the ''Finish'' button of the window.
[[File:ARIS41.png|none|400px|thumb| Finish the application installation ]]

==[[File:IconOrange.png|left|20px]] Running ARIS==

If you created a link in your desktop, just double-click it. Otherwise, go to the folder where you installed it (''C:\Users\Public\ARIS'' by default in MSWindows) and double click ''ARIS.exe''. The execution will open the ARIS services that will run in the background, you will find a new icon at the ''hide icon menu'' in the Operating system toolbar (typically on the bottom right of the screen). In addition, it will also open a new browser tab with the application running. Please be patient, this will take a while as the application needs to wait first for the services to start up in the background in order to work properly.
<div style="display: flex; justify-content: center;">
<div>
[[File:Aris_icon_bar.png|thumb|400px|ARIS icon at the hide icon menu]]
</div>
<div>
[[File:Aris_icon_expanded_bar.png|thumb|400px|ARIS icon at the expanded hide icon menu]]
</div>
</div>

===Initial configuration===
[[File:LoginFirstMessage.png|right|300px|thumb| Message on login the empty system]]

On logging for the first time, a warning appears highlighting that there are no users in the system.
Hence, access is automatically granted and a new ''System Administrator'' is created with the provided username and password (any values are accepted at this stage and recorded for further use in the system).

Congratulations! you have successfully installed and executed the new ARIS application.
[[File:ARIS5.png|center|600px|thumb| You should see a browser tab with the application running like this]]

As a first important note, the system has three different [[System administration#Roles|roles]] with different and complementary functionalities.
Consequently, the first necessary thing is to [[System_administration#Users|create two more users]] with the other two roles ''Laboratory Technician'' and ''Laboratory Supervisor''.

Once the other two users are created, it is important to notice that the initial setting contains some real values for most of the features like laboratory areas or services, but not for other configurable lists of values like regions, locations or health facilities which only contain a fake exemplary instance.
This exemplary instances should be replaced by real ones before starting to introduce patients and requests in the system.
This should be done through the [[Configuration|Configuration]] functionalities by the ''System Administrator'' and ''Laboratory supervisor''.

==Upgrading ARIS==
[[File:updater1.png|right|600px|thumb|Select one of the options]]
To upgrade the application you will only need an Internet connection. Once you are connected to the Internet, if there is a new version of ARIS, a pop-up window will appear the next time that you open the application showing three options asking you to update it. The behavior of these options is described below:

· '''Update now''': This option will open a window with a progress bar and a button that you must press to start the update of the software, once this is updated (should take a few minutes), a message window will appear with a successful message, when you click on ''Accept'' the program will start with the last version.

· '''No (Defer for 30 days)''': If you click this option, the software will not be updated and no update message will appear until 30 days have passed.

· '''Remind me later''': Clicking on this option will not update the software, but the next time you launch the system, the update message will appear again.

==Closing ARIS==
[[File:Aris_close.png|thumb|right|400px|Close option when clicking on the ARIS icon to close services]]
When yo want to close the application you will need to follow two easy steps:

# The first step is to close the browser tab where the application is running. This will only close the visual part of the application (i.e., opening again the browser and providing the same URL will still take you to the application), so be sure to execute the second step to actually interrupt the services running in the background.
# In the second step you will need to right click on the ARIS icon located at the "hide icon menu" in the operating system toolbar, then click on close. This will finalize the services that were running on the background, it is important to finalize the services or otherwise you will not be able to reopen the application again (also this is the way to reset ARIS in case of any unstable behaviour).

Main Page

2024-01-12T15:04:19Z

Wikiroot:

[[Category:Main]]
<div style="float:left; margin: 0px 20px 0px 0px">__TOC__</div>
[[File:LogoProbitas.png|right|thumb|250px|link=https://www.fundacionprobitas.org|Probitas Foundation]]

ARIS is a laboratory software system for patient management, analysis and laboratory tests. It offers basic functionalities and a simple interface that can be flexibly configured to support the main tasks of a laboratory. ARIS has been designed specifically by [https://www.fundacionprobitas.org Probitas Foundation] and it is available to laboratories free of charge.

These pages contain all the useful information for both final users as well as administrators.

==Installation and Upgrades==
[[File:Main page.PNG|right|thumb|Main page of the software]]

First of all, the application needs to be installed in a regular computer. It will automatically install some required software platforms. The [[Installation and Upgrades|Installation and Upgrades]] page contains all the details and step by step instructions to do it. If an Internet connection is at hand, it can also be upgraded when a new version is available, as explained in the same page.

The application has been developed with native support in English and Spanish, however, it supports multilanguage. The [[Define new language|Define new language]] page explains how to extend it to other languages.

==User Guide==

The [[User Guide|User Guide]] page contains all the information necessary for both final users as well as administrators. It explains all functionalities provided by the application.

==Backup and Restore==

As for any other information system, it is important to extract a copy of the database regularly, and move it to another support for safety reasons. The [[Backup and Restore|Backup and Restore]] page explains how such copy can be generated and accessed, as well as used to recover all the data in the unlikely case of database corruption.

MediaWiki:Breadcrumbs

2024-01-12T14:58:01Z

Wikiroot:

User Guide

2024-01-12T14:51:55Z

Wikiroot: Wikiroot moved page ARIS:User Guide to User Guide without leaving a redirect

[[Category:ARIS:User Guide]]
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="[[ARIS:Patients]]"];
// Edges
ARIS -> Patients;
//----- Requests graph
// Nodes
Requests [label="Requests" URL="[[ARIS:Requests]]"];
// Edges
ARIS -> Requests;
//----- Data Analysis graph
// Nodes
DataAnalysis [label="Data Analysis" URL="[[ARIS:Data_analysis]]"];
// Edges
ARIS -> DataAnalysis;
//----- Configuration graph
// Nodes
Configuration [label="Configuration" URL="[[ARIS:Configuration]]"];
// Edges
ARIS -> Configuration;
//----- System Administration graph
// Nodes
SystemAdministration [label="System Administration" URL="[[ARIS:System_administration]]"];
// Edges
ARIS -> SystemAdministration;
//----- System Information graph
// Nodes
SystemInformation [label="System Information"];
// Edges
ARIS -> SystemInformation;}
</graphviz>
</div>
__TOC__

==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 [[ARIS: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 [[ARIS: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
|-
| [[ARIS:Patients|Patients]] [[File:Patients.PNG|25px|right]] || Create and edit patients, as well as navigate through the patients list.
|-
| [[ARIS:Requests|Requests]] [[File:Requests.PNG|25px|right]] || Create and edit requests, as well as different types of search.
|-
| [[ARIS:Data analysis|Data analysis]] [[File:Data_Analysis.PNG|25px|right]] || Basic statistics on the performance of the laboratory.
|-
| [[ARIS:Configuration|Configuration]] [[File:Configuration.PNG|25px|right]] || Options offered by the system in the different dropboxes of the forms.
|-
| [[ARIS: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 [[ARIS: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 [[ARIS: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 [[ARIS:Requests#Introduce results|Introduce results]], [[ARIS:Requests#Validate results|Validate results]], as well as the [[ARIS: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 [[ARIS:Patients#Search|''search patients'']] or [[ARIS: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 [[#Profile|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 [[ARIS:System administration|system administration]] functionality and going to the [[ARIS: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 [[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 [[ARIS: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 [[ARIS: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 [[MobileApp:Main|Mobile App]] in case of automatic tests. From the moment the icon is orange, all the behavior is managed from the [[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.

System administration

2024-01-12T14:51:44Z

Wikiroot: Wikiroot moved page ARIS:System administration to System administration without leaving a redirect

[[Category:ARIS:System administration]]
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border="frame" format="svg">
digraph AdministrationDiagram {
node [shape=oval style=filled fillcolor=orange fontsize="9pt"];
//----- System Administration graph
// Nodes
SystemAdministration [label="System Administration"];
Generic [label="Generic" URL="#Generic"];
Technical [label="Technical" URL="#Technical"];
Users [label="Users" shape=tab URL="#Users"];
AccessLog [label="Access Log" shape=tab URL="#Access_log"];
DownloadedFields [label="Downloaded Fields" shape=tab URL="#Downloaded_fields"];
SummaryOfInstances [label="Summary of Instances" shape=tab URL="#Summary_of_instances"];
Roles [label="Roles" shape=tab URL="#Roles"];
Parameters [label="Parameters" shape=tab URL="#Parameters"];
// Edges
SystemAdministration -> Generic;
SystemAdministration -> Technical;
// Edges
Generic -> Users;
Generic -> AccessLog;
Generic -> DownloadedFields;
// Edges
Technical -> SummaryOfInstances;
Technical -> Roles;
Technical -> Parameters;
}
</graphviz>
</div>

This groups all knobs that allow to manage and adapt the behavior of ARIS to the needs of the laboratory and user preferences.
They are grouped in two to facilitate their access.
The first one is more generic and allows both laboratory supervisor and system administration to access some basic stuff.
The second one is only available to the system administrator, since it is considered to require more advance technological skills.

==Generic==
This groups all the basic administration functionalities.
They are available for both the system administration and the laboratory supervisor.
===Users===
[[File:Newuser.PNG|right|thumb|750px|User creation form]]
When clicking on the edit or ''New user'' buttons, a form pops up on the screen. The information necessary to create a user consists of a ''Username'', ''Name'', ''Middle name'', ''password'' and the person's [[#Roles|Role]] within the system.
This Role will determine the functionalities available to the user.
A note, without any effect in the behavior of the application can be added to indicate any relevant information to the system administrator.

This same form allows the system administrator to modify the password of any other user.
For security reasons, this password must contain some number, some capital letter, some small letter, and at least eight characters.

Since they are used to audit changes in patients and requests, the users cannot be deleted from the system.
However, they can be declared not to be active, which would prevent them from logging in, but still keep track in the database of all their past actions.

===Access log===
The ''access log'' shows the user which user has done an action within the system and exactly when. The timestamp is in the format '''Year-Month-Day Hour:Minute:Second'''
[[File:Accesslog.PNG|right|thumb|600px|Example of access log]]</br>
There are three actions recorded by the access log, ''successful log in'', ''wrong user'' and ''failed log in''. This last action refers to the wrong password being used.

===Downloaded fields===
ARIS allows the laboratory supervisor to download all the information in the database into a single file in their computer.
There are two possible download options, depending of the format of the generated file being plain CSV, or compressed and password protected ZIP.
These documents will contain information on the requests, and by extension, on the corresponding patients.
Thus, due to patient confidentiality, not all of the personal data should be in the downloaded file.
The checkboxes in this form allow the laboratory supervisor as well as the system administrator to decide which fields will be downloaded in each one of the formats.

==Technical==
This groups all the more advanced administration functionalities.
They are available only for the system administration.

===Summary of instances===
[[File:Summaryofinstancessmol.PNG|right|250px|thumb|Summary of instances]]
This tab displays information about the different existing instances in the application.
Some examples are: the number of patients, users, requests or genders.
This information comes directly from the database and is automatically updated after every modification in the system.
It can be useful to investigate potential performance problems is case of extremely large numbers.
To facilitate the reading and identification of the different kinds of instances, the information is divided into three sections: ''Data'', ''Administration'' and ''Configuration''.

===Roles===
This tab is displayed and works, in the same way as the [[ARIS:Configuration#State of the request|State of the request]] tab in the [[ARIS:Configuration|Configuration]] functionality.
The roles are unchangeable, but their labels (not the corresponding functionality) can be customized.

Each role has different actions allowed within the application, chosen due to the tasks the people are expected to carry out.
Thus, there are three roles within the system, which indicate the functionalities that a user can perform, as can be seen in the following table.

{| class="wikitable" style="margin:auto; text-align: center;"
|+ Allowed functionalities per role
|-
!colspan="2"| Functionalities !! Laboratory Technician !! Laboratory Supervisor !! System administrator
|-
| style="text-align:left;" rowspan="2" | Patient || style="text-align:left;" | Create || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Search || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" rowspan="6" | Request || style="text-align:left;" | Create || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Change information || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Deliver samples || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Introduce results || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Validate results || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" | Search historic || [[File:Tick.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" colspan="2" | Data analysis || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" rowspan="2" | Configuration || style="text-align:left;" | Generic || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Tick.png|frameless|25px]]
|-
| style="text-align:left;" | Technical || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Cross.png|frameless|25px]]
|-
| style="text-align:left;" rowspan="2" | Administration || style="text-align:left;"| Generic || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Tick.png|frameless|25px]]
|-
| style="text-align:left;" | Technical || [[File:Cross.png|frameless|25px]] || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]]
|}

===Parameters===
Parameters determine the behavior of some functionalities.
Thus, they cannot be created or deleted.
However, their values can be updated to customize the system.
At this point it is important to highlight the on updating them, the data type must be respected.
Providing a value of the wrong data type (e.g., a string instead of an integer) can provoke the malfunction of the whole application.

The following table contains the list of existing parameters together with the corresponding data type and a brief description.

{| class="wikitable" style="margin:auto; text-align: left;"
|+ System parameters
|-
! Name !! Data type !! Description
|-
| ''version'' || String || Version of the system
|-
| ''name'' || String || Caption to appear at the top of the screen, in the navigation bar
|-
| ''default_language'' || String || Language set by default on logging in (the same for all users)
|-
| ''timeout'' || Integer || Time (in minutes) after wich the connection to the backend requires a new log in
|-
| ''table_default_paging'' || Integer || This indicates the initial paging of all the tables (accepted values are 5, 10 or 25)
|-
| ''table_min_rows_for_search'' || Integer || This is the minimum number of rows a table must have to show the corresponding search field
|-
| ''attribute_reserved1'' || String || Label of the first field of free use in the requests (write 'DoNotShow' to hide it)
|-
| ''attribute_reserved2'' || String || Label of the second field of free use in the requests (write 'DoNotShow' to hide it)
|-
| ''attribute_reserved3'' || String || Label of the third field of free use in the requests (write 'DoNotShow' to hide it)
|-
| ''filename_background'' || String || File containing the image displayed in the background
|-
| ''filename_sidebarlogo'' || String || File containing the logo displayed at the bottom of the sidebar
|-
| ''filename_favicon'' || String || Icon of the system used in the browser tab
|-
| ''bluetooth_enabler'' || String || Indicates the availability of automatic tests through Bluetooth connection (accepted values are 'Enabled' and 'Disabled'), which is only used in the [[Main_Page|IMAGING project]]
|-
| ''zip_password'' || String || This is the password that will be used to generate the downloaded zip file
|-
| ''log_history'' || Integer || Maximum number of days to keep registries in the access log (those older than this will be automatically deleted)
|-
| ''backup_frequency'' || Integer || Minimum amount of hours that need to pass for the system to generate a new copy of the database
|-
| ''backup_history'' || Integer || Maximum number of copies of the database kept (once reached, oldest copy in the folder is deleted)
|-
| ''max_image_volume'' || Integer || Maximum number of megabytes used to store images (once reached, oldest ones in the folder are deleted)
|-
| ''filename_worklistlogo'' || String || Logo used in the worklist reports
|}

Requests

2024-01-12T14:51:33Z

Wikiroot: Wikiroot moved page ARIS:Requests to Requests without leaving a redirect

[[Category:ARIS:Requests]]

Requests are the most important entities in ARIS, whose main purpose is to manage them.
They are always associated to a given patient, who must have been created before hand.
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph RequestsDiagram {
node [shape="oval" style=filled fillcolor="orange" fontsize="9pt"];
//edge [minlen=2];
//----- Requests graph
// Nodes
Requests [label="Requests" ];
Create [label="Create", URL="#Create" ];
ChangeInformation [label="Change Information", URL="#Change_information"];
PatientsData [label="Patients' Data", shape="tab", URL="#Create"];
AdditionalInformation [label="Additional Information", shape="tab", URL="#Create"];
BiologicalSamples [label="Biological Samples", shape="tab", URL="#Create" ];
AnalyticalTests [label="Analytical Tests", shape="tab", URL="#Create" ];
DeliverSamples [label="Deliver Samples", URL="#Deliver_samples" ];
IntroduceResults [label="Introduce Results", URL="#Introduce_results" ];
ValidateResults [label="Validate Results", URL="#Validate_results"];
SearchHistoric [label="Search Historic", URL="#Search_historic"];
// Edges
Requests -> Create;
Requests -> ChangeInformation;
Create -> PatientsData;
ChangeInformation -> PatientsData;
PatientsData -> AdditionalInformation [dir=both minlen=2];
AdditionalInformation -> BiologicalSamples [dir=both minlen=2];
BiologicalSamples -> AnalyticalTests [dir=both minlen=2];
Requests -> DeliverSamples
DeliverSamples -> BiologicalSamples;
Requests -> IntroduceResults;
IntroduceResults -> AnalyticalTests;
Requests -> ValidateResults;
ValidateResults -> AnalyticalTests;
Requests -> SearchHistoric;

{ rank=same; Create ChangeInformation DeliverSamples ValidateResults IntroduceResults SearchHistoric}
{ rank=same; PatientsData AdditionalInformation BiologicalSamples AnalyticalTests}
}
</graphviz>
</div>
__TOC__

==Request Lifespan==
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph StatesDiagram {
node [shape=rectangle style=rounded fontsize="9pt"];
edge [fontsize="7pt"];
//----- Main graph
// Nodes
Begin [label="" shape="circle" style=filled fillcolor=black fixedsize=true width=0.2 height=0.2];
Registered [label="Registered"];
Processing [label="Processing"];
WithResults [label="WithResults"];
Validated [label="Validated"];
Cancelled [label="Cancelled"];
End [label="" shape="doublecircle" style=filled fillcolor="black" fixedsize=true width=0.2 height=0.2];
// Edges
Begin -> Registered [constraint=false];
Registered -> Processing [label="Some sample delivered" constraint=false];
Processing -> WithResults [label="All results provided" constraint=false];
WithResults -> Validated [label="All tests validated" constraint=false];
Validated -> End [constraint=false];
Registered -> Cancelled [label="Cancel"];
Processing -> Cancelled [label="Cancel"];
WithResults -> Cancelled [label="Cancel"];
Cancelled -> End [constraint=false];

{ rank=same; Begin Registered Processing WithResults Validated}
{ rank=same; Cancelled End}
}
</graphviz>
</div>
During their lifespan, requests go through some different states that determine the functionalities offered for them in the system.
These states are depicted in the diagram, and their labels are configurable at [[ARIS:Configuration#State_of_the_request|State of the request]].

On creation, the state of the request is ''Registered'', and allows to provide the basic information, as well as associate different tests to it.
After indicating that some of the samples has been delivered, the state changes to ''Processing'' and the data of the request cannot be modified anymore.
Other samples can be delivered later, but at this point, results can be provided for the tests whose sample was already delivered.
Once all non-cancelled tests have a result, the state of the request changes to ''WithResults''.
At this state, results can still be modified, but they are expected to be eventually validated.
A request with all its non-cancelled tests being validated is considered ''Validated''.

At any time, a request, its samples or its tests can be cancelled.
A sample with all its tests cancelled is considered cancelled, and a request with all samples cancelled is considered cancelled, too.

During the lifespan of a request, it is available to the laboratory technicians, except for the validation, which can only be done by a laboratory supervisor.

==Create==
[[File:Selectpatient.PNG|350px|right|thumb|Create request form]]

This form is divided into steps. The step the laboratory technician is on is indicated by the number of the step turning orange.
Once the step is filled with the required information, the circle marking the step will stay orange and the number in said circle will change into a check mark (&check;) [[File:Tick.PNG|30px]].
#Select a patient → The first step involves searching and selecting a patient. The search grid can be narrowed down with the search field. Once a patient is selected, the main and important information about this patient will be displayed at the bottom of the form in a table. Until the patient has been selected, the laboratory technician cannot continue to the next step. To continue to the next step, the laboratory technician must press the ''next'' button found at the bottom right of the form.
#Basic information → To complete this step, only the requesting center is required, but other optional fields are provided like requesting unit and physician, or the room and bed of the patient. Additional information like a diagnostic orientation or the pregnancy status can also be indicated. At the bottom right of the page, on top of the ''Next'' button, there is a checkbox labelled '''Urgent''', check this box if this request must be prioritized. [[File:Urgent.PNG|100px]]
#Analytical tests → In this step, the laboratory technician must choose which tests, groups or profiles are requested for the patient. More than one element from each list may be chosen, but at least one test must be requested one way or another. Tests selected as part of a group or profile (highlighted in purple) cannot be deselected individually.
#Biological samples → This step informs the laboratory technician of the type of sample that must be taken, depending on the tests chosen in the previous step. There are no required fields in this step, but if the laboratory technician wants to add a comment, there is a comment box for each sample. [[File:Comments.PNG|1000px]]

At any moment, the ''next'' button cannot be used if any of the required fields is not filled in.
In every step, there is a ''Previous'' button for the laboratory technician to be able to navigate back and forth between steps and alter the information they contain.

==Change information==
[[File:SearchRequest.PNG|350px|right|thumb|Change information form]]

This form is for editing requests whose samples were not yet delivered.
Clicking on any part of the row will bring the laboratory technician to a form similar to the [[#Create|create]] one, with all of its tabs and similar format and behavior.

==Deliver samples==
Similarly to the previous form, this also displays a list of either ''Registered'' or ''Processing'' requests, for the laboratory technician to choose one of them.
[[File:DeliverSamples.PNG|350px|right|thumb|Deliver samples form]]
Once a request is chosen, five tabs are shown with the patient's data, the request data, its list of biological samples, and potentially analytical already done in this request, and tests in previous requests.
The first and last two are read-only (if enabled at all).
Just the biological samples allows some interaction.

Each of the samples shown contains a field to provide comments, and it can be either checked as delivered or cancelled by click the corresponding red button.
On the delivering of a sample, its origin or incident can be optionally provided.
On cancelling, a pop-up dialog allows to provide some justification for this.

It is important to notice that the tests associated to the request cannot be changed once the first sample as been delivered.

==Introduce results==
As in the previous cases, a list of requests is shown.
In this case, this list contains all requests in ''Processing'' state.
Clicking the corresponding button at the bottom, it is possible to download a worklist with all pending tests in these requests, to work on them off-line.

[[File:IntroduceResults.PNG|350px|right|thumb|IntroduceResults form]]

Once the laboratory technician has chosen a request, five tabs are shown with the patient's data, the request data, its list of biological samples, its list of analytical tests, and potentially previous tests of the same patient.
The first tree and last one are read-only.
Just the analytical tests allows some interaction.
Besides the same search box present in all the tables in the system, there is also the possibility of filtering the tests by group of tests (if any was chosen for this request).
A red button in the top right corner allows to cancel the request.

The table of tests contains the following columns
#Name → Shows the name and the code of the kind of test. It is colored red if either the test or its sample was cancelled.
#Result → Allows to introduce the result of the test.
#Generic test note → Shows the informative note associated to the kind of test, if any.
#Result within range → Indicates whether the result of the test is in the expected range of values for the kind of test (green check) or not (red cross).
#Referred → Indicates whether the test is done or expected to be done in another laboratory (green check) or not (red cross).
#Automatic (not visible by default) → Indicates whether the test is done or expected to be done automatically (green check) or not (red cross). Automatic tests are done by means of the [[Microscope:Main|Robotized microscope]] and the [[MobileApp:Main|Mobile App]]. Their results should not be typed manually, but uploaded through Bluetooth. This feature is enabled through the corresponding [[ARIS:System_administration#Parameters|system parameter]]. If enabled, the field is editable here to allow overwriting the automatic results.
#The test has some note → Indicates whether the test has some associated note (green check) or not (red cross). Tests whose results were generated automatically will always have an associated note.
#Test details → This should show an icon to navigate to further details of the test. However, if the test or its corresponding sample was cancelled, the corresponding message in red will be shown.

[[File:TestDetails.PNG|350px|right|thumb|Test details]]

On the laboratory technician accessing the details of the test, we gain access to visualize many other things (i.e., units of the result, inferior reference measure, superior reference measure, the use who introduced the results, as well as details provided for the corresponding sample on delivering it).
Moreover, this also allows to change if the test is automatic or deferred, indicate some incidence on the sample, of provide some note.
It is important to notice that any of the information provided in this form will not be persisted in the disk until back in the list and saved from there.

If the result of the test was provided automatically (which is not enabled by default and only available in the context of the [[Main_Page|IMAGING]] project), the corresponding image and its associated note will be shown at the bottom of the details of the test.

==Validate results==
[[File:Validateresults.mp4|left]]
This functionality, available only to the laboratory supervisor, uses exactly the same interface as introducing results, but the table shows one more column ''Validated'' with a checkbox for each test.
These can be checked one by one, or all at once by choosing a concrete group of tests in the dropbox at the top.
On doing the latter, a button to check all the tests of the group will appear.

Besides doing it in the list, the results can be overwritten and the test validated from the details of the test.
Together with displaying all the information related to the test in read-only mode, the corresponding form also offers the possibility of adding a note to the test, as well as changing whether the test is automatic/referred or not, cancelling the test or the whole request.

It is important to notice that the tests will not be really validated until the bottom right button is pressed to save the changes.

==Search historic==
[[File:Download.mp4|left]]
This functionality, available to both laboratory technician and supervisor allows to see any request in the history of the laboratory.
They can be filtered out by the state and the date of the request.
By clicking on the corresponding row, all the details of the request can be visualized.

At the bottom left of this form, there are two download buttons.
Clicking any of them will generate and download the corresponding file (i.e., CSV or ZIP).
The checkboxes in the [[ARIS:System administration#Downloaded fields|Downloaded fields]] tab indicate which fields will be included in each of these files.
Moreover, the ZIP file is password protected.
The password used is indicated by the system parameter ''zip_password'', whose value can be seen and modified from [[ARIS:System administration#Parameters|Parameters]] tab.

Patients

2024-01-12T14:51:21Z

Wikiroot: Wikiroot moved page ARIS:Patients to Patients without leaving a redirect

[[Category:ARIS:Patients]]

The basic information unit is the patient.
Before creating any analytical request, the corresponding patient record must exist.
This will survive the livespan of the request, and will contain all their history.

<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg' rendered='dot'>
digraph FunctionalitiesDiagram {
node [shape=oval style=filled fillcolor=orange fontsize="9pt"];
//----- Patients graph
// Nodes
Patients [label="Patients"];
P_Create [label="Create", URL="#Create"];
P_Search [label="Search", URL="#Search"];
P_BasicInformation [label="Basic Information", shape="tab", URL="#Create"];
P_BirthData [label="Birth Information", shape="tab", URL="#Create"];
P_ContactData [label="Contact Information", shape="tab", URL="#Create"];
P_ResidenceData [label="Residency Information", shape="tab", URL="#Create"];
P_AdditionalInformation [label="Extra Information", shape="tab", URL="#Create"];
P_Requests [label="Requests", shape="tab", URL="#Create"];
// Edges
Patients -> P_Create;
Patients -> P_Search;
P_Create -> P_BasicInformation;
P_Search -> P_BasicInformation;
P_Search -> P_Requests;
P_BasicInformation -> P_BirthData [dir=both minlen=2];
P_BirthData -> P_ContactData [dir=both minlen=2];
P_ContactData -> P_ResidenceData [dir=both minlen=2];
P_ResidenceData -> P_AdditionalInformation [dir=both minlen=2];

{ rank=same; P_BasicInformation P_BirthData P_ContactData P_ResidenceData P_AdditionalInformation P_Requests}
}
</graphviz>
</div>

__FORCETOC__
==Create==
This form is divided into steps. The step the laboratory technician is on is marked by the number of the step turning orange.
[[File:Createpatientssection.PNG|center|750px]]
Once the step is filled with the required information, the circle marking the step will stay orange and the number in said circle will change into a check mark (&check;) [[File:Tick.PNG|30px]]
#Basic information of the patient → The first step involves the obligatory entry of the name, last name and gender of the patient, as indicated by the asterisk, [[File:Asterisk.PNG|30px]]. Further information is optional. To continue to the next step, the laboratory technician must press the ''next'' button found at the bottom right of the form.
#Birth information → To complete this step, only the birthdate is required. To input this information, the laboratory technician has two options. They can fill in the information with the format given, or they can click on the little calendar icon, [[File:Calendar.PNG|30px]], and select the correct date. Once this information is filled in, the box next to it will automatically be filled with the patient's current age.
#Contact information → One phone number must be assigned to a patient for further contact.
#Residency information → This step has no required fields, but it contains a checkbox at the bottom, ''Add provenance region?''. This option is for when a patient, although local, has come from outside the country. When the box is ticked, two more boxes appear on the forms, ''Provenance region'' and ''Provenance city''. [[File:Addprovenanceregion.PNG|750px]]
#Extra information → This step has no required fields. The ''Reserved 1, 2 and 3'' are boxes whose names can be modified through the [[ARIS:System administration|System administration]] if the laboratory requires any specific information from the patients.
#Requests → This actually not a step in the creation or update of the patient, but just a read-only tab containing all the requests of the patient.

The ''next'' button cannot be used if any of the required fields are not filled in. In every step, apart from step 1, there is a ''Previous'' button for the laboratory technician to be able to navigate back and forth between steps and alter the information they contain.

==Search and Edition==

{| class="wikitable" style="margin:auto"
|+ Table found in the Search function of the system
|-
! Name !! Phone !! Identification !! Creation Date !! Last Modification Date
|-
| The first column shows the patient's name || The patient's contact number is listed in this column || Here, the internal, automatically generated identification number can be found || This column informs about when the patient's information was first inputted into the system || The last time the patient's information was altered in the system is shown here
|}

Arrows appear next to each heading in the table when the mouse is hovered over them to manipulate the order the information is showed in for each heading.

On clicking on any row, a new form will appear with the age, gender, phone and internal identifier of the patient as well as tabs with the information on the patient's documentation information, birth information, contact information, residency information, extra information and requests. From this page, the laboratory technician can also edit the patient through the edit patient button at the bottom left of the page. To return to the search patients page, there is a Return button at the top left of the screen

Notice that to avoid inconsistences in the system, patients once created cannot be deleted.

==Duplicate Detection==
[[File:Duplicate_detection_-_Made_with_Clipchamp.mp4|right|500px]]
The e-mail address, as well as the Identifier document number optionally identify a patient.
Besides this, to guarantee the existence of an identifier for each patient, a consecutive number is always automatically generated and internally assigned by the system.
Moreover, patients of similar name, age and telephone number are detected as potential duplicates at creation time.
On happening, a warning is displayed, and the laboratory technician can either modify the corresponding data or move ahead with the creation.

Installation and Upgrades

2024-01-12T14:50:49Z

Wikiroot: Wikiroot moved page ARIS:Installation and Upgrades to Installation and Upgrades without leaving a redirect

[[Category:ARIS:Installation and Upgrades]]
<div style="float:left; margin: 0px 20px 0px 0px">__TOC__</div>
This is a step-by-step guide on how install and run the ARIS application. It contains information about its requirements, installation and upgrades.
<BR/><BR/><BR/><BR/><BR/><BR/><BR/>

==Installing ARIS==
[[File:Warning.png|left|70px|]]
It is possible that when installing or running the application for the first time an administrator permissions window or a firewall windows will pop up. You should not worry much about it, and just accept it since the application will need the permissions to connect to internet to write the necessary files on your hard disk.

To start the installation, you have to execute the ''ARIS_Setup'' file, which is the installer of the application, available in different languages (notice that this is different from the language of the application itself).
This will open a window where you can select the language of the installation instructions.
Simply choose the language you are most familiar with.
[[File:ARIS1.png|none|400px|thumb| ARIS installer language selector]]

Once you select the language and click on the accept button, on the following screens you only have to click on the ''Next'' button. Notice that the ''Create a desktop shortcut'' is selected by default, we recommend selecting it.
[[File:ARIS21.png|none|400px|thumb| Select ''Create a desktop shortcut'' for easy access to the application]]

The next step is to click on the install button in the next window. This will install all the necessary files for the application to function properly.
[[File:ARIS31.png|none|400px|thumb| Click ''Install'' to start the application installation ]]

If everything went well a final window will show a satisfactory message, as it can be observed in the following image. To finalize the installation press the ''Finish'' button of the window.
[[File:ARIS41.png|none|400px|thumb| Finish the application installation ]]

==[[File:IconOrange.png|left|20px]] Running ARIS==

If you created a link in your desktop, just double-click it. Otherwise, go to the folder where you installed it (''C:\Users\Public\ARIS'' by default in MSWindows) and double click ''ARIS.exe''. The execution will open the ARIS services that will run in the background, you will find a new icon at the ''hide icon menu'' in the Operating system toolbar (typically on the bottom right of the screen). In addition, it will also open a new browser tab with the application running. Please be patient, this will take a while as the application needs to wait first for the services to start up in the background in order to work properly.
<div style="display: flex; justify-content: center;">
<div>
[[File:Aris_icon_bar.png|thumb|400px|ARIS icon at the hide icon menu]]
</div>
<div>
[[File:Aris_icon_expanded_bar.png|thumb|400px|ARIS icon at the expanded hide icon menu]]
</div>
</div>

===Initial configuration===
[[File:LoginFirstMessage.png|right|300px|thumb| Message on login the empty system]]

On logging for the first time, a warning appears highlighting that there are no users in the system.
Hence, access is automatically granted and a new ''System Administrator'' is created with the provided username and password (any values are accepted at this stage and recorded for further use in the system).

Congratulations! you have successfully installed and executed the new ARIS application.
[[File:ARIS5.png|center|600px|thumb| You should see a browser tab with the application running like this]]

As a first important note, the system has three different [[ARIS:System administration#Roles|roles]] with different and complementary functionalities.
Consequently, the first necessary thing is to [[ARIS:System_administration#Users|create two more users]] with the other two roles ''Laboratory Technician'' and ''Laboratory Supervisor''.

Once the other two users are created, it is important to notice that the initial setting contains some real values for most of the features like laboratory areas or services, but not for other configurable lists of values like regions, locations or health facilities which only contain a fake exemplary instance.
This exemplary instances should be replaced by real ones before starting to introduce patients and requests in the system.
This should be done through the [[ARIS:Configuration|Configuration]] functionalities by the ''System Administrator'' and ''Laboratory supervisor''.

==Upgrading ARIS==
[[File:updater1.png|right|600px|thumb|Select one of the options]]
To upgrade the application you will only need an Internet connection. Once you are connected to the Internet, if there is a new version of ARIS, a pop-up window will appear the next time that you open the application showing three options asking you to update it. The behavior of these options is described below:

· '''Update now''': This option will open a window with a progress bar and a button that you must press to start the update of the software, once this is updated (should take a few minutes), a message window will appear with a successful message, when you click on ''Accept'' the program will start with the last version.

· '''No (Defer for 30 days)''': If you click this option, the software will not be updated and no update message will appear until 30 days have passed.

· '''Remind me later''': Clicking on this option will not update the software, but the next time you launch the system, the update message will appear again.

==Closing ARIS==
[[File:Aris_close.png|thumb|right|400px|Close option when clicking on the ARIS icon to close services]]
When yo want to close the application you will need to follow two easy steps:

# The first step is to close the browser tab where the application is running. This will only close the visual part of the application (i.e., opening again the browser and providing the same URL will still take you to the application), so be sure to execute the second step to actually interrupt the services running in the background.
# In the second step you will need to right click on the ARIS icon located at the "hide icon menu" in the operating system toolbar, then click on close. This will finalize the services that were running on the background, it is important to finalize the services or otherwise you will not be able to reopen the application again (also this is the way to reset ARIS in case of any unstable behaviour).

Define new language

2024-01-12T14:50:34Z

Wikiroot: Wikiroot moved page ARIS:Define new language to Define new language without leaving a redirect

[[Category:ARIS:Define new language]]

In this section you will find the information that will help you to add new languages to the ARIS application.

==Introducction==
The multilanguage system of ARIS is implemented through some files, but to add a new language you will only need to know about two of them: ''languageList.json'' and the language JSON files.
You will find these files in the ''lang'' folder in ARIS system files (under "C:\Users\Public\ARIS\Frontend\build" by default in MSWindows).

===''languageList.json''===
This file contains a list of all the languages that the multilanguage system of the ARIS application can handle. All the languages it contains will appear in the dropdown menu on the ARIS navigation bar.
[[File:LanguageList.PNG|none|400px|thumb| ''languageList.json'']]

===Language JSON files===
By default, the ARIS system contains language JSON files that correspond to the Spanish and English languages.
These files contain all the translations of the messages displayed in ARIS interface, following a JSON structure where the key has to be the same in all the language files, you can see the example in the images below.
[[File:EnJson.png|none|400px|thumb| English JSON file]]
[[File:EsJson.png|none|400px|thumb| Spanish JSON file. Notice that the keys for the same words are the same as in both files]]

==How to add a new language?==
Thanks to how the multilanguage system is implemented, in order to add a new language not provided by default in the distribution, you only have to follow two simple steps that we explain below.

· '''Step 1:''' Add a new language JSON file. Remember that it must follow the same structure as the files for other languages, so they must all contain the same keys. We recommend naming the new files as the [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO 639-1] code of the new language.

· '''Step 2:''' Add the new language to the ''languageList.json'' file just as the other languages already listed.
''{"fileName": "NewLanguageCode", "label": "NewLanguageName"},''

You don't have to worry about modifying any other file, if you have followed the above two steps you have successfully added a new language to the ARIS system, that will automatically be added to the [[ARIS:User Guide#Language|Language]] in the [[ARIS:User Guide#Navigation bar|Navigation bar]].

Data analysis

2024-01-12T14:50:15Z

Wikiroot: Wikiroot moved page ARIS:Data analysis to Data analysis without leaving a redirect

[[Category:ARIS:Data analysis]]
<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"];
//----- Data Analysis graph
// Nodes
DataAnalysis [label="Data Analysis"];
GlobalIndicators [label="Global Indicators" shape=tab URL="#Global_indicators" ];
TestsPerLaboratoryArea [label="Tests Per Laboratory Area" shape=tab URL="#Tests_per_laboratory_area"];
TestsPerKind [label="Tests Per Kind" shape=tab URL="#Tests_per_kind"];
// Edges
DataAnalysis -> GlobalIndicators;
DataAnalysis -> TestsPerLaboratoryArea;
DataAnalysis -> TestsPerKind;
}
</graphviz>
</div>

This provides a very basic analytical functionality based on counters.
It basically allows the laboratory supervisor to keep track of the number of tests performed (potentially grouped) and some basic elements related to the requests.

==Database queries==
[[File:DataAnalysis.PNG|350px|right|thumb|Data analysis form]]
This form contains a filter at the top of the screen, which allows the laboratory supervisor to choose the parameter for the database search.
There are nine filter fields available, at most (only those being used in the existing requests are shown).
#From (request's creation date): the data taken will only contain requests created after this date.
#Until (request's creation date): the data taken will only contain requests created before this date.
#Test request state
#Laboratory area
#Requesting centre
#Requesting unit
#Patient's gender
#Patient's provenance region
#Patient's provenance location

Not all filters are always visible. If the ARIS database does not contain values for a specific element, the filter for this element will not be shown to the laboratory supervisor.

===Global indicators===
This tab contains a table with counters, which shows the laboratory supervisor the number of certain elements that are in the ARIS database.

===Tests per laboratory area===
This tab groups together all of the tests that belong to each laboratory area and shows the laboratory supervisor the number of each one.</br>
At the bottom left of this tab, there is a download button. When clicked, this button will download every piece of information found in the screen, into the laboratory supervisor's computer.

===Tests per kind===
This tab groups together all of the kinds of tests and shows the laboratory supervisor the number of each one. It also informs the laboratory supervisor as to which laboratory area each kind of test belongs to.</br>
At the bottom left of this tab, there is a download button. When clicked, this button will download every piece of information found in the screen, into the laboratory supervisor's computer.

===Tests per gender===
This tab groups together all of the tests that belong to each gender and shows the laboratory supervisor the number of each one.</br>
At the bottom left of this tab, there is a download button. When clicked, this button will download every piece of information found in the screen, into the laboratory supervisor's computer.

Configuration

2024-01-12T14:50:05Z

Wikiroot: Wikiroot moved page ARIS:Configuration to Configuration without leaving a redirect

[[Category:ARIS:Configuration]]

The configuration functionality allows the user to manipulate ARIS, adding or changing some of its aspects for a better customization.
These have been divided into two groups, depending on the knowledge needed to use them.
The first group is absolutely generic and both laboratory supervisor and system administrator should be able to provide the required information.
However, for the second group, more specific biomedical knowledge will be needed, and consequently only the laboratory supervisor is allowed to do it.

<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph ConfigurationDiagram {
nodesep=0.05;
node [shape=oval style=filled fillcolor=orange fontsize="9pt" margin="0.01, 0.01"];

Configuration [label="Configuration"];
ConfGeneric [label="Generic", URL="#Generic_configuration"];
ConfTechnical [label="Technical", URL="#Technical_configuration"];

Configuration -> ConfGeneric;
Configuration -> ConfTechnical;

Regions [label="Regions", shape=tab, URL="#Generic_configuration"];
Locations [label="Locations", shape=tab, URL="#Generic_configuration"];
Units [label="Units", shape=tab, URL="#Generic_configuration"];
HealthFacilities [label="Health, Facilities" shape=tab, URL="#Generic_configuration"];
Physicians [label="Physicians", shape=tab, URL="#Generic_configuration"];
Gender [label="Gender", shape=tab, URL="#Generic_configuration"];
IdentificationCards [label="Identification Cards", shape=tab, URL="#Generic_configuration"];
StateOfTheRequest [label="State of the Request", shape=tab URL="#State_of_the_request"];

ConfGeneric -> Regions;
ConfGeneric -> Locations;
ConfGeneric -> Units;
ConfGeneric -> HealthFacilities;
ConfGeneric -> Physicians;
ConfGeneric -> Gender;
ConfGeneric -> IdentificationCards;
ConfGeneric -> StateOfTheRequest;

LaboratoryAreas [label="Laboratory Areas", shape=tab, URL="#Technical_configuration"];
AnalyticalTests [label="Analytical Tests", shape=tab URL="#Analytical_tests"];
AnalyticalTestsGroups [label="Analytical Tests Groups", shape=tab URL="#Analytical_tests_groups"];
AnalyticalProfiles [label="Analytical Profiles", shape=tab URL="#Analytical_profiles"];
KindsOfSamples [label="Kinds of Samples", shape=tab, URL="#Technical_configuration"];
SampleIncidents [label="Sample Incidents", shape=tab, URL="#Technical_configuration"];
SampleOrigins [label="Sample Origins", shape=tab, URL="#Technical_configuration"];
PregnancyPhases [label="Pregnancy Phases", shape=tab, URL="#Technical_configuration"];
DataTypes [label="Datatypes", shape=tab, URL="#Datatypes"];
ReportingOrder [label="Reporting Order", shape=tab, URL="#Reporting_order"];

ConfTechnical -> LaboratoryAreas;
ConfTechnical -> AnalyticalTests;
ConfTechnical -> AnalyticalTestsGroups;
ConfTechnical -> AnalyticalProfiles;
ConfTechnical -> KindsOfSamples;
ConfTechnical -> SampleIncidents;
ConfTechnical -> SampleOrigins;
ConfTechnical -> PregnancyPhases;
ConfTechnical -> DataTypes;
ConfTechnical -> ReportingOrder;

{ rank=same; Regions Units Physicians IdentificationCards LaboratoryAreas AnalyticalTestsGroups KindsOfSamples SampleOrigins DataTypes}
{ rank=same; ConfGeneric ConfTechnical}
{ rank=sink; Locations HealthFacilities Gender StateOfTheRequest AnalyticalTests AnalyticalProfiles SampleIncidents PregnancyPhases ReportingOrder}}
</graphviz>
</div>

__TOC__

==Generic configuration==
[[File:Genericconfiguration.PNG|right|600px|thumb|Editing the labels used for the states]]
This form controls the values of all non-free text fields (i.e., those that appear when clicking on an [[ARIS:User Guide#Arrow|arrow]]) within the system. Through each tab, the user is able to create, edit and delete the values of one of these fields.
If the laboratory is not interested in one of the values, but the user does not wish to delete the information from the system, it can be simply disabled, so it will not be shown in the corresponding drop-down menu. This is done by unticking the ''Active'' checkbox. </br> [[File:Activecheckbox.PNG|75px|Activated checkbox]] ⇔ [[File:Deactivatedcheckbox.PNG|75px|Deactivated checkbox]] </br>
List of tabs:
*Regions (initially empty)
*Locations (initially empty)
*Units
*Health Facilities (initially empty)
*Physicians (initially empty)
*Gender
*Identification cards
*State of the request

Some of them also include hierarchical information. Thus, physicians point to health facilities, health facilities point to locations and these to regions. This information is used in the forms to show the right available values depending on the parent choice in the hierarchy.

===State of the request===
From the ''state of the request'' tab, only the ''label'' field can be edited. Notice that this indicates the different phases a request goes through in the application during its lifecycle, and not only a passive value to be stored.

==Technical configuration==
The ''Laboratory areas'', ''Kinds of sample'', ''Sample incidents'', ''Sample origins'' and ''Pregnancy phases'' tabs, have exactly the same effect as the ones under the [[#Generic configuration|generic configuration]] (i.e., they simply provide the available values in drop boxes).
However, the following tabs have further effects in the behaviour of the forms.

===Analytical tests===
[[File:Analyticalprofile.PNG|right|thumb|700px| Editing analytical profiles]]
This is without doubt the most crucial concept in the configuration, since it defines the available kinds of tests in the laboratory.
They are identified by a name, but also contain a code that will always be shown next to the name.
To facilitate the management of the laboratory, kinds of tests are assigned to a laboratory area, which will be used both in the generation of reports for the patients, as well as in the analysis of data regarding the performance of the laboratory itself.

Each kind of test is then related to a kind of sample.
Only after that kind of sample is provided by the patient, the corresponding test will be allowed to have an associated result.

Each test must have a [[#Datatypes|datatype]], which indicates the kind of result it will accept, this being either numerical (integer or real) or enumerate.
For numerical test results, units of the test can be indicated for informative purposes, together with upper and lower bounds of the result can be defined.
These will be automatically checked.
Only results within the declared boundaries will get a green tick next to them.
Those outside the boundaries will be detected and automatically marked with a red cross.
Validating the value will rely anyway on the laboratory supervisor.
However, a note can be provided here to indicate exceptions to the boundaries or any information that is considered relevant to either the technician or the supervisor.

Finally, there are two specific boolean fields:
* Referred → Indicates that an action or test is performed in another hospital. The option marked in the configuration only determines the default of this field for each test. It does not impede the laboratory supervisor from choosing differently in the [[ARIS:Requests|Requests]] forms.
* Automatic → Enables the kind of test to be partially automated. The result of the test is not manually obtained by a person, but by an AI. If this option is disabled in the configuration, the laboratory supervisor will not be able to mark it otherwise in the [[ARIS:Requests|Requests]] forms. However, if it is enabled, the laboratory supervisor will be able to choose if she desires for the test to be done automatically or not in the [[ARIS:Requests|Requests]] forms.

===Analytical tests groups===
In this tab, groups of tests can be formed for a quicker selection when choosing which tests to perform on a patient. When creating or editing a new group, a ''Group Of Tests Information'' form must be filled in or modified. In this form, the group must be given a name and the laboratory supervisor must choose the tests included in the group from the box provided. In the left-hand side list, the groups are in alphabetical order and if the laboratory supervisor wishes for a quicker option, there is a search bar on top of the box to write down and filter the tests.
Simply clicking on the name of a test adds it to the group, hence appearing in the right-hand side list.

The analytical tests groups are also used to sort the tests in the generated report of a request.

===Analytical profiles===
In this tab, profiles of tests can be formed for a quicker selection when choosing which groups of tests or individual tests to perform on a patient.
When creating or editing a new profile, an ''Analytical Profile Information'' form must be filled in or modified.
In this form, the profile must be given a name and the laboratory supervisor must choose the tests and the groups included in the profile from the lists provided.
The groups and tests are in alphabetical order and if the laboratory supervisor wishes for a quicker option, there is a search bar on top of the box to write down and filter the tests and groups.

Choosing a group selects in the corresponding list all the tests belonging to it.
Then, these cannot be individually removed from the profile, but only by removing the group.
Moreover, a test added later to the group will automatically appear as part of any profile containing that group, which is indicated by a lock icon next to the test name.

Analytical profiles do not have any effect in the report generated for a request.

===Datatypes===

Enumerate datatypes can be defined here (integer and real numbers are always available).
These are simply lists of potential results that can be used in any kind of test.

===Reporting order===
[[File:Reportingorder.PNG|Centre|500px|thumb|Editing the laboratory areas order from the reporting areas tab]]
This tab allows ordering the elements in the PDF worklist and in the report of a request.
The tests appearing in them will be firstly sorted by laboratory area, then groups of tests, and finally individual tests.
This is done by choosing one of the three elements, which will lead to another form with a list and two vertical arrows on the left side of the image.
Any number of elements can be simultaneously selected by simply clicking on them.
Then, the arrows will allow to move them up or down in the list, and hence in the generated PDF documents.

Bluetooth

2024-01-12T14:49:49Z

Wikiroot: Wikiroot moved page ARIS:Bluetooth to Bluetooth without leaving a redirect

[[Category:ARIS:Bluetooth]]

The Bluetooth feature allows a bidirectional information exchange between the [[ARIS:main|ARIS]] system and the [[MobileApp:Main|Mobile App]]. When enabled, the users will be able to establish a wireless connection with ARIS within the Mobile App, and perform two basic operations from the device.
# Extract from ARIS a list of test identifiers (i.e., a worklist) from those [[ARIS:Configuration#Analytical_tests|Analytical tests]] which are in ''Processing'' state and marked as ''Automatic''.
# Transfer back to ARIS the images taken from each one of those tests, captured with the Mobile app through the microscope.

__TOC__

==Relevant system paremeters==
===''bluetooth_enabler''===
[[File:DownloadingNN.PNG|right|600px|thumb|Window while downloading AI model]]
By default, the Bluetooth functionality is disabled for everybody.
To allow the usage of this feature, a logged ''System Administrator'' must set the 'bluetooth_enabler' parameter to 'Enabled' from the [[ARIS:System_administration#Parameters|Parameters]] configuration page.
Immediately, the download process of the Artificial Intelligence model for automatic image analysis will start, in case that the required file was not previously downloaded.
After this, in case of success (note that internet connection is required in order to perform the download), a Bluetooth icon will be visible to all ''Laboratory Technicians'' in the [[ARIS:User Guide#Navigation bar|Navigation bar]] section, allowing them to enable and disable the Bluetooth connections of the ARIS system by clicking the mentioned icon.

In the same way, the Bluetooth functionality can be disabled anytime by a logged ''System Administrator'' from the same [[ARIS:System_administration#Parameters|Parameters]] configuration page by setting the 'bluetooth_enabler' parameter to 'Disabled'. This change will hide back the Bluetooth icon, preventing ''Laboratory Technitians'' from enabling or disabling Bluetooth connections.

===''max_image_volume''===
The 'max_image_volume' parameter from the [[ARIS:System_administration#Parameters|Parameters]] configuration page refers to the maximum number of megabytes used to store images from the automatically analyzed tests in the whole system. Once the limit is reached, the oldest images in the folder are deleted until the image volume is below the indicated value.

==Usage==
When the Bluetooth functionality is enabled from system [[ARIS:System_administration#Parameters|Parameters]], one of three different icons can be seen in the [[ARIS:User Guide#Navigation bar|Navigation bar]].

===Bluetooth OFF===
[[File:Bluetooth_off.PNG|left|50px]]
A grey Bluetooth OFF icon indicates that, currently, ARIS is not being visible to other devices, such as those running the [[MobileApp:Main|Mobile App]], preventing them from establishing Bluetooth connections with the system.
If clicked, the Bluetooth OFF icon turns into an orange [[ARIS:Bluetooth#Bluetooth_ON|Bluetooth ON]] icon.

===Bluetooth ON===
[[File:Bluetooth_on.PNG|left|50px]]
An orange Bluetooth ON icon indicates that ARIS is visible to other devices, and therefore a [[MobileApp:Main|Mobile App]] can establish a Bluetooth connection with the system whenever needed.
If clicked, the Bluetooth ON icon turns into a grey [[ARIS:Bluetooth#Bluetooth_OFF|Bluetooth OFF]] icon.

===Loading===
[[File:Bluetooth_loading.PNG|left|50px]]
When image transmission using the Bluetooth feature is taking place between the [[MobileApp:Main|Mobile App]] and ARIS, the [[ARIS:Bluetooth#Bluetooth_ON|Bluetooth ON]] icon turns automatically into an animated orange circle. This icon is not clickable and keeps visible while the mentioned procedure is not over. Moreover, a dropdown next to it appears showing, for all tests being transmited, the download progress or the number of images being analyzed, depending on the stage of the process each test is at.
Once the image transmission finalizes, this icon turns automatically into the previous [[ARIS:Bluetooth#Bluetooth_ON|Bluetooth ON]] icon and the dropdown disappears.
[[File:Receiving.png|centre|200px]]

==States==
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg' caption='ARIS Bluetooth states'>
digraph StatesDiagram {
node [shape=rectangle style=rounded fontsize="9pt"];
edge [fontsize="7pt"];
//----- Main graph
// Nodes
Begin [label="" shape="circle" style=filled fillcolor=black fixedsize=true width=0.2 height=0.2];
Waiting [label="Waiting"];
TransferingWorklist [label="Transfering Worklist"];
ReceivingImages [label="Receiving Images"];
ExecutingModel [label="Executing Model"];
End [label="" shape="doublecircle" style=filled fillcolor="black" fixedsize=true width=0.2 height=0.2];
// Edges
Begin -> Waiting [label="Enable Bluetooth"]; // [constraint=false];
Waiting -> TransferingWorklist [label="Mobile request"];
TransferingWorklist -> Waiting; // [constraint=false];
Waiting -> ReceivingImages [label="Mobile request"];
ReceivingImages -> Waiting; // [constraint=false];
ReceivingImages -> ExecutingModel [label="Last image of a test"];
ExecutingModel -> ReceivingImages; // [constraint=false];
Waiting -> End [label="Disable Bluetooth"]; // [constraint=false];

//{ rank=same; Begin Registered Processing WithResults Validated}
//{ rank=same; Cancelled End}
}
</graphviz>
</div>
In any given time, the Bluetooth system can be in four different states if [[ARIS:Bluetooth#Bluetooth_ON|Bluetooth is ON]].
===Waiting===
ARIS is visible to other devices and ready to respond to requests made from the [[MobileApp:Main|Mobile App]]. At this point, it can receive the order to send the current worklist to the Mobile, to receive images from the Mobile or, otherwise, disable any Bluetooth connection by turning the [[ARIS:Bluetooth#Bluetooth_OFF|Bluetooth OFF]] in the [[ARIS:User Guide#Navigation bar|Navigation bar]].

===Transfering Worklist===
ARIS is sending to the [[MobileApp:Main|Mobile App]] that has made the request the list of test identifiers from those [[ARIS:Configuration#Analytical_tests|Analytical tests]] which are in ''Processing'' state and marked as ''Automatic'', known as worklist. Once the transfer is done, ARIS goes back to [[ARIS:Bluetooth#Waiting|Waiting]] state.

===Receiving Images===
ARIS is receiving the images taken from one or more of those previously sent tests, captured with the [[MobileApp:Main|Mobile App]] through the microscope. Every test in the set of images can have as many images as needed. Once the last image of a test is received, the model is executed in parallel for all of the images from that test. Meanwhile, ARIS can keep receiving images of other tests, or go back to [[ARIS:Bluetooth#Waiting|Waiting]] state if no more images are being transferred.

===Executing Model===
ARIS is running the AI Model for all of the previously received images of an [[ARIS:Configuration#Analytical_tests|Analytical test]], in order to automatically analyze them and obtain a diagnosis.

Backup and Restore

2024-01-12T14:49:35Z

Wikiroot: Wikiroot moved page ARIS:Backup and Restore to Backup and Restore without leaving a redirect

[[Category:ARIS:Backup and Restore]]

==Backup==

The backup process for ARIS application involves regularly creating backups of the application's database to ensure data safety and the ability to restore the system in case of any issues. Here is a step-by-step guide on how the the backup is perfomred and how to customize it:

1.'''Access technical administration page:''' Log in to the application as an administrator and go to the Technical Administration section, then find the parameters tab. This section provides access to the backup-related parameters and settings.

2. '''Set Backup Frequency:''' In the parameters tab, locate the backup_frequency parameter. This parameter determines how often the backups will be created. Modify this parameter according to your requirements. For example, if you set it to "6", a backup will be created every six hours. By default it will be set as 23 so it will create a backup daily.

3. '''Set Backup History:''' Locate the backup_history parameter in the same tab. This parameter defines the number of backups to retain. Modify this parameter to specify how many backups you want to keep. For instance, if you set it to "5", the system will retain the most recent five backups. By default the parameter is set to three, so the system will only preserve the three most recent backups.

[[File:backup_parameters.png|center|600px|thumb| Parameters of backup settings inside the parameters tab]]

4. '''Find the Backup Folder:''' The backup files will be stored in the ''ARIS/Backend/Database/Backups'' folder. Here you will find all the backup files with the creation date as name.

[[File:backup_folder.png|center|600px|thumb| Backup folder with three backup files]]

The backup process will be done automatic, you just need to modify, if you see it necessary, the parameters presented above. Every time ARIS is launched, it will generate a backup depending on the ''backup_frecuency'' parameter and keep as many as the ''backup_history'' parameter indicates.

IMPORTANT NOTICE: You should realize that creating backups is absolutely useless if you do not regularly copy them out of your machine (e.g., to a USB).

==Restore==

In case of system failure or hard disk crash, you can restore the system from the latest backup file you extracted, following the next steps:

0. '''Stop de application:''' Remember that closing the browser is not enough, but you need to really [[ARIS:Installation_and_Upgrades#Closing_ARIS|stop the services running in the background]].

1. '''Locate the last available backup:''' You should have extracted it to some external storage device, but if the hard disk didn't fail, you will find it in the backup folder ''C:/Users/Public/ARIS/Backend/Database/Backups'' (by default).

2. '''Delete Existing Database:''' Ensure that the "sql_app.db" file in the ''Database'' folder is either deleted or moved out of the folder. This step ensures that the restored backup will replace the existing database.

[[File:sql_app.png|center|600px|thumb| sql_app.db file at the end of the folder]]

3. '''Locate the Desired Backup:''' In the Backup folder (''ARIS/Backend/Database/Backups''), locate the backup file you want to restore (filename indicates the date with format ''yymmddhhmmss.db''). Choose the most recent backup or the one that suits your needs.

4. '''Copy Backup File:''' Copy the selected backup file.

5. '''Paste and Rename:''' Paste the copied backup file into the ''Database'' folder. Rename the backup file to ''sql_app.db''. This step ensures that the restored backup file becomes the active database file for the application.

6. '''Restart ARIS'''

By following these steps, you can perform regular backups of your application's database and restore the system using any of the previously created backup files. It is important to review and update the ''backup_frequency'' and ''backup_history'' parameters in the Technical Administration section to align with your data retention and backup requirements.

MediaWiki:Breadcrumbs

2024-01-12T14:47:06Z

Wikiroot:

Translations:ARIS:About/Page display title/es

2024-01-12T14:22:51Z

Wikiroot: Created page with "ARIS:About"

ARIS:About

Translations:ARIS:About/2/es

2024-01-12T14:21:10Z

Wikiroot: Created page with "link=https://www.fundacionprobitas.org/en/homelink=http://www.upc.edu"

[[File:LogoProbitas.png|250px|link=https://www.fundacionprobitas.org/en/home]][[File:LogoUPC.png|250px|link=http://www.upc.edu]]

Translations:ARIS:About/1/es

2024-01-12T14:20:58Z

Wikiroot: Created page with "Este proyecto es un esfuerzo conjunto entre [https://www.fundacionprobitas.org/en/home ''Fundació Probitas''] y [http://www.upc.edu ''Universitat Politècnica de Catalunya'' (UPC)]."

Este proyecto es un esfuerzo conjunto entre [https://www.fundacionprobitas.org/en/home ''Fundació Probitas''] y [http://www.upc.edu ''Universitat Politècnica de Catalunya'' (UPC)].

MediaWiki:Aboutsite

2024-01-12T14:16:15Z

Wikiroot:

About ARIS

Main Page

2024-01-12T14:07:10Z

Wikiroot:

[[Category:Main Page]]

<div style="float:left; margin: 0px 20px 0px 0px">__TOC__</div>
[[File:LogoProbitas.png|right|thumb|250px|link=https://www.fundacionprobitas.org|Probitas Foundation]]

ARIS is a laboratory software system for patient management, analysis and laboratory tests. It offers basic functionalities and a simple interface that can be flexibly configured to support the main tasks of a laboratory. ARIS has been designed specifically by [https://www.fundacionprobitas.org Probitas Foundation] and it is available to laboratories free of charge.

These pages contain all the useful information for both final users as well as administrators.

==Installation and Upgrades==
[[File:Main page.PNG|right|thumb|Main page of the software]]

First of all, the application needs to be installed in a regular computer. It will automatically install some required software platforms. The [[ARIS:Installation and Upgrades|Installation and Upgrades]] page contains all the details and step by step instructions to do it. If an Internet connection is at hand, it can also be upgraded when a new version is available, as explained in the same page.

The application has been developed with native support in English and Spanish, however, it supports multilanguage. The [[ARIS:Define new language|Define new language]] page explains how to extend it to other languages.

==User Guide==

The [[ARIS:User Guide|User Guide]] page contains all the information necessary for both final users as well as administrators. It explains all functionalities provided by the application.

==Backup and Restore==

As for any other information system, it is important to extract a copy of the database regularly, and move it to another support for safety reasons. The [[ARIS:Backup and Restore|Backup and Restore]] page explains how such copy can be generated and accessed, as well as used to recover all the data in the unlikely case of database corruption.

MediaWiki:Breadcrumbs

2023-10-14T17:39:04Z

Wikiroot:

MediaWiki:Common.css

2023-10-06T07:31:30Z

Wikiroot:

/* CSS placed here will be applied to all skins */
#catlinks { display: none; }

MediaWiki:Common.css

2023-10-05T15:26:01Z

Wikiroot:

/* CSS placed here will be applied to all skins */
#catlinks { display: none; }

.ns-3000 #content, .ns-3001 #content { background-color: #f3f3ff; }
.ns-3000 div.thumb, .ns-3001 div.thumb { border-color: #f3f3ff; }

MediaWiki:Privacy

2023-10-05T15:03:52Z

Wikiroot: Created page with "-"

MediaWiki:Common.css

2023-10-05T15:02:01Z

Wikiroot:

/* CSS placed here will be applied to all skins */
#catlinks { display: none; }

MediaWiki:Common.css

2023-10-05T15:01:25Z

Wikiroot:

/* CSS placed here will be applied to all skins */
#catlinks { display: none; }

.ns-subject a { /* Almost all links on subject pages to be green. */
color: #0f0;
}
.ns-talk a { /* Links on talk pages to be blue. */
color: #00f;
}