(DI-1711) End user documentation
- Veronika Hunorova (Unlicensed)
Architecture
Application architecture consist of three main parts. Core part of application is SAP HANA XS application that stores store and index content of collected files. XS application is providing HTTP services that allows external File indexing agents to register upload files and their contents. File indexing agent is reading and parsing text files into smaller chunks that represent separate events or logs that was written into file. These chunks then agent uploads to XS application through HTTP interface. Last part is actual user interface application based on HTML5 and SAPUI5 library. Web application is using services of XS application for searching through uploaded file contents.
Installation
Prerequisites
You have our own account on SAP Cloud platform
You have HANA database connected to your account
You have obtained installation package that includes
Delivery unit of HANA XS
SAPUI5 application
Application requires minimum version of following components
Component | Minimum required version |
|---|---|
SAPUI5 library | 1.38 |
HANA Database | 1.00.121.00.1466466057 |
For step by step installation follow installation guide.
User interface
Application provides intuitive user interface for full text search in parsed log files. Results contain following information.
Origin
Identification of file location
File name
Full patch of file in local file system
Time stamp
Date and time of log content
File Content
Log Content itself
Layout of application is divided into tree sections. Top section contains searching and filtering controls, middle section shows number of results by date and bottom section shows actual results.
Filtering controls
Main function of Datavard Insights is to find and further analyze logs from multiple sources. Filter control helps user to find required results in file content. User is able to filter on all result properties. Following screenshots display which control is filter with result information.
Main search input field
As previous diagram reveals, main search bar is used for filtering file content based on given key word. User needs to confirm searched word either by clicking to magnifier icon 
or pressing ENTER on keyboard.
Date range selection
Date range selects only file content that was created in chosen time range. User has the possibility to chose from following options:
Hour
current date and time minus 1 hour
6 Hours
current date and time minus 6 hours
Day
default option
current date and time minus 24 hours
Week
current date and time - 7 days
Custom
custom defined date time range (max date and time that can be set is restricted to current date and time)
Additional filters
Sometimes user wants to pick certain file location or file itself, where the search engine will look for key word.
Mentioned properties can be filtered by using patterns. If you for example chose Origin and type 'DVD' to input field Pattern it will find all Origins that contains 'DVD'.
Result distribution chart
Once user gets search results distribution column chart shows, what is a distribution of results per particular day. Chart displays only days where at least 1 result was found for specified date range.
Results
Based on filter settings, results are displayed in form of table with mentioned columns in chronological order (ascending).
If search contains more than 20 results, table will show only first 20 entries. If it is necessary to show more records, user can click on 'More' option that loads another 20 rows. This option is visible in the end of table.
Troubleshooting
If you experience issue or behavior that wasn't described, please contact our support. Check support document.