Example for using custom tags in template reporting

This template is intended to be used with the example project Custom-Tags-Reporting-

Example.esx

<#"loop-start":
{
"type": "floors”,
“filter”:
{
“include”:
{
“has-aps”:”true”
}
}
}#>5 GHz signal strength for my Aps on switch A
<#"visualization":
{
“aps”:
{
"filter":
{
"include":
{
"owner": "my“,
"band": "5",
“tag-key”: “ap_switch”,
“tag-value”: “A”
}
}
},
"heatmap":
{
"type": "sig-strength",
"filter":
{
"include":
{
"owner": "my",
"band": "5",
“tag-key”: “ap_switch”,
“tag-value”: “A”
}
}
}
}
#>
<#”visualization-legend”: {“width-in-millis”: “80”}#>

What's happening above: Here's an example how you can use tags to filter the visualization
results in reporting.

Above a signal strength heatmap with AP icons is created. Multiple filters are also applied on
the created heatmap.

Any shown results require My-status and 5Ghz frequency and tag-key "ap_switch" and tag-
value "A" to be on APs in order to be shown in this visualizations.

Connected Access Points

AP Name Vendor Serial Number Other tags
<#”loop-start”: <#${ap- <#”loop-start”: {”type”: <#”loop-start”: {”type”:
{”type”: ”aps”, vendor}#> ”tags”, “filter”: ”tags”, “filter”: {“exclude”:
“filter”: {“include”: {“tag-key”: {“tag-key”: “ap_*”}}}#><#$
{“include”: “ap_serial”}}}#><#${tag- {tag-key}#>: <#${tag-
{“owner”: value}#> <#”loop-end”: value}#><#${nl}#><#”loop-
“my”, {”type”: ”tags”}#> end”: {”type”:
"band": "5", ”tags”}#><#”loop-end”:
“tag-key”: {”type”: ”aps”}#>
“ap_switch”,
“tag-value”:
“A”}}}#><#$
{ap-name}#>

What's happening above: Here's an example how you can list specific tags using tag-loops
with using tag-key and tag-value filters. Additionally, you can also use tags as filters for other
data tags as well (as seen in the first column).

AP Name: AP names are listed with ap-name data tag, but they are first filtered various
parameters including tag-key "ap_switch" and tag-value "A"
Vendor: Loops and filters are already established in the previous column, so we use those
report in vendor names with simple "ap-vendor" data tag.
Serial Number: This is an example of how to report just one specific tag value. We tags-loop
to report tags that are found in the currently looped APs. We further filter the tags by
adding tag-key "ap_serial" filter for it, so only the "ap_serial" tag will be matched. The tag-
value data tag will then show the value of that tag.
Other Tags: We also want to show other tags from these APs, but don't want to repeat the
serial number or switch type from previous columns. Therefore, we use exclusion filter to
filter out all the tag-keys with "ap_" on them - giving us only the other remaining tags!

5 GHz signal strength for my Aps on switch B

<#"visualization":
{
“aps”:
{
"filter":
 {
"include":
{
"owner": "my“,
"band": "5",
“tag-key”: “ap_switch”,
“tag-value”: “B”
}
}
},
"heatmap":
{
"type": "sig-strength",
"filter":
{
"include":
{
"owner": "my",
"band": "5",
“tag-key”: “ap_switch”,
“tag-value”: “B”
}
}
}
}
#>

<#”visualization-legend”: {“width-in-millis”: “80”}#>

What's happening above: Here's an example how you can use tags to filter the visualization
results in reporting.

Above a signal strength heatmap with AP icons is created. Multiple filters are also applied on
the created heatmap.

Any shown results require My-status and 5Ghz frequency and tag-key "ap_switch" and tag-
value "B" to be on APs in order to be shown in this visualization.

Connected Access Points

AP Name Vendor Serial Number Other tags
<#”loop-start”: <#${ap- <#”loop-start”: {”type”: <#”loop-start”: {”type”:
{”type”: ”aps”, vendor}#> ”tags”, “filter”: ”tags”, “filter”: {“exclude”:
“filter”: {“include”: {“tag-key”: {“tag-key”: “ap_*”}}}#><#$
{“include”: “ap_serial”}}}#><#$ {tag-key}#>: <#${tag-
{“owner”: {tag-value}#> <#”loop- value}#><#${nl}#><#”loop-
“my”, end”: {”type”: ”tags”}#> end”: {”type”:
"band": "5", ”tags”}#><#”loop-end”:
 “tag-key”: {”type”: ”aps”}#>
“ap_switch”,
“tag-value”:
“B”}}}#><#$
{ap-name}#>
<#"loop-end": {"type": "floors"}#>

What's happening above: Same things are happening here as in the list above, but this time
we are filtering with tag-value "B", so we will get results from different set of APs.

And that's a quick introduction how you can use custom tags to your benefit in Ekahau Pro!