dcs_read — Документация Кванты

dcs_read

R · чтениепо подпискене изменяет проект

Читает схему компоновки данных по адресу — обзор схемы, набор данных с текстом запроса и полями, параметр, вычисляемое поле, ресурс, связь наборов, вложенную схему, макет оформления. Грань #help — контракт dcs_write для узла и рецепт рабочего отчёта.

Когда использовать

Разобраться в существующем отчёте: какие наборы, откуда данные, какие ресурсы и варианты.
Перед записью узла — #help на его адресе: ключи definition, пример; работает и для несуществующего узла.
Найти параметр или поле по имени — filter.

Соседние инструменты домена «Отчёты СКД»

dcs_writeWсоздать, изменить, удалить узел схемы composition_settings_readRнастройки варианта: поля, отборы, группировки composition_settings_writeWСоздаёт, изменяет на месте и удаляет элементы настроек компоновки — выбранные поля, отборы и группы отборов, сортировку, группировки, условное оформление, параметры данных и вывода. Адрес — якорь настроек плюс путь секции, элементы адресуются индексом [i], который не сдвигается при правке.

Операции

Параметра operation у инструмента нет: что вернуть, задаёт адрес fqn — маркер-хвост и грань после #.

Режимы dcs_read по адресу
Адрес или грань	Что возвращает
`Report.X.Template.<Схема>`	Обзор схемы: наборы, параметры, ресурсы, связи, варианты
`….DataSet.<Набор>`	Набор: для запроса — текст и поля
`….DataSet.<Набор>.Field.<Поле>`	Поле набора
`….Parameter.<Имя>`	Параметр схемы
`….CalculatedField.<Поле>, ….TotalField.<Поле>`	Вычисляемое поле, ресурс
`….DataSetLink.<номер>`	Связь наборов — по номеру: имени у связи нет
`….NestedSchema.<Имя>, ….AreaTemplate.<Имя>`	Вложенная схема, макет оформления (только чтение)
`….DataSet`	Маркер без имени — срез коллекции списком
`<адрес>#help`	Контракт `dcs_write` для узла и рецепт отчёта с нуля

Параметры

Параметры dcs_read
Параметр и тип	Обязательный	Описание	По умолчанию
`project`строка	да	Идентификатор проекта рабочей области EDT — имя из ответа project_read (например, УТ2020). Для расширения — проект расширения.	—
`fqn`строка	да	Адрес схемы или её узла: `Report.<Отчет>.Template.<Схема>`, `.DataSet.<Набор>`, `.DataSet.<Набор>.Field.<Поле>`, `.Parameter.<Имя>`, `.CalculatedField.<Поле>`, `.TotalField.<Поле>`, `.DataSetLink.<номер>`. Грань — `#source` или `#properties`. Маркеры — по-русски или по-английски.	—
`filter`строка	нет	Регулярное выражение без учёта регистра по именам.	—
`limit`целое	нет	Окно чтения: сколько строк готового ответа вернуть. По умолчанию 200, максимум 1000.	`200`
`offset`целое	нет	Окно чтения: номер строки ответа, с которой начать (0 — первая страница). Значение для следующей страницы подсказывает строка `lines: …` в конце ответа.	`0`

Таблица собрана из схемы инструмента, которую получает агент при подключении.

Адреса

Адреса dcs_read
Адрес	Что адресует
`Report.<Отчет>.Template.<Схема>`	обзор схемы
`Report.<Отчет>.Template.<Схема>.DataSet.<Набор>`	набор данных
`Report.<Отчет>.Template.<Схема>.Parameter.Период`	параметр
`Report.<Отчет>.Template.<Схема>.DataSet.<Набор>.Field.<Поле>#help`	контракт записи поля

Пример вызова и ответа

аргументы dcs_read

{ "project": "УТ2020", "fqn": "Report.<Отчет>.Template.<Схема>", "filter": "Период" }

Пример ответа в подготовке Устройство ответа — на странице Формат ответов.

Отказы и ошибки

Узел не найден

Имени нет в схеме — ответ предлагает ближайшие имена (Did you mean).

Макет табличного документа

Печатные макеты читает spreadsheet_read, а не этот инструмент.

failed · лицензия

Без действующего ключа инструмент отвечает карточкой failed с сообщением лицензия: … и подсказкой, где ввести ключ; в секции Context — список инструментов, доступных без ключа. Подробнее — Лицензия и бесплатный доступ.

Ограничения

Макеты оформления схемы только читаются.