aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-user/general.rst
diff options
context:
space:
mode:
authorAijana Schumann <aijana.schumann@highstreet-technologies.com>2020-02-11 15:44:17 +0100
committerAijana Schumann <aijana.schumann@highstreet-technologies.com>2020-02-11 15:47:12 +0100
commit06fb529a84d4e7d70b3aca68c33b2980049d5973 (patch)
tree843a61b2a980cfb486996c967b86da56863f27de /docs/guides/onap-user/general.rst
parentf6f3b57be8e57ffc6790d139b0b7f168b8cc69e6 (diff)
Update documentation for odlux
Update help texts for all odlux apps to include new functionality Issue-ID: SDNC-1065 Signed-off-by: Aijana Schumann <aijana.schumann@highstreet-technologies.com> Change-Id: I35b60a950b758f3bc3c182a01646d6d746ed2240 Signed-off-by: Aijana Schumann <aijana.schumann@highstreet-technologies.com>
Diffstat (limited to 'docs/guides/onap-user/general.rst')
-rw-r--r--docs/guides/onap-user/general.rst59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/guides/onap-user/general.rst b/docs/guides/onap-user/general.rst
new file mode 100644
index 000000000..570930ec4
--- /dev/null
+++ b/docs/guides/onap-user/general.rst
@@ -0,0 +1,59 @@
+.. contents::
+ :depth: 3
+..
+
+General functionality
+=====================
+
+The following functionality is common to all applications.
+
+Table data export
+-----------------
+
+Every table can export its data via the '︙' button. The data, which
+gets exported is the currently viewed data in the table. As the default
+pagination is set to 10, only the first 10 rows or filtered rows will be
+exported. To increase the number of exported rows, change the
+pagination.
+
+The behavior of the export can vary based on the browser:
+
+a) Some browsers allow you to save the file with the predefined name
+ export.csv. In case your browser does not offer this function please
+ use the 'Save as...' option and define the filename with extension
+ csv.
+
+b) Some browsers save the file automatically with the alphanumeric name
+ but without an extension. In such a case navigate to the downloaded
+ file location and rename the file. The extension (csv) must be
+ appended to the name. The result should look like 'export\_file.csv'.
+
+Table filters
+-------------
+
+The following filters are supported by all tables based on the data type
+of the column.
+
++------------+------------------+------------+
+| Data type | Possible Filter | Example |
++============+==================+============+
+| Text | Any characters | Test, |
+| | or numbers, | Tes\ *, |
+| | matches exactly | *\ t |
+| | unless a \* is | |
+| | used. The \* | |
+| | acts as a | |
+| | wildcard and can | |
+| | be used for | |
+| | contains, ends | |
+| | with and begins | |
+| | with queries. | |
++------------+------------------+------------+
+| Numeric | < or <= or > or | >5000, 20, |
+| | >= or exact | <=82 |
+| | number | |
++------------+------------------+------------+
+| Boolean | None (no filter | true, |
+| | set), true or | false |
+| | false | |
++------------+------------------+------------+