Monday, April 23, 2012

Where's CAS (lly) putting your CAS location on a map

As a bit of break from the EWS powershell series here is an interesting script that will show a Google Map of the location(s) of your CAS server's if you have them (In multiple Geographically locations) and the AD Site that the CAS Server is located in has the location property set in a format that can be Geo-coded by the Google maps API.

For this script to work you must have set the Location property of the AD site where your CAS is located in and it needs to be formatted in a Geo-code format. eg  street, city, state, zip you can test it with eg my settings looked like

 So lets look at how the script works first we have a Get-ClientAccessServer loop

Get-ClientAccessServer | foreach-object{

The next thing the script does is jumps out to use ADSI to access the server object for the CAS

$soSvrObject = [ADSI]("LDAP://" + $_.DistinguishedName.ToString())

This script then uses ADSI to grab the Site object from the msExchServerSite property via ADSI

$siteObject = [ADSI]("LDAP://" + $soSvrObject.Properties.msExchServerSite.Value.ToString())

It then Geo-codes the address which means it gets the Lat and Long of the address location which can then be used to construct the Google Map URL and place the Map Pin

    $WebClient = new-object System.Net.WebClient
    $location = $rptObj.Location
    $baseURL = ""
    $url = $baseURL + $location + "&output=xml&sensor=false"
    $LatLonBox = ([xml]($WebClient.DownloadString($url))).kml.Response.Placemark

The rest of the script just gets the Map and displays it in a Windows Form picture box so what you get when you run the script is something like

Or a Northern Hemisphere example

I've put a download of this script here the script itself looks like

  1. [System.Reflection.Assembly]::LoadWithPartialName("System.Drawing")  
  2. [System.Reflection.Assembly]::LoadWithPartialName("")  
  4. $rptCollection = @()  
  5. Get-ClientAccessServer | foreach-object{  
  6.     $rptObj = "" | Select ServerName,Version, SiteName, Location,Description,MapUrl  
  7.     $rptObj.ServerName = $_.Name  
  8.     $soSvrObject = [ADSI]("LDAP://" + $_.DistinguishedName.ToString())  
  9.     $rptObj.Version = $soSvrObject.Properties.serialNumber.Value  
  10.     $siteObject = [ADSI]("LDAP://" + $soSvrObject.Properties.msExchServerSite.Value.ToString())  
  11.     $rptObj.SiteName = $siteObject.Properties.Name.Value  
  12.     $rptObj.Location = $siteObject.Properties.Location.Value  
  13.     $rptObj.Description = $siteObject.Properties.Description.Value  
  14.     $WebClient = new-object System.Net.WebClient  
  15.     $location = $rptObj.Location  
  16.     $baseURL = ""  
  17.     $url = $baseURL + $location + "&output=xml&sensor=false"  
  18.     $LatLonBox = ([xml]($WebClient.DownloadString($url))).kml.Response.Placemark  
  19.     $cordArray = $LatLonBox.Point.coordinates.split(",")  
  20.     $MapUrl = "" + $cordArray[1] + "," + $cordArray[0]  + "&zoom=18&size=600x800&markers=color:blue|label:S|" + $cordArray[1] + "," + $cordArray[0] + "&sensor=true"  
  21.     $rptObj.MapURL = $MapUrl   
  22.     $rptObj  
  23.     $rptCollection += $rptObj  
  24.     $title = "Show Map"  
  25.     $message = "Do you want Show the Map"     
  26.     $yes = New-Object System.Management.Automation.Host.ChoiceDescription "&Yes"  
  27.         $no = New-Object System.Management.Automation.Host.ChoiceDescription "&No"  
  28.         $options = [System.Management.Automation.Host.ChoiceDescription[]]($yes$no)  
  29.     $result = $host.ui.PromptForChoice($title$message$options, 0)   
  30.     if($result -eq 0){  
  31.         $form = new-object System.Windows.Forms.form   
  32.         $pbox = new-object System.Windows.Forms.PictureBox  
  33.         $pbox.Location = new-object System.Drawing.Size(0,0)  
  34.         $pbox.Size = new-object System.Drawing.Size(800,600)  
  35.         $pbox.ImageLocation = $MapUrl  
  36.         $form.Controls.Add($pbox)  
  37.         $form.size = new-object System.Drawing.Size(800,600)  
  38.         $form.Add_Shown({$form.Activate()})  
  39.         $form.ShowDialog()   
  40.     }  
  41. }  

Monday, April 09, 2012

EWS Managed API and Powershell How-To Series Part 7 Using the Configuration Information Operation

In the past couple of posts I've been looking at using the special operations in EWS that allow you to access the unconventional data in a mailbox such as OOF, FreeBusy etc. In this post I'm going to look at accessing the FAI (Folder Associated Items) userconfiguration Items. These are used to store a lot of the Meta-Information for various mailbox functions such as the Master Category list, Works hours, OWA Signature and various other configuration options. The best documentation for the options and formats that are used to store config information in FAI Items is the following Exchange Protocol Document

Before looking at EWS you should consider whether using the Exchange Management Shell maybe a better option, most of the configuration Setting can now be set using EMS cmdlet's such as eg OWA Signature(Get-MailboxMessageConfiguration), WorkHours(Get-MailboxCalendarConfiguration).

With UserConfiguration information that is stored on a FAI item the Item will have a special ItemClass and the config data itself is stored in one or more Mapi properties in either a custom XML format,Roaming Dictionary format or Binary format. Lets look at a few examples of dealing with the different formats for different config Items

Master Category List

The first one I'll cover is the Master category list which I've shown an example of before but the Master Category list is held in a FAI item in the Mailboxes Calendar Folder with a ItemClass of IPM.Configuration.CategoryList and the data for the catergory list is held in a Mapi property in a Custom XML format that is documented in the Exchange Protocol Document i linked above.

To Access the Master Category list which is useful if you need to show the color associated with a particular Keyword.

  1. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Calendar,$MailboxName)     
  2. #Specify the Calendar folder where the FAI Item is  
  3. $UsrConfig = [Microsoft.Exchange.WebServices.Data.UserConfiguration]::Bind($service"CategoryList"$folderid, [Microsoft.Exchange.WebServices.Data.UserConfigurationProperties]::All)  
  4. #Get the XML in String Format  
  5. $CatXML = [System.Text.Encoding]::UTF8.GetString($UsrConfig.XmlData)  
  6. #Deal with the first character being a Byte Order Mark  
  7. $boMark = $CatXML.SubString(0,1)  
  8. #Parse the XML  
  9. [XML]$CatXML = $CatXML.SubString(1)  
  10. $NewCat = $CatXML.categories.category  
If you want to add a new Category the easiest way to do this is to clone a existing category from the existing XML change the properties then append it to the Categorylist. Here's an example

  1. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Calendar,$MailboxName)     
  2. #Specify the Calendar folder where the FAI Item is  
  3. $UsrConfig = [Microsoft.Exchange.WebServices.Data.UserConfiguration]::Bind($service"CategoryList"$folderid, [Microsoft.Exchange.WebServices.Data.UserConfigurationProperties]::All)  
  4. #Get the XML in String Format  
  5. $CatXML = [System.Text.Encoding]::UTF8.GetString($UsrConfig.XmlData)  
  6. #Deal with the first character being a Byte Order Mark  
  7. $boMark = $CatXML.SubString(0,1)  
  8. #Parse the XML  
  9. [XML]$CatXML = $CatXML.SubString(1)  
  10. #Clone exiting Entry  
  11. $NewCat = $CatXML.categories.category[0].Clone()  
  12. #Set properties  
  13. $ = "My New Cat meow"  
  14. $NewCat.color = "10" #Steel Cat  
  15. $NewCat.keyboardShortcut = "0"  
  16. $NewCat.guid = "{" + [System.Guid]::NewGuid().ToString() + "}"  
  17. $NewCat.renameOnFirstUse = "0"  
  18. [Void]$CatXML.categories.AppendChild($NewCat)  
  19. $UsrConfig.XmlData = [System.Text.Encoding]::UTF8.GetBytes($boMark + $CatXML.OuterXml)  
  20. #Update Item  
  21. $UsrConfig.Update()  
OWA UserOptions

The most common form of data-format that is used for a configuration item is the Dictionary an example of this is the OWA.UserOptions FAI item that is held in the Root of the Mailbox. This contains the OWA configuration for the user including the OWA Signature. To show the settings that are currently held in the dictionary in this configuration Item we can use.

  1. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Root,$MailboxName)     
  2. #Specify the Root folder where the FAI Item is  
  3. $UsrConfig = [Microsoft.Exchange.WebServices.Data.UserConfiguration]::Bind($service"OWA.UserOptions"$folderid, [Microsoft.Exchange.WebServices.Data.UserConfigurationProperties]::All)  
  4. $UsrConfig.Dictionary  
If you wanted to set the OWA Signature for a user you would use something like this

  1. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Root,$MailboxName)     
  2. #Specify the Root folder where the FAI Item is  
  3. $UsrConfig = [Microsoft.Exchange.WebServices.Data.UserConfiguration]::Bind($service"OWA.UserOptions"$folderid, [Microsoft.Exchange.WebServices.Data.UserConfigurationProperties]::All)  
  4. $hsHtmlSigniture = "Im away use <a href=''></a>";  
  5. $stTextSig = "Get a HTML email editor it is 2012 you know";  
  6. if($UsrConfig.Dictionary.ContainsKey("signaturehtml")){  
  7.     $UsrConfig.Dictionary["signaturehtml"] = $hsHtmlSigniture  
  8. }  
  9. else{  
  10.     $UsrConfig.Dictionary.Add("signaturehtml",$hsHtmlSigniture)  
  11. }  
  12. if($UsrConfig.Dictionary.ContainsKey("signaturetext")){  
  13.     $UsrConfig.Dictionary["signaturetext"] = $stTextSig  
  14. }  
  15. else{  
  16.     $UsrConfig.Dictionary.Add("signaturetext",$stTextSig)  
  17. }  
  18. $UsrConfig.Update()  
Message Records Management

The MRM Tag configuration for a mailbox is also held within a FAI item (you shouldn't be modifying this setting via EWS) but it is useful if you are creating a script that is going to be stamping these tags on Folders or Items to be able to retrieve them via EWS. This is a sample of getting the MRM Policy and Archive Tags from the FAI items that is held in the Inbox

  1. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$MailboxName)     
  2. #Specify the Inbox folder where the FAI Item is  
  3. $UsrConfig = [Microsoft.Exchange.WebServices.Data.UserConfiguration]::Bind($service"MRM"$folderid, [Microsoft.Exchange.WebServices.Data.UserConfigurationProperties]::All)  
  4. $ConfXML = [System.Text.Encoding]::UTF8.GetString($UsrConfig.XmlData)    
  5. [XML]$ConfXML = $ConfXML    
  6. $ConfXML.UserConfiguration.Info.Data.PolicyTag  
  7. $ConfXML.UserConfiguration.Info.Data.ArchiveTag  
If you love working with Binary data than there is a lot more that can be done on the customization side using this operation to modify View Definitions etc these are very targeted configurations though and can be time consuming so I'm not going to cover those for now.