Модели интеграции с партнерами
Хотя невозможно дополнить содержимое схем обучения Microsoft 365 напрямую из службы подготовки SharePoint Online, существует несколько моделей интеграции, которые партнеры могут использовать для создания согласованных предложений услуг с добавлением значений. Описанные выше модели интеграции партнеров представлены в порядке возрастания сложности и уровней инвестиций. Поэтому мы ведите обучение и переход на более сложные уровни на основе бизнес-моделей.
Как приступить к работе?
Чтобы приступить к работе, ознакомьтесь с рекомендациями.
1. Начните с создания опыта в качестве средства включения.
Вы можете сразу же помочь в работе с клиентской базой, включив портал обучения для путей обучения и выполнив целевую проверку содержимого Корпорации Майкрософт. Инструкции по подготовке схем обучения см. в разделе "Подготовка нового решения схем обучения".
2. Затем расширение служб в качестве интегратора
Выполнив возврат автоматизации при анализе инвестиций в зависимости от количества содержимого и (или) потребностей в интеграции служб. Например, не имеет смысла взять на себя затраты на разработку и эксплуатацию в соответствии с нашими рекомендациями по интеграции содержимого, если вы можете быстро вручную создать целевые настраиваемые списки воспроизведения, указывающие на ваше содержимое с оплатой или ссылаться на ваши службы.
3. Когда имеет смысл рентабельность инвестиций, рассмотрите возможность распространения
Когда целесообразно получить рентабельность инвестиций, рассмотрите возможность повторного распространения (или работа с соответствующими партнерами схем обучения) для создания переупаковаемых решений. Они основаны на платформе шаблонов и методик SharePoint, которая предоставляет решения для извлечения настраиваемых сайтов и их развертывания в клиентских средах.
Рекомендации по интеграции содержимого, предоставляемые партнером
Содержимое схем обучения Microsoft 365 управляется набором файлов JSON, которые выступают в качестве манифестов содержимого для вашего пакета обучения. Существует три файла: metadata.json, playlists.json и assets.json. Эти файлы должны быть структурированы в соответствии с моделями, которые распознает веб-часть, а затем размещены из сети доставки содержимого (CDN), чтобы разрешить веб-части загружать их. Корпорация Майкрософт предоставит начальные шаблоны этих файлов, чтобы начать работу.
Отказ от ответственности: структура JSON-файла может быть изменена в зависимости от предстоящих работ по решению. Партнер программы ранних последователей (EAP) схем обучения Microsoft 365 будет получать уведомления о любых изменениях этого характера. Наряду с любым клиентом обеспечивает обратную совместимость и /или руководство по переходу.
Скачивание решения схем обучения Microsoft 365
Вы можете скачать решение схем обучения Microsoft 365 вместе с файлами JSON из репозитория GitHub: https://github.com/pnp/custom-learning-office-365 Обратите внимание, что в данный момент корпорация Майкрософт не выполняет запрос на вытягивание GitHub для решения. Но вы можете использовать файлы GitHub в качестве отправной точки для создания собственного пользовательского пакета содержимого.
Структура Metadata.json
Этот файл можно рассматривать как мозг меню и структуры. Он содержит всю структуру навигации, а также списки выбора данных в двух других файлах.
| Имя | Описание |
|---|---|
| Технологии | Содержимое помечается тегом и может быть скрыто в зависимости от назначенной технологии. |
| Id | GUID, представляющий технологию |
| Имя | Отображаемое имя технологии |
| Субъекты[ ] | Массив субъектов, которые являются подмножеством технологии |
| Id | GUID, представляющий тему |
| Имя | Отображаемое имя субъекта |
| Категории [ ] | Категории информируют о навигации веб-части. Каждая категория представляет верхний уровень навигации |
| Id | GUID, представляющий категорию или подкатегорию |
| Имя | Отображаемое имя категории или подкатегории |
| Image | URL-адрес изображения, которое должно отображаться в пользовательском интерфейсе (относительно базы CDN) |
| TechnologyId | ИДЕНТИФИКАТОР GUID технологии, с данным содержимым (необязательно — пустая строка) |
| SubjectId | GUID субъекта, с данным содержимым связан (необязательно — пустая строка) |
| Source | В исходном массиве, который не используется в пользовательском интерфейсе, кроме пользовательских данных, добавленных пользователем, помечается как "Клиент", а область администрирования пользовательского интерфейса не разрешает редактирование каких-либо элементов, не помеченных как "Tenant". |
| Подкатегории[ ] | Sub-Categories по сути это уровень навигации от уровня 2 вниз. Структура совпадает с только что вложенной категорией. |
| Аудитории [ ] | Если списки воспроизведения, связанные с категорией или подкатегорией, имеют разные аудитории с тегами, будет доступен выбор для отображения доступных аудиторий. |
| Id | GUID аудитории |
| Имя | Отображаемое имя аудитории |
| Источники [ ] | Массив строк, которые помечаются содержимым с его источником, не используется специально в пользовательском интерфейсе, кроме пользовательских данных, добавленных пользователем, помечен как "Клиент", а область администрирования пользовательского интерфейса не позволяет редактировать что-либо, не помеченное "Клиент". |
| Уровни [ ] | Если списки воспроизведения, связанные с категорией или подкатегорией, помечены различными уровнями, будет доступен выбор для отображения доступных уровней. |
| Id | GUID уровня |
| Имя | Отображаемое имя уровня |
| StatusTag [ ] | Тег состояния предназначен для идентификации содержимого с различным состоянием, которое будет предоставлено в пользовательском интерфейсе. Некоторые из этих флагов будут отображаться для потребителя, а некоторые — только для администратора. |
| Id | GUID of the StatugTag |
| Имя | Отображаемое имя StatusTag |
| Телеметрия [ ] | |
| AppInsightsKey | GUID ключа аналитики приложений, настроенного для отслеживания загрузки веб-части средства просмотра. Отслеживание может быть отключено администратором для всего клиента, но отправленные сведения — это анонимный пользователь с идентификатором клиента. Дополнительные сведения см. в этом разделе https://github.com/pnp/custom-learning-office-365#disabling-telemetry-collection |
| Версия | Сведения о версии используются решением, чтобы указать администраторам, что веб-часть обновлена, а также разрешить веб-части самостоятельно обновлять пользовательское содержимое до последней версии манифеста, если были внесены значительные изменения. |
| Манифест | Версия манифеста |
| ManifestMinWebPart | Минимальная версия веб-части, которая работает с версией манифеста |
| CurrentWebPart | URL-адрес изображения, которое должно отображаться в пользовательском интерфейсе (относительно базы CDN) |
| Репозиторий | URL-адрес репозитория, в котором находятся инструкции по обновлению веб-части. |
| Пакеты содержимого | В настоящее время пакеты содержимого для дополнительных CDN не поддерживаются. Пакеты содержимого позволяют корпорации Майкрософт предлагать другие решения, созданные корпорацией Майкрософт, которые можно подготовить с помощью службы подготовки, которые используют M365LP для доставки содержимого и находятся в пользовательских CDN. |
| Id | GUID пакета содержимого или CDN |
| Имя | Отображаемое имя CDN |
| Описание | Описание, отображаемое в пользовательском интерфейсе для добавления пакета содержимого |
| Image | Изображение, отображаемое в пользовательском интерфейсе для добавления пакета содержимого |
| ProvisionURL | URL-адрес пакета службы подготовки для создания семейства веб-сайтов пакета содержимого |
| CDNbase | Базовый URL-адрес манифестов для пакета содержимого |
| AssetOrigins | Массив источников URL-адресов, используемых в файле assets.json, описанном далее. Если URL-адрес источника поддерживается, в help_getClientHeight. Ответ в свойстве данных "help_getClientHeight={высота содержимого}" (например, "help_getClientHeight=5769") позволяет изменить размер iFrame до соответствующей высоты фрейма содержимого. |
Структура Playlists.json
playlists.json — манифест списков воспроизведения представляет собой массив объектов, описывающих метаданные о списке воспроизведения и ресурсах, включенных в список воспроизведения.
| Имя | Описание |
|---|---|
| Id | GUID, представляющий список воспроизведения |
| Название | Отображаемое имя списка воспроизведения |
| Image | Относительный URL-адрес (из CDN) к изображению для визуализации списка воспроизведения |
| LevelId | Связанный уровень |
| AudienceId | Связанная аудитория |
| TechnologyId | Связанная технология |
| SubjectId | Отображаемое имя категории или подкатегории |
| Source | В исходном массиве, который не используется в пользовательском интерфейсе, кроме пользовательских данных, добавленных пользователем, помечается как "Клиент", а область администрирования пользовательского интерфейса не разрешает редактирование каких-либо элементов, не помеченных как "Tenant". |
| CatId | Идентификатор категории или подкатегории, представляющий контейнер, в котором должен отображаться список воспроизведения. В настоящее время манифест не поддерживает выбор категории или подкатегории в качестве контейнера, если у него также есть дочерние элементы SubCategory. |
| Описание | Описание каждого списка воспроизведения в пользовательском интерфейсе |
| StatusTagId | Связанный тег состояния |
| StatusNote | Заметки о содержимом, отображаемом администраторам |
| Активы[] | Массив идентификаторов GUID для ресурсов, которые являются частью этого списка воспроизведения, в порядке отображения. |
Структура Asset.json
playlists.json — манифест списков воспроизведения представляет собой массив объектов, описывающих метаданные о списке воспроизведения и ресурсах, включенных в список воспроизведения.
| Имя | Описание |
|---|---|
| Id | GUID, представляющий список воспроизведения |
| Название | Отображаемое имя списка воспроизведения |
| Описание | --- |
| URL-адрес | URL-адрес источника для ресурса, который будет применен к iFrame. |
| TechnologyId | Связанная технология |
| SubjectId | Связанная тема |
| Source | Отображаемое имя категории или подкатегории |
| StatusTagId | Связанный тег состояния |
| StatusNote | Заметки о содержимом, отображаемом администраторам. |
Кэширование
Текущая версия веб-части средства просмотра использует кэшированную версию файлов манифеста в течение 24 часов. По истечении 24 часов первый пользователь, на которого нажата веб-часть, получает сведения о производительности, чтобы обновить кэш, скачав манифесты из исходной сети CDN и объединив эти сведения со скрытыми технологиями и списками воспроизведения, а также объединив пользовательские подкатали, списки воспроизведения и ресурсы. Кроме того, веб-часть администрирования всегда скачивает содержимое из манифестов, объединяет их и обновляет кэш. Таким образом, иными словами, администратор может принудительно обновить кэш в любое время, загрузив веб-часть администратора, т. е. перейдя на страницу администрирования.
Рекомендации по пакету содержимого
Функция пакета содержимого разблокирует следующие сценарии:
- Возможность для партнеров распространять настраиваемое пользовательское содержимое обучения с добавленной ценностью, адаптированное для среды клиентов
- Возможность для организаций с надежной командой обучения и ИТ-поддержкой создавать настраиваемое содержимое для обучения, направленное на их собственные внутренние системы и систему управления.
- Возможность корпорации Майкрософт предоставлять дополнительные схемы обучения в будущем, в которых клиенты могут принять участие.
Этот текущий набор документации намеренно предназначен для партнеров из-за сложности функции. Команда обслуживания активно работает над улучшением поддержки и включением сценария 2 в будущем.
Как работают пакеты содержимого
Корпорация Майкрософт использует страницы GitHub в качестве источника сети доставки содержимого (CDN) для файлов манифестов и изображений. В корне репозитория GitHub есть папка документации, которая включает вложенные папки для каждой версии файлов манифеста. В каждой папке есть три файла манифеста, а также папка изображений для хранения всех изображений категории, подкатегории и списка воспроизведения.
Важно поддерживать ту же структуру управления версиями, что и корпорация Майкрософт, если вы решили расширить решение схем обучения с помощью собственного пакета содержимого. Конечная точка CDN не должна включать папку версии, так как поддерживаемая веб-частью версия манифеста добавляется в нее и автоматически добавляется к URL-адресу CDN. Очевидно, что у вас будет время на создание новых экземпляров файлов манифеста при каждом его исправлении.
Дополнительные сведения об использовании страниц GitHub в качестве источника CDN см. в следующей справочной документации. https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages
Решение Майкрософт делает сведения о ресурсах открытыми, так как нет безопасности для пользователей, имеющих доступ к этим файлам. Мы считаем, что для потребителя должен быть бесплатный уровень содержимого, который означает, что при необходимости оплаты содержимого вам потребуется реализовать его по-разному в рамках технических ограничений решения, и использование страниц GitHub не является требованием. Любой поставщик CDN, который вы хотите использовать, в порядке, если вы поддерживаете структуру нумерации версий, которую мы определили. Как упоминалось ранее, версия структуры манифеста, поддерживаемая веб-частью, добавляется в код и автоматически добавляется к URL-адресу CDN.
Руководство по интеграции пакета содержимого
Веб-части администратора и средства просмотра были расширены, чтобы позволить потребителю настраивать дополнительные конечные точки CDN в своем клиенте, что позволит веб-части средства просмотра выбрать cdN, который должен быть источником отображаемых данных.
Кадрирование ключей для этой функции следует учитывать:
- Это основное применимо для сценариев распространения партнеров, где настройка списка воспроизведения вручную слишком громоздка
- Пользовательские пакеты содержимого — это расширенная функция, которая должна использоваться только партнерами с опытом администрирования веб-содержимого. Ненадежные источники контента могут привести к небезопасному содержимому на сайте. Следует добавлять только источники, которые вы доверяете.
ВАЖНО Перед добавлением пользовательского пакета содержимого необходимо подготовить схемы обучения Microsoft 365 3.0 или более поздней версии. Сведения о подготовке схем обучения Microsoft 365 см. в разделе "Подготовка схем обучения Microsoft 365".
Надежность содержимого
Как партнер вы несете ответственность за то, чтобы помочь потребителям обеспечить надежную отрисовку содержимого в их среде. Мы рекомендуем создать тестовый сценарий в их среде, чтобы проверить, может ли содержимое быть iFrame на странице SharePoint внутри брандмауэра. Следуйте инструкциям по созданию страниц SharePoint для пользовательских списков воспроизведения, чтобы убедиться, что это так.
Добавление пакета содержимого в схемы обучения
После создания измененного JSON-файла и определения сети CDN можно добавить пакет контактов в схемы обучения.
- На домашней странице сайта схем обучения наведите указатель мыши на домашнюю страницу и щелкните "Администрирование схем обучения".
- На странице "Администрирование " щелкните ... Добавьте пакет содержимого в правом верхнем углу страницы.
- Щелкните "Пользовательский пакет содержимого", а затем введите имя пакета содержимого, а затем укажите CDN, в котором находятся JSON-файлы.
- Щелкните Сохранить. Содержимое пользовательского пакета содержимого теперь должно отображаться на странице администрирования. Пример:
Фильтрация по пакету содержимого в веб-части
С помощью схем обучения можно добавить веб-часть схем обучения на страницу, отфильтровать веб-часть так, чтобы она указывала на источник пользовательского пакета содержимого, а затем отфильтровать веб-часть по нужной категории, подкатегории, списку воспроизведения и ресурсу.
- На сайте схем обучения щелкните " Создать" и "Страница ".
- Нажмите кнопку "Пустая", а затем создайте страницу.
- Присвойте странице имя.
- Щелкните "+ Добавить новый раздел" в левой части страницы.
- Щелкните + в верхней середине нового раздела и добавьте веб-часть схем обучения Microsoft 365 .
- Щелкните веб-часть и щелкните значок "Изменить ".
- В поле "Выбор источника обучения " выберите пользовательский пакет содержимого и отфильтруйте веб-часть по нужному содержимому. Ниже приведен пример веб-части, отфильтроваемой по списку воспроизведения из пользовательского пакета содержимого.
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по