Access Microsoft Planner Data with Entity Framework 6

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Microsoft Planner ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Microsoft Planner.



This article shows how to access Microsoft Planner data using an Entity Framework code-first approach. Entity Framework 6 is available in .NET 4.5 and above.

Entity Framework is an object-relational mapping framework that can be used to work with data as objects. While you can run the ADO.NET Entity Data Model wizard in Visual Studio to handle generating the Entity Model, this approach, the model-first approach, can put you at a disadvantage if there are changes in your data source or if you want more control over how the entities operate. In this article you will complete the code-first approach to accessing Microsoft Planner data using the CData ADO.NET Provider.

  1. Open Visual Studio and create a new Windows Form Application. This article uses a C# project with .NET 4.5.
  2. Run the command 'Install-Package EntityFramework' in the Package Manger Console in Visual Studio to install the latest release of Entity Framework.
  3. Modify the App.config file in the project to add a reference to the Microsoft Planner Entity Framework 6 assembly and the connection string.

    You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
    • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

    When you connect the Driver opens the MS Planner OAuth endpoint in your default browser. Log in and grant permissions to the Driver. The Driver then completes the OAuth process.

    1. Extracts the access token from the callback URL and authenticates requests.
    2. Obtains a new access token when the old one expires.
    3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
    <configuration> ... <connectionStrings> <add name="MicrosoftPlannerContext" connectionString="Offline=False;OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH" providerName="System.Data.CData.MicrosoftPlanner" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.MicrosoftPlanner" type="System.Data.CData.MicrosoftPlanner.MicrosoftPlannerProviderServices, System.Data.CData.MicrosoftPlanner.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
  4. Add a reference to System.Data.CData.MicrosoftPlanner.Entities.EF6.dll, located in the lib -> 4.0 subfolder in the installation directory.
  5. Build the project at this point to ensure everything is working correctly. Once that's done, you can start coding using Entity Framework.
  6. Add a new .cs file to the project and add a class to it. This will be your database context, and it will extend the DbContext class. In the example, this class is named MicrosoftPlannerContext. The following code example overrides the OnModelCreating method to make the following changes:
    • Remove PluralizingTableNameConvention from the ModelBuilder Conventions.
    • Remove requests to the MigrationHistory table.
    using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class MicrosoftPlannerContext : DbContext { public MicrosoftPlannerContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<MicrosoftPlannerContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
  7. Create another .cs file and name it after the Microsoft Planner entity you are retrieving, for example, Tasks. In this file, define both the Entity and the Entity Configuration, which will resemble the example below: using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; [System.ComponentModel.DataAnnotations.Schema.Table("Tasks")] public class Tasks { [System.ComponentModel.DataAnnotations.Key] public System.String TaskId { get; set; } public System.String startDateTime { get; set; } }
  8. Now that you have created an entity, add the entity to your context class: public DbSet<Tasks> Tasks { set; get; }
  9. With the context and entity finished, you are now ready to query the data in a separate class. For example: MicrosoftPlannerContext context = new MicrosoftPlannerContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Tasks select line;