# Документация по ARTA Synergy

## О платформе Synergy

### Назначение платформы

Synergy - это low-code платформа для проектирования, автоматизации и исполнения бизнес-процессов, а также для создания прикладных бизнес-приложений без необходимости классической разработки.

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

Примечание

В контексте обучения под разработкой в Synergy понимается не программирование, а проектирование и настройка бизнес-решений средствами платформы.

### Какие задачи решает Synergy

Платформа Synergy предназначена для решения следующих задач:

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

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

### Роль аналитика в платформе

В типовом сценарии работы аналитик получает описание бизнес-процесса (ордер, техническое задание, регламент) и на его основе:

- определяет вход и выход процесса;
- описывает структуру данных;
- проектирует пользовательские формы;
- настраивает реестры для хранения и просмотра данных;
- моделирует маршрут выполнения процесса;
- определяет роли и участников процесса.

Все перечисленные действия выполняются средствами Synergy без необходимости написания серверного кода.

### Архитектура платформы (логический обзор)

С точки зрения пользователя платформа Synergy состоит из двух ключевых частей:

- Среда проектирования (Synergy IDE) - используется для создания и настройки приложений, форм, реестров и маршрутов;
- Среда исполнения (Synergy Server) - отвечает за выполнение процессов, хранение данных, работу пользователей и интеграции.

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

## Приложение в Synergy

### Назначение приложения

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

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

### Создание приложения

Работа с приложением выполняется в подсистеме Synergy IDE.

Для перехода в среду проектирования необходимо открыть в браузере адрес проекта с указанием пути `/designer`:

    http://<адрес_сервера>/designer

После авторизации, при отсутствии созданных приложений, система предлагает создать новое приложение.

Создание нового приложения

При создании приложения необходимо указать:

- наименование приложения;
- при необходимости - использовать структуру по умолчанию.

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

### Структура приложения

После создания приложения пользователю отображается его структура.

В зависимости от выбранных настроек приложение может содержать:

- одну корневую папку;
- или иерархию папок, созданную по умолчанию.

Папки используются для логической группировки объектов приложения и не влияют на их функциональное поведение.

Структура по умолчанию приложения в Synergy IDE

Внутри папок могут размещаться следующие объекты:

- формы;
- реестры;
- маршруты;
- справочники;
- другие конфигурационные элементы.

### Добавление объектов в приложение

Создание объектов выполняется из контекстного меню выбранной папки.

Для добавления объекта необходимо:

1. Выбрать папку в структуре приложения.
2. Нажать правой кнопкой мыши.
3. Выбрать пункт `Добавить`.
4. Выбрать тип создаваемого объекта.

Добавление объекта в приложение

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

### Управление приложением

В Synergy IDE предусмотрены возможности управления приложением, включая:

- редактирование объектов конфигурации;
- группировку объектов по папкам;
- перемещение объектов внутри приложения;
- импорт и экспорт приложения;
- управление правами доступа.

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

### Связь приложения с дальнейшей настройкой

Приложение является основой для последующей работы с платформой.

В следующих разделах рассматривается:

- создание форм для ввода данных;
- настройка реестров для хранения информации;
- моделирование маршрутов бизнес-процессов.

Все перечисленные элементы создаются и настраиваются внутри приложения.

## Форма

### Что такое форма в Synergy

Форма в Synergy является основным инструментом ввода и отображения данных в системе.

Форма представляет собой макет документа или заявки, структура которого определяется на основе ордера (технического задания) и описывает набор полей, их типы и правила заполнения.

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

Форма определяет:

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

Создание формы выполняется в среде проектирования Synergy IDE и является одним из базовых этапов настройки бизнес-процесса.

### Создание формы

Создание формы выполняется в среде проектирования Synergy IDE внутри ранее созданного приложения.

Для перехода в среду проектирования необходимо открыть в браузере адрес проекта с указанием пути `/designer` и пройти авторизацию в системе.

После создания или выбора приложения форма создается внутри нужной папки структуры приложения.

Для создания формы необходимо:

1. Выбрать папку в структуре приложения.
2. Открыть контекстное меню правой кнопкой мыши.
3. Выбрать пункт `Добавить` → `Базовые сущности` → `Форма`.

Создание новой формы

После этого открывается окно редактирования формы. Созданная форма является макетом документа, который в дальнейшем будет использоваться для ввода данных пользователем.

#### Первичная настройка формы

Первичная настройка формы выполняется во вкладке «Форма» на правой панели редактора.

На данном этапе указываются:

- наименование формы;
- код формы.

Настройка формы

При вводе наименования система автоматически формирует код формы на основе транслитерации. При необходимости код может быть изменен вручную.

После задания основных параметров выполняется переход к добавлению и настройке компонентов формы.

### Структура формы

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

Для построения структуры формы в Synergy применяется компонент «Таблица».

#### Использование таблиц для разметки

Компонент «Таблица» используется для разметки формы и структурирования элементов внутри нее.

Таблица позволяет:

- разделять форму на логические блоки;
- выравнивать элементы по колонкам и строкам;
- группировать поля по смыслу;
- создавать динамические области для ввода данных.

В рамках формы таблицы применяется для организации пользовательского интерфейса.

#### Вертикальная структура формы

Наиболее распространенная схема построения формы - вертикальное деление на две колонки:

- левая колонка - наименования полей;
- правая колонка - элементы для ввода данных.

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

Вертикальная структура формы

#### Горизонтальная структура формы

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

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

Для визуального выделения блока:

- создается отдельная таблица;
- добавляется строка заголовка;
- заголовок выравнивается по центру.

Горизонтальное разделение формы на блоки

#### Вложенные таблицы

Для сложных форм допускается использование вложенных таблиц.

Вложенные таблицы применяются для:

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

Каждая таблица на форме настраивается независимо и может иметь собственные параметры отображения.

#### Динамическая таблица

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

Типовыми примерами использования динамической таблицы являются:

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

Для создания динамической таблицы используется компонент «Таблица», для которого в настройках включаются параметры:

- «Добавлять строки в режиме заполнения»;
- «Добавить заголовок динамической таблицы».

После включения данных настроек таблица позволяет пользователю самостоятельно добавлять строки при заполнении формы.

#### Общие принципы построения структуры

При проектировании структуры формы рекомендуется:

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

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

### Компоненты формы

Компоненты формы используются для ввода, отображения и выбора данных пользователем.

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

Компоненты добавляются на форму во вкладке «Компоненты» и размещаются внутри таблиц, определяющих структуру формы.

В зависимости от назначения компоненты формы можно разделить на несколько основных групп.

#### Текстовые компоненты

Текстовые компоненты предназначены для ввода и отображения текстовых значений.

В Synergy используются следующие основные текстовые компоненты.

##### Однострочное поле

Компонент «Однострочное поле» используется для ввода коротких текстовых значений в одну строку без абзацев.

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

- номер заказа;
- наименование;
- ФИО;
- телефон;
- адрес электронной почты.

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

##### Многострочный текст

Компонент «Многострочный текст» используется для ввода произвольного текста, состоящего из нескольких строк и абзацев.

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

- комментарии;
- описания;
- дополнительные сведения.

В отличие от однострочного поля, данный компонент позволяет вводить неограниченный объем текста с сохранением структуры абзацев.

##### Неизменяемый текст

Компонент «Неизменяемый текст» используется для отображения статического текста на форме.

Как правило, данный компонент применяется для:

- наименований полей в левой колонке формы;
- заголовков разделов (блоков) на форме.

Текст задается в поле «Надпись». При необходимости можно добавить перевод.

#### Элементы выбора

Элементы выбора используются в формах Synergy для выбора одного или нескольких значений из заданного набора.

В качестве источника значений элементы выбора могут использовать:

- значения, заданные вручную;
- справочники, ранее созданные в системе.

Элементы выбора добавляются на форму во вкладке «Компоненты» и настраиваются через вкладку «Элементы».

##### Выпадающий список

Компонент «Выпадающий список» предназначен для выбора одного значения из раскрывающегося списка.

В режиме заполнения формы пользователю отображаются значения из поля «Наименование», при этом системным значением является поле «Значение».

Список значений может быть:

- создан вручную непосредственно в компоненте;
- выбран из существующих справочников системы.

Компонент используется в тех случаях, когда необходимо выбрать одно значение из фиксированного набора.

##### Переключатель вариантов

Компонент «Переключатель вариантов» также предназначен для выбора одного значения, но в отличие от выпадающего списка, варианты выбора отображаются пользователю сразу.

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

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

##### Выбор вариантов

Компонент «Выбор вариантов» используется для выбора одного или нескольких значений из списка с возможностью одновременного выбора нескольких пунктов.

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

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

Компонент применяется в тех случаях, когда пользователю необходимо отметить несколько вариантов одновременно.

##### Дата / время

Компонент «Дата / время» используется для ввода пользователем значения даты и, при необходимости, времени.

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

Компонент применяется в тех случаях, когда необходимо указать дату события, дату создания, срок выполнения или иное календарное значение.

Для компонента доступны следующие основные настройки:

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

Формат даты может быть задан вручную с использованием шаблонов, например `${dd}.${mm}.${yyyy}`.

#### Файловые компоненты

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

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

##### Изображение

Компонент «Изображение» предназначен для загрузки и отображения графических файлов на форме.

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

Компонент применяется в случаях, когда визуальное представление данных имеет значение, например:

- сканы документов;
- фотографии;
- изображения, связанные с объектом заявки.

Загруженные изображения сохраняются в системе и доступны для просмотра на последующих этапах бизнес-процесса.

##### Файл

Компонент «Файл» используется для загрузки файлов произвольного формата.

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

В зависимости от настроек компонент может:

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

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

##### Ссылка

Компонент «Ссылка» используется для сохранения URL-адреса внешнего ресурса, связанного с заявкой или документом.

Компонент позволяет указать текст надписи и сам URL-адрес, который открывается при нажатии.

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

- ссылка на внешний документ;
- ссылка на информационный ресурс;
- ссылка на связанный процесс или систему.

На форме ссылка отображается в виде кликабельного элемента и может открываться в текущем или отдельном окне в зависимости от настроек.

#### Специальные компоненты

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

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

##### Объекты Synergy

Компонент «Объекты Synergy» используется для выбора системных объектов в зависимости от заданного типа данных.

Тип данных определяет, какие объекты будут доступны для выбора. Возможные варианты включают, например:

- пользователей;
- должности;
- подразделения.

В зависимости от выбранного типа данных компонент позволяет:

- выбирать один или несколько объектов;
- автоматически заполнять значение данными создающего пользователя (например, должностью или подразделением);
- управлять отображением групп и структур объектов;
- настраивать язык отображения значений.

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

##### Ссылка на реестр

Компонент «Ссылка на реестр» используется для установления связи между формой и данными, хранящимися в реестрах Synergy.

С его помощью можно:

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

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

##### Номер

Компонент «Номер» предназначен для автоматической генерации уникального значения на основе заданного шаблона.

Чаще всего данный компонент используется для формирования:

- номеров заявок;
- регистрационных номеров;
- внутренних идентификаторов документов.

Значение номера формируется системой автоматически и не требует ручного ввода пользователем.

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

### Валидация и формат данных

Валидация и формат данных используются для контроля корректности вводимой информации и обеспечения целостности данных в форме.

С помощью настроек валидации можно ограничить ввод пользователя и задать правила заполнения полей в соответствии с требованиями бизнес-процесса.

#### Обязательные поля

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

Если обязательное поле не заполнено, система не позволит продолжить работу с формой и уведомит пользователя о необходимости ввода значения.

Использование обязательных полей позволяет гарантировать наличие ключевых данных в записи.

#### Маска ввода

Маска ввода используется для задания фиксированного формата данных при вводе значения.

Она позволяет ограничить ввод символов и задать структуру значения, например для:

- телефонных номеров;
- идентификационных кодов;
- форматированных числовых значений.

Маска ввода помогает пользователю вводить данные в корректном виде и снижает вероятность ошибок.

#### Регулярные выражения

Регулярные выражения используются для проверки вводимых данных на соответствие заданному шаблону.

С их помощью можно реализовать более гибкую и точную валидацию, например для:

- адресов электронной почты;
- специальных кодов;
- пользовательских форматов данных.

Если введенное значение не соответствует заданному регулярному выражению, система уведомляет пользователя об ошибке.

#### Блокировка от изменений

Блокировка от изменений используется для запрета редактирования значения компонента пользователем.

Данный параметр применяется в случаях, когда значение:

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

Заблокированное поле отображается в форме, но недоступно для редактирования.

Read the Docs v: latest

Versions
  latest

Downloads

On Read the Docs
  Project Home
  Builds

Free document hosting provided by Read the Docs.