Intellex - Вклад [ru]

Заглавная страница

2024-04-16T16:21:58Z

Wiki: Перенаправление на О платформе ХМ

#перенаправление [[О платформе ХМ]]

MediaWiki:Sidebar

2024-04-16T16:20:30Z

Wiki:

* ПОИСК
* ВВЕДЕНИЕ
== Текст заголовка ==
Платформа приложений ХМ
== Текст заголовка ==
** О платформе ХМ|О платформе XM
** Технологический стек|Технологический стек
** Исключительное право|Исключительное право
* УСТАНОВКА
***VirtualBox и загрузка образа|Виртуальный образ в VirtualBox
***Установка на Astra Linux|Установка на Astra Linux
* СЦЕНАРИИ ПОЛЬЗОВАТЕЛЯ
** Общие принципы работы с ХМ|Работа в системе
** Работа со списками|Работа со списками
** Построение произвольного отчета|Построение произвольного отчета
* СЦЕНАРИИ РАЗРАБОТЧИКА
** Сценарии обучения|Сценарии обучения
** Дизайнер документов|Дизайнер документов
** Дизайнер справочников|Дизайнер справочников
** Дизайнер аналитик|Дизайнер аналитик
** Дизайнер встроенных аналитик|Дизайнер встроенных аналитик
** Дизайнер БД|Дизайнер БД
* ДОКУМЕНТАЦИЯ
**https://xmdocs.intellex.ru/images/a/a9/%D0%A0%D0%9F_%D0%9E%D0%B1%D1%89%D0%B8%D0%B5_%D0%BF%D1%80%D0%B8%D0%BD%D1%86%D0%B8%D0%BF%D1%8B_%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%8B_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9.pdf|Общие принципы
** https://xmdocs.intellex.ru/images/2/2b/%D0%A0%D0%9F_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80%D0%B0_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%B2.pdf|Дизайнер документов
** https://xmdocs.intellex.ru/images/f/ff/%D0%A0%D0%9F_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80_%D1%81%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D1%87%D0%BD%D0%B8%D0%BA%D0%BE%D0%B2.pdf|Дизайнер справочников
** https://xmdocs.intellex.ru/images/5/5e/%D0%A0%D0%9F_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80_%D0%B0%D0%BD%D0%B0%D0%BB%D0%B8%D1%82%D0%B8%D0%BA.pdf|Дизайнер аналитик
** https://xmdocs.intellex.ru/images/4/4a/%D0%A0%D0%9F_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80_%D0%B2%D1%81%D1%82%D1%80%D0%BE%D0%B5%D0%BD%D0%BD%D1%8B%D1%85_%D0%B0%D0%BD%D0%B0%D0%BB%D0%B8%D1%82%D0%B8%D0%BA.pdf|Дизайнер встроенных аналитик
** https://xmdocs.intellex.ru/images/3/3b/%D0%A0%D0%9F_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80%D0%B0_%D0%91%D0%94.pdf|Дизайнер БД
** Синтаксис и формат формул|Синтаксис и формат формул

Заглавная страница

2024-04-16T16:20:11Z

Wiki: Полностью удалено содержимое страницы

MediaWiki:Sidebar

2024-04-16T15:59:10Z

Wiki:

MediaWiki:Sidebar

2024-04-16T15:57:09Z

Wiki:

Закладка Структура Дизайнера документов

2022-08-22T08:21:16Z

Wiki: /* Описание */

== Описание ==
Закладка Структура в Дизайнере документов предназначена для создания физической и логической модели электронного документа имеющая полное соответствие с хранением в базе данных:

Пошаговое описание создания структуры описано в [[Создание документа в Дизайнере документов xmlowcode|сценарии создания нового документа]]. [[Файл:Структура 1.png|без|мини]]
== Панель инструментов закладки «Структура» ==
Закладка "Структура содержит панель инструментов с командами:
{|
|-
|Открытие/закрытие панели поиска параметров по таблицам структуры
|[[Файл:Структура 2.png|без|мини]]
|-
|Переключение отображения параметров таблиц на логическую/физическую модель
|[[Файл:Структура 3.png|без|мини]]
|-
|Добавление таблицы
|[[Файл:Структура 4.png|без|мини]]
|-
|Добавление параметра
|[[Файл:Структура 5.png|без|мини]]
|-
|Удаление выделенного объекта
|[[Файл:Структура 6.png|без|мини]]
|-
|Добавление таблицы из БД
|[[Файл:Структура 7.png|без|мини]]
|-
|Добавление таблицы и связанной таблицы по FK из БД
|[[Файл:Структура 8.png|без|мини]]
|-
|Добавление представления из БД
|[[Файл:Структура 9.png|без|мини]]
|-
|Добавление новых полей из БД для выбранных таблиц
|[[Файл:Структура 10.png|без|мини]]
|-
|Открытие диалога «Скрипты БД»
|[[Файл:Структура 11.png|без|мини]]
|-
|Экземпляр документа
|[[Файл:Структура 12.png|без|мини]]
|-
|Спецификация документа
|[[Файл:Структура 13.png|без|мини]]
|-
|Поднятие наверх (глубина) выбранной таблицы или представления
|[[Файл:Структура 14.png|без|мини]]
|-
|Опустить вниз (глубина) выбранную таблицу или представление
|[[Файл:Структура 15.png|без|мини]]
|-
|Экспортировать картинку
|[[Файл:Структура 16.png|без|мини]]
|}

== Поиск и навигация ==
На закладке Структура осуществляется поиск параметров и навигация таблиц.

=== Поиск параметров ===
'''1. Поиск по всем таблицам'''

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

Для поиска по всем таблицам необходимо нажать на поиск на панели инструментов слева и ввести название в поле поиска.
[[Файл:Структура 2.png|без|мини]]
После ввода названия параметра отобразятся все найденные значения с отображением наименования таблицы, в которой он находится.

Таблица с выбранным параметром будет отображена в центре рабочей области, параметр выделен.
[[Файл:Структура 17.png|без|мини]]
Для скрытия панели необходимо повторно нажать на иконку поиска на панели слева.

'''2. Поиск параметров по выбранной таблице'''

Для поиска параметра в выбранной таблице необходимо её выделить и нажать «Параметры» на панели навигации. Откроется панель с настройками видимости таблиц и параметров.

Далее необходимо ввести название искомого параметра.
[[Файл:Структура 18.png|без|мини]]
На панели Параметров для выбранной таблицы доступна следующая функциональность:

-Показать все параметры;

-Скрыть все параметры крое ключевых;

-Показать не сохраняемые в БД;

-Срыть не сохраняемые в БД;

- Обновление списка параметров.
[[Файл:Структура 20.png|без|мини]]

=== '''Навигация''' ===
В области навигации доступна следующая функциональность:

-Увеличение размера отображения рабочей области;

-Уменьшение размера отображения рабочей области;

-Установка исходного размера рабочей области;

-Возможность подогнать под размер схемы;

-Развернуть все таблицы;

-Свернуть все таблицы.
[[Файл:Структура 19.png|без|мини]]
== Создание структуры документа ==
'''<big>Добавление таблицы</big>'''

Для создания структуры документа необходимо нажать на панели инструментов слева «Добавить таблицу» или перетащить иконку в рабочую область. [[Файл:Структура 4.png|без|мини]]

Чтобы добавить дочернюю таблицу, необходимо еще раз нажать на «Добавить таблицу».

Для создания ссылочной связи между таблицами, которые были добавлены с помощью панели инструментов необходимо навести курсор мыши на таблицу до появления стрелки в "шапке" или параметре и далее протянуть до нужной таблицы.
[[Файл:Структура 22.1.png|без|мини]]
Добавить дочерние таблицы также можно наведя курсор мыши на выбранную таблицу, пока не появятся стрелки (слева, справа и снизу) .

При нажатии на стрелку левой кнопкой мыши, будет добавлена новая таблица в выбранном направлении.
[[Файл:Структура 23.png|без|мини]]
'''<big>Добавление параметра</big>'''

Добавить параметр для выбранной таблицы можно нажав на иконку «Добавить параметр» на панели инструментов или перетащив ее в необходимую таблицу.[[Файл:Структура 5.png|без|мини]]
== Свойства таблиц\представлений и параметров ==
Свойства таблицы\представления и параметров заполняются в правой части экрана в «Блоке свойств выбранной таблицы и параметра».

'''Описание свойств основной таблицы'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Дата справочника
|refBookDate
|Дата, на которую нужно искать

данные в справочниках
|Передается в поле API_DATE в listChoice, если у listChoice не задана своя дата

справочника
|Используется для генерации sql-запросов, а также для получения даты документа чтобы получать xslt схему, а также подтягивать данные из апи
|-
|Номер документа
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|}

'''Описание свойств таблицы'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип в БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Номер саба
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Поле сортировки
|orderField
|Поле, по которому сортируется

таблица
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by
|-
|Порядок сортировки
|orderMode
|Тип сортировки по возрастанию

или убыванию
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by для указания порядка сортировки
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Вроде используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Не копировать
|nocopy
|Не копировать
|<nowiki>---</nowiki>
|Если установлено true, то при копировании данного документа значения этого саба не копируются в новый документ
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|
|}
'''Описание свойств параметров'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое имя параметра
|
|Добавляется в сообщение об ошибке при обработке конкретного поля.

Пишется в логи при изменении записей справочника.

Выводится в описании полей АПИ

В фильтр плагине используется для наименования колонок результирующего датасета
|-
|Название в БД
|dbname
|Идентификатор параметра
|Используется для идентификации параметра
|Используется при формировании SQL-запросов, а также тэгов xml или параметров json
|-
|Тип
|metatype
|Тип параметра: Число

Целое число

Дата

Дата и время

Время

Строка

Логический

Ссылка
|
|Используется при получении значения из базы, а также при сохранении в базу
|-
|Первичный ключ
|primaryKey
|Параметр является первичным ключом
|Устанавливается при первом сохранении строки

саба. Получается в GET_AUTONUMERATOR_NEXTVAL
|Используется для задания первичного ключа для таблицы. Используется при генерации SQL-запросов
|-
|Внешний ключ
|foreignKey
|Параметр является внешним ключом
|Если при 1 сохранении документа тип перехагрузки - без

перезагрузки, то сабам 1 уровня проставляется foreignKey

как docId документа
|Используется для задания внешнего ключа для таблицы. Используется при генерации SQL-запросов
|-
|Сохранять в БД
|dbsaved
|Параметр сохраняется в БД
|Используется при формировании и парсинге xml
|Если true, то при формировании sql-запроса поле берется из таблицы иначе из таблицы референса с формированием join-ов.
|-
|Не копировать
|nocopy
|Параметр не переносится в копию при

копировании
|<nowiki>---</nowiki>
|Если true, то при копировании документа значение данного поля не переносится
|-
|Не пересчитывать
|norecalc
|
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Обязательный
|required
|Параметр обязательный к заполнению
|При создании xml правил такому параметру добавится

проверка на то, что он не пустой
|<nowiki>---</nowiki>
|-
|Номер документа
|пишется в docNumber у таблицы
|см. таблицу
|см. таблицу
|<nowiki>---</nowiki>
|-
|Ключ сортировки
|пишется в orderField у таблицы
|см. таблицу
|см. таблицу
|Используется в sql-запросе в секции order by
|-
|Тип сортировки
|пишется в orderMode у таблицы
|см. таблицу
|см. таблицу
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Автонумератор
|пишется в autoNumerate у таблицы
|Автоматическая нумерация
|Пересчитывается после externalCall или смены строк в сабе
|<nowiki>---</nowiki>
|-
|Включать в XML для АСУ
|fieldforasu
|Включать ли параметр в xml формируемую

для АСУ
|<nowiki>---</nowiki>
|Если true, то данное поле включается в xml возвращаемый по АСУ-АСУ
|-
|Название тега в XML
|nameforasu
|Имя тега в xml для АСУ
|<nowiki>---</nowiki>
|Если задано, то при формировании xml для АСУ-АСУ используется вместо dbname в качестве названия тэга
|-
|Описание
|description
|Описание параметра
|<nowiki>---</nowiki>
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Макс знаков
|totalDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает максимальную возможную длину числа (включая дробную часть)
|<nowiki>---</nowiki>
|-
|Дробных знаков
|fractionDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает длину дробной части
|<nowiki>---</nowiki>
|-
|Формат ввода и отображения
|format
|Выбор значения:

день.месяц.год

месяц.год

Свойство применяется для параметра с типом «Дата», «Дата и время», «Время»,
|В зависимости от этого формата, обнуляется часть даты.

Например если выбран формат день.месяц.год, обнуляется время
|<nowiki>---</nowiki>
|-
|Макс длина
|maxLength
|Свойство применяется для параметра с типом «Строка»
|Максимальная длина строки
|<nowiki>---</nowiki>
|-
|Тип выбора
|kind
|Свойство применяется для параметра с типом «Ссылка»

1. Из других документов\справочников

2. Из грида

3. Из апп-функции
|Тип ссылочного параметра, в зависимости от того что

выбрано
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Сущность
|cubeId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id куба
|<nowiki>---</nowiki>
|-
|АПИ чтения
|apiId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id апи
|Используется при генерации sql-запроса для получения данных из апи для разименования полей
|-
|Имя грида
|subName
|Свойство применяется для параметра с типом «Ссылка» Тип - из грида
|Имя грида из которого будут браться данные
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Апп-функция
|appFunc
|Свойство применяется для параметра с типом «Ссылка» Тип - из апп-функции
|Имя функции, которая будет использоваться вместо XM_QS
|<nowiki>---</nowiki>
|-
|XSLT преобразование
|transformId
|Свойство применяется для параметра с типом «XML»
|<nowiki>---</nowiki>
|Используется для преобразования xml при получении xml документа
|}
== Создание структуры документа из БД ==
Чтобы создать структуру из БД необходимо нажать на иконку на панели инструментов или перетащив её в рабочую область.

Откроется диалоговое окно с формой поиска. После ввода названия необходимо нажать на поиск.
Далее автоматически отображается список с названиями таблиц. Чтобы выбрать необходимую нужно ее выделить левой кнопкой мыши и нажать на кнопку «Да».[[Файл:Структура 7.png|без|мини]]

Закладка Структура Дизайнера документов

2022-08-22T08:20:51Z

Wiki: /* Создание структуры документа */

== Описание ==
Закладка Структура в Дизайнере документов предназначена для создания физической и логической модели электронного документа имеющая полное соответствие с хранением в базе данных:
[[Файл:Структура 1.png|без|мини]]Пошаговое описание создания структуры описано в [[Создание документа в Дизайнере документов xmlowcode|сценарии создания нового документа]].

== Панель инструментов закладки «Структура» ==
Закладка "Структура содержит панель инструментов с командами:
{|
|-
|Открытие/закрытие панели поиска параметров по таблицам структуры
|[[Файл:Структура 2.png|без|мини]]
|-
|Переключение отображения параметров таблиц на логическую/физическую модель
|[[Файл:Структура 3.png|без|мини]]
|-
|Добавление таблицы
|[[Файл:Структура 4.png|без|мини]]
|-
|Добавление параметра
|[[Файл:Структура 5.png|без|мини]]
|-
|Удаление выделенного объекта
|[[Файл:Структура 6.png|без|мини]]
|-
|Добавление таблицы из БД
|[[Файл:Структура 7.png|без|мини]]
|-
|Добавление таблицы и связанной таблицы по FK из БД
|[[Файл:Структура 8.png|без|мини]]
|-
|Добавление представления из БД
|[[Файл:Структура 9.png|без|мини]]
|-
|Добавление новых полей из БД для выбранных таблиц
|[[Файл:Структура 10.png|без|мини]]
|-
|Открытие диалога «Скрипты БД»
|[[Файл:Структура 11.png|без|мини]]
|-
|Экземпляр документа
|[[Файл:Структура 12.png|без|мини]]
|-
|Спецификация документа
|[[Файл:Структура 13.png|без|мини]]
|-
|Поднятие наверх (глубина) выбранной таблицы или представления
|[[Файл:Структура 14.png|без|мини]]
|-
|Опустить вниз (глубина) выбранную таблицу или представление
|[[Файл:Структура 15.png|без|мини]]
|-
|Экспортировать картинку
|[[Файл:Структура 16.png|без|мини]]
|}

== Поиск и навигация ==
На закладке Структура осуществляется поиск параметров и навигация таблиц.

=== Поиск параметров ===
'''1. Поиск по всем таблицам'''

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

Для поиска по всем таблицам необходимо нажать на поиск на панели инструментов слева и ввести название в поле поиска.
[[Файл:Структура 2.png|без|мини]]
После ввода названия параметра отобразятся все найденные значения с отображением наименования таблицы, в которой он находится.

Таблица с выбранным параметром будет отображена в центре рабочей области, параметр выделен.
[[Файл:Структура 17.png|без|мини]]
Для скрытия панели необходимо повторно нажать на иконку поиска на панели слева.

'''2. Поиск параметров по выбранной таблице'''

Для поиска параметра в выбранной таблице необходимо её выделить и нажать «Параметры» на панели навигации. Откроется панель с настройками видимости таблиц и параметров.

Далее необходимо ввести название искомого параметра.
[[Файл:Структура 18.png|без|мини]]
На панели Параметров для выбранной таблицы доступна следующая функциональность:

-Показать все параметры;

-Скрыть все параметры крое ключевых;

-Показать не сохраняемые в БД;

-Срыть не сохраняемые в БД;

- Обновление списка параметров.
[[Файл:Структура 20.png|без|мини]]

=== '''Навигация''' ===
В области навигации доступна следующая функциональность:

-Увеличение размера отображения рабочей области;

-Уменьшение размера отображения рабочей области;

-Установка исходного размера рабочей области;

-Возможность подогнать под размер схемы;

-Развернуть все таблицы;

-Свернуть все таблицы.
[[Файл:Структура 19.png|без|мини]]
== Создание структуры документа ==
'''<big>Добавление таблицы</big>'''

Для создания структуры документа необходимо нажать на панели инструментов слева «Добавить таблицу» или перетащить иконку в рабочую область. [[Файл:Структура 4.png|без|мини]]

Чтобы добавить дочернюю таблицу, необходимо еще раз нажать на «Добавить таблицу».

Для создания ссылочной связи между таблицами, которые были добавлены с помощью панели инструментов необходимо навести курсор мыши на таблицу до появления стрелки в "шапке" или параметре и далее протянуть до нужной таблицы.
[[Файл:Структура 22.1.png|без|мини]]
Добавить дочерние таблицы также можно наведя курсор мыши на выбранную таблицу, пока не появятся стрелки (слева, справа и снизу) .

При нажатии на стрелку левой кнопкой мыши, будет добавлена новая таблица в выбранном направлении.
[[Файл:Структура 23.png|без|мини]]
'''<big>Добавление параметра</big>'''

Добавить параметр для выбранной таблицы можно нажав на иконку «Добавить параметр» на панели инструментов или перетащив ее в необходимую таблицу.[[Файл:Структура 5.png|без|мини]]
== Свойства таблиц\представлений и параметров ==
Свойства таблицы\представления и параметров заполняются в правой части экрана в «Блоке свойств выбранной таблицы и параметра».

'''Описание свойств основной таблицы'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Дата справочника
|refBookDate
|Дата, на которую нужно искать

данные в справочниках
|Передается в поле API_DATE в listChoice, если у listChoice не задана своя дата

справочника
|Используется для генерации sql-запросов, а также для получения даты документа чтобы получать xslt схему, а также подтягивать данные из апи
|-
|Номер документа
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|}

'''Описание свойств таблицы'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип в БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Номер саба
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Поле сортировки
|orderField
|Поле, по которому сортируется

таблица
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by
|-
|Порядок сортировки
|orderMode
|Тип сортировки по возрастанию

или убыванию
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by для указания порядка сортировки
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Вроде используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Не копировать
|nocopy
|Не копировать
|<nowiki>---</nowiki>
|Если установлено true, то при копировании данного документа значения этого саба не копируются в новый документ
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|
|}
'''Описание свойств параметров'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое имя параметра
|
|Добавляется в сообщение об ошибке при обработке конкретного поля.

Пишется в логи при изменении записей справочника.

Выводится в описании полей АПИ

В фильтр плагине используется для наименования колонок результирующего датасета
|-
|Название в БД
|dbname
|Идентификатор параметра
|Используется для идентификации параметра
|Используется при формировании SQL-запросов, а также тэгов xml или параметров json
|-
|Тип
|metatype
|Тип параметра: Число

Целое число

Дата

Дата и время

Время

Строка

Логический

Ссылка
|
|Используется при получении значения из базы, а также при сохранении в базу
|-
|Первичный ключ
|primaryKey
|Параметр является первичным ключом
|Устанавливается при первом сохранении строки

саба. Получается в GET_AUTONUMERATOR_NEXTVAL
|Используется для задания первичного ключа для таблицы. Используется при генерации SQL-запросов
|-
|Внешний ключ
|foreignKey
|Параметр является внешним ключом
|Если при 1 сохранении документа тип перехагрузки - без

перезагрузки, то сабам 1 уровня проставляется foreignKey

как docId документа
|Используется для задания внешнего ключа для таблицы. Используется при генерации SQL-запросов
|-
|Сохранять в БД
|dbsaved
|Параметр сохраняется в БД
|Используется при формировании и парсинге xml
|Если true, то при формировании sql-запроса поле берется из таблицы иначе из таблицы референса с формированием join-ов.
|-
|Не копировать
|nocopy
|Параметр не переносится в копию при

копировании
|<nowiki>---</nowiki>
|Если true, то при копировании документа значение данного поля не переносится
|-
|Не пересчитывать
|norecalc
|
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Обязательный
|required
|Параметр обязательный к заполнению
|При создании xml правил такому параметру добавится

проверка на то, что он не пустой
|<nowiki>---</nowiki>
|-
|Номер документа
|пишется в docNumber у таблицы
|см. таблицу
|см. таблицу
|<nowiki>---</nowiki>
|-
|Ключ сортировки
|пишется в orderField у таблицы
|см. таблицу
|см. таблицу
|Используется в sql-запросе в секции order by
|-
|Тип сортировки
|пишется в orderMode у таблицы
|см. таблицу
|см. таблицу
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Автонумератор
|пишется в autoNumerate у таблицы
|Автоматическая нумерация
|Пересчитывается после externalCall или смены строк в сабе
|<nowiki>---</nowiki>
|-
|Включать в XML для АСУ
|fieldforasu
|Включать ли параметр в xml формируемую

для АСУ
|<nowiki>---</nowiki>
|Если true, то данное поле включается в xml возвращаемый по АСУ-АСУ
|-
|Название тега в XML
|nameforasu
|Имя тега в xml для АСУ
|<nowiki>---</nowiki>
|Если задано, то при формировании xml для АСУ-АСУ используется вместо dbname в качестве названия тэга
|-
|Описание
|description
|Описание параметра
|<nowiki>---</nowiki>
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Макс знаков
|totalDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает максимальную возможную длину числа (включая дробную часть)
|<nowiki>---</nowiki>
|-
|Дробных знаков
|fractionDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает длину дробной части
|<nowiki>---</nowiki>
|-
|Формат ввода и отображения
|format
|Выбор значения:

день.месяц.год

месяц.год

Свойство применяется для параметра с типом «Дата», «Дата и время», «Время»,
|В зависимости от этого формата, обнуляется часть даты.

Например если выбран формат день.месяц.год, обнуляется время
|<nowiki>---</nowiki>
|-
|Макс длина
|maxLength
|Свойство применяется для параметра с типом «Строка»
|Максимальная длина строки
|<nowiki>---</nowiki>
|-
|Тип выбора
|kind
|Свойство применяется для параметра с типом «Ссылка»

1. Из других документов\справочников

2. Из грида

3. Из апп-функции
|Тип ссылочного параметра, в зависимости от того что

выбрано
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Сущность
|cubeId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id куба
|<nowiki>---</nowiki>
|-
|АПИ чтения
|apiId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id апи
|Используется при генерации sql-запроса для получения данных из апи для разименования полей
|-
|Имя грида
|subName
|Свойство применяется для параметра с типом «Ссылка» Тип - из грида
|Имя грида из которого будут браться данные
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Апп-функция
|appFunc
|Свойство применяется для параметра с типом «Ссылка» Тип - из апп-функции
|Имя функции, которая будет использоваться вместо XM_QS
|<nowiki>---</nowiki>
|-
|XSLT преобразование
|transformId
|Свойство применяется для параметра с типом «XML»
|<nowiki>---</nowiki>
|Используется для преобразования xml при получении xml документа
|}
== Создание структуры документа из БД ==
Чтобы создать структуру из БД необходимо нажать на иконку на панели инструментов или перетащив её в рабочую область.

Откроется диалоговое окно с формой поиска. После ввода названия необходимо нажать на поиск.
Далее автоматически отображается список с названиями таблиц. Чтобы выбрать необходимую нужно ее выделить левой кнопкой мыши и нажать на кнопку «Да».[[Файл:Структура 7.png|без|мини]]

Файл:Структура 23.png

2022-08-22T08:13:46Z

Wiki:

Структура 23

Файл:Структура 22.1.png

2022-08-22T08:12:41Z

Wiki:

Структура 22.1

Файл:Структура 22.png

2022-08-22T08:09:55Z

Wiki:

Структура 22

Файл:Структура 21.png

2022-08-22T08:09:27Z

Wiki:

Структура 20

Закладка Структура Дизайнера документов

2022-07-29T09:54:26Z

Wiki: /* Поиск и навигация */

== Описание ==
Закладка Структура в Дизайнере документов предназначена для создания физической и логической модели электронного документа имеющая полное соответствие с хранением в базе данных:
[[Файл:Структура 1.png|без|мини]]

== Панель инструментов закладки «Структура» ==
Закладка "Структура содержит панель инструментов с командами:
{|
|-
|Открытие/закрытие панели поиска параметров по таблицам структуры
|[[Файл:Структура 2.png|без|мини]]
|-
|Переключение отображения параметров таблиц на логическую/физическую модель
|[[Файл:Структура 3.png|без|мини]]
|-
|Добавление таблицы
|[[Файл:Структура 4.png|без|мини]]
|-
|Добавление параметра
|[[Файл:Структура 5.png|без|мини]]
|-
|Удаление выделенного объекта
|[[Файл:Структура 6.png|без|мини]]
|-
|Добавление таблицы из БД
|[[Файл:Структура 7.png|без|мини]]
|-
|Добавление таблицы и связанной таблицы по FK из БД
|[[Файл:Структура 8.png|без|мини]]
|-
|Добавление представления из БД
|[[Файл:Структура 9.png|без|мини]]
|-
|Добавление новых полей из БД для выбранных таблиц
|[[Файл:Структура 10.png|без|мини]]
|-
|Открытие диалога «Скрипты БД»
|[[Файл:Структура 11.png|без|мини]]
|-
|Экземпляр документа
|[[Файл:Структура 12.png|без|мини]]
|-
|Спецификация документа
|[[Файл:Структура 13.png|без|мини]]
|-
|Поднятие наверх (глубина) выбранной таблицы или представления
|[[Файл:Структура 14.png|без|мини]]
|-
|Опустить вниз (глубина) выбранную таблицу или представление
|[[Файл:Структура 15.png|без|мини]]
|-
|Экспортировать картинку
|[[Файл:Структура 16.png|без|мини]]
|}

== Поиск и навигация ==
На закладке Структура осуществляется поиск параметров и навигация таблиц.

=== Поиск параметров ===
'''1. Поиск по всем таблицам'''

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

Для поиска по всем таблицам необходимо нажать на поиск на панели инструментов слева и ввести название в поле поиска.
[[Файл:Структура 2.png|без|мини]]
После ввода названия параметра отобразятся все найденные значения с отображением наименования таблицы, в которой он находится.

Таблица с выбранным параметром будет отображена в центре рабочей области, параметр выделен.
[[Файл:Структура 17.png|без|мини]]
Для скрытия панели необходимо повторно нажать на иконку поиска на панели слева.

'''2. Поиск параметров по выбранной таблице'''

Для поиска параметра в выбранной таблице необходимо её выделить и нажать «Параметры» на панели навигации. Откроется панель с настройками видимости таблиц и параметров.

Далее необходимо ввести название искомого параметра.
[[Файл:Структура 18.png|без|мини]]
На панели Параметров для выбранной таблицы доступна следующая функциональность:

-Показать все параметры;

-Скрыть все параметры крое ключевых;

-Показать не сохраняемые в БД;

-Срыть не сохраняемые в БД;

- Обновление списка параметров.
[[Файл:Структура 20.png|без|мини]]

=== '''Навигация''' ===
В области навигации доступна следующая функциональность:

-Увеличение размера отображения рабочей области;

-Уменьшение размера отображения рабочей области;

-Установка исходного размера рабочей области;

-Возможность подогнать под размер схемы;

-Развернуть все таблицы;

-Свернуть все таблицы.
[[Файл:Структура 19.png|без|мини]]
== Создание структуры документа ==
'''<big>Добавление таблицы</big>'''

Для создания структуры документа необходимо нажать на панели инструментов слева «Добавить таблицу» или перетащить иконку в рабочую область (Рисунок 47).

Первая таблица добавляется основная (родительская). Чтобы добавить последующие, необходимо еще раз нажать на «Добавить таблицу».

Добавить последующие таблицы также можно наведя курсор мыши на выбранную таблицу, пока не появятся стрелки (слева, справа и снизу) (Рисунок 48).

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

'''<big>Добавление параметра</big>'''

Добавить параметр для выбранной таблицы можно нажав на иконку «Добавить параметр» или перетащив ее в необходимую таблицу.

Рисунок 48 Добавление таблицы

== Создание структуры документа из БД ==
Чтобы создать структуру из БД необходимо нажать на иконку на панели инструментов (Таблица 9) или перетащив её в рабочую область. Откроется диалоговое окно с формой поиска. После ввода названия в поле поиска необходимо нажать на . Далее автоматически отображается список с названиями таблиц. Чтобы выбрать необходимую нужно ее выделить левой кнопкой мыши и нажать на кнопку «Да»[1] (Рисунок 49).

Рисунок 49 Создание структуры из БД

== Свойства таблиц\представлений и параметров ==
Свойства таблицы\представления и параметров заполняются в правой части экрана в «Блоке свойств выбранной таблицы и параметра».

'''Описание свойств основной таблицы'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Дата справочника
|refBookDate
|Дата, на которую нужно искать

данные в справочниках
|Передается в поле API_DATE в listChoice, если у listChoice не задана своя дата

справочника
|Используется для генерации sql-запросов, а также для получения даты документа чтобы получать xslt схему, а также подтягивать данные из апи
|-
|Номер документа
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|}

'''Описание свойств таблицы'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип в БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Номер саба
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Поле сортировки
|orderField
|Поле, по которому сортируется

таблица
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by
|-
|Порядок сортировки
|orderMode
|Тип сортировки по возрастанию

или убыванию
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by для указания порядка сортировки
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Вроде используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Не копировать
|nocopy
|Не копировать
|<nowiki>---</nowiki>
|Если установлено true, то при копировании данного документа значения этого саба не копируются в новый документ
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|
|}
'''Описание свойств параметров'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое имя параметра
|
|Добавляется в сообщение об ошибке при обработке конкретного поля.

Пишется в логи при изменении записей справочника.

Выводится в описании полей АПИ

В фильтр плагине используется для наименования колонок результирующего датасета
|-
|Название в БД
|dbname
|Идентификатор параметра
|Используется для идентификации параметра
|Используется при формировании SQL-запросов, а также тэгов xml или параметров json
|-
|Тип
|metatype
|Тип параметра: Число

Целое число

Дата

Дата и время

Время

Строка

Логический

Ссылка
|
|Используется при получении значения из базы, а также при сохранении в базу
|-
|Первичный ключ
|primaryKey
|Параметр является первичным ключом
|Устанавливается при первом сохранении строки

саба. Получается в GET_AUTONUMERATOR_NEXTVAL
|Используется для задания первичного ключа для таблицы. Используется при генерации SQL-запросов
|-
|Внешний ключ
|foreignKey
|Параметр является внешним ключом
|Если при 1 сохранении документа тип перехагрузки - без

перезагрузки, то сабам 1 уровня проставляется foreignKey

как docId документа
|Используется для задания внешнего ключа для таблицы. Используется при генерации SQL-запросов
|-
|Сохранять в БД
|dbsaved
|Параметр сохраняется в БД
|Используется при формировании и парсинге xml
|Если true, то при формировании sql-запроса поле берется из таблицы иначе из таблицы референса с формированием join-ов.
|-
|Не копировать
|nocopy
|Параметр не переносится в копию при

копировании
|<nowiki>---</nowiki>
|Если true, то при копировании документа значение данного поля не переносится
|-
|Не пересчитывать
|norecalc
|
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Обязательный
|required
|Параметр обязательный к заполнению
|При создании xml правил такому параметру добавится

проверка на то, что он не пустой
|<nowiki>---</nowiki>
|-
|Номер документа
|пишется в docNumber у таблицы
|см. таблицу
|см. таблицу
|<nowiki>---</nowiki>
|-
|Ключ сортировки
|пишется в orderField у таблицы
|см. таблицу
|см. таблицу
|Используется в sql-запросе в секции order by
|-
|Тип сортировки
|пишется в orderMode у таблицы
|см. таблицу
|см. таблицу
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Автонумератор
|пишется в autoNumerate у таблицы
|Автоматическая нумерация
|Пересчитывается после externalCall или смены строк в сабе
|<nowiki>---</nowiki>
|-
|Включать в XML для АСУ
|fieldforasu
|Включать ли параметр в xml формируемую

для АСУ
|<nowiki>---</nowiki>
|Если true, то данное поле включается в xml возвращаемый по АСУ-АСУ
|-
|Название тега в XML
|nameforasu
|Имя тега в xml для АСУ
|<nowiki>---</nowiki>
|Если задано, то при формировании xml для АСУ-АСУ используется вместо dbname в качестве названия тэга
|-
|Описание
|description
|Описание параметра
|<nowiki>---</nowiki>
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Макс знаков
|totalDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает максимальную возможную длину числа (включая дробную часть)
|<nowiki>---</nowiki>
|-
|Дробных знаков
|fractionDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает длину дробной части
|<nowiki>---</nowiki>
|-
|Формат ввода и отображения
|format
|Выбор значения:

день.месяц.год

месяц.год

Свойство применяется для параметра с типом «Дата», «Дата и время», «Время»,
|В зависимости от этого формата, обнуляется часть даты.

Например если выбран формат день.месяц.год, обнуляется время
|<nowiki>---</nowiki>
|-
|Макс длина
|maxLength
|Свойство применяется для параметра с типом «Строка»
|Максимальная длина строки
|<nowiki>---</nowiki>
|-
|Тип выбора
|kind
|Свойство применяется для параметра с типом «Ссылка»

1. Из других документов\справочников

2. Из грида

3. Из апп-функции
|Тип ссылочного параметра, в зависимости от того что

выбрано
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Сущность
|cubeId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id куба
|<nowiki>---</nowiki>
|-
|АПИ чтения
|apiId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id апи
|Используется при генерации sql-запроса для получения данных из апи для разименования полей
|-
|Имя грида
|subName
|Свойство применяется для параметра с типом «Ссылка» Тип - из грида
|Имя грида из которого будут браться данные
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Апп-функция
|appFunc
|Свойство применяется для параметра с типом «Ссылка» Тип - из апп-функции
|Имя функции, которая будет использоваться вместо XM_QS
|<nowiki>---</nowiki>
|-
|XSLT преобразование
|transformId
|Свойство применяется для параметра с типом «XML»
|<nowiki>---</nowiki>
|Используется для преобразования xml при получении xml документа
|}
== Добавление ссылочной связи таблиц ==
Для создания ссылочной связи между таблицами, которые были добавлены с помощью панели инструментов необходимо навести курсор мыши на таблицу до появления стрелки (Рисунок 51) и далее протянуть до нужной таблицы (Рисунок 52). При нарушении условий ссылочной связи между таблицами установить такую связь будет невозможно.

Рисунок 51 Добавление ссылочной связи (1 способ)

Рисунок 52 Добавление ссылочной связи (2 способ)

Значение «Родительского ключа (PRIMARY KEY)» и «Внешнего ключа (FOREIGN KEY)» отображается в левой колонке таблицы (Рисунок 53). Выполнить редактирование данного значения можно в «Блоке свойств выбранной таблицы или параметра»[2].

Рисунок 53 Отображение Родительского и Внешнего ключа

----[1] ''Примечание: Одинаковые таблицы из разных схем добавить нельзя''

[2] ''Примечание: Основная таблица не может иметь внешнего ключа''

[3] ''Примечание: Поиск параметров осуществляется в зависимости от выбранной модели таблиц (физическая/логическая)''

Закладка Структура Дизайнера документов

2022-07-29T09:51:28Z

Wiki: /* 1.1 Создание структуры документа */

== Описание ==
Закладка Структура в Дизайнере документов предназначена для создания физической и логической модели электронного документа имеющая полное соответствие с хранением в базе данных:
[[Файл:Структура 1.png|без|мини]]

== Панель инструментов закладки «Структура» ==
Закладка "Структура содержит панель инструментов с командами:
{|
|-
|Открытие/закрытие панели поиска параметров по таблицам структуры
|[[Файл:Структура 2.png|без|мини]]
|-
|Переключение отображения параметров таблиц на логическую/физическую модель
|[[Файл:Структура 3.png|без|мини]]
|-
|Добавление таблицы
|[[Файл:Структура 4.png|без|мини]]
|-
|Добавление параметра
|[[Файл:Структура 5.png|без|мини]]
|-
|Удаление выделенного объекта
|[[Файл:Структура 6.png|без|мини]]
|-
|Добавление таблицы из БД
|[[Файл:Структура 7.png|без|мини]]
|-
|Добавление таблицы и связанной таблицы по FK из БД
|[[Файл:Структура 8.png|без|мини]]
|-
|Добавление представления из БД
|[[Файл:Структура 9.png|без|мини]]
|-
|Добавление новых полей из БД для выбранных таблиц
|[[Файл:Структура 10.png|без|мини]]
|-
|Открытие диалога «Скрипты БД»
|[[Файл:Структура 11.png|без|мини]]
|-
|Экземпляр документа
|[[Файл:Структура 12.png|без|мини]]
|-
|Спецификация документа
|[[Файл:Структура 13.png|без|мини]]
|-
|Поднятие наверх (глубина) выбранной таблицы или представления
|[[Файл:Структура 14.png|без|мини]]
|-
|Опустить вниз (глубина) выбранную таблицу или представление
|[[Файл:Структура 15.png|без|мини]]
|-
|Экспортировать картинку
|[[Файл:Структура 16.png|без|мини]]
|}

== Поиск и навигация ==
На закладке Структура осуществляется поиск параметров и навигация таблиц.

=== Поиск параметров ===
'''1. Поиск по всем таблицам'''

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

Для поиска по всем таблицам необходимо нажать на поиск на панели инструментов слева и ввести название в поле поиска.
[[Файл:Структура 2.png|без|мини]]
После ввода названия параметра отобразятся все найденные значения с отображением наименования таблицы, в которой он находится.

Таблица с выбранным параметром будет отображена в центре рабочей области, параметр выделен.
[[Файл:Структура 17.png|без|мини]]
Для скрытия панели необходимо повторно нажать на иконку поиска на панели слева.

'''2. Поиск параметров по выбранной таблице'''

Для поиска параметра в выбранной таблице необходимо её выделить и нажать «Параметры» на панели навигации. Откроется панель с настройками видимости таблиц и параметров.

Далее необходимо ввести название искомого параметра.
[[Файл:Структура 18.png|без|мини]]
На панели Параметров для выбранной таблицы доступна следующая функциональность:

-Показать все параметры;

-Скрыть все параметры крое ключевых;

-Показать не сохраняемые в БД;

-Срыть не сохраняемые в БД;

- Обновление списка параметров.
[[Файл:Структура 20.png|без|мини]]
'''3. Навигация'''

В области навигации доступна следующая функциональность:

-Увеличение размера отображения рабочей области;

-Уменьшение размера отображения рабочей области;

-Установка исходного размера рабочей области;

-Возможность подогнать под размер схемы;

-Развернуть все таблицы;

-Свернуть все таблицы.
[[Файл:Структура 19.png|без|мини]]
== Создание структуры документа ==
'''<big>Добавление таблицы</big>'''

Для создания структуры документа необходимо нажать на панели инструментов слева «Добавить таблицу» или перетащить иконку в рабочую область (Рисунок 47).

Первая таблица добавляется основная (родительская). Чтобы добавить последующие, необходимо еще раз нажать на «Добавить таблицу».

Добавить последующие таблицы также можно наведя курсор мыши на выбранную таблицу, пока не появятся стрелки (слева, справа и снизу) (Рисунок 48).

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

'''<big>Добавление параметра</big>'''

Добавить параметр для выбранной таблицы можно нажав на иконку «Добавить параметр» или перетащив ее в необходимую таблицу.

Рисунок 48 Добавление таблицы

== Создание структуры документа из БД ==
Чтобы создать структуру из БД необходимо нажать на иконку на панели инструментов (Таблица 9) или перетащив её в рабочую область. Откроется диалоговое окно с формой поиска. После ввода названия в поле поиска необходимо нажать на . Далее автоматически отображается список с названиями таблиц. Чтобы выбрать необходимую нужно ее выделить левой кнопкой мыши и нажать на кнопку «Да»[1] (Рисунок 49).

Рисунок 49 Создание структуры из БД

== Свойства таблиц\представлений и параметров ==
Свойства таблицы\представления и параметров заполняются в правой части экрана в «Блоке свойств выбранной таблицы и параметра».

'''Описание свойств основной таблицы'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Дата справочника
|refBookDate
|Дата, на которую нужно искать

данные в справочниках
|Передается в поле API_DATE в listChoice, если у listChoice не задана своя дата

справочника
|Используется для генерации sql-запросов, а также для получения даты документа чтобы получать xslt схему, а также подтягивать данные из апи
|-
|Номер документа
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|}

'''Описание свойств таблицы'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип в БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Номер саба
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Поле сортировки
|orderField
|Поле, по которому сортируется

таблица
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by
|-
|Порядок сортировки
|orderMode
|Тип сортировки по возрастанию

или убыванию
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by для указания порядка сортировки
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Вроде используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Не копировать
|nocopy
|Не копировать
|<nowiki>---</nowiki>
|Если установлено true, то при копировании данного документа значения этого саба не копируются в новый документ
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|
|}
'''Описание свойств параметров'''
{|
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое имя параметра
|
|Добавляется в сообщение об ошибке при обработке конкретного поля.

Пишется в логи при изменении записей справочника.

Выводится в описании полей АПИ

В фильтр плагине используется для наименования колонок результирующего датасета
|-
|Название в БД
|dbname
|Идентификатор параметра
|Используется для идентификации параметра
|Используется при формировании SQL-запросов, а также тэгов xml или параметров json
|-
|Тип
|metatype
|Тип параметра: Число

Целое число

Дата

Дата и время

Время

Строка

Логический

Ссылка
|
|Используется при получении значения из базы, а также при сохранении в базу
|-
|Первичный ключ
|primaryKey
|Параметр является первичным ключом
|Устанавливается при первом сохранении строки

саба. Получается в GET_AUTONUMERATOR_NEXTVAL
|Используется для задания первичного ключа для таблицы. Используется при генерации SQL-запросов
|-
|Внешний ключ
|foreignKey
|Параметр является внешним ключом
|Если при 1 сохранении документа тип перехагрузки - без

перезагрузки, то сабам 1 уровня проставляется foreignKey

как docId документа
|Используется для задания внешнего ключа для таблицы. Используется при генерации SQL-запросов
|-
|Сохранять в БД
|dbsaved
|Параметр сохраняется в БД
|Используется при формировании и парсинге xml
|Если true, то при формировании sql-запроса поле берется из таблицы иначе из таблицы референса с формированием join-ов.
|-
|Не копировать
|nocopy
|Параметр не переносится в копию при

копировании
|<nowiki>---</nowiki>
|Если true, то при копировании документа значение данного поля не переносится
|-
|Не пересчитывать
|norecalc
|
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Обязательный
|required
|Параметр обязательный к заполнению
|При создании xml правил такому параметру добавится

проверка на то, что он не пустой
|<nowiki>---</nowiki>
|-
|Номер документа
|пишется в docNumber у таблицы
|см. таблицу
|см. таблицу
|<nowiki>---</nowiki>
|-
|Ключ сортировки
|пишется в orderField у таблицы
|см. таблицу
|см. таблицу
|Используется в sql-запросе в секции order by
|-
|Тип сортировки
|пишется в orderMode у таблицы
|см. таблицу
|см. таблицу
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Автонумератор
|пишется в autoNumerate у таблицы
|Автоматическая нумерация
|Пересчитывается после externalCall или смены строк в сабе
|<nowiki>---</nowiki>
|-
|Включать в XML для АСУ
|fieldforasu
|Включать ли параметр в xml формируемую

для АСУ
|<nowiki>---</nowiki>
|Если true, то данное поле включается в xml возвращаемый по АСУ-АСУ
|-
|Название тега в XML
|nameforasu
|Имя тега в xml для АСУ
|<nowiki>---</nowiki>
|Если задано, то при формировании xml для АСУ-АСУ используется вместо dbname в качестве названия тэга
|-
|Описание
|description
|Описание параметра
|<nowiki>---</nowiki>
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Макс знаков
|totalDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает максимальную возможную длину числа (включая дробную часть)
|<nowiki>---</nowiki>
|-
|Дробных знаков
|fractionDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает длину дробной части
|<nowiki>---</nowiki>
|-
|Формат ввода и отображения
|format
|Выбор значения:

день.месяц.год

месяц.год

Свойство применяется для параметра с типом «Дата», «Дата и время», «Время»,
|В зависимости от этого формата, обнуляется часть даты.

Например если выбран формат день.месяц.год, обнуляется время
|<nowiki>---</nowiki>
|-
|Макс длина
|maxLength
|Свойство применяется для параметра с типом «Строка»
|Максимальная длина строки
|<nowiki>---</nowiki>
|-
|Тип выбора
|kind
|Свойство применяется для параметра с типом «Ссылка»

1. Из других документов\справочников

2. Из грида

3. Из апп-функции
|Тип ссылочного параметра, в зависимости от того что

выбрано
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Сущность
|cubeId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id куба
|<nowiki>---</nowiki>
|-
|АПИ чтения
|apiId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id апи
|Используется при генерации sql-запроса для получения данных из апи для разименования полей
|-
|Имя грида
|subName
|Свойство применяется для параметра с типом «Ссылка» Тип - из грида
|Имя грида из которого будут браться данные
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Апп-функция
|appFunc
|Свойство применяется для параметра с типом «Ссылка» Тип - из апп-функции
|Имя функции, которая будет использоваться вместо XM_QS
|<nowiki>---</nowiki>
|-
|XSLT преобразование
|transformId
|Свойство применяется для параметра с типом «XML»
|<nowiki>---</nowiki>
|Используется для преобразования xml при получении xml документа
|}
== Добавление ссылочной связи таблиц ==
Для создания ссылочной связи между таблицами, которые были добавлены с помощью панели инструментов необходимо навести курсор мыши на таблицу до появления стрелки (Рисунок 51) и далее протянуть до нужной таблицы (Рисунок 52). При нарушении условий ссылочной связи между таблицами установить такую связь будет невозможно.

Рисунок 51 Добавление ссылочной связи (1 способ)

Рисунок 52 Добавление ссылочной связи (2 способ)

Значение «Родительского ключа (PRIMARY KEY)» и «Внешнего ключа (FOREIGN KEY)» отображается в левой колонке таблицы (Рисунок 53). Выполнить редактирование данного значения можно в «Блоке свойств выбранной таблицы или параметра»[2].

Рисунок 53 Отображение Родительского и Внешнего ключа

----[1] ''Примечание: Одинаковые таблицы из разных схем добавить нельзя''

[2] ''Примечание: Основная таблица не может иметь внешнего ключа''

[3] ''Примечание: Поиск параметров осуществляется в зависимости от выбранной модели таблиц (физическая/логическая)''

Закладка Структура Дизайнера документов

2022-07-29T08:38:12Z

Wiki: /* Поиск и навигация */

== Описание ==
Закладка Структура в Дизайнере документов предназначена для создания физической и логической модели электронного документа имеющая полное соответствие с хранением в базе данных:
[[Файл:Структура 1.png|без|мини]]

== Панель инструментов закладки «Структура» ==
Закладка "Структура содержит панель инструментов с командами:
{|
|-
|Открытие/закрытие панели поиска параметров по таблицам структуры
|[[Файл:Структура 2.png|без|мини]]
|-
|Переключение отображения параметров таблиц на логическую/физическую модель
|[[Файл:Структура 3.png|без|мини]]
|-
|Добавление таблицы
|[[Файл:Структура 4.png|без|мини]]
|-
|Добавление параметра
|[[Файл:Структура 5.png|без|мини]]
|-
|Удаление выделенного объекта
|[[Файл:Структура 6.png|без|мини]]
|-
|Добавление таблицы из БД
|[[Файл:Структура 7.png|без|мини]]
|-
|Добавление таблицы и связанной таблицы по FK из БД
|[[Файл:Структура 8.png|без|мини]]
|-
|Добавление представления из БД
|[[Файл:Структура 9.png|без|мини]]
|-
|Добавление новых полей из БД для выбранных таблиц
|[[Файл:Структура 10.png|без|мини]]
|-
|Открытие диалога «Скрипты БД»
|[[Файл:Структура 11.png|без|мини]]
|-
|Экземпляр документа
|[[Файл:Структура 12.png|без|мини]]
|-
|Спецификация документа
|[[Файл:Структура 13.png|без|мини]]
|-
|Поднятие наверх (глубина) выбранной таблицы или представления
|[[Файл:Структура 14.png|без|мини]]
|-
|Опустить вниз (глубина) выбранную таблицу или представление
|[[Файл:Структура 15.png|без|мини]]
|-
|Экспортировать картинку
|[[Файл:Структура 16.png|без|мини]]
|}

== Поиск и навигация ==
На закладке Структура осуществляется поиск параметров и навигация таблиц.

=== Поиск параметров ===
'''1. Поиск по всем таблицам'''

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

Для поиска по всем таблицам необходимо нажать на поиск на панели инструментов слева и ввести название в поле поиска.
[[Файл:Структура 2.png|без|мини]]
После ввода названия параметра отобразятся все найденные значения с отображением наименования таблицы, в которой он находится.

Таблица с выбранным параметром будет отображена в центре рабочей области, параметр выделен.
[[Файл:Структура 17.png|без|мини]]
Для скрытия панели необходимо повторно нажать на иконку поиска на панели слева.

'''2. Поиск параметров по выбранной таблице'''

Для поиска параметра в выбранной таблице необходимо её выделить и нажать «Параметры» на панели навигации. Откроется панель с настройками видимости таблиц и параметров.

Далее необходимо ввести название искомого параметра.
[[Файл:Структура 18.png|без|мини]]
На панели Параметров для выбранной таблицы доступна следующая функциональность:

-Показать все параметры;

-Скрыть все параметры крое ключевых;

-Показать не сохраняемые в БД;

-Срыть не сохраняемые в БД;

- Обновление списка параметров.
[[Файл:Структура 20.png|без|мини]]
'''3. Навигация'''

В области навигации доступна следующая функциональность:

-Увеличение размера отображения рабочей области;

-Уменьшение размера отображения рабочей области;

-Установка исходного размера рабочей области;

-Возможность подогнать под размер схемы;

-Развернуть все таблицы;

-Свернуть все таблицы.
[[Файл:Структура 19.png|без|мини]]
== 1.1 Создание структуры документа ==
Для создания структуры документа необходимо нажать в группе кнопок «Инструменты создания и редактирования таблиц» (Таблица 9) на панели инструментов «Добавить таблицу» или перетащить иконку в рабочую область (Рисунок 47). Первая таблица добавляется основная (родительская). Чтобы добавить последующие, необходимо еще раз нажать на «Добавить таблицу». Добавить последующие таблицы также можно наведя курсор мыши на выбранную таблицу, пока не появятся стрелки (слева, справа и снизу) (Рисунок 48). При нажатии на стрелку левой кнопкой мыши, будет добавлена новая таблица в выбранном направлении.

Добавить параметр для выбранной таблицы можно нажав на иконку «Добавить параметр» или перетащив ее в необходимую таблицу.

Рисунок 48 Добавление таблицы

== 1.2 Создание структуры документа из БД ==
Чтобы создать структуру из БД необходимо нажать на иконку на панели инструментов (Таблица 9) или перетащив её в рабочую область. Откроется диалоговое окно с формой поиска. После ввода названия в поле поиска необходимо нажать на . Далее автоматически отображается список с названиями таблиц. Чтобы выбрать необходимую нужно ее выделить левой кнопкой мыши и нажать на кнопку «Да»[1] (Рисунок 49).

Рисунок 49 Создание структуры из БД

== 1.3 Свойства таблиц\представлений и параметров ==
Свойства таблицы\представления и параметров заполняются в правой части экрана в «Блоке свойств выбранной таблицы и параметра».

Таблица 11 Описание свойств основной таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Дата справочника
|refBookDate
|Дата, на которую нужно искать

данные в справочниках
|Передается в поле API_DATE в listChoice, если у listChoice не задана своя дата

справочника
|Используется для генерации sql-запросов, а также для получения даты документа чтобы получать xslt схему, а также подтягивать данные из апи
|-
|Номер документа
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|}

Таблица 12 Описание свойств таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип в БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Номер саба
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Поле сортировки
|orderField
|Поле, по которому сортируется

таблица
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by
|-
|Порядок сортировки
|orderMode
|Тип сортировки по возрастанию

или убыванию
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by для указания порядка сортировки
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Вроде используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Не копировать
|nocopy
|Не копировать
|<nowiki>---</nowiki>
|Если установлено true, то при копировании данного документа значения этого саба не копируются в новый документ
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|
|}
Таблица 13 Описание свойств параметров
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое имя параметра
|
|Добавляется в сообщение об ошибке при обработке конкретного поля.

Пишется в логи при изменении записей справочника.

Выводится в описании полей АПИ

В фильтр плагине используется для наименования колонок результирующего датасета
|-
|Название в БД
|dbname
|Идентификатор параметра
|Используется для идентификации параметра
|Используется при формировании SQL-запросов, а также тэгов xml или параметров json
|-
|Тип
|metatype
|Тип параметра: Число

Целое число

Дата

Дата и время

Время

Строка

Логический

Ссылка
|
|Используется при получении значения из базы, а также при сохранении в базу
|-
|Первичный ключ
|primaryKey
|Параметр является первичным ключом
|Устанавливается при первом сохранении строки

саба. Получается в GET_AUTONUMERATOR_NEXTVAL
|Используется для задания первичного ключа для таблицы. Используется при генерации SQL-запросов
|-
|Внешний ключ
|foreignKey
|Параметр является внешним ключом
|Если при 1 сохранении документа тип перехагрузки - без

перезагрузки, то сабам 1 уровня проставляется foreignKey

как docId документа
|Используется для задания внешнего ключа для таблицы. Используется при генерации SQL-запросов
|-
|Сохранять в БД
|dbsaved
|Параметр сохраняется в БД
|Используется при формировании и парсинге xml
|Если true, то при формировании sql-запроса поле берется из таблицы иначе из таблицы референса с формированием join-ов.
|-
|Не копировать
|nocopy
|Параметр не переносится в копию при

копировании
|<nowiki>---</nowiki>
|Если true, то при копировании документа значение данного поля не переносится
|-
|Не пересчитывать
|norecalc
|
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Обязательный
|required
|Параметр обязательный к заполнению
|При создании xml правил такому параметру добавится

проверка на то, что он не пустой
|<nowiki>---</nowiki>
|-
|Номер документа
|пишется в docNumber у таблицы
|см. таблицу
|см. таблицу
|<nowiki>---</nowiki>
|-
|Ключ сортировки
|пишется в orderField у таблицы
|см. таблицу
|см. таблицу
|Используется в sql-запросе в секции order by
|-
|Тип сортировки
|пишется в orderMode у таблицы
|см. таблицу
|см. таблицу
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Автонумератор
|пишется в autoNumerate у таблицы
|Автоматическая нумерация
|Пересчитывается после externalCall или смены строк в сабе
|<nowiki>---</nowiki>
|-
|Включать в XML для АСУ
|fieldforasu
|Включать ли параметр в xml формируемую

для АСУ
|<nowiki>---</nowiki>
|Если true, то данное поле включается в xml возвращаемый по АСУ-АСУ
|-
|Название тега в XML
|nameforasu
|Имя тега в xml для АСУ
|<nowiki>---</nowiki>
|Если задано, то при формировании xml для АСУ-АСУ используется вместо dbname в качестве названия тэга
|-
|Описание
|description
|Описание параметра
|<nowiki>---</nowiki>
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Макс знаков
|totalDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает максимальную возможную длину числа (включая дробную часть)
|<nowiki>---</nowiki>
|-
|Дробных знаков
|fractionDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает длину дробной части
|<nowiki>---</nowiki>
|-
|Формат ввода и отображения
|format
|Выбор значения:

день.месяц.год

месяц.год

Свойство применяется для параметра с типом «Дата», «Дата и время», «Время»,
|В зависимости от этого формата, обнуляется часть даты.

Например если выбран формат день.месяц.год, обнуляется время
|<nowiki>---</nowiki>
|-
|Макс длина
|maxLength
|Свойство применяется для параметра с типом «Строка»
|Максимальная длина строки
|<nowiki>---</nowiki>
|-
|Тип выбора
|kind
|Свойство применяется для параметра с типом «Ссылка»

1. Из других документов\справочников

2. Из грида

3. Из апп-функции
|Тип ссылочного параметра, в зависимости от того что

выбрано
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Сущность
|cubeId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id куба
|<nowiki>---</nowiki>
|-
|АПИ чтения
|apiId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id апи
|Используется при генерации sql-запроса для получения данных из апи для разименования полей
|-
|Имя грида
|subName
|Свойство применяется для параметра с типом «Ссылка» Тип - из грида
|Имя грида из которого будут браться данные
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Апп-функция
|appFunc
|Свойство применяется для параметра с типом «Ссылка» Тип - из апп-функции
|Имя функции, которая будет использоваться вместо XM_QS
|<nowiki>---</nowiki>
|-
|XSLT преобразование
|transformId
|Свойство применяется для параметра с типом «XML»
|<nowiki>---</nowiki>
|Используется для преобразования xml при получении xml документа
|}

Для отображения или скрытия параметров таблицы необходимо нажать на -/+ в левом верхнем углу таблицы (Рисунок 50)

Рисунок 50 Открыть/скрыть параметры в таблице

== 1.4 Добавление ссылочной связи таблиц ==
Для создания ссылочной связи между таблицами, которые были добавлены с помощью панели инструментов необходимо навести курсор мыши на таблицу до появления стрелки (Рисунок 51) и далее протянуть до нужной таблицы (Рисунок 52). При нарушении условий ссылочной связи между таблицами установить такую связь будет невозможно.

Рисунок 51 Добавление ссылочной связи (1 способ)

Рисунок 52 Добавление ссылочной связи (2 способ)

Значение «Родительского ключа (PRIMARY KEY)» и «Внешнего ключа (FOREIGN KEY)» отображается в левой колонке таблицы (Рисунок 53). Выполнить редактирование данного значения можно в «Блоке свойств выбранной таблицы или параметра»[2].

Рисунок 53 Отображение Родительского и Внешнего ключа

----[1] ''Примечание: Одинаковые таблицы из разных схем добавить нельзя''

[2] ''Примечание: Основная таблица не может иметь внешнего ключа''

[3] ''Примечание: Поиск параметров осуществляется в зависимости от выбранной модели таблиц (физическая/логическая)''

Файл:Структура 20.png

2022-07-29T08:38:01Z

Wiki:

Структура 20

Файл:Структура 19.png

2022-07-29T08:32:33Z

Wiki:

Структура 19

Файл:Структура 18.png

2022-07-29T08:27:54Z

Wiki:

Структура 18

Закладка Структура Дизайнера документов

2022-07-29T08:26:52Z

Wiki: /* Поиск и навигация */

== Описание ==
Закладка Структура в Дизайнере документов предназначена для создания физической и логической модели электронного документа имеющая полное соответствие с хранением в базе данных:
[[Файл:Структура 1.png|без|мини]]

== Панель инструментов закладки «Структура» ==
Закладка "Структура содержит панель инструментов с командами:
{|
|-
|Открытие/закрытие панели поиска параметров по таблицам структуры
|[[Файл:Структура 2.png|без|мини]]
|-
|Переключение отображения параметров таблиц на логическую/физическую модель
|[[Файл:Структура 3.png|без|мини]]
|-
|Добавление таблицы
|[[Файл:Структура 4.png|без|мини]]
|-
|Добавление параметра
|[[Файл:Структура 5.png|без|мини]]
|-
|Удаление выделенного объекта
|[[Файл:Структура 6.png|без|мини]]
|-
|Добавление таблицы из БД
|[[Файл:Структура 7.png|без|мини]]
|-
|Добавление таблицы и связанной таблицы по FK из БД
|[[Файл:Структура 8.png|без|мини]]
|-
|Добавление представления из БД
|[[Файл:Структура 9.png|без|мини]]
|-
|Добавление новых полей из БД для выбранных таблиц
|[[Файл:Структура 10.png|без|мини]]
|-
|Открытие диалога «Скрипты БД»
|[[Файл:Структура 11.png|без|мини]]
|-
|Экземпляр документа
|[[Файл:Структура 12.png|без|мини]]
|-
|Спецификация документа
|[[Файл:Структура 13.png|без|мини]]
|-
|Поднятие наверх (глубина) выбранной таблицы или представления
|[[Файл:Структура 14.png|без|мини]]
|-
|Опустить вниз (глубина) выбранную таблицу или представление
|[[Файл:Структура 15.png|без|мини]]
|-
|Экспортировать картинку
|[[Файл:Структура 16.png|без|мини]]
|}

== Поиск и навигация ==
На закладке Структура осуществляется поиск параметров и навигация таблиц.

=== Поиск параметров ===
'''1. Поиск по всем таблицам'''

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

Для поиска по всем таблицам необходимо нажать на поиск на панели инструментов слева и ввести название в поле поиска.
[[Файл:Структура 2.png|без|мини]]
После ввода названия параметра отобразятся все найденные значения с отображением наименования таблицы, в которой он находится.

Таблица с выбранным параметром будет отображена в центре рабочей области, параметр выделен.
[[Файл:Структура 17.png|без|мини]]
Для скрытия панели необходимо повторно нажать на иконку поиска на панели слева.

'''2. Поиск параметров по выбранной таблице'''

Для поиска параметра в выбранной таблице необходимо её выделить и нажать «Параметры» на панели навигации. Откроется панель с настройками видимости таблиц и параметров.

Далее необходимо ввести название искомого параметра (Рисунок 55).

Рисунок 55 Поиск параметров в выбранной таблице
{| class="wikitable"
|-
|Увеличить размер отображения рабочей области
| rowspan="6" |
|-
|Уменьшить размер отображения рабочей области
|-
|Установить исходный размер рабочей области
|-
|Подогнать под размер схемы
|-
|Развернуть все таблицы
|-
|Свернуть все таблицы
|}

== 1.1 Создание структуры документа ==
Для создания структуры документа необходимо нажать в группе кнопок «Инструменты создания и редактирования таблиц» (Таблица 9) на панели инструментов «Добавить таблицу» или перетащить иконку в рабочую область (Рисунок 47). Первая таблица добавляется основная (родительская). Чтобы добавить последующие, необходимо еще раз нажать на «Добавить таблицу». Добавить последующие таблицы также можно наведя курсор мыши на выбранную таблицу, пока не появятся стрелки (слева, справа и снизу) (Рисунок 48). При нажатии на стрелку левой кнопкой мыши, будет добавлена новая таблица в выбранном направлении.

Добавить параметр для выбранной таблицы можно нажав на иконку «Добавить параметр» или перетащив ее в необходимую таблицу.

Рисунок 48 Добавление таблицы

== 1.2 Создание структуры документа из БД ==
Чтобы создать структуру из БД необходимо нажать на иконку на панели инструментов (Таблица 9) или перетащив её в рабочую область. Откроется диалоговое окно с формой поиска. После ввода названия в поле поиска необходимо нажать на . Далее автоматически отображается список с названиями таблиц. Чтобы выбрать необходимую нужно ее выделить левой кнопкой мыши и нажать на кнопку «Да»[1] (Рисунок 49).

Рисунок 49 Создание структуры из БД

== 1.3 Свойства таблиц\представлений и параметров ==
Свойства таблицы\представления и параметров заполняются в правой части экрана в «Блоке свойств выбранной таблицы и параметра».

Таблица 11 Описание свойств основной таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Дата справочника
|refBookDate
|Дата, на которую нужно искать

данные в справочниках
|Передается в поле API_DATE в listChoice, если у listChoice не задана своя дата

справочника
|Используется для генерации sql-запросов, а также для получения даты документа чтобы получать xslt схему, а также подтягивать данные из апи
|-
|Номер документа
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|}

Таблица 12 Описание свойств таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип в БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Номер саба
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Поле сортировки
|orderField
|Поле, по которому сортируется

таблица
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by
|-
|Порядок сортировки
|orderMode
|Тип сортировки по возрастанию

или убыванию
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by для указания порядка сортировки
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Вроде используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Не копировать
|nocopy
|Не копировать
|<nowiki>---</nowiki>
|Если установлено true, то при копировании данного документа значения этого саба не копируются в новый документ
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|
|}
Таблица 13 Описание свойств параметров
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое имя параметра
|
|Добавляется в сообщение об ошибке при обработке конкретного поля.

Пишется в логи при изменении записей справочника.

Выводится в описании полей АПИ

В фильтр плагине используется для наименования колонок результирующего датасета
|-
|Название в БД
|dbname
|Идентификатор параметра
|Используется для идентификации параметра
|Используется при формировании SQL-запросов, а также тэгов xml или параметров json
|-
|Тип
|metatype
|Тип параметра: Число

Целое число

Дата

Дата и время

Время

Строка

Логический

Ссылка
|
|Используется при получении значения из базы, а также при сохранении в базу
|-
|Первичный ключ
|primaryKey
|Параметр является первичным ключом
|Устанавливается при первом сохранении строки

саба. Получается в GET_AUTONUMERATOR_NEXTVAL
|Используется для задания первичного ключа для таблицы. Используется при генерации SQL-запросов
|-
|Внешний ключ
|foreignKey
|Параметр является внешним ключом
|Если при 1 сохранении документа тип перехагрузки - без

перезагрузки, то сабам 1 уровня проставляется foreignKey

как docId документа
|Используется для задания внешнего ключа для таблицы. Используется при генерации SQL-запросов
|-
|Сохранять в БД
|dbsaved
|Параметр сохраняется в БД
|Используется при формировании и парсинге xml
|Если true, то при формировании sql-запроса поле берется из таблицы иначе из таблицы референса с формированием join-ов.
|-
|Не копировать
|nocopy
|Параметр не переносится в копию при

копировании
|<nowiki>---</nowiki>
|Если true, то при копировании документа значение данного поля не переносится
|-
|Не пересчитывать
|norecalc
|
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Обязательный
|required
|Параметр обязательный к заполнению
|При создании xml правил такому параметру добавится

проверка на то, что он не пустой
|<nowiki>---</nowiki>
|-
|Номер документа
|пишется в docNumber у таблицы
|см. таблицу
|см. таблицу
|<nowiki>---</nowiki>
|-
|Ключ сортировки
|пишется в orderField у таблицы
|см. таблицу
|см. таблицу
|Используется в sql-запросе в секции order by
|-
|Тип сортировки
|пишется в orderMode у таблицы
|см. таблицу
|см. таблицу
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Автонумератор
|пишется в autoNumerate у таблицы
|Автоматическая нумерация
|Пересчитывается после externalCall или смены строк в сабе
|<nowiki>---</nowiki>
|-
|Включать в XML для АСУ
|fieldforasu
|Включать ли параметр в xml формируемую

для АСУ
|<nowiki>---</nowiki>
|Если true, то данное поле включается в xml возвращаемый по АСУ-АСУ
|-
|Название тега в XML
|nameforasu
|Имя тега в xml для АСУ
|<nowiki>---</nowiki>
|Если задано, то при формировании xml для АСУ-АСУ используется вместо dbname в качестве названия тэга
|-
|Описание
|description
|Описание параметра
|<nowiki>---</nowiki>
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Макс знаков
|totalDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает максимальную возможную длину числа (включая дробную часть)
|<nowiki>---</nowiki>
|-
|Дробных знаков
|fractionDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает длину дробной части
|<nowiki>---</nowiki>
|-
|Формат ввода и отображения
|format
|Выбор значения:

день.месяц.год

месяц.год

Свойство применяется для параметра с типом «Дата», «Дата и время», «Время»,
|В зависимости от этого формата, обнуляется часть даты.

Например если выбран формат день.месяц.год, обнуляется время
|<nowiki>---</nowiki>
|-
|Макс длина
|maxLength
|Свойство применяется для параметра с типом «Строка»
|Максимальная длина строки
|<nowiki>---</nowiki>
|-
|Тип выбора
|kind
|Свойство применяется для параметра с типом «Ссылка»

1. Из других документов\справочников

2. Из грида

3. Из апп-функции
|Тип ссылочного параметра, в зависимости от того что

выбрано
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Сущность
|cubeId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id куба
|<nowiki>---</nowiki>
|-
|АПИ чтения
|apiId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id апи
|Используется при генерации sql-запроса для получения данных из апи для разименования полей
|-
|Имя грида
|subName
|Свойство применяется для параметра с типом «Ссылка» Тип - из грида
|Имя грида из которого будут браться данные
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Апп-функция
|appFunc
|Свойство применяется для параметра с типом «Ссылка» Тип - из апп-функции
|Имя функции, которая будет использоваться вместо XM_QS
|<nowiki>---</nowiki>
|-
|XSLT преобразование
|transformId
|Свойство применяется для параметра с типом «XML»
|<nowiki>---</nowiki>
|Используется для преобразования xml при получении xml документа
|}

Для отображения или скрытия параметров таблицы необходимо нажать на -/+ в левом верхнем углу таблицы (Рисунок 50)

Рисунок 50 Открыть/скрыть параметры в таблице

== 1.4 Добавление ссылочной связи таблиц ==
Для создания ссылочной связи между таблицами, которые были добавлены с помощью панели инструментов необходимо навести курсор мыши на таблицу до появления стрелки (Рисунок 51) и далее протянуть до нужной таблицы (Рисунок 52). При нарушении условий ссылочной связи между таблицами установить такую связь будет невозможно.

Рисунок 51 Добавление ссылочной связи (1 способ)

Рисунок 52 Добавление ссылочной связи (2 способ)

Значение «Родительского ключа (PRIMARY KEY)» и «Внешнего ключа (FOREIGN KEY)» отображается в левой колонке таблицы (Рисунок 53). Выполнить редактирование данного значения можно в «Блоке свойств выбранной таблицы или параметра»[2].

Рисунок 53 Отображение Родительского и Внешнего ключа

----[1] ''Примечание: Одинаковые таблицы из разных схем добавить нельзя''

[2] ''Примечание: Основная таблица не может иметь внешнего ключа''

[3] ''Примечание: Поиск параметров осуществляется в зависимости от выбранной модели таблиц (физическая/логическая)''

Файл:Структура 17.png

2022-07-29T07:39:10Z

Wiki:

Структура 17

Закладка Структура Дизайнера документов

2022-07-29T07:34:01Z

Wiki:

== Описание ==
Закладка Структура в Дизайнере документов предназначена для создания физической и логической модели электронного документа имеющая полное соответствие с хранением в базе данных:
[[Файл:Структура 1.png|без|мини]]

== Панель инструментов закладки «Структура» ==
Закладка "Структура содержит панель инструментов с командами:
{|
|-
|Открытие/закрытие панели поиска параметров по таблицам структуры
|[[Файл:Структура 2.png|без|мини]]
|-
|Переключение отображения параметров таблиц на логическую/физическую модель
|[[Файл:Структура 3.png|без|мини]]
|-
|Добавление таблицы
|[[Файл:Структура 4.png|без|мини]]
|-
|Добавление параметра
|[[Файл:Структура 5.png|без|мини]]
|-
|Удаление выделенного объекта
|[[Файл:Структура 6.png|без|мини]]
|-
|Добавление таблицы из БД
|[[Файл:Структура 7.png|без|мини]]
|-
|Добавление таблицы и связанной таблицы по FK из БД
|[[Файл:Структура 8.png|без|мини]]
|-
|Добавление представления из БД
|[[Файл:Структура 9.png|без|мини]]
|-
|Добавление новых полей из БД для выбранных таблиц
|[[Файл:Структура 10.png|без|мини]]
|-
|Открытие диалога «Скрипты БД»
|[[Файл:Структура 11.png|без|мини]]
|-
|Экземпляр документа
|[[Файл:Структура 12.png|без|мини]]
|-
|Спецификация документа
|[[Файл:Структура 13.png|без|мини]]
|-
|Поднятие наверх (глубина) выбранной таблицы или представления
|[[Файл:Структура 14.png|без|мини]]
|-
|Опустить вниз (глубина) выбранную таблицу или представление
|[[Файл:Структура 15.png|без|мини]]
|-
|Экспортировать картинку
|[[Файл:Структура 16.png|без|мини]]
|}

== Поиск и навигация ==
На закладке Структура осуществляется поиск параметров и навигация таблиц.

=== Поиск параметров ===
Поиск параметров может осуществляться во всех таблицах или в выбранной.

Для поиска по всем таблицам необходимо нажать на поиск на панели инструментов слева и ввести название в поле поиска.
[[Файл:Структура 2.png|без|мини]]
После ввода названия параметра отобразятся все найденные значения с отображением наименования таблицы, в которой он находится.

Таблица с выбранным параметром будет отображена в центре рабочей области, параметр выделен.

Для редактирования найденного параметра необходимо нажать на панели навигации «Параметры» (Рисунок 54).

Рисунок 54 Поиск параметра в таблицах и просмотр его свойств

=== 1.5.2 Поиск параметров по выбранной таблице ===
Для поиска параметра в выбранной таблице необходимо её выделить и нажать «Параметры». Откроется панель с настройками видимости таблиц и параметров. Далее необходимо ввести название искомого параметра (Рисунок 55).

Рисунок 55 Поиск параметров в выбранной таблице
{| class="wikitable"
|-
|Увеличить размер отображения рабочей области
| rowspan="6" |
|-
|Уменьшить размер отображения рабочей области
|-
|Установить исходный размер рабочей области
|-
|Подогнать под размер схемы
|-
|Развернуть все таблицы
|-
|Свернуть все таблицы
|}

== 1.1 Создание структуры документа ==
Для создания структуры документа необходимо нажать в группе кнопок «Инструменты создания и редактирования таблиц» (Таблица 9) на панели инструментов «Добавить таблицу» или перетащить иконку в рабочую область (Рисунок 47). Первая таблица добавляется основная (родительская). Чтобы добавить последующие, необходимо еще раз нажать на «Добавить таблицу». Добавить последующие таблицы также можно наведя курсор мыши на выбранную таблицу, пока не появятся стрелки (слева, справа и снизу) (Рисунок 48). При нажатии на стрелку левой кнопкой мыши, будет добавлена новая таблица в выбранном направлении.

Добавить параметр для выбранной таблицы можно нажав на иконку «Добавить параметр» или перетащив ее в необходимую таблицу.

Рисунок 48 Добавление таблицы

== 1.2 Создание структуры документа из БД ==
Чтобы создать структуру из БД необходимо нажать на иконку на панели инструментов (Таблица 9) или перетащив её в рабочую область. Откроется диалоговое окно с формой поиска. После ввода названия в поле поиска необходимо нажать на . Далее автоматически отображается список с названиями таблиц. Чтобы выбрать необходимую нужно ее выделить левой кнопкой мыши и нажать на кнопку «Да»[1] (Рисунок 49).

Рисунок 49 Создание структуры из БД

== 1.3 Свойства таблиц\представлений и параметров ==
Свойства таблицы\представления и параметров заполняются в правой части экрана в «Блоке свойств выбранной таблицы и параметра».

Таблица 11 Описание свойств основной таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Дата справочника
|refBookDate
|Дата, на которую нужно искать

данные в справочниках
|Передается в поле API_DATE в listChoice, если у listChoice не задана своя дата

справочника
|Используется для генерации sql-запросов, а также для получения даты документа чтобы получать xslt схему, а также подтягивать данные из апи
|-
|Номер документа
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|}

Таблица 12 Описание свойств таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип в БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Номер саба
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Поле сортировки
|orderField
|Поле, по которому сортируется

таблица
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by
|-
|Порядок сортировки
|orderMode
|Тип сортировки по возрастанию

или убыванию
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by для указания порядка сортировки
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Вроде используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Не копировать
|nocopy
|Не копировать
|<nowiki>---</nowiki>
|Если установлено true, то при копировании данного документа значения этого саба не копируются в новый документ
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|
|}
Таблица 13 Описание свойств параметров
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое имя параметра
|
|Добавляется в сообщение об ошибке при обработке конкретного поля.

Пишется в логи при изменении записей справочника.

Выводится в описании полей АПИ

В фильтр плагине используется для наименования колонок результирующего датасета
|-
|Название в БД
|dbname
|Идентификатор параметра
|Используется для идентификации параметра
|Используется при формировании SQL-запросов, а также тэгов xml или параметров json
|-
|Тип
|metatype
|Тип параметра: Число

Целое число

Дата

Дата и время

Время

Строка

Логический

Ссылка
|
|Используется при получении значения из базы, а также при сохранении в базу
|-
|Первичный ключ
|primaryKey
|Параметр является первичным ключом
|Устанавливается при первом сохранении строки

саба. Получается в GET_AUTONUMERATOR_NEXTVAL
|Используется для задания первичного ключа для таблицы. Используется при генерации SQL-запросов
|-
|Внешний ключ
|foreignKey
|Параметр является внешним ключом
|Если при 1 сохранении документа тип перехагрузки - без

перезагрузки, то сабам 1 уровня проставляется foreignKey

как docId документа
|Используется для задания внешнего ключа для таблицы. Используется при генерации SQL-запросов
|-
|Сохранять в БД
|dbsaved
|Параметр сохраняется в БД
|Используется при формировании и парсинге xml
|Если true, то при формировании sql-запроса поле берется из таблицы иначе из таблицы референса с формированием join-ов.
|-
|Не копировать
|nocopy
|Параметр не переносится в копию при

копировании
|<nowiki>---</nowiki>
|Если true, то при копировании документа значение данного поля не переносится
|-
|Не пересчитывать
|norecalc
|
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Обязательный
|required
|Параметр обязательный к заполнению
|При создании xml правил такому параметру добавится

проверка на то, что он не пустой
|<nowiki>---</nowiki>
|-
|Номер документа
|пишется в docNumber у таблицы
|см. таблицу
|см. таблицу
|<nowiki>---</nowiki>
|-
|Ключ сортировки
|пишется в orderField у таблицы
|см. таблицу
|см. таблицу
|Используется в sql-запросе в секции order by
|-
|Тип сортировки
|пишется в orderMode у таблицы
|см. таблицу
|см. таблицу
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Автонумератор
|пишется в autoNumerate у таблицы
|Автоматическая нумерация
|Пересчитывается после externalCall или смены строк в сабе
|<nowiki>---</nowiki>
|-
|Включать в XML для АСУ
|fieldforasu
|Включать ли параметр в xml формируемую

для АСУ
|<nowiki>---</nowiki>
|Если true, то данное поле включается в xml возвращаемый по АСУ-АСУ
|-
|Название тега в XML
|nameforasu
|Имя тега в xml для АСУ
|<nowiki>---</nowiki>
|Если задано, то при формировании xml для АСУ-АСУ используется вместо dbname в качестве названия тэга
|-
|Описание
|description
|Описание параметра
|<nowiki>---</nowiki>
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Макс знаков
|totalDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает максимальную возможную длину числа (включая дробную часть)
|<nowiki>---</nowiki>
|-
|Дробных знаков
|fractionDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает длину дробной части
|<nowiki>---</nowiki>
|-
|Формат ввода и отображения
|format
|Выбор значения:

день.месяц.год

месяц.год

Свойство применяется для параметра с типом «Дата», «Дата и время», «Время»,
|В зависимости от этого формата, обнуляется часть даты.

Например если выбран формат день.месяц.год, обнуляется время
|<nowiki>---</nowiki>
|-
|Макс длина
|maxLength
|Свойство применяется для параметра с типом «Строка»
|Максимальная длина строки
|<nowiki>---</nowiki>
|-
|Тип выбора
|kind
|Свойство применяется для параметра с типом «Ссылка»

1. Из других документов\справочников

2. Из грида

3. Из апп-функции
|Тип ссылочного параметра, в зависимости от того что

выбрано
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Сущность
|cubeId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id куба
|<nowiki>---</nowiki>
|-
|АПИ чтения
|apiId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id апи
|Используется при генерации sql-запроса для получения данных из апи для разименования полей
|-
|Имя грида
|subName
|Свойство применяется для параметра с типом «Ссылка» Тип - из грида
|Имя грида из которого будут браться данные
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Апп-функция
|appFunc
|Свойство применяется для параметра с типом «Ссылка» Тип - из апп-функции
|Имя функции, которая будет использоваться вместо XM_QS
|<nowiki>---</nowiki>
|-
|XSLT преобразование
|transformId
|Свойство применяется для параметра с типом «XML»
|<nowiki>---</nowiki>
|Используется для преобразования xml при получении xml документа
|}

Для отображения или скрытия параметров таблицы необходимо нажать на -/+ в левом верхнем углу таблицы (Рисунок 50)

Рисунок 50 Открыть/скрыть параметры в таблице

== 1.4 Добавление ссылочной связи таблиц ==
Для создания ссылочной связи между таблицами, которые были добавлены с помощью панели инструментов необходимо навести курсор мыши на таблицу до появления стрелки (Рисунок 51) и далее протянуть до нужной таблицы (Рисунок 52). При нарушении условий ссылочной связи между таблицами установить такую связь будет невозможно.

Рисунок 51 Добавление ссылочной связи (1 способ)

Рисунок 52 Добавление ссылочной связи (2 способ)

Значение «Родительского ключа (PRIMARY KEY)» и «Внешнего ключа (FOREIGN KEY)» отображается в левой колонке таблицы (Рисунок 53). Выполнить редактирование данного значения можно в «Блоке свойств выбранной таблицы или параметра»[2].

Рисунок 53 Отображение Родительского и Внешнего ключа

----[1] ''Примечание: Одинаковые таблицы из разных схем добавить нельзя''

[2] ''Примечание: Основная таблица не может иметь внешнего ключа''

[3] ''Примечание: Поиск параметров осуществляется в зависимости от выбранной модели таблиц (физическая/логическая)''

Файл:Структура 16.png

2022-07-29T07:23:48Z

Wiki:

Структура 16

Файл:Структура 15.png

2022-07-29T07:23:19Z

Wiki:

Структура 15

Файл:Структура 14.png

2022-07-29T07:21:21Z

Wiki:

Структура 14

Файл:Структура 13.png

2022-07-29T07:20:55Z

Wiki:

Структура 13

Закладка Структура Дизайнера документов

2022-07-29T07:19:56Z

Wiki:

== Описание ==
Закладка Структура в Дизайнере документов предназначена для создания физической и логической модели электронного документа имеющая полное соответствие с хранением в базе данных:
[[Файл:Структура 1.png|без|мини]]

== Панель инструментов закладки «Структура» ==
Закладка "структура содержит:

'''1. Панель инструментов с командами:'''
{|
|-
|Открытие/закрытие панели поиска параметров по таблицам структуры
|[[Файл:Структура 2.png|без|мини]]
|-
|Переключение отображения параметров таблиц на логическую/физическую модель
|[[Файл:Структура 3.png|без|мини]]
|-
|Добавление таблицы
|[[Файл:Структура 4.png|без|мини]]
|-
|Добавление параметра
|[[Файл:Структура 5.png|без|мини]]
|-
|Удаление выделенного объекта
|[[Файл:Структура 6.png|без|мини]]
|-
|Добавление таблицы из БД
|[[Файл:Структура 7.png|без|мини]]
|-
|Добавление таблицы и связанной таблицы по FK из БД
|[[Файл:Структура 8.png|без|мини]]
|-
|Добавление представления из БД
|[[Файл:Структура 9.png|без|мини]]
|-
|Добавление новых полей из БД для выбранных таблиц
|[[Файл:Структура 10.png|без|мини]]
|-
|Открытие диалога «Скрипты БД»
|[[Файл:Структура 11.png|без|мини]]
|-
|Экземпляр документа
|[[Файл:Структура 12.png|без|мини]]
|-
|Спецификация документа
|
|-
|Просмотр/ копирование спецификации документа
|
|-
|Поднятие наверх (глубина) выбранной таблицы или представления
|
|-
|Опустить вниз (глубина) выбранную таблицу или представление
|
|-
|Экспортировать картинку
|
|}

Таблица 10 Панель инструментов блока навигации «Параметры»
{| class="wikitable"
|Иконка
|'''Описание'''
|-
|
|Увеличить размер отображения рабочей области
|-
|
|Уменьшить размер отображения рабочей области
|-
|
|Установить исходный размер рабочей области
|-
|
|Подогнать под размер схемы
|-
|
|Развернуть все таблицы
|-
|
|Свернуть все таблицы
|}

== 1.1 Создание структуры документа ==
Для создания структуры документа необходимо нажать в группе кнопок «Инструменты создания и редактирования таблиц» (Таблица 9) на панели инструментов «Добавить таблицу» или перетащить иконку в рабочую область (Рисунок 47). Первая таблица добавляется основная (родительская). Чтобы добавить последующие, необходимо еще раз нажать на «Добавить таблицу». Добавить последующие таблицы также можно наведя курсор мыши на выбранную таблицу, пока не появятся стрелки (слева, справа и снизу) (Рисунок 48). При нажатии на стрелку левой кнопкой мыши, будет добавлена новая таблица в выбранном направлении.

Добавить параметр для выбранной таблицы можно нажав на иконку «Добавить параметр» или перетащив ее в необходимую таблицу.

Рисунок 48 Добавление таблицы

== 1.2 Создание структуры документа из БД ==
Чтобы создать структуру из БД необходимо нажать на иконку на панели инструментов (Таблица 9) или перетащив её в рабочую область. Откроется диалоговое окно с формой поиска. После ввода названия в поле поиска необходимо нажать на . Далее автоматически отображается список с названиями таблиц. Чтобы выбрать необходимую нужно ее выделить левой кнопкой мыши и нажать на кнопку «Да»[1] (Рисунок 49).

Рисунок 49 Создание структуры из БД

== 1.3 Свойства таблиц\представлений и параметров ==
Свойства таблицы\представления и параметров заполняются в правой части экрана в «Блоке свойств выбранной таблицы и параметра».

Таблица 11 Описание свойств основной таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Дата справочника
|refBookDate
|Дата, на которую нужно искать

данные в справочниках
|Передается в поле API_DATE в listChoice, если у listChoice не задана своя дата

справочника
|Используется для генерации sql-запросов, а также для получения даты документа чтобы получать xslt схему, а также подтягивать данные из апи
|-
|Номер документа
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|}

Таблица 12 Описание свойств таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип в БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Номер саба
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Поле сортировки
|orderField
|Поле, по которому сортируется

таблица
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by
|-
|Порядок сортировки
|orderMode
|Тип сортировки по возрастанию

или убыванию
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by для указания порядка сортировки
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Вроде используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Не копировать
|nocopy
|Не копировать
|<nowiki>---</nowiki>
|Если установлено true, то при копировании данного документа значения этого саба не копируются в новый документ
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|
|}
Таблица 13 Описание свойств параметров
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое имя параметра
|
|Добавляется в сообщение об ошибке при обработке конкретного поля.

Пишется в логи при изменении записей справочника.

Выводится в описании полей АПИ

В фильтр плагине используется для наименования колонок результирующего датасета
|-
|Название в БД
|dbname
|Идентификатор параметра
|Используется для идентификации параметра
|Используется при формировании SQL-запросов, а также тэгов xml или параметров json
|-
|Тип
|metatype
|Тип параметра: Число

Целое число

Дата

Дата и время

Время

Строка

Логический

Ссылка
|
|Используется при получении значения из базы, а также при сохранении в базу
|-
|Первичный ключ
|primaryKey
|Параметр является первичным ключом
|Устанавливается при первом сохранении строки

саба. Получается в GET_AUTONUMERATOR_NEXTVAL
|Используется для задания первичного ключа для таблицы. Используется при генерации SQL-запросов
|-
|Внешний ключ
|foreignKey
|Параметр является внешним ключом
|Если при 1 сохранении документа тип перехагрузки - без

перезагрузки, то сабам 1 уровня проставляется foreignKey

как docId документа
|Используется для задания внешнего ключа для таблицы. Используется при генерации SQL-запросов
|-
|Сохранять в БД
|dbsaved
|Параметр сохраняется в БД
|Используется при формировании и парсинге xml
|Если true, то при формировании sql-запроса поле берется из таблицы иначе из таблицы референса с формированием join-ов.
|-
|Не копировать
|nocopy
|Параметр не переносится в копию при

копировании
|<nowiki>---</nowiki>
|Если true, то при копировании документа значение данного поля не переносится
|-
|Не пересчитывать
|norecalc
|
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Обязательный
|required
|Параметр обязательный к заполнению
|При создании xml правил такому параметру добавится

проверка на то, что он не пустой
|<nowiki>---</nowiki>
|-
|Номер документа
|пишется в docNumber у таблицы
|см. таблицу
|см. таблицу
|<nowiki>---</nowiki>
|-
|Ключ сортировки
|пишется в orderField у таблицы
|см. таблицу
|см. таблицу
|Используется в sql-запросе в секции order by
|-
|Тип сортировки
|пишется в orderMode у таблицы
|см. таблицу
|см. таблицу
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Автонумератор
|пишется в autoNumerate у таблицы
|Автоматическая нумерация
|Пересчитывается после externalCall или смены строк в сабе
|<nowiki>---</nowiki>
|-
|Включать в XML для АСУ
|fieldforasu
|Включать ли параметр в xml формируемую

для АСУ
|<nowiki>---</nowiki>
|Если true, то данное поле включается в xml возвращаемый по АСУ-АСУ
|-
|Название тега в XML
|nameforasu
|Имя тега в xml для АСУ
|<nowiki>---</nowiki>
|Если задано, то при формировании xml для АСУ-АСУ используется вместо dbname в качестве названия тэга
|-
|Описание
|description
|Описание параметра
|<nowiki>---</nowiki>
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Макс знаков
|totalDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает максимальную возможную длину числа (включая дробную часть)
|<nowiki>---</nowiki>
|-
|Дробных знаков
|fractionDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает длину дробной части
|<nowiki>---</nowiki>
|-
|Формат ввода и отображения
|format
|Выбор значения:

день.месяц.год

месяц.год

Свойство применяется для параметра с типом «Дата», «Дата и время», «Время»,
|В зависимости от этого формата, обнуляется часть даты.

Например если выбран формат день.месяц.год, обнуляется время
|<nowiki>---</nowiki>
|-
|Макс длина
|maxLength
|Свойство применяется для параметра с типом «Строка»
|Максимальная длина строки
|<nowiki>---</nowiki>
|-
|Тип выбора
|kind
|Свойство применяется для параметра с типом «Ссылка»

1. Из других документов\справочников

2. Из грида

3. Из апп-функции
|Тип ссылочного параметра, в зависимости от того что

выбрано
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Сущность
|cubeId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id куба
|<nowiki>---</nowiki>
|-
|АПИ чтения
|apiId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id апи
|Используется при генерации sql-запроса для получения данных из апи для разименования полей
|-
|Имя грида
|subName
|Свойство применяется для параметра с типом «Ссылка» Тип - из грида
|Имя грида из которого будут браться данные
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Апп-функция
|appFunc
|Свойство применяется для параметра с типом «Ссылка» Тип - из апп-функции
|Имя функции, которая будет использоваться вместо XM_QS
|<nowiki>---</nowiki>
|-
|XSLT преобразование
|transformId
|Свойство применяется для параметра с типом «XML»
|<nowiki>---</nowiki>
|Используется для преобразования xml при получении xml документа
|}

Для отображения или скрытия параметров таблицы необходимо нажать на -/+ в левом верхнем углу таблицы (Рисунок 50)

Рисунок 50 Открыть/скрыть параметры в таблице

== 1.4 Добавление ссылочной связи таблиц ==
Для создания ссылочной связи между таблицами, которые были добавлены с помощью панели инструментов необходимо навести курсор мыши на таблицу до появления стрелки (Рисунок 51) и далее протянуть до нужной таблицы (Рисунок 52). При нарушении условий ссылочной связи между таблицами установить такую связь будет невозможно.

Рисунок 51 Добавление ссылочной связи (1 способ)

Рисунок 52 Добавление ссылочной связи (2 способ)

Значение «Родительского ключа (PRIMARY KEY)» и «Внешнего ключа (FOREIGN KEY)» отображается в левой колонке таблицы (Рисунок 53). Выполнить редактирование данного значения можно в «Блоке свойств выбранной таблицы или параметра»[2].

Рисунок 53 Отображение Родительского и Внешнего ключа

== 1.5 Поиск параметров в таблицах ==

=== 1.5.1 Поиск параметров по всем таблицам ===
Поиск параметров может осуществляться во всех таблицах или в выбранной.

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

После ввода названия параметра отобразятся все найденные значения с отображением наименования таблицы, в которой он находится. Таблица с выбранным параметром будет отображена в центре рабочей области, параметр выделен. Для редактирования найденного параметра необходимо нажать на панели навигации «Параметры» (Рисунок 54).

Рисунок 54 Поиск параметра в таблицах и просмотр его свойств

=== 1.5.2 Поиск параметров по выбранной таблице ===
Для поиска параметра в выбранной таблице необходимо её выделить и нажать «Параметры». Откроется панель с настройками видимости таблиц и параметров. Далее необходимо ввести название искомого параметра (Рисунок 55).

Рисунок 55 Поиск параметров в выбранной таблице
----[1] ''Примечание: Одинаковые таблицы из разных схем добавить нельзя''

[2] ''Примечание: Основная таблица не может иметь внешнего ключа''

[3] ''Примечание: Поиск параметров осуществляется в зависимости от выбранной модели таблиц (физическая/логическая)''

Файл:Структура 12.png

2022-07-29T07:18:23Z

Wiki:

Структура 12

Файл:Структура 11.png

2022-07-29T07:17:50Z

Wiki:

Структура 11

Файл:Структура 10.png

2022-07-29T07:17:23Z

Wiki:

Структура 10

Файл:Структура 9.png

2022-07-29T07:17:00Z

Wiki:

Структура 9

Файл:Структура 8.png

2022-07-29T07:16:36Z

Wiki:

Структура 8

Файл:Структура 7.png

2022-07-29T07:16:12Z

Wiki:

Структура 7

Файл:Структура 6.png

2022-07-29T07:15:39Z

Wiki:

Структура 6

Файл:Структура 5.png

2022-07-29T07:15:00Z

Wiki:

Структура 5

Файл:Структура 4.png

2022-07-29T07:14:37Z

Wiki:

Структура 4

Закладка Документооборот Дизайнера документов

2022-07-29T07:14:08Z

Wiki:

== Описание ==

Документооборот - это схема, которая определяет состояния документа и переходы между ними для управления бизнес-процессами компании.[[Файл:ДО 1.1.1.png|без|мини]]

== Панель инструментов закладки «Документооборот». ==
Закладка Документооборот содержит:

'''1. Панель инструментов с командами:'''
{| class="wikitable"
|Скрыть/

показать название переходов
|Отображение и скрытие наименований переходов
|[[Файл:ДО 1.1.png|без|мини]]
|-
|Экспорт картинки
|Сохранение картинки документооборота в формате "png"
|[[Файл:ДО 2.png|без|мини]]
|}
'''2. Вкладки:'''
{| class="wikitable"
|Состояния
|Состояние документа предназначен для отслеживания статуса документа на его жизненном цикле.
Состояния находятся в таблице DOC_STATE.
| rowspan="6" |[[Файл:ДО 3.png|без|мини]]
|-
|Роли
|Роли предназначены для дополнительного способа ограничений на определенный набор действий в системе.
Роли находятся в таблице DOC_ROLE.

Все роли привязаны к Типу документа (DOC_TYPE_ID ) и доступны для просмотра и редактирования.

Роли применяются:

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

- к работе со сканированными документами (не обязательна);

- при настройке параметров сохранения в выбранном состоянии;

- при произвольном действие в коде, с помощью вызова функции CHECK_ROLE
|-
|Права
|Права определяют действия пользователя на переходах по документообороту, а так же права на сохранение документа.
У каждого права есть идентификатор (уникальный номер) и наименование, которое присваивается автоматически при добавлении.

Справочник прав документооборота находится в таблице SYS_BUS_FUNC.

Право относится к определенному типу TYPE_FUNC_ID и атрибуту DOC_TYPE_ID.

В дополнение у этих прав TYPE_FUNC_ID проставляется в 1.
|-
|Результаты
|Результат выполнения функции технологической операции.
Таблица SYS_FUNC_RESULT.
|-
|ЭЦП
|Электронная цифровая подпись позволяет идентифицировать владельца подписи.
При нажатии на кнопку подписания ЭЦП вызывается апп-функция DOC_S_GETTEXTSIGN и

после подписания на клиенте - апп-функция DOC_S_INSERTSIGN_NEW.

Параметр ORG_ECP_SIGN может принимать следующие значения:

0 - ЭЦП не ожидается,

1 - ЭЦП нужна, но не от организации пользователя,

2 - ЭЦП от организации пользователя,

3 - ЭЦП от организации пользователя (но таймаут просрочен),

4 - ЭЦП от организации пользователя и откатывать нельзя
|-
|Поиск
|Предназначена для поиска апп-функций и переходов
|}'''3. Панель навигации'''

Предназначена для перемещения схемы документооборота и ее масштабирования.
[[Файл:ДО 4.png|без|мини]]
'''4. Масштабирование блоков'''

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

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

Горизонтальная прокрутка строк осуществляется при помощи полосы прокрутки (скролла).

Вертикальная прокрутка строк осуществляется при помощи колесика мыши или полосы прокрутки (скролла)
[[Файл:ДО 5.png|без|мини]]

== Создание документооборота ==
Построение схемы документооборота заключается в добавлении состояний и переходов в порядке установленным бизнес-процессом документа.
При создании документа, в рабочей области документооборота проставляется начальное событие и состояние.
[[Файл:ДО 6.png|без|мини]]
Документооборот может быть создан с несколькими начальными состояниями, которые разделяются ролями (Вкладка «Роли») и должны быть взаимоисключающие.

Для добавления множественных начальных переходов в одно состояние, с разными результатами необходимо выделить нужное состояние и в свойства нажать на кнопку «Добавить начальный переход».
[[Файл:ДО 7.png|без|мини]]

=== Добавление состояния ===
Чтобы добавить новое состояние, необходимо навести указатель мыши на рабочую область и нажать кнопку «Insert» на клавиатуре.

После чего будет добавлено новое состояние, которое можно переместить в пределах рабочей области.
Для этого его необходимо выделить и удерживая левую кнопку мыши переместить.
[[Файл:ДО 8.png|без|мини]]
Также добавить новое состояние можно, наведя курсор мыши на начальное состояние, пока не появятся стрелки (слева, справа и снизу)

При нажатии на стрелку левой кнопкой мыши, будет добавлено новое состояние в выбранном направлении.
[[Файл:ДО 9.png|без|обрамить]]
Состояния добавляются кратно нажатию на кнопку «Insert» или при нажатии на стрелки (Рисунок 28).
[[Файл:ДО 10.png|без|мини|365x365пкс]]
Для удаления состояния его необходимо выделить, нажав левой кнопкой мыши и нажать кнопку «Delete».

Чтобы просмотреть список созданных состояний и основные параметры необходимо открыть вкладку «Состояния».
[[Файл:ДО 11.png|без|мини|506x506пкс]]

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

Чтобы создать переход между состояниями, добавленными с помощью кнопки «Insert», необходимо навести курсор мыши на состояние до появления точек подключений.
[[Файл:ДО 12.png|без|мини|350x350пкс]]
Далее наведя курсор мыши на точку подключения «Нового состояния 1» и зажав левую кнопку мыши необходимо протянуть переход до точки подключения «Нового состояния 2».
[[Файл:ДО 13.png|без|мини|345x345пкс]]
Для удаления перехода его необходимо выделить, нажав левой кнопкой мыши и нажать кнопку «Delete».
== Параметры состояния и перехода ==
Для добавления или редактирования параметров необходимо выделить нужное состояние или переход. Откроется блок со свойствами.

Параметры состояния содержат следующие поля:
[[Файл:ДО 14.png|без|мини]]
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Название
|Наименование состояния
|-
|Начальное состояние
|Установка значения начального состояния.
|-
|Сохранение
|Выбор параметров сохранения документа на переходе. Описание в 6.4 Параметры сохранения документа
|-
|Некомплитность
|Незаверешнное состояние документа.

Ограничения:

1 Состояния не могут быть начальными, терминальными или участвовать в корректировках.

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

3 Право в переходе, входящем в некомплитное состояние, должно быть такое же как право на выходящем переходе
|-
|Количество точек подключений
|16 точек

28 точек

36точек
|}
Параметры перехода содержат следующие поля:
[[Файл:ДО 15.png|без|мини]]
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Название
|Наименование перехода
|-
|Тип перехода
|Выбор типа перехода:

- обычный переход

- корректировка
|-
|Право
|Выбор права из выпадающего списка
|-
|Результат
|Выбор результата из выпадающего списка.
|-
|Роль
|Выбор роли из выпадающего списка
|-
|Отмена
|Установка признака отмены операции.
При установке возможности отмены операции необходимо задать «Право отмены» и «Роль отмены» для которых данное свойство будет доступно.
|-
|'''Не сохранять перед переходом'''
|
|-
|Без проверки контролей
|Установка признака без проверки контролей, который позволяет совершить переход, даже если в документе есть ошибки
|-
|Доступна как групповая операция
|Установка признака применения группового перехода, который позволяет совершать переход как групповой. Пример: в фильтре документов для выбранных строк в гриде.
|-
|Метод переоткрытия
|Задается в сохраняемых состояниях и переходах.
· По настройке документа – задается на закладке «Свойства».

· Без переоткрытия – обновление только состояний и кнопок при переходе по документообороту

· Мягкое – WebShell получает новые данные документа из БД и, не закрывая старый документ, накладывает полученные данные в открытый документ, аналогично как при выполнении внешнего действия. Если XML при сохранении будет аналогичен полученному XML, то действия выполнены не будут, так как нет изменившихся параметров

· Полное - WebShell закрывает документ и полностью выполняет процедуру открытия документа, при этом выполняются все действия описанные в правилах также как при обычном открытии документа.
|-
| rowspan="4" |Диалог на переходе
|Выбор из выпадающего списка:

· Без диалога
|-
|· Диалог подтверждения
|-
|· Диалог с правилами и GUI

Предназначен для дополнения пользователем реквизитов документа при выполнении операции.
|-
|· Встроенная аналитика

В свойствах перехода указывается “Встроенная аналитика” и выбирается одна из созданных аналитик. При нажатии пользователем на кнопку перехода по документообороту, открывается окно встроенной аналитики.
|-
|Мин. длина примечания
|Минимальное значение ограничения длины примечания при переходе по документообороту
|-
|Макс. длина примечания
|Максимальное значение ограничения длины примечания при переходе по документообороту
|-
|Цвет перехода
|Выбор цвета перехода при работе на закладке «Документооборот»
|-
|Показывать кнопку перехода
|Установка признака отображения кнопки на переходе.
|-
|Настройка email-рассылки
|Отправка email-оповещения при переходе по документообороту
|}
При добавлении параметров на переходе они отображаются на документообороте следующими графическими элементами:
{| class="wikitable"
|Графическое отображение
|Наименование
|Описание
|-
|[[Файл:ДО 16.png|без|мини]]
|ЭЦП
|Отображается, если у результата перехода настроена электронная подпись или задано текстовое представление ЭЦП
|-
|[[Файл:ДО 17.png|без|мини]]
|Правила
|Отображается, если на переходе выбран диалог с правилами и GUI
|-
|[[Файл:ДО 18.png|без|мини]]
|Отмена
|Отмена последней операции, приводящее документ к состоянию, предшествующему текущему состоянию.
|-
|[[Файл:ДО 19.png|без|мини]]
|Некомплитное состояние
|Свойство перехода, которое позволяет вернуться к предыдущему состоянию (cancel === true).
|}
== Параметры сохранения документа в выбранном состоянии ==
Для отображения и редактирования параметров сохранения документа в выбранном состоянии необходимо выделить состояние и проставить галочку напротив параметра «Сохранение» .

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

[[Файл:ДО 20.1.png|без|мини]]

Описание параметров сохранения:
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Результат сохранения
|Выбор результата из выпадающего списка.

Описание в п. 6.7 Вкладка «Результаты»
|-
|Право на сохранение
|Выбор права из выпадающего списка

Описание в п. 6.6 Вкладка «Права»
|-
|Роль
|Выбор роли из выпадающего списка

Описание в п 6.4 Вкладка «Роли»
|-
|Метод переоткрытия
|Задается в сохраняемых состояниях и переходах.

· По настройке документа – задается на закладке «Свойства».

· Без переоткрытия – обновление только состояний и кнопок при переходе по документообороту

· Мягкое – WebShell получает новые данные документа из БД и, не закрывая старый документ, накладывает полученные данные в открытый документ, аналогично как при выполнении внешнего действия. Если XML при сохранении будет аналогичен полученному XML, то действия выполнены не будут, так как нет изменившихся параметров

· Полное - WebShell закрывает документ и полностью выполняет процедуру открытия документа, при этом выполняются все действия описанные в правилах также как при обычном открытии документа.
|}
== Вкладка «Роли» ==
'''<big>Свойства роли</big>'''

Роли находятся в таблице DOC_ROLE и имеют следующие атрибуты:

Таблица 8 Таблица ролей в БД
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|NAME
|Наименование роли
|-
|DOC_TYPE_ID
|ИД типа документа
|-
|ROLE_SQL
|SQL запрос роли
|}

Все роли привязаны к Типу документа (DOC_TYPE_ID ) и доступны для просмотра и редактирования.

Атрибут ROLE_SQL позволяет осуществлять проверку наличия роли у пользователя. В этом атрибуте лежит SQL запрос следующего формата:

SELECT ORG_TYPE_ID, ORG_ID, POST, USER_ID FROM ...

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

ИД текущего пользователя равен USER_ID

ИД должности текущего пользователя равен POST

ИД организации, в которой состоит текущий пользователь равен ORG_ID

ИД типа организации, в которой состоит текущий пользователь равен ORG_TYPE_ID

Вместо реальных ИД в любом поле может стоять 0, подходящее любому пользователю по аналогии с правом.

Пример для роли «Все» (создается для каждого нового документооборота и подходит для любого пользователя):

SELECT 0 ORG_TYPE_ID, 0 ORG_ID, 0 POST, 0 USER_ID FROM DUAL

С помощью оператора «Select» можно использовать внешний параметр DOC_ID

Пример применения внешних параметров:

SELECT 0 ORG_TYPE_ID, 0 ORG_ID, 0 POST, 0 USER_ID FROM DUAL WHERE :DOC_ID = 666

UNION ALL

SELECT 0 ORG_TYPE_ID, 10 ORG_ID, 0 POST, 0 USER_ID FROM DUAL

Дать доступ для любых операций с документом 666 или любому пользователю из организации с ИД = 10

Роли применяются:

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

- к работе со сканированными документами (не обязательна);

- при настройке параметров сохранения в выбранном состоянии;

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

'''<big>Добавление роли</big>'''

Роли предназначены для дополнительного способа ограничений на определенный набор действий в системе.

Для добавления роли необходимо перейти на закладку «Роли» и нажать на кнопку «Добавить» . Выделив созданную роль, откроется блок с настройками.
[[Файл:ДО 22.png|без|мини]]
'''<big>Удаление роли</big>'''

Для удаления роли необходимо нажать на напротив нее на вкладке «Роли».
[[Файл:ДО 23.png|без|мини]]

== Вкладка «Права» ==
Права определяют действия пользователя на переходах по документообороту, а так же права на сохранение документа. У каждого права есть идентификатор (уникальный номер) и наименование, которое присваивается автоматически при добавлении. Справочник прав документооборота находится в таблице SYS_BUS_FUNC.

Право относится к определенному типу TYPE_FUNC_ID и атрибуту DOC_TYPE_ID. В дополнение у этих прав TYPE_FUNC_ID проставляется в 1.

'''<big>Добавление права</big>'''

Для добавления права необходимо перейти на закладку «Права» и нажать на кнопку «Добавить». Выделив созданную роль, откроется блок с настройками.
[[Файл:ДО 24.png|без|мини]]
<big>'''Удаление права'''</big>

Для удаления права необходимо нажать на напротив него на вкладке «Права».
[[Файл:ДО 25.png|без|мини]]

== Вкладка «Результаты» ==
'''<big>Добавление результата</big>'''

Для добавления результата необходимо перейти на закладку «Результаты» и нажать на кнопку «Добавить».

Чтобы открыть настройки созданного результата, необходимо его выделить левой кнопкой мыши. Блок с настройками отобразится под таблицей.
[[Файл:ДО 26.png|без|мини]]
'''<big>Удаление результата</big>'''

Для удаления результата необходимо нажать на напротив него на вкладке «Результаты».
[[Файл:ДО 27.png|без|мини]]
'''<big>Свойства результата</big>'''

В настройках выбранного результата необходимо задать название результата и в выпадающем списке выбрать право ([https://xmdocs.intellex.ru/index.php/%D0%97%D0%B0%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D0%B0_%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%BE%D0%B1%D0%BE%D1%80%D0%BE%D1%82_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80%D0%B0_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%B2#%D0%92%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D0%B0_%C2%AB%D0%9F%D1%80%D0%B0%D0%B2%D0%B0%C2%BB Вкладка Права]) для результата. Далее добавить апп-функции для события до и после перехода

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

При выполнении апп-функции переданные параметры встраиваются в SQL-конструкцию с помощью механизма JDBC PreparedStatement, что исключает возможность SQL-injection. Для выполнения запроса используется метод передачи имени функции и параметров её выполнения. Имена всех допустимых апп-функций хранятся в таблице «SYS_APP_FUNC».

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

== Вкладка «ЭЦП» ==
'''<big>Добавление ЭЦП</big>'''

Для добавления электронной цифровой подписи (далее – ЭЦП) необходимо перейти на закладку «ЭЦП» и нажать на кнопку «Добавить». Выделив созданную ЭЦП, откроется блок с настройками.
[[Файл:ДО 28.png|без|мини]]
'''<big>Удаление ЭЦП</big>'''
Для удаления ЭЦП необходимо нажать на напротив него на вкладке «ЭЦП».
[[Файл:ДО 29.png|без|мини]]
'''<big>Свойства ЭЦП</big>'''

После добавления необходимо добавить скрипты для формирования текстового представления ЭЦП, в котором должно быть указаны возможные входные параметры:
ИД документа (:DOC_ID),

ИД результата (RESULT_ID),

ИД записи в SYS_ECP_PATH (:ECP_PATH_ID),

дата, на которую получаем ТП (:DOC_DATE),

ИД операции (:OPER_ID),

ИД пользователя (:USER_ID),
обязательный выходной параметр :TEXT. Также необходимо указать период действия скрипта.
[[Файл:ДО 30.png|без|мини]]
Апп-функцию XM_DOC_S_GetDocECPProps нужно вызвать при (пере)открытии документа. Если параметр DOC_ECP_SIGN <> 0 и не пуст, то документ уже ЭЦП можно отразить на клиенте.

Параметр ORG_ECP_SIGN может принимать следующие значения:

0 - ЭЦП не ожидается,

1 - ЭЦП нужна, но не от организации пользователя,

2 - ЭЦП от организации пользователя,

3 - ЭЦП от организации пользователя (но таймаут просрочен),

4 - ЭЦП от организации пользователя и откатывать нельзя

Для значений 2 и 4 нужно показать на клиенте кнопку подписания ЭЦП.

Для значений 2 и 3 нужно показать кнопку отказа от подписания.

Для значения 0, если DOC_ECP_SIGN = 1 и ExistsRightToPaper=1, нужно показать кнопку перехода на бумажный документооборот

При нажатии на кнопку подписания ЭЦП надо вызвать апп-функцию DOC_S_GETTEXTSIGN и после подписания на клиенте - апп-функцию DOC_S_INSERTSIGN_NEW.

При нажатии на кнопку отказа от подписания надо вызвать апп-функцию DOC_S_UNDOLASTOPER.

При нажатии на кнопку перехода на бумажный документооборот надо вызвать апп-функцию Doc_S_SetZeroECPSIGN.

Для просмотра информации по ЭЦП вызываем DOC_S_GETALLSIGN для списка всех ЭЦП и DOC_S_CHECKSIGNOPER для просмотра более подробной информации по каждой ЭЦП.

В SYS_VAR_VALUE можно задать два параметры для работы с ЭЦП:

SYS_ECP2PAPER_RESULTID - Результат перехода на бумажный документооборот

SYS_ECP_TSPFUNCTION - Функция получения TSP. Пример FUNCTION FCCTEST.TEST_GET_TSP (p_sign IN BLOB) RETURN BLOB - при этом в sys_Var_value нужно прописать FCCTEST.TEST_GET_TSP

== Вкладка «Поиск» ==
Предназначена для поиска апп-функций и переходов.
[[Файл:ДО 31.png|без|мини]]

Файл:Структура 3.png

2022-07-29T07:13:29Z

Wiki:

Структура 3

Файл:Структура 2.png

2022-07-29T07:13:01Z

Wiki:

Структура 2

Файл:Структура 1.png

2022-07-29T07:06:16Z

Wiki:

Структура 1

Руководство пользователя "Дизайнер документов"

2022-07-29T07:00:40Z

Wiki:

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

'''<big>Включает в себя основные функциональные возможности:</big>'''

- Создание документооборота с учетом бизнес-процесса компании.

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

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

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

- Выбор и настройка полей для построения пользовательских фильтров (поля списков).

- Настройка представления для выбора данных с помощью SQL запроса к БД.

- Определение свойств режима и электронного документа.

- Загрузка перевода интерфейса (локализация) на языки, определенной системой.

- Подключение печатных форм.

'''<big>Содержит закладки:</big>'''
{|
|-
|[[Закладка Документооборот Дизайнера документов|'''<big>Документооборот▶</big>''']]
|Схема, которая определяет состояния документа и переходы между ними в соответствии с бизнес-процессами.
|-
|[https://xmdocs.intellex.ru/index.php/%D0%97%D0%B0%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D0%B0_%D0%A1%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80%D0%B0_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%B2 '''<big>Структура▶</big>''']
|Физическая и логическая модель документа имеющая полное соответствие с хранением в базе данных.
|-
|'''<big>Правила▶</big>'''
|Описание последовательности действий для изменения и проверки полей документа.
|-
|'''<big>Интерфейс▶</big>'''
|Экранные формы, при помощи которых осуществляется работа с документом.
|-
|'''<big>Поля списков▶</big>'''
|Настройка полей для пользовательских списков и выбора данных из справочников/кубов.
|-
|'''<big>Свойства▶</big>'''
|Обязательные/необязательные свойства документа и режима.
|-
|'''<big>История▶</big>'''
|Отображение внесенных изменений.
|-
|'''<big>Объекты▶</big>'''
|Отображение и редактирование списка объектов, входящих в куб.
|}

Руководство пользователя "Дизайнер документов"

2022-07-29T06:57:19Z

Wiki:

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

'''<big>Включает в себя основные функциональные возможности:</big>'''

- Создание документооборота с учетом бизнес-процесса компании.

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

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

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

- Выбор и настройка полей для построения пользовательских фильтров (поля списков).

- Настройка представления для выбора данных с помощью SQL запроса к БД.

- Определение свойств режима и электронного документа.

- Загрузка перевода интерфейса (локализация) на языки, определенной системой.

- Подключение печатных форм.

'''<big>Содержит закладки:</big>'''
{|
|-
|[[Закладка Документооборот Дизайнера документов|'''<big>Документооборот</big>''']]
|Схема, которая определяет состояния документа и переходы между ними в соответствии с бизнес-процессами.
|-
|[https://xmdocs.intellex.ru/index.php/%D0%97%D0%B0%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D0%B0_%D0%A1%D1%82%D1%80%D1%83%D0%BA%D1%82%D1%83%D1%80%D0%B0_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80%D0%B0_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%B2 '''<big>Структура</big>''']
|Физическая и логическая модель документа имеющая полное соответствие с хранением в базе данных.
|-
|'''<big>Правила</big>'''
|Описание последовательности действий для изменения и проверки полей документа
|-
|'''<big>Интерфейс</big>'''
|Экранные формы, при помощи которых осуществляется работа с документом
|-
|'''<big>Поля списков</big>'''
|Настройка свойств и видимости
|-
|'''<big>Свойства</big>'''
|Обязательные/необязательные свойства документа и режима
|-
|'''<big>История</big>'''
|Отображение внесенных изменений.
|-
|'''<big>Объекты</big>'''
|Отображение и редактирование списка объектов, входящих в куб
|}

Закладка Структура Дизайнера документов

2022-07-29T06:21:36Z

Wiki: Новая страница: «Структура таблиц в Дизайнере документов содержит основные свойства: - в закладке «Структура» проставляется признак PK у идентификатора сущности (например, st_id), однако при генерации скрипта PK создаётся по полю Trans_ID. - в скриптах происходит генерац...»

Структура таблиц в Дизайнере документов содержит основные свойства:

- в закладке «Структура» проставляется признак PK у идентификатора сущности (например, st_id), однако при генерации скрипта PK создаётся по полю Trans_ID.

- в скриптах происходит генерация индекса по ID сущности + Recdateend.

Панель инструментов закладки «Структура» содержит основные кнопки исполняемых команд (Таблица 9) и панель инструментов блока навигации (Таблица 10).

Таблица 9 Панель инструментов закладки «Структура»
{| class="wikitable"
|Иконка
|'''Описание'''
|-
|
|Открытие/закрытие панели поиска параметров по таблицам структуры
|-
|/
|Переключение отображения параметров таблиц на логическую/физическую модель
|-
|
|Добавление таблицы
|-
|
|Добавление параметра
|-
|
|Удаление выделенного объекта
|-
|
|Добавление таблицы из БД
|-
|
|Добавление таблицы и связанной таблицы по FK из БД
|-
|
|Добавление представления из БД
|-
|
|Открытие диалога «Скрипты БД»
|-
|
|Просмотр/копирование/скачивание экземпляра документа
|-
|
|Просмотр/ копирование спецификации документа
|-
|
|Поднятие наверх (глубина) выбранной таблицы или представления
|-
|
|Опустить вниз (глубина) выбранную таблицу или представление
|-
|
|Экспортировать картинку
|}

Таблица 10 Панель инструментов блока навигации «Параметры»
{| class="wikitable"
|Иконка
|'''Описание'''
|-
|
|Увеличить размер отображения рабочей области
|-
|
|Уменьшить размер отображения рабочей области
|-
|
|Установить исходный размер рабочей области
|-
|
|Подогнать под размер схемы
|-
|
|Развернуть все таблицы
|-
|
|Свернуть все таблицы
|}

== 1.1 Создание структуры документа ==
Для создания структуры документа необходимо нажать в группе кнопок «Инструменты создания и редактирования таблиц» (Таблица 9) на панели инструментов «Добавить таблицу» или перетащить иконку в рабочую область (Рисунок 47). Первая таблица добавляется основная (родительская). Чтобы добавить последующие, необходимо еще раз нажать на «Добавить таблицу». Добавить последующие таблицы также можно наведя курсор мыши на выбранную таблицу, пока не появятся стрелки (слева, справа и снизу) (Рисунок 48). При нажатии на стрелку левой кнопкой мыши, будет добавлена новая таблица в выбранном направлении.

Добавить параметр для выбранной таблицы можно нажав на иконку «Добавить параметр» или перетащив ее в необходимую таблицу.

Рисунок 48 Добавление таблицы

== 1.2 Создание структуры документа из БД ==
Чтобы создать структуру из БД необходимо нажать на иконку на панели инструментов (Таблица 9) или перетащив её в рабочую область. Откроется диалоговое окно с формой поиска. После ввода названия в поле поиска необходимо нажать на . Далее автоматически отображается список с названиями таблиц. Чтобы выбрать необходимую нужно ее выделить левой кнопкой мыши и нажать на кнопку «Да»[1] (Рисунок 49).

Рисунок 49 Создание структуры из БД

== 1.3 Свойства таблиц\представлений и параметров ==
Свойства таблицы\представления и параметров заполняются в правой части экрана в «Блоке свойств выбранной таблицы и параметра».

Таблица 11 Описание свойств основной таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Дата справочника
|refBookDate
|Дата, на которую нужно искать

данные в справочниках
|Передается в поле API_DATE в listChoice, если у listChoice не задана своя дата

справочника
|Используется для генерации sql-запросов, а также для получения даты документа чтобы получать xslt схему, а также подтягивать данные из апи
|-
|Номер документа
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|}

Таблица 12 Описание свойств таблицы
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое название таблицы
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Название в БД
|dbname
|Наименование объекта (таблицы

или представления) в БД
|Уникальное имя таблицы
|Используется для генерации sql-запросов, а также в качестве имени тэга в xml документа
|-
|Тип в БД
|dbtype
|Таблица или представление
|<nowiki>---</nowiki>
|При вставке данных для таблиц и представлений используются разные методы
|-
|Номер саба
|docNumber
|Номер добавляемый в заголовок

окна документа
|В документе называется codeParam

Добавляется к заголовку окна `№${ codeParam }`
|<nowiki>---</nowiki>
|-
|Поле сортировки
|orderField
|Поле, по которому сортируется

таблица
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by
|-
|Порядок сортировки
|orderMode
|Тип сортировки по возрастанию

или убыванию
|<nowiki>---</nowiki>
|Используется для генерации sql-запросов в секции order by для указания порядка сортировки
|-
|Использовать даты действия
|<nowiki>---</nowiki>
|Добавляет в таблицу 2 поля

RECDATEBEGIN и

RECDATEEND которые по факту

- составной первичный ключ
|Вроде используется так же как и даты справочников
|При наличии данных полей таблица отмечается как версионная и используется в sql-запросах
|-
|Не копировать
|nocopy
|Не копировать
|<nowiki>---</nowiki>
|Если установлено true, то при копировании данного документа значения этого саба не копируются в новый документ
|-
|Название тега в XML
|nameforasu
|Имя тега для передачи в АСУ
|<nowiki>---</nowiki>
|Если задано значение, то в xml для АСУ используется вместо dbname
|-
|Описание
|description
|Описание таблицы
|<nowiki>---</nowiki>
|
|}
Таблица 13 Описание свойств параметров
{| class="wikitable"
|'''Имя параметра'''
|'''Ключ'''
|'''Описание'''
|'''Использование на клиенте'''
|'''Использование на сервере'''
|-
|Название
|name
|Читаемое имя параметра
|
|Добавляется в сообщение об ошибке при обработке конкретного поля.

Пишется в логи при изменении записей справочника.

Выводится в описании полей АПИ

В фильтр плагине используется для наименования колонок результирующего датасета
|-
|Название в БД
|dbname
|Идентификатор параметра
|Используется для идентификации параметра
|Используется при формировании SQL-запросов, а также тэгов xml или параметров json
|-
|Тип
|metatype
|Тип параметра: Число

Целое число

Дата

Дата и время

Время

Строка

Логический

Ссылка
|
|Используется при получении значения из базы, а также при сохранении в базу
|-
|Первичный ключ
|primaryKey
|Параметр является первичным ключом
|Устанавливается при первом сохранении строки

саба. Получается в GET_AUTONUMERATOR_NEXTVAL
|Используется для задания первичного ключа для таблицы. Используется при генерации SQL-запросов
|-
|Внешний ключ
|foreignKey
|Параметр является внешним ключом
|Если при 1 сохранении документа тип перехагрузки - без

перезагрузки, то сабам 1 уровня проставляется foreignKey

как docId документа
|Используется для задания внешнего ключа для таблицы. Используется при генерации SQL-запросов
|-
|Сохранять в БД
|dbsaved
|Параметр сохраняется в БД
|Используется при формировании и парсинге xml
|Если true, то при формировании sql-запроса поле берется из таблицы иначе из таблицы референса с формированием join-ов.
|-
|Не копировать
|nocopy
|Параметр не переносится в копию при

копировании
|<nowiki>---</nowiki>
|Если true, то при копировании документа значение данного поля не переносится
|-
|Не пересчитывать
|norecalc
|
|<nowiki>---</nowiki>
|<nowiki>---</nowiki>
|-
|Обязательный
|required
|Параметр обязательный к заполнению
|При создании xml правил такому параметру добавится

проверка на то, что он не пустой
|<nowiki>---</nowiki>
|-
|Номер документа
|пишется в docNumber у таблицы
|см. таблицу
|см. таблицу
|<nowiki>---</nowiki>
|-
|Ключ сортировки
|пишется в orderField у таблицы
|см. таблицу
|см. таблицу
|Используется в sql-запросе в секции order by
|-
|Тип сортировки
|пишется в orderMode у таблицы
|см. таблицу
|см. таблицу
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Автонумератор
|пишется в autoNumerate у таблицы
|Автоматическая нумерация
|Пересчитывается после externalCall или смены строк в сабе
|<nowiki>---</nowiki>
|-
|Включать в XML для АСУ
|fieldforasu
|Включать ли параметр в xml формируемую

для АСУ
|<nowiki>---</nowiki>
|Если true, то данное поле включается в xml возвращаемый по АСУ-АСУ
|-
|Название тега в XML
|nameforasu
|Имя тега в xml для АСУ
|<nowiki>---</nowiki>
|Если задано, то при формировании xml для АСУ-АСУ используется вместо dbname в качестве названия тэга
|-
|Описание
|description
|Описание параметра
|<nowiki>---</nowiki>
|Использовалось в юниверсах 1 версии, в текущей версии не используется
|-
|Макс знаков
|totalDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает максимальную возможную длину числа (включая дробную часть)
|<nowiki>---</nowiki>
|-
|Дробных знаков
|fractionDigits
|Свойство применяется для параметра с типом «Число»
|Ограничивает длину дробной части
|<nowiki>---</nowiki>
|-
|Формат ввода и отображения
|format
|Выбор значения:

день.месяц.год

месяц.год

Свойство применяется для параметра с типом «Дата», «Дата и время», «Время»,
|В зависимости от этого формата, обнуляется часть даты.

Например если выбран формат день.месяц.год, обнуляется время
|<nowiki>---</nowiki>
|-
|Макс длина
|maxLength
|Свойство применяется для параметра с типом «Строка»
|Максимальная длина строки
|<nowiki>---</nowiki>
|-
|Тип выбора
|kind
|Свойство применяется для параметра с типом «Ссылка»

1. Из других документов\справочников

2. Из грида

3. Из апп-функции
|Тип ссылочного параметра, в зависимости от того что

выбрано
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Сущность
|cubeId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id куба
|<nowiki>---</nowiki>
|-
|АПИ чтения
|apiId
|Свойство применяется для параметра с типом «Ссылка» Тип - из других документов\справочников
|Id апи
|Используется при генерации sql-запроса для получения данных из апи для разименования полей
|-
|Имя грида
|subName
|Свойство применяется для параметра с типом «Ссылка» Тип - из грида
|Имя грида из которого будут браться данные
|Используется при генерации sql-запроса для получения данных из саблистчоиса для разименования полей
|-
|Апп-функция
|appFunc
|Свойство применяется для параметра с типом «Ссылка» Тип - из апп-функции
|Имя функции, которая будет использоваться вместо XM_QS
|<nowiki>---</nowiki>
|-
|XSLT преобразование
|transformId
|Свойство применяется для параметра с типом «XML»
|<nowiki>---</nowiki>
|Используется для преобразования xml при получении xml документа
|}

Для отображения или скрытия параметров таблицы необходимо нажать на -/+ в левом верхнем углу таблицы (Рисунок 50)

Рисунок 50 Открыть/скрыть параметры в таблице

== 1.4 Добавление ссылочной связи таблиц ==
Для создания ссылочной связи между таблицами, которые были добавлены с помощью панели инструментов необходимо навести курсор мыши на таблицу до появления стрелки (Рисунок 51) и далее протянуть до нужной таблицы (Рисунок 52). При нарушении условий ссылочной связи между таблицами установить такую связь будет невозможно.

Рисунок 51 Добавление ссылочной связи (1 способ)

Рисунок 52 Добавление ссылочной связи (2 способ)

Значение «Родительского ключа (PRIMARY KEY)» и «Внешнего ключа (FOREIGN KEY)» отображается в левой колонке таблицы (Рисунок 53). Выполнить редактирование данного значения можно в «Блоке свойств выбранной таблицы или параметра»[2].

Рисунок 53 Отображение Родительского и Внешнего ключа

== 1.5 Поиск параметров в таблицах ==

=== 1.5.1 Поиск параметров по всем таблицам ===
Поиск параметров может осуществляться во всех таблицах или в выбранной.

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

После ввода названия параметра отобразятся все найденные значения с отображением наименования таблицы, в которой он находится. Таблица с выбранным параметром будет отображена в центре рабочей области, параметр выделен. Для редактирования найденного параметра необходимо нажать на панели навигации «Параметры» (Рисунок 54).

Рисунок 54 Поиск параметра в таблицах и просмотр его свойств

=== 1.5.2 Поиск параметров по выбранной таблице ===
Для поиска параметра в выбранной таблице необходимо её выделить и нажать «Параметры». Откроется панель с настройками видимости таблиц и параметров. Далее необходимо ввести название искомого параметра (Рисунок 55).

Рисунок 55 Поиск параметров в выбранной таблице
----[1] ''Примечание: Одинаковые таблицы из разных схем добавить нельзя''

[2] ''Примечание: Основная таблица не может иметь внешнего ключа''

[3] ''Примечание: Поиск параметров осуществляется в зависимости от выбранной модели таблиц (физическая/логическая)''

Закладка Документооборот Дизайнера документов

2022-07-29T05:11:41Z

Wiki:

Документооборот - это схема, которая определяет состояния документа и переходы между ними для управления бизнес-процессами компании.[[Файл:ДО 1.1.1.png|без|мини]]

== Панель инструментов закладки «Документооборот». ==
Закладка Документооборот содержит:

'''1. Панель инструментов с командами:'''
{| class="wikitable"
|Скрыть/

показать название переходов
|Отображение и скрытие наименований переходов
|[[Файл:ДО 1.1.png|без|мини]]
|-
|Экспорт картинки
|Сохранение картинки документооборота в формате "png"
|[[Файл:ДО 2.png|без|мини]]
|}
'''2. Вкладки:'''
{| class="wikitable"
|Состояния
|Состояние документа предназначен для отслеживания статуса документа на его жизненном цикле.
Состояния находятся в таблице DOC_STATE.
| rowspan="6" |[[Файл:ДО 3.png|без|мини]]
|-
|Роли
|Роли предназначены для дополнительного способа ограничений на определенный набор действий в системе.
Роли находятся в таблице DOC_ROLE.

Все роли привязаны к Типу документа (DOC_TYPE_ID ) и доступны для просмотра и редактирования.

Роли применяются:

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

- к работе со сканированными документами (не обязательна);

- при настройке параметров сохранения в выбранном состоянии;

- при произвольном действие в коде, с помощью вызова функции CHECK_ROLE
|-
|Права
|Права определяют действия пользователя на переходах по документообороту, а так же права на сохранение документа.
У каждого права есть идентификатор (уникальный номер) и наименование, которое присваивается автоматически при добавлении.

Справочник прав документооборота находится в таблице SYS_BUS_FUNC.

Право относится к определенному типу TYPE_FUNC_ID и атрибуту DOC_TYPE_ID.

В дополнение у этих прав TYPE_FUNC_ID проставляется в 1.
|-
|Результаты
|Результат выполнения функции технологической операции.
Таблица SYS_FUNC_RESULT.
|-
|ЭЦП
|Электронная цифровая подпись позволяет идентифицировать владельца подписи.
При нажатии на кнопку подписания ЭЦП вызывается апп-функция DOC_S_GETTEXTSIGN и

после подписания на клиенте - апп-функция DOC_S_INSERTSIGN_NEW.

Параметр ORG_ECP_SIGN может принимать следующие значения:

0 - ЭЦП не ожидается,

1 - ЭЦП нужна, но не от организации пользователя,

2 - ЭЦП от организации пользователя,

3 - ЭЦП от организации пользователя (но таймаут просрочен),

4 - ЭЦП от организации пользователя и откатывать нельзя
|-
|Поиск
|Предназначена для поиска апп-функций и переходов
|}'''3. Панель навигации'''

Предназначена для перемещения схемы документооборота и ее масштабирования.
[[Файл:ДО 4.png|без|мини]]
'''4. Масштабирование блоков'''

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

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

Горизонтальная прокрутка строк осуществляется при помощи полосы прокрутки (скролла).

Вертикальная прокрутка строк осуществляется при помощи колесика мыши или полосы прокрутки (скролла)
[[Файл:ДО 5.png|без|мини]]

== Создание документооборота ==
Построение схемы документооборота заключается в добавлении состояний и переходов в порядке установленным бизнес-процессом документа.
При создании документа, в рабочей области документооборота проставляется начальное событие и состояние.
[[Файл:ДО 6.png|без|мини]]
Документооборот может быть создан с несколькими начальными состояниями, которые разделяются ролями (Вкладка «Роли») и должны быть взаимоисключающие.

Для добавления множественных начальных переходов в одно состояние, с разными результатами необходимо выделить нужное состояние и в свойства нажать на кнопку «Добавить начальный переход».
[[Файл:ДО 7.png|без|мини]]

=== Добавление состояния ===
Чтобы добавить новое состояние, необходимо навести указатель мыши на рабочую область и нажать кнопку «Insert» на клавиатуре.

После чего будет добавлено новое состояние, которое можно переместить в пределах рабочей области.
Для этого его необходимо выделить и удерживая левую кнопку мыши переместить.
[[Файл:ДО 8.png|без|мини]]
Также добавить новое состояние можно, наведя курсор мыши на начальное состояние, пока не появятся стрелки (слева, справа и снизу)

При нажатии на стрелку левой кнопкой мыши, будет добавлено новое состояние в выбранном направлении.
[[Файл:ДО 9.png|без|обрамить]]
Состояния добавляются кратно нажатию на кнопку «Insert» или при нажатии на стрелки (Рисунок 28).
[[Файл:ДО 10.png|без|мини|365x365пкс]]
Для удаления состояния его необходимо выделить, нажав левой кнопкой мыши и нажать кнопку «Delete».

Чтобы просмотреть список созданных состояний и основные параметры необходимо открыть вкладку «Состояния».
[[Файл:ДО 11.png|без|мини|506x506пкс]]

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

Чтобы создать переход между состояниями, добавленными с помощью кнопки «Insert», необходимо навести курсор мыши на состояние до появления точек подключений.
[[Файл:ДО 12.png|без|мини|350x350пкс]]
Далее наведя курсор мыши на точку подключения «Нового состояния 1» и зажав левую кнопку мыши необходимо протянуть переход до точки подключения «Нового состояния 2».
[[Файл:ДО 13.png|без|мини|345x345пкс]]
Для удаления перехода его необходимо выделить, нажав левой кнопкой мыши и нажать кнопку «Delete».
== Параметры состояния и перехода ==
Для добавления или редактирования параметров необходимо выделить нужное состояние или переход. Откроется блок со свойствами.

Параметры состояния содержат следующие поля:
[[Файл:ДО 14.png|без|мини]]
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Название
|Наименование состояния
|-
|Начальное состояние
|Установка значения начального состояния.
|-
|Сохранение
|Выбор параметров сохранения документа на переходе. Описание в 6.4 Параметры сохранения документа
|-
|Некомплитность
|Незаверешнное состояние документа.

Ограничения:

1 Состояния не могут быть начальными, терминальными или участвовать в корректировках.

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

3 Право в переходе, входящем в некомплитное состояние, должно быть такое же как право на выходящем переходе
|-
|Количество точек подключений
|16 точек

28 точек

36точек
|}
Параметры перехода содержат следующие поля:
[[Файл:ДО 15.png|без|мини]]
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Название
|Наименование перехода
|-
|Тип перехода
|Выбор типа перехода:

- обычный переход

- корректировка
|-
|Право
|Выбор права из выпадающего списка
|-
|Результат
|Выбор результата из выпадающего списка.
|-
|Роль
|Выбор роли из выпадающего списка
|-
|Отмена
|Установка признака отмены операции.
При установке возможности отмены операции необходимо задать «Право отмены» и «Роль отмены» для которых данное свойство будет доступно.
|-
|'''Не сохранять перед переходом'''
|
|-
|Без проверки контролей
|Установка признака без проверки контролей, который позволяет совершить переход, даже если в документе есть ошибки
|-
|Доступна как групповая операция
|Установка признака применения группового перехода, который позволяет совершать переход как групповой. Пример: в фильтре документов для выбранных строк в гриде.
|-
|Метод переоткрытия
|Задается в сохраняемых состояниях и переходах.
· По настройке документа – задается на закладке «Свойства».

· Без переоткрытия – обновление только состояний и кнопок при переходе по документообороту

· Мягкое – WebShell получает новые данные документа из БД и, не закрывая старый документ, накладывает полученные данные в открытый документ, аналогично как при выполнении внешнего действия. Если XML при сохранении будет аналогичен полученному XML, то действия выполнены не будут, так как нет изменившихся параметров

· Полное - WebShell закрывает документ и полностью выполняет процедуру открытия документа, при этом выполняются все действия описанные в правилах также как при обычном открытии документа.
|-
| rowspan="4" |Диалог на переходе
|Выбор из выпадающего списка:

· Без диалога
|-
|· Диалог подтверждения
|-
|· Диалог с правилами и GUI

Предназначен для дополнения пользователем реквизитов документа при выполнении операции.
|-
|· Встроенная аналитика

В свойствах перехода указывается “Встроенная аналитика” и выбирается одна из созданных аналитик. При нажатии пользователем на кнопку перехода по документообороту, открывается окно встроенной аналитики.
|-
|Мин. длина примечания
|Минимальное значение ограничения длины примечания при переходе по документообороту
|-
|Макс. длина примечания
|Максимальное значение ограничения длины примечания при переходе по документообороту
|-
|Цвет перехода
|Выбор цвета перехода при работе на закладке «Документооборот»
|-
|Показывать кнопку перехода
|Установка признака отображения кнопки на переходе.
|-
|Настройка email-рассылки
|Отправка email-оповещения при переходе по документообороту
|}
При добавлении параметров на переходе они отображаются на документообороте следующими графическими элементами:
{| class="wikitable"
|Графическое отображение
|Наименование
|Описание
|-
|[[Файл:ДО 16.png|без|мини]]
|ЭЦП
|Отображается, если у результата перехода настроена электронная подпись или задано текстовое представление ЭЦП
|-
|[[Файл:ДО 17.png|без|мини]]
|Правила
|Отображается, если на переходе выбран диалог с правилами и GUI
|-
|[[Файл:ДО 18.png|без|мини]]
|Отмена
|Отмена последней операции, приводящее документ к состоянию, предшествующему текущему состоянию.
|-
|[[Файл:ДО 19.png|без|мини]]
|Некомплитное состояние
|Свойство перехода, которое позволяет вернуться к предыдущему состоянию (cancel === true).
|}
== Параметры сохранения документа в выбранном состоянии ==
Для отображения и редактирования параметров сохранения документа в выбранном состоянии необходимо выделить состояние и проставить галочку напротив параметра «Сохранение» .

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

[[Файл:ДО 20.1.png|без|мини]]

Описание параметров сохранения:
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Результат сохранения
|Выбор результата из выпадающего списка.

Описание в п. 6.7 Вкладка «Результаты»
|-
|Право на сохранение
|Выбор права из выпадающего списка

Описание в п. 6.6 Вкладка «Права»
|-
|Роль
|Выбор роли из выпадающего списка

Описание в п 6.4 Вкладка «Роли»
|-
|Метод переоткрытия
|Задается в сохраняемых состояниях и переходах.

· По настройке документа – задается на закладке «Свойства».

· Без переоткрытия – обновление только состояний и кнопок при переходе по документообороту

· Мягкое – WebShell получает новые данные документа из БД и, не закрывая старый документ, накладывает полученные данные в открытый документ, аналогично как при выполнении внешнего действия. Если XML при сохранении будет аналогичен полученному XML, то действия выполнены не будут, так как нет изменившихся параметров

· Полное - WebShell закрывает документ и полностью выполняет процедуру открытия документа, при этом выполняются все действия описанные в правилах также как при обычном открытии документа.
|}
== Вкладка «Роли» ==
'''<big>Свойства роли</big>'''

Роли находятся в таблице DOC_ROLE и имеют следующие атрибуты:

Таблица 8 Таблица ролей в БД
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|NAME
|Наименование роли
|-
|DOC_TYPE_ID
|ИД типа документа
|-
|ROLE_SQL
|SQL запрос роли
|}

Все роли привязаны к Типу документа (DOC_TYPE_ID ) и доступны для просмотра и редактирования.

Атрибут ROLE_SQL позволяет осуществлять проверку наличия роли у пользователя. В этом атрибуте лежит SQL запрос следующего формата:

SELECT ORG_TYPE_ID, ORG_ID, POST, USER_ID FROM ...

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

ИД текущего пользователя равен USER_ID

ИД должности текущего пользователя равен POST

ИД организации, в которой состоит текущий пользователь равен ORG_ID

ИД типа организации, в которой состоит текущий пользователь равен ORG_TYPE_ID

Вместо реальных ИД в любом поле может стоять 0, подходящее любому пользователю по аналогии с правом.

Пример для роли «Все» (создается для каждого нового документооборота и подходит для любого пользователя):

SELECT 0 ORG_TYPE_ID, 0 ORG_ID, 0 POST, 0 USER_ID FROM DUAL

С помощью оператора «Select» можно использовать внешний параметр DOC_ID

Пример применения внешних параметров:

SELECT 0 ORG_TYPE_ID, 0 ORG_ID, 0 POST, 0 USER_ID FROM DUAL WHERE :DOC_ID = 666

UNION ALL

SELECT 0 ORG_TYPE_ID, 10 ORG_ID, 0 POST, 0 USER_ID FROM DUAL

Дать доступ для любых операций с документом 666 или любому пользователю из организации с ИД = 10

Роли применяются:

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

- к работе со сканированными документами (не обязательна);

- при настройке параметров сохранения в выбранном состоянии;

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

'''<big>Добавление роли</big>'''

Роли предназначены для дополнительного способа ограничений на определенный набор действий в системе.

Для добавления роли необходимо перейти на закладку «Роли» и нажать на кнопку «Добавить» . Выделив созданную роль, откроется блок с настройками.
[[Файл:ДО 22.png|без|мини]]
'''<big>Удаление роли</big>'''

Для удаления роли необходимо нажать на напротив нее на вкладке «Роли».
[[Файл:ДО 23.png|без|мини]]

== Вкладка «Права» ==
Права определяют действия пользователя на переходах по документообороту, а так же права на сохранение документа. У каждого права есть идентификатор (уникальный номер) и наименование, которое присваивается автоматически при добавлении. Справочник прав документооборота находится в таблице SYS_BUS_FUNC.

Право относится к определенному типу TYPE_FUNC_ID и атрибуту DOC_TYPE_ID. В дополнение у этих прав TYPE_FUNC_ID проставляется в 1.

'''<big>Добавление права</big>'''

Для добавления права необходимо перейти на закладку «Права» и нажать на кнопку «Добавить». Выделив созданную роль, откроется блок с настройками.
[[Файл:ДО 24.png|без|мини]]
<big>'''Удаление права'''</big>

Для удаления права необходимо нажать на напротив него на вкладке «Права».
[[Файл:ДО 25.png|без|мини]]

== Вкладка «Результаты» ==
'''<big>Добавление результата</big>'''

Для добавления результата необходимо перейти на закладку «Результаты» и нажать на кнопку «Добавить».

Чтобы открыть настройки созданного результата, необходимо его выделить левой кнопкой мыши. Блок с настройками отобразится под таблицей.
[[Файл:ДО 26.png|без|мини]]
'''<big>Удаление результата</big>'''

Для удаления результата необходимо нажать на напротив него на вкладке «Результаты».
[[Файл:ДО 27.png|без|мини]]
'''<big>Свойства результата</big>'''

В настройках выбранного результата необходимо задать название результата и в выпадающем списке выбрать право ([https://xmdocs.intellex.ru/index.php/%D0%97%D0%B0%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D0%B0_%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%BE%D0%B1%D0%BE%D1%80%D0%BE%D1%82_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80%D0%B0_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%B2#%D0%92%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D0%B0_%C2%AB%D0%9F%D1%80%D0%B0%D0%B2%D0%B0%C2%BB Вкладка Права]) для результата. Далее добавить апп-функции для события до и после перехода

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

При выполнении апп-функции переданные параметры встраиваются в SQL-конструкцию с помощью механизма JDBC PreparedStatement, что исключает возможность SQL-injection. Для выполнения запроса используется метод передачи имени функции и параметров её выполнения. Имена всех допустимых апп-функций хранятся в таблице «SYS_APP_FUNC».

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

== Вкладка «ЭЦП» ==
'''<big>Добавление ЭЦП</big>'''

Для добавления электронной цифровой подписи (далее – ЭЦП) необходимо перейти на закладку «ЭЦП» и нажать на кнопку «Добавить». Выделив созданную ЭЦП, откроется блок с настройками.
[[Файл:ДО 28.png|без|мини]]
'''<big>Удаление ЭЦП</big>'''
Для удаления ЭЦП необходимо нажать на напротив него на вкладке «ЭЦП».
[[Файл:ДО 29.png|без|мини]]
'''<big>Свойства ЭЦП</big>'''

После добавления необходимо добавить скрипты для формирования текстового представления ЭЦП, в котором должно быть указаны возможные входные параметры:
ИД документа (:DOC_ID),

ИД результата (RESULT_ID),

ИД записи в SYS_ECP_PATH (:ECP_PATH_ID),

дата, на которую получаем ТП (:DOC_DATE),

ИД операции (:OPER_ID),

ИД пользователя (:USER_ID),
обязательный выходной параметр :TEXT. Также необходимо указать период действия скрипта.
[[Файл:ДО 30.png|без|мини]]
Апп-функцию XM_DOC_S_GetDocECPProps нужно вызвать при (пере)открытии документа. Если параметр DOC_ECP_SIGN <> 0 и не пуст, то документ уже ЭЦП можно отразить на клиенте.

Параметр ORG_ECP_SIGN может принимать следующие значения:

0 - ЭЦП не ожидается,

1 - ЭЦП нужна, но не от организации пользователя,

2 - ЭЦП от организации пользователя,

3 - ЭЦП от организации пользователя (но таймаут просрочен),

4 - ЭЦП от организации пользователя и откатывать нельзя

Для значений 2 и 4 нужно показать на клиенте кнопку подписания ЭЦП.

Для значений 2 и 3 нужно показать кнопку отказа от подписания.

Для значения 0, если DOC_ECP_SIGN = 1 и ExistsRightToPaper=1, нужно показать кнопку перехода на бумажный документооборот

При нажатии на кнопку подписания ЭЦП надо вызвать апп-функцию DOC_S_GETTEXTSIGN и после подписания на клиенте - апп-функцию DOC_S_INSERTSIGN_NEW.

При нажатии на кнопку отказа от подписания надо вызвать апп-функцию DOC_S_UNDOLASTOPER.

При нажатии на кнопку перехода на бумажный документооборот надо вызвать апп-функцию Doc_S_SetZeroECPSIGN.

Для просмотра информации по ЭЦП вызываем DOC_S_GETALLSIGN для списка всех ЭЦП и DOC_S_CHECKSIGNOPER для просмотра более подробной информации по каждой ЭЦП.

В SYS_VAR_VALUE можно задать два параметры для работы с ЭЦП:

SYS_ECP2PAPER_RESULTID - Результат перехода на бумажный документооборот

SYS_ECP_TSPFUNCTION - Функция получения TSP. Пример FUNCTION FCCTEST.TEST_GET_TSP (p_sign IN BLOB) RETURN BLOB - при этом в sys_Var_value нужно прописать FCCTEST.TEST_GET_TSP

== Вкладка «Поиск» ==
Предназначена для поиска апп-функций и переходов.
[[Файл:ДО 31.png|без|мини]]

Закладка Документооборот Дизайнера документов

2022-07-28T14:36:45Z

Wiki: /* Вкладка «Права» */

Документооборот - это схема, которая определяет состояния документа и переходы между ними для управления бизнес-процессами компании.
[[Файл:ДО 1.1.1.png|без|мини]]

== Панель инструментов закладки «Документооборот». ==
Закладка Документооборот содержит:

'''1. Панель инструментов с командами:'''
{| class="wikitable"
|Скрыть/

показать название переходов
|Отображение и скрытие наименований переходов
|[[Файл:ДО 1.1.png|без|мини]]
|-
|Экспорт картинки
|Сохранение картинки документооборота в формате "png"
|[[Файл:ДО 2.png|без|мини]]
|}
'''2. Вкладки:'''
{| class="wikitable"
|Состояния
|Состояние документа предназначен для отслеживания статуса документа на его жизненном цикле.
Состояния находятся в таблице DOC_STATE.
| rowspan="6" |[[Файл:ДО 3.png|без|мини]]
|-
|Роли
|Роли предназначены для дополнительного способа ограничений на определенный набор действий в системе.
Роли находятся в таблице DOC_ROLE.

Все роли привязаны к Типу документа (DOC_TYPE_ID ) и доступны для просмотра и редактирования.

Роли применяются:

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

- к работе со сканированными документами (не обязательна);

- при настройке параметров сохранения в выбранном состоянии;

- при произвольном действие в коде, с помощью вызова функции CHECK_ROLE
|-
|Права
|Права определяют действия пользователя на переходах по документообороту, а так же права на сохранение документа.
У каждого права есть идентификатор (уникальный номер) и наименование, которое присваивается автоматически при добавлении.

Справочник прав документооборота находится в таблице SYS_BUS_FUNC.

Право относится к определенному типу TYPE_FUNC_ID и атрибуту DOC_TYPE_ID.

В дополнение у этих прав TYPE_FUNC_ID проставляется в 1.
|-
|Результаты
|Результат выполнения функции технологической операции.
Таблица SYS_FUNC_RESULT.
|-
|ЭЦП
|Электронная цифровая подпись позволяет идентифицировать владельца подписи.
При нажатии на кнопку подписания ЭЦП вызывается апп-функция DOC_S_GETTEXTSIGN и

после подписания на клиенте - апп-функция DOC_S_INSERTSIGN_NEW.

Параметр ORG_ECP_SIGN может принимать следующие значения:

0 - ЭЦП не ожидается,

1 - ЭЦП нужна, но не от организации пользователя,

2 - ЭЦП от организации пользователя,

3 - ЭЦП от организации пользователя (но таймаут просрочен),

4 - ЭЦП от организации пользователя и откатывать нельзя
|-
|Поиск
|Предназначена для поиска апп-функций и переходов
|}'''3. Панель навигации'''

Предназначена для перемещения схемы документооборота и ее масштабирования.
[[Файл:ДО 4.png|без|мини]]
'''4. Масштабирование блоков'''

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

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

Горизонтальная прокрутка строк осуществляется при помощи полосы прокрутки (скролла).

Вертикальная прокрутка строк осуществляется при помощи колесика мыши или полосы прокрутки (скролла)
[[Файл:ДО 5.png|без|мини]]

== Создание документооборота ==
Построение схемы документооборота заключается в добавлении состояний и переходов в порядке установленным бизнес-процессом документа.
При создании документа, в рабочей области документооборота проставляется начальное событие и состояние.
[[Файл:ДО 6.png|без|мини]]
Документооборот может быть создан с несколькими начальными состояниями, которые разделяются ролями (Вкладка «Роли») и должны быть взаимоисключающие.

Для добавления множественных начальных переходов в одно состояние, с разными результатами необходимо выделить нужное состояние и в свойства нажать на кнопку «Добавить начальный переход».
[[Файл:ДО 7.png|без|мини]]

=== Добавление состояния ===
Чтобы добавить новое состояние, необходимо навести указатель мыши на рабочую область и нажать кнопку «Insert» на клавиатуре.

После чего будет добавлено новое состояние, которое можно переместить в пределах рабочей области.
Для этого его необходимо выделить и удерживая левую кнопку мыши переместить.
[[Файл:ДО 8.png|без|мини]]
Также добавить новое состояние можно, наведя курсор мыши на начальное состояние, пока не появятся стрелки (слева, справа и снизу)

При нажатии на стрелку левой кнопкой мыши, будет добавлено новое состояние в выбранном направлении.
[[Файл:ДО 9.png|без|обрамить]]
Состояния добавляются кратно нажатию на кнопку «Insert» или при нажатии на стрелки (Рисунок 28).
[[Файл:ДО 10.png|без|мини|365x365пкс]]
Для удаления состояния его необходимо выделить, нажав левой кнопкой мыши и нажать кнопку «Delete».

Чтобы просмотреть список созданных состояний и основные параметры необходимо открыть вкладку «Состояния».
[[Файл:ДО 11.png|без|мини|506x506пкс]]

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

Чтобы создать переход между состояниями, добавленными с помощью кнопки «Insert», необходимо навести курсор мыши на состояние до появления точек подключений.
[[Файл:ДО 12.png|без|мини|350x350пкс]]
Далее наведя курсор мыши на точку подключения «Нового состояния 1» и зажав левую кнопку мыши необходимо протянуть переход до точки подключения «Нового состояния 2».
[[Файл:ДО 13.png|без|мини|345x345пкс]]
Для удаления перехода его необходимо выделить, нажав левой кнопкой мыши и нажать кнопку «Delete».
== Параметры состояния и перехода ==
Для добавления или редактирования параметров необходимо выделить нужное состояние или переход. Откроется блок со свойствами.

Параметры состояния содержат следующие поля:
[[Файл:ДО 14.png|без|мини]]
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Название
|Наименование состояния
|-
|Начальное состояние
|Установка значения начального состояния.
|-
|Сохранение
|Выбор параметров сохранения документа на переходе. Описание в 6.4 Параметры сохранения документа
|-
|Некомплитность
|Незаверешнное состояние документа.

Ограничения:

1 Состояния не могут быть начальными, терминальными или участвовать в корректировках.

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

3 Право в переходе, входящем в некомплитное состояние, должно быть такое же как право на выходящем переходе
|-
|Количество точек подключений
|16 точек

28 точек

36точек
|}
Параметры перехода содержат следующие поля:
[[Файл:ДО 15.png|без|мини]]
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Название
|Наименование перехода
|-
|Тип перехода
|Выбор типа перехода:

- обычный переход

- корректировка
|-
|Право
|Выбор права из выпадающего списка
|-
|Результат
|Выбор результата из выпадающего списка.
|-
|Роль
|Выбор роли из выпадающего списка
|-
|Отмена
|Установка признака отмены операции.
При установке возможности отмены операции необходимо задать «Право отмены» и «Роль отмены» для которых данное свойство будет доступно.
|-
|'''Не сохранять перед переходом'''
|
|-
|Без проверки контролей
|Установка признака без проверки контролей, который позволяет совершить переход, даже если в документе есть ошибки
|-
|Доступна как групповая операция
|Установка признака применения группового перехода, который позволяет совершать переход как групповой. Пример: в фильтре документов для выбранных строк в гриде.
|-
|Метод переоткрытия
|Задается в сохраняемых состояниях и переходах.
· По настройке документа – задается на закладке «Свойства».

· Без переоткрытия – обновление только состояний и кнопок при переходе по документообороту

· Мягкое – WebShell получает новые данные документа из БД и, не закрывая старый документ, накладывает полученные данные в открытый документ, аналогично как при выполнении внешнего действия. Если XML при сохранении будет аналогичен полученному XML, то действия выполнены не будут, так как нет изменившихся параметров

· Полное - WebShell закрывает документ и полностью выполняет процедуру открытия документа, при этом выполняются все действия описанные в правилах также как при обычном открытии документа.
|-
| rowspan="4" |Диалог на переходе
|Выбор из выпадающего списка:

· Без диалога
|-
|· Диалог подтверждения
|-
|· Диалог с правилами и GUI

Предназначен для дополнения пользователем реквизитов документа при выполнении операции.
|-
|· Встроенная аналитика

В свойствах перехода указывается “Встроенная аналитика” и выбирается одна из созданных аналитик. При нажатии пользователем на кнопку перехода по документообороту, открывается окно встроенной аналитики.
|-
|Мин. длина примечания
|Минимальное значение ограничения длины примечания при переходе по документообороту
|-
|Макс. длина примечания
|Максимальное значение ограничения длины примечания при переходе по документообороту
|-
|Цвет перехода
|Выбор цвета перехода при работе на закладке «Документооборот»
|-
|Показывать кнопку перехода
|Установка признака отображения кнопки на переходе.
|-
|Настройка email-рассылки
|Отправка email-оповещения при переходе по документообороту
|}
При добавлении параметров на переходе они отображаются на документообороте следующими графическими элементами:
{| class="wikitable"
|Графическое отображение
|Наименование
|Описание
|-
|[[Файл:ДО 16.png|без|мини]]
|ЭЦП
|Отображается, если у результата перехода настроена электронная подпись или задано текстовое представление ЭЦП
|-
|[[Файл:ДО 17.png|без|мини]]
|Правила
|Отображается, если на переходе выбран диалог с правилами и GUI
|-
|[[Файл:ДО 18.png|без|мини]]
|Отмена
|Отмена последней операции, приводящее документ к состоянию, предшествующему текущему состоянию.
|-
|[[Файл:ДО 19.png|без|мини]]
|Некомплитное состояние
|Свойство перехода, которое позволяет вернуться к предыдущему состоянию (cancel === true).
|}
== Параметры сохранения документа в выбранном состоянии ==
Для отображения и редактирования параметров сохранения документа в выбранном состоянии необходимо выделить состояние и проставить галочку напротив параметра «Сохранение» .

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

[[Файл:ДО 20.1.png|без|мини]]

Описание параметров сохранения:
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Результат сохранения
|Выбор результата из выпадающего списка.

Описание в п. 6.7 Вкладка «Результаты»
|-
|Право на сохранение
|Выбор права из выпадающего списка

Описание в п. 6.6 Вкладка «Права»
|-
|Роль
|Выбор роли из выпадающего списка

Описание в п 6.4 Вкладка «Роли»
|-
|Метод переоткрытия
|Задается в сохраняемых состояниях и переходах.

· По настройке документа – задается на закладке «Свойства».

· Без переоткрытия – обновление только состояний и кнопок при переходе по документообороту

· Мягкое – WebShell получает новые данные документа из БД и, не закрывая старый документ, накладывает полученные данные в открытый документ, аналогично как при выполнении внешнего действия. Если XML при сохранении будет аналогичен полученному XML, то действия выполнены не будут, так как нет изменившихся параметров

· Полное - WebShell закрывает документ и полностью выполняет процедуру открытия документа, при этом выполняются все действия описанные в правилах также как при обычном открытии документа.
|}
== Вкладка «Роли» ==
'''<big>Свойства роли</big>'''

Роли находятся в таблице DOC_ROLE и имеют следующие атрибуты:

Таблица 8 Таблица ролей в БД
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|NAME
|Наименование роли
|-
|DOC_TYPE_ID
|ИД типа документа
|-
|ROLE_SQL
|SQL запрос роли
|}

Все роли привязаны к Типу документа (DOC_TYPE_ID ) и доступны для просмотра и редактирования.

Атрибут ROLE_SQL позволяет осуществлять проверку наличия роли у пользователя. В этом атрибуте лежит SQL запрос следующего формата:

SELECT ORG_TYPE_ID, ORG_ID, POST, USER_ID FROM ...

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

ИД текущего пользователя равен USER_ID

ИД должности текущего пользователя равен POST

ИД организации, в которой состоит текущий пользователь равен ORG_ID

ИД типа организации, в которой состоит текущий пользователь равен ORG_TYPE_ID

Вместо реальных ИД в любом поле может стоять 0, подходящее любому пользователю по аналогии с правом.

Пример для роли «Все» (создается для каждого нового документооборота и подходит для любого пользователя):

SELECT 0 ORG_TYPE_ID, 0 ORG_ID, 0 POST, 0 USER_ID FROM DUAL

С помощью оператора «Select» можно использовать внешний параметр DOC_ID

Пример применения внешних параметров:

SELECT 0 ORG_TYPE_ID, 0 ORG_ID, 0 POST, 0 USER_ID FROM DUAL WHERE :DOC_ID = 666

UNION ALL

SELECT 0 ORG_TYPE_ID, 10 ORG_ID, 0 POST, 0 USER_ID FROM DUAL

Дать доступ для любых операций с документом 666 или любому пользователю из организации с ИД = 10

Роли применяются:

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

- к работе со сканированными документами (не обязательна);

- при настройке параметров сохранения в выбранном состоянии;

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

'''<big>Добавление роли</big>'''

Роли предназначены для дополнительного способа ограничений на определенный набор действий в системе.

Для добавления роли необходимо перейти на закладку «Роли» и нажать на кнопку «Добавить» . Выделив созданную роль, откроется блок с настройками.
[[Файл:ДО 22.png|без|мини]]
'''<big>Удаление роли</big>'''

Для удаления роли необходимо нажать на напротив нее на вкладке «Роли».
[[Файл:ДО 23.png|без|мини]]

== Вкладка «Права» ==
Права определяют действия пользователя на переходах по документообороту, а так же права на сохранение документа. У каждого права есть идентификатор (уникальный номер) и наименование, которое присваивается автоматически при добавлении. Справочник прав документооборота находится в таблице SYS_BUS_FUNC.

Право относится к определенному типу TYPE_FUNC_ID и атрибуту DOC_TYPE_ID. В дополнение у этих прав TYPE_FUNC_ID проставляется в 1.

'''<big>Добавление права</big>'''

Для добавления права необходимо перейти на закладку «Права» и нажать на кнопку «Добавить». Выделив созданную роль, откроется блок с настройками.
[[Файл:ДО 24.png|без|мини]]
<big>'''Удаление права'''</big>

Для удаления права необходимо нажать на напротив него на вкладке «Права».
[[Файл:ДО 25.png|без|мини]]

== Вкладка «Результаты» ==
'''<big>Добавление результата</big>'''

Для добавления результата необходимо перейти на закладку «Результаты» и нажать на кнопку «Добавить».

Чтобы открыть настройки созданного результата, необходимо его выделить левой кнопкой мыши. Блок с настройками отобразится под таблицей.
[[Файл:ДО 26.png|без|мини]]
'''<big>Удаление результата</big>'''

Для удаления результата необходимо нажать на напротив него на вкладке «Результаты».
[[Файл:ДО 27.png|без|мини]]
'''<big>Свойства результата</big>'''

В настройках выбранного результата необходимо задать название результата и в выпадающем списке выбрать право ([https://xmdocs.intellex.ru/index.php/%D0%97%D0%B0%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D0%B0_%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%BE%D0%B1%D0%BE%D1%80%D0%BE%D1%82_%D0%94%D0%B8%D0%B7%D0%B0%D0%B9%D0%BD%D0%B5%D1%80%D0%B0_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%B2#%D0%92%D0%BA%D0%BB%D0%B0%D0%B4%D0%BA%D0%B0_%C2%AB%D0%9F%D1%80%D0%B0%D0%B2%D0%B0%C2%BB Вкладка Права]) для результата. Далее добавить апп-функции для события до и после перехода

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

При выполнении апп-функции переданные параметры встраиваются в SQL-конструкцию с помощью механизма JDBC PreparedStatement, что исключает возможность SQL-injection. Для выполнения запроса используется метод передачи имени функции и параметров её выполнения. Имена всех допустимых апп-функций хранятся в таблице «SYS_APP_FUNC».

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

== Вкладка «ЭЦП» ==
'''<big>Добавление ЭЦП</big>'''

Для добавления электронной цифровой подписи (далее – ЭЦП) необходимо перейти на закладку «ЭЦП» и нажать на кнопку «Добавить». Выделив созданную ЭЦП, откроется блок с настройками.
[[Файл:ДО 28.png|без|мини]]
'''<big>Удаление ЭЦП</big>'''
Для удаления ЭЦП необходимо нажать на напротив него на вкладке «ЭЦП».
[[Файл:ДО 29.png|без|мини]]
'''<big>Свойства ЭЦП</big>'''

После добавления необходимо добавить скрипты для формирования текстового представления ЭЦП, в котором должно быть указаны возможные входные параметры:
ИД документа (:DOC_ID),

ИД результата (RESULT_ID),

ИД записи в SYS_ECP_PATH (:ECP_PATH_ID),

дата, на которую получаем ТП (:DOC_DATE),

ИД операции (:OPER_ID),

ИД пользователя (:USER_ID),
обязательный выходной параметр :TEXT. Также необходимо указать период действия скрипта.
[[Файл:ДО 30.png|без|мини]]
Апп-функцию XM_DOC_S_GetDocECPProps нужно вызвать при (пере)открытии документа. Если параметр DOC_ECP_SIGN <> 0 и не пуст, то документ уже ЭЦП можно отразить на клиенте.

Параметр ORG_ECP_SIGN может принимать следующие значения:

0 - ЭЦП не ожидается,

1 - ЭЦП нужна, но не от организации пользователя,

2 - ЭЦП от организации пользователя,

3 - ЭЦП от организации пользователя (но таймаут просрочен),

4 - ЭЦП от организации пользователя и откатывать нельзя

Для значений 2 и 4 нужно показать на клиенте кнопку подписания ЭЦП.

Для значений 2 и 3 нужно показать кнопку отказа от подписания.

Для значения 0, если DOC_ECP_SIGN = 1 и ExistsRightToPaper=1, нужно показать кнопку перехода на бумажный документооборот

При нажатии на кнопку подписания ЭЦП надо вызвать апп-функцию DOC_S_GETTEXTSIGN и после подписания на клиенте - апп-функцию DOC_S_INSERTSIGN_NEW.

При нажатии на кнопку отказа от подписания надо вызвать апп-функцию DOC_S_UNDOLASTOPER.

При нажатии на кнопку перехода на бумажный документооборот надо вызвать апп-функцию Doc_S_SetZeroECPSIGN.

Для просмотра информации по ЭЦП вызываем DOC_S_GETALLSIGN для списка всех ЭЦП и DOC_S_CHECKSIGNOPER для просмотра более подробной информации по каждой ЭЦП.

В SYS_VAR_VALUE можно задать два параметры для работы с ЭЦП:

SYS_ECP2PAPER_RESULTID - Результат перехода на бумажный документооборот

SYS_ECP_TSPFUNCTION - Функция получения TSP. Пример FUNCTION FCCTEST.TEST_GET_TSP (p_sign IN BLOB) RETURN BLOB - при этом в sys_Var_value нужно прописать FCCTEST.TEST_GET_TSP

== Вкладка «Поиск» ==
Предназначена для поиска апп-функций и переходов.
[[Файл:ДО 31.png|без|мини]]

Файл:ДО 31.png

2022-07-28T14:23:35Z

Wiki:

ДО 31

Файл:ДО 30.png

2022-07-28T14:22:26Z

Wiki:

ДО 30

Файл:ДО 29.png

2022-07-28T14:20:59Z

Wiki:

ДО 29

Файл:ДО 28.png

2022-07-28T14:20:23Z

Wiki:

ДО 28

Закладка Документооборот Дизайнера документов

2022-07-28T14:17:23Z

Wiki: /* 1.5 Вкладка «Роли» */

Документооборот - это схема, которая определяет состояния документа и переходы между ними для управления бизнес-процессами компании.
[[Файл:ДО 1.1.1.png|без|мини]]

== Панель инструментов закладки «Документооборот». ==
Закладка Документооборот содержит:

'''1. Панель инструментов с командами:'''
{| class="wikitable"
|Скрыть/

показать название переходов
|Отображение и скрытие наименований переходов
|[[Файл:ДО 1.1.png|без|мини]]
|-
|Экспорт картинки
|Сохранение картинки документооборота в формате "png"
|[[Файл:ДО 2.png|без|мини]]
|}
'''2. Вкладки:'''
{| class="wikitable"
|Состояния
|Состояние документа предназначен для отслеживания статуса документа на его жизненном цикле.
Состояния находятся в таблице DOC_STATE.
| rowspan="6" |[[Файл:ДО 3.png|без|мини]]
|-
|Роли
|Роли предназначены для дополнительного способа ограничений на определенный набор действий в системе.
Роли находятся в таблице DOC_ROLE.

Все роли привязаны к Типу документа (DOC_TYPE_ID ) и доступны для просмотра и редактирования.

Роли применяются:

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

- к работе со сканированными документами (не обязательна);

- при настройке параметров сохранения в выбранном состоянии;

- при произвольном действие в коде, с помощью вызова функции CHECK_ROLE
|-
|Права
|Права определяют действия пользователя на переходах по документообороту, а так же права на сохранение документа.
У каждого права есть идентификатор (уникальный номер) и наименование, которое присваивается автоматически при добавлении.

Справочник прав документооборота находится в таблице SYS_BUS_FUNC.

Право относится к определенному типу TYPE_FUNC_ID и атрибуту DOC_TYPE_ID.

В дополнение у этих прав TYPE_FUNC_ID проставляется в 1.
|-
|Результаты
|Результат выполнения функции технологической операции.
Таблица SYS_FUNC_RESULT.
|-
|ЭЦП
|Электронная цифровая подпись позволяет идентифицировать владельца подписи.
При нажатии на кнопку подписания ЭЦП вызывается апп-функция DOC_S_GETTEXTSIGN и

после подписания на клиенте - апп-функция DOC_S_INSERTSIGN_NEW.

Параметр ORG_ECP_SIGN может принимать следующие значения:

0 - ЭЦП не ожидается,

1 - ЭЦП нужна, но не от организации пользователя,

2 - ЭЦП от организации пользователя,

3 - ЭЦП от организации пользователя (но таймаут просрочен),

4 - ЭЦП от организации пользователя и откатывать нельзя
|-
|Поиск
|предназначена для поиска апп-функций и переходов
|}'''3. Панель навигации'''

Предназначена для перемещения схемы документооборота и ее масштабирования.
[[Файл:ДО 4.png|без|мини]]
'''4. Масштабирование блоков'''

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

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

Горизонтальная прокрутка строк осуществляется при помощи полосы прокрутки (скролла).

Вертикальная прокрутка строк осуществляется при помощи колесика мыши или полосы прокрутки (скролла)
[[Файл:ДО 5.png|без|мини]]

== Создание документооборота ==
Построение схемы документооборота заключается в добавлении состояний и переходов в порядке установленным бизнес-процессом документа.
При создании документа, в рабочей области документооборота проставляется начальное событие и состояние.
[[Файл:ДО 6.png|без|мини]]
Документооборот может быть создан с несколькими начальными состояниями, которые разделяются ролями (Вкладка «Роли») и должны быть взаимоисключающие.

Для добавления множественных начальных переходов в одно состояние, с разными результатами необходимо выделить нужное состояние и в свойства нажать на кнопку «Добавить начальный переход».
[[Файл:ДО 7.png|без|мини]]

=== Добавление состояния ===
Чтобы добавить новое состояние, необходимо навести указатель мыши на рабочую область и нажать кнопку «Insert» на клавиатуре.

После чего будет добавлено новое состояние, которое можно переместить в пределах рабочей области.
Для этого его необходимо выделить и удерживая левую кнопку мыши переместить.
[[Файл:ДО 8.png|без|мини]]
Также добавить новое состояние можно, наведя курсор мыши на начальное состояние, пока не появятся стрелки (слева, справа и снизу)

При нажатии на стрелку левой кнопкой мыши, будет добавлено новое состояние в выбранном направлении.
[[Файл:ДО 9.png|без|обрамить]]
Состояния добавляются кратно нажатию на кнопку «Insert» или при нажатии на стрелки (Рисунок 28).
[[Файл:ДО 10.png|без|мини|365x365пкс]]
Для удаления состояния его необходимо выделить, нажав левой кнопкой мыши и нажать кнопку «Delete».

Чтобы просмотреть список созданных состояний и основные параметры необходимо открыть вкладку «Состояния».
[[Файл:ДО 11.png|без|мини|506x506пкс]]

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

Чтобы создать переход между состояниями, добавленными с помощью кнопки «Insert», необходимо навести курсор мыши на состояние до появления точек подключений.
[[Файл:ДО 12.png|без|мини|350x350пкс]]
Далее наведя курсор мыши на точку подключения «Нового состояния 1» и зажав левую кнопку мыши необходимо протянуть переход до точки подключения «Нового состояния 2».
[[Файл:ДО 13.png|без|мини|345x345пкс]]
Для удаления перехода его необходимо выделить, нажав левой кнопкой мыши и нажать кнопку «Delete».
== Параметры состояния и перехода ==
Для добавления или редактирования параметров необходимо выделить нужное состояние или переход. Откроется блок со свойствами.

Параметры состояния содержат следующие поля:
[[Файл:ДО 14.png|без|мини]]
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Название
|Наименование состояния
|-
|Начальное состояние
|Установка значения начального состояния.
|-
|Сохранение
|Выбор параметров сохранения документа на переходе. Описание в 6.4 Параметры сохранения документа
|-
|Некомплитность
|Незаверешнное состояние документа.

Ограничения:

1 Состояния не могут быть начальными, терминальными или участвовать в корректировках.

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

3 Право в переходе, входящем в некомплитное состояние, должно быть такое же как право на выходящем переходе
|-
|Количество точек подключений
|16 точек

28 точек

36точек
|}
Параметры перехода содержат следующие поля:
[[Файл:ДО 15.png|без|мини]]
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Название
|Наименование перехода
|-
|Тип перехода
|Выбор типа перехода:

- обычный переход

- корректировка
|-
|Право
|Выбор права из выпадающего списка
|-
|Результат
|Выбор результата из выпадающего списка.
|-
|Роль
|Выбор роли из выпадающего списка
|-
|Отмена
|Установка признака отмены операции.
При установке возможности отмены операции необходимо задать «Право отмены» и «Роль отмены» для которых данное свойство будет доступно.
|-
|'''Не сохранять перед переходом'''
|
|-
|Без проверки контролей
|Установка признака без проверки контролей, который позволяет совершить переход, даже если в документе есть ошибки
|-
|Доступна как групповая операция
|Установка признака применения группового перехода, который позволяет совершать переход как групповой. Пример: в фильтре документов для выбранных строк в гриде.
|-
|Метод переоткрытия
|Задается в сохраняемых состояниях и переходах.
· По настройке документа – задается на закладке «Свойства».

· Без переоткрытия – обновление только состояний и кнопок при переходе по документообороту

· Мягкое – WebShell получает новые данные документа из БД и, не закрывая старый документ, накладывает полученные данные в открытый документ, аналогично как при выполнении внешнего действия. Если XML при сохранении будет аналогичен полученному XML, то действия выполнены не будут, так как нет изменившихся параметров

· Полное - WebShell закрывает документ и полностью выполняет процедуру открытия документа, при этом выполняются все действия описанные в правилах также как при обычном открытии документа.
|-
| rowspan="4" |Диалог на переходе
|Выбор из выпадающего списка:

· Без диалога
|-
|· Диалог подтверждения
|-
|· Диалог с правилами и GUI

Предназначен для дополнения пользователем реквизитов документа при выполнении операции.
|-
|· Встроенная аналитика

В свойствах перехода указывается “Встроенная аналитика” и выбирается одна из созданных аналитик. При нажатии пользователем на кнопку перехода по документообороту, открывается окно встроенной аналитики.
|-
|Мин. длина примечания
|Минимальное значение ограничения длины примечания при переходе по документообороту
|-
|Макс. длина примечания
|Максимальное значение ограничения длины примечания при переходе по документообороту
|-
|Цвет перехода
|Выбор цвета перехода при работе на закладке «Документооборот»
|-
|Показывать кнопку перехода
|Установка признака отображения кнопки на переходе.
|-
|Настройка email-рассылки
|Отправка email-оповещения при переходе по документообороту
|}
При добавлении параметров на переходе они отображаются на документообороте следующими графическими элементами:
{| class="wikitable"
|Графическое отображение
|Наименование
|Описание
|-
|[[Файл:ДО 16.png|без|мини]]
|ЭЦП
|Отображается, если у результата перехода настроена электронная подпись или задано текстовое представление ЭЦП
|-
|[[Файл:ДО 17.png|без|мини]]
|Правила
|Отображается, если на переходе выбран диалог с правилами и GUI
|-
|[[Файл:ДО 18.png|без|мини]]
|Отмена
|Отмена последней операции, приводящее документ к состоянию, предшествующему текущему состоянию.
|-
|[[Файл:ДО 19.png|без|мини]]
|Некомплитное состояние
|Свойство перехода, которое позволяет вернуться к предыдущему состоянию (cancel === true).
|}
== Параметры сохранения документа в выбранном состоянии ==
Для отображения и редактирования параметров сохранения документа в выбранном состоянии необходимо выделить состояние и проставить галочку напротив параметра «Сохранение» .

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

[[Файл:ДО 20.1.png|без|мини]]

Описание параметров сохранения:
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|Результат сохранения
|Выбор результата из выпадающего списка.

Описание в п. 6.7 Вкладка «Результаты»
|-
|Право на сохранение
|Выбор права из выпадающего списка

Описание в п. 6.6 Вкладка «Права»
|-
|Роль
|Выбор роли из выпадающего списка

Описание в п 6.4 Вкладка «Роли»
|-
|Метод переоткрытия
|Задается в сохраняемых состояниях и переходах.

· По настройке документа – задается на закладке «Свойства».

· Без переоткрытия – обновление только состояний и кнопок при переходе по документообороту

· Мягкое – WebShell получает новые данные документа из БД и, не закрывая старый документ, накладывает полученные данные в открытый документ, аналогично как при выполнении внешнего действия. Если XML при сохранении будет аналогичен полученному XML, то действия выполнены не будут, так как нет изменившихся параметров

· Полное - WebShell закрывает документ и полностью выполняет процедуру открытия документа, при этом выполняются все действия описанные в правилах также как при обычном открытии документа.
|}
== Вкладка «Роли» ==
'''<big>Свойства роли</big>'''

Роли находятся в таблице DOC_ROLE и имеют следующие атрибуты:

Таблица 8 Таблица ролей в БД
{| class="wikitable"
|'''Наименование'''
|'''Описание'''
|-
|NAME
|Наименование роли
|-
|DOC_TYPE_ID
|ИД типа документа
|-
|ROLE_SQL
|SQL запрос роли
|}

Все роли привязаны к Типу документа (DOC_TYPE_ID ) и доступны для просмотра и редактирования.

Атрибут ROLE_SQL позволяет осуществлять проверку наличия роли у пользователя. В этом атрибуте лежит SQL запрос следующего формата:

SELECT ORG_TYPE_ID, ORG_ID, POST, USER_ID FROM ...

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

ИД текущего пользователя равен USER_ID

ИД должности текущего пользователя равен POST

ИД организации, в которой состоит текущий пользователь равен ORG_ID

ИД типа организации, в которой состоит текущий пользователь равен ORG_TYPE_ID

Вместо реальных ИД в любом поле может стоять 0, подходящее любому пользователю по аналогии с правом.

Пример для роли «Все» (создается для каждого нового документооборота и подходит для любого пользователя):

SELECT 0 ORG_TYPE_ID, 0 ORG_ID, 0 POST, 0 USER_ID FROM DUAL

С помощью оператора «Select» можно использовать внешний параметр DOC_ID

Пример применения внешних параметров:

SELECT 0 ORG_TYPE_ID, 0 ORG_ID, 0 POST, 0 USER_ID FROM DUAL WHERE :DOC_ID = 666

UNION ALL

SELECT 0 ORG_TYPE_ID, 10 ORG_ID, 0 POST, 0 USER_ID FROM DUAL

Дать доступ для любых операций с документом 666 или любому пользователю из организации с ИД = 10

Роли применяются:

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

- к работе со сканированными документами (не обязательна);

- при настройке параметров сохранения в выбранном состоянии;

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

'''<big>Добавление роли</big>'''

Роли предназначены для дополнительного способа ограничений на определенный набор действий в системе.

Для добавления роли необходимо перейти на закладку «Роли» и нажать на кнопку «Добавить» . Выделив созданную роль, откроется блок с настройками.
[[Файл:ДО 22.png|без|мини]]
'''<big>Удаление роли</big>'''

Для удаления роли необходимо нажать на напротив нее на вкладке «Роли».
[[Файл:ДО 23.png|без|мини]]

== Вкладка «Права» ==
Права определяют действия пользователя на переходах по документообороту, а так же права на сохранение документа. У каждого права есть идентификатор (уникальный номер) и наименование, которое присваивается автоматически при добавлении. Справочник прав документооборота находится в таблице SYS_BUS_FUNC.

Право относится к определенному типу TYPE_FUNC_ID и атрибуту DOC_TYPE_ID. В дополнение у этих прав TYPE_FUNC_ID проставляется в 1.

'''<big>Добавление права</big>'''

Для добавления права необходимо перейти на закладку «Права» и нажать на кнопку «Добавить». Выделив созданную роль, откроется блок с настройками.
[[Файл:ДО 24.png|без|мини]]
<big>'''Удаление права'''</big>

Для удаления права необходимо нажать на напротив него на вкладке «Права».
[[Файл:ДО 25.png|без|мини]]

== Вкладка «Результаты» ==
'''<big>Добавление результата</big>'''

Для добавления результата необходимо перейти на закладку «Результаты» и нажать на кнопку «Добавить».

Чтобы открыть настройки созданного результата, необходимо его выделить левой кнопкой мыши. Блок с настройками отобразится под таблицей.
[[Файл:ДО 26.png|без|мини]]
'''<big>Удаление результата</big>'''

Для удаления результата необходимо нажать на напротив него на вкладке «Результаты».
[[Файл:ДО 27.png|без|мини]]
'''<big>Свойства результата</big>'''

В настройках выбранного результата необходимо задать название результата и в выпадающем списке выбрать право '''(п. 6.6)''' для результата. Далее добавить апп-функции для события до и после перехода

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

При выполнении апп-функции переданные параметры встраиваются в SQL-конструкцию с помощью механизма JDBC PreparedStatement, что исключает возможность SQL-injection. Для выполнения запроса используется метод передачи имени функции и параметров её выполнения. Имена всех допустимых апп-функций хранятся в таблице «SYS_APP_FUNC».

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

== 1.8 Вкладка «ЭЦП» ==

=== 1.8.1 Добавление ЭЦП ===
Для добавления электронной цифровой подписи (далее – ЭЦП) необходимо перейти на закладку «ЭЦП» (Рисунок 22) и нажать на кнопку «Добавить». Выделив созданную ЭЦП, откроется блок с настройками (Рисунок 44).

Рисунок 44 Добавление ЭЦП

=== 1.8.2 Удаление ЭЦП ===
Для удаления ЭЦП необходимо нажать на напротив него на вкладке «ЭЦП» (Рисунок 45).

Рисунок 45 Удаление ЭЦП

=== 1.8.3 Свойства ЭЦП ===
После добавления необходимо добавить скрипты для формирования текстового представления ЭЦП, в котором должно быть указаны возможные входные параметры: ИД документа (:DOC_ID), ИД результата (RESULT_ID), ИД записи в SYS_ECP_PATH (:ECP_PATH_ID), дата, на которую получаем ТП (:DOC_DATE), ИД операции (:OPER_ID), ИД пользователя (:USER_ID), обязательный выходной параметр :TEXT. Также необходимо указать период действия скрипта (Рисунок 46).

Рисунок 46 Настройка ЭЦП

Апп-функцию XM_DOC_S_GetDocECPProps нужно вызвать при (пере)открытии документа. Если параметр DOC_ECP_SIGN <> 0 и не пуст, то документ уже ЭЦП можно отразить на клиенте.

Параметр ORG_ECP_SIGN может принимать следующие значения:

0 - ЭЦП не ожидается,

1 - ЭЦП нужна, но не от организации пользователя,

2 - ЭЦП от организации пользователя,

3 - ЭЦП от организации пользователя (но таймаут просрочен),

4 - ЭЦП от организации пользователя и откатывать нельзя

Для значений 2 и 4 нужно показать на клиенте кнопку подписания ЭЦП.

Для значений 2 и 3 нужно показать кнопку отказа от подписания.

Для значения 0, если DOC_ECP_SIGN = 1 и ExistsRightToPaper=1, нужно показать кнопку перехода на бумажный документооборот

При нажатии на кнопку подписания ЭЦП надо вызвать апп-функцию DOC_S_GETTEXTSIGN и после подписания на клиенте - апп-функцию DOC_S_INSERTSIGN_NEW.

При нажатии на кнопку отказа от подписания надо вызвать апп-функцию DOC_S_UNDOLASTOPER.

При нажатии на кнопку перехода на бумажный документооборот надо вызвать апп-функцию Doc_S_SetZeroECPSIGN.

Для просмотра информации по ЭЦП вызываем DOC_S_GETALLSIGN для списка всех ЭЦП и DOC_S_CHECKSIGNOPER для просмотра более подробной информации по каждой ЭЦП.

В SYS_VAR_VALUE можно задать два параметры для работы с ЭЦП:

SYS_ECP2PAPER_RESULTID - Результат перехода на бумажный документооборот

SYS_ECP_TSPFUNCTION - Функция получения TSP. Пример FUNCTION FCCTEST.TEST_GET_TSP (p_sign IN BLOB) RETURN BLOB - при этом в sys_Var_value нужно прописать FCCTEST.TEST_GET_TSP

== 1.9 Вкладка «Поиск» ==

Файл:ДО 27.png

2022-07-28T14:16:58Z

Wiki:

ДО 27

Файл:ДО 26.png

2022-07-28T14:15:26Z

Wiki:

ДО 26