File:IntroduceResults1.PNG

2024-05-30T14:20:57Z

Pau:

Requests

2024-05-30T14:17:40Z

Pau:

[[Category:Requests]]
<languages/>
<translate>

Requests are the most important entities in ARIS, whose main purpose is to manage them.
They are always associated to a given patient, who must have been created before hand.


<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph RequestsDiagram {
node [shape="oval" style=filled fillcolor="orange" fontsize="9pt"];
//edge [minlen=2];
//----- Requests graph
// Nodes
Requests [label="Requests" ];
Create [label="Create", URL="#Create" ];
ChangeInformation [label="Change Information", URL="#Change_information"];
PatientsData [label="Patients' Data", shape="tab", URL="#Create"];
AdditionalInformation [label="Additional Information", shape="tab", URL="#Create"];
BiologicalSamples [label="Biological Samples", shape="tab", URL="#Create" ];
AnalyticalTests [label="Analytical Tests", shape="tab", URL="#Create" ];
DeliverSamples [label="Deliver Samples", URL="#Deliver_samples" ];
IntroduceResults [label="Introduce Results", URL="#Introduce_results" ];
ValidateResults [label="Validate Results", URL="#Validate_results"];
SearchHistoric [label="Search Historic", URL="#Search_historic"];
// Edges
Requests -> Create;
Requests -> ChangeInformation;
Create -> PatientsData;
ChangeInformation -> PatientsData;
PatientsData -> AnalyticalTests [dir=both minlen=2];
AnalyticalTests -> BiologicalSamples [dir=both minlen=2];
BiologicalSamples -> AdditionalInformation [dir=both minlen=2];
Requests -> DeliverSamples
DeliverSamples -> BiologicalSamples;
Requests -> IntroduceResults;
IntroduceResults -> AnalyticalTests;
Requests -> ValidateResults;
ValidateResults -> AnalyticalTests;
Requests -> SearchHistoric;
{ rank=same; Create ChangeInformation DeliverSamples ValidateResults IntroduceResults SearchHistoric}
{ rank=same; PatientsData AnalyticalTests AdditionalInformation BiologicalSamples }
}
</graphviz>
</div>


__TOC__

==Request Lifespan== 
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph StatesDiagram {
node [shape=rectangle style=rounded fontsize="9pt"];
edge [fontsize="7pt"];
//----- Main graph
// Nodes
Begin [label="" shape="circle" style=filled fillcolor=black fixedsize=true width=0.2 height=0.2];
Registered [label="Registered"];
Processing [label="Processing"];
WithResults [label="WithResults"];
Validated [label="Validated"];
Cancelled [label="Cancelled"];
End [label="" shape="doublecircle" style=filled fillcolor="black" fixedsize=true width=0.2 height=0.2];
// Edges
Begin -> Registered [constraint=false];
Registered -> Processing [label="Some sample delivered" constraint=false];
Processing -> WithResults [label="All results provided" constraint=false];
WithResults -> Validated [label="All tests validated" constraint=false];
Validated -> End [constraint=false];
Registered -> Cancelled [label="Cancel"];
Processing -> Cancelled [label="Cancel"];
WithResults -> Cancelled [label="Cancel"];
Cancelled -> End [constraint=false];
{ rank=same; Begin Registered Processing WithResults Validated}
{ rank=same; Cancelled End}
}
</graphviz>
</div>


During their lifespan, requests go through some different states that determine the functionalities offered for them in the system.
These states are depicted in the diagram, and their labels are configurable at [[Configuration#State_of_the_request|State of the request]].


On creation, the state of the request is ''Registered'', and allows to provide the basic information, as well as associate different tests to it.
After indicating that some of the samples has been delivered, the state changes to ''Processing'' and the data of the request cannot be modified anymore.
Other samples can be delivered later, but at this point, results can be provided for the tests whose sample was already delivered.
Once all non-cancelled tests have a result, the state of the request changes to ''WithResults''.
At this state, results can still be modified, but they are expected to be eventually validated.
A request with all its non-cancelled tests being validated is considered ''Validated''.


At any time, a request, its samples or its tests can be cancelled.
A sample with all its tests cancelled is considered cancelled, and a request with all samples cancelled is considered cancelled, too.


During the lifespan of a request, it is available to the laboratory technicians, except for the validation, which can only be done by a laboratory supervisor.

==Create== 
[[File:Selectpatient1.PNG|350px|right|thumb|Create request form]]


This form is divided into tabs. The tab the laboratory technician is on is indicated by the label of the tab turning orange. Above, it can be found the ''Requesting center'' mandatory field, alongisde with the additional ''Requesting unit'' field and the ''Urgent'' checkbox.

#Select a patient → The first tab involves searching and selecting a patient. The search grid can be narrowed down with the search field. Once a patient is selected, the main and important information about this patient will be displayed at the bottom of the form in a table. Until the patient has been selected, the laboratory technician cannot save the new request.
#Analytical tests → In this tab, the laboratory technician must choose which tests, are requested for the patient. Groups and profiles will appear in case the proper parameter is enabled. More than one element from each list may be chosen, but at least one test must be requested one way or another. Tests selected as part of a group or profile (highlighted in purple) cannot be deselected individually.
#Biological samples → This tab informs the laboratory technician of the type of sample that must be taken, depending on the tests chosen in the previous tab. There are no required fields in this tab, but if the laboratory technician wants to add a comment, there is a comment box for each sample. [[File:Comments.PNG|1000px]]
#Basic information → In this tab, other optional fields are provided like physician, the room or bed of the patient. Additional information like a diagnostic orientation or the pregnancy status can also be indicated.


At any moment, the ''Save values'' button cannot be used if any of the required fields is not filled in.

==Change information== 
[[File:SearchRequest.PNG|350px|right|thumb|Change information form]]


This form is for editing requests whose samples were not yet delivered.
Clicking on any part of the row will bring the laboratory technician to a form similar to the [[#Create|create]] one, with all of its tabs and similar format and behavior.

==Deliver samples== 
Similarly to the previous form, this also displays a list of either ''Registered'' or ''Processing'' requests, for the laboratory technician to choose one of them.
[[File:DeliverSamples1.PNG|350px|right|thumb|Deliver samples form]]
Once a request is chosen, five tabs are shown with the patient's data, the request data, its list of biological samples, and potentially analytical already done in this request, and tests in previous requests.
The first and last two are read-only (if enabled at all).
Just the biological samples allows some interaction.


Each of the samples shown contains a field to provide comments, and it can be either checked as delivered or cancelled by click the corresponding red button.
On the delivering of a sample, its origin or incident can be optionally provided.
On cancelling, a pop-up dialog allows to provide some justification for this.


It is important to notice that the tests associated to the request cannot be changed once the first sample as been delivered.

==Introduce results== 
As in the previous cases, a list of requests is shown.
In this case, this list contains all requests in ''Processing'' state.
Clicking the corresponding button at the bottom, it is possible to download a worklist with all pending tests in these requests, to work on them off-line.


[[File:IntroduceResults.PNG|350px|right|thumb|Form to Introduce Results]]


Once the laboratory technician has chosen a request, five tabs are shown with the patient's data, the request data, its list of biological samples, its list of analytical tests, and potentially previous tests of the same patient.
The first tree and last one are read-only.
Just the analytical tests allows some interaction.
Besides the same search box present in all the tables in the system, there is also the possibility of filtering the tests by group of tests (if any was chosen for this request).
A red button in the top right corner allows to cancel the request.


The table of tests contains the following columns
#Name → Shows the name and the code of the kind of test. It is colored red if either the test or its sample was cancelled.
#Result → Allows to introduce the result of the test.
#Generic test note → Shows the informative note associated to the kind of test, if any.
#Result within range → Indicates whether the result of the test is in the expected range of values for the kind of test (green check) or not (red cross).
#Referred → Indicates whether the test is done or expected to be done in another laboratory (green check) or not (red cross).
#Automatic (not visible by default) → Indicates whether the test is done or expected to be done automatically (green check) or not (red cross). Automatic tests are done by means of the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Microscope:Main Robotized microscope] and the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App]. Their results should not be typed manually, but uploaded through Bluetooth. This feature is enabled through the corresponding [[System_administration#Parameters|system parameter]]. If enabled, the field is editable here to allow overwriting the automatic results.
#The test has some note → Indicates whether the test has some associated note (green check) or not (red cross). Tests whose results were generated automatically will always have an associated note.
#Test details → This should show an icon to navigate to further details of the test. However, if the test or its corresponding sample was cancelled, the corresponding message in red will be shown.


[[File:TestDetails.PNG|350px|right|thumb|Test details]]


On the laboratory technician accessing the details of the test, we gain access to visualize many other things (i.e., units of the result, inferior reference measure, superior reference measure, the use who introduced the results, as well as details provided for the corresponding sample on delivering it).
Moreover, this also allows to change if the test is automatic or deferred, indicate some incidence on the sample, of provide some note.
It is important to notice that any of the information provided in this form will not be persisted in the disk until back in the list and saved from there.


If the result of the test was provided automatically (which is not enabled by default and only available in the context of the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]), the corresponding image and its associated note will be shown at the bottom of the details of the test.

==Validate results== 
[[File:Validateresults.mp4|left]]
This functionality, available only to the laboratory supervisor, uses exactly the same interface as introducing results, but the table shows one more column ''Validated'' with a checkbox for each test.
These can be checked one by one, or all at once by choosing a concrete group of tests in the dropbox at the top.
On doing the latter, a button to check all the tests of the group will appear.


Besides doing it in the list, the results can be overwritten and the test validated from the details of the test.
Together with displaying all the information related to the test in read-only mode, the corresponding form also offers the possibility of adding a note to the test, as well as changing whether the test is automatic/referred or not, cancelling the test or the whole request.


It is important to notice that the tests will not be really validated until the bottom right button is pressed to save the changes.

==Search historic== 
[[File:Download.mp4|left]]
This functionality, available to both laboratory technician and supervisor allows to see any request in the history of the laboratory.
They can be filtered out by the state and the date of the request.
By clicking on the corresponding row, all the details of the request can be visualized.


At the bottom left of this form, there are two download buttons.
Clicking any of them will generate and download the corresponding file (i.e., CSV or ZIP).
The checkboxes in the [[System administration#Downloaded fields|Downloaded fields]] tab indicate which fields will be included in each of these files.
Moreover, the ZIP file is password protected.
The password used is indicated by the system parameter ''zip_password'', whose value can be seen and modified from [[System administration#Parameters|Parameters]] tab.
</translate>

2024-05-30T14:04:53Z

Pau:

Requests

2024-05-30T14:02:55Z

Pau:

[[Category:Requests]]
<languages/>
<translate>

Requests are the most important entities in ARIS, whose main purpose is to manage them.
They are always associated to a given patient, who must have been created before hand.


<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph RequestsDiagram {
node [shape="oval" style=filled fillcolor="orange" fontsize="9pt"];
//edge [minlen=2];
//----- Requests graph
// Nodes
Requests [label="Requests" ];
Create [label="Create", URL="#Create" ];
ChangeInformation [label="Change Information", URL="#Change_information"];
PatientsData [label="Patients' Data", shape="tab", URL="#Create"];
AdditionalInformation [label="Additional Information", shape="tab", URL="#Create"];
BiologicalSamples [label="Biological Samples", shape="tab", URL="#Create" ];
AnalyticalTests [label="Analytical Tests", shape="tab", URL="#Create" ];
DeliverSamples [label="Deliver Samples", URL="#Deliver_samples" ];
IntroduceResults [label="Introduce Results", URL="#Introduce_results" ];
ValidateResults [label="Validate Results", URL="#Validate_results"];
SearchHistoric [label="Search Historic", URL="#Search_historic"];
// Edges
Requests -> Create;
Requests -> ChangeInformation;
Create -> PatientsData;
ChangeInformation -> PatientsData;
PatientsData -> AnalyticalTests [dir=both minlen=2];
AnalyticalTests -> BiologicalSamples [dir=both minlen=2];
BiologicalSamples -> AdditionalInformation [dir=both minlen=2];
Requests -> DeliverSamples
DeliverSamples -> BiologicalSamples;
Requests -> IntroduceResults;
IntroduceResults -> AnalyticalTests;
Requests -> ValidateResults;
ValidateResults -> AnalyticalTests;
Requests -> SearchHistoric;
{ rank=same; Create ChangeInformation DeliverSamples ValidateResults IntroduceResults SearchHistoric}
{ rank=same; PatientsData AnalyticalTests AdditionalInformation BiologicalSamples }
}
</graphviz>
</div>


__TOC__

==Request Lifespan== 
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph StatesDiagram {
node [shape=rectangle style=rounded fontsize="9pt"];
edge [fontsize="7pt"];
//----- Main graph
// Nodes
Begin [label="" shape="circle" style=filled fillcolor=black fixedsize=true width=0.2 height=0.2];
Registered [label="Registered"];
Processing [label="Processing"];
WithResults [label="WithResults"];
Validated [label="Validated"];
Cancelled [label="Cancelled"];
End [label="" shape="doublecircle" style=filled fillcolor="black" fixedsize=true width=0.2 height=0.2];
// Edges
Begin -> Registered [constraint=false];
Registered -> Processing [label="Some sample delivered" constraint=false];
Processing -> WithResults [label="All results provided" constraint=false];
WithResults -> Validated [label="All tests validated" constraint=false];
Validated -> End [constraint=false];
Registered -> Cancelled [label="Cancel"];
Processing -> Cancelled [label="Cancel"];
WithResults -> Cancelled [label="Cancel"];
Cancelled -> End [constraint=false];
{ rank=same; Begin Registered Processing WithResults Validated}
{ rank=same; Cancelled End}
}
</graphviz>
</div>


During their lifespan, requests go through some different states that determine the functionalities offered for them in the system.
These states are depicted in the diagram, and their labels are configurable at [[Configuration#State_of_the_request|State of the request]].


On creation, the state of the request is ''Registered'', and allows to provide the basic information, as well as associate different tests to it.
After indicating that some of the samples has been delivered, the state changes to ''Processing'' and the data of the request cannot be modified anymore.
Other samples can be delivered later, but at this point, results can be provided for the tests whose sample was already delivered.
Once all non-cancelled tests have a result, the state of the request changes to ''WithResults''.
At this state, results can still be modified, but they are expected to be eventually validated.
A request with all its non-cancelled tests being validated is considered ''Validated''.


At any time, a request, its samples or its tests can be cancelled.
A sample with all its tests cancelled is considered cancelled, and a request with all samples cancelled is considered cancelled, too.


During the lifespan of a request, it is available to the laboratory technicians, except for the validation, which can only be done by a laboratory supervisor.

==Create== 
[[File:Selectpatient.PNG|350px|right|thumb|Create request form]]


This form is divided into tabs. The tab the laboratory technician is on is indicated by the label of the tab turning orange.
Once the step is filled with the required information, the circle marking the step will stay orange and the number in said circle will change into a check mark (&check;) [[File:Tick.PNG|30px]].
#Select a patient → The first step involves searching and selecting a patient. The search grid can be narrowed down with the search field. Once a patient is selected, the main and important information about this patient will be displayed at the bottom of the form in a table. Until the patient has been selected, the laboratory technician cannot continue to the next step. To continue to the next step, the laboratory technician must press the ''next'' button found at the bottom right of the form.
#Basic information → To complete this step, only the requesting center is required, but other optional fields are provided like requesting unit and physician, or the room and bed of the patient. Additional information like a diagnostic orientation or the pregnancy status can also be indicated. At the bottom right of the page, on top of the ''Next'' button, there is a checkbox labelled '''Urgent''', check this box if this request must be prioritized. [[File:Urgent.PNG|100px]]
#Analytical tests → In this step, the laboratory technician must choose which tests, groups or profiles are requested for the patient. More than one element from each list may be chosen, but at least one test must be requested one way or another. Tests selected as part of a group or profile (highlighted in purple) cannot be deselected individually.
#Biological samples → This step informs the laboratory technician of the type of sample that must be taken, depending on the tests chosen in the previous step. There are no required fields in this step, but if the laboratory technician wants to add a comment, there is a comment box for each sample. [[File:Comments.PNG|1000px]]


At any moment, the ''next'' button cannot be used if any of the required fields is not filled in.
In every step, there is a ''Previous'' button for the laboratory technician to be able to navigate back and forth between steps and alter the information they contain.

==Change information== 
[[File:SearchRequest.PNG|350px|right|thumb|Change information form]]


This form is for editing requests whose samples were not yet delivered.
Clicking on any part of the row will bring the laboratory technician to a form similar to the [[#Create|create]] one, with all of its tabs and similar format and behavior.

==Deliver samples== 
Similarly to the previous form, this also displays a list of either ''Registered'' or ''Processing'' requests, for the laboratory technician to choose one of them.
[[File:DeliverSamples.PNG|350px|right|thumb|Deliver samples form]]
Once a request is chosen, five tabs are shown with the patient's data, the request data, its list of biological samples, and potentially analytical already done in this request, and tests in previous requests.
The first and last two are read-only (if enabled at all).
Just the biological samples allows some interaction.


Each of the samples shown contains a field to provide comments, and it can be either checked as delivered or cancelled by click the corresponding red button.
On the delivering of a sample, its origin or incident can be optionally provided.
On cancelling, a pop-up dialog allows to provide some justification for this.


It is important to notice that the tests associated to the request cannot be changed once the first sample as been delivered.

==Introduce results== 
As in the previous cases, a list of requests is shown.
In this case, this list contains all requests in ''Processing'' state.
Clicking the corresponding button at the bottom, it is possible to download a worklist with all pending tests in these requests, to work on them off-line.


[[File:IntroduceResults.PNG|350px|right|thumb|Form to Introduce Results]]


Once the laboratory technician has chosen a request, five tabs are shown with the patient's data, the request data, its list of biological samples, its list of analytical tests, and potentially previous tests of the same patient.
The first tree and last one are read-only.
Just the analytical tests allows some interaction.
Besides the same search box present in all the tables in the system, there is also the possibility of filtering the tests by group of tests (if any was chosen for this request).
A red button in the top right corner allows to cancel the request.


The table of tests contains the following columns
#Name → Shows the name and the code of the kind of test. It is colored red if either the test or its sample was cancelled.
#Result → Allows to introduce the result of the test.
#Generic test note → Shows the informative note associated to the kind of test, if any.
#Result within range → Indicates whether the result of the test is in the expected range of values for the kind of test (green check) or not (red cross).
#Referred → Indicates whether the test is done or expected to be done in another laboratory (green check) or not (red cross).
#Automatic (not visible by default) → Indicates whether the test is done or expected to be done automatically (green check) or not (red cross). Automatic tests are done by means of the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Microscope:Main Robotized microscope] and the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App]. Their results should not be typed manually, but uploaded through Bluetooth. This feature is enabled through the corresponding [[System_administration#Parameters|system parameter]]. If enabled, the field is editable here to allow overwriting the automatic results.
#The test has some note → Indicates whether the test has some associated note (green check) or not (red cross). Tests whose results were generated automatically will always have an associated note.
#Test details → This should show an icon to navigate to further details of the test. However, if the test or its corresponding sample was cancelled, the corresponding message in red will be shown.


[[File:TestDetails.PNG|350px|right|thumb|Test details]]


On the laboratory technician accessing the details of the test, we gain access to visualize many other things (i.e., units of the result, inferior reference measure, superior reference measure, the use who introduced the results, as well as details provided for the corresponding sample on delivering it).
Moreover, this also allows to change if the test is automatic or deferred, indicate some incidence on the sample, of provide some note.
It is important to notice that any of the information provided in this form will not be persisted in the disk until back in the list and saved from there.


If the result of the test was provided automatically (which is not enabled by default and only available in the context of the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]), the corresponding image and its associated note will be shown at the bottom of the details of the test.

==Validate results== 
[[File:Validateresults.mp4|left]]
This functionality, available only to the laboratory supervisor, uses exactly the same interface as introducing results, but the table shows one more column ''Validated'' with a checkbox for each test.
These can be checked one by one, or all at once by choosing a concrete group of tests in the dropbox at the top.
On doing the latter, a button to check all the tests of the group will appear.


Besides doing it in the list, the results can be overwritten and the test validated from the details of the test.
Together with displaying all the information related to the test in read-only mode, the corresponding form also offers the possibility of adding a note to the test, as well as changing whether the test is automatic/referred or not, cancelling the test or the whole request.


It is important to notice that the tests will not be really validated until the bottom right button is pressed to save the changes.

==Search historic== 
[[File:Download.mp4|left]]
This functionality, available to both laboratory technician and supervisor allows to see any request in the history of the laboratory.
They can be filtered out by the state and the date of the request.
By clicking on the corresponding row, all the details of the request can be visualized.


At the bottom left of this form, there are two download buttons.
Clicking any of them will generate and download the corresponding file (i.e., CSV or ZIP).
The checkboxes in the [[System administration#Downloaded fields|Downloaded fields]] tab indicate which fields will be included in each of these files.
Moreover, the ZIP file is password protected.
The password used is indicated by the system parameter ''zip_password'', whose value can be seen and modified from [[System administration#Parameters|Parameters]] tab.
</translate>

Requests

2024-05-30T13:58:02Z

Pau:

[[Category:Requests]]
<languages/>
<translate>

Requests are the most important entities in ARIS, whose main purpose is to manage them.
They are always associated to a given patient, who must have been created before hand.


<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph RequestsDiagram {
node [shape="oval" style=filled fillcolor="orange" fontsize="9pt"];
//edge [minlen=2];
//----- Requests graph
// Nodes
Requests [label="Requests" ];
Create [label="Create", URL="#Create" ];
ChangeInformation [label="Change Information", URL="#Change_information"];
PatientsData [label="Patients' Data", shape="tab", URL="#Create"];
AdditionalInformation [label="Additional Information", shape="tab", URL="#Create"];
BiologicalSamples [label="Biological Samples", shape="tab", URL="#Create" ];
AnalyticalTests [label="Analytical Tests", shape="tab", URL="#Create" ];
DeliverSamples [label="Deliver Samples", URL="#Deliver_samples" ];
IntroduceResults [label="Introduce Results", URL="#Introduce_results" ];
ValidateResults [label="Validate Results", URL="#Validate_results"];
SearchHistoric [label="Search Historic", URL="#Search_historic"];
// Edges
Requests -> Create;
Requests -> ChangeInformation;
Create -> PatientsData;
ChangeInformation -> PatientsData;
PatientsData -> AnalyticalTests [dir=both minlen=2];
AnalyticalTests -> BiologicalSamples [dir=both minlen=2];
BiologicalSamples -> AdditionalInformation [dir=both minlen=2];
Requests -> DeliverSamples
DeliverSamples -> BiologicalSamples;
Requests -> IntroduceResults;
IntroduceResults -> AnalyticalTests;
Requests -> ValidateResults;
ValidateResults -> AnalyticalTests;
Requests -> SearchHistoric;
{ rank=same; Create ChangeInformation DeliverSamples ValidateResults IntroduceResults SearchHistoric}
{ rank=same; PatientsData AnalyticalTests AdditionalInformation BiologicalSamples }
}
</graphviz>
</div>


__TOC__

==Request Lifespan== 
<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg'>
digraph StatesDiagram {
node [shape=rectangle style=rounded fontsize="9pt"];
edge [fontsize="7pt"];
//----- Main graph
// Nodes
Begin [label="" shape="circle" style=filled fillcolor=black fixedsize=true width=0.2 height=0.2];
Registered [label="Registered"];
Processing [label="Processing"];
WithResults [label="WithResults"];
Validated [label="Validated"];
Cancelled [label="Cancelled"];
End [label="" shape="doublecircle" style=filled fillcolor="black" fixedsize=true width=0.2 height=0.2];
// Edges
Begin -> Registered [constraint=false];
Registered -> Processing [label="Some sample delivered" constraint=false];
Processing -> WithResults [label="All results provided" constraint=false];
WithResults -> Validated [label="All tests validated" constraint=false];
Validated -> End [constraint=false];
Registered -> Cancelled [label="Cancel"];
Processing -> Cancelled [label="Cancel"];
WithResults -> Cancelled [label="Cancel"];
Cancelled -> End [constraint=false];
{ rank=same; Begin Registered Processing WithResults Validated}
{ rank=same; Cancelled End}
}
</graphviz>
</div>


During their lifespan, requests go through some different states that determine the functionalities offered for them in the system.
These states are depicted in the diagram, and their labels are configurable at [[Configuration#State_of_the_request|State of the request]].


On creation, the state of the request is ''Registered'', and allows to provide the basic information, as well as associate different tests to it.
After indicating that some of the samples has been delivered, the state changes to ''Processing'' and the data of the request cannot be modified anymore.
Other samples can be delivered later, but at this point, results can be provided for the tests whose sample was already delivered.
Once all non-cancelled tests have a result, the state of the request changes to ''WithResults''.
At this state, results can still be modified, but they are expected to be eventually validated.
A request with all its non-cancelled tests being validated is considered ''Validated''.


At any time, a request, its samples or its tests can be cancelled.
A sample with all its tests cancelled is considered cancelled, and a request with all samples cancelled is considered cancelled, too.


During the lifespan of a request, it is available to the laboratory technicians, except for the validation, which can only be done by a laboratory supervisor.

==Create== 
[[File:Selectpatient.PNG|350px|right|thumb|Create request form]]


This form is divided into steps. The step the laboratory technician is on is indicated by the number of the step turning orange.
Once the step is filled with the required information, the circle marking the step will stay orange and the number in said circle will change into a check mark (&check;) [[File:Tick.PNG|30px]].
#Select a patient → The first step involves searching and selecting a patient. The search grid can be narrowed down with the search field. Once a patient is selected, the main and important information about this patient will be displayed at the bottom of the form in a table. Until the patient has been selected, the laboratory technician cannot continue to the next step. To continue to the next step, the laboratory technician must press the ''next'' button found at the bottom right of the form.
#Basic information → To complete this step, only the requesting center is required, but other optional fields are provided like requesting unit and physician, or the room and bed of the patient. Additional information like a diagnostic orientation or the pregnancy status can also be indicated. At the bottom right of the page, on top of the ''Next'' button, there is a checkbox labelled '''Urgent''', check this box if this request must be prioritized. [[File:Urgent.PNG|100px]]
#Analytical tests → In this step, the laboratory technician must choose which tests, groups or profiles are requested for the patient. More than one element from each list may be chosen, but at least one test must be requested one way or another. Tests selected as part of a group or profile (highlighted in purple) cannot be deselected individually.
#Biological samples → This step informs the laboratory technician of the type of sample that must be taken, depending on the tests chosen in the previous step. There are no required fields in this step, but if the laboratory technician wants to add a comment, there is a comment box for each sample. [[File:Comments.PNG|1000px]]


At any moment, the ''next'' button cannot be used if any of the required fields is not filled in.
In every step, there is a ''Previous'' button for the laboratory technician to be able to navigate back and forth between steps and alter the information they contain.

==Change information== 
[[File:SearchRequest.PNG|350px|right|thumb|Change information form]]


This form is for editing requests whose samples were not yet delivered.
Clicking on any part of the row will bring the laboratory technician to a form similar to the [[#Create|create]] one, with all of its tabs and similar format and behavior.

==Deliver samples== 
Similarly to the previous form, this also displays a list of either ''Registered'' or ''Processing'' requests, for the laboratory technician to choose one of them.
[[File:DeliverSamples.PNG|350px|right|thumb|Deliver samples form]]
Once a request is chosen, five tabs are shown with the patient's data, the request data, its list of biological samples, and potentially analytical already done in this request, and tests in previous requests.
The first and last two are read-only (if enabled at all).
Just the biological samples allows some interaction.


Each of the samples shown contains a field to provide comments, and it can be either checked as delivered or cancelled by click the corresponding red button.
On the delivering of a sample, its origin or incident can be optionally provided.
On cancelling, a pop-up dialog allows to provide some justification for this.


It is important to notice that the tests associated to the request cannot be changed once the first sample as been delivered.

==Introduce results== 
As in the previous cases, a list of requests is shown.
In this case, this list contains all requests in ''Processing'' state.
Clicking the corresponding button at the bottom, it is possible to download a worklist with all pending tests in these requests, to work on them off-line.


[[File:IntroduceResults.PNG|350px|right|thumb|Form to Introduce Results]]


Once the laboratory technician has chosen a request, five tabs are shown with the patient's data, the request data, its list of biological samples, its list of analytical tests, and potentially previous tests of the same patient.
The first tree and last one are read-only.
Just the analytical tests allows some interaction.
Besides the same search box present in all the tables in the system, there is also the possibility of filtering the tests by group of tests (if any was chosen for this request).
A red button in the top right corner allows to cancel the request.


The table of tests contains the following columns
#Name → Shows the name and the code of the kind of test. It is colored red if either the test or its sample was cancelled.
#Result → Allows to introduce the result of the test.
#Generic test note → Shows the informative note associated to the kind of test, if any.
#Result within range → Indicates whether the result of the test is in the expected range of values for the kind of test (green check) or not (red cross).
#Referred → Indicates whether the test is done or expected to be done in another laboratory (green check) or not (red cross).
#Automatic (not visible by default) → Indicates whether the test is done or expected to be done automatically (green check) or not (red cross). Automatic tests are done by means of the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Microscope:Main Robotized microscope] and the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/MobileApp:Main Mobile App]. Their results should not be typed manually, but uploaded through Bluetooth. This feature is enabled through the corresponding [[System_administration#Parameters|system parameter]]. If enabled, the field is editable here to allow overwriting the automatic results.
#The test has some note → Indicates whether the test has some associated note (green check) or not (red cross). Tests whose results were generated automatically will always have an associated note.
#Test details → This should show an icon to navigate to further details of the test. However, if the test or its corresponding sample was cancelled, the corresponding message in red will be shown.


[[File:TestDetails.PNG|350px|right|thumb|Test details]]


On the laboratory technician accessing the details of the test, we gain access to visualize many other things (i.e., units of the result, inferior reference measure, superior reference measure, the use who introduced the results, as well as details provided for the corresponding sample on delivering it).
Moreover, this also allows to change if the test is automatic or deferred, indicate some incidence on the sample, of provide some note.
It is important to notice that any of the information provided in this form will not be persisted in the disk until back in the list and saved from there.


If the result of the test was provided automatically (which is not enabled by default and only available in the context of the [http://dl-prod.essi.upc.edu/IMAGINGwiki/index.php/Main_Page IMAGING project]), the corresponding image and its associated note will be shown at the bottom of the details of the test.

==Validate results== 
[[File:Validateresults.mp4|left]]
This functionality, available only to the laboratory supervisor, uses exactly the same interface as introducing results, but the table shows one more column ''Validated'' with a checkbox for each test.
These can be checked one by one, or all at once by choosing a concrete group of tests in the dropbox at the top.
On doing the latter, a button to check all the tests of the group will appear.


Besides doing it in the list, the results can be overwritten and the test validated from the details of the test.
Together with displaying all the information related to the test in read-only mode, the corresponding form also offers the possibility of adding a note to the test, as well as changing whether the test is automatic/referred or not, cancelling the test or the whole request.


It is important to notice that the tests will not be really validated until the bottom right button is pressed to save the changes.

==Search historic== 
[[File:Download.mp4|left]]
This functionality, available to both laboratory technician and supervisor allows to see any request in the history of the laboratory.
They can be filtered out by the state and the date of the request.
By clicking on the corresponding row, all the details of the request can be visualized.


At the bottom left of this form, there are two download buttons.
Clicking any of them will generate and download the corresponding file (i.e., CSV or ZIP).
The checkboxes in the [[System administration#Downloaded fields|Downloaded fields]] tab indicate which fields will be included in each of these files.
Moreover, the ZIP file is password protected.
The password used is indicated by the system parameter ''zip_password'', whose value can be seen and modified from [[System administration#Parameters|Parameters]] tab.
</translate>

Patients

2024-05-30T13:49:14Z

Pau:

[[Category:Patients]]
<languages/>
<translate>

The basic information unit is the patient.
Before creating any analytical request, the corresponding patient record must exist.
This will survive the livespan of the request, and will contain all their history.


<div style="float:right; margin: 0px 0px 0px 0px">
<graphviz border='frame' format='svg' rendered='dot'>
digraph FunctionalitiesDiagram {
node [shape=oval style=filled fillcolor=orange fontsize="9pt"];
//----- Patients graph
// Nodes
Patients [label="Patients"];
P_Create [label="Create", URL="#Create"];
P_Search [label="Search", URL="#Search"];
P_BasicInformation [label="Basic Information", shape="tab", URL="#Create"];
P_DocumentationInformation [label="Documentation Information", shape="tab", URL="#Create"];
P_BirthData [label="Birth Information", shape="tab", URL="#Create"];
P_ContactData [label="Contact Information", shape="tab", URL="#Create"];
P_ResidenceData [label="Residency Information", shape="tab", URL="#Create"];
P_AdditionalInformation [label="Extra Information", shape="tab", URL="#Create"];
P_Requests [label="Requests", shape="tab", URL="#Create"];
// Edges
Patients -> P_Create;
Patients -> P_Search;
P_Create -> P_BasicInformation;
P_Search -> P_BasicInformation;
P_Search -> P_Requests;
P_BasicInformation -> P_DocumentationInformation [dir=both minlen=2];
P_DocumentationInformation -> P_BirthData [dir=both minlen=2];
P_BirthData -> P_ContactData [dir=both minlen=2];
P_ContactData -> P_ResidenceData [dir=both minlen=2];
P_ResidenceData -> P_AdditionalInformation [dir=both minlen=2];
{ rank=same; P_BasicInformation P_DocumentationInformation P_BirthData P_ContactData P_ResidenceData P_AdditionalInformation P_Requests}
}
</graphviz>
</div>


__TOC__

==Create== 


This page is divided in a form with the basic information of the patient, involving the obligatory [[File:Asterisk.PNG|30px]] entry of the name, last name, gender, birth date and phone, as well as multiple tabs with additional non-mandatory information.

#Documentation information → Information such as the number of clinical history or the type and number of an identifier card.
#Birth information → Complementary information such as the birth region and locality. Added to the previously introduced birth date and the automatically calculated age of the patient.
#Contact information → Additional contact information.
#Residency information → Apart from the basic residency information, it contains a checkbox at the bottom, ''Add provenance region?''. This option is for when a patient, although local, has come from outside the country. When the box is ticked, two more boxes appear on the forms, ''Provenance region'' and ''Provenance city''. [[File:Addprovenanceregion.PNG|750px]]
#Extra information → Other data such as parent's names. The ''Reserved 1, 2 and 3'' are boxes whose names can be modified through the [[System administration|System administration]] if the laboratory requires any specific information from the patients.
#Requests → This actually not a step in the creation or update of the patient, but just a read-only tab containing all the requests of the patient.

Once the mandatory information is entered, the 'Save values' button at the bottom right of the page will be available.

==Search and Edition== 


{| class="wikitable" style="margin:auto"
|+ Table found in the Search function of the system
|-
! Name !! Phone !! Identification !! Creation Date !! Last Modification Date
|-
| The first column shows the patient's name || The patient's contact number is listed in this column || Here, the internal, automatically generated identification number can be found || This column informs about when the patient's information was first inputted into the system || The last time the patient's information was altered in the system is shown here
|}


Arrows appear next to each heading in the table when the mouse is hovered over them to manipulate the order the information is showed in for each heading.


On clicking on any row, a new form will appear with the age, gender, phone and internal identifier of the patient as well as tabs with the information on the patient's documentation information, birth information, contact information, residency information, extra information and requests. From this page, the laboratory technician can also edit the patient through the edit patient button at the bottom right of the page. To return to the search patients page, there is a Return button at the bottom left of the screen.


Notice that to avoid inconsistences in the system, patients once created cannot be deleted.

==Duplicate Detection== 


[[File:Duplicate_patient.mp4|right|500px]]
The e-mail address, as well as the Identifier document number optionally identify a patient.
Besides this, to guarantee the existence of an identifier for each patient, a consecutive number is always automatically generated and internally assigned by the system.
Moreover, patients of similar name, age and telephone number are detected as potential duplicates at creation time.
On happening, a warning is displayed, and the laboratory technician can either modify the corresponding data or move ahead with the creation.
</translate>

2024-04-27T18:10:14Z

Pau:

WiFi Connection

2024-04-27T18:08:25Z

Pau: /* Setting custom server name in the 'hosts' file */

[[Category:WiFi Connection]]

<div style="float:left; margin: 0px 20px 0px 0px">__TOC__</div>
[[File:localhost.png|300px|thumb|right|Default ARIS url]]
ARIS allows other devices in the same network as the laptop/PC acting as server (i.e., the one where it was installed, and actually running the application) to connect to the system and work concurrently.
However, ARIS executes by default on “localhost” (i.e., the server itself, which is a way to access services or resources on your own machine without going over the network), and thus not allowing other devices to connect (even if they are in the same network).
Hence, this should be properly reconfigured to the right URL (or IP address).

To make ARIS available through the WiFi connection, the first thing necessary is actually a WiFi.
Just notice that this is different from having Internet connection, which is not really necessary at this point.
There are actually two cases here.
The first one is when the network already exists, and the second is when the network must be created in the same server in the form of a HotSpot.

==Pre-existing network==
In cases where WiFi or Ethernet connections are already available, there is also the option to run the system in any of these networks. In order to be able to connect multiple devices on the same network to use ARIS concurrently, you will need to set the IP address as follows:

#Look for the IP address (the unique number that identifies where the device is located in the network) of the server executing ARIS. Note that this IP address must be the one of the active network where both the server and the other devices MUST connect. To find out which is the IP address of the server, you should:
##Open Settings: Click on the Start menu (Windows icon) located at the bottom-left corner of your screen. Then click on the gear icon labeled "Settings" to open the Windows Settings menu.
##Navigate to Network & Internet Settings: In the Windows Settings menu, click on the "Network & Internet" option. This will take you to settings related to your network connections.
##View Network Status: In the Network & Internet settings, you'll see various options on the left side. Click on "Status". This will show you an overview of your network status.
##Change Adapter Options: Under the "Status" section, find and click on the "Change adapter options" link. This will open a window displaying all the network adapters available on your computer.
##Find Active Network Connection: In the Network Connections window, you'll see a list of network adapters. Identify the available network connection (one from these three in the following example: Ethernet, Wi-Fi or Local Area Connection - a.k.a. HotSpot) where ARIS needs to run. Note that the chosen network MUST be also available for the other devices to connect too (i.e., visible from those devices). Right-click on the active network connection and select "Status" from the context menu (right button in the mause or touch pad).[[File:Netconnections.png|900px|thumb|center|Network Connections example]]
##Check Connection Status: In the Status window for your network connection, click on the "Details" button. This will open a new window displaying detailed information about your network connection.
##Find the IP address: In the Network Connection Details window, look for the "IPv4 Address" field. This field will display your active IP address.[[File:Ncdetails.png|300px|thumb|center|Network Connection details example]]
##Note Down the IP address: Take note of the IP address displayed next to "IPv4 Address." This is the active IP address of your PC in the network.
#Copy this IP address in the 'ARIS\Frontend\build\server_ip.txt' file:
##Navigate to 'C:\Users\Public' folder and find the 'ARIS\Frontend\build\server_ip.txt' file.
##Copy the selected IP address to this file, removing the previous content.[[File:Server_ip_file.png|200px|thumb|center|Editing server_ip.txt]]
##Save the changes and close the file.

Now, the next time ARIS starts, it will run in the desired URL.
[[File:Url.png|300px|thumb|right|ARIS on network URL]]
Hence, you can type the URL (192.168.1.111:3000 in the example) in a browser of this or any other device connected to the same network and access ARIS concurrently. In this example, the selected network to run ARIS was "MiFibra-842E” (Wi-Fi). So all devices connected to this network, can thus access the application as in the server.

==HotSpot network==
In cases where neither WiFi nor Ethernet networks are available, the initialization of a Local Area Network (known as HotSpot) from the laptop/PC acting as server allows to create an access point in which other devices can connect and thus work concurrently with ARIS, even without any Internet connection. In order to set up and run ARIS in a HotSpot network, you must do the following:

#Download and install [https://mypublicwifi.com/publicwifi/en/index.html MyPublicWiFi software], an assistant which will enable the creation of the HotSpot.
#Once successfully installed, open the application. You will see the main configuration page.
#In this page, select “WLAN Hotspot” tab and set the following options:
#:Network Access: Router Mode (NAT)
#:Internet Connection: Wi-Fi (0.0.0.0)
#:Network name (SSID): arisWiFi (can be anything else)
#:Network key: arisnetwork (can be anything else)
#When finished, click the “Start Hotspot” button. In case of success, the IP address in which the HotSpot is running will be shown, alongside with the previously configured name of the network. At this point, nearby devices will be capable of connecting to the “arisWiFi” by selecting this network and introducing the key.[[File:Publicwifirunning.png|300px|thumb|center|Setting the HotSpot configuration.]]
#Find the 'C:\Users\Public folder and open the ARIS\Frontend\build\server_ip.txt' file.
#Copy the IP address where the HotSpot is running (192.168.5.1 in the example) into this file, removing the previous content.[[File:Serverfilehp.png|200px|thumb|center|Editing server_ip.txt]]
#Save the changes and close the file.

The next time ARIS starts, it will run in the HotSpot network URL. Hence, you can type the URL (192.168.5.1:3000 in the example) in a browser of this or any other device connected to the HotSpot and access ARIS concurrently.
[[File:Urlhp.png|300px|thumb|right|ARIS on HotSpot network URL]]
Note that for this type of networks there is the option to set a custom server name instead of the numeric IP address, making it easier to access the system in the browser. The steps to set up this feature are explained in detail below.

===Setting custom server name in the 'hosts' file===

Furthermore, '''only for HotSpot connections (in case Wi-Fi and Ethernet connections the server name cannot be configured this way, but must be done by the network administrator)''', there is the option the set a server name instead of the numeric IP address so it can be easier to remember. For this purpose, we must edit the Windows hosts file:

#Open Notepad as an Administrator:
##Click on the Start menu (Windows icon) located at the bottom-left corner of your screen.
##Type "Notepad" into the search bar.
##Right-click on Notepad in the search results.
##Select "Run as administrator" from the context menu. If prompted for permission, click "Yes."
#Open the Hosts File:
##In Notepad, click on "File" in the top-left corner.
##Choose "Open."
##In the file explorer window, navigate to the following location: C:\Windows\System32\drivers\etc
##Change the file type dropdown menu to "All Files (*.*)" (in the bottom-right corner of the window) to make sure you can see the hosts file.
##Select the file named "hosts" and click "Open".
#Edit the Hosts File:
##The hosts file will open in Notepad.
##You'll see some comments at the beginning of the file (lines starting with a "#" symbol).
##To add an entry, go to the end of the file on a new line.
##Enter the IP address you want to assign (such as "192.168.5.1") followed by a space and then the servern name you want to map to that IP address. For example: "192.168.5.1 aris" [[File:Hosts.png|500px|thumb|center|Editing hosts file]]
#Save the Changes:
##After making your changes, click on "File" in the top-left corner.
##Choose "Save" to save the changes to the hosts file.
#Close Notepad:
##Close Notepad once you've saved the changes.

After these steps, you must set the 'ARIS/Frontend/build/server_ip.txt' with the same name as in the hosts file, instead of the IP address, as explained in the previous section.[[File:ArisURL.png|150px|thumb|center|Editing server_ip.txt]]

Once you start ARIS, it will be accessible through the “aris” URL as set before. Accessing this in the browser of the devices connected to the HotSpot will access the application as in the server itself.[[File:ArisURL2.png|300px|thumb|right|Custom ARIS URL]]

WiFi Connection

2024-04-22T15:58:17Z

Pau: /* Other networks */

[[Category:WiFi Connection]]

[[File:localhost.png|300px|thumb|right|Default ARIS url]]
ARIS allows other devices in the same network as the laptop/PC acting as server (i.e., the one where it was installed, and actually running the application) to connect to the system and work concurrently.
However, ARIS executes by default on “localhost” (i.e., the server itself, which is a way to access services or resources on your own machine without going over the network), and thus not allowing other devices to connect (even if they are in the same network).
Hence, this should be properly reconfigured to the right URL (or IP address).

==Running ARIS on network URL==
===HotSpot network===
In cases where neither WiFi nor Ethernet networks are available, the initialization of a Local Area Network (known as HotSpot) from the laptop/PC acting as server allows to create an access point in which other devices can connect and thus work concurrently with ARIS, even without any Internet connection. In order to set up and run ARIS in a HotSpot network, you must do the following:

#Install MyPublicWiFi software, an assistant which will enable the creation of the HotSpot. It can be downloaded from the following link: https://mypublicwifi.com/publicwifi/en/index.html
#Once successfully installed, open the application. You will see the main configuration page.
#In this page, select “WLAN Hotspot” tab and set the following options:
#:Network Access: Router Mode (NAT)
#:Internet Connection: Wi-Fi (0.0.0.0)
#:Network name (SSID): arisWiFi (can be anything else)
#:Network key: arisnetwork (can be anything else)
#When finished, click the “Start Hotspot” button. In case of success, the IP address in which the HotSpot is running will be shown, alongside with the previously configured name of the network. At this point, nearby devices will be capable of connecting to the “arisWiFi” by selecting this network and introducing the key.[[File:Publicwifirunning.png|300px|thumb|center|Setting the HotSpot configuration.]]
#Find the 'C:\Users\Public folder and open the ARIS\Frontend\build\server_ip.txt' file.
#Copy the IP address where the HotSpot is running (192.168.5.1 in the example) into this file, removing the previous content.[[File:Serverfilehp.png|200px|thumb|center|Editing server_ip.txt]]
#Save the changes and close the file.

The next time ARIS starts, it will run in the HotSpot network URL. Hence, you can type the URL (192.168.5.1:3000 in the example) in a browser of this or any other device connected to the HotSpot and access ARIS concurrently.
[[File:Urlhp.png|300px|thumb|right|ARIS on HotSpot network URL]]
Note that for these type of networks there is the option to set a custom name instead of the numeric URL address, making it easier to access the system in the browser. The steps to set up this feature are explained in detail in the [[WiFi_Connection#Setting custom name for ARIS URL – hosts file|Setting custom name for ARIS URL – hosts file]] section below.

===Other networks===
In cases where WiFi or Ethernet connections are available, there is also the option to run the system in any of these networks. In order to be able to connect multiple devices on the same network to use ARIS simultaneously, you will need to:

#Look for the IP address (the unique number that identifies where the device is located in the network) of the server executing ARIS. Note that this IP address must be the one of the active network where both the server and the other devices MUST connect. To find out which is the IP address of the server, you should:
##Open Settings: Click on the Start menu (Windows icon) located at the bottom-left corner of your screen. Then click on the gear icon labeled "Settings" to open the Windows Settings menu.
##Navigate to Network & Internet Settings: In the Windows Settings menu, click on the "Network & Internet" option. This will take you to settings related to your network connections.
##View Network Status: In the Network & Internet settings, you'll see various options on the left side. Click on "Status". This will show you an overview of your network status.
##Change Adapter Options: Under the "Status" section, find and click on the "Change adapter options" link. This will open a window displaying all the network adapters available on your computer.
##Find Active Network Connection: In the Network Connections window, you'll see a list of network adapters. Identify the available network connection (one from these three in the following example: Ethernet, Wi-Fi or Local Area Connection - a.k.a. HotSpot) where ARIS needs to run. Note that the chosen network MUST be also available for the other devices to connect too (i.e., visible from those devices). Right-click on the active network connection and select "Status" from the context menu (right button in the mause or touch pad).[[File:Netconnections.png|900px|thumb|center|Network Connections example]]
##Check Connection Status: In the Status window for your network connection, click on the "Details" button. This will open a new window displaying detailed information about your network connection.
##Find IP Address: In the Network Connection Details window, look for the "IPv4 Address" field. This field will display your active IP address.[[File:Ncdetails.png|300px|thumb|center|Network Connection details example]]
##Note Down the IP Address: Take note of the IP address displayed next to "IPv4 Address." This is the active IP address of your PC in the network.
#Copy this IP address in the ARIS\Frontend\build\server_ip.txt file:
##Navigate to 'C:\Users\Public folder and find the ARIS\Frontend\build\server_ip.txt' file.
##Copy the selected IP address to this file, removing the previous content.[[File:Server_ip_file.png|200px|thumb|center|Editing server_ip.txt]]
##Save the changes and close the file.

Now, the next time ARIS starts, it will run in the desired URL.
[[File:Url.png|300px|thumb|right|ARIS on network URL]]
Hence, you can type the URL (192.168.1.111:3000 in the example) in a browser of this or any other device connected to the same network and access ARIS concurrently. In this example, the selected network to run ARIS was "MiFibra-842E” (Wi-Fi). So all devices connected to this network, can thus access the application as in the server.

==Setting custom name for ARIS URL – hosts file==

Furthermore, '''only for HotSpot connections (Wi-Fi and Ethernet connections will not be able to run the application with the custom name)''', there is the option the set a name instead of the numeric IP address so it can be easier to remember. For this purpose, we must edit the Windows hosts file:

#Open Notepad as an Administrator:
##Click on the Start menu (Windows icon) located at the bottom-left corner of your screen.
##Type "Notepad" into the search bar.
##Right-click on Notepad in the search results.
##Select "Run as administrator" from the context menu. If prompted for permission, click "Yes."
#Open the Hosts File:
##In Notepad, click on "File" in the top-left corner.
##Choose "Open."
##In the file explorer window, navigate to the following location: C:\Windows\System32\drivers\etc
##Change the file type dropdown menu to "All Files" to make sure you can see the hosts file.
##Select the file named "hosts" and click "Open".
#Edit the Hosts File:
##The hosts file will open in Notepad.
##You'll see some comments at the beginning of the file, denoted by a "#" symbol.
##To add an entry, go to the end of the file on a new line.
##Enter the IP address you want to assign (such as "192.168.137.1") followed by a space and then the domain name you want to map to that IP address. For example: "192.168.137.1 aris" [[File:Hosts.png|500px|thumb|center|Editing hosts file]]
#Save the Changes:
##After making your changes, click on "File" in the top-left corner.
##Choose "Save" to save the changes to the hosts file.
#Close Notepad:
##Close Notepad once you've saved the changes.

After these steps, you must set the 'ARIS/Frontend/build/server_ip.txt' with the same name as in the hosts file, instead of the IP address, as explained in the previous section.[[File:ArisURL.png|150px|thumb|center|Editing server_ip.txt]]

Once you start ARIS, it will run on the “aris” domain as set before. Accessing this domain in the browser of the devices connected to the HotSpot will samely run the application.[[File:ArisURL2.png|300px|thumb|right|Custom ARIS URL]]

WiFi Connection

2024-04-22T15:51:27Z

Pau: /* Running ARIS on network URL */

[[Category:WiFi Connection]]

[[File:localhost.png|300px|thumb|right|Default ARIS url]]
ARIS allows other devices in the same network as the laptop/PC acting as server (i.e., the one where it was installed, and actually running the application) to connect to the system and work concurrently.
However, ARIS executes by default on “localhost” (i.e., the server itself, which is a way to access services or resources on your own machine without going over the network), and thus not allowing other devices to connect (even if they are in the same network).
Hence, this should be properly reconfigured to the right URL (or IP address).

==Running ARIS on network URL==
===HotSpot network===
In cases where neither WiFi nor Ethernet networks are available, the initialization of a Local Area Network (known as HotSpot) from the laptop/PC acting as server allows to create an access point in which other devices can connect and thus work concurrently with ARIS, even without any Internet connection. In order to set up and run ARIS in a HotSpot network, you must do the following:

#Install MyPublicWiFi software, an assistant which will enable the creation of the HotSpot. It can be downloaded from the following link: https://mypublicwifi.com/publicwifi/en/index.html
#Once successfully installed, open the application. You will see the main configuration page.
#In this page, select “WLAN Hotspot” tab and set the following options:
#:Network Access: Router Mode (NAT)
#:Internet Connection: Wi-Fi (0.0.0.0)
#:Network name (SSID): arisWiFi (can be anything else)
#:Network key: arisnetwork (can be anything else)
#When finished, click the “Start Hotspot” button. In case of success, the IP address in which the HotSpot is running will be shown, alongside with the previously configured name of the network. At this point, nearby devices will be capable of connecting to the “arisWiFi” by selecting this network and introducing the key.[[File:Publicwifirunning.png|300px|thumb|center|Setting the HotSpot configuration.]]
#Find the 'C:\Users\Public folder and open the ARIS\Frontend\build\server_ip.txt' file.
#Copy the IP address where the HotSpot is running (192.168.5.1 in the example) into this file, removing the previous content.[[File:Serverfilehp.png|200px|thumb|center|Editing server_ip.txt]]
#Save the changes and close the file.

The next time ARIS starts, it will run in the HotSpot network URL. Hence, you can type the URL (192.168.5.1:3000 in the example) in a browser of this or any other device connected to the HotSpot and access ARIS concurrently.
[[File:Urlhp.png|300px|thumb|right|ARIS on HotSpot network URL]]
Note that for these type of networks there is the option to set a custom name instead of the numeric URL address, making it easier to access the system in the browser. The steps to set up this feature are explained in detail in the [[WiFi_Connection#Setting custom name for ARIS URL – hosts file|Setting custom name for ARIS URL – hosts file]] section below.

===Other networks===
In order to be able to connect multiple devices on the same network to use ARIS simultaneously, you will need to:

#Look for the IP address (the unique number that identifies where the device is located in the network) of the server executing ARIS. Note that this IP address must be the one of the active network where both the server and the other devices MUST connect. To find out which is the IP address of the server, you should:
##Open Settings: Click on the Start menu (Windows icon) located at the bottom-left corner of your screen. Then click on the gear icon labeled "Settings" to open the Windows Settings menu.
##Navigate to Network & Internet Settings: In the Windows Settings menu, click on the "Network & Internet" option. This will take you to settings related to your network connections.
##View Network Status: In the Network & Internet settings, you'll see various options on the left side. Click on "Status". This will show you an overview of your network status.
##Change Adapter Options: Under the "Status" section, find and click on the "Change adapter options" link. This will open a window displaying all the network adapters available on your computer.
##Find Active Network Connection: In the Network Connections window, you'll see a list of network adapters. Identify the available network connection (one from these three in the following example: Ethernet, Wi-Fi or Local Area Connection - a.k.a. HotSpot) where ARIS needs to run. Note that the chosen network MUST be also available for the other devices to connect too (i.e., visible from those devices). Right-click on the active network connection and select "Status" from the context menu (right button in the mause or touch pad).[[File:Netconnections.png|900px|thumb|center|Network Connections example]]
##Check Connection Status: In the Status window for your network connection, click on the "Details" button. This will open a new window displaying detailed information about your network connection.
##Find IP Address: In the Network Connection Details window, look for the "IPv4 Address" field. This field will display your active IP address.[[File:Ncdetails.png|300px|thumb|center|Network Connection details example]]
##Note Down the IP Address: Take note of the IP address displayed next to "IPv4 Address." This is the active IP address of your PC in the network.
#Copy this IP address in the ARIS\Frontend\build\server_ip.txt file:
##Navigate to 'C:\Users\Public folder and find the ARIS\Frontend\build\server_ip.txt' file.
##Copy the selected IP address to this file, removing the previous content.[[File:Server_ip_file.png|200px|thumb|center|Editing server_ip.txt]]
##Save the changes and close the file.

Now, the next time ARIS starts, it will run in the desired URL.
[[File:Url.png|300px|thumb|right|ARIS on network URL]]
Hence, you can type the URL (192.168.1.111:3000 in the example) in a browser of this or any other device connected to the same network and access ARIS concurrently. In this example, the selected network to run ARIS was "MiFibra-842E” (Wi-Fi). So all devices connected to this network, can thus access the application as in the server.

==Setting custom name for ARIS URL – hosts file==

Furthermore, '''only for HotSpot connections (Wi-Fi and Ethernet connections will not be able to run the application with the custom name)''', there is the option the set a name instead of the numeric IP address so it can be easier to remember. For this purpose, we must edit the Windows hosts file:

#Open Notepad as an Administrator:
##Click on the Start menu (Windows icon) located at the bottom-left corner of your screen.
##Type "Notepad" into the search bar.
##Right-click on Notepad in the search results.
##Select "Run as administrator" from the context menu. If prompted for permission, click "Yes."
#Open the Hosts File:
##In Notepad, click on "File" in the top-left corner.
##Choose "Open."
##In the file explorer window, navigate to the following location: C:\Windows\System32\drivers\etc
##Change the file type dropdown menu to "All Files" to make sure you can see the hosts file.
##Select the file named "hosts" and click "Open".
#Edit the Hosts File:
##The hosts file will open in Notepad.
##You'll see some comments at the beginning of the file, denoted by a "#" symbol.
##To add an entry, go to the end of the file on a new line.
##Enter the IP address you want to assign (such as "192.168.137.1") followed by a space and then the domain name you want to map to that IP address. For example: "192.168.137.1 aris" [[File:Hosts.png|500px|thumb|center|Editing hosts file]]
#Save the Changes:
##After making your changes, click on "File" in the top-left corner.
##Choose "Save" to save the changes to the hosts file.
#Close Notepad:
##Close Notepad once you've saved the changes.

After these steps, you must set the 'ARIS/Frontend/build/server_ip.txt' with the same name as in the hosts file, instead of the IP address, as explained in the previous section.[[File:ArisURL.png|150px|thumb|center|Editing server_ip.txt]]

Once you start ARIS, it will run on the “aris” domain as set before. Accessing this domain in the browser of the devices connected to the HotSpot will samely run the application.[[File:ArisURL2.png|300px|thumb|right|Custom ARIS URL]]

WiFi Connection

2024-04-22T15:49:42Z

Pau: /* Running ARIS on network URL */

[[Category:WiFi Connection]]

[[File:localhost.png|300px|thumb|right|Default ARIS url]]
ARIS allows other devices in the same network as the laptop/PC acting as server (i.e., the one where it was installed, and actually running the application) to connect to the system and work concurrently.
However, ARIS executes by default on “localhost” (i.e., the server itself, which is a way to access services or resources on your own machine without going over the network), and thus not allowing other devices to connect (even if they are in the same network).
Hence, this should be properly reconfigured to the right URL (or IP address).

==Running ARIS on network URL==
===HotSpot network===
In cases where neither WiFi nor Ethernet networks are available, the initialization of a Local Area Network (known as HotSpot) from the laptop/PC acting as server allows to create an access point in which other devices can connect and thus work concurrently with ARIS. In order to set up and run ARIS in a HotSpot network, you must do the following:

#Install MyPublicWiFi software, an assistant which will enable the creation of the HotSpot. It can be downloaded from the following link: https://mypublicwifi.com/publicwifi/en/index.html
#Once successfully installed, open the application. You will see the main configuration page.
#In this page, select “WLAN Hotspot” tab and set the following options:
#:Network Access: Router Mode (NAT)
#:Internet Connection: Wi-Fi (0.0.0.0)
#:Network name (SSID): arisWiFi (can be anything else)
#:Network key: arisnetwork (can be anything else)
#When finished, click the “Start Hotspot” button. In case of success, the IP address in which the HotSpot is running will be shown, alongside with the previously configured name of the network. At this point, nearby devices will be capable of connecting to the “arisWiFi” by selecting this network and introducing the key.[[File:Publicwifirunning.png|300px|thumb|center|Setting the HotSpot configuration.]]
#Find the 'C:\Users\Public folder and open the ARIS\Frontend\build\server_ip.txt' file.
#Copy the IP address where the HotSpot is running (192.168.5.1 in the example) into this file, removing the previous content.[[File:Serverfilehp.png|200px|thumb|center|Editing server_ip.txt]]
#Save the changes and close the file.

The next time ARIS starts, it will run in the HotSpot network URL. Hence, you can type the URL (192.168.5.1:3000 in the example) in a browser of this or any other device connected to the HotSpot and access ARIS concurrently.
[[File:Urlhp.png|300px|thumb|right|ARIS on HotSpot network URL]]
Note that for these type of networks there is the option to set a custom name instead of the numeric URL address, making it easier to access the system in the browser. The steps to set up this feature are explained in detail in the [[WiFi_Connection#Setting custom name for ARIS URL – hosts file|Setting custom name for ARIS URL – hosts file]] section below.

===Other networks===
In order to be able to connect multiple devices on the same network to use ARIS simultaneously, you will need to:

#Look for the IP address (the unique number that identifies where the device is located in the network) of the server executing ARIS. Note that this IP address must be the one of the active network where both the server and the other devices MUST connect. To find out which is the IP address of the server, you should:
##Open Settings: Click on the Start menu (Windows icon) located at the bottom-left corner of your screen. Then click on the gear icon labeled "Settings" to open the Windows Settings menu.
##Navigate to Network & Internet Settings: In the Windows Settings menu, click on the "Network & Internet" option. This will take you to settings related to your network connections.
##View Network Status: In the Network & Internet settings, you'll see various options on the left side. Click on "Status". This will show you an overview of your network status.
##Change Adapter Options: Under the "Status" section, find and click on the "Change adapter options" link. This will open a window displaying all the network adapters available on your computer.
##Find Active Network Connection: In the Network Connections window, you'll see a list of network adapters. Identify the available network connection (one from these three in the following example: Ethernet, Wi-Fi or Local Area Connection - a.k.a. HotSpot) where ARIS needs to run. Note that the chosen network MUST be also available for the other devices to connect too (i.e., visible from those devices). Right-click on the active network connection and select "Status" from the context menu (right button in the mause or touch pad).[[File:Netconnections.png|900px|thumb|center|Network Connections example]]
##Check Connection Status: In the Status window for your network connection, click on the "Details" button. This will open a new window displaying detailed information about your network connection.
##Find IP Address: In the Network Connection Details window, look for the "IPv4 Address" field. This field will display your active IP address.[[File:Ncdetails.png|300px|thumb|center|Network Connection details example]]
##Note Down the IP Address: Take note of the IP address displayed next to "IPv4 Address." This is the active IP address of your PC in the network.
#Copy this IP address in the ARIS\Frontend\build\server_ip.txt file:
##Navigate to 'C:\Users\Public folder and find the ARIS\Frontend\build\server_ip.txt' file.
##Copy the selected IP address to this file, removing the previous content.[[File:Server_ip_file.png|200px|thumb|center|Editing server_ip.txt]]
##Save the changes and close the file.

Now, the next time ARIS starts, it will run in the desired URL.
[[File:Url.png|300px|thumb|right|ARIS on network URL]]
Hence, you can type the URL (192.168.1.111:3000 in the example) in a browser of this or any other device connected to the same network and access ARIS concurrently. In this example, the selected network to run ARIS was "MiFibra-842E” (Wi-Fi). So all devices connected to this network, can thus access the application as in the server.

==Setting custom name for ARIS URL – hosts file==

Furthermore, '''only for HotSpot connections (Wi-Fi and Ethernet connections will not be able to run the application with the custom name)''', there is the option the set a name instead of the numeric IP address so it can be easier to remember. For this purpose, we must edit the Windows hosts file:

#Open Notepad as an Administrator:
##Click on the Start menu (Windows icon) located at the bottom-left corner of your screen.
##Type "Notepad" into the search bar.
##Right-click on Notepad in the search results.
##Select "Run as administrator" from the context menu. If prompted for permission, click "Yes."
#Open the Hosts File:
##In Notepad, click on "File" in the top-left corner.
##Choose "Open."
##In the file explorer window, navigate to the following location: C:\Windows\System32\drivers\etc
##Change the file type dropdown menu to "All Files" to make sure you can see the hosts file.
##Select the file named "hosts" and click "Open".
#Edit the Hosts File:
##The hosts file will open in Notepad.
##You'll see some comments at the beginning of the file, denoted by a "#" symbol.
##To add an entry, go to the end of the file on a new line.
##Enter the IP address you want to assign (such as "192.168.137.1") followed by a space and then the domain name you want to map to that IP address. For example: "192.168.137.1 aris" [[File:Hosts.png|500px|thumb|center|Editing hosts file]]
#Save the Changes:
##After making your changes, click on "File" in the top-left corner.
##Choose "Save" to save the changes to the hosts file.
#Close Notepad:
##Close Notepad once you've saved the changes.

After these steps, you must set the 'ARIS/Frontend/build/server_ip.txt' with the same name as in the hosts file, instead of the IP address, as explained in the previous section.[[File:ArisURL.png|150px|thumb|center|Editing server_ip.txt]]

Once you start ARIS, it will run on the “aris” domain as set before. Accessing this domain in the browser of the devices connected to the HotSpot will samely run the application.[[File:ArisURL2.png|300px|thumb|right|Custom ARIS URL]]