Как программно получить настройки компоновки данных в 1С

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

Настройки компоновки данных (СКД) представляют собой сложный объект, содержащий отборы, параметры, структуру полей и варианты оформления. Получить их можно различными способами: от прямого обращения к свойствам макета в коде до использования встроенных механизмов консоли запросов. Понимание структуры этих объектов критически важно для отладки и оптимизации отчетов.

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

Объектная модель настроек СКД

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

Для доступа к конкретным параметрам, таким как отборы или сортировки, необходимо обращаться к соответствующим коллекциям объекта. Например, коллекция Отборы содержит объекты типа ЭлементОтбораКомпоновкиДанных, каждый из которых имеет свой логический тип и значение. Важно понимать, что значения параметров могут быть как простыми типами (строка, число), так и сложными структурами.

При программном анализе часто требуется привести настройки к читаемому виду. Для этого используется механизм сериализации в XML или JSON. Однако, прямое преобразование может привести к потере части мета-данных, если не учитывать контекст схемы компоновки данных.

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

Получение настроек через код встроенного языка

Самый распространенный сценарий — получение настроек из формы отчета или непосредственно из объекта СхемаКомпоновкиДанных. Если вы находитесь внутри модуля формы, доступ к текущим настройкам обычно осуществляется через свойство формы Настройки. Это свойство возвращает актуальный объект настроек, учитывающий все изменения, внесенные пользователем в интерфейс.

Для программного создания новых настроек "с нуля" используется конструктор объекта. Вы можете инициализировать пустой объект и заполнить его необходимыми элементами. Ниже приведен пример кода, демонстрирующий базовый подход к чтению и модификации параметров:

// Получаем текущие настройки из формы
ТекущиеНастройки = ЭлементыФормы.Отчет.НастройкиКомпоновкиДанных;

// Создаем копию для безопасного редактирования
КопияНастроек = ТекущиеНастройки.ПолучитьНастройки();

// Проходим по коллекции отборов
Для каждого ЭлементОтбора Из КопияНастроек.Отборы Цикл
Если ЭлементОтбора.Использование = Истина Тогда
Сообщить("Активный отбор: " + ЭлементОтбора.Поле);
КонецЕсли;
КонецЦикла;

Обратите внимание на метод ПолучитьНастройки(). Он возвращает независимую копию объекта, что позволяет вносить изменения без немедленного влияния на визуальную часть отчета. Это полезно при реализации сценариев предварительного просмотра или валидации введенных данных.

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

Анализ настроек в Консоли запросов

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

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

Секретная функция консоли

Вы можете экспортировать текущие настройки прямо из окна отладки запроса, скопировав XML-представление объекта НастройкиКомпоновкиДанных для последующего использования в тестах.

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

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

Сериализация и сохранение вариантов настроек

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

Для записи настроек в файл используется объект ЗаписьXML. Важно соблюдать порядок действий: сначала записать схему (если она кастомная), а затем сами настройки. Это гарантирует, что при чтении файл будет корректно восстановлен даже на другой базе данных.

Метод сохранения	Формат данных	Где хранится	Доступность
Хранилище вариантов	Бинарные данные / XML	Таблица информационного регистра	Только текущий пользователь
Файл на диске	XML	Локальная файловая система	Любой пользователь с доступом к файлу
Буфер обмена	Текст (XML/JSON)	Оперативная память ОС	Временный обмен между окнами
Внешнее хранилище	JSON / Сериализованный объект	HTTP-сервис или база данных	Кросс-платформенный доступ

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

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

Работа с расширениями и динамическими полями

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

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

⚠️ Внимание: При обновлении конфигурации имена полей в схеме компоновки данных могут измениться. Настройки, сохраненные в старой версии, могут стать невалидными. Всегда тестируйте загрузку сохраненных вариантов после обновления платформы.

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

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

Типовые ошибки и методы отладки

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

Еще одна распространенная ошибка — некорректная работа с периодами. Параметры периода в 1С имеют сложную структуру (вид периода, начало, конец). Прямое присваивание даты без учета вида периода часто приводит к тому, что отчет формирует данные за весь доступный диапазон вместо выбранного месяца.

⚠️ Внимание: Интерфейс и возможности работы с СКД могут отличаться в разных версиях платформы 1С (например, 8.3.10 против 8.3.25). Некоторые методы сериализации были добавлены в более поздних релизах. Сверяйте документацию для вашей конкретной версии платформы.

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

Часто задаваемые вопросы (FAQ)

Как программно сбросить все настройки отчета к значениям по умолчанию?

Для этого необходимо получить объект схемы компоновки данных и вызвать метод Настройки.ЗаполнитьПараметрыПоУмолчанию() или просто создать новый экземпляр НастройкиКомпоновкиДанных, передав в конструктор схему. Это очистит все пользовательские отборы и вернет стандартную структуру.

Можно ли передать настройки отчета в другой сеанс 1С?

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

Почему настройки не сохраняются после закрытия формы?

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

Как получить доступ к настройкам из внешнего отчета?

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