docs/general.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2020 highstreet technologies and others
   4
   5 .. contents::
   6    :depth: 3
   7 ..
   8
   9 General functionality
  10 =====================
  11
  12 The following functionality is common to all applications.
  13
  14 Table data export
  15 -----------------
  16
  17 Every table can export its data via the '︙' button. The data, which
  18 gets exported is the currently viewed data in the table. As the default
  19 pagination is set to 10, only the first 10 rows or filtered rows will be
  20 exported. To increase the number of exported rows, change the
  21 pagination.
  22
  23 The behavior of the export can vary based on the browser:
  24
  25 a) Some browsers allow you to save the file with the predefined name
  26    export.csv. In case your browser does not offer this function please
  27    use the 'Save as...' option and define the filename with extension
  28    csv.
  29
  30 b) Some browsers save the file automatically with the alphanumeric name
  31    but without an extension. In such a case navigate to the downloaded
  32    file location and rename the file. The extension (csv) must be
  33    appended to the name. The result should look like 'export\_file.csv'.
  34
  35 Table filters
  36 -------------
  37
  38 The following filters are supported by all tables based on the data type
  39 of the column.
  40
  41 +------------+------------------+------------+
  42 | Data type  | Possible Filter  | Example    |
  43 +============+==================+============+
  44 | Text       | Any characters   | Test,      |
  45 |            | or numbers,      | Tes\ \*,   |
  46 |            | matches exactly  | \*\ t      |
  47 |            | unless a \* is   |            |
  48 |            | used. The \*     |            |
  49 |            | acts as a        |            |
  50 |            | wildcard and can |            |
  51 |            | be used for      |            |
  52 |            | contains, ends   |            |
  53 |            | with and begins  |            |
  54 |            | with queries.    |            |
  55 +------------+------------------+------------+
  56 | Numeric    | < or <= or > or  | >5000, 20, |
  57 |            | >= or exact      | <=82       |
  58 |            | number           |            |
  59 +------------+------------------+------------+
  60 | Boolean    | None (no filter  | true,      |
  61 |            | set), true or    | false      |
  62 |            | false            |            |
  63 +------------+------------------+------------+