Entity Framework 6 からSAP Netweaver Gateway のデータに連携

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでSAP Netweaver Gateway にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、SAP Netweaver Gateway Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   SAP Gateway 接続プロパティの取得・設定方法

   SAP Gateway のテーブルにアクセスするには、次の接続プロパティを設定します。

   • URL = お使いの環境のURL、またはサービスの完全URL。例えば、完全URL は次のようになります：https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/。この例では、環境URL は次のようになります：https://sapes5.sapdevcenter.com。CustomUrlParams プロパティを使用して、追加プロパティを追加します。
   • Namespace = 適切なService Namespace。先ほどの例では、IWBEP が名前空間です。サービスへの完全URL が指定されている場合は任意です。
   • Service = データを取得するサービス。先ほどの例では、サービスはGWSAMPLE_BASIC です。完全URL が指定されている場合は必須ではありません。
   • CustomUrlParams = HTTP リクエストに含まれる必要のある追加プロパティ；例えばsap-client=001&sap-language=EN。

   SAP Gateway への認証

   SAP Gateway はBasic 認証、OAuth 2.0 認証、SAP BTP Destination 認証を許可します。

   Basic 認証

   Basic 認証を有効にするには、以下のプロパティを設定します。

   • AuthScheme = Basic。
   • User = SAP Gateway へのログインに使用するユーザー名。
   • Password = SAP Gateway へのログインに使用するパスワード。

   上記のプロパティを設定したら、接続の準備は完了です。ローカルデータにアクセスするには、個人の認証情報を使用します。

   他の認証方法については、ヘルプドキュメントの「接続の確立」セクションを参照してください。

   
   <configuration>
      ... <connectionStrings>
       <add name="SAPGatewayContext" connectionString="Offline=False;User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;" providerName="System.Data.CData.SAPGateway" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.SAPGateway" type="System.Data.CData.SAPGateway.SAPGatewayProviderServices, System.Data.CData.SAPGateway.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.SAPGateway.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSAPGatewayContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class SAPGatewayContext :DbContext {
   	public SAPGatewayContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<SAPGatewayContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSAP Netweaver Gateway のエンティティ、例えばSalesOrderLineItems にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class SalesOrderLineItems {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String ProductID { get; set; }
   }
   public class SalesOrderLineItemsMap :EntityTypeConfiguration<SalesOrderLineItems> {
   	public SalesOrderLineItemsMap() {
   		this.ToTable("SalesOrderLineItems");
   		this.HasKey(SalesOrderLineItems => SalesOrderLineItems.Id);
   		this.Property(SalesOrderLineItems => SalesOrderLineItems.ProductID);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

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

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

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