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.
...
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.
Détail des paramètres contextuels
- surfer.uid
UID
example
du surfer ayant déclenché l’événement exemple :
user_57- surfer.login
Login
example
de l’utilisateur exemple :
user@application.fr- surfer.role.uid
UID
example:
du rôle de l’utilisateur
role_32- surfer.role.name
Libellé du rôle de l’utilisateur (name)
example:
writer- surfer.locale.language
Code langue au format ISO-639
example:
enfr- surfer.locale.country
Code région au format ISO-3166
example:
FR- session.uid
example:
Identifiant de la session
651dqqsd54eea11ff(non
représentatif)
- session.duration
Temps écoulé depuis le début de la session (
en ms)
example:
25342- session.type
Type de session (bo|fo|admin)
example:
bo- remoteaddr
example:
Adresse IP de l’utilisateur
10.11.12.13- referer
example:
Dernière URL connue de l’utilisateur
http://monsite.com/exemple.jspz- remotecountry
Pays dans lequel se trouve l’utilisateur (code ISO-639
)
example:
FR- uri.path
example: /mypage
chemin d’accès à l’URL courante
/mapage.jspz- uri.qs
Query String
example:
de l’URL courante
param1=12¶m2=xyz- user_agent
example:
User Agent du navigateur utilisateur
mozilla/5.0 (x11; linux x86_64) applewebkit/537.36 (khtml, like gecko)
chrome/49.0.2623.87 safari/537.36- user_os
example:
Système d’exploitation utilisé
Linux- user_browsergroup
example:
Navigateur utilisé (nom du groupe)
chrome- user_browser
example: Chrome
Version du navigateur utilisé
chrome 49
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.
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 event.context.surfer.role.uid.
pour récupérer l’UID du role du surfer.
connexion_search_option.getQuery().mustNotEquals("event.context.surfer.role.uid", "role_1");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.
uid suffix at the end of the parameter name is automatically added by the application on child and child multiple properties.