docs/platform/byoq.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Sparky - BYOQ
   4 =======================
   5
   6 *BYOQ* Overview
   7 ~~~~~~~~~~~~~~~~~~~~~~~~~
   8
   9 *BYOQ* provides a way for users to build their own traversal queries in A&AI
  10
  11 .. image:: images/aai-ui-byoq.JPG
  12    :scale: 100 %
  13    :alt: alternate text
  14    :align: center
  15
  16 *BYOQ* Features
  17 ~~~~~~~~~~~~~~~~~~~~~~~~~
  18 With BYOQ UI, users can:
  19   * Create queries to extract information using typeahead help functionality
  20   * The user can view help menus on the DSL syntax
  21   * The user can view the information in a paginated format (50 results per page)
  22   * The user can filter down the results in the tabular view on the column headers (exact string matching only)
  23   * The user can download their results to xslx (500 results at a time)
  24   * The user can opt to download a range of pages to download to xslx
  25   * The user can view results in card-based format
  26   * The user can view results in a tabular-based format
  27   * The user can view results in a visual format
  28   * The user can pinch/zoom in the visual format and double click on the elements to get additional info in a modal
  29   * The user can choose a defaulted format (saved in local storage)
  30   * The user can view & traverse relationships on an element
  31   * The user can build a query giving the element and all related elements (1 hop) by clicking >>BYOQ
  32
  33 Navigation to *BYOQ*
  34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35
  36 The *BYOQ* view can be reached by clicking on the BYOQ item in the hamburger menu
  37
  38 .. image:: images/byoq-hamburger.JPG
  39    :scale: 100 %
  40    :alt: alternate text
  41    :align: center
  42
  43 How to use *BYOQ*
  44 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  45 1. On the BYOQ page click in the dsl query input box and start creating a query
  46
  47 Typeahead will help with creating connections or filters as the query is being typed out (it can be configured off)
  48
  49 In this case I started from a generic-vnf with a specific filter and selected a few elements directly connected to it
  50 and ran the query
  51
  52 The results can be seen below in card format
  53
  54 .. image:: images/byoq-view-1.JPG
  55    :scale: 100 %
  56    :alt: alternate text
  57    :align: center
  58
  59 2. We have the option to view the output in tabular format
  60
  61 .. image:: images/byoq-view-2.JPG
  62    :scale: 100 %
  63    :alt: alternate text
  64    :align: center
  65
  66 3. As well as visual graph format
  67
  68 .. image:: images/byoq-view-3.JPG
  69    :scale: 100 %
  70    :alt: alternate text
  71    :align: center
  72
  73 4. You can pinch/zoom & drag/drop in the visual view and double clicking an item brings up its details in a modal
  74
  75 .. image:: images/byoq-view-4.JPG
  76    :scale: 100 %
  77    :alt: alternate text
  78    :align: center
  79
  80 5. The user can access the syntax help documentation from the accordions
  81
  82 .. image:: images/byoq-view-5.JPG
  83    :scale: 100 %
  84    :alt: alternate text
  85    :align: center