I started looking for a Forum tip on “Session Relevance vs Client Relevance”, only to find I haven’t actually written one yet, though I keep meaning to get around to that. I’ll try to write up something in the next week or two.
For now, the short version is that Session Relevance is evaluated on the server, not the client. Clients cannot use Session Relevance, at all, because it requires a Session on the server. To use Session Relevance, you must be logged on (authenticated) to the Server.
Session Relevance is useful in creating custom Dashboards, Web Reports, or REST API queries, all of which run in a session on the server.
For testing Session Relevance, the easiest place is probably the Web Reports QNA page ( https://web-reports-server.domain:8083/webreports?page=QNA
). Other options include the Presentation Debugger in the Console (need to enable Console Debug options first). There’s also a Session Relevance Query Tester and an Excel Connector standalone tool.
In either a Custom Web Report, or in a custom Console Dashboard, in any of the HTML areas you can perform simple relevance substitutions via the special tags <?relevance some relevance query /?>
, for example <?relevance concatenation of ps of names of bes computers ?>
would output a set of HTML <p>
tags, with one computername in each paragraph.
Web Reports and Console Dashboards also provide a couple of JavaScript functions for relevance, that can be used inside script tags on either. Relevance(string)
and EvaluateRelevance(string)
are the most common. One returns a flat string of all the results, while the other returns an object allowing to step through each plural result and each property of the result.
https://developer.bigfix.com/other/dashboard-api/ goes into some detail on both the HTML tag and JavaScript session relevance usage.
You can also use Session Relevance via the REST API by posting to https://bes-root-server.domain:52311/api/query
. Some good details at https://developer.bigfix.com/rest-api/ and its sub-topics.