Corey Roth [MVP]

At Tulsa TechFest, I gave a talk about the various new ECM features available out of the box in SharePoint 2010.  One feature of particular interest to the crowd was average ratings.  I had lots of questions on it so I thought it was worth a blog post.  Instead of describing it first, let’s start with a picture.

As you can see in the above picture, ratings are a new field available which gives users the ability to rate each document using stars just like they might do in iTunes or any other application.  Behind the scenes, it takes the ratings of each user and a timer job comes along periodically and calculates the average rating.  This allows users to quickly determine which documents are the most popular when viewing a document library.  You can also sort on this field as well.  It’s easy to add to both your document libraries and content types.

In reality, Ratings are nothing more than a site column, but SharePoint 2010 makes it really easy to add them to an existing document library.  Just click on Library Settings in the ribbon and then Ratings settings. 

One you do that, two new site columns are added to your document library, Rating (0-5) and Number of Ratings.  The Rating (0-5) site column, named AverageRating internally, is the column users interact with.  Users can’t edit the Number of Ratings column, named RatingCount internally.  The timer job just uses it to help calculate the average.

At this point, your users can start rating documents.  It’s that simple.   When you view the properties on a document, you will see the average rating and the number of ratings as well.

In reality, you can actually just add the above two site columns to any list or content type and have ratings work.  I have actually started including these in my base content type on most ECM deployments.  This is a content type that I use in lieu of the Document content type which has additional site columns.  All other content types I create will inherit from this one.  It adds great functionality to every content type that inherits from it.  If some people don’t like the ratings on their documents, they can always just remove it from the view on his or her document library. 

To add the columns to a content type, just click the Add from existing site columns link on your content type page.  You will find the two columns listed in the Ratings Group.  You will want to add both of them to your content type.

When you add one of these columns, you will get a warning stating that some earlier versions of Office cannot use these fields.  If you are using Office 2007 or earlier, you may want to test this out some to see if it will be an issue in your organization.

Once you click OK, your content type is ready for use.  Now, I would be a bad blogger if I didn’t show you how to add these fields using CAML.  If you want to add these two fields to a content type, just add the following elements to the FieldRefs element.

Since these fields are included out-of-the-box, I believe those GUIDs should always be the same.  If I’m wrong, someone let me know.  You can also add these fields to document libraries as well.  Just add the following Field elements to the Fields element in your schema.xml.

Try out document ratings today.  They provide a lot of functionality and are quite easy to implement.