Skip to main content

Последовательность создания бандла

  1. Создать директорию с произвольным названием, которая будет содержать манифест (cdn_bundle.json) и директорию с ресурсами.

  2. Создать cdn_bundle.json. Пример файла cdn_bundle.json с кастомным приложением «1С»:

    {
      "bundleVersion": "custom-12.0.5.5",
      "formatVersion": 1,
      "description": "Customizations description",
      "merge": false,
      "properties": [
        {
          "key": "wfe/appswitcher.quicklaunch.json",
          "value": "{\"order\":[\"1c\",\"calendar\",\"landing\",\"mail\",\"wfm\",\"contacts\",\"admin\"]}"
        },
        {
          "key": "wfe/appswitcher.landing.json",
          "value": "{\"order\":[\"wfm\",\"mail\",\"contacts\",\"calendar\",\"profile\",\"admin\",\"1c\"],\"main\":\"wfm\"}"
        },
        {
          "key": "wfe/appswitcher.apps.json",
          "value": "{\"1c\":{\"url\":\"https://example.com\",\"title\":{\"ru-RU\":\"1С Бухгалтерия\"},\"iconUrl\":\"%cdn_base_url%/apps/1c.png\"},\"landing\":{\"url\":\"//auth-{base_url}/landing\"},\"wfm\":{\"url\":\"//files-{base_url}\"},\"mail\":{\"url\":\"//mail-{base_url}\"},\"contacts\":{\"url\":\"//mail-{base_url}/#contacts\"},\"calendar\":{\"url\":\"//mail-{base_url}/#calendar\"},\"profile\":{\"url\":\"//auth-{base_url}/profile\",\"userTypes\":[\"default\"]},\"admin\":{\"url\":\"//admin-{base_url}\",\"userTypes\":[\"admin\"]}}"
        }
      ]
    }

    В примере манифеста указаны: кастомное приложение и все базовые приложения «МойОфис Документы», а именно landing, wfm, mail, contacts, calendar, profile, admin.

  3. Для создания бандла необходимо выполнить следующие действия:

  • во всех базовых приложениях значение переменной base_url должно быть представлено в виде ссылки на сервер с развёрнутой средой «МойОфис Документы». Для удобства допускается использовать поиск (Ctrl + F) с заменой всех вхождений. Например: у адреса https://example.com/ переменная base_url будет представлена в виде значения example.com;
  • заменить «1С» на название кастомного приложения (в примере есть три вхождения). Аналогично заменить url, title, iconUrl, относящиеся к кастомному приложению.

При создании записей кавычки внутри поля "value" должны быть экранированы обратным слешем: \"ru-RU\".

  1. Создание директории с ресурсами.

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

    Пример:

    Имя директории с ресурсами — apps. В директории расположен каталог icons с иконкой кастомного приложения custom_icon.svg. В файле cdn_bundle.json путь до иконки должен быть указан в виде:

    %cdn_base_url%/apps/icons/custom_icon.svg

    Иконка требуется только для кастомных приложений, для базовых приложений продукта иконка не требуется.

    При использовании иконок применяются следующие правила:

    • иконки, необходимые для интеграции с внешними продуктами, запрашиваются у соответствующего вендора;
    • для продуктов «МойОфис» иконки можно скачать по ссылке: https://myoffice.ru/files/identity/icons.zip;
    • если при подготовке кастомизированного бандла иконки не будут приложены для подключаемых внешних приложений, то для данных приложений в «МойОфис Документы» будет отображаться универсальная иконка;
    • допускается использование разных форматов изображений (PNG, SVG). Предпочтительно SVG.

  2. Загрузка бандла на сервер.

    Для загрузки необходима директория с бандлом, которая содержит cdn_bundle.json и директорию с ресурсами. Перед загрузкой на сервер директорию с бандлом нужно упаковать в формат tar.gz или tgz архив. Полученный архив загрузить на сервер.