Skip to main content

OWA Customization Example using Maps and StreetView with a Custom Contact Type and integrating EWS within OWA Custom Forms

For those brave souls who attended my MVP theatre talk on Friday here’s the OWA customization I demo'ed. The basics of creating custom forms are documented in the Exchange SDK . But putting this together can be a little tricky so let’s go though some of the basis’s step by step.

Firstly I wanted to create a custom form that would display a map of the contacts address information and also a Street-view of the same address information using Google’s new Streetview features that was recently released for Australia. For this I created some contact items with a Message class of IPM.Contact.Map.

To start the process of creating an OWA custom form for these items firstly you need to create a folder under the Forms directory on your CAS server. You should have a directory structure similar to this on your CAS server Program Files\Microsoft\Exchange Server\ClientAccess\Owa which represents the root of the OWA ASP.NET application. Under this directory is the Forms directory which is where you first need to create a folder to hold your customization e.g. I’ve created one called maps



Next there needs to be at least one file that goes in that directory which is the registry.xml file that contains the definition for your custom forms and what actions and pages to open. The actually content pages for your custom form can be located elsewhere but for my customization I’ve just used this folder which means that my pages are going to run as part of the OWA asp.net application and use the authentication from the OWAapplication pool. The Registry.XML for my OWA customization looks like

<ApplicationElement Name="Item"><ElementClass
Value="IPM.Contact.Map"><Mapping
Form="Map.aspx"/><Mapping
Action="Open" Form="Map.aspx"/><Mapping
Action="Preview" Form="Map.aspx"/><Mapping
Action="Print" Form="Map.aspx"/></ElementClass>
</ApplicationElement><ApplicationElement
Name="PreFormAction"><ElementClass
Value="IPM.Contact.Map"><Mapping
Form="Microsoft.Exchange.Clients.Owa.Premium.Controls.
CustomFormRedirectPreFormAction,Microsoft.Exchange.Clients.Owa"/>
</ElementClass>
</ApplicationElement>

This basically means that whenever anybody opens/Previews or trys to print items with a MessageClass of IPM.Contact.Map the file map.aspx will be used. At this stage you should pause and consider the application pool this custom form is going to be running under. Writing poorly performing code that runs under the OWA application pool is going to make OWA performance poor for everybody using the server. This is something you need to give serious consideration before putting any OWA customization into production.

Next comes the tricky part because I also wanted to use Exchange Web Service in my custom forms I had to have some way of loading the EWS proxy objects. Because I wasn’t creating a separate ASPX application for my pages and I didn’t want to put a class library containing the EWS proxy objects in the GAC I dropped a class library containing the proxy objects into the bin folder for the OWA application eg Microsoft\Exchange Server\ClientAccess\Owa\Bin. I used my EWSUtil.dll but you could create your own using WDSL.exe etc. Once I could now reference the EWS proxy objects in my ASPX code I could get on with the job of coding what I wanted my form to do.

But before that I had to address one final issue which was security because I was going to be making a request to EWS from within another webpage I need to ensure that the security context used to make this request was that of the users that was logged onto OWA. To do this impersonation needed to be set as per http://support.microsoft.com/kb/306158 within the code behind file.

Okay so the final task now is just to copy the map.aspx and map.aspx.cs file into the map directory in the forms directory and then do an IISReset for Exchange to pick up the changes. If you want to see if Exchange has loaded you custom form check the application event log for an event

The code itself in the map.aspx.cs file does the following tasks firstly it takes the OWAid and Email address from the querystrings OWA passes to custom form. This information is then used to do a EWS convertID to convert that OWAid into a EWSid so that contact Item can be open in EWS using a GetItem call and the address properties can then be accessed. Next the address details are geocoded meaning it gets the longitude and latitude values for the address which are then used to send a request of to Google Maps for the Map and Street View of this address and then the result are display in couple of divs on the aspx page. The final result looks something like this to use Google Street View you need to register for you own API key (which is free) http://code.google.com/apis/maps/signup.html and change the following line

string gkGoogleKey = "abc123";

I’ve put a download of the aspx and registry.xml here the customization in action looks like this (for all those blues brothers fans)






Popular posts from this blog

Export calendar Items to a CSV file using EWS and Powershell

Somebody asked about this last week and while I have a lot of EWS scripts that do access the Calendar I didn't have a simple example that just exported a list of the Calendar events with relevant information to a CSV file so here it is. I've talked on this one before in this howto  but when you query the calendar folder using EWS you need to use a CalendarView which will expand any recurring appointments in a calendar. There are some limits when you use a calendarview in that you can only return a maximum of 2 years of appointments at a time and paging will limit the max number of items to 1000 per call. So if you have a calendar with a very large number of appointments you need to break your query into small date time blocks. In this example script I'm just grabbing the next 7 days of appointments if you want to query a longer period you need to adjust the following lines (keeping in mind what I just mentioned) #Define Date to Query $StartDate = (Get-Date) $EndDate

Downloading a shared file from Onedrive for business using Powershell

I thought I'd quickly share this script I came up with to download a file that was shared using One Drive for Business (which is SharePoint under the covers) with Powershell. The following script takes a OneDrive for business URL which would look like https://mydom-my.sharepoint.com/personal/gscales_domain_com/Documents/Email%20attachments/filename.txt This script is pretty simple it uses the SharePoint CSOM (Client side object Model) which it loads in the first line. It uses the URI object to separate the host and relative URL which the CSOM requires and also the SharePointOnlineCredentials object to handle the Office365 SharePoint online authentication. The following script is a function that take the OneDrive URL, Credentials for Office365 and path you want to download the file to and downloads the file. eg to run the script you would use something like ./spdownload.ps1 ' https://mydom-my.sharepoint.com/personal/gscales_domain_com/Documents/Email%20attachments/filena

Writing a simple scripted process to download attachmentts in Exchange 2007/ 2010 using the EWS Managed API

Every complicated thing in life is made up of smaller simpler building blocks, when it comes to writing a script (or any code really) the more of these little building blocks you have to figure out the more the process of solving a problem can become bewildering. The Internet generally provides you with lots of half eaten sandwiches of information something someone else has taken a bite out but a lot of the time half done, and as with any code its usefulness declines over time as new and better API's and methods are derived. In this post I'm going to go through a simple scripted process that hopefully covers a few more of these smaller building blocks that you might face when asked to come up with a simple costless solution to perform an automated business function with a script. So the process im going to look at is one that comes up a lot and that is you have an Email that comes into to certain mailbox every day with a certain subject in my case "Daily Export" this
All sample scripts and source code is provided by for illustrative purposes only. All examples are untested in different environments and therefore, I cannot guarantee or imply reliability, serviceability, or function of these programs.

All code contained herein is provided to you "AS IS" without any warranties of any kind. The implied warranties of non-infringement, merchantability and fitness for a particular purpose are expressly disclaimed.