System administration: Difference between revisions
No edit summary |
|||
Line 24: | Line 24: | ||
</graphviz> | </graphviz> | ||
</div> | </div> | ||
==Generic== | |||
===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 app. | |||
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 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, users cannot be deleted. | |||
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 app and exactly when. The timestamp is in the format '''Year-Month-Day Hour:Minute:Second''' | |||
[[File:Accesslog.PNG|600px]] | |||
===Downloaded fields=== | |||
The application permits the user to download certain documents into the computer. | |||
==Technical== | |||
===Summary of instances=== | ===Summary of instances=== | ||
Line 78: | Line 101: | ||
| style="text-align:left;" | Downloaded fields || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] | | style="text-align:left;" | Downloaded fields || [[File:Cross.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] || [[File:Tick.png|frameless|25px]] | ||
|} | |} | ||
===Parameters=== | ===Parameters=== | ||
Line 137: | Line 148: | ||
| ''backup_history'' || Integer || Maximum number of copies of the database kept (once reached, oldest copy in the folder is deleted) | | ''backup_history'' || Integer || Maximum number of copies of the database kept (once reached, oldest copy in the folder is deleted) | ||
|} | |} | ||
Revision as of 12:02, 12 March 2023

Generic
Users
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 Role within the app. 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 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, users cannot be deleted. 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 app and exactly when. The timestamp is in the format Year-Month-Day Hour:Minute:Second
Downloaded fields
The application permits the user to download certain documents into the computer.
Technical
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 application. 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 state of the request tab in the 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 app, which indicate the functionalities that a user can perform, as can be seen in the following table.
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.
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 |
attribute_reserved2 | String | Label of the second field of free use in the requests |
attribute_reserved3 | String | Label of the third field of free use in the requests |
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 |
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) |