Office365 MailBox usage report with SteelScript App Framework and integration in Portal

Need to integrate Office365 metrics in Portal? Steelscript App Framework can help.

The O365 plugin has been developed with Steelscript App Framework. It retrieves Mailbox Usage reporting data and shows them in table and timeserie widgets which can be embedded in a Portal dashboard.

 

The O365 plugin package is attached (steelscript.o365-1.0.0.tar.gz).

 

Notes

Developing plugin requires a bit of knowledge in Python scripting. The source code is now available on a Github repository.

Riverbed technical tutorials help a lot (9.10. Plugins — steelscript documentation; 9.11. Writing a Plugin — steelscript documentation) as well as community help and support - special thanks to Mike Garabedian and Eric De Bressing.

 

Details

The O365 plugin consumes the Office365 usage reports Odata feed provided by Microsoft (Office365 RESTful API) - Office365 tenant userid/password need to be set in the settings file (o365_settings.py). Then it can fetch data, parse and format to feed SteelScript AppFwk datasources, widgets and reports. Finally in Portal, dasboard can embed HTML iframe using Auxialiary Panel.

 

 

 

Prerequisites

 

Deploy the O365 plugin on the SteelScript VM1.0 with App Framework

 

#1 Copy the file attached steelscript.o365-1.0.0.tar.gz on your box (ex. inside /tmp) and then following on your box

 

#2 Install and check the package has been installed

 

sudo pip install steelscript.o365-1.0.0.tar.gz

 

steel about

#3- Configure the plugin settings with your Office365 userid and password

Edit file /usr/lib/python2.7/site-packages/steelscript/o365/core/o365_settings.py

o365defaultuserid = 'reporting@contoso.com'

o365defaultpassword = 'mypasswordoffice365'

 

#4- Refresh SteelScript reports

python manage.py collectreports --overwrite ; python manage.py reload

 

 

Embed SteelScript widget in a Portal dashboard

 

#1 Open SteelScript in a webbrowser

 

#2 Open the report (Reports -> Office365 MailBox Usage report)

 

 

#3 Retrieve the HTML to embed (Right-Click on the widget, Click on Embed this widget….)

Ex.: <iframe width="500" height="312" src="http://10.0.0.1:8000/report/o365/o365_mbusage_report/widgets/mailbox-usage-timeseries-2-1/render/?auth=ed8da279351e447fb6d96ec547baac07" frameborder="0"></iframe>

 

 

#4- Open Portal in the webbrowser, edit a dashboard

 

#5 – Create a new Auxialiary Panel

 

  • Select HTML for the type
  • Set a Title
  • Paste the widget html code in HTML field
  • Set the refresh rate

 

Example: