-
Notifications
You must be signed in to change notification settings - Fork 2
/
Management.html
196 lines (187 loc) · 9.3 KB
/
Management.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<!DOCTYPE HTML>
<!--
Spectral by HTML5 UP
html5up.net | @ajlkn
Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
-->
<html>
<head>
<title>Systems Engineering HCI</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<!--[if lte IE 8]><script src="assets/js/ie/html5shiv.js"></script><![endif]-->
<link rel="stylesheet" href="assets/css/main.css" />
<!--[if lte IE 8]><link rel="stylesheet" href="assets/css/ie8.css" /><![endif]-->
<!--[if lte IE 9]><link rel="stylesheet" href="assets/css/ie9.css" /><![endif]-->
</head>
<body>
<!-- Page Wrapper -->
<div id="page-wrapper">
<!-- Header -->
<header id="header">
<h1><a href="index.html">Systems Engineering </a></h1>
<nav id="nav">
<ul>
<li class="special">
<a href="#menu" class="menuToggle"><span>Menu</span></a>
<div id="menu">
<ul>
<li><a href="index.html">Overview</a></li>
<li><a href="Requirements2.html">Requirements</a></li>
<li><a href="Research2.html">Research</a></li>
<li><a href="HCI.html">HCI</a></li>
<li><a href="Testing.html">Testing</a></li>
<li><a href="Evaluation2.html">Evaluation</a></li>
<li><a href="Management.html">Management</a></li>
</ul>
</div>
</li>
</ul>
</nav>
</header>
<!-- Main -->
<article id="main">
<header>
<h2>Management</h2>
</header>
<section class="wrapper style5">
<div class="inner">
<section>
<h4>User Manual</h4>
<p>
The chatbot is the only component of our project that will interact with the user. Since the bot will be integrated within the Renewables.AI platform ( which will be done by our clients), the chatbot will be located somewhere in the right corner of the page. It will look like a simple chat and the bot will be triggered once the user inputs some text. The bot can be used by asking simple questions regarding the user’s plants.
</p>
<hr />
<h4>Deployment Manual</h4>
<h5>Local Deployment</h5>
<p>
In order to test the bot locally, you need to have the following installed:
<ol>
<li>
Bot Framework emulator (<a href="https://docs.microsoft.com/en-us/bot-framework/bot-service-debug-emulator">link and Tutorial to install</a>)
</li>
<li>
MAMP (<a href="https://www.mamp.info/en/ ">link and Tutorial to install</a>) - or any other local server
</li>
<li>
Our chatbot source code
</li>
</ol>
</p>
<p>Local Deployment steps:</p>
<ol>
<li>
Launch MAMP
</li>
<br>
<li>
On the “Preference” tab, click on ports and make sure you have the following ports configured:
<section>
<img src="images/depl1.jpg" style="margin-left: 20%;width: 60%;">
</section>
</li>
<br>
<li>
Click on the “start servers” button
</li>
<br>
<li>
When the servers will start running, the local host page will open in the browser.
</li>
<br>
<li>
On this page, click on the “Tools” tab and then “phpMyAdmin”
<section>
<img src="images/depl2.jpg" style="margin-left: 20%;width: 60%;">
</section>
</li>
<br>
<li>
On the new page, on the left menu, click on “NEW”
<section>
<img src="images/depl3.jpg" style="margin-left: 20%;width: 60%;">
</section>
</li>
<br>
<li>
Then type “Plant” in the whitebox and click “Create”
<section>
<img src="images/depl4.jpg" style="margin-left: 20%;width: 60%;">
</section>
</li>
<br>
<li>
In the terminal, navigate the folder with the chatbot source code
</li>
<br>
<li>
Type in the terminal : “node initDB.js” - this will fill in the database with data
</li>
<br>
<li>
After this command finishes running, type: “ node chatbot.js”
</li>
<br>
<li>
Open the Bot Framework Emulator
</li>
<br>
<li>
Press on the “Enter your endpoint URL” field and type “http://localhost:3978/api/messages”
</li>
<br>
<li>
In the Microsoft App ID fill in with the following : “66764a1f-6a0b-4d3d-9c1d-04deb3fd0716”
</li>
<br>
<li>
In the Microsoft APP Password fill in with the following : “kYDD406^tujyryILAE67-?[”
</li>
<br>
<li>
In the Locale field, type “en-US”. The page should now look something like this:
<section>
<img src="images/depl5.jpg" style="margin-left: 20%;width: 60%;">
</section>
</li>
<br>
<li>
Click on connect. Now the bot should be running and you can start asking questions.
Example:
<section>
<img src="images/depl6.jpg" style="margin-left: 10%;width: 80%;">
</section>
</li>
</ol>
<hr />
<h5>Full Azure Deployment</h5>
<p>
Our clients did not request us to deploy the components on Azure and they plan to do that by themselves. However, we thought about what steps our clients must do in order to deploy it.
</p>
<p>
Firstly, they must automate the code deployment using Github on Azure. This feature is available on the Azure Portal, in the “All Section” menu and “Continuous Deployment” option. Having the Github repository of our code, it is then easy to have the platform as well as the bot continuously running. We found this <a href="https://blog.github.com/2015-09-15-automating-code-deployment-with-github-and-azure/">Link</a> to be a nice tutorial for continuous deployment.
</p>
<p>
Secondly, our clients must deploy the database to the SQL Azure database. This can be done using the SQL scripts. This allows the continuous deployment of the database as well. The best tutorial to do that is this <a href="https://docs.microsoft.com/en-us/vsts/build-release/apps/cd/deploy-database-sqlscripts?view=vsts">official documentation link</a> by Microsoft.
</p>
<hr />
<h4>Gantt Chart</h4>
<section>
<img src="images/gantt.jpg" style="margin-left: 10%;width: 80%;">
</section>
<hr />
</section>
</div>
</section>
</article>
</div>
<!-- Scripts -->
<script src="assets/js/jquery.min.js"></script>
<script src="assets/js/jquery.scrollex.min.js"></script>
<script src="assets/js/jquery.scrolly.min.js"></script>
<script src="assets/js/skel.min.js"></script>
<script src="assets/js/util.js"></script>
<!--[if lte IE 8]><script src="assets/js/ie/respond.min.js"></script><![endif]-->
<script src="assets/js/main.js"></script>
</body>
</html>