How to Access Adobe Target Data Using Entity Framework

Microsoft Entity Framework serves as an object-relational mapping framework for working with data represented as objects. Although Visual Studio offers the ADO.NET Entity Data Model wizard to automatically generate the Entity Model, this model-first approach may present challenges when your data source undergoes changes or when you require greater control over entity operations. In this article, we will delve into the code-first approach for accessing Adobe Target data through the CData ADO.NET Provider, providing you with more flexibility and control.

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 Adobe Target Entity Framework 6 assembly and the connection string.

   To connect to Adobe Target, you must provide the Tenant property along with OAuth connection properties mentioned below. Note that while other connection properties can influence processing behavior, they do not affect the ability to connect.

   To determine your Tenant name:

   1. Log in to Adobe Experience. The URL will look similar to: "https://experience.adobe.com/#/@mycompanyname/preferences/general-section".
   2. Extract the value after the "/#/@". In this example, it is "mycompanyname".
   3. Set the Tenant connection property to that value.

   User Accounts (OAuth)

   You must set AuthScheme to OAuthClient for all user account flows.

   Note: Adobe authentication via OAuth requires updating your token every two weeks.

   All Applications

   CData provides an embedded OAuth application that simplifies OAuth authentication. Alternatively, you can create a custom OAuth application. Review Creating a Custom OAuth App in the Help documentation for more information.

   Obtaining the OAuth Access Token

   Set the following properties to connect:

   • InitiateOAuth: Set to GETANDREFRESH to automatically perform the OAuth exchange and refresh the OAuthAccessToken as needed.
   • OAuthClientId : Set to the client Id assigned when you registered your app.
   • OAuthClientSecret : Set to the client secret assigned when you registered your app.
   • CallbackURL : Set to the redirect URI defined when you registered your app. For example: https://localhost:3333

   With these settings, the provider obtains an access token from Adobe Target, which it uses to request data. The OAuth values are stored in the location specified by OAuthSettingsLocation, ensuring they persist across connections.

   
   <configuration>
      ... 
     <connectionStrings>
       <add name="AdobeTargetContext" connectionString="Offline=False;Tenant=mycompanyname;InitiateOAuth=GETANDREFRESH" providerName="System.Data.CData.AdobeTarget" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... 
         <provider invariantName="System.Data.CData.AdobeTarget" type="System.Data.CData.AdobeTarget.AdobeTargetProviderServices, System.Data.CData.AdobeTarget.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code> 
   

4. Add a reference to System.Data.CData.AdobeTarget.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 AdobeTargetContext. 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 AdobeTargetContext : DbContext {
     public AdobeTargetContext() { }
   
     protected override void OnModelCreating(DbModelBuilder modelBuilder)
     {
       // To remove the requests to the Migration History table
       Database.SetInitializer<AdobeTargetContext>(null);  
       // To remove the plural names    
       modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
     }  
   }
   

7. Create another .cs file and name it after the Adobe Target entity you are retrieving, for example, Activities. 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("Activities")]
   public class Activities {
     [System.ComponentModel.DataAnnotations.Key] 
     public System.String Id { get; set; }
     public System.String Name { get; set; }
   }
       
   

8. Now that you have created an entity, add the entity to your context class:

   
   public DbSet<Activities> Activities { set; get; }
   

9. With the context and entity finished, you are now ready to query the data in a separate class. For example:

   AdobeTargetContext context = new AdobeTargetContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Activities select line;