Статический клиентский контент в файловой системе

Общие сведения

До версии 7.11 при запросе клиентского контента (*.js и *.css файлов) сервер приложения формировал его динамически, основываясь на текущей структуре связей между пакетами и зависимостями между схемами. Сформированные данные кэшировались и отправлялись клиентскому приложению.

Начиная с версии 7.11 весь клиентский контент предварительно генерируется в специальном каталоге приложения — становится статическим. При запросе клиентского контента сервер IIS ищет запрашиваемый контент в этом каталоге и сразу же отправляет его клиентскому приложению. Таким образом повышается общая производительность приложения и снижается нагрузка на сервер.

Преимущества и недостатки

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

Табл. 1. — Преимущества и недостатки использования статического клиентского контента

Генерация статического клиентского контента

Клиентский контент генерируется в специальный каталог .\Terrasoft.WebApp\conf. В нем содержатся *.js-файлы с исходным кодом схем, *.css-файлы стилей и *.js-файлы ресурсов для всех культур приложения.

Действия, при которых выполняется генерация клиентского контента

Первичная или повторная генерация статического клиентского контента выполняется при следующих действиях в системе:

• Сохранение схемы через дизайнеры клиентских схем и объектов.
• Сохранение через мастера разделов и деталей.
• Установка и удаление приложений из Marketplace и zip-архива.
• Применение переводов.
• Действия [Компилировать все] и [Компилировать измененное] в разделе [Конфигурация].

Генерация клиентского контента с помощью утилиты WorkspaceConsole

В утилиту WorkspaceConsole была добавлена операция BuildConfiguration, которая выполняет генерацию клиентского контента. Параметры операции приведены в таблице 2.

Табл. 2. — Параметры операции BuildConfiguration

Примеры использования:

Terrasoft.Tools.WorkspaceConsole.exe -operation=BuildConfiguration -workspaceName=Default -destinationPath="C:\WebApplication\BPMOnline\Terrasoft.WebApp" -force=true -logPath=C:\wc\log

Terrasoft.Tools.WorkspaceConsole.exe -operation=BuildConfiguration -workspaceName=Default -webApplicationPath="C:\WebApplication\BPMOnline" -destinationPath="C:\WebApplication\BPMOnline\Terrasoft.WebApp" -force=true -logPath=C:\wc\log

Совместимость с режимом разработки в файловой системе

На текущий момент режим разработки в файловой системе (РФС) не совместим с получением клиентского контента из предварительно сгенерированных файлов. Для корректной работы с РФС необходимо отключить получение статического клиентского контента из файловой системы. Для отключения данной функциональности нужно установить значение false для флага UseStaticFileContent в файле Web.config.

<fileDesignMode enabled="true" />
...
<add key="UseStaticFileContent" value="false" />

Генерация клиентского контента при добавления новой культуры

После добавления новых культур из интерфейса приложения необходимо выполнить действие [Компилировать все] в разделе [Конфигурация].

Изменения в объекте параметров, необходимом для формирования URL изображения (версия 7.11.1)

Изображения в клиентской части bpm'online всегда запрашиваются браузером по определенному URL, который устанавливается в атрибуте src html-элемента img. Для формирования этого URL в bpm'online используется специальный модуль Terrasoft.ImageUrlBuilder (imageurlbuilder.js), в котором реализован публичный метод получения URL изображения — getUrl(config). Этот метод принимает специальный конфигурационный JavaScript-объект config, в свойстве params которого содержится объект параметров, на основе которого формируется URL изображения для вставки на страницу.

До версии 7.11.0 включительно структура объекта params была следующей:

config: {
    params: {
        schemaName: "",
        resourceItemName: "",
        hash: ""
    }
}

Здесь:

• schemaName — название схемы (строка);
• resourceItemName — название изображения в bpm'online (строка);
• hash — хэш изображения (строка).

Начиная с версии 7.11.1 в перечень параметров добавлено строковое свойство resourceItemExtension, содержащее расширение файла изображения (например, ".png". Новая структура объекта params:

config: {
    params: {
        schemaName: "",
        resourceItemName: "",
        hash: "",
        resourceItemExtension: ""
    }
}

Пример корректного формирования конфигурационного объекта параметров для получения URL статического изображения:

var localizableImages = {
    AddButtonImage: {
        source: 3,
        params: {
            schemaName: "ActivityMiniPage",
            resourceItemName: "AddButtonImage",
            hash: "c15d635407f524f3bbe4f1810b82d315",
            resourceItemExtension: ".png"
        }
    }
}