If you want to log all actions performed on the local computer and store them on your local hard drive, enable the log file option offered by SiteKiosk.
The log files will record every action performed in SiteKiosk with exact-to-the-second accuracy. The logfiles are also used as the basis for extensive user and sales statistics which you can create with the help of
SiteRemote .
SiteRemote (client and server) versions 3 or higher will collect the login information that is relevant to SiteRemote no matter if you turned on the log file option or not and submit this data to the SiteRemote server. You can specify in the settings of your SiteRemote team which login information is supposed to be stored on the server.
1.1 Storage location
Refers to the location in which the data is stored on the local hard drive. By default, the log files are saved as a Year-Month-Day.txt file to the subfolder "Logfiles" which is located in the SiteKiosk installation folder. The preset file path is
%SiteKioskPath%\Logfiles\
with "%SiteKioskPath%" representing the installation folder of SiteKiosk.
Each line in the log contains information about the protocol object that represents the source of the entry. For technical and historical reasons, this designation may vary from the currently official designation. For instance, the [Sitecash] protocol object identifies the payment module, while the [SiteCoach] protocol object represents the content filter.
Example:
Protocol Level |
20 03e9 2004-05-10 15:55:49 +0200 [SiteKiosk] started |
|
SiteRemote Info |
20 07d1 2004-05-10 15:55:51 +0200 [SiteCash] Account ... |
|
Date |
20 0bb8 2004-05-10 15:55:53 +0200 [SiteCoach] Up to date ... |
|
Time |
20 07d0 2004-05-10 15:55:53 +0200 [SiteCash] Zone changed: ... |
|
Time Zone |
20 03ec 2004-05-10 15:55:53 +0200 [SiteKiosk] Navigation: http... |
|
Protocol Object |
20 0000 2004-05-10 15:55:54 +0200 [SiteKiosk] Notification: ... |
|
Action |
20 07d3 2004-05-10 15:56:05 +0200 [SiteCash] Beginning session |
.... |
1.2 Protocol level
You can use the drop-down menu to specify which actions you want to log. It is important to note that a higher protocol level will result in the logging of fewer information. The protocol level appears at the beginning of a line entry.
Example:
..... |
20 03e9 .. [SiteKiosk] started |
20 0000 .. [SiteKiosk] Notification: Language changed to German |
40 0bb8 .. [SiteCoach] The update process failed. |
..... |
In the example above, the protocol level "Normal" has been enabled. The log will show normal entries as all as all levels above normal, e.g. errors.
You can also view the log files in
SiteRemote . SiteRemote allows you to apply filters to the log entries so that you can, for instance, reduce the displayed data to all errors that have occurred.
Note that the protocol level does not affect the live view of the debug output window.
1.3 Show debug output window (for testing purposes)
For testing purposes, you can display an output window while SiteKiosk is running which will show you a live view of the ongoing logging process. You may find this useful, for instance, if you want to detect problems and find the reasons causing these problems or track the individual steps of an action while it is being performed.
1.4 Do not log URL parameters (e.g. session IDs)
If enabled, this option will only enter the URL that is being opened into the log files while leaving out the attached parameters and IDs. This means that everything following the question mark will be cut off from the URL. As an example, the URL may look like this:
http://www.sitekiosk.com/index.php
instead of
http://www.sitekiosk.com/index.php?PHPSESSID=823870182738289187
1.5 Delete files older than X days
To prevent log files from taking up too much storage space on your hard drive, you can select a period after which the log files will be erased automatically.
You can activate the option to send the current GPS position to
SiteRemote, if you would like to automatically update the location information on the Administration page of a SiteRemote client. The computer requires GPS hardware and the GPS feature must also be enabled under Windows in order for SiteKiosk to be able to capture the data.
The GPS data can also be written to the SiteKiosk logfiles that are transferred to SiteRemote. This is only required if you plan to use the data in other applications that are able to process it. Note that SiteKiosk only creates a log entry if the position has changed by several meters.
Use the check interval to determine how often the position should be queried. Note that the data will be transferred to SiteRemote during the usual connection intervals you can configure on the settings page of your SiteRemote team.
3. Tips and recommendations
- Use SiteRemote to obtain easy-to-understand visualized evaluations of your sales and user data. SiteRemote is also capable of consolidating data that has been collected from several terminals.
- The first time the Start Page of SiteKiosk is opened automatically will be recorded as a navigation in the log files. You also have the option of suppressing this entry. Open the SiteKiosk configuration file you are using in an editor. Add the following entry to the existing log file node:
<log-first-nav>false</log-first-nav>
See also
Back to top