[ТАКСИ] Шаблон внешней обработки…и не только

 22.08.2014 — Изменены запросы динамического списка и заполнения остальных таблиц, теперь используется только справочник "Номенклатура", т.к. в УТ 11 структура справочников "Контрагенты" и "Договоры контрагентов" отличается от БП 3.0, на которой была написана обработка. Надеюсь уж номенклатура то в других конфигурациях на ТАКСИ… Пока писал, вспомнил ЗУП 3.0 :-). В общем не буду заморачиваться, для любой конфигурации поменять эти запросы несложно, не в них суть.
25.09.2014 — Добавлены новые примеры (чтение из макета или из файла mxl, заполнение таблица и подменю), регистрация обработки с проверкой версии. Изменен вывод программный вывод таблицы значений на форму. Изменения подробнее в файле описания описания.
28.09.2014 — Изменено изменение режима компактности, отключение предупреждений в ""Облегчить" старт программы", добавлено программное добавление дерева значений на форму.
06.10.2014 — Версия 1.5 (Платформа 8.3.5.1186 БП 3.0.36.15 ). Добавлены примеры: подключения через COM (OLE) К ИБ 7.7, 8.*; Чтение из тестового файла и файла XLS. Изменена команда ""Облегчить" старт программы" .
21.10.2014 — Версия 1.6 (Платформа 8.3.5.1186 БП 3.0.36.17 ). Отключение регламентных заданий вынесено в отдельную процедуру, добавлен пример условного оформление строк ("раскрашено" дерево), изменена процедура вызова встроенной формы.
02.12.2014 — Версия 1.7 (Платформа 8.3.5.1249 БП 3.0.37.27). Изменена универсальная процедура выбора из таблицы — при незаполненном значении колонки включается стандартный режим редактирования, если заполнено — то открывается ссылочный элемент,или показывает в предупреждении значение колонки.
18.02.2024 — Версия 1.9 (Платформа 8.3.5.1460 БП 3.0.37.43) Добавлены примеры чтения из TXT, XLS и DBF. Исправлено что то по мелочи.
Все подробности в модуле формы и в описании.
26.02.2024 — Версия 1.10 Настройки программы вынесены из меню «Ещё» в отдельную форму (использование отдельными пунктами — неудобно несколько раз вызывать перезапуск программы). Оставил версию 1.9 — там пример работы с кнопками с пометкой…

11.04.2024 — Версия 1.12 Добавлено сохранение табличного документа в файлы разных форматов

22.05.2024 — Версия 1.16 Что-то добавлено, что-то исправлено… Точно исправлено подключение по OLE к 7.7)))

22.05.2014 — Версия 1.17 Изменена регистрация из обработки — разделы для регистрации берутся из сведение о обработке.

24.11.2024 — Версия 1.21 — что-то добавил, что-то поправил….

16.04.2024 — По просьбам трудящихся (немногочисленным, правда) оставил последнюю версию 1.21, дабы не было путаницы… 

17.04.2024 — Версия 1.22 Вернул пример сохранения табличного документа в разных форматах и чтения DBF из версии 1.16 (как потерялось — сам не понял)

 

Шаблон внешней обработки

1. С чего всё начиналось

Обработка предназначена в первую очередь для лентяев, к каковым отношу и себя. Сама идея сотворить эту обработку пришла, когда стал собирать очередную загрузку файла из сторонней программы в БП 3.0. Вроде всё уже было написано неоднократно, но, в очередной раз начал таскать из разных мест куски кода, т.к. писать с нуля было лениво – ведь помню точно, уже было.

Сентябрь на дворе — клиенты не достают, решил- напишу себе шпаргалку в виде шаблона, чтобы просто удалять ненужное, и не ваять с нуля каждый раз одно и то же.

2. Тех. подробности

Обработка сделана на Такси, платформа 8.3.5.1119, писал на демо БП 3.0 (релиз 3.0.35.28).

Продолжение разработки — платформа 8.3.5.1146, БП 3.0 (релиз 3.0.36.11).

Для примера заполнения всех таблиц используются запросы к справочникам «Контрагенты» и «Договоры контрагентов», входящие практически в любые «типовые» конфигурации, выборка ограничена 20-ю записями, для «посмотреть» этого вполне достаточно, опять же — жалко времени на «подождать» выполнения запроса к большому числу записей.

3. Цели и задачи

Не ставил цели создать что-то оригинальное – всё, что здесь есть, валяется на просторах инета, синтаксис помощнике и методической поддержке. Где смог, оставил ссылки на источник кода, если был простой копипаст (так же буду поступать и дальше).  Это первый вариант шаблона, думаю развивать его дальше, если появятся идеи, что туда можно будет добавить. Буду рад любым предложениям, замечаниям.

Что-то подобное уже есть, для Такси не видел, да особо не искал, вдруг кому — то пригодится.

4. Что тут есть

Включил в шаблон:

4.1. Ряд мелких сервисных функций, вовсе необязательных для всех случаев жизни (вызываются из меню «Ещё» (не в Такси —  «Все действия»)):

 

• Изменить режим вывода форм … — Пункт меню, где в заголовке показан текущий режим, при выборе устанавливается следующий «по порядку». Порядок такой – «Авто», «Компактный» (установлен на картинке), и «Обычный». Для вступления изменений в силу необходим перезапуск программы, о чём обработка «попросит», после выбора. Компактный режим хорош для мелких мониторов, хотя я его использую и на своём, далеко не мелком – просто больше информации на экран помещается;
• Включить стандартный интерфейс – Все конечно в курсе, как переключить программу в интерфейс Такси, эта кнопка устанавливает Такси в стандартном варианте, бывает трудно объяснить пользователю как это сделать по телефону. Когда разговор «глухого со слепым»  заходит в тупик (клиент рассказывает, что видит на экране, Вы не можете понять, он в тетрис играет, или про БП спрашивает), я предлагаю ему запустить мою обработку, которой он точно пользуется и знает, как её открыть, и прошу включить стандартный интерфейс. После перезапуска программы, уже можно как то, без удалёнки, объяснить пользователю куда ему надо жмать, т.к. в этом случаю уже известно, какой экран он видит перед собой;

Маленькое отступление: Сейчас, в той же БП3.0 развелось столько различных вариантов работы, что уже не знаешь, как консультировать по телефону – заливаешься соловьём, рассказывая, что сделать, и тут ведро воды на голову, у меня этого нету!!! Поэтому, с недавнего времени, в свои обработки включаю эту возможность — привести интерфейс к известному виду, без долгих разговоров с пользователем, где найти «Главное меню»… Ну лентяй короче, впрочем про это уже говорил…

• «Облегчить» старт программы – Эту функцию давно хотелось реализовать, наконец сподобился, включив её в этот шаблон. Все прекрасно знают, что при старте программы начинаются  всякие проверки наличия обновлений, вывод рекламы и т.д. Есть множество обработок, отключающих то одно, то другое, наиболее полный вариант нашел у Алексея Карманова Copyright © helpme1c.ru 2014. Что – то оставил оттуда, что – то переделал, получилась такая штука: при выборе этой функции отключается всё, что мне показалось ненужным для нормальной работы программы. Хотел «огласить весь список», но, посмотрев в модуль понял, проще увидеть это там, может кем-то этот список будет урезан, или наоборот расширен. Замечу про регламентные и фоновые задания, тут не тупо отключается всё подряд, а всё ж таки проверяются согласно настройкам программы, и, например, если включен валютный учет, загрузка курсов валют отключена не будет. Информация из обработки «Предупреждение об изменениях» отключаются по именам макетов – всё что есть в макетах, будет отключено (до версии 1.4 каждое предупреждение было прописано отдельными строками – отключалось не всё, особенно стало заметно после двух обновлений БП).

  В версии 1.6 регламентные задания отключаются по списку, который задается в модуле, отключение вынесено в отдельную процедуру. Список создаем по ветке конфигурации «Регламентные задания» (если надо отключить все, то можно список не заполнять, а просто в процедуре:

Маленькое отступление: Сам был удивлен, когда только после отключений ненужных регламентных фоновых заданий, через пару дней получил «отклик» от бухгалтера «- Знаешь, после того, что ты там что – то сделал, программа стала работать намного быстрее». Всегда отключал этот регламент вручную (особенно мне ПДД нравится, аж два штуки, практически никто не использует, а тормозит работу очень даже успешно). Беда в том, что после обновлений или ещё каких событий, ну реально то «никто ничего делал», эти галки всяческие имеют тенденцию появляться сами собой, и не всегда вспоминаешь, что их надо убрать, а когда вспоминаешь, то каждый раз думаешь (ну не каждый день туда лазить доводится), что убрать, а что оставить. Теперь стало проще жить – нажал, перезапустил и можно спать спокойно (настройки записываются на 100 вперед, ну … или до следующего обновления, потом опять надо будет нажимать)…

Все эти три функции предлагают перезапустить программу (заодно в коде можно подсмотреть, как в Такси диалог прописывается). Перезапускать три раза необходимости, в общем-то нет – можно сначала «натыкать» нужный режим компактности, потом нажать (или не нажимать, если всё настроено как надо) стандартный режим, ну и в конце отключить всё, что не нужно нажав на «Облегчить» старт программы (название конечно не совсем верное – отключается всякая зараза, которая не только при старте срабатывает, например те же «Быстрые освоения …» и иже с ними,  как минимум, обработчики ожидания этих событий работать не будут).

4.2 Выбор периода. Отдельная песня – с появление управляемого приложения всегда старался действовать в духе требований к экзаменам – использовал стандартные диалоги и процедуры/функции БСП. После того, как раз пять – десять они переставали работать, после очередных обновлений, решил – оно мне надо? Теперь использую встроенную в обработку форму выбора периода, наиболее полный вариант которой, включил в шаблон. Эта форма позволяет выбрать как любой стандартный период, так и произвольный. Произвольный период, может быть и перебор, выведя на форму поля начала и окончания периода, можно и так его ввести, а для быстрого выбора месяца и т.д. использовать кнопку вызова формы выбора, но решил вставить в эту форму и выбор произвольного периода, т.к. всегда есть вероятность того, что забудется проверить правильность конца периода, по отношению к его началу, а тут уже сделано. Ещё, ИМХО, надпись с выбранным периодом на форме более «читабельна», чем два поля с датами, а места (которого так часто не хватает) занимает меньше.

Убрать с этой формы ненужные элементы, например, для обработок, которые должны отрабатывать только помесячно очень просто (и недолго по времени). Достаточно просто снять галку «Видимость», с ненужных элементов форм:

 

Больше ничего менять в принципе не нужно – форма будет работать нормально в «усеченном» варианте. Опять же, тут не используются общие модули конфигурации и БСП, ради чего, собственно, всё и затевалось.

4.3 Первый раз, когда в Такси понадобилось выбрать файл, был неприятно удивлен, как всё стало запущено. Поэтому решил включить выбор имени файла в шаблон. Сложного ничего нет, но помнить это наизусть – увольте. Поэтому включил, не нужно – удалить недолго, нужно – искать/вспоминать процесс гораздо более длительный.

4.4 Страницы шаблона – это несколько вариантов возможных «надобностей» внешней (да и, в принципе, не только внешней) обработки. По порядку:

• Динамический список – Включил один из вариантов заполнения табличной части формы – с помощью динамического списка. В примере он заполняется запросом:

 

Картинку привожу для новичков, помню, как искал, где сидит запрос в первый раз, когда столкнулся с таким вариантом 

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

Ссылка на элемент или группу справочника в поле ввода на форме Контрагент используется для передачи в одноименный параметр запроса динамического списка, если поле не заполнено, условие из текста запроса удаляется (это же утверждение справедливо и для других списков шаблона).

• Табличный документ – Простой пример, как вывести на форму табличный документ. По факту – так же выводятся отчеты (про СКД сейчас не будем – это тема отдельного разбирательства), хотя табличный документ может использоваться не только как банальный отчет, но и как средство вывода в одно поле на форме разных по содержанию таблиц, без необходимости программно менять элементы формы (пример программного изменения элементов формы в шаблоне то же есть – см. Таблица значений). Вывел с группировками по уровням, т.к. вечно забываю при выводе строки (ТабДок.Вывести(ОбластьСтрока, 2)) указать этот самый уровень при включенной авто группировке строк.

• Таблица значений – Пример вывода на форму произвольной таблицы. Состав колонок определяется в запросе, сама таблица выводится на форму программно. Есть одна тонкость – при автоматическом создании колонок таблицы значений (псевдонимов полей в запросе), нужно обратить внимание на уникальность названий полей «в пределах элементов форм». Поясню, если колонка таблицы значений результата запроса будет называться так же, как любой другой элемент на форме – получим ошибку «Недопустимое имя реквизита», причём ошибка явно не укажет, какого именно. Словить получится только в отладчике, пошагово, или остановкой по ошибке. Избежать такой беды в принципе просто – к названию полей таблицы значений, при формировании колонок на форме можно добавлять любой префикс (например, «Мой_» +). Но мы не ищем «лёгких путей», в данной обработке используется одна процедура открытия колонки любого списка (кроме табличного документа, естественно, там работают расшифровки макета) — «ВыборИзТаблицы». В этой процедуре «унифицировано» получение имени поля, и колонки с префиксами требовали отдельной обработки, что почему – то делать «не захотелось». Не нравится , как сейчас реализовано повторное заполнение таблицы значений, надо как — то по — другому. Проверка наличия таблицы формы через попытку некрасиво, надо переделать.

Маленькое отступление: Обработку выбора в табличных частях формы (Событие «Выбор») можно не делать в принципе – есть «штатные» механизмы, позволяющий управлять поведением колонки таблицы на форме установкой соответствующих настроек, например, запретить редактирование полей с типом число или дата, повесить кнопку открытия на поля ссылочного типа и убрать для них кнопку выбора, если пользователь не должен менять эти поля. Но делать это каждый раз для каждой колонки табличной части формы крайне утомительно, а в режиме учета ещё и неудобно пользоваться – чтобы открыть форму элемента ссылочного типа пользователю придётся сначала двойным кликом (нажатием Enter) войти в редактирование поля, потом нажать на появившуюся кнопку открытия, и только тогда получить искомую форму. Исходя из этого, уже давно «вешаю» обработчик на событие «Выбор» табличной части, и там уже разбираюсь с обработкой действий пользователя, главный результат – то, что нужно таким способом получается просто двойным щелчком левой кнопки мыши. Плохо было одно, по накатанному, для каждой табличной части формы вешал отдельный обработчик, хотя текст внутри каждого был до боли схожим, но времени на «унификацию» как всегда не хватало, наконец то сделал в этом шаблоне, посмотрим, как пойдет дальше. Предполагается, что этот код «подойдет» для любой табличной части на форме, где необходим просмотр значений колонок, а данные в этих колонка изменяться не должны.

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

• В версии 1.6 добавлено условное оформление строк (процедура «НастроитьУсловноеОформление» с параметром «ИмяТаблицы»). Для работы условного оформления в таблице должны заполнена быть колонка «Состояние» с типом «Строка» длиной 1. Значениями состояния определяется цвет фона строки:

  • 0 – Светло Зеленый
  • 1 – Светло Желтый Золотистый
  • 2 – Светло Коралловый
  • 3 – Красный.

• Помощник (пошаговое выполнение) – Пример реализации схемы помощника выполнения обработки. Используется в случаях, когда на одном экране не помещается много различных элементов (полей ввода, таблиц кнопок и т.п.), да и ещё ситуация «усугубляется» необходимостью «заставить» пользователя выполнить некоторые действия в строго определённой последовательности.

 

Декорации «Этап №…» показывают текущий этап выполнения, причем цвет рамки декорации предлагается использовать для выделения текущего этапа, а цветом текста и фона можно «играть», с целью указания пользователю на результата выполнения конкретного шага: например на каком то шаге помощника необходимо провести документы по полученному каким – либо образом списку. Можно после проведения документов, если провелось всё, «покрасить» декорацию в зеленый цвет, если не всё – сделать ядовито — красным, или вообще поставить цвет фона в зависимость от процента успешно проведенных документов. Простор для творческой мысли есть, реализовать можно в процедуре «УстановитьЦвет». Тут представлен самый что ни на есть «убогий» вариант – активный (текущий) этап – фон цвета фона формы, цвет рамки и текста зеленый, неактивные красный фон без рамки.

5. Дополнительные подробности

Есть ещё ряд моментов, заслуживающих внимания.

5.1 Для облегчения дальнейшей разработки «своих» внешних обработок по данному шаблону, текст модуля формы обработки структурирован по областям:

 

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

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

5.2 В обработку встроена возможность регистрации в справочнике «Дополнительные отчеты и обработки», если БСП конфигурации, для которой разрабатывается внешняя обработка по этому шаблону, содержит такой справочник.

Необходимость регистрации проверяется при запуске обработки (событие формы «ПриСозданииНаСервере»). Проверяется наличие ссылки в справочнике, а так же соответствие версии обработки в функции модуля обработки «СведенияОВнешнейОбработке» и ссылки справочника (при её наличии). Проверка актуальна конечно только в случае запуска через Файл – Открыть. Если обработка не была зарегистрирована ранее, или версии не совпадают, на форме становится видимой кнопка «Регистрация», а в заголовке формы выведется соответствующая информация:

• (Не зарегистрировано в ИБ) – если ссылки в справочнике нет;
• (Зарегистрирована v ) – в случае различных версий в обработке и в ИБ.

По умолчанию обработка регистрируется доступной для всех пользователей ИБ в разделе «Администрирование». Изменить можно в модуле обработки в процедуре «Зарегистрировать».

5.3 Функция «СведенияОВнешнейОбработке» модуля обработки подлежит обязательному редактированию – там нужно указать отмеченные "<<>>" строки на нужные по смыслу для создаваемой обработки. Информация, указанная в этих сведениях используется в заголовке основной формы обработки (см. картинки выше). Вообще сам заголовок формы состоит из представления обработки в таблице команд сведений для регистрации, версии из параметров (дополнительно может выводиться информация о необходимости регистрации, как уже говорилось чуть выше).

5.4 Имя внешней обработки «ВнешняяОбработка» (простите за невольную тавтологию) менять не рекомендуется, но, если очень хочется, меняйте, только не забудьте поправить вызов формы выбора периода. С версии 1.6 менять можно – вызов формы выбора периода переделан – имя обработки получается из функции, и теперь некритично для вызова (спасибо Гусеву Николаю, http://forum.infostart.ru/user/18469/).

5.5 Не забудьте так же в декорации «СведенияОРазработчике» занести сведения о себе, любимом, ибо мир должен знать своих героев!!!

5.6 В обработчике «АдресПубликацииНаИС» укажите адрес публикации, или свой профиль…

 

6. Страница «Разное»

Новая страница для добавления новых примеров:

 

6.1 Блок получение данных из шаблона – пример использования шаблона для получения таблицы значений или списка значений из шаблона обработки или внешнего шаблона. Использую, например, для настройки заполнения подменю. При заполнении из внешнего файла в поле имя файла надо выбрать файл с таблицей mxl:

 

 

 

Версия 1.5 (Платформа 8.3.5.1186 БП 3.0.36.15 )

Добавлено всяко — разно в закладке «Разное»:

 

6.2 Добавлен пример подключения к разным ИБ (7.7, 8.*):

 

Выбор файла (поле «Каталог ИБ») в этом примере, в отличии от поля «Имя файла», работает по «старой схеме», через ДиалогВыбораФайла.Выбрать(), на модальность не ругается.

Кнопка «Зарегистрировать  comcntr.dll» нужна для регистрации DLL, Если при попытке подключения ОС выдает: Ошибка “Недопустимая строка с указанием класса”. Команда отработает только с случае, если программа будет запущена от имени администратора ОС, иначе получим ошибку с кодом 0x80070005 (может сопровождается сообщением "ОТКАЗАНО В ДОСТУПЕ"). В принципе, наверное, это лишнее, зарегистрировать comcntr.dll легко и просто, выполнив с правами и от имени администратора:

 regsvr32 “<<Program Files>>1cv88.3.5.1186incomcntr.dll”

где <<Program Files>> — путь к папке с платформой.

В получении данных добавлена кнопка «Очистить», для удаления созданных подменю и таблиц.

6.3 Чтение из текстового файла.

Для проверки можно создать текстовый файл, например, с таким содержимым:

Заполняем; Реквизиты; Колонок; Это; Строка; Один

Строка два; колонки; могут; быть; пустыми

;;;;Например так

;;или так;;;

Если поле «Разделитель» не заполнено результат чтения будет таким:

 

Если ввести в поле «Разделитель» символ «;» — получим таблицу значений:

 

Версия 1.9

6.4 Добавлен пример чтения файла XLS. Данные выводятся в таблицу значений, чтение начинается со строки, указанной в поле «Начальная строка XLS». Если там 0 – выводится с первой строки.

6.5 Добавлен пример чтения файла DBF. Данные выводятся в таблицу значений. Когда писал загрузку из DBF для розницы аптека выяснил один момент, может я и не прав, но прочитать файл с именем не в формате 8 + 3 не получилось, поэтому сделал «ход конём» — файл DBF сначала копируется во временный файл, и уже он без проблем читаем. Колонки таблицы значений формируются по названиям полей в, были случаи, когда имена колонок совпадали, для совпадающий подставляется префикс «_» (если совпадающих имён в DBF будет больше двух – вылетит по ошибке).

 

Прочие изменения

Версия 1.10

Настройки программы вынесены из меню «Ещё» в отдельную форму (использование отдельными пунктами — неудобно несколько раз  вызывать перезапуск программы):

 

Теперь в отдельном окне (вызывается кнопкой «Открыть настройки») можно сразу сделать необходимые установки, при нажатии на «Записать настройки» будут внесены выбранные изменения и задан вопрос о перезапуске. Если установить флаг «Установить стандартный интерфейс», то установка режима компактности значения не имеет – установится в «Авто», о чём будет выдано предупреждение.

Для БП 3.0 сделал отдельную обработку //infostart.ru/public/333876/, там кроме вышеописанных настроек можно более настроить отключение регламента, информации для форм и задач бухгалетра. Шаблон, он таки для программиста, а обработку отключения даю пользователям, что бы после каждого обновления могли сами убрать ненужные им функции…

 

Версия 1.12

Понадобилось сохранение в файл табличного документа из своей формы, оказалось типовой механизм в БП 3.0 позволяет сохранять печатные формы, но не любой табличный документы с формы. Ничего трудного нет сделать это через «Файл» – «Сохранить как…», но, есть две закавыки:

1. Сохранить сразу в несколько разных форматов файлов не получится;

2. Не все пользователи приветствуют такие сложности, им хочется попроще и побыстрее (мне, иногда то же).

В результате добавил в копилку форму для сохранения (урезанная общая форма БП 3.0 «СохранениеПечатнойФормы»).  При вызове формы сохранения можно задать любые правила формирования имени файла. Папку для сохранения и форматы выбираем в окне «Сохранение печатной формы».

Кусок кода для вставки в «свою» обработку (отчет):

 

Посмотреть, как работает можно на закладке «Табличный документ», порядок действий на картинке:

 

Нажатие на «Сохранить» в случае успешного сохранения получим:

 

 

Жду замечаний, предложений, пожеланй и т.п от всех попробовавших.