Show/Hide Toolbars

Руководство администратора

Произвольные источники данных

Ссылки Назад Вверх Вперед

warning_icon Работает только для MS SQL

Инструмент предназначен для работы с произвольными источниками данных как из самой системы, так и получаемых через интеграции: просмотр, фильтрация, выбор полей, выгрузка в excel. Произвольные источники позволяют в интерфейсе "Первой Формы" работать с большими объемами данных и сложными аналитическими отчетностями.

custom_data_sources_all

Список произвольных источников данных

Добавление и редактирование источников данных

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

warning_icon При создании нового источника необходимо настроить и сохранить колонки

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

custom_data_sources_1_main

Редактирование произвольного источника, вкладка "Общие"

custom_data_sources_2_columns2

Редактирование произвольного источника, вкладка "Колонки"

custom_data_sources_3_actions

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

custom_data_sources_4_toolbar

Редактирование произвольного источника, вкладка "Настройки тулбара"

custom_data_sources_5_view

Редактирование произвольного источника, вкладка "Общий вид"

После внесения изменений нажмите кнопку Сохранить.

Общие

Тип источника данных

Доступные варианты:

Таблица

Функция

Хранимая процедура (доступно только на MSSQL)

Представление

Хранимая процедура без явного ResultSet (доступно только на MSSQL)*

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

 

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

 

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

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

 

Пример функции:

CREATE FUNCTION customDataSourceFunc ( @UserId int null ) RETURNS TABLE AS RETURN ( SELECT DisplayName, LastName from Users )

 

Пример хранимой процедуры:

CREATE PROCEDURE customDataSourceProc @UserId int null AS BEGIN SELECT DisplayName, LastName from Users END

Источник данных*

Источник данных в БД

Загружать данные при открытии

Если настройка неактивна, при открытии будет отображаться пустой список с уведомлением: Для отображения данных, нажмите "Загрузить"

По умолчанию активировано.

Название

Название произвольного источника

Алиас*

Наименование источника (псевдоним)

Путь

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

Описание

Описание произвольного источника

Группы

Список групп, которым выданы права на источник

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

Произвольный источник можно открыть как отдельным роутом, так и из БИ.

При выборе типа "Блок используется" к пути добавляется ds/{alias}?taskId=

Колонки

Колонка в БД

Название колонки в БД. Подтягивается автоматически, поле недоступно для редактирования

warning_icon При настройке произвольного источника необходимо использовать значения колонок именно в том виде (с сохранением регистра), в котором они передаются в поле "Колонка в БД".

Название

Название колонки

warning_icon Если необходимо открывать ссылки, в название колонки необходимо указать TaskID

Тип

Тип данных колонки. Доступные варианты:

Число

Строка

Дата

Дата и время

Html

Html без тегов

Чекбокс

Настройки фильтра

Доступные типы фильтра: Базовый и Мультивыбор. Фильтр с типом "Мультивыбор" для колонки в списке задач категории позволяет дополнительно выбирать несколько значений из множества.
Для мультивыбора необходимо указать источник фильтра:

custom_data_sources_edit_columns_multifilter

Доступно

Доступ поля для пользователей

Детализируется

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

custom_data_sources_2_columns_details

Детализация по колонкам Title, Genre, Year

Действия

Позволяет добавлять кастомные кнопки действий со строкой, которые отобржаются в отдельной колонке "Действия".

Настройка кнопок действий в колонке задается в формате JSON со следующими параметрами:

icon  Название иконки из набора, она будет отображаться на кнопке. Список доступных иконок вы можете найти по ссылке: /spa/icons

name  Название кнопки.

showInMenu  Отображение кнопки в меню. Возможные значения: true (отображать) / false (не отображать).

showInActions Отображение кнопки в тулбаре действий. Возможные значения: true (отображать) / false (не отображать).

type Тип кнопки. Возможные значения: OpenUrl — Открыть ссылку из параметра url, Request — Запрос, OpenComponent — Открыть компонент (в настоящее время не поддерживается).

options:

ourl Ссылка, которая открывается при нажатии на кнопку. Помимо статичной ссылки вы можете задать ссылку на конкретную строку таблицы в формате {params:[column]}, вместо [column] указывается название колонки, из которой необходимо получить данные в этой строке (см.пример).

oopenMode — Режим отображения. Возможные значения: CurrentWindow — в текущем окне, NewWindow — в новом окне, ModalWindow — в модальном окне.

oparams  — может содержать элемент http-запроса: headers, credentials, body и т.п. Наиболее распространенное значение:

method API-метод (GET, POST).

oshowResponse Отображение результата запроса. Возможные значения: true (отображать) / false (не отображать).

oisAvailable Настройка доступа в формате: "(params, ctx) => params.id === 123 && ctx.userId === 11".

Пример

custom_data_sources_example1

Отображение кнопок действий со строкой в пользовательском интерфейсе

Настройки тулбара

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

Настройка кнопок в панели инструментов задается в формате JSON со следующими параметрами:

icon  Название иконки из набора, она будет отображаться на кнопке панели инструментов. Список доступных иконок вы можете найти по ссылке: /spa/icons

name  Название кнопки.

showInMenu  Отображение кнопки в меню. Возможные значения: true (отображать) / false (не отображать).

showInActions Отображение кнопки в тулбаре действий. Возможные значения: true (отображать) / false (не отображать).

type Тип кнопки. Возможные значения: OpenUrl — Открыть ссылку из параметра url, Request — Запрос, OpenComponent — Открыть компонент (в настоящее время не поддерживается).

options:

ourl Ссылка, которая открывается при нажатии на кнопку.

oopenMode — Режим отображения. Возможные значения: CurrentWindow — в текущем окне, NewWindow — в новом окне, ModalWindow — в модальном окне.

oparams (может содержать элемент http-запроса: headers, credentials, body и т.п. Наиболее распространенное значение:

method API-метод (GET, POST).

oshowResponse Отображение результата запроса. Возможные значения: true (отображать) / false (не отображать).

oisAvailable Настройка доступа в формате: "(params, ctx) => params.id === 123 && ctx.userId === 11".

Пример

custom_data_sources_example2

Отображение кнопок действий в пользовательском интерфейсе

Общий вид

vh-Re-v1

Обновление данных

vh-hamburger-menu

Выбор нужного состава колонок для отображения

select_icon_new

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

vh-Categories

Пакетная обработка

vh-download2

Выгрузка в файл Excel

warning_icon В системе нельзя экспортировать более 50 000 задач!

icon_def

Сброс персональных настроек табличного представления, сделанных пользователем (сортировка, группировка, список и порядок колонок), и возврат к настройкам таблицы, определенным по умолчанию для данной категории\раздела системным администратором

Особенности работы с хранимой процедурой в качестве источника данных

Источником данных может являться хранимая процедура SQL. К таким процедурам предъявляется ряд требований.

Входные параметры хранимой процедуры:

Обязательно: @UserID (int) — ID текущего пользователя.

Опционально: @TaskID (int) — ID текущей задачи

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

Хранимая процедура может возвращать произвольные данные и произвольный набор колонок. Названия колонок должны быть на латинице без пробелов

Пример процедуры

Удаление настроек

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

custom_data_sources_delete

Удаление источника данных