外部イベントレシーバーを作成する

Business Connectivity Services (BCS) 外部リストのオンプレミスのインストール用に外部イベントレシーバーを作成する手順について説明します。

重要

SharePoint アドインは非推奨です。このコンテンツは、オンプレミスの SharePoint Server にのみ適用されます。

外部イベントレシーバーは、SharePoint アドインがリストまたはリストアイテムなどの SharePoint アイテムに発生するイベントに応答できるようにするクラスです。たとえば、(フィールドを追加/削除するなどの) リストイベント、(リストアイテムやリストアイテムに対する添付ファイルを追加/削除するなどの) リストアイテムイベント、(サイトやサイトコレクションを追加/削除するなどの) Web イベントに応答できます。 SharePoint アドインを含む既存の Visual Studio ソリューションにリモートイベントレシーバーを追加できます。

この記事には、外部データ用のリモートイベントレシーバーを作成するための元の MSDN コードサンプルが付属しています。このコードは、外部システムイベント通知を構成して使用するために必要なコンポーネントの作成方法が示されています。

注:

この記事で参照されている元の MSDN コードサンプルは使用できなくなりました。ここには、必要なすべての手順とコードスニペットが含まれています。

この例では、次の操作を行います。

Northwind サンプルデータベースに基づいた外部システムの作成
Windows Communication Foundation (WCF) サービスの作成による、OData を介したサンプルデータの公開
データの変更を監視するポーリングサービスの作成と、SharePoint への変更の通知
アイテムが外部データに追加され、その結果、通知リストに新しいリストアイテムが作成された場合に実行される、外部イベントレシーバーの作成

前提条件とシステムセットアップ

この例を完了するには、次の前提条件が必要です。

Visual Studio 2022
Office Developer Tools for Visual Studio 2022
SQL Server
SharePoint
インターネットインフォメーションサービス
Northwind サンプルデータベース

外部システム用のコンポーネントの作成

設定の多くの部分は、実際には外部システム上で実行されます。外部イベントレシーバーが正しく動作するには、外部システムで次のコンポーネントが存在し、動作している必要があります。

サブスクリプションストア:外部システムへの変更の通知を受信するサブスクライバーに関する情報が含まれているテーブル。
変更ストア: データアイテムへの変更の保存に使用されるテーブル。通知が SharePoint のサブスクライバーに送り返されると、ポーリングサービスによってテーブル内のアイテムが削除されるため、一時的なストレージとしてのみ機能します。
ポーリングサービス: いつデータが変更されたか、いつ変更テーブルに送信されたかをチェックする方法として、このシナリオで必要です。ポーリングサービスは変更テーブルをクエリし、サブスクリプションストアに保存されている SharePoint 配信アドレス (REST エンドポイント) に送信される通知パッケージを作成します。
OData WCF データサービス: 外部システムのデータベースからのデータを公開するには、WCF サービスを作成する必要があります。インターネットインフォメーションサービス (IIS) で実行されているこのサービスは、REST 対応のインターフェイスと、このシナリオに必要な OData フィードを提供します。

外部システムのセットアップ

最初のタスクは、外部システムのセットアップです。

Northwind サンプルデータベースの接続

バックエンドシステムを準備するための最初の作業は、Northwind サンプルデータベースを SQL Server の実行中インスタンスに追加することです。すでに Northwind サンプルデータベースがインストールされている場合は、次のセクションのスクリプトを実行して、外部イベント通知が動作するために必要な追加オブジェクトを作成できます。

ただし、Northwind がインストールされていない場合は、「 Northwind サンプルデータベースのインストール」を参照してください。

サブスクリプションストアの作成

Northwind データベースをインストールしたら、新しいクエリウィンドウを開いて、次のスクリプトを実行します。

USE [Northwind]
GO

SET ANSI_NULLS ON
GO

SET QUOTED_IDENTIFIER ON
GO

CREATE TABLE [dbo].[EntitySubscribe](
    [SubscriptionId] [int] IDENTITY(1,1) NOT NULL,
    [EntityName] [nvarchar](250) NULL,
    [DeliveryURL] [nvarchar](250) NULL,
    [EventType] [int] NULL,
    [UserId] [nvarchar](50) NULL,
    [SubscribeTime] [timestamp] NULL,
    [SelectColumns] [nvarchar](10) NULL,
 CONSTRAINT [PK_Subscribe] PRIMARY KEY CLUSTERED ([SubscriptionId] ASC) WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS  = ON, ALLOW_PAGE_LOCKS  = ON) ON [PRIMARY]
) ON [PRIMARY]
GO

これにより、EntitySubscribe という名前のテーブルが Northwind データベースに作成されます。このテーブルは前述したサブスクリプションストアとして機能します。

変更ストアの作成

次のスクリプトを実行して、顧客テーブルのデータに加えられた変更を記録する変更テーブルを作成します。

USE [Northwind]
GO

SET ANSI_NULLS ON
GO

SET QUOTED_IDENTIFIER ON
GO

CREATE TABLE [dbo].[Customers_Updates](
    [CustomerID] [nchar](5) NOT NULL,
    [CompanyName] [nvarchar](40) NOT NULL,
    [ContactName] [nvarchar](30) NULL,
    [ContactTitle] [nvarchar](30) NULL,
    [Address] [nvarchar](60) NULL,
    [City] [nvarchar](15) NULL,
    [Region] [nvarchar](15) NULL,
    [PostalCode] [nvarchar](10) NULL,
    [Country] [nvarchar](15) NULL,
    [Phone] [nvarchar](24) NULL,
    [Fax] [nvarchar](24) NULL,
    [TimeAdded] [datetime] NULL,
    [EventType] [int] NULL,
 CONSTRAINT [PK_Customers_Updates] PRIMARY KEY CLUSTERED ([CustomerID] ASC)WITH (PAD_INDEX  = OFF, STATISTICS_NORECOMPUTE  = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS  = ON, ALLOW_PAGE_LOCKS  = ON) ON [PRIMARY]) ON [PRIMARY]
GO

これにより、顧客テーブルに追加されたレコードに関する情報を保存する、Customers_Updates という名前のテーブルが追加されます。

変更トリガーの作成

変更トリガーは、Customers テーブルに変更が発生したときに発生します。レコードが Customers に追加されるたびに、SQL Serverはトリガーを実行し、レコードに関する情報を含む新しいレコードをCustomers_Updates テーブルに挿入します。

トリガーを作成するには、次のクエリを実行します。

USE [Northwind]
GO

SET ANSI_NULLS ON
GO

SET QUOTED_IDENTIFIER ON
GO

CREATE trigger [dbo].[Customer_insupd] on [dbo].[Customers] for
INSERT
AS
DECLARE
    @CustomerID nchar(5),
    @CompanyName nvarchar(40),
    @ContactName nvarchar(30) ,
    @ContactTitle nvarchar(30) ,
    @Address nvarchar(60) ,
    @City nvarchar(15) ,
    @Region nvarchar(15) ,
    @PostalCode nvarchar(10) ,
    @Country nvarchar(15) ,
    @Phone nvarchar(24) ,
    @Fax nvarchar(24),
    @TimeAdded datetime,
    @EventType int

    Select @CustomerID = CustomerId, @CompanyName=CompanyName,
    @ContactName=ContactName, @ContactTitle=ContactTitle,
    @Address=Address, @City=City, @Region=Region,
    @PostalCode =PostalCode, @Country=Country,
    @Phone=Phone,@Fax=Fax,@EventType=1
    from inserted

    insert into Customers_Updates
    (CustomerId,CompanyName,
    ContactName, ContactTitle,
    Address, City, Region,
    PostalCode,Country,
    Phone,Fax,TimeAdded,EventType) values
    (@CustomerId,@CompanyName,
    @ContactName, @ContactTitle,
    @Address, @City, @Region,
    @PostalCode,@Country,
    @Phone,@Fax,SYSDATETIME(),@EventType)

GO

注:

BDC モデルで定義されている独自のカスタムストアドプロシージャを使用している場合は、削除トリガーと更新トリガーを作成することもできます。追加のトリガーは、このシナリオの一部として取り上げません。

ストアドプロシージャを作成する

Business Connectivity サービスで直接テーブルアクセスを使用している場合、これらの手順は必要ありません。ただし、外部システムで独自のプロシージャとカスタムコードを定義する場合は、これらを追加して、SQL Serverからテーブルへのアクセスを許可することができます。

// DeleteEventRecords stored procedure
USE [Northwind]
GO
SET ANSI_NULLS ON
GO

SET QUOTED_IDENTIFIER ON
GO

CREATE PROCEDURE [dbo].[proc_DeleteEventRecords]
    @CustomerID nchar(5), @EventType int
    AS
    Delete from Customers_Updates
    WHERE  CustomerID like @CustomerID AND EventType=@EventType

GO

SubscribeEntity ストアドプロシージャは、サブスクリプションストアにレコードを作成します。

// SubscribeEntity
USE [Northwind]
GO

SET ANSI_NULLS ON
GO

SET QUOTED_IDENTIFIER ON
GO

CREATE PROCEDURE [dbo].[SubscribeEntity]
    @EntityName Varchar(255),
    @EventType Integer,
    @DeliveryAddress Varchar(255),
    @SelectColumns Varchar(10)

AS
BEGIN
    -- SET NOCOUNT ON added to prevent extra result sets from
    -- interfering with SELECT statements.
    SET NOCOUNT ON;

    -- Insert statements for procedure here

    Insert into EntitySubscribe(EntityName,DeliveryURL,EventType,SelectColumns)
    values (@EntityName,@DeliveryAddress,@EventType,@SelectColumns)

END

GO

OData サービスを作成する

OData フィードは、 WCF データサービス 内でホストされます。この WCF サービスは、Web アプリケーションで IIS によってホストされます。

以下の手順では、新しい ASP.NET WCF データサービスを作成します。

WCF データサービスアプリケーションを作成するには

Visual Studio 2022 の [ ファイル ] メニューで、[ 新規作成] 、[ プロジェクト] の順に選択します。
[ 新しいプロジェクト] ダイアログボックスの Visual C# ノードで [ Web] テンプレート、[ ASP.NET Web アプリケーション] の順に選択します。
プロジェクトの名前として「NorthwindService」と入力し、[ OK] を選択します。

次に Visual Studio ウィザードを使用して、データソースのスキーマを検出し、それを使って ADO.NET エンティティデータモデルを作成します。

データモデルを定義するには

ソリューションエクスプローラーで、ASP.NET プロジェクトのショートカットメニューを開き、[ 新しい項目の追加] を選択します。
[ 新しいアイテムの追加] ダイアログボックスで [ データ] テンプレートを選択し、[ ADO.NET エンティティデータモデル] を選択します。
データモデルの名前には、「Northwind.edmx」と入力します。
エンティティデータモデルウィザードで、[ データベースから生成] を選択し、[ 次へ] を選択します。
次のいずれかのステップを実行して、データモデルをデータベースに接続します。
データベース接続がまだ構成されていない場合は、[ 新しい接続 ] を選択し、新しい接続を作成します。詳細については、「 SQL Server データベースへの接続を作成する方法」を参照してください。この SQL Server インスタンスには、Northwind サンプルデータベースが接続されている必要があります。 [次へ] を選択します。

または
Northwind データベースに接続するようにデータベース接続が構成済みの場合、接続リストからその接続を選択し、[ 次へ] を選択します。
ウィザードの最終ページで、データベース内のすべてのテーブルのチェックボックスを選択し、ビューおよびストアドプロシージャのチェックボックスをオフにします。
[ 完了] ボタンをクリックして、ウィザードを終了します。

次のステップでは、IIS がホストする実際のサービスを作成します。このサービスは、Representational State Transfer (REST) を介して、外部データにアクセスする方法を提供します。

WCF データサービスを作成するには

[ ソリューションエクスプローラー] で ASP.NET プロジェクトのショートカットメニューを開き、[ 新しいアイテムの追加] を選択します。
[ 新しい項目の追加] ダイアログボックスで [ WCF データサービス] を選択します。
サービスの名前には、「Northwind」を入力します。
データサービスのコードでは、データサービスを定義するクラスの定義で、コメント /* TODO: put your data source class name here */ をデータモデルのエンティティコンテナーである型に置き換えます。この場合は NorthwindEntities。クラス定義は次のようになります。

public class Northwind : DataService<NorthwindEntities>

サービスにセキュリティを設定するには

外部の消費者が OData フィードからのデータにアクセスできるように、セキュリティを変更する必要があります。 WCF サービスを作成すると、既定ではすべてのアクセスが拒否されます。作成したクラスに次の変更を加えます。


config.SetEntitySetAccessRule("*", EntitySetRights.All);
config.SetServiceOperationAccessRule("*", ServiceOperationRights.All);

SharePoint からのサブスクライブおよびサブスクライブ取り消し要求を処理する方法を使って、WCF サービスをコーディングすることができます。アプリケーションのカスタムストアドプロシージャを作成する場合、これらはそれぞれサービス操作によって処理されます。

サブスクライブ: サブスクライブ操作は SharePoint によって送信される要求を受け取り、各タイプとエンティティの配信アドレスを取得します。また、 subscriptionId を生成し、これらのすべてをデータベーステーブルに記録します。


/// The Subscribe service operation maps directly to the Subscribe stereotype
/// found in the BDC model

[WebGet]
public string Subscribe(string deliveryUrl, string eventType)
{
   // Generate a new Guid that will function as the subscriptionId.
  string subscriptionId = new Guid().ToString();

  // This sproc will be used to create the subscription in the database.
  string subscribeSproc = "SubscribeEntity";

  // Create connection to database.
  using (SqlConnection conn = new SqlConnection(sqlConn))
  {
    SqlCommand cmd = new SqlCommand(subscribeSproc, conn);
    cmd.Parameters.Add(new SqlParameter("SubscriptionId", subscriptionId));
    cmd.Parameters.Add(new SqlParameter("EntityName", entityName));
    cmd.Parameters.Add(new SqlParameter("EventType", eventType));
    cmd.Parameters.Add(new SqlParameter("DeliveryAddress", deliveryUrl));
    cmd.Parameters.Add(new SqlParameter("SelectColumns", selectColumns));

    try
    {
      conn.Open();
      cmd.ExecuteNonQuery();
  }
    catch (Exception e)
    {
      throw e;
    }
    finally
    {
      conn.Close();
    }

    return subscriptionId;
  }
}

注:

SQL Server が Windows 認証用にセットアップされている場合、アプリケーションプール ID を使用して要求の認証を試みます。アプリケーションプールで構成されたアカウントが、データベースの読み取りおよび書き込みのアクセス権を持っていることを確認してください。

ポーリングサービスを作成する

ポーリングサービスは、変更テーブルのクエリを実行し、特定の配信アドレスで SharePoint または SharePoint Online に通知を作成して送信する Windows サービスです。

次に、新しい Windows サービスプロジェクトを作成し、WCF ホストマシンに登録します。プロジェクトを登録した後、Microsoft 管理コンソール (MMC) の実行中サービスを確認できます。

新規プロジェクトを作成するには

Visual Studio 2022 を開きます。
Windows サービステンプレートを使って新規プロジェクトを作成し、プロジェクトに「PollingService」という名前を付けて、[ OK] ボタンをクリックします。
プロジェクトを作成したら、コードビューで PollingService.cs ファイルを開きます。
以下のコードを新しく作成したクラスに追加します。

public partial class PollingService : ServiceBase
{
  string subscriptionStorePath = string.Empty;

  public PollingService()
  {
    InitializeComponent();
  }

  protected override void OnStart(string[] args)
  {
    // This is the timer which fires every minute.
    System.Timers.Timer aTimer = new System.Timers.Timer();
    aTimer.Elapsed += new System.Timers.ElapsedEventHandler(SendEventNotification);
    aTimer.Interval = 60000;
    aTimer.Enabled = true;
  }

  protected override void OnStop()
  { }

  private void SendEventNotification(object sender, EventArgs e)
  {
    try
    {
      List<ItemChange> events = itemChangeLookUp();
      triggerEventPerSubscription(events);
    }
    catch (Exception ex)
    {
      EventLog.Log = "Application";
      EventLog.Source = ServiceName;
      EventLog.WriteEntry("PollingService" + ex.Message, EventLogEntryType.Error);
    }
  }

  private void triggerEventPerSubscription(List<ItemChange> events)
  {
    foreach (ItemChange itemChangeEvent in events)
    {
      SendNotification(itemChangeEvent, itemChangeEvent.DeliveryAddress);
      string message = string.Format("PollingService.TriggerEventPerSubscription: Notification sent for item {0} of eventType {1}", itemChangeEvent.CustomerId, itemChangeEvent.EventType);
      EventLog.Log = "Application";
      EventLog.Source = ServiceName;
      EventLog.WriteEntry(message);
    }
  }

  private List<ItemChange> itemChangeLookUp()
  {
    EventLog.Log = "Application";
    EventLog.Source = ServiceName;
    EventLog.WriteEntry("Polling for Item Change");
    List<ItemChange> itemChangeList = new List<ItemChange>();
    string connectionString = "Data Source=.;Initial Catalog=Northwind;Integrated Security=true";

    // Provide the query string with a parameter placeholder.
    string queryString = "Proc_RetrieveEventRecords";

    // Specify the parameter value.
    int paramValue = -50;

    using (SqlConnection connection = new SqlConnection(connectionString))
    {
      SqlCommand command = new SqlCommand(queryString, connection);
      command.CommandType = CommandType.StoredProcedure;
      command.Parameters.AddWithValue("@TimeSince", paramValue);
      try
      {
        connection.Open();
        SqlDataReader reader = command.ExecuteReader();
        while (reader.Read())
        {
          ItemChange item = new ItemChange(reader["CustomerID"].ToString(), Int32.Parse(reader["EventType"].ToString()),
            reader[14].ToString(), reader["DeliveryUrl"].ToString(), reader["CompanyName"].ToString(),
            reader["ContactName"].ToString(), reader["ContactTitle"].ToString(), reader["Address"].ToString(),
            reader["City"].ToString(), reader["Region"].ToString(), reader["Country"].ToString(), reader["PostalCode"].ToString(),
            reader["Phone"].ToString(), reader["Fax"].ToString());
          itemChangeList.Add(item);
        }
        reader.Close();
      }
      catch (Exception ex)
      {
        EventLog.Log = "Application";
        EventLog.Source = ServiceName;
        EventLog.WriteEntry("PollingService : ItemChangeLookup " + ex.Message, EventLogEntryType.Error);
      }
    }
    string message = string.Format("{0} items changes", itemChangeList.Count);
    EventLog.Log = "Application";
    EventLog.Source = ServiceName;
    EventLog.WriteEntry(message);

    return itemChangeList;
  }

次の手順は、OData コンピューターの実行中サービスに追加できる実行可能ファイルを作成することです。

ポーリングサービスのコンパイルと展開を行うには

F5 を押して、プロジェクトをビルドします。
VS2022 のコマンドプロンプトを開きます。
プロンプトで、プロジェクトを出力する場所に移動します。
Bin ディレクトリーで、PollingService.exe ファイルを探します。
「installutil PollingService.ex」と入力し、Enter キーを押します。
Services MMC を実行して、サービスが実行中であることを確認します。

必要な SharePoint コンポーネント

システム全体を完了するには、SharePoint を実行しているサーバーで次のコンポーネントが必要です。

外部コンテンツタイプ: 外部コンテンツタイプは基本的に、外部データソースの XML 定義です。このシナリオでは、Visual Studio 2022 の新しい自動生成ツールを使用してデータソースを検出し、外部コンテンツタイプを自動的に作成します。
外部イベントレシーバー: リモートまたは外部イベントレシーバーは、外部データの変更に対する操作を、SharePoint で実行できるようにします。外部リストとエンティティに対して、イベントレシーバーを作成できます。

外部リスト用に作成されたイベントレシーバーは、SharePoint リスト用の他のイベントレシーバーと似ています。コードを作成し、それをリストに接続します。リストで表示されているデータに対して操作を実行すると、イベントレシーバーが実行されます。

エンティティ用のイベントレシーバーは、リストベースのイベントレシーバーと同じように実行されますが、リストに接続する必要がないという点が異なります。このレシーバーは同じように通知を受信しますが、リストベースの例に関連付けられているインタフェースは必要ありません。このレシーバーのメリットは、通知をプログラムで受信し、特定のアクションを実行するコードを作成することができるということです。このシナリオでは、通知リストでの新規レコードの作成がそのアクションに相当します。
通知リスト: 通知リストはシンプルな SharePoint リストで、外部システムから受信した通知を記録するために使われます。外部システムに新しいレコードが追加されるたびに、通知リストでレコードが作成されます。

SharePoint コンポーネントのセットアップ

外部システムを設定したら、次に数式の残りの半分を作成します。次に、SharePoint でホストするコンポーネントを作成します。

新しい Visual Studio 2022 プロジェクトを作成するには

Visual Studio 2022 で、[ 新しいプロジェクト] を選択します。
SharePoint アプリプロジェクトのテンプレートを選択します。

Office Developer Tools for Visual Studio 2022 では、データソースのスキーマを検出し、そこから外部コンテンツタイプを作成する自動生成ウィザードが追加されました。

新しい外部コンテンツタイプを追加するには

[ ソリューションエクスプローラー] でプロジェクトのショートカットメニューを開き、[ 追加]、[ 外部データソース用のコンテンツタイプ] の順に選択します。

これにより、 SharePoint カスタマイズウィザード が起動します。このウィザードは外部コンテンツタイプの自動作成に使われます。

外部コンテンツタイプを作成する方法の詳細については、「方法: SharePoint で OData ソースから外部コンテンツタイプを作成する」を参照してください。

前の手順で生成された XML を変更して、Subscribe のメソッドを追加します。これにより、外部データの変更について通知されるようにユーザーがサブスクライブするときに、BCS が外部システムと通信できるようになります。

[ ソリューションエクスプローラー] で [ 外部コンテンツタイプ] という新規ノードを検索します。
Customers.ect ファイルを見つけ、それを XML エディターで開きます。
ページの下部まで下にスクロールし、次のメソッドを [ <Methods> ] セクションに貼り付けます。


<Method Name="SubscribeCustomer" DefaultDisplayName="Customer Subscribe" IsStatic="true">
              <Properties>
                <Property Name="ODataEntityUrl" Type="System.String">/EntitySubscribes</Property>
                <Property Name="ODataHttpMethod" Type="System.String">POST</Property>
                <Property Name="ODataPayloadKind" Type="System.String">Entry</Property>
                <Property Name="ODataFormat" Type="System.String">application/atom+xml</Property>
                <Property Name="ODataServiceOperation" Type="System.Boolean">false</Property>
              </Properties>
              <AccessControlList>
                <AccessControlEntry Principal="NT Authority\\Authenticated Users">
                  <Right BdcRight="Edit" />
                  <Right BdcRight="Execute" />
                  <Right BdcRight="SetPermissions" />
                  <Right BdcRight="SelectableInClients" />
                </AccessControlEntry>
              </AccessControlList>
              <Parameters>
                <Parameter Direction="In" Name="@DeliveryURL">
                  <TypeDescriptor TypeName="System.String" Name="DeliveryURL" >
                    <Properties>
                      <Property Name="IsDeliveryAddress" Type="System.Boolean">true</Property>
                    </Properties>
                  </TypeDescriptor>
                </Parameter>
                <Parameter Direction="In" Name="@EventType">
                  <TypeDescriptor TypeName="System.Int32" Name="EventType" >
                    <Properties>
                      <Property Name="IsEventType" Type="System.Boolean">true</Property>
                    </Properties>
                  </TypeDescriptor>
                </Parameter>
                <Parameter Direction="In" Name="@EntityName">
                  <TypeDescriptor TypeName="System.String" Name="EntityName" >
                    <DefaultValues>
                      <DefaultValue MethodInstanceName="SubscribeCustomer" Type="System.String">Customers</DefaultValue>
                    </DefaultValues>
                  </TypeDescriptor>
                </Parameter>
                <Parameter Direction="In" Name="@SelectColumns">
                  <TypeDescriptor TypeName="System.String" Name="SelectColumns" >
                    <DefaultValues>
                      <DefaultValue MethodInstanceName="SubscribeCustomer" Type="System.String">*</DefaultValue>
                    </DefaultValues>
                  </TypeDescriptor>
                </Parameter>
                <Parameter Direction="Return" Name="SubscribeReturn">
                  <TypeDescriptor Name="SubscribeReturnRootTd" TypeName="Microsoft.BusinessData.Runtime.DynamicType">
                    <TypeDescriptors>
                      <TypeDescriptor Name="SubscriptionId" TypeName="System.String" >
                        <Properties>
                          <Property Name="SubscriptionIdName" Type="System.String">Default</Property>
                        </Properties>
                        <Interpretation>
                          <ConvertType LOBType="System.Int32" BDCType="System.String"/>
                        </Interpretation>
                      </TypeDescriptor>
                      <TypeDescriptor Name="DeliveryURL" TypeName="System.String" />
                      <TypeDescriptor Name="SelectColumns" TypeName="System.String" >
                      </TypeDescriptor>
                      <TypeDescriptor Name="EntityName" TypeName="System.String" />
                      <TypeDescriptor Name="EventType" TypeName="System.Int32" />
                      <TypeDescriptor Name="UserId" TypeName="System.String" />
                      <!--TypeDescriptor Name="SubscribeTime" TypeName="System." /-->
                    </TypeDescriptors>
                  </TypeDescriptor>
                </Parameter>
              </Parameters>
              <MethodInstances>
                <MethodInstance Type="EventSubscriber" ReturnParameterName="SubscribeReturn" ReturnTypeDescriptorPath="SubscribeReturnRootTd" Default="true" Name="SubscribeCustomer" DefaultDisplayName="Customer Subscribe">
                  <AccessControlList>
                    <AccessControlEntry Principal="NT Authority\\Authenticated Users">
                      <Right BdcRight="Edit" />
                      <Right BdcRight="Execute" />
                      <Right BdcRight="SetPermissions" />
                      <Right BdcRight="SelectableInClients" />
                    </AccessControlEntry>
                  </AccessControlList>
                </MethodInstance>
              </MethodInstances>
            </Method>

次に、クライアントコードを追加して、リストがイベント通知をサブスクライブできるようにします。

コードを App.js ファイルに追加して、サブスクリプションを開始するには

SharePoint アドインプロジェクトの [スクリプト] フォルダーで、 App.js ファイルを開きます。以下のメソッドをファイルに貼り付けます。


function SubscribeEntity()
{
    var notificationCallback = new SP.BusinessData.Runtime.NotificationCallback(context, "http://[MACHINE NAME]:8585");
    var url = myweb.get_url();
    notificationCallback.set_notificationContext(url);
    context.load(notificationCallback);
    var subscription = entity.subscribe(1, notificationCallback, "", "SubscribeCustomer", lobSystemInstance);
    context.load(subscription);
    context.executeQueryAsync(OnSubscribeSuccess, failmethod);
}

このスクリプトを使用してイベントレシーバーを登録するには、プロジェクトの Default.aspx ページにボタンを作成し、 onclick() メソッドから SubscribeEntity() を呼び出す必要があります。

Default.aspx ページを開き、次の HTML を追加します。


<input type="button" value="Subscribe" onclick="SubscribeEntity();"/>

イベントを動作させるには、SharePoint リストを有効にして、外部イベントを受け取れるようにすることも必要です。これは、外部イベント機能をオンにすることで可能になります。

クライアントコードを使用して、この機能をオンにするスクリプトを次に示します。

function EnableEventing_Clicked()
{
    var clientContext = SP.ClientContext.get_current();
    var web = clientContext.get_web();
    var features = web.get_features();

    clientContext.load(features);

    // The GUID provided here is the feature that allows external events and alerts.
    var eventingFeatureId = new SP.Guid('5B10D113-2D0D-43BD-A2FD-F8BC879F5ABD');

    var eventingFeature = features.add(eventingFeatureId, true, SP.FeatureDefinitionScope.farm);

    clientContext.load(eventingFeature);
    var onEventingFeatureActivated = function () {
        alert("eventing feature activated");
    };
    clientContext.executeQueryAsync(Function.createDelegate(this,
    onEventingFeatureActivated));
}

Subscribe と同様に、機能を有効にするボタンをページに追加します。

Default.aspx ページの [ サブスクライブ] ボタンのすぐ下に、次の HTML を追加します。


<input type="button" value="EnableEventing" onclick="EnableEventing_Clicked();" />

このシナリオでは次に、外部システムが送信した通知を表示する通知リストを追加する必要があります。

通知リストを追加するには

[ ソリューションエクスプローラー] で、プロジェクト名のショートカットメニューを開き、[ 追加] を選択します。
[ リスト] テンプレートを選択し、リストに「NotificationList」という名前を付けます。

グローバルアセンブリキャッシュで SharePoint で登録されているイベントレシーバーを模倣するため、このサンプルでは、変更のリッスンを開始するコンソールアプリケーションを提供します。通知を受信すると、リストアイテムが NotificationList に追加されます。

コマンドラインイベントレシーバーを開始するには

[ RemoteEventReceiverConsoleApp] を開きます。
[ Program.cs] ファイルを開き、ローカルコンピューター (またはイベントレシーバーを実行中のコンピューター) の名前を変更します。
Visual Studio の [スタート ] ボタンを選択して、コンソールアプリケーションを実行します。

コマンドウィンドウが開きます。これは、アプリケーションが正しくコンパイルされ、外部システムからの変更通知をリッスンしていることを示します。このテスト中は、このウィンドウを開いたままにします。

アプリを SharePoint に展開するには

Visual Studio で F5 キーを押して、ビルドと展開を行います。

アプリのテスト

これでアプリが実行できるようになりました。

アプリを色々と動かし、外部システム内のデータを表すさまざまなリストを表示します。
[ 顧客 ] の一覧を選択します。
新しい顧客を追加します。
作成した新しいリストアイテムを表示します。
通知リストに移動して、外部システムが顧客テーブルの変更を SharePoint に通知したことを確認します。

1 分ごとに通知を送信するようにタイマーが設定されているということに注意してください。テスト中、通知が送信されるまでに、少し時間がかかることがあります。

外部イベント レシーバーを作成する

前提条件とシステムセットアップ

外部システム用のコンポーネントの作成

外部システムのセットアップ

Northwind サンプル データベースの接続

サブスクリプション ストアの作成

変更ストアの作成

変更トリガーの作成

ストアド プロシージャを作成する

OData サービスを作成する

WCF データ サービス アプリケーションを作成するには

データ モデルを定義するには

WCF データ サービスを作成するには

サービスにセキュリティを設定するには

サブスクライブ サービス操作の作成 (オプション)

ポーリング サービスを作成する