In this user guide we will walk through using the Koverse user interface.
Accessing the User Interface¶
To access the Koverse user interface you will need to know the URL of your Koverse instance. The URL consists of the hostname of the server on which the Koverse web application is running into a browser, followed by :8080 to indicate that port 8080 should be used. For example, if the Koverse web application is running on a server called ‘koverse-server.net’, the user interface can be accessed by visiting http://koverse-server.net:8080 in a web browser.
Supported browsers include:
- Chrome (recommended)
- Microsoft Edge
- Internet Explorer 10+
In some production instances of Koverse, authentication is handled automatically by a public key infrastructure or other integrated single-sign on system. If so, when you first visit the Koverse URL in a browser you will automatically be logged in. On a system that is using built-in Koverse user and group management, you will see the following login screen:
To login to a newly installed Koverse instance, type in ‘admin’ for the user name and ‘admin’ for the password. Otherwise, login using the username (often your email address) and password that have been provided to you by your administrator.
If your password is incorrect you will see an error.
Once logged in successfully, you will now see elements of the Koverse user interface, which are described below.
Viewing Available Data Sets¶
The ‘data view’ the first view seen after logging into Koverse. On the left you will see a list of data sets in alphabetical order. These are the data sets your user is allowed to see. There may be other data sets managed by the system that your user account does not have access to that do not appear in this list.
To filter the view of the data sets in the list, click on the search bar labeled ‘Search Everything’ just to the right of the list of data sets. You will see a drop-down menu with a list of labels that may have been applied to these data sets, as indicated by the icon that looks like a little label or tag.
Clicking on a label will limit the list of data sets to the data sets that have that label. You can click ‘show all’ to return to the full list of data sets.
You can also filter the list of data sets to those that have a name matching a particular word by typing in a word in the search bar. The drop-down menu will automatically change to show a list of the data sets whose name matches the word typed. Clicking on a suggested data set will show that data set’s details.
The search bar will also suggest values as search terms that match records in any data set. We’ll discuss searching the records of data sets in the Exploring a Data Set section.
Clicking on a data set in the list on the left will show the detail view for that data set.
When viewing details for a data set the name of the data set appears on the right, and below the name is a list of optional labels that have been applied to this data set. To the right, there is a circular button that allows the entire data set to be downloaded, either as a CSV file or a JSON file.
Finally we have some ‘metadata’ about this data set, including the total number of records, the date the data set was created, the last time data was imported, and the number of groups with whom the data set is shared.
There are four tabs on the data set detail page:
- A summary of all the data set ‘attributes’ (also sometimes called ‘fields’ or ‘columns’) found in this data set.
- Search results from this data set will appear here.
- Data Flow
- View data flowing into or out of a data set, import more data, setup transforms and exports.
- Change data set settings such as the name, view processing events, and other actions.
- View the audit log of events that have taken place involving this data set, such as searches, imports, etc.
We discuss each of these tab pages next.
If you are using a new installation of Koverse, there will be no data sets listed in the list on the left.
To load some example data sets, see the Importing Data section and return here.
Once example data sets are loaded you will see five data sets in the list on the left:
- Bank Departments
- Bank Employee Timesheets
- Bank Employees
- Bank Security Incidents
- Bank Trade Transactions