Skip to content

Commit

Permalink
Merge pull request #590 from reshmabidikar/work-for-ts-180
Browse files Browse the repository at this point in the history
Update Kaui Guide for TS180
  • Loading branch information
sbrossie authored Jan 14, 2025
2 parents 4db93c3 + b42eaf1 commit a43f12a
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 0 deletions.
Binary file added userguide/assets/img/kaui/DownloadCsv1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added userguide/assets/img/kaui/DownloadCsv2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added userguide/assets/img/kaui/DownloadCsv3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added userguide/assets/img/kaui/DownloadCsv4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added userguide/assets/img/kaui/EditColumns1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added userguide/assets/img/kaui/EditColumns2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added userguide/assets/img/kaui/EditColumns3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added userguide/assets/img/kaui/EditColumns4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added userguide/assets/img/kaui/KauiHealth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions userguide/kaui/includes/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,40 @@ If relevant, you can click a link in the grid to view that item's detail. For ex

image::../assets/img/kaui/ClickToViewDetail.png[width=650,align="center"]

Kaui allows you to edit the columns displayed in a table. To do this, click on the Edit Columns button:

image::../assets/img/kaui/EditColumns1.png[width=650,align="center"]

This displays a new menu that lets you select the columns that you would like to view/hide:

image::../assets/img/kaui/EditColumns2.png[width=650,align="center"]

You can click on the checkbox next to a column name to show/hide it from the view. For example, in the screenshot below only the `Account Id`, `Name` and `External Key` columns are displayed in the table:

image::../assets/img/kaui/EditColumns3.png[width=650,align="center"]

You can also drag and drop a column name to change its position in the table. For example, to display the `External Key` field as the first column in the table, click the `External Key` field in the Edit Columns UI, drag it to the top of the list and drop it.

image::../assets/img/kaui/EditColumns4.png[width=650,align="center"]

To download the data from a table, click on the Download CSV button:

image::../assets/img/kaui/DownloadCsv1.png[width=650,align="center"]

This displays some additional download customizations:

image::../assets/img/kaui/DownloadCsv2.png[width=650,align="center"]

If you are on the accounts page and would like to download data for all the accounts created in this week, you can select `This Week` and click the Download button:

image::../assets/img/kaui/DownloadCsv3.png[width=650,align="center"]

On clicking the Download button, a CSV file is generated and downloaded.

By default, only the fields displayed on the screen are included in the CSV. if you would like all the fields to be included, you should click the "All fields" checkbox:

image::../assets/img/kaui/DownloadCsv4.png[width=650,align="center"]

[[basic_search]]
=== Basic Search

Expand Down Expand Up @@ -237,3 +271,8 @@ image::../assets/img/kaui/AdvancedSearchSyntax-Labeled.png[]
|transaction ID, external key

|===

=== Checking Kaui Version
You can check the current Kaui version by typing `\http://<your Kaui URL>/health` in the browser. This displays the following:

image::../assets/img/kaui/KauiHealth.png[width=450,align="center"]

0 comments on commit a43f12a

Please sign in to comment.