Ekahau Template Reporting Cheatsheet v1

Before we start, you can always find the full documentation for Ekahau Report Templates here.

The following is a list of useful quick references when building out Ekahau Report Templates:

Data Tags

<#${project-name}#>

<#${project-file-name}#>

<#${project-owner}#>

<#${project-notes}#>

<#${project-location}#>

<#${floor-name}#>

<#${ap-name}#>

<#${ap-number}#>

<#${ssid}#>


Loop Tags

<#“loop-start”: {“type”: “floors”}#>
<#“loop-end”: {“type”: “floors”}#>

<#“loop-start”: {“type”: “aps”}#>
<#“loop-end”: {“type”: “aps”}#>

<#“loop-start”: {“type”: “ssids”}#>
<#“loop-end”: {“type”: “ssids”}#>


<#“loop-start”: {”type”: ”aps”,
    “filter”: {
      “include”: { “on-map”: “false” }
    }
}#>


Visualization Tags

<#”loop-start” : {“type” : “floors”} #>

<#{

  “visualization” : {

    “width-in-millis”: “80”,

    “heatmap : {

      “adapter” : “iPhone13Pro”,

      “show-contours” : “false”,

      “range-colors” : “#FF0000-#00F200”,

      “range-abs-max” : “-45”,

      “accuracy” : “very”,

      “type” : “sig-strength”,

      “range-spacing” : “1”,

      “requirement-grey-out” : “true”,

      “signal-prediction” : “one-floor”,

      “visualization-opacity” : “70”,

      “range-cutout-min” : “-80”,

      “filter” : {

        “include” : {

          “owner” : “my”,

          “band” : “5”

        }

      },

      “mode” : “smooth”,

      “sig-at-ch” : “all”,

      “show-sig-of” : “strongest”,

      “range-abs-min” : “-90”

    }

  }

}#>

<#”loop-end” : {“type” : “floors”} #>


<#”visualization”:{
  “aps”: {
    “show-name”: “true”
  }
}#>


“surveys”: “true”,
“areas”: {}


“width-in-millis”: “120”
“width-in-inches”: “4”

“height-in-millis”: “80”
“height-in-inches”: “2”


Visualization Legend

<#{“visualization-legend”:{}}#>

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


Visualization Statistics

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


VisualizationHeatmap Type ParameterHeatmap specific parameters
Airtime Utilizationairtime-utilization 
Associated Access Pointassociated-ap“association-mode”, “noise”, “noise-source”, “adapter” and “network-load”
Capacity: Clients Per APcap-cli-per-apN/A
Capacity Healthcap-healthN/A
Channel Widthch-bandwidth“sig-str-min”
Channel Coveragech-coverage“adapter” and “ch-view-mode”
Channel Interferencech-interference 
Data Ratedata-rate“noise”, “noise-source”, “adapter”, “network-load”
JitterjitterN/A
Network Healthnw-health“network-health-pass-condition”
Network Issuesnw-issuesN/A
NoisenoiseN/A
Number of APsnumber-of-aps“adapter”, “sig-str-min”, “range-min”, “range-max”, “range-open”, “range-spacing” and “range-colors“ 
Packet Losspacket-loss“range-min”, “range-max”, “range-open”, “range-spacing” and “range-colors“
Round-Trip TimerttN/A
Signal Strength (Primary)sig-strength“adapter”, “show-sig-of”, “sig-at-ch”, “range-min”, “range-max”, “range-open”, “range-spacing” and “range-colors“
Secondary Signal Strengthsig-strength-2nd“adapter”, “show-sig-of”, “sig-at-ch”, “range-min”, “range-max”, “range-open”, “range-spacing” and “range-colors“
Tertiary Signal Strengthsig-strength-3rd“adapter”, “show-sig-of”, “sig-at-ch”, “range-min”, “range-max”, “range-open”, “range-spacing” and “range-colors“
Signal to Noise Ratio (SNR)snr“noise”, “noise-source”, “adapter”, “network-load”, “range-min”, “range-max”, “range-open”, “range-spacing”, “range-colors“
Spectrum Channel Powerspectrum-ch-power “range-min”, “range-max”, “range-open”, “range-spacing”, “range-colors“
Channel (Spectrum) Utilizationspectrum-utilization  
Throughputthroughput“noise”, “noise-source”, “adapter”, “network-load”
Interferersinterferers 
Difference in Signal Strengthdiff-sig-strength “sig-at-ch”, “range-min”, “range-max”, “range-open”, “range-spacing” and “range-colors“
Bluetooth Coveragebluetooth-coverage “sig-str-min”, “range-min”, “range-max”, “range-open”, “range-spacing” and “range-colors“
Visualization Types

Custom AP Tags

<#“loop-start”: {“type”: “aps”}#>

<#”loop-start”: {“type”: “tags”,

  “filter”: {

    “include”: {

      “tag-key”: “tx-power-5”

      }

    }

}#>

<#${tag-value}#>

<#”loop-end”: {“type”: “tags”}#>

<#“loop-end”: {“type”: “aps”}#>


Special Tags

<#${nl}#>

There is also a large repository of example Ekahau Report templates at this Google Drive link, thanks to @nickjvturner