Skip to content

Commit 1a62df4

Browse files
actions-useractions-user
committed
updated site
1 parent a1ad14c commit 1a62df4

File tree

105 files changed

+6726
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+6726
-0
lines changed

‎esw-ocs-eng-ui/0.6.0-M1/Getting-started.html‎

Lines changed: 319 additions & 0 deletions
Large diffs are not rendered by default.

‎esw-ocs-eng-ui/0.6.0-M1/Login_HomePage.html‎

Lines changed: 267 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,267 @@
1+
<!DOCTYPE html>
2+
<html lang="en" class="no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width,initial-scale=1">
6+
<meta http-equiv="x-ua-compatible" content="ie=edge">
7+
<meta name="description" content="docs">
8+
<meta name="generator" content="Paradox, paradox-material-theme=0.7.0, mkdocs-material=3.0.3">
9+
10+
<meta name="lang:clipboard.copy" content="Copy to clipboard">
11+
<meta name="lang:clipboard.copied" content="Copied to clipboard">
12+
<meta name="lang:search.language" content="">
13+
<meta name="lang:search.pipeline.stopwords" content="true">
14+
<meta name="lang:search.pipeline.trimmer" content="true">
15+
<meta name="lang:search.result.none" content="No matching documents">
16+
<meta name="lang:search.result.one" content="1 matching document">
17+
<meta name="lang:search.result.other" content="# matching documents">
18+
<meta name="lang:search.tokenizer" content="[\s\-]+">
19+
20+
21+
<meta name="description" content="docs">
22+
<link rel="shortcut icon" href="assets/images/favicon.png">
23+
<title>Login and Home Page · OCS-ENG-UI - OCS Engineering User Interface</title>
24+
<link rel="stylesheet" href="assets/stylesheets/application.451f80e5.css">
25+
<link rel="stylesheet" href="lib/material__tabs/dist/mdc.tabs.min.css">
26+
<link rel="stylesheet" href="lib/prettify/prettify.css">
27+
<script src="assets/javascripts/modernizr.1aa3b519.js"></script>
28+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
29+
<style>
30+
body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}
31+
code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}
32+
</style>
33+
<link rel="stylesheet" href="assets/fonts/font-awesome.css">
34+
<link rel="stylesheet" href="assets/fonts/material-icons.css">
35+
<link rel="stylesheet" href="assets/stylesheets/paradox-material-theme.css">
36+
</head>
37+
<body
38+
>
39+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
40+
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
41+
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
42+
<header class="md-header" data-md-component="header">
43+
<nav class="md-header-nav md-grid">
44+
<div class="md-flex">
45+
<div class="md-flex__cell md-flex__cell--shrink">
46+
<a href="index.html" title="OCS-ENG-UI - OCS Engineering User Interface" class="md-header-nav__button md-logo">
47+
<i class="md-icon">local_library</i>
48+
</a>
49+
</div>
50+
<div class="md-flex__cell md-flex__cell--shrink">
51+
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
52+
</div>
53+
<div class="md-flex__cell md-flex__cell--stretch">
54+
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
55+
<span class="md-header-nav__topic">
56+
OCS-ENG-UI - OCS Engineering User Interface
57+
</span>
58+
<span class="md-header-nav__topic">
59+
Login and Home Page
60+
</span>
61+
</div>
62+
</div>
63+
<div class="md-flex__cell md-flex__cell--shrink">
64+
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
65+
<div class="md-search" data-md-component="search" role="dialog">
66+
<label class="md-search__overlay" for="__search"></label>
67+
<div class="md-search__inner" role="search">
68+
<form class="md-search__form" name="search">
69+
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
70+
<label class="md-icon md-search__icon" for="__search"></label>
71+
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">&#xE5CD;</button>
72+
</form>
73+
<div class="md-search__output">
74+
<div class="md-search__scrollwrap" data-md-scrollfix>
75+
<div class="md-search-result" data-md-component="result">
76+
<div class="md-search-result__meta">
77+
Type to start searching
78+
</div>
79+
<ol class="md-search-result__list"></ol>
80+
</div>
81+
</div>
82+
</div>
83+
</div>
84+
</div>
85+
86+
</div>
87+
</div>
88+
</nav>
89+
</header>
90+
91+
<div class="md-container">
92+
<main class="md-main">
93+
<div class="md-main__inner md-grid" data-md-component="container">
94+
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
95+
<div class="md-sidebar__scrollwrap">
96+
<div class="md-sidebar__inner">
97+
<nav class="md-nav md-nav--primary" data-md-level="0" style="visibility: hidden">
98+
<label class="md-nav__title md-nav__title--site" for="drawer">
99+
<a href="index.html" title="OCS-ENG-UI - OCS Engineering User Interface" class="md-nav__button md-logo">
100+
<span class="md-nav__button md-logo">
101+
<i class="md-icon">local_library</i>
102+
</a>
103+
<a href="index.html" title="OCS-ENG-UI - OCS Engineering User Interface">
104+
OCS-ENG-UI - OCS Engineering User Interface
105+
</a>
106+
</label>
107+
<ul>
108+
<li><a href="UI_overview.html" class="page">Overview and Guide to this User Manual</a></li>
109+
<li><a href="Getting-started.html" class="page">Getting Started</a></li>
110+
<li><a href="UI_processflow.html" class="page">Process Flow for Users</a></li>
111+
<li><a href="Login_HomePage.html" class="active page">Login and Home Page</a></li>
112+
<li><a href="ManageInfrastructure.html" class="page">Manage Infrastructure Page</a></li>
113+
<li><a href="ManageObservation.html" class="page">Manage and Monitor Observation Page</a></li>
114+
<li><a href="ManageSequencer.html" class="page">Manage Sequencer Page</a></li>
115+
<li><a href="Resources.html" class="page">The Resources Page</a></li>
116+
</ul>
117+
<nav class="md-nav md-nav--secondary">
118+
<label class="md-nav__title" for="__toc">Table of contents</label>
119+
<ul>
120+
<li><a href="Login_HomePage.html#login-and-home-page" class="header">Login and Home Page</a>
121+
<ul>
122+
<li><a href="Login_HomePage.html#logging-in" class="header">Logging In</a></li>
123+
<li><a href="Login_HomePage.html#home-page" class="header">Home Page</a></li>
124+
</ul></li>
125+
</ul>
126+
</nav>
127+
128+
</nav>
129+
<ul style="display: none">
130+
<li class="md-nav__item md-version" id="project.version">
131+
<label class="md-nav__link" for="__version">
132+
<i class="md-icon" title="Version">label_outline</i> 0.6.0-M1
133+
</label>
134+
</li>
135+
</ul>
136+
</div>
137+
</div>
138+
</div>
139+
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
140+
<div class="md-sidebar__scrollwrap">
141+
<div class="md-sidebar__inner">
142+
<nav class="md-nav md-nav--secondary">
143+
<label class="md-nav__title" for="__toc">Table of contents</label>
144+
<ul>
145+
<li><a href="Login_HomePage.html#login-and-home-page" class="header">Login and Home Page</a>
146+
<ul>
147+
<li><a href="Login_HomePage.html#logging-in" class="header">Logging In</a></li>
148+
<li><a href="Login_HomePage.html#home-page" class="header">Home Page</a></li>
149+
</ul></li>
150+
</ul>
151+
</nav>
152+
153+
</div>
154+
</div>
155+
</div>
156+
<div class="md-content">
157+
<article class="md-content__inner md-typeset">
158+
<div class="md-content__searchable">
159+
<h1><a href="#login-and-home-page" name="login-and-home-page" class="anchor"><span class="anchor-link"></span></a>Login and Home Page</h1>
160+
<p>To use OCS-ENG-UI the user must log in to the system. The user interface is integrated with the CSW Authentication and Authorization Service, which keeps track of users and their security roles in the system.</p>
161+
<h2><a href="#logging-in" name="logging-in" class="anchor"><span class="anchor-link"></span></a>Logging In</h2>
162+
<p>The below image shows a snapshot of the login screen :</p>
163+
<p><img src="./images/Login-Screen.png" alt="Login" /></p>
164+
<p>To access the Engineering UI portal in this release version, a user should log in with roles and credentials as specified below.</p>
165+
<h3><a href="#authentication-and-authorization" name="authentication-and-authorization" class="anchor"><span class="anchor-link"></span></a>Authentication and Authorization</h3>
166+
<p>OCS-ENG-UI is a proper UISTD user interface and requires the user be authenticated with the CSW Authentication and Authorization Service (AAS).</p>
167+
<p>For testing purposes, we have created <code>osw-user1, esw-user1 &amp; tcs-user1</code> users while launching the AAS from csw-services.</p>
168+
<p>For testing purposes, user-role <code>osw-user1</code> can be used.</p>
169+
<pre><code>Username: osw-user1 Password: osw-user1
170+
</code></pre>
171+
<p>For authorized commands, the esw-user role is required.</p>
172+
<pre><code>Username: esw-user1 Password: esw-user1
173+
</code></pre><div class="callout note "><div class="callout-title">Note</div>
174+
<p>You may add new users to AAS/KeyCloak following procedures in the CSW documentation. To operate OCS-ENG-UI properly the user must have the osw-user or esw-user roles.</p></div>
175+
<h2><a href="#home-page" name="home-page" class="anchor"><span class="anchor-link"></span></a>Home Page</h2>
176+
<p>Once log in happens successfully, the user should be able to see the screen below:</p>
177+
<p><img src="./images/HomePage.png" alt="Home Page" /></p>
178+
<h3><a href="#spawn-shutdown-the-sequence-manager" name="spawn-shutdown-the-sequence-manager" class="anchor"><span class="anchor-link"></span></a>Spawn/Shutdown the Sequence Manager</h3>
179+
<p>The top of this page shows a button to Spawn/Shutdown the Sequence Manager. Spawning means to startup the Sequence Manager.</p>
180+
<p>If Sequence Manager is been spawned with agents (as with esw-services), then it shows the label &lsquo;Shutdown&rsquo; for the Sequence Manager.</p>
181+
<p><img src="./images/HomePage_SequenceManager-ShutdownButton.png" alt="ShutdownSequenceManager" /></p><div class="callout note "><div class="callout-title">Note</div>
182+
<p>Sequence Manager may be started without the OCS-ENG-UI from its application, and the system will still work.</p></div>
183+
<p>Clicking on &lsquo;Shutdown&rsquo; button asks for confirmation before shutting down the Sequence Manager.</p>
184+
<p><img src="./images/HomePage-ShutdownSequenceManagerConfirm.png" alt="ConfirmShutdownSequenceManager" /></p>
185+
<p>Once Sequence Manager is shutdown, the label changes to &lsquo;Spawn&rsquo; and a message of successful shutdown is displayed.</p>
186+
<p><img src="./images/HomePage_SequenceManager-SpawnButton.png" alt="Home Page" /></p>
187+
<p>After clicking on &lsquo;Spawn&rsquo; button, select an Agent to run Sequence Manager on.</p>
188+
<p><img src="./images/HomePage_SequenceManager-SpawnAfterShutdown.png" alt="Home Page" /></p>
189+
<p>Clicking on one of the Agents, spawns Sequence Manager on that machine.</p>
190+
<h3><a href="#home-page-also-shows-tabs-for-links-to" name="home-page-also-shows-tabs-for-links-to" class="anchor"><span class="anchor-link"></span></a>Home Page also shows tabs for links to</h3>
191+
<ul>
192+
<li><a href="ManageInfrastructure.html">Manage Infrastructure</a></li>
193+
<li><a href="ManageObservation.html">Manage Observations</a></li>
194+
<li><a href="Resources.html">Resources</a></li>
195+
</ul>
196+
</div>
197+
<div>
198+
<a href="https://github.com/tmtsoftware/esw-ocs-eng-ui/tree/master/src/main/Login_HomePage.md" title="Edit this page" class="md-source-file md-edit">
199+
Edit this page
200+
</a>
201+
</div>
202+
<div class="print-only">
203+
<span class="md-source-file md-version">
204+
0.6.0-M1
205+
</span>
206+
</div>
207+
</article>
208+
</div>
209+
</div>
210+
</main>
211+
<footer class="md-footer">
212+
<div class="md-footer-nav">
213+
<nav class="md-footer-nav__inner md-grid">
214+
<a href="UI_processflow.html" title="Process Flow for Users" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
215+
<div class="md-flex__cell md-flex__cell--shrink">
216+
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
217+
</div>
218+
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
219+
<span class="md-flex__ellipsis">
220+
<span class="md-footer-nav__direction">
221+
Previous
222+
</span>
223+
Process Flow for Users
224+
</span>
225+
</div>
226+
</a>
227+
<a href="ManageInfrastructure.html" title="Manage Infrastructure Page" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
228+
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
229+
<span class="md-flex__ellipsis">
230+
<span class="md-footer-nav__direction">
231+
Next
232+
</span>
233+
Manage Infrastructure Page
234+
</span>
235+
</div>
236+
<div class="md-flex__cell md-flex__cell--shrink">
237+
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
238+
</div>
239+
</a>
240+
</nav>
241+
</div>
242+
<div class="md-footer-meta md-typeset">
243+
<div class="md-footer-meta__inner md-grid">
244+
<div class="md-footer-copyright">
245+
Powered by
246+
<a href="https://github.com/lightbend/paradox">Paradox</a>
247+
and
248+
<a href="https://jonas.github.io/paradox-material-theme/">Paradox Material Theme</a>
249+
250+
</div>
251+
</div>
252+
</div>
253+
</footer>
254+
255+
</div>
256+
<script src="assets/javascripts/application.583bbe55.js"></script>
257+
<script src="assets/javascripts/paradox-material-theme.js"></script>
258+
<script>app.initialize({version:"0.17",url:{base:"."}})</script>
259+
<script type="text/javascript" src="lib/prettify/prettify.js"></script>
260+
<script type="text/javascript" src="lib/prettify/lang-scala.js"></script>
261+
<script type="text/javascript">
262+
document.addEventListener("DOMContentLoaded", function(event) {
263+
window.prettyPrint && prettyPrint();
264+
});
265+
</script>
266+
</body>
267+
</html>

0 commit comments

Comments
 (0)