docs/general.rst

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