medAL-suite documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== medAL-data User Guide ======

This page gathers all the informations needed to use the medAL-//data// web application as a user.




===== Register a User =====

To register as a new user, follow these steps:
  - Go to the url ''<medal-data-url>/register''.
  - Enter your //Full name//, //email//, //password//, and confirm your password.
  - Click on ''Register''.
  - Setup Google Authentication. You can find the procedure [[user-guide#Setup Google Authenticator|here]].
  - Click on ''Complete Registration'', you should now be logged in.
  - Finally, contact an administrator to [[administrator-guide#Assign a role to a user|assign your account to a given role]].




===== Reset your Own Password =====

To reset your own password, make sure to be logged in to medAL-//data// and follow these steps:
  - On the home page, click on ''Change password''.
  - Enter our current password in the ''Enter Current Password'' field.
  - Enter your new desired password in the ''Enter New Password'' field.
  - Click on ''Change password''.




===== Setup Google Authenticator =====

==== Install a Compatible Application ====

To setup two-factor authentication on your device, install a Google Authenticator compatible app. Some currently available apps are:
  * Authy for iOS, Android, Chrome, OS X
  * FreeOTP for iOS, Android and Pebble
  * Google Authenticator for iOS
  * Google Authenticator for Android
  * Google Authenticator (port) on Windows Store
  * Microsoft Authenticator for Windows Phone
  * LastPass Authenticator for iOS, Android, OS X, Windows
  * 1Password for iOS, Android, OS X, Windows




==== Add a New Session Using a Setup Key ====

To add a new session using a setup key, follow these steps (described using the application //Google Authenticator for Android//).
  - Click on ''+''.
  - Click on ''Enter a setup key''.
  - Enter your account name and the key that was sent by email.
  - Click on ''Add''.




==== Add a New Session Using a QR Code ====

To add a new session using a setup key, follow these steps (described using the application //Google Authenticator for Android//).
  - Click on ''+''.
  - Click on ''Scan a QR code''.
  - Scan the QR code.




===== Health Facility Setup =====

==== Health Facility Creation ====

To setup a health facility, follow these steps:
  - Open your browser and navigate to your medAL-//data// server URL.
  - Login with a user having accesses to health facilities.
  - Go to the ''Health Facilities'' section.
  - Click on ''Create New Health Facility'':
    * Enter basic informations such as ''Name'', ''Country'', ''Area'', enter your area, ''Longitude'' and ''Latitude''.
    * Under ''Architecture'', you can choose between the following values:
        * ''Standalone'': The tablets will work by themselves and send data directly to medAL-//data//.
        * ''Client Server'': The medAL-//hub// IP will need to be filled in so the tablets will connect to it to retrieve and send data.
    * Under ''medAL-//hub// IP'', enter your medAL-//hub// IP to allow the tablets to connect to it.
    * Under ''Pin Code'', you can set the PIN code that the tablets will ask for when opening medAL-//reader//.
  - Click on ''Create New Health Facility''.
  - Your new health facility should appear in the list.




==== Device Assignment ====

To assign a Device to a health facility, follow these steps:
  - Look for your health facility in the healt facility's list.
  - Click on ''Devices''. 
  - A window will open up allowing to assign free devices to this health facility.




==== Algorithm & Version Assignment ====

You will now need to setup an algorithm and a version for your health facility. Follow these steps:
  - Look for your health facility in the healt facility's list.
  - Click on ''Algorithms''.
  - Under ''Choose Algorithm'', choose the desired algorithm.
  - Under ''Choose a version'', choose the desired version.
  - Click on ''Assign''. This may take some time to process.
  - Once done, you can close the window.
 



==== Edit Health Facility ====

To edit an already existing health facility, follow this procedure:
  - Look for your health facility in the healt facility's list.
  - Click on ''Edit''.
  - You can edit some fields. Once done, click on ''Submit''.