Преобразование изолированных решений в модель надстроек SharePoint
Преобразование изолированные решения в модель надстройки SharePoint включает анализ существующих расширений, разработку и проектирование вашей новой надстройки SharePoint, а затем тестирование и развертывание вашей надстройки в рабочей среде.
Примечание.
Изолированные решения на основе кода устарели в 2014 году. Процесс полного удаления этой возможности начался с SharePoint Online. Изолированные решения на основе кода также не рекомендуются к использованию в SharePoint 2013 и SharePoint 2016.
Изолированные решения, основанные на коде, в SharePoint Online
Изолированные решения - это настраиваемые пакеты, которые могут использоваться для развертывания настроек в SharePoint на уровне семейства веб-сайтов. Если изолированное решение содержит код, оно выполнялось в рамках специального изолированного процесс с определенным набором интерфейсов API для доступа к службам SharePoint и содержимому.
Существует два типа изолированных решений:
- Основанные на коде изолированные решения, которые содержат настраиваемую сборку в пакете.
- Декларативные изолированные решения, которые содержат только конфигурации на основе XML и связанные активы.
Декларативные (на основе XML) изолированные решения можно дополнительно разбить на следующие типы согласно вариантам их использования:
- Шаблон сайта — создается с помощью функции «Сохранить сайт как шаблон» на основе существующего сайта.
- Пакет конструктора — создается с помощью функции "Дизайнер" (Design Manager) на базе сайта публикации.
- Настраиваемые изолированные решения — создаются в Visual Studio, например, для применения фирменной символики для активов и не содержат сборки.
Изолированные решения на основе кода можно дополнительно разбить на следующие типы согласно вариантам их использования:
- Декларативное изолированное решение с пустой сборкой
- Изолированное решение с формой InfoPath и кодом
- Изолированные, основанные на коде решения с такими настраиваемыми параметрами как веб-части, приемники событий, и/или функции приемников
- Изолированные решения с настраиваемым действием рабочего процесса
Если вы планируете отказаться от изолированных решений, вам следует оценить функциональные и рабочие требования для определенных решений и определить будущие направления проектирования на основе этих данных.
Планирование процесса преобразования
При преобразовании изолированных решений в модель надстройки SharePoint, необходимо убедиться, что влияние на ваших пользователей будет минимальным. Выполните тщательный анализ текущих изолированных решений, а потом создайте вашу новую надстройку SharePoint в соответствии с потребностями вашей организации. Мы рекомендуем использовать указанную ниже процедуру, чтобы гарантировать успешное преобразование.
Готовность
Дополнительные сведения:
- Модель надстройки SharePoint, различные виды надстроек и параметры размещения. Дополнительные сведения см. в разделах Надстройки SharePoint и разработка Office 365 и Руководство по решению SharePoint PnP.
Оценка решения
Анализ функциональных и рабочих требований:
Определите развернутые изолированные решения в вашу среду, для которых вы можете использовать указанные ниже средства, предоставляемые как открытый источник командой SharePoint PnP:
- Сканер изолированных решений SharePoint или видео: инструмент, предлагающий различные варианты и подробные описания.
- Сценарий описи определенных изолированных решений: сценарий PowerShell, который позволяет сформировать базовую опись.
Проверка требований с вашими пользователями. Попросите пользователей продемонстрировать, как они используют существующие изолированные решения для выполнения своей повседневной работы.
Определение, документальное оформление и разработка новых функций, предназначенных для включения в новую надстройку SharePoint. Вы можете использовать список запросов новых функций от ваших пользователей в качестве дополнительного источника идей.
Определение не использовавшихся ранее функций и согласование с пользователями отказа от включения этих функций в новую надстройку SharePoint.
Для каждого решения определите, следует ли заменить его надстройкой SharePoint или реализовать ее с помощью встроенных возможностей или альтернативного решения.
Планирование решения
Разработка нового приложения с помощью модели надстройки SharePoint на основе:
Требований, собранных на этапе оценки решения.
Ваш анализ существующего кода. Во время анализа кода мы рекомендуем определить части кода, которые можно опустить (например, код, который больше не используется, код, не отвечающий изменившимся требованиям).
Разработка и проверка версии модели надстройки SharePoint вашего приложения
Обычно это наиболее значительный по затратам времени этап процесса преобразования.
Развертывание новой надстройки
Необходимо убедиться, что развертывание стабильно, и отправить необходимые сообщения вашим пользователям.
Замена пользовательских настроек изолированного решения
Ниже приведены примеры стандартных пользовательских настроек, которые входят в изолированные решения, и возможные варианты преобразования. Мы планируем добавить дополнительные сведения для каждого из типов настройки, чтобы у вас были практические примеры вариантов преобразования.
Настройка | Варианты преобразования |
---|---|
Декларативное решение с пустой сборкой | Вы можете управлять созданием сборки с помощью свойств проекта решения Visual Studio. Дополнительные сведения см. в статье Удаление ссылки на сборку из изолированного решения, созданного в среде Visual Studio Внимание: при использовании сканера изолированного решения SharePoint, вывод сканера содержит список решений, которые имеют пустую сборку, а инструмент создает обновленные пакеты изолированного решения для вас, где сборка будет отсутствовать. Затем вы можете просто заменить существующее изолированное решение на обновленное. |
Форма InfoPath с кодом | Если вы публикуете форму InfoPath из клиента InfoPath, которая содержит код, фактически выполняется публикация в SharePoint в качестве изолированного решения. Это означает, что код формы фактически выполняется модулем "песочницы" в SharePoint. Отказ от форм InfoPath, основанных на коде, зависит от варианта использования. Существует несколько вариантов, начиная с создания специального интерфейса пользователя в качестве надстроек и заканчивая использованием других форм. Дополнительные сведения см. в статье Исправление InfoPath в изолированных решениях. |
Веб-часть | Веб-части обычно преобразуются либо в части надстройки, либо они внедряются полностью с помощью клиентских возможностей с помощью шаблона внедрения JavaScript. Дополнительные сведения см. в разделе: |
Визуальная веб-часть | Визуальные веб-части преобразуются тем же образом, что и обычные веб-части. Необходимо заменить пользовательские элементы управления, используемые в визуальных веб-частях, поскольку в случае изолированных решений, они входят в состав сборки. |
Приемник событий | Приемники событий во многих случаях следует заменять на удаленные приемники событий. Удаленные приемники событий, тем не менее, нужно размещать на определенной платформе, обычно, это определенные, размещенные у поставщика надстройки. Дополнительные сведения см. в разделе: |
Приемник функций | Приемники функций обычно заменяются удаленной API на базе операций, например, с помощью CSOM или REST для применения необходимых настроек или конфигурации на уровне сайта. Если необходимые API отсутствуют в удаленных API (CSOM/REST), сообщите об этом с помощью SharePoint UserVoice. Приемники функций используются, например, для установки пользовательской главной страницы или темы на сайт, когда они включены. Такие операции можно легко заменить с помощью удаленных решений, основанных на коде, или с помощью PnP PowerShell с удобными командами для контроля конфигурации сайта. |
Настраиваемое действие рабочего процесса | Типичный путь миграции кода для данных типов настройки состоит в использовании рабочих процессов SharePoint или альтернативных решений, например, Microsoft Flow или сторонние решения. |
Удаление кода «песочницы» с сайта
При отключении существующего изолированного решения на ваших веб-сайтах, все активы или файлы, которые развернуты с помощью декларативных параметров, не удаляются. Если вы использовали изолированные решения для включения новых основанных на коде веб-частей, эти функции будут отключены на веб-сайтах. Это означает, что страницы будут по-прежнему отображаться нормально, поэтому это не повлияет на опыт конечного пользователя, когда решение будет отключено, за исключением удаления функций, основанных на коде, таких как веб-части.
Удаление поддержки основанных на коде изолированных решений
Поддержка основанных на коде изолированных решений будет удалена из SharePoint Online путем отключения операций, основанных на коде, которые выполняются из изолированных решений на основе кода. Это означает, что изолированные решения не отключаются явным образом в магазине решения, но больше не будут выполняться любые операции, основанные на коде. Изолированные решения останутся в активированном состоянии в каталоге решения. Функции, развернутые с помощью изолированных решений, не будут отключаться автоматически, что значит, что возможный код, связанный с отключенной функцией, или обработчик удаления, не будут работать.
Все декларативные определения в изолированном решении будут продолжать работу после того, как это изменение вступит в силу в SharePoint Online.
Содержание
- Замена веб-частей
- Замена приемников событий
- Замена приемников функций
- Исправление основанных на коде форм InfoPath