9 FSI Pages Add-on
307
NeptuneLabs - FSI Viewer
9.28 Parameters for Statistics
(Requires FSI Viewer 4.1.3 or above)
The following parameters can be used to measure the usage of FSI Pages
instances by means of third party statistic tools. Using these parameters you can
define a template based URL to be called each time the user performs a specified
action like flipping to another page. The templates in the URL will be replaced at
runtime. You can specify a custom delay before the statistics URL will be loaded.
PageLogURL
Description
Template based URL for page view logging
Syntax
URL
Default
—
Context
Pages plug-in node or HTTP query prefixed with "pages_"
Version
4.1.3 or higher
Template based URL to load each time the user flips to another page.
The following templates will be replaced at runtime:
[uniqueid]
The FSI Pages parameter value "UniqueID"
[instanceid] A unique number identifying the FSI Pages instance (unique per
instance)
[pagenum]
The page number of the current left page
[targetpage] The target page number to flip to (if applicable)
[totaltime]
Total seconds the FSI Pages instance is running
[action]
String identifying the action which caused the log event (one of: flip,
chapters, index, input, hyperlink, hyperlinkurl)
[hyperlinkurl] The URL of the clicked hyperlink (if applicable)
Example URL:
http://example.com/log.php?catalog=foo&action= [action] &page= [pagenum]
&targetpage= [targetpage] &uniqueid= [uniqueid] &totaltime= [totaltime] &IID=
[instanceid]&targeturl=[hyperlinkurl]
You can alternatively call a Javascript function using the "javascript:" syntax. In this
case you need to define a valid HTML target frame using the "PageLogTarget"
parameter.