System administration/en - Revision history

FuzzyBot: Updating to match new version of source page

2026-02-26T14:50:55Z

Updating to match new version of source page

← Older revision		Revision as of 16:50, 26 February 2026
Line 170:		Line 170:
	\|-		\|-
	\| ''set_sample_delivery_default'' \|\| String \|\| Indicates whether samples are assumed to be delivered or not by default (accepted values are 'True' and 'False'); setting it to 'True' makes 'Change information' and 'Samples' items in the sidebar be hidden.		\| ''set_sample_delivery_default'' \|\| String \|\| Indicates whether samples are assumed to be delivered or not by default (accepted values are 'True' and 'False'); setting it to 'True' makes 'Change information' and 'Samples' items in the sidebar be hidden.
			\|-
			\| ''show_validate_all_button'' \|\| String \|\| Specifies whether the button to validate all tests at once is visible or not (accepted values are 'True' and 'False').
	\|-		\|-
	\| ''table_default_paging'' \|\| Integer \|\| Indicates the initial paging of all the tables (accepted values are 5, 10 or 25)		\| ''table_default_paging'' \|\| Integer \|\| Indicates the initial paging of all the tables (accepted values are 5, 10 or 25)

FuzzyBot: Updating to match new version of source page

2026-01-08T18:01:44Z

Updating to match new version of source page

← Older revision		Revision as of 20:01, 8 January 2026
Line 169:		Line 169:
	\| ''report_subtitle'' \|\| String \|\| Subtitle to be used in the worklist and reports		\| ''report_subtitle'' \|\| String \|\| Subtitle to be used in the worklist and reports
	\|-		\|-
	\| ''set_sample_delivery_default'' \|\| String \|\| Indicates whether samples are assumed to be delivered or not by default (accepted values are 'True' and 'False')~~. Setting~~ it to 'True' makes 'Change information' and 'Samples' items in the sidebar be hidden.		\| ''set_sample_delivery_default'' \|\| String \|\| Indicates whether samples are assumed to be delivered or not by default (accepted values are 'True' and 'False'); setting it to 'True' makes 'Change information' and 'Samples' items in the sidebar be hidden.
	\|-		\|-
	\| ''table_default_paging'' \|\| Integer \|\| Indicates the initial paging of all the tables (accepted values are 5, 10 or 25)		\| ''table_default_paging'' \|\| Integer \|\| Indicates the initial paging of all the tables (accepted values are 5, 10 or 25)

FuzzyBot: Updating to match new version of source page

2026-01-08T17:40:03Z

Updating to match new version of source page

← Older revision		Revision as of 19:40, 8 January 2026
Line 169:		Line 169:
	\| ''report_subtitle'' \|\| String \|\| Subtitle to be used in the worklist and reports		\| ''report_subtitle'' \|\| String \|\| Subtitle to be used in the worklist and reports
	\|-		\|-
	\| ''~~table_default_paging~~'' \|\| ~~Integer~~ \|\| ~~This indicates the initial paging of all the tables~~ (accepted values are ~~5, 10 or 25~~)		\| ''set_sample_delivery_default'' \|\| String \|\| Indicates whether samples are assumed to be delivered or not by default (accepted values are 'True' and 'False'). Setting it to 'True' makes 'Change information' and 'Samples' items in the sidebar be hidden.
	\|-		\|-
	\| ''table_min_rows_for_search'' \|\| Integer \|\| ~~This is the minimum~~ number of rows a table must have to show the corresponding search field		\| ''table_default_paging'' \|\| Integer \|\| Indicates the initial paging of all the tables (accepted values are 5, 10 or 25)
			\|-
			\| ''table_min_rows_for_search'' \|\| Integer \|\| Minimum number of rows a table must have to show the corresponding search field
	\|-		\|-
	\| ''timeout'' \|\| Integer \|\| Time (in minutes) after which the connection to the backend requires a new log in		\| ''timeout'' \|\| Integer \|\| Time (in minutes) after which the connection to the backend requires a new log in
Line 177:		Line 179:
	\| ''version'' \|\| String \|\| Version of the system		\| ''version'' \|\| String \|\| Version of the system
	\|-		\|-
	\| ''zip_password'' \|\| String \|\| ~~This is the password~~ that will be used to generate the downloaded zip file		\| ''zip_password'' \|\| String \|\| Password that will be used to generate the downloaded zip file
	\|}		\|}

FuzzyBot: Updating to match new version of source page

2025-03-26T11:20:25Z

Updating to match new version of source page

← Older revision		Revision as of 13:20, 26 March 2025
Line 65:		Line 65:
	Thus, due to patient confidentiality, not all the personal data should be in the downloaded file.		Thus, due to patient confidentiality, not all 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.		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.

			Additionally, the system provides two configuration parameters to customize the structure of the CSV file: ''csv_delimiter'', which defines the character used to separate data fields in the CSV file, and ''csv_decimal'', which specifies the character used to represent decimal values in numerical fields. It is essential to configure these parameters according to the settings used by the system and the spreadsheet software (e.g Excel) to ensure proper data interpretation. Using an incorrect delimiter or decimal separator may result in formatting issues when opening the file.

	==Technical==		==Technical==
Line 142:		Line 144:
	\|-		\|-
	\| ''bluetooth_enabler'' \|\| String \|\| Indicates the availability of automatic tests through Bluetooth connection (accepted values are 'Enabled' and 'Disabled'), which is only used in the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]		\| ''bluetooth_enabler'' \|\| String \|\| Indicates the availability of automatic tests through Bluetooth connection (accepted values are 'Enabled' and 'Disabled'), which is only used in the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]
			\|-
			\| ''csv_decimal'' \|\| String \|\| Specifies the character used to represent the decimal point in numerical values in the generated csv file (accepted values are ''.'' and '','')
			\|-
			\| ''csv_delimiter'' \|\| String \|\| Specifies the character used to separate fields in the generated csv file (accepted values are '';'' and '','')
	\|-		\|-
	\| ''default_language'' \|\| String \|\| Language set by default on logging in (the same for all users)		\| ''default_language'' \|\| String \|\| Language set by default on logging in (the same for all users)

FuzzyBot: Updating to match new version of source page

2025-01-17T16:51:23Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2024-09-27T13:27:11Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2024-05-30T12:03:55Z

Updating to match new version of source page

← Older revision		Revision as of 14:03, 30 May 2024
Line 131:		Line 131:
	! Name !! Data type !! Description		! Name !! Data type !! Description
	\|-		\|-
	\| ''~~version~~'' \|\| String \|\| ~~Version~~ of the ~~system~~		\| ''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)
	\|-		\|-
	\| ''~~name~~'' \|\| ~~String~~ \|\| ~~Caption~~ to ~~appear at~~ the ~~top~~ of the ~~screen, in the navigation bar~~		\| ''backup_frequency'' \|\| Integer \|\| Minimum amount of hours that need to pass for the system to generate a new copy of the database
	\|-		\|-
	\| ''~~default_language~~'' \|\| ~~String~~ \|\| ~~Language set by default on logging~~ in (the ~~same for all users~~)		\| ''backup_history'' \|\| Integer \|\| Maximum number of copies of the database kept (once reached, oldest copy in the folder is deleted)
	\|-		\|-
	\| ''~~timeout~~'' \|\| ~~Integer~~ \|\| ~~Time~~ (in ~~minutes) after wich~~ the ~~connection to the backend requires a new log in~~		\| ''bluetooth_enabler'' \|\| String \|\| Indicates the availability of automatic tests through Bluetooth connection (accepted values are 'Enabled' and 'Disabled'), which is only used in the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]
	\|-		\|-
	\| ''~~table_default_paging~~'' \|\| ~~Integer~~ \|\| ~~This indicates~~ the ~~initial paging of~~ all ~~the tables (accepted values are 5, 10 or 25~~)		\| ''default_language'' \|\| String \|\| Language set by default on logging in (the same for all users)
	\|-		\|-
	\| ''~~table_min_rows_for_search~~'' \|\| ~~Integer~~ \|\| ~~This is~~ the ~~minimum number of rows a table must have to show~~ the ~~corresponding search field~~		\| ''filename_background'' \|\| String \|\| File containing the image displayed in the background
	\|-		\|-
	\| ''~~attribute_reserved1~~'' \|\| String \|\| ~~Label~~ of the ~~first field of free use~~ in the ~~requests (write 'DoNotShow' to hide it)~~		\| ''filename_favicon'' \|\| String \|\| Icon of the system used in the browser tab
	\|-		\|-
	\| ''~~attribute_reserved2~~'' \|\| String \|\| ~~Label of~~ the ~~second field~~ of ~~free use in~~ the ~~requests (write 'DoNotShow' to hide it)~~		\| ''filename_sidebarlogo'' \|\| String \|\| File containing the logo displayed at the bottom of the sidebar
	\|-		\|-
	\| ''~~attribute_reserved3~~'' \|\| String \|\| ~~Label of the third field of free use~~ in the ~~requests (write 'DoNotShow' to hide it)~~		\| ''filename_worklistlogo'' \|\| String \|\| Logo used in the worklist reports
	\|-		\|-
	\| ''~~filename_background~~'' \|\| String \|\| ~~File containing the image displayed in the background~~		\| ''groups_profiles'' \|\| String \|\| Shows groups and profiles for analytical tests (accepted values are 'Enabled' and 'Disabled')
	\|-		\|-
	\| ''~~filename_sidebarlogo~~'' \|\| ~~String~~ \|\| ~~File containing the logo displayed at the bottom~~ of the ~~sidebar~~		\| ''log_history'' \|\| Integer \|\| Maximum number of days to keep registries in the access log (those older than this will be automatically deleted)
	\|-		\|-
	\| ''~~filename_favicon~~'' \|\| ~~String~~ \|\| ~~Icon~~ of ~~the system~~ used in the ~~browser tab~~		\| ''max_image_volume'' \|\| Integer \|\| Maximum number of megabytes used to store images (once reached, oldest ones in the folder are deleted)
	\|-		\|-
	\| ''~~bluetooth_enabler~~'' \|\| String \|\| ~~Indicates~~ the ~~availability~~ of ~~automatic tests through Bluetooth connection~~ (~~accepted values are 'Enabled' and 'Disabled'~~), ~~which is only used~~ in the ~~[http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]~~		\| ''name'' \|\| String \|\| Caption to appear at the top of the screen (in the navigation bar), as well as in the worklist and reports
	\|-		\|-
	\| ''~~zip_password~~'' \|\| String \|\| ~~This is the password that will~~ be used ~~to generate~~ the ~~downloaded zip file~~		\| ''report_subtitle'' \|\| String \|\| Subtitle to be used in the worklist and reports
	\|-		\|-
	\| ''~~log_history~~'' \|\| Integer \|\| ~~Maximum number~~ of ~~days to keep registries in~~ the ~~access log~~ (~~those older than this will be automatically deleted~~)		\| ''table_default_paging'' \|\| Integer \|\| This indicates the initial paging of all the tables (accepted values are 5, 10 or 25)
	\|-		\|-
	\| ''~~backup_frequency~~'' \|\| Integer \|\| ~~Minimum amount~~ of ~~hours that need to pass for the system~~ to ~~generate a new copy of~~ the ~~database~~		\| ''table_min_rows_for_search'' \|\| Integer \|\| This is the minimum number of rows a table must have to show the corresponding search field
	\|-		\|-
	\| ''~~backup_history~~'' \|\| Integer \|\| ~~Maximum number of copies of the database kept~~ (~~once reached, oldest copy~~ in the ~~folder is deleted)~~		\| ''timeout'' \|\| Integer \|\| Time (in minutes) after wich the connection to the backend requires a new log in
	\|-		\|-
	\| ''~~max_image_volume~~'' \|\| ~~Integer~~ \|\| ~~Maximum number~~ of ~~megabytes used to store images (once reached, oldest ones in~~ the ~~folder are deleted)~~		\| ''version'' \|\| String \|\| Version of the system
	\|-		\|-
	\| ''~~filename_worklistlogo~~'' \|\| String \|\| ~~Logo~~ used in the ~~worklist reports~~		\| ''zip_password'' \|\| String \|\| This is the password that will be used to generate the downloaded zip file
	\|}		\|}

FuzzyBot: Updating to match new version of source page

2024-02-02T13:51:31Z

Updating to match new version of source page

← Older revision		Revision as of 15:51, 2 February 2024
Line 1:		Line 1:
	[[Category:System administration]]		[[Category:System administration]]
	<languages/>		<languages/>
			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.

	<div style="float:right; margin: 0px 0px 0px 0px">		<div style="float:right; margin: 0px 0px 0px 0px">
	<graphviz border="frame" format="svg">		<graphviz border="frame" format="svg">
Line 30:		Line 35:
	</graphviz>		</graphviz>
	</div>		</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.~~

	__TOC__		__TOC__
Line 41:		Line 41:
	This groups all the basic administration functionalities.		This groups all the basic administration functionalities.
	They are available for both the system administration and the laboratory supervisor.		They are available for both the system administration and the laboratory supervisor.

	===Users===		===Users===
	[[File:Newuser.PNG\|right\|thumb\|750px\|User creation form]]		[[File:Newuser.PNG\|right\|thumb\|750px\|User creation form]]

FuzzyBot: Updating to match new version of source page

2024-01-30T07:16:11Z

Updating to match new version of source page

← Older revision		Revision as of 09:16, 30 January 2024
Line 1:		Line 1:
	[[Category:System administration]]		[[Category:System administration]]
	<languages/>		<languages/>
	~~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.~~

	<div style="float:right; margin: 0px 0px 0px 0px">		<div style="float:right; margin: 0px 0px 0px 0px">
	<graphviz border="frame" format="svg">		<graphviz border="frame" format="svg">
Line 35:		Line 30:
	</graphviz>		</graphviz>
	</div>		</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.

	__TOC__		__TOC__

FuzzyBot: Updating to match new version of source page

2024-01-16T09:39:06Z

Updating to match new version of source page

New page

[[Category:System administration]]
<languages/>
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.

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

__TOC__

==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 [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/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
|}

← Older revision		Revision as of 18:51, 17 January 2025
Line 83:		Line 83:

	Each role has different actions allowed within the application, chosen due to the tasks the people are expected to carry out.		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.		Thus, there are five 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;"		{\| class="wikitable" style="margin:auto; text-align: center;"
	\|+ Allowed functionalities per role		\|+ Allowed functionalities per role
	\|-		\|-
	!colspan="2"\| Functionalities !! Laboratory Technician !! Laboratory Supervisor !! System administrator		!colspan="2"\| Functionalities !! Patient Manager !! Laboratory Technician !! Laboratory Technician with Validation !! 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;" rowspan="2" \| Patient \|\| style="text-align:left;" \| Create \|\| [[File:Tick.png\|frameless\|25px]] \|\| [[File:Tick.png\|frameless\|25px]] \|\| [[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;" \| Search \|\| [[File:Tick.png\|frameless\|25px]] \|\| [[File:Tick.png\|frameless\|25px]] \|\| [[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;" rowspan="6" \| Request \|\| style="text-align:left;" \| Create \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Tick.png\|frameless\|25px]] \|\| [[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;" \| Change information \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Tick.png\|frameless\|25px]] \|\| [[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;" \| Deliver samples \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Tick.png\|frameless\|25px]] \|\| [[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;" \| Introduce results \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Tick.png\|frameless\|25px]] \|\| [[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;" \| Validate results \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Tick.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;" \| Search historic \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Tick.png\|frameless\|25px]] \|\| [[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;" colspan="2" \| Data analysis \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[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;" rowspan="2" \| Configuration \|\| style="text-align:left;" \| Generic \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[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;" \| Technical \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[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;" rowspan="2" \| Administration \|\| style="text-align:left;"\| Generic \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[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]]		\| style="text-align:left;" \| Technical \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Cross.png\|frameless\|25px]] \|\| [[File:Tick.png\|frameless\|25px]]
	\|}		\|}

← Older revision		Revision as of 15:27, 27 September 2024
Line 46:		Line 46:
	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.		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.		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.		A note, without any effect in the behaviour 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.		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.		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.		Since they are used for auditing 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.		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.

Line 61:		Line 61:
	===Downloaded fields===		===Downloaded fields===
	ARIS allows the laboratory supervisor to download all the information in the database into a single file in their computer.		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.		There are two possible download options, depending on 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.		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.		Thus, due to patient confidentiality, not all 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.		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.

Line 75:		Line 75:
	Some examples are: the number of patients, users, requests or genders.		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.		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.		It can be useful to investigate potential performance problems in 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''.		To facilitate the reading and identification of the different kinds of instances, the information is divided into three sections: ''Data'', ''Administration'' and ''Configuration''.

Line 118:		Line 118:

	===Parameters===		===Parameters===
	Parameters determine the ~~behavior~~ of some functionalities.		Parameters determine the behaviour of some functionalities.
	Thus, they cannot be created or deleted.		Thus, they cannot be created or deleted.
	However, their values can be updated to customize the system.		However, their values can be updated to customize the system.
Line 139:		Line 139:
	\| ''backup_frequency'' \|\| Integer \|\| Minimum amount of hours that need to pass for the system to generate a new copy of the database		\| ''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)		\| ''backup_history'' \|\| Integer \|\| Maximum number of copies of the database kept (once reached, the oldest copy in the folder is deleted)
	\|-		\|-
	\| ''bluetooth_enabler'' \|\| String \|\| Indicates the availability of automatic tests through Bluetooth connection (accepted values are 'Enabled' and 'Disabled'), which is only used in the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]		\| ''bluetooth_enabler'' \|\| String \|\| Indicates the availability of automatic tests through Bluetooth connection (accepted values are 'Enabled' and 'Disabled'), which is only used in the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]
Line 157:		Line 157:
	\| ''log_history'' \|\| Integer \|\| Maximum number of days to keep registries in the access log (those older than this will be automatically deleted)		\| ''log_history'' \|\| Integer \|\| Maximum number of days to keep registries in the access log (those older than this will be automatically deleted)
	\|-		\|-
	\| ''max_image_volume'' \|\| Integer \|\| Maximum number of megabytes used to store images (once reached, oldest ones in the folder are deleted)		\| ''max_image_volume'' \|\| Integer \|\| Maximum number of megabytes used to store images (once reached, the oldest ones in the folder are deleted)
	\|-		\|-
	\| ''name'' \|\| String \|\| Caption to appear at the top of the screen (in the navigation bar), as well as in the worklist and reports		\| ''name'' \|\| String \|\| Caption to appear at the top of the screen (in the navigation bar), as well as in the worklist and reports
Line 167:		Line 167:
	\| ''table_min_rows_for_search'' \|\| Integer \|\| This is the minimum number of rows a table must have to show the corresponding search field		\| ''table_min_rows_for_search'' \|\| Integer \|\| This is the minimum number of rows a table must have to show the corresponding search field
	\|-		\|-
	\| ''timeout'' \|\| Integer \|\| Time (in minutes) after ~~wich~~ the connection to the backend requires a new log in		\| ''timeout'' \|\| Integer \|\| Time (in minutes) after which the connection to the backend requires a new log in
	\|-		\|-
	\| ''version'' \|\| String \|\| Version of the system		\| ''version'' \|\| String \|\| Version of the system