Обновление надстроек SharePoint
Вы можете обновить свою надстройку SharePoint, используя встроенную в SharePoint систему обновления. В течение 24 часов после отправки обновленной версии надстройки в каталог надстроек организации или приема надстройки в Магазин Office рядом с надстройкой на странице Контент сайта каждого веб-сайта, на котором она установлена, появится уведомление о доступном обновлении. Как видно на рисунке 1, пользователи могут немедленно установить обновление по предоставленной ссылке.
Рис. 1. Процесс обновления надстройки SharePoint
Пользователь может установить обновление, не удаляя предыдущую версию. Инфраструктура обновления проверяет установку обновления и выполняет ее откат в случае каких-либо ошибок.
Важно!
С помощью системы обновления нельзя изменить тип надстройки. Например, надстройку с размещением в SharePoint невозможно преобразовать в надстройку с размещением у поставщика. Чтобы изменить тип, необходимо перенести данные из старой надстройки в новую. В частности, так как программа тестирования надстроек с автоматически размещением закрыта, надстройку с автоматически размещением нельзя обновить до надстройки с размещением у поставщика. Преобразуйте надстройку SharePoint согласно инструкциям в этой статье.
Необходимые условия для обновления надстройки SharePoint
Для обновления надстройки SharePoint необходимы вот какие компоненты:
Тестовая установка SharePoint, которая поддерживает изоляцию. Инструкции по настройке Сайта разработчика Office 365 см. в статье Настройка среды для разработки надстроек SharePoint в Office 365.
Инструменты, используемые для создания надстройки SharePoint, которые, как правило, также используются для ее обновления. Например, для создания надстроек SharePoint многие разработчики используют Visual Studio и Инструменты разработчика Microsoft Office для Visual Studio.
Основные понятия, касающиеся обновления надстройки SharePoint
Прежде чем обновлять надстройку, ознакомьтесь с понятиями в приведенной ниже таблице.
Название статьи | Описание |
---|---|
Выбор шаблонов для разработки и размещения надстройки SharePoint | Сведения о различных типах надстроек SharePoint. Процесс обновления для разных типов отличается. |
Процесс обновления надстроек SharePoint | Описание процесса обновления надстроек SharePoint. |
Обновление компонентов | Узнайте, как обновлять компоненты (пакет SDK SharePoint 2010). |
Развертывание и установка надстроек SharePoint: методы и параметры | Сведения о методах публикации, установки и удаления надстроек SharePoint. |
Обработка событий в надстройках SharePoint | Сведения о приемниках удаленных событий в SharePoint. |
Основные шаги по обновлению надстройки
Ниже описаны основные шаги по созданию обновления для надстройки SharePoint. Каждый шаг подробно описан в разделах или статьях, на которые указывают ссылки. Не все они являются обязательными в каждом проекте обновления. Необходимые действия зависят от того, какие компоненты уже содержатся в надстройке, а какие нужно добавить. Обязательными являются только действия, отмеченные знаком **
.
Обновите манифест надстройки.
**
Увеличьте номер Version в элементе App файла appmanifest.xml (в первом выпуске схемы надстройки назывались "приложениями"). Не изменяйте номер ProductID.Измените раздел AppPermissionRequests файла appmanifest.xml.
Измените раздел AppPrerequisites файла appmanifest.xml.
Дополнительные сведения см. в разделе Обновление версии надстройки, запросов разрешений и необходимых условий.
Добавьте или обновите разметку для компонентов сайта надстройки. Дополнительные сведения см. в статье Обновление компонентов сайта с надстройкой в SharePoint.
Добавьте или обновите разметку для компонентов хост-сайта. Дополнительные сведения см. в статье Обновление компонентов хост-сайта с надстройкой в SharePoint.
Добавьте пользовательскую логику в UpgradedEventEndpoint и зарегистрируйте ее в файле appmanifest.xml. Дополнительные сведения см. в статье Создание обработчика для события обновления надстройки SharePoint.
Обновите удаленные компоненты.
- Для надстройки с размещением у поставщика обновите удаленные компоненты с помощью методов, соответствующих платформам, которые используются для размещения.
Дополнительные сведения см. в статье Обновление удаленных компонентов в надстройках SharePoint.
**
Отправьте пакет надстройки в Магазин Office или каталог надстроек организации.
Рекомендации по обновлению надстроек
В следующих разделах рассматриваются процедуры, которым нужно следовать, и важные вопросы, на которые следует обратить внимание при планировании обновления.
Решите, действительно ли нужно обновление
Улучшить надстройку SharePoint с размещением у поставщика можно и без обновления. Если изменения касаются только удаленных компонентов и не должны отражаться в компонентах SharePoint, можно изменить удаленные компоненты, не обновляя надстройку. Если URL-адреса и строки, используемые компонентами SharePoint для доступа к удаленным компонентам, не изменяются, надстройка SharePoint продолжает работать.
Допустим, вы добавили кнопку в удаленное веб-приложение, которая считывает столбец из нового списка SharePoint. Если столбец уже существует в списке, вам не нужно ничего менять в SharePoint. Вы можете отправить измененную веб-страницу, измененный код или данные JavaScript в удаленное веб-приложение. Новые функции мгновенно станут доступны пользователям при запуске надстройки SharePoint.
Помните, что обновление не является обязательным для пользователей
Когда новая версия надстройки SharePoint становится доступна в Магазине Office или каталоге надстроек организации, на плитке надстройки на странице Контент сайта появляется сообщение о доступном обновлении. Оно появляется в течение 24 часов. Но обновление не является обязательным. Поэтому изменения, которые вы вносите в удаленные компоненты, не должны нарушать работу предыдущих версий надстройки. Общее, но не универсальное, правило гласит: добавляйте новые элементы в удаленные компоненты, но не удаляйте, не переименовывайте, не перемещайте и не изменяйте схему, строку подключения или URL-адрес существующего компонента.
Если удаленному компоненту нужна версия экземпляра надстройки, который его вызывает, вы можете отправить эти сведения из SharePoint. Например, можно добавить версию надстройки как параметр запроса в URL-адресе начальной страницы приложения.
Создайте и отладьте новую версию, как будто это новая надстройка
Следует отделять разработку и отладку новой версии надстройки от отладки разметки и логики обновления. Для этого удалите предыдущую версию надстройки из тестового сайта SharePoint для разработки. Сохраните резервную копию файла пакета надстройки для предыдущей версии. Необходимым образом добавьте и измените компоненты надстройки, а затем проверьте и отладьте их с использованием тестового сайта, как будто это новая надстройка, созданная с нуля.
Протестируйте обновление с каждой предыдущей версией надстройки
Когда новая версия надстройки будет правильно работать как "новая" надстройка, измените код и разметку так, чтобы проект представлял собой обновление старой надстройки. Например, увеличьте номер версии надстройки, как указано в разделе Основные шаги по обновлению надстройки. Дополнительные сведения о преобразовании проекта в обновление см. в разделах этой статьи.
Когда вы будете готовы проверить свое обновление, уберите новую версию с тестового сайта и повторно разверните предыдущую версию, чтобы проверить логику обновления. Если существует несколько предыдущих версий надстройки, установите каждую из них на отдельный дочерний веб-сайт тестового сайта. Затем отправьте последнюю версию надстройки в каталог надстроек тестового сайта и обновите каждый экземпляр надстройки. Убедитесь, что каждый из них имеет последний номер версии и новейшие версии всех компонентов. Если в надстройке используется сайт надстройки, убедитесь, что его компоненты развернуты в соответствии с процедурой, описанной в разделе Проверка развертывания веб-компонентов надстройки.
Обновите надстройку раньше чем через 24 часа
Разрабатывая обновление для надстройки на тестовом сайте SharePoint, нет смысла ждать 24 часа между обновлениями. Вы (и пользователи производственного сайта SharePoint) можете обновить надстройку сразу после ее отправки в Магазин Office или каталог надстроек организации. Для этого выполните указанные ниже действия.
Немедленное обновление надстройки
Отправив последнее обновление в каталог надстроек, откройте страницу Контент сайта на веб-сайте, на котором установлена надстройка, и нажмите кнопку ... на плитке надстройки.
В появившейся выноске выберите вкладку О программе. На открывшейся странице О программе отобразится сообщение о доступности новой версии.
Нажмите кнопку Получить. Снова откроется страница Контент сайта, а на плитке надстройки появится сообщение о текущем обновлении надстройки.
Эти действия показаны на рисунке 2.
Рис. 2. Процесс мгновенного обновления надстройки SharePoint
Примечание.
Чтобы сообщение о доступности обновления на плитке надстройки отображалось чаще, чем каждые 24 часа, вы можете использовать метод, описанный в статье Процесс обновления надстройки SharePoint, чтобы оно появлялось мгновенно.
Обновление версии надстройки, запросов разрешений и необходимых условий
Создав резервную копию папки проекта Visual Studio, откройте проект надстройки. Откройте манифест надстройки и на вкладке Общие конструктора манифеста увеличьте номер версии.
Если обновленной версии надстройки требуется больше (или меньше) разрешений для компонентов хост-сайта, внесите необходимые изменения в разделе надстройки AppPermissionRequests. В Visual Studio откройте вкладку Разрешения конструктора манифеста.
После обновления надстройки пользователю всегда предлагается предоставить разрешения, независимо от того, изменились ли они по сравнению с предыдущей версией. Если в новой версии требуется меньше разрешений по сравнению с предыдущей, дополнительные разрешения не отзываются. Единственный способ ограничить надстройку разрешениями последней версии — открыть страницу {SharePointDomain}/_layouts/15/appinv.aspx
после обновления надстройки, а затем вручную ввести разметку разрешений, соответствующую схеме AppPermissionRequests .
Если обновленной версии надстройки требуются определенные компоненты, которых не было в предыдущей версии (или отсутствуют компоненты, которые были в предыдущей версии), внесите необходимые изменения в разделе надстройки AppPrerequisites. В Visual Studio откройте вкладку Необходимые компоненты в конструкторе манифеста.
Дальнейшие действия
Перейдите к следующему пункту в разделе Основные шаги по обновлению надстройки или непосредственно к одной из следующих статей:
- Обновление компонентов сайта надстройки в SharePoint
- Обновление компонентов хост-сайта в SharePoint
- Создание обработчика событий обновления в надстройках SharePoint
- Обновление удаленных компонентов в надстройках SharePoint