100 Context Parameters

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 du surfer ayant déclenché l’événement exemple : user_57
surfer.login: Login de l’utilisateur exemple : user@application.fr
surfer.role.uid: UID du rôle de l’utilisateur role_32
surfer.role.name: Libellé du rôle de l’utilisateur (name) writer
surfer.locale.language: Code langue au format ISO-639 fr
surfer.locale.country: Code région au format ISO-3166 FR
session.uid: Identifiant de la session 651dqqsd54eea11ff (non représentatif)
session.duration: Temps écoulé depuis le début de la session (en ms) 25342
session.type: Type de session (bo|fo|admin) bo
remoteaddr: Adresse IP de l’utilisateur 10.11.12.13
referer: Dernière URL connue de l’utilisateur http://monsite.com/exemple.jspz
remotecountry: Pays dans lequel se trouve l’utilisateur (code ISO-639) FR
uri.path: chemin d’accès à l’URL courante /mapage.jspz
uri.qs: Query String de l’URL courante param1=12&param2=xyz
user_agent: 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: Système d’exploitation utilisé Linux
user_browsergroup: Navigateur utilisé (nom du groupe) chrome
user_browser: Version du navigateur utilisé 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 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

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 utilisateurs

connexion_search_option.putAggregation("pie_connexions_by_role", Analytics.TermsAggregation("event.context.surfer.role.uid", 20));