Персональный блог Игоря Антонова aka "spider_net"

Правильная доработка типовых решений от 1С. Разбираем кейсы легкой поддержки


Рубрика: 1С:Предприятие -> Программирование -> Статьи
Метки: | | |
Просмотров: 1160
Правильная доработка типовых решений от 1С. Разбираем кейсы легкой поддержки

Компания 1С прочно закрепились в нише программ для автоматизации деятельности предприятий. «Бухгалтерия предприятия», «Управление торговлей», «Зарплата управление персоналом» и т.д. – стали визитными карточками компании и успешно применяются как в маленьких, так и больших предприятиях.

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

Почему так происходит? Проблема с профессионализмом сторонних разработчиков или несовершенство архитектуры решений типовых решений? На мой скромный взгляд, проблемы с обеих сторон: 1С не сильно попуализирует правильные подходы к доработке типовых решений, а многочисленные разработчики предпочитают работать по старинке, не тратя время на изучение новых возможностей и чтения «нудной» документации.

Проблема

Перед тем как начать говорить о решениях озвучим проблему. Типовые решения не могут выполнить все «хотелки» компании и единственный способ их реализовать – обратиться к сторонним/своим разработчикам. Если «хотелка» затрагивает типовые механизмы (объекты, формы, алгоритмы), то конфигурация становится непригодной для автоматического обновления.

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

Документирование, инструменты

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

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

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

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

Конфигурирование

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

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

Нужны примеры костылей? Пожалуйста! Заказчику всегда не хватает полей в стандартных документах/справочниках и он хочет добавить свои. Исполнить это желание проще без открытия конфигуратора. Активировать использование дополнительных (см. рисунок 1) реквизитов в настройках и потом быстренько создать все необходимые поля. Созданные таким образом реквизиты не затрагивают конфигурации и они пригодны для использования в отчетах, следовательно, практически ничем не уступают нативным.

Рисунок 1. Дополнительные реквизитов

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

Одну и ту же печатную форму можно сделать разными способами: воспользоваться механизмом, предоставляемым БСП (библиотека стандартных подсистем) или написать код напрямую в модуль формы/менеджера определенного объекта. Результат будет один и тот же – клиент получит желаемое, а вот поддержка решения усложнится.

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

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

Внешние печатные формы

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

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

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

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

Функция «СведенияОВнешнейОбработке» описывает структуру с базовой информацией по обработке. Перечисленные сведения необходимо для успешной регистрации в механизме внешних печатных форм. Непосредственная регистрация происходит через добавление элемента в справочник «Дополнительные отчеты и обработки» (см. рисунок 2).

Рисунок 2. Регистрация внешней обработки

Особое внимание стоит обратить на следующие свойства:

  • МассивНазначений. Содержит название объектов метаданных, для которых будет регистрировать печатная форма. Допускается несколько вариантов указания объектов: «Документ.ПриходныйКассовыйОрдер», «Документ.*». Последняя запись подразумевает все документы, доступные в системе.
  • Вид. Определяет вид внешней обработки. Обработки разных видов регистрируются по-разному. Для печатных форм указываем «ПечатнаяФорма», остальные доступные виды привел в комментариях.
  • Наименование. Название обработки в системе.
  • Идентификатор. Используется в нескольких местах, рекомендуется присваивать осмысленное имя. Чаще всего здесь указывает имя обработки, например: «РогаИКОпыта_ФормированиеМакетаКассовогоОрдера».
  • Модификатор. Если в качестве макета используется табличный документ, то указываем «ПечатьXML».

Процедура «Печать» выполняет служебную роль и вызывается встроенными механизмами системы. В большинстве случае ее содержимое остается неизменным за исключением параметров вызова «ВывестиТабличныйДокументВКоллекцию» (см. тело процедуры).

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

Следующая на очереди рассмотрения функция «СформироватьПечатнуюФорму». Может показаться, что именно в ней выполняется формирование печатной формы, но это только на первый взгляд. По факту это еще одна служебная функция, которая требует от разработчика:

  • Имя для сохранения параметров печати. Чаще пользуются шаблоном: «ПАРАМЕТРЫ_ПЕЧАТИ_ИмяПечатнойФормы».
  • Макет. В методе «ПолучитьМакет» требуется указать имя макета.

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

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

Обработки для заполнения

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

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

Начало процесса разработки обработки заполнения стандартное: создаем новую обработку и описываем в модуле служебную функцию – «СведенияОВнешнейОбработке» (см. листинг 1).

Листинг 1. Заготовка для обработки заполнения

ПараметрыРегистрации = ДополнительныеОтчетыИОбработки.СведенияОВнешнейОбработке("2.1.2.1");
ПараметрыРегистрации.Вид = ДополнительныеОтчетыИОбработкиКлиентСервер.ВидОбработкиЗаполнениеОбъекта();
ПараметрыРегистрации.Назначение.Добавить("Документ.КонтСтраховойПолис");
ПараметрыРегистрации.Наименование = НСтр("ru= 'Заполнение способов урегулирования убытков'");
ПараметрыРегистрации.БезопасныйРежим = Ложь;
ПараметрыРегистрации.Информация = "Демонстрирует механизм создания обработок заполнения";
ПараметрыРегистрации.Версия = "1.0.1";
	
НоваяКоманда = ПараметрыРегистрации.Команды.Добавить();
НоваяКоманда.Представление = НСтр("ru = 'Заполнить способами урегулирования убытков'");	
	
НоваяКоманда.Идентификатор = "ЗаполнитьСпособыУрегулированияУбытков";
НоваяКоманда.Использование = ДополнительныеОтчетыИОбработкиКлиентСервер.ТипКомандыОткрытиеФормы();
	
Возврат ПараметрыРегистрации;

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

Рассмотренной функции достаточно для создания каркаса обработки-заполнения. Дальше все зависит от решаемой задачи. Если требуется создать форму обработки и наладить связь с объектом заполнения, вам потребуется описать в форме несколько параметров:

  • ОбъектыНазначения (Произвольный) – массив ссылок на объекты заполнения.
  • Идентификатор (Строка) – идентификатор команды.
  • ДополнительнаяОбработкаСсылка (СправочникСсылка.ДополнительныеОтчетыИОбработки).

Для корректной работы требуется определить все перечисленные параметры. Работать в большинстве случаев придется с «ОбъктыНазначения». Если обработка заполнения ориентирована на работу с одним объектом для заполнения, то достаточно выполнить проверку на заполнение коллекции и в случае успеха выдернуть нулевой элемент.

Модернизация типовых форм

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

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

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

Новые расширения создаются в конфигураторе с помощью менеджера расширений («Конфиугурация» -> «Расширения конфигурации»). В окне менеджера отображаются все установленные расширения (см. рисунок 3) и интерфейс для создания новых.

Рисунок 3. Менеджер расширений конфигурации

Для создания нового расширения нажимаем кнопку «Добавить» и в появившемся окне заполним поля (рисунок 4):

  • Имя. Стандартные правила именования объектов метаданных 1С.
  • Синоним.
  • Префикс. Дополнительное значение, которое будет автоматически добавляться для всех созданных сущностей в расширении.

Рисунок 4. Создание нового расширения

Нажимаем “Ok” и перед вами отобразится дополнительное дерево конфигурации (рисунок 5).

Рисунок 5. Дерево конфигурации для расширения

Принцип работы с деревом конфигурации расширения мало чем отличается от работы со стандартным деревом конфигурации информационной базы. Отличие заключается в ограничениях (http://its.1c.ru/db/v839doc#bookmark:dev:TI000001513).

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

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

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

Попробуйте поместить в созданную заготовку любой объект метаданных. Свои эксперименты я провожу на конфигурации «Бухгалтерия некредитной финансовой организации КОРП», но все сказанное будет актуально для большинства решений, построенных на базе БСП.

Я расширил документ «КонтСтраховойПолис» (добавил табличную часть и новые реквизиты), а затем добавил основную форму документа в созданное расширение (контекстное меню «Добавить в расширение»).

Вместе с формой будут перенесены связанные реквизиты, а также ряд других объектов (рисунок 6).

Рисунок 6. Добавляем форму документа в расширение

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

Рисунок 7. Пишем код в модуле формы из расширения

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

Идеи для расширений

Не стоит думать о расширениях, как о своеобразных костылях для модификации объектов. Это полноценная система плагинов с большим потенциалом на развитие. Уже сегодня расширения позволяют создавать: подсистемы, общие модули, роли, общие формы, обработки, отчеты, HTTP-сервисы, WS-ссылки, XDTO-пакеты. Перечисленных объектов хватит для решения многих реальных задач.

Например, в нашей компании с помощью расширений удалось решить цикл задач, связанных с интеграцией CRM и корпоративным порталом. Механизмы обмена перенесены в расширения и для интеграции требуется несколько кликов мышкой. Все необходимые объекты метаданных поставляются в виде расширения (HTTP-сервисы, обработки и т.д.).

Аналогичным образом обстоят дела с интеграцией КИС и CMS. Стандартные механизмы обменов в виде громоздкого CommerceML – не самый удобный и быстрый способ выгружать номенклатуру на сайт. Расширения от разработчиков CMS могут запросто решить эту проблему и не создать пользователю типовых решений проблем с последующим обновлением.

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

На что еще способны расширения

О механизме расширений конфигурации можно говорить долго и написать отдельную статью. Технология постоянно развивается и пополняется новыми возможностями. Наиболее интересные новинки произошли с релизом платформы 8.3.9. Свет увидела первая концепция перехвата/подмена функций в модулях (расширение модулей).

Суть идеи: предоставить прикладному разработчику возможность менять логику работы модулей без непосредственного внесения изменений. Например, есть модуль «СуперМодуль» в типовой конфигурации, содержащий множество расчетных функций. Разработчику необходимо изменить логику работы нескольких функций из этого модуля и расширение модулей идеально подходит для этой задачи.

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

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

&Перед, &Вместо, &После. Например:
&Вместо ("РассчетСтраховойПремии")
Функция РассчетСтраховойПремииСДополнительнымиРисками(Параметр)
// Какой-то код
КонецФункции

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

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

Подписки на события

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

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

Программная доработка форм

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

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

Модификация ролей

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

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

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

Не ленитесь

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

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

Не ленитесь!

Статья опубликована в журнале "Системный администратор" (http://samag.ru/). Февраль 2017 г.

Оставьте комментарий!
comments powered by HyperComments