Работа с клиентским кодом в файловой системе

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

Для удобства разработчика предусмотрена возможность выгрузки исходного кода клиентских схем из базы данных в *.js-файлы и LESS-стилей модулей в *.less-файлы для работы с ними в интегрированной среде разработки (Integrated Development Environment, IDE), например, WebStorm, Visual Studio Code, Sublime Text и т.п.

Общая последовательность действий при разработке исходного кода клиентских схем в файловой системе:

1. Выполнить предварительные настройки приложения bpm'online.
2. Создать, установить или обновить пользовательский пакет из репозитория SVN.
3. Создать клиентскую схему, в которой будет выполняться разработка.
4. Выгрузить схему из базы данных в файловую систему.
5. Выполнить разработку исходного кода схемы в IDE.
6. Сохранить схему и выполнить отладку созданного исходного кода.

Последовательность действий при разработке исходного хода клиентских схем в файловой системе

1. Выполнить предварительные настройки приложения bpm'online

Настройка приложения для разработки в файловой системе подробно описана в статье "Разработка в файловой системе".

2. Создать, получить или обновить пакет из репозитория SVN

Создание пользовательского пакета с использованием и без использования SVN описано в статьях "Создание пользовательского пакета" и "Создание пакета в режиме разработки в файловой системе". Установка и обновление пакетов — в "Установка пакета из хранилища" и "Обновление пакета из хранилища".

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

Создание клиентских схем в пользовательском пакете подробно описано в "Создание клиентской схемы".

4. Выгрузить схему из базы данных в файловую систему

Для этого нужно в разделе [Конфигурация] ([Configuration]) выполнить действие [Выгрузить пакеты в файловую систему] ([Download packages to file system]) (рис. 1)

Рис. 1. — Действие [Выгрузить пакеты в файловую систему]

Так, например, если в пользовательском пакете sdkPackageInFileSystem была создана замещающая схема [Схема отображения карточки контакта] ([Display schema - Contact card]) с именем ContactPageV2, то в файловой системе в каталоге Pkg\sdkPackageInFileSystem\Schemas\ContactPageV2 появятся файлы исходного кода схемы ContactPageV2.js и стилей ContactPageV2.less (рис. 2).

Рис. 2. — Файлы с исходным кодом и стилями схемы

5. Выполнить разработку исходного кода схемы в IDE.

Для выполнения разработки необходимо открыть файл с исходным кодом схемы в предпочитаемой IDE (или любом текстовом редакторе) и добавить нужный исходный код (рис. 3).

Рис. 3. — Редактирование файла схемы в Visual Studio Code

Например, чтобы скрыть со страницы редактирования контакта поле [Полное название должности] ([Full job title]), в файл ContactPageV2.js нужно добавить следующий исходный код:

define("ContactPageV2", [],
        function() {
            return {
                entitySchemaName: "Contact",
                diff: /**SCHEMA_DIFF*/[
                    {
                        "operation": "remove",
                        "name": "JobTitleProfile"
                    }
                ]/**SCHEMA_DIFF*/
            };
        });

6. Сохранить схему и выполнить отладку созданного исходного кода

После сохранения файла ContactPageV2.js и обновления страницы браузера поле [Полное название должности] ([Full job title]) будет скрыто со страницы редактирования контакта (рис. 4).

Рис. 4. — Измененный профиль контакта

Если при редактировании клиентского исходного кода были допущены ошибки, необходимо выполнить его отладку (см. "Отладка клиентского кода").