= Slice Portal =

== What is it? ==
The [https://portal.uky.emulab.net/ Portal] gives a graphical overview of an experiment and quick access to each node's measurements. 
Through the Portal you can:
 * see the experiment's topology
 * display measurement graphs for a node or link, updated in real time
 * access each node's Live View web page
 * access each node via VNC
 * create an Archive point
 * access Archived points

== Quick Start ==
 * The Experiment's Slice must have been [wiki:Instrumentize instrumentized] using [wiki:InstrumentationTools INSTOOLS].
 * Go to the [https://portal.uky.emulab.net/ Portal], https://portal.uky.emulab.net/
[[Image(log_on.png)]]
 * Enter your slice information into the log on form. 
  * '''User Name''' used to create the slice.
  * '''Certificate Issuer''' the certificate issuer (clearinghouse) associated with your '''User Name'''.
  * '''Slice Name''' name of slice to be shown.
  * '''Password''' password given when slice was instrumentized.
 * Click '''Map Slice''' button to see the mapped layout of the slice topology.

== Portal Interface ==
The Portal uses [http://maps.google.com/ Google Maps] to display the network topology for the given slice.
The main map components are:
 * '''Machine node''' displayed at it's geographical location. [[Image(terminal_purple.png)]] 
 * '''Measurement Controller''' (MC) displayed at it's geographical location. [[Image(mc.png)]]  
 * '''Links''' are displayed as lines connecting the nodes.  [[Image(link_line.png)]]
 * '''Menu''' displayed on the right along with Zoom and Centering controls for each machine node and MC.   [[Image(menu.png)]]  
 * Chosen '''Graphs''' will be displayed on the left. These are updated every 5 seconds. Mouse over them to enlarge.   [[Image(sample_graph.png)]]  


=== Available Actions ===
 ==== Menu Controls ====
[[Image(menu.png)]]
 * Top item is the '''Slice Name'''.
 * '''Logout''' to logout of the portal.
 * '''Make Archive''' displays the control to create an Archive point.
 * '''View Archive''' brings up the Instrumentation Tools Archive Site.
 * '''Collapse All''' or '''Expand All''' expands or collapses nodes that are in the same geographic location. Expanded nodes are relocated so that they are all visible instead of collocated.
 * '''Node Name''' Each node is listed. Click on the magnifying glass to zoom in and center the node. Click on the name to just center the node on the screen.
||
 ==== Control forms ====
 Clicking on a Machine Node, MC or Link line brings up a Control form
 * '''Machine Node''' [[Image(machine_control_checked.png)]]
  * Link to the node's Live View page ('''All Graphs''').
  * Link to the node's VNC for access to the machine's Desktop ('''VNC''').
  * A list of check boxes for showing the node's graphs. Checked graphs are shown to the left. 
 * '''MC'''
  * Link to the MC's Instrumentation Page (Live View) ('''Main Page''') 
 * '''Link'''
  * A list of check boxes for showing the link's graphs. Checked graphs are shown to the left.