System administration: Difference between revisions

From ARIS
Jump to navigation Jump to search
Blanca (talk | contribs)
No edit summary
Alberto (talk | contribs)
Marked this version for translation
 
(39 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:ARIS:System administration]]
[[Category:System administration]]
<languages/>
<translate>
<!--T:1-->
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.
 
<!--T:2-->
<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">
digraph AdministrationDiagram {
digraph AdministrationDiagram {
   node [shape=oval style=filled fillcolor=orange fontsize="7pt"];
   node [shape=oval style=filled fillcolor=orange fontsize="9pt"];
   //----- System Administration graph
   //----- System Administration graph
     // Nodes
     // Nodes
     SystemAdministration [label="System Administration"];
     SystemAdministration [label="System Administration"];
     GenericAdmin [label="Generic" URL="[[#Generic]]"];
     Generic [label="Generic" URL="#Generic"];
     TechnicalAdmin [label="Technical" URL="[[#Technical]]"];
    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
     // Edges
     SystemAdministration -> GenericAdmin;
     Technical -> SummaryOfInstances;
     SystemAdministration -> TechnicalAdmin;
     Technical -> Roles;
    Technical -> Parameters;
}
}
</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.
<!--T:16-->
They are grouped in two to facilitate their access.
__TOC__
 
==Generic==
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph GenericAdminDiagram {
  node [shape="oval" style=filled fillcolor="orange" fontsize="7pt"];
  //----- System Administration graph
    // Nodes
    Generic [label="Generic"];
    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]]"];
    // Edges
    Generic -> Users
    Generic -> AccessLog
    Generic -> DownloadedFields
}
</graphviz>
</div>


==Generic== <!--T:3-->
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=== <!--T:17-->
[[File:Newuser.PNG|right|thumb|750px|User creation form]]
[[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.
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.


<!--T:4-->
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.
<!--T:5-->
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.


===Access log===
===Access log=== <!--T:6-->
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'''
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>
[[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.
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===
===Downloaded fields=== <!--T:7-->
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 user 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.


==Technical==
<!--T:18-->
<div style="float:right; margin: 0px 0px 0px 0px">
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.
<graphviz border='frame' format='svg'>
 
digraph TechnicalAdminDiagram {
==Technical== <!--T:8-->
  node [shape=oval style=filled fillcolor=orange fontsize="7pt"]
This groups all the more advanced administration functionalities.
  //----- System Administration graph
They are available only for the system administration.
    // Nodes
    Technical [label="Technical"];
    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
    Technical -> SummaryOfInstances ;
    Technical -> Roles;
    Technical -> Parameters;
}
</graphviz>
</div>


===Summary of instances===
===Summary of instances=== <!--T:9-->
[[File:Summaryofinstancessmol.PNG|right|250px|thumb|Summary of instances]]
[[File:Summaryofinstancessmol.PNG|right|250px|thumb|Summary of instances]]
This tab displays information about the different existing instances in the application.   
This tab displays information about the different existing instances in the application.   
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''.


===Roles===
===Roles=== <!--T:10-->
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.  
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.
The roles are unchangeable, but their labels (not the corresponding functionality) can be customized.


<!--T:11-->
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.


<!--T:12-->
{| 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]]
|}
|}


===Parameters===
===Parameters=== <!--T:13-->
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 137: Line 135:
Providing a value of the wrong data type (e.g., a string instead of an integer) can provoke the malfunction of the whole application.
Providing a value of the wrong data type (e.g., a string instead of an integer) can provoke the malfunction of the whole application.


<!--T:14-->
The following table contains the list of existing parameters together with the corresponding data type and a brief description.
The following table contains the list of existing parameters together with the corresponding data type and a brief description.


<!--T:15-->
{| class="wikitable" style="margin:auto; text-align: left;"
{| class="wikitable" style="margin:auto; text-align: left;"
|+ System parameters
|+ System parameters
Line 144: Line 144:
! 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)
|-
|-
| ''name'' || String || Caption to appear at the top of the screen, in the navigation bar
| ''attribute_reserved2'' || String || Label of the second field of free use in the requests (write 'DoNotShow' to hide it)
|-
|-
| ''default_language'' || String || Language set by default on logging in (the same for all users)
| ''attribute_reserved3'' || String || Label of the third field of free use in the requests (write 'DoNotShow' to hide it)
|-
|-
| ''timeout'' || Integer || Time (in minutes) after wich the connection to the backend requires a new log in
| ''backup_frequency'' || Integer || Minimum amount of hours that need to pass for the system to generate a new copy of the database
|-
|-
| ''table_default_paging'' || Integer || This indicates the initial paging of all the tables (accepted values are 5, 10 or 25)
| ''backup_history'' || Integer || Maximum number of copies of the database kept (once reached, the oldest copy in the folder is deleted)
|-
|-
| ''table_min_rows_for_search'' || Integer || This is the minimum number of rows a table must have to show the corresponding search field
| ''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]
|-
|-
| ''attribute_reserved1'' || String || Label of the first field of free use in the requests
| ''csv_decimal'' || String || Specifies the character used to represent the decimal point in numerical values in the generated csv file (accepted values are ''.'' and '','')
|-
|-
| ''attribute_reserved2'' || String || Label of the second field of free use in the requests
| ''csv_delimiter'' || String || Specifies the character used to separate fields in the generated csv file (accepted values are '';'' and '','')
|-
|-
| ''attribute_reserved3'' || String || Label of the third field of free use in the requests
| ''default_language'' || String || Language set by default on logging in (the same for all users)
|-
|-
| ''filename_background'' || String || File containing the image displayed in the background
| ''filename_background'' || String || File containing the image displayed in the background
|-
| ''filename_favicon'' || String || Icon of the system used in the browser tab
|-
|-
| ''filename_sidebarlogo'' || String || File containing the logo displayed at the bottom of the sidebar
| ''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
| ''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
| ''groups_profiles'' || String || Shows groups and profiles for analytical tests (accepted values are 'Enabled' and 'Disabled')
|-
|-
| ''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)
|-
|-
| ''backup_frequency'' || Integer || Minimum amount of hours that need to pass for the system to generate a new copy of the database
| ''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
|-
| ''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)
|-
| ''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 which the connection to the backend requires a new log in
|-
| ''version'' || String || Version of the system
|-
|-
| ''backup_history'' || Integer || Maximum number of copies of the database kept (once reached, oldest copy in the folder is deleted)
| ''zip_password'' || String || This is the password that will be used to generate the downloaded zip file
|}
|}
</translate>

Latest revision as of 13:15, 26 March 2025

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[edit]

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

Users[edit]

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 Role within the system. This Role will determine the functionalities available to the user. 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. For security reasons, this password must contain some number, some capital letter, some small letter, and at least eight characters.

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.

Access log[edit]

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

Example of access log


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[edit]

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

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[edit]

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

Summary of instances[edit]

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

Roles[edit]

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 five roles within the system, which indicate the functionalities that a user can perform, as can be seen in the following table.

Allowed functionalities per role
Functionalities Patient Manager Laboratory Technician  Laboratory Technician with Validation Laboratory Supervisor System administrator
Patient Create
Search
Request Create
Change information
Deliver samples
Introduce results
Validate results
Search historic
Data analysis
Configuration Generic
Technical
Administration Generic
Technical

Parameters[edit]

Parameters determine the behaviour 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.

System parameters
Name Data type Description
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)
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, 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 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)
filename_background String File containing the image displayed in the background
filename_favicon String Icon of the system used in the browser tab
filename_sidebarlogo String File containing the logo displayed at the bottom of the sidebar
filename_worklistlogo String Logo used in the worklist reports
groups_profiles String Shows groups and profiles for analytical tests (accepted values are 'Enabled' and 'Disabled')
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, 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
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)
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 which the connection to the backend requires a new log in
version String Version of the system
zip_password String This is the password that will be used to generate the downloaded zip file