Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UI deployment diagram and C&C #25

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
27 changes: 27 additions & 0 deletions Usecases/UI-component-Desc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
The UI microservices is split into 4 subservices<br>
#### 1.)Authentication<br>
- this service contains two actions: a login and register action<br>
- login: communicate with account information to validate credentials<br>
- register: communicate with account information to add new dredentials to account information<br>
#### 2.)Notification<br>
- this service generates and displays notifications when various tasks occur<br>
- some tasks include account info updates, updates to the triage record
#### 3.)TriageHandler<br>
- this service allows for triages to occur and triage records to be accessed.<br>
- communicates with the triage engine to perform triage<br>
- communicates with the triage record to get history

#### 4.)ER Service<br>
- this service allows for checking the current ED load from the ERDataSource<br><br>

Connectors:
#### internal:<br>
- Triage services requires the user to be logged in (from authentication)

#### External:<br>
- Authentication requires patient management to create patient credentials and validate patient credentials
- ERService requires ERDataSource from Health service management to determine load
- Notification services require patient management to determine changes in stored data to notify the patient about
- Triage services requires both patient management to access triage history and the triage engine from Health service management to perform a triage


5 changes: 5 additions & 0 deletions Usecases/UI_Deployment_description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
The first thing a client will see when accessing our service
will be the UI and how it is portrayed. This web server contains
a HTML website,a .css file for display styles, and a javascript file
to request tasks using fast API. Fast API is an efficient web framework for connecting the web server and the application server.
On the application server are three types of services: Authentication, Notification, and a Triage data gatherer. The Authentication service takes a username and password from the website, then communicates with the patient management microservice to determine the validity of the credentials. After Validity/Denial, the website will update accordingly. The notification service will generate a text message according to the current ask (such as a login success message) and display it on the webpage for a set period. The triage data gatherer communicates with the patient management microservice to obtain the data from the user's most recent triage and display it on the webpage.
48 changes: 48 additions & 0 deletions Usecases/UI_deployment.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<mxfile host="app.diagrams.net" modified="2023-10-15T08:17:30.946Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 Edg/118.0.2088.46" etag="Glxkg9gi-W8HsRFfBJBt" version="22.0.4" type="github">
<diagram name="Page-1" id="c4acf3e9-155e-7222-9cf6-157b1a14988f">
<mxGraphModel dx="746" dy="459" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" background="none" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="4m9tjicO3Grch9T9ZGGS-13" value="&lt;div&gt;&amp;lt;&amp;lt;device&amp;gt;&amp;gt;&lt;/div&gt;&lt;div&gt;Application Server&lt;/div&gt;&lt;div&gt;&lt;br&gt;&lt;/div&gt;" style="verticalAlign=top;align=left;spacingTop=8;spacingLeft=2;spacingRight=12;shape=cube;size=10;direction=south;fontStyle=4;html=1;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="290" y="20" width="400" height="460" as="geometry" />
</mxCell>
<mxCell id="4m9tjicO3Grch9T9ZGGS-18" value="&lt;div&gt;&amp;lt;&amp;lt;executionEnvironment&amp;gt;&amp;gt;&lt;/div&gt;&lt;div&gt;Authentication&lt;/div&gt;" style="verticalAlign=top;align=left;spacingTop=8;spacingLeft=2;spacingRight=12;shape=cube;size=10;direction=south;fontStyle=4;html=1;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="300" y="70" width="270" height="110" as="geometry" />
</mxCell>
<mxCell id="4m9tjicO3Grch9T9ZGGS-19" value="«artifact»&lt;br&gt;&lt;b&gt;Authentication.py&lt;br&gt;&lt;/b&gt;" style="html=1;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="430" y="120" width="110" height="50" as="geometry" />
</mxCell>
<mxCell id="4m9tjicO3Grch9T9ZGGS-22" value="&lt;div&gt;&amp;lt;&amp;lt;executionEnvironment&amp;gt;&amp;gt;&lt;/div&gt;&lt;div&gt;Notification Service&lt;br&gt;&lt;/div&gt;" style="verticalAlign=top;align=left;spacingTop=8;spacingLeft=2;spacingRight=12;shape=cube;size=10;direction=south;fontStyle=4;html=1;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="300" y="190" width="320" height="120" as="geometry" />
</mxCell>
<mxCell id="4m9tjicO3Grch9T9ZGGS-23" value="«artifact»&lt;br&gt;&lt;b&gt;NotificationHandler.py&lt;/b&gt;" style="html=1;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="425" y="235" width="150" height="50" as="geometry" />
</mxCell>
<mxCell id="4m9tjicO3Grch9T9ZGGS-25" value="&lt;div&gt;&amp;lt;&amp;lt;executionEnvironment&amp;gt;&amp;gt;&lt;/div&gt;&lt;div&gt;Triage Service&lt;br&gt;&lt;/div&gt;" style="verticalAlign=top;align=left;spacingTop=8;spacingLeft=2;spacingRight=12;shape=cube;size=10;direction=south;fontStyle=4;html=1;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="300" y="320" width="320" height="140" as="geometry" />
</mxCell>
<mxCell id="4m9tjicO3Grch9T9ZGGS-30" value="«artifact»&lt;br&gt;&lt;b&gt;TriageDataHandler.py&lt;/b&gt;" style="html=1;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="430" y="380" width="160" height="50" as="geometry" />
</mxCell>
<mxCell id="UEBHQQYHRw-75EYxOyBH-4" value="" style="endArrow=none;html=1;rounded=0;exitX=0;exitY=0;exitDx=135;exitDy=0;exitPerimeter=0;entryX=0;entryY=0;entryDx=235;entryDy=400;entryPerimeter=0;" parent="1" source="4m9tjicO3Grch9T9ZGGS-7" target="4m9tjicO3Grch9T9ZGGS-13" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="300" y="330" as="sourcePoint" />
<mxPoint x="350" y="280" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="UEBHQQYHRw-75EYxOyBH-7" value="Fast API" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" parent="UEBHQQYHRw-75EYxOyBH-4" vertex="1" connectable="0">
<mxGeometry x="-0.275" y="2" relative="1" as="geometry">
<mxPoint x="11" y="2" as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="4m9tjicO3Grch9T9ZGGS-7" value="&lt;div&gt;&amp;lt;&amp;lt;Device&amp;gt;&amp;gt;&lt;/div&gt;&lt;div&gt;Web Server&lt;br&gt;&lt;/div&gt;" style="verticalAlign=top;align=left;spacingTop=8;spacingLeft=2;spacingRight=12;shape=cube;size=10;direction=south;fontStyle=4;html=1;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="20" y="120" width="190" height="160" as="geometry" />
</mxCell>
<mxCell id="4m9tjicO3Grch9T9ZGGS-8" value="«artifact»&lt;br&gt;&lt;b&gt;Website&lt;br&gt;&lt;/b&gt;" style="html=1;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="60" y="190" width="110" height="50" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>