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

Импорт проекта надстройки в Microsoft 365 Agents Toolkit

Расширение Набора средств агентов для Visual Studio Code — это широкое средство для работы с расширениями на платформе разработчика Microsoft 365, включая приложения Teams, надстройки Office и расширения Copilot. Это также упрощает работу с расширениями, которые выходят за границы между приложениями Teams, надстройками и расширениями Copilot. Например, это упрощает загрузку неопубликованных приложений.

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

  • Структура папок и файлов существующей надстройки. Но эти структуры различаются в зависимости от того, какое средство использовалось для создания проекта и какая версия этого средства. Разработчик надстройки также мог изменить структуру после создания проекта.
  • Параметры в различных файлах конфигурации. Но эти параметры также различаются в зависимости от того, как был создан проект, и от изменений, внесенных в конфигурацию с момента его создания.
  • Какой язык, TypeScript или JavaScript, использовался для клиентского исходного кода веб-приложения.

Однако мы можем сделать некоторые общие рекомендации.

Примечание.

  • Эта статья не относится к проектам надстроек, созданным с помощью Visual Studio. Такие проекты основаны на платформе веб-приложений ASP.NET и предназначены для запуска на сервере IIS. Преобразование такого проекта в набор средств агентов будет значительно сложнее и не область для этой статьи.
  • Проекты надстроек в наборе средств агентов должны использовать унифицированный манифест для Microsoft 365. Если в проекте надстройки используется функция, которая еще не поддерживается в унифицированном манифесте, вы не сможете импортировать ее в набор средств агентов, если сначала не измените ее, чтобы в ней не использовались неподдерживаемые функции.
  • В настоящее время надстройки, использующие унифицированный манифест, не могут быть загружены неопубликованным приложением на компьютере Mac. Если компьютер разработки является компьютером Mac, не импортируйте проект в набор средств агентов, пока не будет поддерживаться загрузка неопубликованных приложений на компьютере Mac.

Существует две основные стратегии.

Независимо от выбранного варианта, сначала убедитесь, что установлены Visual Studio Code и расширение Набора средств агентов.

Использование функции импорта набора средств

Существует четыре задачи для использования функции импорта.

Подготовка существующего манифеста

Важно!

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

Импорт проекта

  1. Откройте Visual Studio Code и щелкните значок Набора средств агентов на панели действий.

    Значок набора средств агентов.

  2. Выберите Создать новое приложение.

  3. Откроется раскрывающееся меню Новый проект . Перечисленные параметры зависят от версии набора средств агентов. Выберите Надстройка Office.

    Параметры в раскрывающемся меню Новый проект. Один из вариантов называется

  4. Откроется раскрывающееся меню Функции приложения с помощью надстройки Office . Перечисленные параметры зависят от версии набора средств агентов. Выберите Обновить существующую надстройку Office.

    Параметры в раскрывающемся меню Функции приложения с помощью надстройки Office. Выбран параметр

  5. В раскрывающемся меню Существующая папка проекта надстройки перейдите к корневой папке проекта надстройки.

  6. В раскрывающемся меню Выбор файла манифеста проекта импорта перейдите к файлу манифеста только надстройки, который обычно называется manifest.xml.

  7. В диалоговом окне Папка рабочей области выберите папку, в которую нужно поместить преобразованный проект.

  8. В диалоговом окне Имя приложения присвойте проекту имя (без пробелов). Agents Toolkit создает проект с исходными файлами и шаблонами. Затем откроется проект во втором окне Visual Studio Code. Закройте исходное окно Visual Studio Code.

Убедитесь, что надстройка может быть загружена неопубликованным

Примечание.

Надстройки, использующие унифицированный манифест, можно загрузить только в Office версии 2304 (сборка 16320.20000) или более поздней.

Загрузите неопубликованную надстройку, следуя инструкциям в разделе Загрузка неопубликованных приложений с помощью microsoft 365 Agents Toolkit.

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

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

После импорта: измените структуру проекта и параметры по мере необходимости

В процессе импорта создаются некоторые папки и файлы, необходимые Visual Studio Code или agent Toolkit, но не реорганизуются исходные файлы, например HTML, JavaScript и CSS-файлы. Он также не изменяет содержимое файлов в проекте, включая файлы конфигурации инструментов. Рекомендуется изменить проект в соответствии с шаблоном проектов, созданных в наборе средств агентов. При работе учитывайте следующие моменты.

  • HTML-файлы в проектах набора средств не имеют встроенных <script> элементов. Они используют <script> только элементы с атрибутом src , который загружает внешний файл.

  • Исходные файлы в новом проекте набора средств находятся в папке с именем \src. В этой папке исходные файлы делятся на вложенные папки в зависимости от сред выполнения, в которых они обычно выполняются. Ниже приведена типичная структура.

    \src
    \commands
       commands.html
       commands.js
    \taskpane
       taskpane.css
       taskpane.html
       taskpane.js

  • Проекты набора средств агентов имеют папку с именем \appPackage. Манифест и другие файлы, которые должны находиться в ZIP-файле пакета приложения, находятся в этой папке.

Важно!

  • URL-адреса в манифесте будут отражать исходную структуру проекта. Измените эти URL-адреса при необходимости, если вы вносите изменения в структуру файлов и папок.
  • Файлы конфигурации средства, такие как webpack.config.js, могут иметь URL-адреса. Измените их при необходимости.

Начните с нового проекта набора средств

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

  1. Если существующий проект использует только манифест надстройки, преобразуйте его. См . раздел Преобразование надстройки, чтобы использовать унифицированный манифест для Microsoft 365.

  2. Создайте проект надстройки в наборе средств агентов. Для каждого выбора, который предлагает вам сделать набор средств, например между JavaScript и TypeScript, сделайте выбор, который лучше всего соответствует существующей надстройке. См . статью Создание проектов надстроек Office с помощью microsoft 365 Agents Toolkit.

  3. Замените манифест в папке \appPackage нового проекта преобразованным манифестом.

    Примечание.

    Если в процессе преобразования возникли какие-либо файлы строк языка, например fr-fr.json, добавьте их в папку \appPackage .

  4. Замените файлы в папке \src нового проекта исходными файлами из старого проекта. Чтобы обеспечить максимальную совместимость с файлами конфигурации в новом проекте, рекомендуется разделить исходные файлы на вложенные папки в зависимости от сред выполнения, в которых они обычно выполняются. Например, у вас есть отдельные папки для исходных файлов команд функций, области задач, событий автозапуска и пользовательских функций Excel.

  5. Измените манифест, чтобы убедиться, что все URL-адреса в нем совместимы с новой структурой проекта.

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

    Совет

    Если старый и новый проект имеют файл конфигурации с одинаковым именем (например ,babel.config.json), используйте средство сравнения файлов ("diff"), чтобы найти различия. Для каждой разницы определите, какой файл является правильным для нового проекта, и измените файл в новом проекте при необходимости.

  7. webpack.config.js, скорее всего, потребуется изменить. Невозможно предоставить универсальные правила для этого файла, но в большинстве случаев применяются следующие принципы.

    • Убедитесь, что URL-адреса соответствуют структуре проекта.
    • Убедитесь, что для каждой entry вложенной папки в папке \src имеется подсвойство.
    • Убедитесь, что plugins массив также учитывает каждую вложенную папку в папке \src .
    • Убедитесь, что extensions свойства и rules учитывают типы файлов в проекте, которые должны обрабатываться загрузчиками и быть объединяемыми.

  8. Убедитесь, что вы можете загрузить надстройку неопубликованного приложения в новом проекте. См . раздел Проверка возможности загрузки надстройки неопубликованных приложений.