docs/platform/view_inspect.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Sparky - View & Inspect
   4 =======================
   5
   6 *View & Inspect* Overview
   7 ~~~~~~~~~~~~~~~~~~~~~~~~~
   8
   9 *View & Inspect* provides a graph based view of elements within AAI. A
  10 single entity is the entry point into each graph, and from that base
  11 element a graph is generated based off relationships.
  12
  13 .. image:: images/aai-ui-view-inspect.jpg
  14    :scale: 100 %
  15    :alt: alternate text
  16    :align: center
  17
  18 *View & Inspect* Features
  19 ~~~~~~~~~~~~~~~~~~~~~~~~~
  20 With View & Inspect UI, users can:
  21   * Search for a network or service object using any part of a key  attribute name, ID or object type
  22   * Select a node matching suggestion returned in the drop-down list, and view a visual representation of its service hierarchy and related nodes
  23   * View and search for multiple object types
  24   * View the specific attributes of a node or any of its related nodes
  25
  26 Navigation to *View & Inspect*
  27 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  28
  29 The *View & Inspect* view can be reached by two means:
  30
  31 1. Main navigation menu
  32 2. Selecting a search result related to an entity instance (e.g. an
  33    entity called readme-entity)
  34
  35 Using *View & Inspect*
  36 ~~~~~~~~~~~~~~~~~~~~~~
  37
  38 *View & Inspect* is driven by using the search bar at the top of the UI
  39 to find and select entity instances. Once an instance has been selected,
  40 a request is processed in *Sparky's* backend component that generates a
  41 graph representation of the selected entity. The graph data is returned
  42 to *View & Inspect* and rendered on screen.
  43
  44 Node Details
  45 ^^^^^^^^^^^^
  46
  47 Upon node selection, the selected graph node details will appear in a
  48 panel to the right of the graph titled, *Node Details*.
  49
  50 Interacting with the Graph
  51 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  52
  53 The graph can be panned by clicking and holding empty space amongst the
  54 graph and moving the mouse. This will pan the entire graph. The graph
  55 can be zoomed in and out by using a mouse scroll wheel. Nodes in the
  56 graph can be select by clicking on them. Nodes in the graph can be moved
  57 by clicking, holding, and dragging them using the mouse.
  58
  59 How to use *View & Inspect*
  60 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  61 1. Start typing into the "Search Network" bar and search suggestions will be displayed - as below
  62
  63 .. image:: images/view1.png
  64    :height: 152px
  65    :width: 250 px
  66    :scale: 100 %
  67    :alt: alternate text
  68    :align: left
  69
  70 .. image:: images/view2.png
  71    :height: 150px
  72    :width: 269 px
  73    :scale: 100 %
  74    :alt: alternate text
  75    :align: center
  76
  77 .. image:: images/view3.png
  78    :height: 150px
  79    :width: 245 px
  80    :scale: 100 %
  81    :alt: alternate text
  82    :align: center
  83
  84 Note: The OXM schema defines the services and resources archetypes and mappings to Java types that are used by A&AI to define the REST endpoints for reading and manipulating the inventory data. The OXM file has been annotated with searchable attributes. Sparky communicates with Synapse (data-router) to update ElasticSearch as entities are created/updated and deleted.
  85
  86 The related objects are displayed as a graph. The attributes of the selected object are in the "Node Details" tab beside the graph display
  87
  88 .. image:: images/view4.png
  89    :height: 165px
  90    :width: 298 px
  91    :scale: 100 %
  92    :alt: alternate text
  93    :align: left
  94
  95 .. image:: images/view5.png
  96    :height: 165px
  97    :width: 280 px
  98    :scale: 100 %
  99    :alt: alternate text
 100    :align: center