Надстройки SharePoint

Существует два основных типа надстроек SharePoint: надстройки, размещаемые в SharePoint, и надстройки, размещаемые у поставщика. Чтобы выбрать наиболее подходящий вариант для своего сценария, сначала узнайте, что общего у обоих типов надстроек SharePoint.

• Надстройка SharePoint — это автономный функциональный модуль, расширяющий возможности веб-сайтов SharePoint для решения определенной бизнес-задачи.
• Надстройки не содержат пользовательский код, выполняемый на серверах SharePoint. Вместо этого всю пользовательскую логику перемещают в облако, на клиентские компьютеры или на локальный сервер, который не входит в ферму SharePoint или в подписку SharePoint Online. Если пользовательский код находится за пределами серверов SharePoint, администраторы SharePoint могут быть уверены, что надстройка не причинит вреда их серверам и не снизит производительность веб-сайтов SharePoint Online.
• Бизнес-логика надстройки SharePoint может получить доступ к данным SharePoint через один из клиентских API в составе SharePoint. Какой API нужно использовать для своей надстройки, зависит от того, каким вы разработаете это приложение.
• Практически все основные типы компонентов SharePoint могут быть частью надстройки, в том числе страницы, списки, рабочие процессы, настраиваемые типы контента, шаблоны списков и веб-части.
• Веб-сайты SharePoint, на которых установлены надстройки SharePoint и на которых пользователи запускают эти надстройки, называют хост-сайтами. Компоненты SharePoint обычно находятся на отдельном дочернем сайте хост-сайта — сайте надстройки.
• Надстройки SharePoint можно разместить на веб-сайте SharePoint несколькими указанными ниже способами.
  • . Это иммерсивный полностраничный интерфейс , который может иметь внешний вид страницы SharePoint.
  • . В рамках веб-страницы используется специальный тип управления, называемый частью надстройки, для отображения элемента iframe, содержащего надстройку.
  • : как команды пользовательского интерфейса, расширяющие ленты и меню для списков , документов и т. д.
• Для всех надстроек SharePoint, устанавливаемых пользователями, предусмотрена плитка на странице "Содержимое сайта" веб-сайта SharePoint. Если щелкнуть плитку, запустится соответствующая надстройка.
• Для настройки надстройки SharePoint используется манифест надстройки, который представляет собой XML-файл, в котором объявлены базовые свойства надстройки, указано, где можно запускать ее и что нужно делать SharePoint при ее запуске. Кроме того, в манифесте можно указать языки, поддерживаемые надстройкой, службы и функции SharePoint, от которых она зависит, а также разрешения для хост-сайта, необходимые этой надстройке. (Надстройки SharePoint имеют полный контроль над своими сайтами надстроек.)
• Распространять надстройки SharePoint следует в пакетах надстроек, которые всегда включают по крайней мере манифест надстройки. (Если отсутствуют компоненты SharePoint, манифест надстройки может быть единственным элементом в пакете надстройки.) Если на сайте надстройки есть компоненты SharePoint, они включаются в пакет в виде набора XML-файлов. Удаленные компоненты, размещенные за пределами SharePoint (например, удаленные веб-приложения или базы данных), не входят в пакет и развертываются отдельно от пакета надстройки. (В этом случае необходимо указать URL-адреса удаленных компонентов в манифесте надстройки.)
• Кроме того, пакеты надстроек могут включать надстройки Office. При установке надстройки SharePoint надстройка Office добавляется в каталог надстроек Office в SharePoint. Пользователи могут установить надстройку из каталога в приложениях Office, например в Word или Excel.

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

Мы исключили изолированные решения, содержащие пользовательский серверный код. Мы все еще поддерживаем изолированные решения "без кода" и изолированные решения, содержащие только JavaScript.

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

Два способа распространения или продажи пакета надстройки

Вы можете распространять пакеты надстроек двумя указанными ниже способами.

• Через каталог надстроек организации, который представляет собой выделенное семейство веб-сайтов SharePoint в локальной ферме или в подписке на SharePoint Online. Этот метод используется, если надстройка разработана для конкретной организации.
• Через Магазин Office. В этом случае маркетинговые операции, связанные с обнаружением, покупкой и обновлениями, выполняет магазин, а не вы. Чтобы помочь вам продавать надстройки через Магазин Office, корпорация Майкрософт предоставляет Панель мониторинга продаж.

После развертывания надстройки одним из указанных способов она станет доступной для установки на странице добавления надстроек веб-сайтов SharePoint. Если надстройке требуются разрешения для хост-сайта или его родительской подписки, при установке этой надстройки SharePoint запросит у пользователя эти разрешения.

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

Два типа надстроек SharePoint (с размещением в SharePoint и у поставщика)

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

Надстройки с размещением в SharePoint почти целиком состоят из компонентов SharePoint на сайте надстройки. Иногда говорят, что их центр находится в SharePoint.

Как и любые другие надстройки SharePoint, надстройку, размещаемую в SharePoint, можно запустить с помощью плитки на странице Содержимое сайта веб-сайта SharePoint, на котором установлена надстройка. При необходимости у надстройки могут быть компоненты пользовательского интерфейса двух других типов на хост-сайте: веб-части надстройки и дополнительные действия (пользовательские кнопки ленты или элементы меню). Остальные компоненты надстройки, размещаемой в SharePoint, развертываются на сайте надстройки. Эти компоненты определяются в декларативном порядке с помощью XML-файлов и могут содержать указанные ниже элементы.

• Пользовательские страницы
• Рабочие процессы
• Модули (наборы файлов)
• Шаблоны списка
• Экземпляры списков и библиотек
• Настраиваемые формы и представления списков
• Настраиваемые типы контента
• Веб-шаблоны
• Встроенные столбцы (не настраиваемые столбцы)
• Встроенные веб-части (не настраиваемые веб-части)
• Файлы JavaScript
• Настраиваемые кнопки и элементы меню для сайта надстройки

Для всей бизнес-логики в надстройке, размещаемой в SharePoint, используется JavaScript: либо непосредственно на пользовательской странице, либо в файле JavaScript, на который указывает ссылка на пользовательской странице. Версия JavaScript объектной модели SharePoint (JSOM) создана, чтобы упростить выполнение операций создания, чтения, обновления и удаления (CRUD) данных SharePoint для надстройки.

Пользовательские страницы в надстройке, размещаемой в SharePoint, — это в основном страницы ASP.NET (ASPX-страницы), которые могут в декларативном порядке ссылаться на ASP.NET и встроенные элементы управления SharePoint, но не могут содержать код. Вы можете настроить элементы управления SharePoint, используя клиентскую обработку и настраиваемый JavaScript.

Код JavaScript в надстройках, размещаемых в SharePoint, может получать доступ к данным и ресурсам, находящимся за пределами сайта надстройки, с помощью любого из двух методов безопасного обхода политики одинаковых источников браузера: с использованием специальной междоменной библиотеки JavaScript или определенного класса WebProxy JavaScript. Эти методы позволяют надстройке, размещаемой в SharePoint, работать с данными на хост-сайте, в ее родительской подписке или в Интернете.

Надстройки SharePoint, размещаемые у поставщика

Любой компонент SharePoint, который можно использовать в надстройке, размещаемой в SharePoint, можно применять и в составе надстройки, размещаемой у поставщика. Эти два типа надстроек отличаются тем, что надстройки, размещаемые у поставщика, содержат по крайней мере один удаленный компонент (например, веб-приложение, службу или базу данных), размещенный за пределами фермы SharePoint или не входящий в подписку SharePoint Online. Это может быть сервер, находящийся в той же корпоративной сети, что и ферма SharePoint или облачная служба. Внешние компоненты могут размещаться в любом стеке веб-хостинга, включая стеки Linux, Apache, MySQL и PHP (LAMP).

Вы можете выбрать любую платформу для размещения удаленных компонентов. Необязательно использовать стек Майкрософт. Вы можете использовать любую платформу для веб-хостинга, в том числе LAMP (Linux, сервер Apache, MySQL, PHP), MEAN (MongoDB, ExpressJS, AngularJS, Nodejs), Java, Python и другие, а также сторонние средства разработки. Кроме того, удаленные компоненты можно разместить в сторонних облачных службах.

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

Удаленные данные могут быть большими двоичными объектами, кэшами, очередями сообщений, сетями доставки содержимого (CDN) и базами данных. Базы данных могут быть любого типа, включая реляционные и объектно-ориентированные. Доступ к удаленным данным можно получить различными способами. Например, можно использовать службы Business Connectivity Services (BCS) для отображения данных в списке SharePoint. Другой вариант — предоставление данных в сетке на странице удаленного веб-приложения.

Надстройки SharePoint используют API SharePoint для подключения и интеграции функций SharePoint поиска, рабочих процессов, социальных сетей, таксономии, профилей пользователей, BCS и не только. Это позволяет им считывать документы, выполнять поиск и операции CRUD, а также обеспечивать общение пользователей. Существует несколько наборов API:

• Если удаленные компоненты реализованы с помощью .NET, будет доступна библиотека клиентской объектной модели (CSOM) SharePoint для управляемого кода.
• Если удаленные компоненты созданы не на основе .NET, для них можно использовать набор REST API и API OData, который можно применять для доступа к данным SharePoint. Его также можно использовать в клиенте .NET, если вы предпочитаете работать с интерфейсом OData.
• Вам не удастся использовать упомянутую выше библиотеку JSOM на удаленной странице. Тем не менее надстройки, размещаемые у поставщика, могут содержать пользовательские страницы SharePoint на сайте надстройки, и в коде JavaScript этих страниц можно использовать библиотеку JSOM.

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

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

Выбор пути разработки решений для SharePoint

Готовы приступить к работе?

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

  Знакомство с созданием надстроек SharePoint с размещением в SharePoint

• Если вы опытный разработчик веб-приложений на базе ASP.NET, рекомендуем начать с надстроек, размещаемых у поставщика. Они создаются на основе веб-приложений.

  Знакомство с созданием надстроек SharePoint с размещением у поставщика

• Если вы хотите разработать надстройку, размещаемую у поставщика, в стеке, отличном от стека Майкрософт, выполните указанные ниже действия.

  • Установите средства, соответствующие используемому вами стеку (если их у вас еще нет).
  • Получите учетную запись разработчика в Office 365 для тестирования и отладки. Дополнительные сведения см. в статье Настройка среды разработки для надстроек SharePoint на Office 365. Если у вас уже есть подписка на Office 365, необходимо просто создать на ней сайт разработчика.
  • Для выполнения операций CRUD над данными в SharePoint ваша надстройка будет использовать REST API или API OData в SharePoint.
    • Разъяснения см. в статье Знакомство со службой REST SharePoint и в других статьях, на которые в ней есть ссылки.
    • Справочную документацию см. в статье Справочная документация REST API для SharePoint.
  • Если вы не используете Visual Studio, вам потребуется создать файл манифеста надстройки и пакет надстройки. Дополнительные сведения см. в статье Изучение структуры манифеста приложения и пакета надстройки SharePoint. Вы сэкономите много времени, если при создании манифеста и пакета вы будете использовать Visual Studio и "Инструменты разработчика Microsoft Office для Visual Studio". Рекомендуем иметь их в виду, даже если для создания удаленного веб-приложения вы используете другое средство. Выпуск Visual Studio Community Edition — бесплатный.
  • В разделе OfficeDev на GitHub есть примеры надстроек, размещаемых у поставщика, для ряда языков и платформ сторонних разработчиков. Пример: PHP-App-for-SharePoint.

См. также

• Глоссарий SharePoint