АЦРК: дополнительные отчеты и обработки
для конфигураций, основанных на БСП.
Часть 2. Печатные формы.
1. Теория
БСП — библиотека стандартных подсистем, на которой основаны типовые конфигурации 1С на управляемых формах.
В состав БСП входит и подсистема «Дополнительные отчеты и обработки»», которая определяет правила создания и подключения к конфигурациям дополнительных ВНЕШНИХ отчетов и обработок различного назначения.
В БСП для дополнительных внешних отчетов и обработок (далее ДВОО) предусмотрен справочник "ДополнительныеОтчетыИОбработки". Кроме того, для каждой ДВОО предусмотрено три способа вызова:
- вызов серверного метода;
- вызов клиентского метода;
- открытие формы.
Вызов обработок из справочника и так сильно затрудняет отладку в управляемом приложении, а ту еще и разные способы вызова.
Но если над всем этим подумать, то при открытии формы сначала на сервере вызывается обработчик события "ПриСозданииНаСервере. В нем можно вызвать любую серверную процедуру, и если форма не нужна, то "Отказ=Истина;" и все. Получаем тот же вызов серверного метода.
Затем при создании формы вызывается обработчик "ПриОткрытии", уже на клиенте. В нем можно вызвать клиентский метод формы, и если сама форма не нудна, то "Отказ=Истина;" и все. Получаем вызов клиентского метода.
Ну и наконец, если мы не отказываемся создать и открыть форму, то форма и откроется. Получаем вызов ДВОО способом "Открытие формы".
То есть я хочу сказать, что все ДВОО надо делать со способом вызова "Открытие формы".
Рассуждаем дальше. Открытие формы есть открытие формы. То есть, делается это в конфигурации БСП или просто через главное меню "Файл / Открыть", управление попадает в метод формы "ПриСозданииНаСервере". То есть такую обработку очень легко отлаживать. Запускаем через "Файл / Открыть" и отлаживаем. А потом подключаем в конфигурацию и она должна работать так же.
Рассуждаем дальше. БСП при вызове разных типов обработок (печатные формы, обработки заполнения объекта и т.д.) передает им дополнительные параметры. Эти параметры можно отобразить на открываемой форме, чтобы задавать их в режиме отладки. Тем более, что не трудно определить, открывается форма через "Файл / Открыть" или штатным для БСП способом через справочник "ДополнительныеОтчетыИОбработки" и скрывать эти реквизиты при штатной работе и показывать при отладке.
Следующая мысль. Обработки часто используются чисто в серверном контексте, когда создается объект обработки, заполняются его реквизиты и вызываются ее методы, которые выполняют какие-то действия. Та же схема может быть реализована при использовании метода «ОткрытьФорму»: создаем обработку, вызываем открытие формы, передавая в форму все нужные параметры, в форме в процедуре «ПриСозданииНаСервере» выполняем все нужные действия и «Отказ=Истина». То есть реквизиты у внешних отчетов и обработок использовать тоже не нужно. Все данные передаются и хранятся в параметрах и реквизитах формы. Зато это наверное ускорит выполнение метода «л_ОбработкаОбъект = РеквизитФормыВЗначение(«Объект»);». Этой командой мы фактически инициализируем модуль обработки, чтобы воспользоваться его процедурами и функциями. То есть обработка как бы является внешним общим модулем, которые мы загружаем из внешнего файла.
Правда для печатных форм есть дополнительные ограничения. «Правильная» печатная форма должна выводить сформированный документ в специальную форму БСП «Печать документов», в которой предусмотрен дополнительный сервис, например в виде возможность отправить документ по электронной почте непосредственно из этой формы. А форма эта может отобразить только такой табличный документ, который она получит путем вызова серверной экспортной процедуры с предопределенным именем «Печать», которая должна находиться в модуле обработки. Так что без этой процедуры нам не обойтись. Такое вот дополнительное условие для программиста.
Перейдем к практике.
2. Внешняя печатная форма.
Итак:
Во-первых, хочется, чтобы печатная форма в результате показывалась в специальной общей форме "ПечатьДокументов", предусмотренной в БСП для вывода печатных форм.
Во-вторых, хочется иметь возможность простой отладки.
В-третьих, иногда перед печатью формы хочется запросить у пользователя дополнительную информацию.
В этой части статьи остановимся на простой печатной форме, без запроса дополнительной информации.
Файл печатной формы — АЦРК_ДополнительнаяВнешняяПечатнаяФорма_ПечатьКомментария_х_х_ххх.epf
2.1 Модуль обработки.
Модуль обработки содержит процедуру СведенияОВнешнейОбработке с двумя служебными процедурой и функцией.
И кроме того, в модуле находится экспортная процедура Печать(п_МассивОбъектовНазначения, п_КоллекцияПечатныхФорм, п_ОбъектыПечати, п_ПараметрыВывода), которая должна сформировать табличные документы и поместить их в коллекцию печатных форм, а так же заполнить список значений «ОбъектыПечати» и связать их с областями сформированного табличного документа через имена областей. Это требование БСП.
Процедура вызывается из общей формы БСП «Печать документов».
Ну и далее могут быть процедуры и функции, которые вызываются из процедуры Печать.
2.2 Форма обработки
Параметры.
Определены 4 параметра, которые БСП передает в открываемую форму:
- ДополнительнаяОбработкаСсылка
- ИдентификаторКоманды
- ИмяФормы
- ОбъектыНазначения
У ОбъектыНазначения тип «Произвольный», а передается в него массив объектов назначения.
Реквизиты.
Четыре реквизита (рф_ДополнительнаяОбработкаСсылка, рф_ИдентификаторКоманды, рф_ИмяФормы, рф_СписокОбъектовНазначения) соответствуют параметрам, чтобы можно было параметры на форме отобразить, а в режиме отладки и заполнить.
Важно! Реквизит рф_СписокОбъектовНазначения имеет тип СписокЗначение и тип значения ЛюбаяСсылка, потому что может работать с любыми объектами базы.
Реквизит рф_ИмяЭтойОбработки предназначен для открытия других форм этой обработки командой ОткрытьФорму("ВнешняяОбработка."+рф_ИмяЭтойОбработки+".Форма...",...);
В данном простом примере эта возможность не используется.
Реквизит рф_РежимОтладки предназначен для хранения признака запуска обработки в режиме отладки. Режимом отладки будем считать запуск обработки через «Файл/Открыть» или установка признака отладки при подключении внешней обработки. Во втором случае режим отладки будет означать только то, что откроется форма обработки и покажет полученные параметры, отладку в конфигураторе такой режим не обеспечит.
Реквизит рф_ТаблицаКоманд предназначен для получения таблицы команд из сведений о внешней обработке. При желании его можно поместить на форму, чтобы посмотреть эти команды. А сам список команд из таблицы переносится в список значений для поля ввода для идентификатора команды (рф_ИдентификаторКоманды), так что все команды будут видны в списке выбора.
2.3 Модуль формы
Процедура ПриСозданииНаСервере.
Из параметров регистрации получаем таблицу команд.
Затем устанавливаем режим отладки и переносим значения из параметров в реквизиты формы.
При запуске через «Файл/Открыть» никакие параметры не передаются. Поэтому признаком запуска через «Файл/Открыть» выберем отсутствие параметра рф_ДополнительнаяОбработкаСсылка. Но при этом мы можем получить ссылку на нашу обработку в справочнике дополнительных отчеты и обработок, если мы ее туда помещали, хотя она нам и не нужна в режиме отладки. При первичной отладке мы проверяем правильное формирование табличных документов, котрые будут просто показаны в виде табличных документов, а не в форме «ПечатьДокументов».
Процедура ПриОткрытии.
В режиме отладки отрываем для редактирования список объектов назначения. Устанавливаем в качестве выполняемой команды первую команду из таблицы команд.
Если запуск производится в штатном режиме, то параметры редактировать не надо, только смотрим. И сразу имитируем выполнение переданной команды. Ну и поскольку в данном примере дополнительных запросов мы делать не будем, то форму открывать не надо, а значит Отказ = Истина;
Процедура ВыполнитьКоманду.
Преобразуем список объектов назначения в массив (при штатной работе через БСП в процедуру печати объекты назначения передаются именно в виде массива) и выполняем формирование печатных форм.
Процедура ПечатьМакетаMXL
В режиме отладки мы не обращаемся к БСП и ее форме ПечатьДокументов, потому что БСП будет вызывать нашу обработку через справочник ДополнительныеОтчетыИОбработки и мы не сможе отладить серверную процедуру Печать. Поэтому мы подготавливаем параметры и вызываем нашу процедуру Печать сами, чтобы можно было пройти ее отладчиком. А потом просто показываем сформированные табличные документы методом Показать.
А вот в штатном режиме мы вызываем стандартную форму БСП ПечатьДокументов так же, как это делается в БСП, предварительно подготовив нужные параметры. То есть при штатной работе БСП создает внешнюю обработку из справочника ДополнительныеОтчетыИОбработки, которая должна использовать вызов серверного метода, готовит параметры и вызывает форму ПечатьДокументов, которая уже вызывает метод Печать из модуля созданной обработки. Ну а мы вызовем форму Печать документов напрямую, передав ей ссылку на нашу обработку, обойдя проверку на использование вызова серверного метода. И получится, что наша обработка используется через ОткрытиеФормы, но печатная форма появится в форме ПечатьДокумента! Что вообще-то в БСП не предусмотрено.
Процедура рф_ИдентификаторКомандыПриИзменении
Обеспечивает изменение заголовка кнопки выполнения команды при выборе команды.
Функция ОтладкаФормированияПечатнойФормыНаСервере.
Процедура формирует парамеры для серверной процедуры Печать, как это делается при штатной работе через БСП, вызывает процедуру Печать и потом извлекает сформированные табличные документы из полученной коллекции печатных форм.
Попробуйте подключить к своей конфигурации — должна работать с любым объектом, для которого предусмотрено подключение внешних печатных форм и есть реквизит Комментарий. В том числе должно работать и для списка объектов.
3. Как из этого образца делать свою форму.
3.1 Модуль объекта
Сокращаем количество типов объектов, для которых форма будет работать, в процедуре СведенияОВнешнейОбработке.
Изменяем список команд.
Переделываем процедуру Печать и вызываемые процедуры и функции. Если форма создается на основе имеющейся в конфигурации, можно и нужно вызывать процедуры из менеджеров соответствующих объектов. Или перенести такие процедуры в модуль, если нужно внести в них изменения.
3.2 Форма
Ограничить тип значения реквизита рф_СписокОбъектовНазначения в соответствии с теми типами, которые перечислены в процедуре СведенияОВнешнейОбработке в модуле.
3.3 Модуль формы
Ничего менять не нужно.
3.4 Макеты
Добавляете свои макеты. Стандарт БСП предполагает, чтобы имена MXL-макетов начинались с “ПФ_MXL_”.
