David Wise's Sharepoint blog

I have worked in numerous programming languages and the one thing that I find most irritating is that every language feels the need to reinvent Nothing – literally – and then applies their own rules to it.

In VB, Nothing is Nothing.  In C# and JavaScript, Nothing is null.  Ruby's Nothing is nil.  Nothing can also be Null or Empty or undefined, although it can sometimes be NaN, which is not necessarily Empty or Null.  Something that is undefined is sometimes null and sometimes not but something that is null is rarely undefined.

Throw in the mix how badly empty strings are handled where "" is not Empty or null, but is an EmptyString and could be NaN.  It could also be a NullString, which is still not a null or even a Null and certainly not an Empty or undefined.

Nothing/Null/null/nul/nil is a basic part of any programming language.  Is there any chance that we could pick one term, like Null (or null even), and use it across languages?

It's just a word, what is the big deal?  The word itself is trivial but the need to use a new term for something so basic is the root of my aggravation.  Each language feels that they have to use their own terms to be "cool", yet are just rebranding well established concepts without adding functionality.  That isn't innovation, that's marketing.  It's "New and Improved" without being either.

All it accomplishes is that it adds one more tiny step in the learning curve for that language and slows adoption.  Further, assuming that the "cool" factor won out in other areas, then there will be hundreds of other such tiny steps as well, all without any added benefit.

Tell you what, I'm going to create my own programming language called Presidents.Net, where all of my core data types are named after past Presidents.

private Jefferson ProcessRequest(Washington pRefID, Jackson pAmount)
{
   Lincoln User = getUserID(pRefID);
   Eisenhower AccountNumber = getAccount(User);
   …
   return applyTransaction(AccountNumber, pAmount);
}

What is the value added?  Nil, or … null … or … Polk.

They have stories from the dawn of computing, about the problems with tape backup, data layouts using bitmasking to save single bytes wherever possible and can regale you with tales of horror about the era of punchcards.  While they can expound for hours on middling details of tech found only in museums, they are surprisingly quiet on the merits of any recent technologies.  One could say that their value is historical but I think they serve a far greater purpose.

They are warning posts, put in place to remind you about the perils of complacency.  About what will happen to you if you let your skills lapse or get too comfortable with any one particular technology.  This field moves too fast and they are glimpses into your own future if you stop moving with it.

Talk with them.  Listen to them.  Consider them the career equivalent of a car wreck.  They hit the brick wall so you don't have to.

The other day, I found myself in need of a way to access SharePoint list data as XML but the only method available to me was a simple http GET.  This is not too bad, but what can I get from SharePoint via GET?  RSS is too limited and scraping the page is too painful and error-prone to even contemplate. 

It turns out that there is an option available in 2007 that was carried forward from SharePoint 2003 / FrontPage days: owssvr.dll.  But this isn't some forgotten FrontPage artifact, it is still a central part of SharePoint.  In fact, if you pull up a list view and then view the source looking for owssvr.dll, you will see that this is the mechanism behind both the Export to Spreadsheet and Open with Access options on the list Actions menu.

How It Works

Simply put together a URL like this:

http://MyServer/[site]/_vti_bin/owssvr.dll?Cmd=Display&List={listGuid}&XMLDATA=TRUE

This will only return the fields that are defined on the default view of the list.  If you need specific fields then you need to create a view with those fields and pass the View ID as well, like this:

http://…/owssvr.dll?Cmd=Display&List={listGuid}&view={viewGuid}&XMLDATA=TRUE

Specifying Fields to be Returned

There is also a Query parameter that lets you specify which fields are to be included in the resulting XML, regardless of how the view is defined.  For example, if you wanted just to bring back the Title and Status Fields, you would add the field names separated by spaces (URL Encoded, of course) like "&Query=Title%20Status".  If you want to return all fields, use an asterisk (*) instead of field names.

http://…/owssvr.dll?Cmd=Display&List={listGuid}&query=Title%20Status&XMLDATA=TRUE

Filtering Data

Regardless of whether you pass a view or use the default it will still use the filter defined by that view.  Not bad, but you can trim this data even more by including a filter of your own using the FilterFieldn and FilterValuen arguments in the querystring.  These are the same values that are passed when you use the filter options in the column headers of a view which makes it pretty easy to track down exactly what needs to be passed.  Simply pull up the view that is your starting point and use the column filters to create your desired filter.  Once you have it, grab all of the FilterField and FilterValue items from the querystring and add them on to yours.

http://…/owssvr.dll?Cmd=Display&List={listGuid}&query=Title%20Status&XMLDATA=TRUE&FilterField1=Status&FilterValue1=In%20Progress

For a full list of what can be done with this technique, check out the URL Protocol or the older Using the URL Protocol on MSDN.

I've spent the better part of two days tracking down an extremely nasty bug in InfoPath that corrupts an InfoPath form completely and almost terminally after connecting to a WCF (Windows Communication Foundation) web service.  Each time you try to open the form in design mode, InfoPath kicks out the error below and then refuses to open the form.

"InfoPath cannot open the following form: C:longpath oform.xsn.  The XML Schema file specified in the form definition (.xsf) file for dataObject 'xyz' cannot be used"

Once this happens, there is no way to get InfoPath to edit the form again.  However, there is a fix.

The Fix – Recovering your work

First, we have to get you so you can edit your form again.  Since the actual error hides itself completely during the initial design session it is possible to lose a lot of work, depending on how much you worked on the form during the session where you connected it to the web service.  Either way, you have to fix both problems in order to get the form working properly anyway.

1. Create a new folder and copy your "corrupt" .XSN file to that folder. 
2. Rename it from .XSN to .CAB (Yes, .XSN is really just a .CAB)
3. Use a compression utility that can read CAB files (like WinZIP) to unpack the contents of the file into that folder. 
4. Open the Manifest.xsf file in a text editor (NOT in InfoPath) and look for "<xsf:dataObjects>"  under that node, you will see several <xsf:dataObject> nodes. 
5. Delete all <xsf:dataObject> nodes that point to WCF web services.  You can spot these easily because they usually have ".svc" somewhere in the wsdlUrl attribute of the <xsf:webServiceAdapter…> child node.
6. Save the Manifest.xsf file. 
7. Now right-click on the manifest.xsf and select 'Design'.  This should open InfoPath and will give you a warning that the form has been moved.
8. Click ok. At this point, the form should open in design properly.  You should also see "[Read-Only]" in the title bar.
9. Go through all views in your form and disconnect any controls that were bound to the WCF data sources.  Sometimes this is as simple as converting them from whatever type they are to text boxes.
10. Click File -> Save As and save the file to the folder where you want the file to reside.  This will automatically save it as an .XSN file again.
11. Close InfoPath (very important- don't just close the form)
12. Browse to the the new folder and find the new .XSN file
13. Right-click on it and select 'Design'.
14. Click 'Preview' to preview the form.  If you get the error "InfoPath cannot open the selected form", it means that one of your controls is still bound to one of the data sources you removed earlier.  Check your controls again and also check any Rules you may have defined under Tools -> Form Options -> Open and Save -> Open behavior.

At this point, you should now be back editing your form as normal, just without the web service data.  Warning: do NOT reconnect to the web service until the next part of the fix is completed.  Doing so immediately lands you back at step 1!

The Fix – Fixing the Web Service

This will require the help of the author of the web service who will probably deny that there is an error and try to blame InfoPath because it works in all of his loosely typed test applications.  You must convince them that the problem really is with the way the service is defined.  Perhaps this entry will help, perhaps not.  Either way, he will have to do something with his web service if he wants that data exposed in your form because it won't work as it is right now.  I was lucky that the developer of the web service was every bit as curious about this error as I was so we were able to troubleshoot this from both ends.

The root of the problem is that one or more of the underlying data types is defined with an improper Namespace in the [DataContract] attribute or one that doesn't match all of the others.  InfoPath is extremely particular and if the namespaces don't match precisely, it will cause the error mentioned at the start of the article.  It is case-sensitive.

To track down exactly where the problem lies involves a little bit of detective work and some of the files extracted from Step 3.  When you created the Data Connection to the web service call in InfoPath you gave it a name like 'GetSomeDataFromJoe'.  If you look in the folder from Step 3, you should see 4 or 5 files called GetSomeDataFromJoeXX.xsd where XX is a number between 1 and 99.  These are the actual schema files that InfoPath pulled down when you connected to the web service.  Send these to the developer.  If he looks through them, he will find one (usually the second in the series) that shows the data types found in the web service.  One or more of the types he is using should be missing completely from the XSD files which means that those are the ones with the broken namespace.

After fixing this, the developer will need to build and then publish the web service before you can attempt to connect to it again.

Putting it All Back Together

Now that the developer has assured you that the fix has been made you will need to reconnect to the web service. To reconnect safely, try it this way:

1. Backup your current working form (.xsn) from the first part of the fix – just in case the developer hasn't gotten the fix quite right yet.
2. Open the form for design in InfoPath
3. Reconnect to the web services
4. Save the form and close InfoPath
5. Reopen the form in InfoPath. 
6. Switch to Design mode.
7. If it opens properly then the developer cleaned up his namespaces and it is safe to reconnect your controls to the web service data.
8. If you still get the "… XML Schema file … cannot be used" error, then the problem is still in the web service.  Delete the .XSN (because it is now corrupted again) and restore it from your backup.  If you jumped ahead and reconnected without backing up, then you get to do this whole thing all over again starting with Step 1 under "Recovering Your Work". 

Behind the Scenes (IMO)

The reason for the error is because of the way that InfoPath pulls the schema for a WCF web service.  When it connects and pulls down the schema info from the WSDL, it also pulls down all of the schemas for the data types used in the service.  In this case, the namespace of one of those schemas didn't match precisely so it couldn't be found later on, which is logical and expected behavior. However, InfoPath itself ignores that error during the session in which you originally connect to the web service.  It is not until you close InfoPath and then go back in that you get bitten by it.  What would be nice is if InfoPath kicked out the error when you connected to the service rather than laying a trap for you later on.

The truly curious part of all of this is that despite having an invalid schema, you can still open the "corrupt" .xsn file for data entry in InfoPath and it works perfectly.  One would think that something as substantial as a broken schema would kill the form no matter what.

I was challenged recently.  It was claimed that there was no way to get usage data out of SharePoint beyond the normal SiteActions -> Site Usage Reports page, which isn't terribly useful if you need actual numbers.

Sure, that page includes some nice graphs and some of the data that is available and it saves the typical user from having to create a common bunch of graphs by hand and even has an option to export the data to Excel.  The problem is the data being exported does not include actual hit data, but averages over the last 30 days.  If you need more detailed information than that, it is not readily available from this summary page.  Which was where the challenge began.

Simple Usage Reports – Just the facts!

SharePoint 2003 had a hidden usage page at /_layouts/1033/usagedetails.aspx and that had decent data.  The good news is that this is still hidden in 2007 but has been moved just slightly to /_layouts/usagedetails.aspx (it redirects automatically).  It has detailed data for Page, User, OS, Browser and Referrer and can slice the data into a Monthly Summary or a Daily Summary.

The bad news is that this data cannot be directly exported in any form – but it does copy-paste very nicely into Excel so it is situationally useful.  However, most people really don't want to be doing this manually all the time.

Technically, I had beaten the challenge there, but my programmer instincts kicked in because I kept thinking: "There has to be a better way!" So I kept looking and found a bunch more.

Getting the data remotely

The same data shown above is also available via http GET using the owssvr.dll, as shown below.  To get the last 30 days, change the BlobType parameter to "Old"

http://[server]/[Site}/_vti_bin/owssvr.dll?Cmd=GetUsageBlob&BlobType=Current

Ah, but there is a catch.  The data it returns is a BLOB (Binary Large OBject) and your browser doesn't know what to do with it.  Fortunately, there is a BlobParser (Download) available from Microsoft that can split this data out.  Catch #2 is that this parser is a C++ Windows application and most of us are in a C#/VB.Net web-based world.  The textbox that this app uses to output the parsed data is also Excel-friendly so that data can be copy-pasted here as well.  Useful, but still not quite what I was looking for.

If you are interested in pursuing this, the format of the blob data is available on MSDN for C++.  Yeah, you'll have to convert it manually to whatever language you are using.

Using the SharePoint object Model

SPSite.UsageInfo [link] – top level stats but nothing like what a typical stat request requires

In order to get actual stats, you need to go to the SPWeb for each site you want info on and call GetUsageData(), passing the proper parameters for the data desired.  Pretty simple and this returns the same data as the BLOB above only in a more useful form, a DataTable.  From here, you can do whatever you want with it.  Export it, save it to disk, stream it to the browser, toss it in a database, etc..  You get the idea.  (Very Important – remember to .Dispose() of your objects!)

Of course, this means deploying code onto your servers, but you are getting pretty good at that by now, aren't you?

.Net version is here and here –

[[ is there a web service? ]]

[[ Direct SQL ]] – include normal caveat from MS: don't hit the DB directly cuz it might change in a service pack … blah blah blah

So, the next time you hear someone say that there is no way to get usage data out of SharePoint, you can tell the right where to go!   (Here, I mean.  What were YOU thinking?)

I just ran across this article on MSDN that is a fantastic read.  If you do any work where you manipulate SharePoint objects via code, especially SPSite and SPWeb then you must read this.  The article is outlines many of the gotcha's lurking in the object model that you may not be aware of.  There is also another article that touches on object disposal as well but lists a few other areas to watch for.

If you are seeing performance, memory and stability issues in a SharePoint server that is running custom code then that code should be probably be reviewed while the above articles are fresh in mind.

I'm trying to open a local copy of an InfoPath form that was originally opened from SharePoint.  The actual .xsn file that I've been working with is on my local file system and that is where I'm opening it from.  However, when I open it, I get the dialog below:

Ok…. so … I know the template on my local machine is the one I want to open and I know that it is different than what is in SharePoint, so I naively click on the "Keep Form Template on Your Computer" button, thinking that it will, you know, keep the one that is on my computer rather than the one in SharePoint.  Silly me.  That option actually opens the original template from SharePoint, which is a "replace" of my local copy in my way of thinking of things.

Now, I realize that a very careful reading of the actual message (which nobody actually does until after the fact) will somewhat point you to the right answer, but having to click "Replace…" in order to keep local changes and "Keep…" to replace local changes is just a little bit counter-intuitive. Maybe a "use this one" button under each option might have been clearer?  Just a thought…

Microsoft has finally released the much awaited Service Pack 1 for SharePoint.  Unfortunately, not all of the links provided on the Microsoft download pages seem to go to the right places.  Here are the actual links that I've found.

SharePoint Service Pack 1 Resource Center

Planning and Deployment Guide (Word Document)

Windows SharePoint Services 3.0 SP1 – Download / List of Fixes / Excel

Microsoft 2007 Office Servers (includes MOSS) SP1 – Download / List of Fixes / Excel

SharePoint Designer SP1 – Download / List of Fixes / Excel (includes Office 2007 SP1)

Revised SP1 SDK for WSS / MOSS / AJAX in SharePoint

System Center Operations Manager 2007 Packs – Announcement / Download

The Excel versions of the fixes are far more useful as they include the actual problem fixed rather than links to hotfixes that you have to sift through.

Update: Fixed the Excel links as Microsoft changed all of them overnight.  They also split out the changes for WSS from the main Excel file for Office Servers.

The intent is for this to be one of those links that you send to your family when they ask: "What is RSS? Why would I care about such a thing?". If you are already familiar enough with RSS to know what it means, then this article is not for you. Move along.  Nothing new to see here. You can go about your business.  These are not the droids you are looking for.

Good, now that they're gone, lets get down to business.

Why do I care about RSS?

Definitions can wait; this is the meat of it. RSS is basically a way to get the news you want from the sources you want in the format you want, when you want it. Think of it as your own personalized Associated Press service. There is even a little bit of dark pleasure involved as you are the editor in this whole process and you can "fire" sources you dislike by unsubscribing to their feed (explained later). Don't lie, I'm sure there are a few columnists in your local paper you'd like to fire and with RSS, you can!

Much more than news

It is true that the most common use for RSS is news feeds, but it can be used for anything that might be of interest to other people. Some sites use it for press releases, some for bug reports, some for articles of interest, others are just for fun and, of course, there are some focused on the latest and greatest deals.

Best of all, you can include sources that most newspapers can't or won't use. Opinions, technical journals, Alumnus organizations, hobbies, etc. Almost anything that you have an interest in has an RSS feed available somewhere for it.

Ok, got it. Now what is it?

RSS stands for Really Simple Syndication and it simply is an agreed upon way for web sites to make anything of interest available to anyone that might be interested in it. These items are available in things called "feeds" that are nothing more than a bunch of news items grouped together.

Think of a feed as something like a newspaper. You "subscribe" to your daily paper, and you "subscribe" to a feed. There's just no messy ink to smear or double-collecting paperboys to deal with. The difference is that a newspaper is actually what is known as an "aggregate feed" meaning that it is a bunch of different topics (news, politics, sports, entertainment) all bundled into one big paper. If all you read is sports, then the rest of the paper just gets in your way. Likewise, on a properly designed site, you can get an aggregate feed of everything, or you can subscribe to just the sports. Try telling your local paper to only deliver the sports section and see what response you get!

FoxNews and CNN are both good examples of this. You can subscribe to only what you are interested in and ignore the rest. Yes, that means you can almost completely filter Britney Spears out of your news.

Hopefully, I have your attention about why you should be interested in RSS. The next steps are the mechanics of actually setting yourself set up to be able to read feeds.

How do I get a started?

First off, you need some software called a reader (a.k.a. Feed Reader, RSS Reader). This software is available in two formats: online and desktop application. The largest online reader is Google Reader and it happens to be free. The interface is a little strange, but it works for a lot of people.

There are several free desktop reader applications out there as well, such as FeedReader and SharpReader, but I strongly recommend Omea because it has plenty of features to grow with. Technically, Internet Explorer 7 has a reader built into it as well, but it is so limited that you will probably outgrow it in the next 10 minutes.

The next thing you need is a feed to subscribe to. Think about your interests; What sites do you visit regularly? Where do you get your news from? Go to some of those sites and look for one of the RSS feed icons (  ). Some sites hide the feed link in text in footers and you have to actually search for "RSS", "XML", "feed" or "subscribe" in the page to find the link for it. Annoying, but if it is a site you like, it's worth hunting for.

Clicking on the link or the icon should bring up a page that only has the news items in it, usually with no advertising or even site identification. In some cases, you will bring up a page that almost looks like computer code. Don't worry, this is the actual feed that the reader uses but you won't have to see it in this form again. In other cases, the link is actually a list of feeds available, in which case, click on one of the feeds that interest you. Now go to the address bar of your browser and copy the URL. You will need this in order to tell your reader what to subscribe to.

Next, you need to actually subscribe to the feed. The term subscribe is a bit of a misnomer here in that you don't really subscribe to anything in the traditional sense as that implies that you are having something delivered. Instead, you are telling your reader to keep checking this feed and to let you know when it changes. You don't have to provide any personal information or any money to subscribe, not even your email address. The feed you are subscribed to has almost no information about you.

The actual mechanics of subscribing depend on the reader you have chosen to use, but they all have an option called something like "Add Subscription", "Add feed" or "new feed" or even simply "subscribe", usually found on the File menu. Click that and paste in the URL you copied earlier, accept any defaults listed for the other options and click OK. Don't worry about those other options for now, they aren't too important and the defaults are usually good enough for most people.

Your reader should now load the feed from the site and give you a list of news items from that site that you can pick and choose from to read. This is great, but you don't get much benefit from one feed! Go find more! Be sure to look for RSS feed options on all of the sites that you visit regularly. Subscribe to anything that interests you – you can always unsubscribe later.

Here is where it gets fun: as long as your reader is open, it will periodically check your feeds and update with the latest articles. Depending on the reader, it might also put a little popup on the screen with the latest news or play a little sound. All automatically. You no longer have to try to remember all the sites you were interested in or keep track of changes or anything. If it is new, it will be in your reader waiting for you. If you close your reader, it will simply look for new items the next time you open it.

I WANT MORE CONTROL!!!

Ok, ok, sheesh. All you "Type A" people out there. Fine, you want control? You’ve got it! Remember those options I told you not to worry about when you subscribed to the feed? Take another look at them (in most readers, right-click on the feed and click on "properties"). The main one that most people change is the update frequency. Most feeds are ok with the default, which is usually 8 hours, but some feeds (like FoxNews and CNN) update very regularly. Change that value to 1 hour to get frequent updates and satisfy your inner news junkie. Odds are that you can also rename the feed to something more meaningful than the default name of the feed. Some readers offer dozens of properties that you can fiddle with.

Ok, you got me hooked but what if I want to change readers?

Ah, but you don't want to lose all those feeds you set up, right? Fear not! Nearly every reader on the planet has an Import and Export feature that supports OPML. What is OPML? You don't really care, other than to know it is an agreed upon way of listing all the feeds you have subscribed to. You Export your feeds as OPML from your current reader. Then Import it into your new one. Voila! You might have to go mark everything as read again because the new reader doesn't know where you left off reading, but that's about it.

What reader do you use, personally?

Omea. I find it easy enough to get started with and it has plenty of features so that when I find myself thinking: "If only I could…", odds are good that Omea already supports whatever I had in mind. It was just in there waiting for me to realize I needed that feature With the 158 feeds that I watch, I end up needing a lot of features that I hadn't imagined needing when I first started using RSS.

And, in conclusion…

Hopefully, that is enough to get you into the exciting world of information via RSS. Once you start using it, you will have a hard time going back to reading sites to get your news or even (gasp) picking up a printed paper with its "ancient" 12 hour old news

There is a multitude of blogs that discuss how to access SharePoint data from SQL Reporting Services, so why another?  Simply because I had not found one that exposed all of the land mines I seem to hit when doing this.  So, I thought I'd try my hand at creating a detailed guide-map to the mine field.

The Requirements

In order to do this, you must have :

• Visual Studio 2005 (I'm sure this works in 2008 as well, but I haven't tried it yet)
• SQL Reporting Extensions.  These are installed by default when you install SQL Server
• A SharePoint list exposed Anonymously or via Windows Integrated Authentication (more below)

Accessing the List

The Report Designer requires that the Data Source either require no authentication or uses Windows Integrated authentication.  Other options are available when defining the Data Source but you will not be able to use them as they are not supported for web services by the designer.

Note: If your SharePoint list requires Windows Authentication then your development machine *must* be in the same domain or a trusted domain as the SharePoint server.  If you are developing on a system that is not in the domain of the SharePoint list you are attempting to access, you will not be able to proceed.  Brutal, but there you have it.

The Steps

Start Visual Studio

Select File -> New Project -> Business Intelligence Projects -> Report Server Project.  Name and save the project.

In Solution explorer, right-click on Shared Data Sources and select Add New Data Source

Make sure you specify the Type as XML and put the proper URL to your server's list.asmx web service page.  This is usually simply http://<server>/<path>/_vti_bin/lists.asmx, replacing <server> with your server name and <path> with the path to the site with the list you are trying to access.

Click the Credentials tab and make sure you set it to Windows Authentication (default) or No Credentials (if your SharePoint site allows anonymous access). 

<Query>    <Method Namespace=http://schemas.microsoft.com/sharepoint/soap/             Name="GetListItems"/>    <SoapAction>http://schemas.microsoft.com/sharepoint/soap/GetListItems</SoapAction></Query>

From there, click on the Parameters tab enter your parameters.  See the Parameters section below for more information.

Parameters

There are 5 parameters that can be passed: listName, viewName, query, rowLimit and queryOptions and yes, they must be this exact case.  The catch here is that if you define all those parameters you will get data in the Data view, but then the Preview will fail with a multitude of messages, usually along the lines of "The Value expression for the parameter … contains an error … ".  To get around this, define only the parameters you are actually passing values for. 

listName

This tells the web service where to get the data from and it is the only required parameter.  You can give it either a list name or a Guid.  If you are unsure how to get the Guid, fire up Stramit CAML Viewer and browse to the list or simply click Settings->List Settings while viewing the list.  The list Guid will be URL encoded in the querystring after 'List=".  You can quickly decode it here.

viewName

The viewName tells the web service what view of listName to query in order to pull back data.  This is not required but strongly recommended because the Report Designer mangles the query parameter with severely limits your options for filtering data from the designer side of this process.  This is also an extremely picky parameter and I have yet to be able to get it to work consistently with a actual name of a view and have had to always use a Guid.

Note: If you do not specify a viewName, it will use whatever view is defined as the default for the list as the filter/sort for the data.  This is usually the All Items view and will likely include way more data than you want.

query

Do not use this parameter.  It is extremely useful for people calling the web service from code but does not work with the report designer.  I suspect that designer does some extra encoding of the CAML that this parameter normally accepts which confuses the web service to no end.  If someone finds a way to actually use this parameter from designer, please let me know!

rowLimit

The number of items to return.  SharePoint defaults to 100 so if you need more than this, you will need to include this parameter along with a number exceeding the number of rows you are likely to get.

queryOptions

Do not use this parameter for the same reason as query: it gets improperly encoded by the report designer.

Click OK and then try to get your list of fields by clicking the Refresh Fields icon ( ) in the data view.  A small + should appear next to your report name.  Click on that to see all the fields it found.  If you don't see all the fields you were expecting, be sure to read the tip in the Annoyances section at the end of this posting.

Last step – get some data by clicking the Run icon ( ) on the Data tab.  It should pop up a dialog with the parameters you defined earlier.  Make sure all the parameters and values are there that you expect and click OK.

That's pretty much it.  I do have some general thoughts on the whole process that I've tacked on below.  Hopefully, this covers most of the quirks and oddities associated with this process.

General Troubleshooting

I cannot recommend Fiddler highly enough.  With this running on the dev machine you can easily see everything that is going on in the actual SOAP calls that are responsible for those vague errors that the designer throws out.  (click to see details)

Guid's versus Names

Ok, so do I reference the list using the Guid or name?  There isn't an easy answer here as this is the classic catch 22.  The Guid is the ID of the item regardless of the name and is the natural thing for developers to want to use.  Unfortunately, if you are in an environment where code is migrated from a Dev farm through test/qa and then to Production, that Guid will change in each environment.  The Name is much friendlier and works across environments, but names have a tendency to change over time which will break your report.  Choose what works best in your environment.

A Word About Formatting

SQL Reports has no clue what to do with many of the columns used in SharePoint, so you might end up having to write some code to handle these.  The first you will probably see of this are the SharePoint fields that contain lookup values because these will show up on your report as something like "245#;My real name".  Pretty nasty.

What you can do is add the snippet of code below to the Code section of the report.  To get there choose the Layout view, then Click on Report -> Report Properties from the main menu.  Click on the Code tab and paste the code below in the window

function GetNameFromSP(pFullID as string) as string
  dim strRet as string
  dim iPos as integer

  if pFullID = nothing then return ""
  if pFullID = "" then return ""
  iPos = Instr(pFullID, ";")
  if iPos < 1 then return pFullID

  return Mid(pFullID, iPos +2)
end function

Then right-click on the field in the report that you want to fix this with and select Expression.  In the Expression Builder window, set it to the following:

=Code.GetNameFromSP(<your field reference>)

It is possible to use a .Net assembly for this function as well, but that is way beyond the scope of this article.  Besides, this method doesn't require any special installation steps on the target server.  If you are creating dozens of reports where you need this behavior or others like it, then it makes sense to look into the assembly approach.

A Word About Sorting

Odds are that the second place that you will hit the formatting snag mentioned above is when attempting to sort the report by one of the fields containing such values as it will sort by the ID part of the value string and not the name.  The easy fix is to use the same Expression as above in the Sorting and Grouping section of the report, which now allows you to sort on the real name.

Annoyances About the Report Designer in Visual Studio

Overall, working with the Report Designer in Visual Studio goes pretty good, but there are some soggy areas that you are bound to step in eventually.  I'm pretty sure these are related to working with either web services in general as a data source, or SharePoint web services specifically as I'm not seeing a lot of people reporting this problem over the net.

Vanishing Parameters

For reasons known only to designer itself, it will occasionally completely delete your list of parameters.  If you suddenly start getting errors or the wrong data and haven't changed anything substantial, make sure your parameters are still defined.  Just make sure you have them written down somewhere where you can refer to them in order to enter them again.  I guarantee you will hit this one at least once.

Erroneous Errors

Sometimes something gets stuck in memory and designer will keep throwing an error when you try to get data or preview what should be a good data call.  Nine times out of ten, just closing the report and re-opening it will take care of this.  It's very easy to lose an hour or more chasing a problem that isn't really there from this.

Now you have data, Now you don't

Fetching the data / previewing the report will work occasionally fail one attempt, then work perfectly the next with *no* changes in between.  This is a minor irritation and can usually be fixed by closing and re-opening the report.  After a while, you get used to trying everything twice.  If it fails on the second attempt, you probably really have an error.

Missing Columns

When you build the list of columns available for the report in Designer, it takes only the data in the first row of data returned.  If any of those columns are null, it won't include the column.  Make sure all the vital columns have data when you create the report and you should be fine, even if that means manually editing them for a short time to put temporary data in.  Update: Maria has offered a solution to this.  I'm not able to try it at this moment but it looks promising – thanks Maria!

Note: if you know of fixes to any of the above, please, please post it in the comments!

Some Helpful Links

• Accessing SharePoint List Items with SQL Server 2005 Reporting Services very good checklist approach to this topic
• How to: Publish a Report to a SharePoint Library from Report Designer
• Fiddler – Good for snooping on web service requests to find the root causes of those errors
• Stramit CAML viewer
• Reporting Services: Using XML and Web Service Data Sources