Hide

YetaWF Documentation

Display
Print

YetaWF.Visitors Package

Overview

This package implements modules that track user activity and display the collected information. All data is stored in the Visitor log which can be displayed using Admin > Dashboard > Visitor Activity (standard YetaWF site).

The YetaWF.Visitors package requires a PostgreSQL/SQL database to store visitor activity.

Enabling Visitor Activity Logging

Add SQL Database

In order to enable use of a SQL DB by the Visitors Package, a connection string has to be defined in your AppSettings.json file:

    "P": {
      . . .
      "YetaWF_Visitors": {
        . . .
        "IOMode": "SQL",
        "SQLDbo": "dbo",
        "SQLConnect": "Data Source=....;Initial Catalog=....;User ID=....;Password=...."
      },

The site must be restarted for the settings to take effect.

Reference SkinVisitor Module

In order for visitor activity to be recorded, the "SkinVisitor Module" must be referenced by the site or by individual pages. Site-wide the module can be referenced using Admin > Settings > Site Settings, References tab (standard YetaWF site). Individual pages can reference the module using Page Settings, References tab.

Adding this module is required so the Visitor Activity Module can display visitor activity. Reference by site to record all activity.

Visitor Log

The Visitor log can be displayed using Admin > Dashboard > Visitor Activity (standard YetaWF site).

The Scheduler Module, see Admin > Panel > Scheduler (standard YetaWF site), can be used to define when old visitor data can be removed. The Scheduler Item "Remove Old Visitor Data" defines the frequency. Data older than the last time the scheduler item ran is removed. This means if you run the scheduler item once a week, data older than one week is removed.

Modules

Module NameDescription
IP Address Lookup ModuleDisplays information for an IP address. This module is used by the Visitor Activity Module to display host name and geolocation information for a visitor.
Visitor (Skin) Module ModuleRecords site visitor information. This module is typically added to every page (as a skin module) so all visitor activity is recorded. This is best done using a Module Reference in the Site Settings.
Visitor Activity ModuleDisplays visitor activity. It is accessible using Admin > Dashboard > Visitor Activity (standard YetaWF site). Displaying a record's detailed information is available in the Visitor Activity grid shown by the Visitors Module. Records cannot be removed.
Visitor Activity Summary ModuleDisplays a summary of yesterday's and today's visitor activity. It is accessible using Admin > Dashboard > Visitor Activity (standard YetaWF site).
Visitor Entry Details ModuleDisplays detailed information about a visitor. This is used by the Visitor Activity Module to display a record's detail information.
Visitor Stats ModuleDisplays a small icon. When an authorized user hovers over the icon, today's and yesterday's totals for anonymous and logged on visitors are shown. By clicking on the icon, the Visitors Module is displayed, showing all visitor activity (assuming that the URL for a page with the Visitors Module has been defined in the TinyVisitor Module's settings). This module is typically added to every page (as a skin module) so the Administrator has access to visitor activity.
Visitors Settings ModuleUsed to edit a site's visitors settings. This can be accessed using Admin > Settings > Visitors Settings (standard YetaWF site).

License

The YetaWF.Visitors package is part of YetaWF, an open source product licensed under the GNU General Public License, version 3 (GPL-3.0) - Copyright - Softel vdm, Inc.