1. Введение

Данный документ предназначен для описания приложения «Конструктор»

2. Перечень компонентов и их атрибутов

2.1. Панель

Описание - компонент предназначен для группировки и настройки способа отображения компонентов и других панелей на странице. Сама страница представляет собой панель с кодом root-panel.

Специальные свойства

Тип панели - Обычная

Блок

Выравнивание по горизонтали

Выравнивание по вертикали

Выравнивать содержимое

Входные параметры

Выходные параметры -

Событие -

Действия -

2.2. Надпись

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

Свойства

Входные параметры

Выходные параметры

Событие -

Действия -

Алфавитный указатель

Примеры

Страница авторизациии

spec/examples_src/auth_p-page.json

Глоссарий

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

Приложение

Приложение на конструкторе - это совокупность страниц (визуальных форм), предназначенная для реализации веб-интерфейса, интегрированного с платформой ARTA SYNERGY, для решения конкретных задач бизнес-пользователя.

Приложение обладает следующими свойствами (настройками):

Название

Код

УРЛ (по которому будет доступно приложение ip_adress:port/URL)

Номер ревизии

Опция «Требуется авторизация»

Пользователь по-умолчанию (логин/пароль)

Группы доступа - Права доступа на приложение (по группам ARTA SYNERGY)

Последние три настройки определяют доступ к приложению. В случае, если опция «Требуется авторизация» включена, приложение не будет доступно пользователям без авторизации (для авторизации в приложении должна быть предусмотрена страница авторизации. Пример). В случае, если опция «Требуется авторизация» выключена, поля «Пользователь по-умолчанию» (для ввода логина) и «Пароль» становятся доступны для редактирования и обязательны. От имени этого пользователя будет осуществляться доступ к объектам синерджи через API. Таблица «Группа доступа» позволяет предоставить доступ пользователям к приложению на чтение и изменение по группам ARTA SYNERGY.

Страница

Страница на конструкторе - представляет собой настроенную корневую панель с набором компонент и следующими свойствами

Название

Код

Требуется авторизация (как связано с авторизацией приложения?)

URL

Путь

Принимаемые параметры (грохнем в будущем)

Компонент

Компонент - является составным элементом страниц и предназначен для настройки визуальных форм доступных пользователю. Источником данных для компонентов могут служить константы, внешние данные(ссылки на внешние ресурсы: видео, изображения и т.д), но, прежде всего, данные платформы ARTA SYNERGY.

Компонент определяется параметрами:

Свойства

Входные параметры (свои для каждого типа компонента)

Выходные параметры (свои для каждого типа компонента)

События, которые он генерирует

Действия, которые могут быть над ним произведены

Свойства компонента разделены на:

Основные

тип

код

значение входных параметров (Сопоставление)

Специальные ( (свои для каждого типа компонента))

Стили

Обработчики событий

В качестве источника входных параметров для одного компонента могут служить выходные параметры любого другого компонента (на этой или другой странице приложения).

[Список всех компонентов](http://example.com/link «Я ссылка»)

Сопоставление

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

Обработчик события

Обработчики событий - способ взаимодействия компонентов в прилоижении между собой и со внешними источниками/приемниками данных (например, API SYNERGY).

Обработчик событий - представляет собой связку «Событие» - «Условие» - «Действие».

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

Обработчик событий настраивается на компоненте-источнике и может осуществлять действия:

В приложении

Логин

Выход из системы

Вернуться со страницы логина

Перейти на страницу

Показать сообщение

Над компонентом

Над внешним источником/приемником данных (внешний УРЛ, API SYNERGY, )

Ресурсы

Ресурсы - способ расширения функиональности конструктора с помощью HTML/CSS/JS В качестве ресурсов могут быть использованы файлы с расширением (.js, .css, ???) и библиотеки (???)