Reference:BlueSpiceExtendedStatistics: Difference between revisions

m (1 revision imported)
m (Text replacement - "BlueSpice Farm" to "BlueSpice farm")
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{BSExtensionInfo
{{BSExtensionInfo
|desc=Provides an analytic view of many relevant parameters on the wiki.
|status=stable
|status=stable
|developer=HalloWelt
|developer=HalloWelt
|type=BlueSpice
|type=BlueSpice
|edition=BlueSpice pro, BlueSpice Farm, BlueSpice Cloud, BlueSpice free (deactivated)
|edition=BlueSpice pro, BlueSpice free (deactivated), BlueSpice farm, BlueSpice cloud
|compatible=BlueSpice
|compatible=BlueSpice
|category=Reporting
|category=Reporting
Line 10: Line 9:
|features='''ExtendedStatistics''' provides an analytic view of many relevant parameters on the wiki, providing wiki administrators better insight into the usage of the wiki.
|features='''ExtendedStatistics''' provides an analytic view of many relevant parameters on the wiki, providing wiki administrators better insight into the usage of the wiki.


ExtendedStatistics can be accessed from the page ''Special:ExtendedStatistics''.
ExtendedStatistics can be accessed from the pages ''Special:ExtendedStatistics'' and ''Special:AggregatedStatistic''.
 
 
For the Snapshot statistics (=AggregatedStatistic) to return any data, the following cronjob needs to run:
 
In <code>crontab -e</code>:
 
<code>0 1 * * * php <path-to-wiki>/extensions/BlueSpiceExtendedStatistics/maintenance/generateSnapshot.php --interval=day --skip-timecheck</code>


It offers analysis of many aspects of wiki, like:
It offers analysis of many aspects of wiki, like:
Line 30: Line 36:
*the users to exclude from statistical analysis
*the users to exclude from statistical analysis
*the maximum number of interval steps
*the maximum number of interval steps
|desc=Provides an analytic view of many relevant parameters on the wiki.
}}
{{wcagCheck
|wcagStatus=2-testing complete
|wcagCheckedfor=Web
|wcagTestdate=2022-08-08
|wcagLevel=AA
|wcagSupport=does not support
|wcagWorkaround=no
|wcagComments=most output formats only available and exportable as svg and not in text-based format.
Snapshot statistics: Export button to excel not keyboard-focusable. [[erm:30819]]
|extensionType=extended
|extensionFocus=admin
}}
}}

Latest revision as of 10:50, 7 June 2024

Extension: BlueSpiceExtendedStatistics

all extensions

Overview
Description:

Statistics module for BlueSpice

State: stable Dependency: BlueSpice
Developer: HalloWelt License: GPL-3.0-only
Type: BlueSpice Category: Reporting
Edition: BlueSpice pro, BlueSpice free (deactivated), BlueSpice farm, BlueSpice cloud Version: 4.1+

Features

ExtendedStatistics provides an analytic view of many relevant parameters on the wiki, providing wiki administrators better insight into the usage of the wiki.

ExtendedStatistics can be accessed from the pages Special:ExtendedStatistics and Special:AggregatedStatistic.


For the Snapshot statistics (=AggregatedStatistic) to return any data, the following cronjob needs to run:

In crontab -e:

0 1 * * * php <path-to-wiki>/extensions/BlueSpiceExtendedStatistics/maintenance/generateSnapshot.php --interval=day --skip-timecheck

It offers analysis of many aspects of wiki, like:

  • Number of users.
  • Number of pages.
  • Edits per user.
  • Search queries and more.

This data can be filtered:

  • By defining the period (from and to date).
  • Granulation (interval to show on diagram - day, week, month, year).
  • Type (absolute, aggregate and list modes).
  • Additional filters depending of the data being represented.

Some aspects of this extension can be configured with the Config manager, under ExtendedStatistics. Here, wiki administrators can configure:

  • the users to exclude from statistical analysis
  • the maximum number of interval steps

Technical Information

This information applies to BlueSpice 4. Technical details for BlueSpice cloud can differ in some cases.

Requirements

  • MediaWiki: 1.39.0
  • BlueSpiceFoundation: 4.3

Integrates into

  • BlueSpiceExtendedStatistics
  • BlueSpiceVisualEditorConnector
  • ContentDroplets

Special pages

  • AggregatedStatistic
  • ExtendedStatistics

Permissions

Name Description Role
extendedstatistics-viewspecialpage-aggregated Access the special page Special:AggregatedStatistic admin, maintenanceadmin
statistic-viewspecialpage Access to extended statistic admin, maintenanceadmin

Configuration

Name Value
StatisticsAvailableGrains array ( 'Y' => 'bs-statistics-year', 'm' => 'bs-statistics-month', 'W' => 'bs-statistics-week', 'd' => 'bs-statistics-day', )
StatisticsExcludeUsers array ( 0 => 'WikiSysop', )
StatisticsMaxNumberOfIntervals 366
StatisticsSnapshotStoreType 'database'

API Modules

  • bs-statistics-available-diagrams-store
  • bs-statistics-search-options-store
  • bs-statistics-tasks

Hooks

Accessibility

Test status: 2-testing complete
Checked for: Web
Last test date: 2022-08-08
WCAG level: AA
WCAG support: does not support (workaround: no)
Comments:

most output formats only available and exportable as svg and not in text-based format.

Snapshot statistics: Export button to excel not keyboard-focusable. erm:30819

Extension type: extended
Extension focus: admin