Клиентская схема

Клиентская схема — это схема клиентского модуля, с помощью которой реализуется front-end часть приложения. Клиентская схема является одним из элементов пакета Creatio. Назначение клиентской схемы — сохранение и поставка метаданных части системы (приложения, раздела, модального окна и т. д.). Типы модулей и их особенности описаны в статье Виды модулей.

Клиентская схема для версии Creatio 8 Atlas и выше представлена схемой клиентского модуля типа Страница Freedom UI (Freedom UI page). Создание страницы Freedom UI описано в статье Клиентский модуль. Клиентская схема принадлежит к слою Schema (слой метаданных) режима DesignTime платформы Creatio и содержит настройки слоев режима RunTime.

Структурные элементы слоя Schema и его взаимодействие с другими структурными элементами платформы Creatio представлены на рисунке ниже.

Подробнее о режимах DesignTime и RunTime читайте в статье Front-end архитектура Creatio.

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

define("ExampleSchema", [], function() {
    return {
        modelConfig: /**SCHEMA_MODEL_CONFIG*/{}/**SCHEMA_MODEL_CONFIG*/,
        viewConfigDiff: /**SCHEMA_VIEW_CONFIG_DIFF*/[]/**SCHEMA_VIEW_CONFIG_DIFF*/,
        viewModelConfig: /**SCHEMA_VIEW_MODEL_CONFIG*/{}/**SCHEMA_VIEW_MODEL_CONFIG*/,
        validators: /**SCHEMA_VALIDATORS*/ {} /**SCHEMA_VALIDATORS*/,
        converters: /**SCHEMA_CONVERTERS*/ {} /**SCHEMA_CONVERTERS*/,
        handlers: /**SCHEMA_HANDLERS*/[] /**SCHEMA_HANDLERS*/
    };
});

Маркерные комментарии к секциям клиентской схемы обязательны к использованию.

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

Подробнее о слоях читайте в статье Front-end архитектура Creatio.

Секции клиентской схемы описываются в формате JSON. Логика секций validators, converters, handlers реализуется на языке JavaScript.

Кастомизация страницы описана в статье Кастомизация страницы.