How to Install and Configure TFS OData

The OData (Open Data Protocol) is a web layer that can get or update data from a specific system, in our case TFS.

Since the OData is a web layer it provides the possibility to develop TFS clients on any system that use HTTP/S protocols. Currently, Microsoft declares that it's only in a beta stage, but they also provide the source code, so you can add/change any function you desire.

The current post will guide you through the stages of how to install TFS OData.

The machine that will host the TFS OData need to have an HTTP/S open network to the production TFS server.

So, lets start with the TFS OData download from:
http://www.microsoft.com/en-us/download/details.aspx?id=36230 (google for: download tfs odata)

Now, you'll have two options:

The first option "ODataForTFS.V....." is the OData layer with it's source code, the second option "TFSDashboard..." is a sample application that you  might look into (you also have a lot of demo applications in codeplex.com).

After downloading the first package, Double click it. you will have a dialog box that will ask you where do you want to extract all the source code.

In order to deploy the OData on the machine you have two options:
1. Deploy the application manually on the IIS (map the default web site to <extract location>\ODataForTFSV2\code\ODataTFS.Web)
2. Open ODataTFS.sln with visual studio and it will be deployed locally automatically
At this point you should see introduction document at http://localhost.

the next steps will show you how to configure TFS OData to communicate with the production TFS. All configuration should be made at the web.config (<extract location>\ODataForTFSV2\code\ODataTFS.Web\Web.config).

1. Change the address of TFS production server

2. If you are using HTTP (NOT HTTPS) protocol to your TFS production server, you will need to change the binding to non-secure traffic, change the security mode from "Transport" to "None".

In order to check your installtion & configuration, open a browser and write the address:
http://<OData host machine>/<Project Collection>/<OData operation>
for example: http://tfsodata/defaultcollection/builds

you should see something like:

That's it. Now you can develop your application over this layer!

No comments:

Post a Comment