reporting

CTS 145: 6 Tips for Creating Ekahau Reports

François and Rowell discuss tips to creating Ekahau reports.

6 Tips for Creating Ekahau Reports

Download the Free CTS Ekahau Report Templates

Here are two free CTS Ekahau report templates to get you started with using reports for your surveys.

Powered by ConvertKit

1 – Use testing files

If you have worked on any programming project before, you will easily understand this tip. Working on a report template is kind of working on a programming project. Here is a summary of the work flow:

    1. You create your template file including your JSON tags
    2. You run it against your Ekahau project
    3. You debug the JSON errors you have
    4. Once you don’t have errors anymore, you can analyze the final generated
    5. You fix your template
    6. You run the updated template against you Ekahau project
    7. You rinse and repeat steps 2 to 6 until you are satisfied with the overall generated report

In the process of testing and debugging, it is much easier and faster to get it done if you work on smaller portions of the report, one at a time.

So here is how you could do it to speed up the process:

    1. Create one master template. This will be the template that you will use at the end to generate the final report.
    2. Create a second template (I call this one my testing template). You will use this one to fine tune your report, section per section. Use this template to do your testing. Once you are happy with the result, copy and paste the section into the master template and start working on the next section.

This is ease the overall process of debugging, fine tuning a custom report template.

Also, when working on loops, I also sometimes create an Ekahau testing file (.esx). I would have a little version of my Ekahau project with maybe 2 or 3 of the elements I am looping on. This way, the testing and tuning process is also much faster.

So if you want to loop on APs, you could have an Ekahau testing project with 3 APs and only loop on these 3 APs.

2 – Put as much information as you can in the Ekahau project

One of the best advantage of using custom report templates is that it speeds up the process of generating reports. In order to maximize on this, you want to gather as much information as you can into the Ekahau project itself. If you do so, you could use the template to generate most of the report for you without adjusting it too much post generation.

Example of information you can configure directly into the Ekahau project:

    • Name of the project
    • Name of the customer
    • Name of the Engineer
    • Address of the location you are designingtroubleshootingvalidating
    • Cable length from AP to MDF/IDF (2D estimation)
    • Location of MDF/IDF
    • Name of APs
    • All the capacity details (number of devices, type of devices, distribution…)
    • Network configuration details (Min. Data rate, number of SSID)

You can also add notes to the following objects:

    • Areas (you could use this to specify specific requirements for specific areas)
    • Access Points (You could use this to add pictures, specify installation specifications…)

You can also add text notes and pictures notes on the floorplan itself. All these notes and information will be retrievable from the custom template report.

Yes it will take you more time to finish up your work in Ekahau. However, it will save you a bunch of time when you generate and produce the overall final report.

3 – Prepare your floor plans beforehand

Let me tell you, it is way easier to spend the time to prepare the floor plans before you import them into Ekahau rather than fixing the generated images in the final report.

A lot of cropping and fixing can be involved, after the final report is generated, if your floor plans are not the best to begin with.

One tip would be to make sure that you work on your floor plans before importing them into your Ekahau project. Here is what can be done at this stage:

    • Rotating the floor plans
    • Converting them into black and white images
    • Cropping the white space around the floor plan
    • Creating new view points (if using DWG files)
      • AutoCAD LT
      • DraftSight
      • FreeCAD – https://www.freecadweb.org/

If you take the time to work on your floor plans before importing them into your Ekahau project, it will save you a lot of time when the final report gets generated. Basically, you will not have to touch the pictures at all.

4 – Keep your layout simple

If you keep the layout of the Word document simple, it will be easier to re-use the template from one project to another without having to modify it.

Sometimes, complex Word templates will have pictures, objects and all sorts of complexe forms. These will not play well (and might disappear) when you run the template against the Ekahau project.

Once example: the crop feature does not work. You could crop a picture on the template document but when the final reports gets generated, it will show you the whole picture in the final report. So you can crop the picture before importing into your template document.

Simple layout does not mean ugly layout. You could produce very elegant and clean minimalist template layouts that will work very well when you run them against your Ekahau project.

5 – Don’t be afraid to use the landscape mode

Depending on the floor plans you receive from the customer, some of them will be best suited for a portrait layout, some others will be suited for a landscape layout.

Here is a tip, when you create a template report document, create 2 versions:

    • One using the portrait layout
    • One using the landscape layout

That way, when it is time to generate the report, depending on the project, you can choose from the more appropriate template!

6 – Dig into the Ekahau documentation

If you go to this page, you will find all the documentation related to the custom template reports: https://support.ekahau.com/hc/en-us/sections/115001529668-Template-Reporting

If you dig a little bit into these pages, you might find some interesting things.

Here are some examples of things I have discovered while digging into the documentation:

    • You can count objects using the counttag
    • You can fix the size of a visualization you generate using the following tags
      • width-in-millis
      • width-in-inches
      • height-in-millis
      • height-in-inches
    • You can retrieve the information related to the network configurations using the following tags
      • network-conf-min-rate-2
      • network-conf-min-rate-5
      • network-conf-band-steering-2
      • network-conf-band-steering-5
      • network-conf-ssid-count-2
      • network-conf-ssid-count-5
      • network-conf-max-clients
    • You can add a new line in your code by using the following tag nl
    • You can use a specific set of requirements using this code: <#”use-requirement”: {“identifier”: “CTS Requirements”}#>

Let us know if you find something else 🙂

Links and Resources

Download the Free CTS Ekahau Report Templates

Here are two free CTS Ekahau report templates to get you started with using reports for your surveys.

Powered by ConvertKit