a month ago
Automated PDF reporting for UniFi sites
Used Products
×1
×1
×1
×1
Location
Hoofddorp, Netherlands
Description

Recently I was approached by a fellow community member, Pittsburgh based Green Light Wireless, who manage a large number of UniFi sites. They wanted to send out a monthly PDF report to their customers showing how their network has been performing over the past month and year, together with some metrics from their Zendesk Service Management platform.

 

These reports needed to be sent out at the start of each month in a consistent and automated manner, saving them a lot of time instead of manually creating reports, while also demonstrating transparency and their innovative character.

 

We were able to develop a custom reporting solution for them which does exactly what they requested, and even a bit more… More importantly, the feedback they received from their clients was extremely positive.


Benefits achieved:

• consistent and accurate reports for the clients delivered to their email address in PDF format within an hour after month end

• no manual intervention is required once a customer site has set up in the solution

• Green Light Wireless staff can spend time on higher value tasks


Components used:

• our PHP API client class to extract the required data for each site from the UniFi SDN controllers

• our base software framework which handles user management, user authentication, user authorization and configuration of the UniFi controller integrations

• HighCharts software for generation of the charts


Features:

• integrates with the UniFi SDN controller API and the Zendesk Service Management API

• fully automated generation and sending of the PDF reports

• report styling and layout match the Green Light Wireless house style

• the report contents and layout automatically adapt to whether the site contains a USG or not

• low touch, easy to administer

• ability to configure multiple TO/CC/BCC recipients for each site report

• ability to manage the template of the HTML-based email to which the PDF reports are attached through the back-end

 

 

To give you an idea of the end results, here’s a sample report preview as shown in the back-end of the solution:report_preview_with_logo.png

 

And here’s a screenshot of the PDF report in Acrobat as it is sent out to the clients through email at the start of each month:Monthly_report_in_Acrobat_with_logo.png

 

How the admins can manage the email template:email_template.PNG

 

and manage the site-specific settings for the monthly report:report_settings_anonymized.png

 

This project clearly demonstrates the power of using the UniFi controller API for which we naturally used the PHP API client class we maintain.

 

A big thank you goes to the people at Green Light Wireless who were kind enough to allow us to publish this story together with the end results.

Automated PDF reporting for UniFi sites

by a month ago - last edited 2 weeks ago

Recently I was approached by a fellow community member, Pittsburgh based Green Light Wireless, who manage a large number of UniFi sites. They wanted to send out a monthly PDF report to their customers showing how their network has been performing over the past month and year, together with some metrics from their Zendesk Service Management platform.

 

These reports needed to be sent out at the start of each month in a consistent and automated manner, saving them a lot of time instead of manually creating reports, while also demonstrating transparency and their innovative character.

 

We were able to develop a custom reporting solution for them which does exactly what they requested, and even a bit more… More importantly, the feedback they received from their clients was extremely positive.


Benefits achieved:

• consistent and accurate reports for the clients delivered to their email address in PDF format within an hour after month end

• no manual intervention is required once a customer site has set up in the solution

• Green Light Wireless staff can spend time on higher value tasks


Components used:

• our PHP API client class to extract the required data for each site from the UniFi SDN controllers

• our base software framework which handles user management, user authentication, user authorization and configuration of the UniFi controller integrations

• HighCharts software for generation of the charts


Features:

• integrates with the UniFi SDN controller API and the Zendesk Service Management API

• fully automated generation and sending of the PDF reports

• report styling and layout match the Green Light Wireless house style

• the report contents and layout automatically adapt to whether the site contains a USG or not

• low touch, easy to administer

• ability to configure multiple TO/CC/BCC recipients for each site report

• ability to manage the template of the HTML-based email to which the PDF reports are attached through the back-end

 

 

To give you an idea of the end results, here’s a sample report preview as shown in the back-end of the solution:report_preview_with_logo.png

 

And here’s a screenshot of the PDF report in Acrobat as it is sent out to the clients through email at the start of each month:Monthly_report_in_Acrobat_with_logo.png

 

How the admins can manage the email template:email_template.PNG

 

and manage the site-specific settings for the monthly report:report_settings_anonymized.png

 

This project clearly demonstrates the power of using the UniFi controller API for which we naturally used the PHP API client class we maintain.

 

A big thank you goes to the people at Green Light Wireless who were kind enough to allow us to publish this story together with the end results.

{"location":{"title":"Hoofddorp, Netherlands","placeId":"ChIJDeaapa_nxUcRgz4JJwaDET8"},"addedProducts":[{"id":"unifi-security-gateway","count":1},{"id":"unifi-cloud-key","count":1},{"id":"unifi-ac-hd","count":1},{"id":"unifi-ac-lite","count":1}],"solved":"","numbers":"","description":"","mainImage":"182210i94B5DDEE5621D16D"}

Art of WiFi
Check out our UniFi API browser tool on GitHub. The PHP API client which it uses, can be found here on GitHub.
Details on our UniFi Device Search tool can be found here.
Comments
by
Monday

@muldeeg Will certainly do so!

by
Thursday

This is amazing project! How do you get the site list - which API? The critical questions about me is that - do you able to see returned server status response from this API or Log?

 

by
Thursday

This is superb. Count me in. Where do I sign up to let me know when you've produced the solution? :-) Seriously.

by
Thursday

@plittlefield Thanks for the compliment! If you send an email to erik AT artofwifi DOT net I will make sure you are put on the list to receive further updates.

 

@tutankamun In this case, we have chosen to let the admins add sites by configuring the appropriate controller URL and credentials and selecting the site from the list of sites that are available on that controller. 

We leverage the UniFi controller API (which is also used extensively by the Web UI) through the PHP API client which we've published on GitHub and actively maintain.

https://github.com/Art-of-WiFi/UniFi-API-client

 

And yes, if you use the PHP API client in the correct manner you can catch the cURL response codes and the API response codes.

by
Friday

I would be interested as well mate.

 

 

------------

Name:Adil Harchaoui

Company: Nevada IT Solutions

Location: Reno, Nevada and Sacramento california

Website: https://nevadaitsolutions.com

Background: Enterprise IT, Ex Microsofty

by
Friday

@NVITS thanks, if you want to be updated by email please drop me an email  (erik AT artofwifi DOT net).