Versions Compared

Version Old Version 3 New Version 4
Changes made by

Jules DELEUZE (Unlicensed)

Jules DELEUZE (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Tous les événements stockés par le système possèdent des paramètres communs que l’on nomme les paramètres contextuels.

Ces paramètres seront stockés systématiquement par le moteur et ce quelque soit la configuration, applicative ou système. Il seront donc toujours disponibles et il ne sera pas nécessaire de les enregistrer spécifiquement, le système le fera automatiquement.

...

All events stored by the system have common parameters which are called contextual parameters.

These parameters will be systematically stored by the engine, whatever it is configuration, application or system.

They will therefore always be available and it will not be necessary to register specifically, the system will do so automatically.

Detail of default contextual parameters

surfer.uid

UID

du surfer ayant déclenché l’événement exemple

of the surfer who triggered the event
example: user_57

surfer.login

User Login

de l’utilisateur exemple


example: user@application.fr

surfer.role.uid

UID

du rôle de l’utilisateur

of the user role
example: role_32

surfer.role.name
Libellé du rôle de l’utilisateur

Name of the user’s role (name)
example: writer

surfer.locale.language
Code langue au format

Language code in ISO-639

fr

format
example: en

surfer.locale.country
Code région au format

Region code in ISO-3166 format
example: FR

session.uid
Identifiant de la session

Login of the session
example: 651dqqsd54eea11ff (non

représentatif

-representative)

session.duration
Temps écoulé depuis le début de la

Time elapsed since the start of the session (

en

in ms)
example: 25342

session.type
Type de session

Session type (bo|fo|admin)
example: bo

remoteaddr
Adresse IP de l’utilisateur

User’s IP address
example: 10.11.12.13

referer
Dernière URL connue de l’utilisateur

Last URL known to the user
example: http://monsite.com/exemple.jspz

remotecountry
Pays dans lequel se trouve l’utilisateur (code /mapage

Country in which the user is located (ISO-639 code)
example: FR

uri.path
chemin d’accès à l’URL courante

path to the current URL
example: /mypage.jspz

uri.qs

Query String

de l’URL courante

of the current URL
example: param1=12&param2=xyz

user_agent
User Agent du navigateur utilisateur

Browser Agent
example: mozilla/5.0 (x11; linux x86_64) applewebkit/537.36 (khtml, like gecko)

chrome

chromium/49.0.2623.87 safari/537.36

user_os
Système d’exploitation utilisé

Operating system used
example: Linux

user_browsergroup
Navigateur utilisé (nom du groupe) chrome

Browser used (group name)
example: chrome

user_browser
Version du navigateur utilisé

Browser version used
example: Chrome 49

Tip
 Lorsque l’on défini les paramètres à enregistrer pour un événement applicatif il est inutile d’ajouter des paramètres supplémentaires si ceux-ci sont déjà présents dans les paramètres contextuels.

Accès au paramètres contextuels

Dans la construction des dashboards on pourra se servir des paramètres contextuels pour filtrer des données dans une option de recherche ou comme donnée à représenter à l’utilisateur. Les paramètres contextuels sont tous stockés sous la clef event.context. Ainsi si l’on souhaite récupérer une des variables, on y accèdera via sa clef event.context.NOM_VARIABLE, par exemple
Important
 All those parameters are systematically saved by the application for each event.

Access to context parameters

In dashboards, context parameters can be used to filter data in search options or as data used to represent to the user.

Contextual parameters are all stored under the key event.context.

If you need to retrieve one of the variables, you can access it by its key event.context.VARIABLE_NAME.

For instance, surfer’s role UID will be retrieved with event.context.surfer.role.uid pour récupérer l’UID du role du surfer.

Exemple d’utilisation d’un paramètre contextuel pour filtrer des résultats de recherche dans une option de recherche

.

Example using a contextual parameter to filter search results in a search option
connexion_search_option.getQuery().mustNotEquals("event.context.surfer.role.uid", "role_1");
Exemple d’utilisation d’un paramètre contextuel pour la déclaration d’une aggrégation par terme sur les rôles des utilisateursExample using a contextual parameter for the declaration of a term aggregation on user roles.
connexion_search_option.putAggregation("pie_connexions_by_role", Analytics.TermsAggregation("event.context.surfer.role.uid", 20));

Logging extra custom surfers parameters

Since 11.15.0 it is now possible to add custom surfer’s parameters to the context parameters. Simply add the structure field tag analytics/surfer on any user property to have it logged at each analytics event.

When available those parameters will be found under the extra property of the context parameters (ie. event.context.extra.bolanguid).

A custom context parameter will always be retrieved with event.context.extra.VARIABLE_NAME.

Note
 The uid suffix at the end of the parameter name is automatically added by the application on child and child multiple properties.