This is a step-by-step guide on how install and run the ARIS application. It contains information about its requirements, installation and upgrades.
This is a step-by-step guide on how install and run the ARIS application. It contains information about its requirements, installation and upgrades.
==Requirements==
<!--T:20-->
To execute the new GLI app you will need to install before, few things on your system that will allow you to run the program without any error, installing these dependencies should take less than 5 minutes.
__TOC__
In the following list you will found the dependencies you need to run it:
· Python 3.7 (The program runs with other python versions, but its correct working is not guaranteed)
==Installing ARIS== <!--T:2-->
[[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.
· Node.js (Latest version preferred)
<!--T:3-->
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]]
===Installing Python===
You will find the proper python installer on its official page which can be accessed from the following link: https://www.python.org/downloads/release/python-379/
Once you are on the page in the Files section, as the following image shows, you will have to install the executable installer for your operating system by clicking on the version name, in this case Windows.
<!--T:4-->
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]]
[[File:PyWeb.png|none|400px|thumb|Installation option from Python web: https://www.python.org/downloads/release/python-379/]]
<!--T:5-->
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 ]]
Open the installer that you have downloaded to continue with the python installation.It will open a new window where some options need to be selected for the correct installation.
You will have to select the Install launcher for all users option and the Add Python 3.7 to PATH option. Once you selected it, continue with the installation by clicking on Install Now.
[[File:PyInstaller1.png|none|400px|thumb| Selected options of the first python installer window]]
''Note: If you can`t select the Install launcher for all users option that means that you had installed a python launcher before only for the current user. You will need to remove the Python launcher on the Add/Remove Programs menu of Windows.''
<!--T:6-->
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 ]]
Before finishing the installation you have to select the Disable path length limit option. Then you will have successfully completed the python installation.
[[File:PyInstaller2.png|none|400px|thumb| Path length option of python installer]]
If you want to check that python was successfully installed, open a MSDOS terminal (just type "cmd" in the MSWindows start menu) and write the following commands in that terminal:
<!--T:8-->
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.
[[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>
''python --version''
===Initial configuration=== <!--T:9-->
''pip --version''
<!--T:21-->
On starting up ARIS for the first time, there are two crucial things that need to be set, namely the encryption key and system administrator password.
If everything went well, these commands will show their versions.
<!--T:27-->
Moreover, some initialization setting to the local facility where ARIS is installed, is also necessary (e.g., city and region names).
===Installing Node.js===
<!--T:28-->
You will find the proper Node.js installer on its official page which can be accessed from the following link: https://nodejs.org/es/
Optionally, WiFi access to the server can also be enabled.
Now that you are on the official page, you have to download the windows installer by clicking on the LTS version, as it can be seen in the following image.
====Encryption key==== <!--T:22-->
[[File:Node1.png|none|400px|thumb| Installation option from Node.js web: https://nodejs.org/es/]]
<!--T:23-->
To guarantee the confidentiality of patients' data, ARIS will encrypt the database. Thus, the first time ARIS is started, an encryption key will be asked to the user. Notice that this key cannot be modified and needs to be kept in a safe place outside the laptop (necessary to restore a backup).
[[File:enterEK.PNG|center|600px|thumb| Window to enter the database encryption key]]
Once you have downloaded the installer, it’s time to execute it. This will open a window where will show the instructions to install Node.js.
<!--T:26-->
Its installation is as simple as clicking the following button in each window (accepting the terms of the License Agreement). The following images show a visual guide of the same.
ARIS will require this encryption key every time the program is started. For this reason, the user will decide how to provide it: manually introduce it every time (only Admin and Supervisor will be able to do it) or store it in a file in the local disk (easier to manage, as anyone can start ARIS up, but hacking the database would be easy). Despite the choice, still remember keeping the encryption key in a safe place. Notice that in case of losing the encryption key, all data stored in the database will be lost.
[[File:EKoptions.PNG|center|600px|thumb| Options to manage the database encryption key]]
====System administrator password==== <!--T:24-->
[[File:LoginFirstMessage.png|right|300px|thumb| Message on login the empty system]]
{| class="wikitable" style="margin:auto"
<!--T:10-->
|+ Visual guide through Node.js installer windows
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). The username can not, but the password can be modified at any time.
| [[File:Node2.png|center|250px|thumb| Click on ''Next'' to continue with the installation]]|| [[File:Node3.png|center|250px|thumb| Accept the terms and continue with the installation]]
|-
| [[File:Node4.png|center|250px|thumb| Click on ''Next'' to continue with the installation]]|| [[File:Node5.png|center|250px|thumb| Click on ''Next'' to continue with the installation]]
|-
| [[File:Node6.png|center|250px|thumb| Make sure that the option is unchecked and click on ''Next'']] || [[File:Node7.png|center|250px|thumb| Finally click on ''Install'']]
|-
| [[File:Node8.png|center|250px|thumb| Click on ''Finish'' to complete the installation]]
|}
<!--T:11-->
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]]
If everything went well, a final window will be displayed with a Finish button that you need to click to complete the installation.
<!--T:12-->
If you want to check that Node.js was successfully installed, open a MSDOS terminal and write the following commands:
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''.
''node --version''
====Features==== <!--T:25-->
''npm --version''
<!--T:13-->
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''.
If everything went well, these commands will show their versions.
====WiFi connection==== <!--T:29-->
==Installing the ARIS application==
<!--T:30-->
ARIS allows other devices in the same network as the PC/laptop running the application to connect to the system and to work cooperatively.
However, ARIS executes by default on “localhost” (i.e., the computer you are currently using, which is a way to access services or resources on your own machine without going over a network), and thus not allowing other devices (even if they are in the same network) to connect to this address. In order to make ARIS available to your network through a [[WiFi Connection|WiFi Connection]], you need to modify the IP address as in the [[WiFi Connection|instructions]].
Before starting this step, make sure that you have installed the necessary requirements, otherwise the application will not be able to run successfully. See the Installing Python and Installing Node.js steps for more information.
==Upgrading ARIS== <!--T:14-->
[[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:
Now that you have installed the necessary requirements, it is time to install the new ARIS application. To start the installation, you have to execute the ARIS_Setup that is the installer of the application.
<!--T:15-->
This will open a window where you can select the language of the installation instructions. Here we choose English, but choose the language you are most familiar with.
· '''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.
The first time you run it, it will take a wile, because in needs to install all the required libraries.
<!--T:16-->
· '''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.
==Running ARIS==
<!--T:17-->
[[File:IconOrange.png|left|20px]]
· '''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.
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". This will open two MSDOS terminals that you should not close, and a tab in your default browser.
The first time you run the application it will contain the "admin" user, whose password is also "admin". You are advised to change it immediately.
==Closing ARIS== <!--T:18-->
[[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:
<!--T:19-->
# 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).
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.
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.
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.
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.
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.
To guarantee the confidentiality of patients' data, ARIS will encrypt the database. Thus, the first time ARIS is started, an encryption key will be asked to the user. Notice that this key cannot be modified and needs to be kept in a safe place outside the laptop (necessary to restore a backup).
Window to enter the database encryption key
ARIS will require this encryption key every time the program is started. For this reason, the user will decide how to provide it: manually introduce it every time (only Admin and Supervisor will be able to do it) or store it in a file in the local disk (easier to manage, as anyone can start ARIS up, but hacking the database would be easy). Despite the choice, still remember keeping the encryption key in a safe place. Notice that in case of losing the encryption key, all data stored in the database will be lost.
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). The username can not, but the password can be modified at any time.
Congratulations! you have successfully installed and executed the new ARIS application.
You should see a browser tab with the application running like this
As a first important note, the system has three different roles with different and complementary functionalities.
Consequently, the first necessary thing is to 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 functionalities by the System Administrator and Laboratory supervisor.
ARIS allows other devices in the same network as the PC/laptop running the application to connect to the system and to work cooperatively.
However, ARIS executes by default on “localhost” (i.e., the computer you are currently using, which is a way to access services or resources on your own machine without going over a network), and thus not allowing other devices (even if they are in the same network) to connect to this address. In order to make ARIS available to your network through a WiFi Connection, you need to modify the IP address as in the instructions.
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.
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).
