docs/platform/specialized.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Sparky - Specialized Search
   4 =======================
   5
   6 *Specialized Search* Overview
   7 ~~~~~~~~~~~~~~~~~~~~~~~~~
   8
   9 *Specialized Search* provides a way to easily filter the inventory items in A&AI
  10
  11 .. image:: images/aai-ui-specialized-search.JPG
  12    :scale: 100 %
  13    :alt: alternate text
  14    :align: center
  15
  16 *Specialized Search* Features
  17 ~~~~~~~~~~~~~~~~~~~~~~~~~
  18 With Specialized Search UI, users can:
  19   * Click on a radio button for a configured node-type and add filters to run and view 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 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 *Specialized Search*
  31 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32
  33 The *Specialized Search* view can be reached by clicking on the hamburger menu item Specialized Search
  34
  35 .. image:: images/specialized-hamburger.JPG
  36    :scale: 100 %
  37    :alt: alternate text
  38    :align: center
  39
  40 How to use *Specialized Search*
  41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42 1. On Specialized Search a user can select an element type
  43
  44 .. image:: images/specialized-search-1.JPG
  45    :scale: 100 %
  46    :alt: alternate text
  47    :align: center
  48
  49 2. Then add the desired filter(s) with the input fields in the center, by choosing the attribute key from the dropdown,
  50 entering a value and clicking add filter. Once the filter is added it will be present as a pill. Filters can be removed
  51 by clicking the X on the pill
  52
  53 .. image:: images/specialized-search-2.JPG
  54    :scale: 100 %
  55    :alt: alternate text
  56    :align: center
  57
  58 3. When the desired filters are added, a user can hit run to access the results. The subsequent page will be the same as
  59 the resulting page in the browse documentation, just with the filters added. For more information on that screen, please
  60 view the documentation on browse.
  61