docs/platform/browse.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Sparky - Browse
   4 =======================
   5
   6 *Browse* Overview
   7 ~~~~~~~~~~~~~~~~~~~~~~~~~
   8
   9 *Browse* provides a way to easily browse the inventory items in A&AI
  10
  11 .. image:: images/aai-ui-browse.JPG
  12    :scale: 100 %
  13    :alt: alternate text
  14    :align: center
  15
  16 *Browse* Features
  17 ~~~~~~~~~~~~~~~~~~~~~~~~~
  18 With Browse UI, users can:
  19   * Click on a tile for a configured node-type and view the instance data
  20   * The user can view the information on the subsequent page in a paginated format (50 results per page)
  21   * The user can filter down the results by attributes on the top of the page (exact string matching only)
  22   * The user can download their results to xslx (500 results at a time)
  23   * The user can opt to download a range of pages to download to xslx
  24   * The user can view results in card-based format
  25   * The user can view results in a tabular-based format
  26   * The user can choose a defaulted format (saved in local storage)
  27   * The user can view & traverse relationships of an element
  28   * The user can build a query giving the element and all related elements (1 hop) by clicking >>BYOQ
  29
  30 Navigation to *Browse*
  31 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32
  33 The *Browse* view can be reached by clicking on the Browse icon from the hamburger menu
  34
  35 .. image:: images/browse-hamburger.JPG
  36    :scale: 100 %
  37    :alt: alternate text
  38    :align: center
  39
  40 How to use *Browse*
  41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42 1. On the Browse page click a desired node type to view, in this case I chose generic virtual network functions
  43
  44 .. image:: images/browse-view-1.JPG
  45    :scale: 100 %
  46    :alt: alternate text
  47    :align: center
  48
  49 2. On the resulting page you can see the results in card format
  50
  51 .. image:: images/browse-view-2.JPG
  52    :scale: 100 %
  53    :alt: alternate text
  54    :align: center
  55
  56 3. Or in tabular format
  57
  58 .. image:: images/browse-view-3.JPG
  59    :scale: 100 %
  60    :alt: alternate text
  61    :align: center
  62
  63 4. A user could view the relationships of an element on the card format by clicking the relationships button,
  64
  65 Clicking a relationship will traverse that relationship to the item
  66
  67 .. image:: images/browse-view-4.JPG
  68    :scale: 100 %
  69    :alt: alternate text
  70    :align: center
  71
  72 5. A user could view the relationships of an element on the tabular format by clicking the + to expand the row
  73
  74 Clicking a relationship will traverse that relationship to the item
  75
  76 .. image:: images/browse-view-5.JPG
  77    :scale: 100 %
  78    :alt: alternate text
  79    :align: center
  80
  81 6. A user could filter their results by adding filters at the top of the screen
  82
  83 .. image:: images/browse-view-7.JPG
  84    :scale: 100 %
  85    :alt: alternate text
  86    :align: center
  87
  88 6. A user could build a query giving the element and all related elements (1 hop) by clicking >>BYOQ
  89
  90 .. image:: images/browse-view-8.JPG
  91    :scale: 100 %
  92    :alt: alternate text
  93    :align: center
  94
  95 7. A user could switch between view types using the blue and grey buttons here, they can also set their default view here
  96
  97 .. image:: images/browse-view-9.JPG
  98    :scale: 100 %
  99    :alt: alternate text
 100    :align: center