docs/platform/byoqBuilder.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Sparky - BYOQ Builder
   4 =======================
   5
   6 *BYOQ Builder* Overview
   7 ~~~~~~~~~~~~~~~~~~~~~~~~~
   8
   9 *BYOQ Builder* provides a way to easily create complex queries through a visual builder
  10
  11 .. image:: images/aai-ui-byoq-builder.JPG
  12    :scale: 100 %
  13    :alt: alternate text
  14    :align: center
  15
  16 *BYOQ Builder* Features
  17 ~~~~~~~~~~~~~~~~~~~~~~~~~
  18 With BYOQ Builder UI, users can:
  19   * Click on a tile for a configured node-type and view the instance data
  20
  21 Navigation to *BYOQ Builder*
  22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23
  24 The *BYOQ Builder* view can be reached by clicking on the BYOQ Builder hamburger menu item
  25
  26 .. image:: images/byoq-builder-hamburger.JPG
  27    :scale: 100 %
  28    :alt: alternate text
  29    :align: center
  30
  31 How to use *BYOQ Builder*
  32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 1. On the BYOQ Builder page click 'Start Building' to open the modal with all node types, to choose a starting node for your query
  34
  35 .. image:: images/byoq-builder-view-1.JPG
  36    :scale: 100 %
  37    :alt: alternate text
  38    :align: center
  39
  40 2. In this example I chose generic-vnf and decided to filter on one of it's properties by clicking options and entering a filter
  41
  42 .. image:: images/byoq-builder-view-2.JPG
  43    :scale: 100 %
  44    :alt: alternate text
  45    :align: center
  46
  47 The little blue + box allows for adding OR filter values (but I don't use it here)
  48
  49 .. image:: images/byoq-builder-view-3.JPG
  50    :scale: 100 %
  51    :alt: alternate text
  52    :align: center
  53
  54 3. Scroll the modal to the bottom and click submit, you will see the element you chose and a DSL query being built
  55
  56 .. image:: images/byoq-builder-view-4.JPG
  57    :scale: 100 %
  58    :alt: alternate text
  59    :align: center
  60
  61 4. From here you can add, remove, or edit via the icons on the node, in this case I choose + for add check a few more nodes in my query path
  62
  63 .. image:: images/byoq-builder-view-5.JPG
  64     :scale: 100 %
  65     :alt: alternate text
  66     :align: center
  67
  68 5. After submitting that I can see the query being built at the top and it showing the same visually
  69
  70 .. image:: images/byoq-builder-view-6.JPG
  71     :scale: 100 %
  72     :alt: alternate text
  73     :align: center
  74
  75 6. You can continue this process of adding/deleting/editing and adding filters until you have the final query for your desired output.
  76
  77 At this point you would click Run Query or Manually Edit and Run Query if you want to make manual edits.
  78
  79 After this is done, your qury will be ran and results returned.
  80
  81 .. image:: images/byoq-builder-view-7.JPG
  82     :scale: 100 %
  83     :alt: alternate text
  84     :align: center
  85
  86 .. image:: images/byoq-builder-view-8.JPG
  87     :scale: 100 %
  88     :alt: alternate text
  89     :align: center
  90