How to Access Claude Compliance Data Using Entity Framework

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
This article shows how to access Claude Compliance data using an Entity Framework code-first approach. Entity Framework 6 is available in .NET 4.5 and above.

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

    The driver connects to Claude Compliance using a Compliance Access Key, the only supported authentication method. Set the following connection property:

    • APIKey: The Compliance Access Key you created.

    Creating a Compliance Access Key

    1. Enable the Compliance API for your organization.
    2. Sign in to claude.ai as a primary owner or organization owner and open Organization settings > API > Keys.
    3. Select Create Key and assign only the scopes your integration needs:
      • read:compliance_activities for Activities and the typed activity views.
      • read:compliance_org_data for organizations, roles, groups, and settings.
      • read:compliance_user_data for users, chats, files, projects, and downloads.
      • delete:compliance_user_data for the explicit Delete stored procedures.
    4. Create the key and copy it when it appears. The key starts with sk-ant-api01- and is shown only once.

    Optionally, set OrganizationUUID to limit organization-scoped views (such as OrganizationUsers and ComplianceRoles) to a single linked organization. If it is left empty, those views default to the first available organization and do not include data from all linked organizations.

    
    
    <configuration>
       ... 
      <connectionStrings>
        <add name="ClaudeComplianceContext" connectionString="Offline=False;APIKey=your_compliance_access_key;" providerName="System.Data.CData.ClaudeCompliance" />
      </connectionStrings>
      <entityFramework>
        <providers>
           ... 
          <provider invariantName="System.Data.CData.ClaudeCompliance" type="System.Data.CData.ClaudeCompliance.ClaudeComplianceProviderServices, System.Data.CData.ClaudeCompliance.Entities.EF6" />
        </providers>
      <entityFramework>
    </configuration>
    </code> 
    
  4. Add a reference to System.Data.CData.ClaudeCompliance.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 ClaudeComplianceContext. 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 ClaudeComplianceContext : DbContext {
      public ClaudeComplianceContext() { }
    
      protected override void OnModelCreating(DbModelBuilder modelBuilder)
      {
        // To remove the requests to the Migration History table
        Database.SetInitializer<ClaudeComplianceContext>(null);  
        // To remove the plural names    
        modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
      }  
    }
    
  7. Create another .cs file and name it after the Claude Compliance entity you are retrieving, for example, Projects. 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("Projects")]
    public class Projects {
      [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<Projects> Projects { set; get; }
    
  9. With the context and entity finished, you are now ready to query the data in a separate class. For example:
    
    ClaudeComplianceContext context = new ClaudeComplianceContext();
    context.Configuration.UseDatabaseNullSemantics = true;
    var query = from line in context.Projects select line;
    

Ready to get started?

Download a free trial of the Claude Compliance Data Provider to get started:

 Download Now

Learn more:

Claude Compliance Icon Claude Compliance ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Claude Compliance data including Activities, Chats, ChatMessages, CodeArtifacts, ComplianceRoles, Organizations, OrganizationUsers, Projects, and more!