Browser Tutorial Statistics (en)¶

Backend¶

You can configure the statistics properties by the Browser plugin (flexform).

If a user is calling a record in the TYPO3 frontend, the statistics data will collected in the fields of this the record. Statistics data will be collected in dependence of the selected frontend language.

The tab [Statistics] in a document record of the extension Organiser (org)

Fields for counting hits and visits.

Fields for counting downloaded files (absolute and depending on visits).

Statistics data of the default language record (here: German)

What does the Tutorial do?¶

This is a tutorial for the extension Browser (extkey: browser).

It is only

a tutorial for the Browser statistics

It does explain the workflow of the Browser statistics and documents the needed requirements.

If you are interested in other issues than statistics, please note the section "Further Informations" below.

What does the Browser statistics do?¶

The Browser statistics enables you to count

• hits and
• visits

for

• records and
• downloaded files

of every database.

This enables you, to provide the most frequently called records. A common application is a top ten list.

You can configure your statistics by mouse clicks in the Browser flexform (the plugin) and with TypoScript.

The Browser statistics is localised.

The Browser statistics collect only hits and visits per record and per file. It doesn't collect any other data like the IP of the visitor nor any timestamp of a hit or a visit.

What doesn't the Browser statistics do?¶

The Browser statistics isn't any substitute for web statistics moduls like webalizer or piwik.

Further Information¶

Cache¶

Localisation¶

The Browser statistics module is localised.

Hits and Visits¶

The needed fields¶

If you like to use the statistics module, your record should have two fields at least:

• for counting hits
• for counting visits

If you provide files for downloading, , your record should have the two fields too:

• for counting downloads
• for counting downloads in dependence of visits

Default labels¶

The Browser uses default labels for the needed fields. It isn't recommended to use own labels, but if you have a database with statistics fields, you can use the given labels too.

The default labels are:

• for counting hits statistics_hits
• for counting visits statistics_visits
• for counting downloads statistics_downloads
• for counting downloads in dependence of visits statistics_downloads_by_visits

You have to extend your database and the TYPO3 Table-Configuration- Array (TCA). See below.

If you are using different labels, you have to configure the Browser plugin (flexform) or TypoScript.

TypoScript¶

See "Reference" below.

Check the work flow, get Warning and Errors¶

If you like to check the work flow, to get the SQL queries, warnings and errors, please enable the DRS, the Development Reporting System.

Enable the DRS¶

Admin Tools > Extension Manager

Select the Browser (browser)

Select [Information]. This should be the default

Select "DRS – Development Reporting System" [Statistics]

Get the developer log¶

Clear the TYPO3 Cache

Call the view with your record or download your file in the frontend

Load the developer log:Admin Tools > Developer Log or click [Refresh]

plugin.tx_browser_pi1¶

You find all other stuff in the manual of the Browser:

• HTML http://typo3.org/documentation/document-library/extension- manuals/browser/current/

• 6. Illustration: Take the value from TypoScript

  PDF: http://typo3.org/extensions/repository/view/browser/current/info/?tx_terfe_pi1%5BdownloadFile%5D=doc%252Fmanual.pdf

plugin.tx_browser_pi1.flexform.sDEF.statistics¶

plugin.tx_browser_pi1.flexform.sDEF.statistics {
    // Enable the statistics module
  enabled = TEXT
  enabled {
      // [Boolean] The statistics module is disabled by default
    value = 1
  }
}

plugin.tx_browser_pi1.flexform.sDEF.statistics {
  adjustment {
    fields {
      ... // See description below
    }
      // Period of a visit in seconds
    timeout = TEXT
    timeout {
        // [Integer] Period in seconds. Default is 1800
      value = 1800
    }
      // List of IPs, which won't counted for hits and visits
    dontAccountIPsOfCsvList = TEXT
    dontAccountIPsOfCsvList {
        // [String/csv]
      value = 127.0.0.1, 127.0.0.2
    }
      // Echo a debug report in the frontend
    debugging = TEXT
    debugging {
        // [Boolean]
      value = 0
    }
  }
}

plugin.tx_browser_pi1.flexform.sDEF.statistics {
  adjustment {
    fields {
        // Label and type of the field for counting downloads
      downloads {
          // Label of the field for counting downloads
        label = TEXT
        label {
            // [String] Name of the field in the SQL table.
          value = statistics_downloads
        }
          // Type of the field in the TCA
        type = TEXT
        type {
            // [String] Type of the field in the TCA
          value = none
        }
      }
      downloadsByVisits {
        // The same like downloads above
      }
      hits {
        // The same like downloads above
      }
      visits {
        // The same like downloads above
      }
    }
  }
}

Why isn't the statistics enable by default?¶

If the statistics is enabled, it checks some conditions. It isn't enabled by default, because if you don't need it, you won't have any disadvantage for the performance.

What's happen, if a statistics field is missing?¶

The Browser statistics module checks, if the needed field for counting is existing. If it isn't existing, no SQL query will executed. This protects from errors.

But in this case there will be logs in the DRS, the Development Reporting System.

What's happen with non localised records?¶

If you have records, which are localised, and records, which aren't localised, it isn't any matter.

What's happen, depends on your localisation configuration.

If a localised record will displayed, the Browser statistics module will store the hits and visits in the fields of this record.

If there isn't any localised record and the default language record will displayed, the Browser statistics module will store the hits and visits in the fields of the default language record.

If there isn't any localised record and any record will displayed, the Browser statistics module won't count any hits nor visit.