Внешние события и оповещения в SharePoint

Статья
05/18/2023

Основные понятия создания удаленных приемников событий в SharePoint, которые можно присоединять к внешним спискам и выполнять при обновлении внешних данных, представленных в списке.

Что такое приемники событий?

Приемник событий — это часть управляемого кода, который реагирует на события, запускающие SharePoint, такие как добавление, перемещение, удаление, возврат и извлечение. При возникновении этих событий и выполнении условий приемника событий выполняется код, который вы пишете для предоставления дополнительных функциональных возможностей. Когда объекты SharePoint, такие как списки, рабочие процессы и компоненты, настроены на ожидание этих событий, они называются узлами событий.

Приемники событий позволяют выполнять бизнес-логики при возникновении определенных событий. По сути это обработчики, где можно создать код, чтобы обрабатывать некоторые условия, сделать уведомлений, обновление других систем и т.д. При создании приемников событий создается библиотеки DLL. Можно поместить эту Библиотеку в глобальном кэше сборок, чтобы приемников событий, вызываются в ответ на изменения в внешней системы.

Следующий пример содержит приемник простой внешних событий в C#, который выполняется при добавлении нового элемента в список.

public class EntryContentEventReceiver : SPItemEventReceiver
{
  public override void ItemAdded(SPItemEventProperties properties)
  {
    base.ItemAdded(properties);
    // properties.ExternalNotificationMessage holds the message sent by the external system
  }
}

Внешние приемники событий также могут быть расширены для работы с приемником событий сущности и в качестве удаленных приемников событий, развернутых как служба в локальной среде или в Microsoft Azure.

Что такое удаленные приемники событий?

Удаленные приемники событий являются новыми для SharePoint. Традиционные решения SharePoint используйте приемника событий для обработки событий, таких как пользователи, создание и удаление списков и элементов списка. В Надстройка SharePoint использовать удаленного приемника событий для обработки событий, аналогичные. Удаленные приемники событий действуют подобно приемников событий регулярных, за исключением того, что удаленные приемники событий обработки событий, происходящих при Надстройка SharePoint на другой системе с его узла веб-приложения.

Службы Business Connectivity Services (BCS) использует удаленных приемников событий подключенного к внешних списков и entities можно написать код, который может реагировать на изменения в данные, размещаемые во внешней системе.

Чтобы решить эту проблему, были добавлены два стереотипов схеме модели BDC: EventSubscriber и EventUnsubscriber.

Примечание.

[!Примечание] Приемники событий не поддерживаются в изолированных решениях.

Какие функции и возможности нового инфраструктура приемника внешних событий предоставляет?

Используя и расширяя функции приемников событий SharePoint, BCS может добавлять оповещения, приемники событий внешнего списка и приемники сущностей для предоставления расширенных функциональных возможностей.

Оповещения: Оповещения были неотъемлемой частью SharePoint для нескольких версий, но до arePoint они не работали с внешними списками. Теперь пользователь может создавать оповещения на внешний список, для которого отличается от оповещений для стандартного списка SharePoint.
Приемников событий внешнего списка: Приемники событий теперь могут быть присоединены к внешним спискам так же, как они могут для Стандартные списки. Это обеспечивает механизм расширяемости, который позволяет записывать данные, выполняемые в определенное время.
Приемников событий сущности: Приемники событий сущности обеспечивают гибкость, позволяя создавать более надежный код, обеспечивающий других операций, например контекста пользователя, для фильтрации данных. Это позволяет лучше личной настройки и настройку безопасности.

Удаленные события в SharePoint позволяют использовать несколько интересных сценариев. Например возможно, «Продажи отслеживание потенциальных клиентов» приложение, которое позволяет получать уведомления при вводе нового сбыту в приложение внешнего интереса продажах. При вводе нового ведущего сотрудника отдела продаж через систему уведомлений, который является частью приложения интереса уведомляется SharePoint. SharePoint получает уведомления и затем создает новые задачи для указанного сотрудников отдела продаж к исполнению на каждый новый ведущий сотрудник. При настройке приложения запись ведущего сотрудника отдела продаж на внешнюю систему, чтобы отправить уведомление SharePoint при создании каждого нового интереса, SharePoint будет храниться полностью в актуальном состоянии.

Необходимые условия для использования приемников событий для внешних списков

Чтобы использовать приемники событий для внешних списков, вам необходимо следующее:

SharePoint
Visual Studio 2012

Дополнительные сведения о настройке среды разработки SharePoint см. в статье Настройка общей среды разработки для SharePoint.

Настройка внешней системы для уведомления SharePoint внешние события

Для внешних событий для работы число компонентов нужно установить и настроить на узел SharePoint и внешняя система.

Необходимо настроить для внешней системы, чтобы его можно сделать следующее:

Определение при изменении базовых данных. Для внешней системы, чтобы узнать, когда были внесены изменения необходимо создать механизм опроса для конкретных изменений. Это можно сделать с помощью запланированных служба, которая опрашивает источника данных через определенные интервалы времени.
Получения и записи запросов для подписки на уведомления об изменениях. Реализация хранилища подписок, чтобы его можно хранить получателей уведомлений об изменении имеет во внешней системе. Самое простое решение, вероятно, это таблица базы данных. Таблица (или любой другой анизм) должна записывать Идентификатор подписки, Адрес доставки, Тип события и Имя сущности.
Регистрации уведомлений конечным точкам представлений состояния (REST). Чтобы сообщить подписчикам SharePoint о том, что произошло изменение, внешнее системное приложение должно отправить httpWebRequest на адрес доставки, записанный в хранилище подписок. Этот адрес доставки является конечной точкой RESTful, созданной SharePoint в процессе подписки.

Настройка SharePoint для разрешения взаимодействия с внешними системами

Чтобы разрешить связь с внешней системы, SharePoint должны быть настроены следующие:

Модели BDC с EventSubscriber и EventUnsubscriber стереотипов настроены
Приемники событий

Как включить внешние события

Вы можете включить внешние события в SharePoint с помощью параметров сайта или путем добавления в проект следующего пользовательского идентификатора компонента.

<ActivationDependency FeatureTitle="BCSEvents" FeatureId="60c8481d-4b54-4853-ab9f-ed7e1c21d7e4" />

Включается событий для внешней системы, когда SharePoint создает адрес доставки и отправляет его к внешней системе во время процесса подписки на.

Общий поток внешние события между SharePoint и внешними системами

На рисунке 1, обратите внимание, что состоит из трех различных шагов при использовании приемников событий внешнего: подписка, уведомления и отменить подписку.

На рисунке 1 поток завершения данных для внешних уведомлений

Поток данных для уведомлений о внешних событиях

Для пользователя (объект SharePoint) для получения уведомлений при изменении базовых данных пользователю необходимо подписаться на уведомления для сущности. Для этого схемы модели BDC был расширен стереотипа Subscribe. Стереотипа Subscribe используемые SharePoint для внешней системы знать, что отправитель запрашивает уведомлений об изменениях в базовые данные.

На рисунке 2 показано обмен информацией между SharePoint и внешней системы во время процесса подписки на.

Рис. 2. Поток процесса подписки

Последовательность операций метода подписки на внешние события

Ниже описаны общие поток в процедуре подписки.

Пользователь запрашивает подписки для уведомлений. Использование настраиваемого пользовательского интерфейса (кнопка на странице или ленты), SharePoint инициирует запрос на приложение внешней системе для уведомлений.
SharePoint создает адрес доставки. В ходе процесса подписки на SharePoint создает конечных точек REST, где доставки уведомлений.
К внешней системе отправляется запрос подписки. SharePoint инкапсулирует запросившей информации наряду с динамически созданные URL-адрес REST и отправляет веб-запрос к внешней системе.
Внешняя система получает запрос. Существуют разные возможности по внедрению хранилища подписок. В этом примере необходимо использовать таблицу базы данных SQL Server.
Внешняя система генерирует subscriptionId. Новые subscriptionId создается с помощью кода в приложении бизнес (LOB). subscriptionId должно быть идентификатором GUID.
Внешняя система записывает подписки. Приложение внешняя система записывает subscriptionId, адрес доставки, тип события и другие сведения, отправленные из SharePoint в хранилище данных подписки.
Внешняя система отправляет subscriptionId SharePoint. Для SharePoint для правильной маршрутизации обновлений, отправляемые с внешней системы subscriptionId отправляется SharePoint и SharePoint записывает эти данные в базе данных.

Модели BDC работает на импорт функции Subscribe. Метаданные для функции импорта показано в следующем примере.

<EntityType Name="EntitySubscribe">
   <Key>
      <PropertyRef Name="SubscriptionId" />
   </Key>
   <Property xmlns:p6="http://schemas.microsoft.com/ado/2009/02/edm/annotation"
             Name="SubscriptionId"
             Type="Edm.Int32"
             Nullable="false"
             p6:StoreGeneratedPattern="Identity" />
   <Property Name="EntityName"
             Type="Edm.String"
             MaxLength="250"
             FixedLength="false"
             Unicode="true" />
   <Property Name="DeliveryURL"
             Type="Edm.String"
             MaxLength="250"
             FixedLength="false"
             Unicode="true" />
   <Property Name="EventType" Type="Edm.Int32" />
   <Property Name="UserId"
             Type="Edm.String"
             MaxLength="50"
             FixedLength="false"
             Unicode="true" />
   <Property xmlns:p6="http://schemas.microsoft.com/ado/2009/02/edm/annotation"
             Name="SubscribeTime"
             Type="Edm.Binary"
             MaxLength="8"
             FixedLength="true"
             p6:StoreGeneratedPattern="Computed" />
   <Property Name="SelectColumns"
             Type="Edm.String"
             MaxLength="10"
             FixedLength="false"
             Unicode="true" />
</EntityType>

Ниже приведен пример модели BDC с помощью метода Subscribe добавлена.

<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>

В таблице 1 перечислены важные атрибуты модели BDC, необходимые для стереотипа Subscribe работы.

Таблица 1. Атрибуты модели BDC

Атрибут	Описание
IsDeliveryAddress	Флаг Boolean, используемый в TypeDescriptor указывает, является ли указанный адрес доставки для доставки уведомлений.
IsEventType	Логический флаг, используемый в TypeDescriptor для указания того, следует ли использовать указанный тип события в качестве типа события. Допустимые типы событий: ItemAdded, ItemUpdated, ItemDeleted и т. д.
SubscriptionIdName	Строка, используемая на TypeDescriptor, который представляет имя subscriptionId части.

Уведомления

В SharePoint улучшена инфраструктура обработки событий, позволяющая внешним источникам данных уведомлять SharePoint о том, что информация во внешней системе была изменена. Затем когда SharePoint получает уведомление, приемники событий, связанных с внешним списком SharePoint или сущности может выполнять код для выполнения указанного действия.

При создании подписки во внешней системе требуется способ сообщить SharePoint о изменений, внесенных в конкретной сущности. Предполагается, что во внешней системе доставки уведомлений на адрес доставки в соответствии с требованиями SharePoint к внешней системе во время процесса подписки на использование формате OData Atom полезных данных.

На рисунке 3 показаны поток обмена данными между внешней системы и SharePoint, при добавлении новой записи данных во внешней системе.

Процесс уведомления на рисунке 3

Процесс уведомления о внешних событиях

Новую запись добавляется к внешней системе. В этом примере новая запись добавляется к внешней системе, с помощью пользовательского интерфейса приложения или непосредственно в базе данных.
Внешней системы приложение получает уведомление об изменении. Приложение внешней системы имеет будут получать уведомления об изменениях, происходящих в базовые данные. Существует несколько способов это сделать. Можно использовать SQL триггеров, которые запускаются при изменении данных на отдельных таблиц или создать механизм опроса для запроса хранилища данных для изменения. Существуют другие способы выполнения этой задачи, но каждая будет иметь оценку с повышения производительности.
Внешняя система отправляет запрос уведомления SharePoint по адресу доставки. Для передачи изменений, запрос формате Atom должен отправляться на адрес доставки, который хранится в хранилище подписки бизнес-приложения.

Полезные данные уведомления

Создание уведомлений, бизнес-системы имеет для создания полезных данных HTTP, который включает в себя полные сведения изменения элемента или идентификатор изменения элемента.

Удостоверений: При отправке полезных данных как удостоверение, полезных данных должен иметь только сведения об идентификации измененный элемент. Например для клиента в сущности клиентов, полезные данные только будет содержать идентификатор клиента, который был изменен.
Полное элемента: В этом случае полезных данных это запись, который был изменен во внешней системе. В примере клиента включается запись всей измененных клиента.

Примечание.

[!Примечание] Все элементы поддерживается только при использовании соединитель OData.

Во время процесса подписки должен задаваться тип полезной нагрузки, отправляемого во внешней системе.

Ниже приведен пример свойства модели BDC, используемого для уведомлений.

<Property Name="NotificationParserType" Type="System.String">
   ODataEntryContentNotificationParser
</Property>

Если не указан, полезных данных по умолчанию является учетные данные.

Адрес доставки уведомлений (виртуальный адрес)

Процесс подписки, запущенного из результаты SharePoint в виртуального адреса, создаваемого с SharePoint, позволяя точки входа для внешней системы для регистрации уведомлений. Адрес доставки используется во внешней системе для отправки этих уведомлений. Адрес доставки также передается внешней системы во время запроса подписки.

EventUnsubscriber: удаление подписки в списке уведомлений

Операция Unsubscribe удаляет подписку в списке уведомлений.

На рисунке 4 показано, что метод UnSubscribe намного проще. Так как идентификатор подписки отправлено обратно в SharePoint и SharePoint записать его, все, что требуется отправить запрос отказа от подписки с идентификатором подписки на правильные.

На рисунке 4 потока кода для метода отказа от подписки

Процесс отмены подписки на внешние уведомления

Модели BDC для отказа от подписки

В следующем примере XML показано, как создать модели BDC, которая отменяет подписку из уведомления о событиях внешней системы.

<Method Name="UnSubscribeExpenseReport" DefaultDisplayName="ExpenseReport
    Unsubscribe">
    <Properties>
        <Property Name="ODataEntityUrl" Type="System.String">
            /Subscriptions(@ID)</Property>
        <Property Name="ODataHttpMethod" Type="System.String">DELETE</Property>
        <Property Name="ODataPayloadKind" Type="System.String">Property</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 Name="@ID" Direction="In">
            <TypeDescriptor Name="ID" TypeName="System.Int32">
                <Properties>
                    <Property Name="SubscriptionIdName" Type="System.String">ID</Property>
                </Properties>
                <Interpretation>
                    <ConvertType LOBType="System.Int32" BDCType="System.String" />
                </Interpretation>
            </TypeDescriptor>
        </Parameter>
    </Parameters>
    <MethodInstances>
        <MethodInstance Name="UnSubscribeExpenseReport" DefaultDisplayName="ExpenseReport
             Unsubscribe" Type="EventUnsubscriber" Default="true">
            <AccessControlList>
                <AccessControlEntry Principal="NT Authority\\Authenticated Users">
                    <Right BdcRight="Edit" />
                    <Right BdcRight="Execute" />
                    <Right BdcRight="SetPermissions" />
                    <Right BdcRight="SelectableInClients" />
                </AccessControlEntry>
            </AccessControlList>
        </MethodInstance>
    </MethodInstances>
</Method>

<Method IsStatic="false" Name="Unsubscribe">
    <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="subscriptionId">
            <TypeDescriptor TypeName="System.String" Name="subscriptionId"
                IsSubscriptionId="true" />
         </Parameter>
    </Parameters>
    <MethodInstances>
        <MethodInstance Type="EventUnsubscriber" Default="true" Name="Unsubscribe"
            DefaultDisplayName="UnSubscriber">
            <Properties>
                <Property Name="LastDesignedOfficeItemType" Type="System.String">None</Property>
            </Properties>
            <AccessControlList>
                <AccessControlEntry Principal=" NT AUTHORITY\\Authenticated Users ">
                    <Right BdcRight="Edit" />
                    <Right BdcRight="Execute" />
                    <Right BdcRight="SetPermissions" />
                    <Right BdcRight="SelectableInClients" />
                </AccessControlEntry>
            </AccessControlList>
        </MethodInstance>
    </MethodInstances>
</Method>

Пример кода: подключение к внешнему списку приемника событий

В следующем коде приведен пример того, как для подключения к внешнему списку приемника событий. После подключения, приемник событий прослушивание уведомлений из внешней системы о обновления, добавления и удаления, которые выполняются на исходные данные.

private static void AddEventReceiver(string siteUrl, string listTitle)
{
  string assembly = "SampleEventReceiver, Culture=neutral, Version=1.0.0.0,PublicKeyToken=1bfafa687d2e46a7";
  string className = "SampleEventReceiver.EntryContentEventReceiver";
  try
  {
    using (SPSite site = new SPSite(siteUrl))
    {
      using (SPWeb web = site.OpenWeb())
      {
        SPList list = web.Lists[listTitle];
        list.EventReceivers.Add(SPEventReceiverType.ItemAdded, assembly, className);
      }
    }
  }
  catch (Exception e)
  {
    Console.WriteLine(e);
  }
}

От простого к сложному: Дополнительные сведения об использовании приемников внешних событий

Дополнительные сведения о внешние события и оповещения содержатся в следующих разделах.

Табл. 2. Дополнительные понятия для работы с внешними приемниками событий

Статья	Описание
Как: создать службу данных OData для использования в качестве внешней системы BCS	Узнайте, как создать службу Windows Communication Foundation (WCF), которая использует OData для отправки уведомлений в SharePoint при изменении базовых данных. Эти уведомления используются для записи событий, присоединенных к внешним спискам.

Статья

Описание

Как: создать службу данных OData для использования в качестве внешней системы BCS

Узнайте, как создать службу Windows Communication Foundation (WCF), которая использует OData для отправки уведомлений в SharePoint при изменении базовых данных. Эти уведомления используются для записи событий, присоединенных к внешним спискам.

Поделиться через

Внешние события и оповещения в SharePoint

Что такое приемники событий?

Что такое удаленные приемники событий?

Какие функции и возможности нового инфраструктура приемника внешних событий предоставляет?

Необходимые условия для использования приемников событий для внешних списков

Настройка внешней системы для уведомления SharePoint внешние события

Настройка SharePoint для разрешения взаимодействия с внешними системами

Как включить внешние события

Общий поток внешние события между SharePoint и внешними системами

Уведомления

Полезные данные уведомления

Адрес доставки уведомлений (виртуальный адрес)

EventUnsubscriber: удаление подписки в списке уведомлений

Модели BDC для отказа от подписки

Пример кода: подключение к внешнему списку приемника событий

От простого к сложному: Дополнительные сведения об использовании приемников внешних событий

См. также

Дополнительные ресурсы

Поделиться через

Внешние события и оповещения в SharePoint

Что такое приемники событий?

Что такое удаленные приемники событий?

Какие функции и возможности нового инфраструктура приемника внешних событий предоставляет?

Необходимые условия для использования приемников событий для внешних списков

Настройка внешней системы для уведомления SharePoint внешние события

Настройка SharePoint для разрешения взаимодействия с внешними системами

Как включить внешние события

Общий поток внешние события между SharePoint и внешними системами

EventSubscriber: подписки на уведомления

Пример кода: модели BDC с подписки на

Уведомления

Полезные данные уведомления

Адрес доставки уведомлений (виртуальный адрес)

EventUnsubscriber: удаление подписки в списке уведомлений

Модели BDC для отказа от подписки

Пример кода: подключение к внешнему списку приемника событий

От простого к сложному: Дополнительные сведения об использовании приемников внешних событий

См. также

Дополнительные ресурсы