Событие в 1с как выглядит карточка
Есть в системе 1С:Документооборот механизм бизнес-событий. Когда мне понадобилось решить конкретную задачу, гугление ни к чему конкретному не привело. Хотелось так «вжух» и всё понять про данный механизм, но в итоге пришлось лезть в код 1С и смотреть реализацию данного механизма. В данной публикации поделюсь результатами исследований, может, кому-то это поможет быстро и легко во всём разобраться.
На днях попросили меня сделать одну на первый взгляд простую и полезную настройку в 1С:Документооборот: если новый входящий документ пришёл в ответ на исходящий, то автора исходящего необходимо оповестить о новом документе не дожидаясь резолюции руководства.
Вроде всё просто: отлавливаем создание вида связи «В ответ на» и запускаем бизнес-процесс «Ознакомление» с нужными параметрами. Но, зайдя в справочник «Виды бизнес-событий» ничего похожего на создание связи не обнаруживаем. Нам подходит только бизнес событие «Изменение входящего документа», в котором мы уже ручками будем отслеживать создание связи и запускать бизнес процесс.
Как механизм бизнес-событий работает в 1С:Документооборот? Рассмотрим на примере «Изменения входящего документа»:
Вот такой несложный механизм.
Получается, что нам нужно всю логику разместить в дополнительном обработчике бизнес события для вида бизнес события «Изменение входящего документа» и «Создание входящего документа» т. к. при создании входящего документа на основании исходящего предварительной записи карточки документа перед созданием связи не производится.
Первым делом получим ссылку на нужный тип связи (1).
Дальше проверим установлена ли эта связь у данного документа (2).
А дальше нам необходимо установить, что данная связь является новой, чтобы не генерировать оповещения каждый раз при сохранении карточки документа.
Алгоритм, который я предлагаю не самый точный, но рабочий. Мы проверяем не было ли по новому документу когда-либо сформировано бизнес-процессов «Ознакомление» (3). Этот подход будет верным если при создании входящих документов автоматически не стартуют иные процессы «Ознакомление».
Ну и наконец создаём новый бизнес-процесс «Ознакомление», прикрепляем в качестве основного предмета новый документ и стартуем его выбрав в качестве исполнителя автора документа.
Система позволяет расширить практически любой программный модуль, относящийся к управляемому приложению. Невозможно расширять глобальные серверные модули. Также следует помнить, что расширение привилегированного общего модуля будет выполняться в непривилегированном режиме (если иное не разрешено профилем безопасности). Кроме того, предоставляется возможность создавать собственные общие модули, которые не могут быть привилегированными и глобальными серверными. Работа с собственным общим модулем в расширении ничем не отличается от работы с общим модулем обычной конфигурации.
Работа с расширенным программным модулем имеет существенные особенности, которые будут рассмотрены в данном разделе.
При разработке расширяющего модуля следует учитывать, что этот модуль будет находиться в одном пространстве имен с расширяемым модулем. В связи с этим, из расширяющего модуля имеется возможность использовать расширяемый контекст (переменные и методы) напрямую. Также следует помнить, что созданные в расширении экспортные методы и переменные автоматически попадают в публичный контекст расширяемого модуля.
В расширяющем модуле имеется возможность:
- Создавать собственные методы и переменные (если это допускает расширяемый модуль).
- Назначать собственные обработчики на события, которые не обрабатываются в расширяемой конфигурации.
- Перехватывать любой метод расширяемого модуля (в том числе и методы обработчиков событий), при этом имеется возможность:
- полностью заменить оригинальный метод собственным;
- создать методы, которые будут вызваны перед или после расширяемого метода.
Создание собственного метода или переменной в расширяющем модуле ничем не отличается от создания метода или переменной в расширяемой конфигурации, при работе без расширений. Однако при создании собственных методов или переменных рекомендуется предварять их имена префиксом, который позволит однозначно идентифицировать принадлежность метода или переменной тому или иному расширению, а также избежать конфликта имен с расширяемой конфигурацией.
Перехват методов расширяемой конфигурации (включая назначение обработчиков) реализуется с помощью специального механизма аннотаций (см. здесь). Всего имеется три различных возможности перехвата вызова метода, которые позволяет реализовать практически любую схему исполнения расширяемого и расширяющего программного кода.
В общем случае, аннотированный метод из программного модуля расширения выглядит следующим образом:
В данном примере Перед одна из трех возможных аннотаций, ИмяМетода имя расширяемого метода, Префикс_Имя имя расширяющего метода. Префикс_ это префикс расширения, который желательно указывать для всех методов расширения. Расширяться может как процедура, так и функция. Имя расширяющего метода должно подчиняться обычным правилам формирования имен процедур и функций. В частности, оно должно быть уникально.
Если расширяемый метод содержит какие-либо параметры, то:
- Все расширяющие методы обязаны иметь в точности такое же описание, как и расширяемый метод, с точностью до ключевых слов Знач в описаниях параметров методов.
- Значения параметров разделяются между всеми расширяющими методами из всех расширений и собственно расширяемым методом. Это значит, что если какой-либо расширяющий метод изменит значение параметра, все методы, которые получат управление после этого метода, получат измененное значение этого параметра.
- В расширяющем методе не имеет смысла указывать значения по умолчанию для параметров расширяемого метода. Значения по умолчанию будут определяться из описания расширяемого метода.
Также следует отметить, что если расширяется обработчик события, то расширяющий метод выполниться до того, как сработают подписки на «расширяемое» событие (см. здесь).
Исполнение до расширяемого метода (аннотация Перед)
Если метод аннотирован таким образом, это означает, что вначале будет выполнен метод расширения, а затем расширяемый метод.
Рис. 688. Схема исполнения «Перед»
Исполнение после расширяемого метода (аннотация После)
Если метод аннотирован таким образом, это означает, что вначале будет выполнен расширяемый метод, а затем метод расширения.
Рис. 689. Схема исполнения «После»
Обрамление расширяемого метода (аннотации Перед и После)
Если в расширяющем модуле созданы расширяющие методы, которые отмечены аннотациями Перед и После , то это означает, что вначале будет вызван метод, который отмечен аннотацией Перед , затем расширяемый метод и зачем метод расширения, отмеченный аннотацией После .
Рис. 690. Схема исполнения «Перед» и «После»
Замена метода (аннотация Вместо)
Под перехватом вызова метода понимается ситуация, когда метод, созданный в расширении, полностью замещает собой расширяемый метод. Другими словами, вызов метода расширяемой конфигурации приведет к исполнению метода расширения. Имя замещаемого метода указывается в качестве параметра аннотации. Рекомендуется использовать данный способ только в том случае, когда нет возможности использовать другие способы расширения методов.
Для расширяемых функций возможно применение только этого способа расширения.
Рис. 691. Схема исполнения «Вместо»
Чтобы иметь возможность модифицировать результат работы расширяемого метода, предусмотрен метод глобального контекста ПродолжитьВызов(). В качестве параметров метода должны быть указаны фактические параметры, которые переданы в расширяющий метод.
Рис. 692. Схема исполнения «Вместо» совместно с ПродолжитьВызов()
В исходном тексте пример будет выглядеть следующим образом:
В общем случае, редактирование программного модуля в расширении мало отличается от редактирования модуля в расширяемой конфигурации или модуля в конфигурации, где вообще нет расширений (подробнее о редактировании модулей см. здесь). В качестве основных отличий можно указать процесс заимствования метода из какого-либо программного модуля расширяемой конфигурации.
Для того чтобы добавить какой-либо метод в расширение, необходимо поместить курсор в требуемый метод (включая строку с именем метода) и выбрать команду Добавить в расширение . Если при выполнении данной команды в конфигураторе открыто одно расширение, то именно это расширение будет использовано. Во всех остальных случаях будет предложен выбор из расширений, которые добавлены для данной информационной базы.
При выполнении команды Добавить в расширение происходит следующее:
- Если объект, из модуля которого добавляется метод, отсутствует в выбранном расширении этот объект автоматически добавляется в расширение.
- Если расширяется метод из модуля, отличного от модуля формы:
- Разработчику предлагается выбрать аннотацию для метода ( Перед , После или Вместо ). При этом полужирным шрифтом выделяются те расширения метода, которые уже существуют в расширении.
- Если выбран существующий метод в расширении, то выполняется переход к этому методу. При этом возможна корректировка объявления метода, если оно стало отличаться от расширяемого метода.
- Если выбран несуществующий способ расширения, то будет создан новый метод в расширении, который будет предваряться соответствующей аннотацией.
- Для функций недоступны аннотации Перед и После
- Для процедуры недоступно:
- Аннотация Вместо , если уже существуют методы с аннотациями Перед или После
- Аннотация Перед / После , если уже существует метод с аннотацией Вместо
Следует учитывать, что если расширяемый метод обрамлен инструкциями препроцессора, то эти инструкции не будут перенесены в расширение.
При проверке соответствия описания расширяемого метода и метода расширения проверяются следующие характеристики методов:
- Количество параметров и признак передачи параметров «по значению» (ключевое слово Знач ).
- Метод является процедурой или функцией. Если определение метода изменяется с процедуры на функцию, а до этого процедура была расширена с применением аннотаций Перед / После , то аннотация будет заменена на аннотацию Вместо
- Если в модуле расширения присутствуют несколько методов с одинаковым именем, но которые обрамлены разными инструкциями препроцессора, то в расширении будет обновляться всегда первый из перечня таких методов.
Еще одной особенностью редактирования программного модуля в расширении является то, что имеется возможность перехода к расширяемому методу непосредственно из расширения. Для этого следует поместить курсор на имя расширяемого метода в аннотации, а затем воспользоваться стандартной командой редактора Перейти к определению
При разработке расширений следует исходить из следующих предположений:
Далее будут рассмотрены несколько примеров работы результирующей конфигурации при различных способах расширения.
Если оба расширения одинаково обрамляют (аннотации Перед и После ) расширяемый метод, то исполнение схема исполнения встроенного языка будет выглядеть следующим образом:
Рис. 693. Схема взаимодействия. Пример 1
При попытке вызвать метод Расширяемая() (в основной конфигурации), встроенный язык будет исполняться в следующем порядке:
- Будет вызван метод, отмеченный аннотацией Перед("Расширяемая") из Расширения2
- Затем будет вызван метод, отмеченный аннотацией Перед("Расширяемая") из Расширения1
- Затем будет вызван метод Расширяемая() из расширяемой конфигурации.
- Затем, в обратном порядке (относительно списка расширений, т. е. Расширение1 и Расширение2 ), будут вызваны методы, отмеченные аннотациями После("Расширяемая")
Т.е. вначале вызываются те методы расширений, которые разработчик отметил как вызываемые до исполнения расширяемого метода, затем исполняется собственно расширяемый метод, а затем вызываются те методы, которые разработчик отметил как вызываемые после исполнения расширяемого метода.
Если в каждом расширении расширяемый метод перехватывается полностью, то схема выполнения будет выглядеть следующим образом:
Рис. 694. Схема взаимодействия. Пример 2
Так произошло потом, что метод, отмеченный аннотацией Вместо , полностью заменяет собой расширяемый метод. Следует особо отметить, что если в этом примере поменять порядок регистрации расширений (первым будет Расширение2 , а последним Расширение1 ), то единственным выполнившимся методом будет метод из Расширения1
В связи с таким поведением «замещающего» метода расширения, рекомендуется не допускать ситуаций, когда какой-то метод расширяемой конфигурации расширяется с замещением (аннотация Вместо) более чем в одном одновременно работающим расширении. Другими словами, если в расширении, в модуле документа Документ1 замещается обработчик события ОбработкаПроведения , то рекомендуется не допускать ситуации, когда в информационной базе работает еще хотя бы одно расширение, которое каким-либо образом перехватывает обработчик события ОбработкаПроведения в документе Документ1 . Однако, если в «замещающем» методе расширения есть безусловный вызов метода ПродолжитьВызов() , то одновременное существование нескольких расширений с таким способом расширения вполне допустимо.
Факт того, что расширение успешно подключено к расширяемой конфигурации, не означает, что все расширяющие методы, которые находятся в расширении, будут выполняться. Работоспособность методов расширения может быть изменена настройками профиля безопасности (подробнее см. здесь), который использует информационная база.
Если прикладное решение работает в файловом варианте или в клиент-серверном варианте без профилей безопасности, то при подключении расширения:
- В обычном режиме исполнения встроенного языка допустимо расширять как клиентские, так и серверные методы. Без ограничения места расположения методов.
- В безопасном режиме исполнения встроенного языка будут расширяться только клиентские методы и серверные обработчики форм, которые установлены через панель свойств. К остальным серверным методам (аннотированные серверные методы модулей формы и серверные общие модули) расширение применяться не будет.
Возможность расширения серверных общих модулей в клиент-серверном варианте регулируется профилем безопасности. Подробное описание см. здесь.
ps: оригинальные изображения взяты из источников
upd(ответ на комментарии Cyberhawk и Yashazz):
"Отказ=Истина", выставленный в одной подписке, не мешает срабатывать другой (т.е. процесс не прерывается)
утверждение верно для ОДНОГО события (в случае наличия нескольких подписок на одно и то же событие). Например, если есть 3 подписки на событие ПриЗаписи документа ПКО, то Отказ=Истина выставленный в одной из них не помешает срабатыванию других двух.
Отказ для каждого события проверяется в двух местах
1. После выполнения обработчика в модуле объекта/менеджера, включая все расширения.
2. После обработки всех подписок, включая все их расширения.
Т.е. если в п.1 выставили Отказ, то п.2 уже выполняться не будет. Думаю стоит это добавить в статью.(с) tormozit
Процедуры-обработчики событий
Особенностью обработки событий среде 1С:Предприятия 8 является то, что имя процедуры-обработчика в одних случаях должно совпадать с именем события, а в других случаях может от него отличаться. Данная статья написана, чтобы внести ясность в этом вопросе.
Обратите внимание, что термин "Предопределенная процедура", который использовался в версии 7.х, теперь заменен на "процедура-обработчик события" или просто "обработчик события".
Ниже показана палитра свойств для формы элемента справочника "Номенклатура" с несколькими назначенными обработчиками событий:
За информацией о приемах работы с этой частью палитры свойств обращайтесь к документации: книга "Конфигурирование и администрирование", "Глава 3. Объекты конфигурации => Свойства элементов управления => Категория свойств События" (стр. 1 - 204)
Обратите внимание на важный момент, имя процедуры-обработчика событий может не совпадать с именем события . Для элементов управления чаще всего так и бывает, например, процедура "ТипЦенПриИзменении" обрабатывает событие "ПриИзменении" поля ввода для реквизита "ТипЦен", как показано на следующем рисунке:
Как правило, процедура-обработчик имеет тот же набор параметров, что и событие. Если у нее нет соответствующих параметров, то обработка события может получиться неполной. Поэтому рекомендуется создавать процедуры-обработчики конструктором через палитру свойств, нажимая кнопку с лупой или выбирая процедуру из выпадающего списка.
Есть еще одна интересная возможность: одна и та же процедура может "обслуживать" несколько событий формы или элементов управления, в том числе от разных источников. Элемент управления, который инициировал событие, передается в качестве первого параметра в эту процедуру-обработчик (параметр "Элемент"), и при необходимости алгоритм может проанализировать, откуда пришло событие, и выполнить соответствующие действия.
Поясним это правило на конкретных примерах:
1. Процедуры-обработчики событий, расположенные в модуле приложения или модуле внешнего соединения, совпадают с именами событий:
- ПередНачаломРаботыСистемы
- ПриНачалеРаботыСистемы
- ПриЗавершенииРаботыСистемы
- ПередЗавершениемРаботыСистемы
- ОбработкаВнешнегоСобытия
2. Имена процедур-обработчиков событий, расположенных в модуле объекта, тоже строго соответствуют именам событий:
для модуля документа (события объекта типа "ДокументОбъект")
- ПередЗаписью
- ПриЗаписи
- ПриУдалении
- ПриКопировании
- ОбработкаЗаполнения (для обработки "ввода на основании")
- ОбработкаПроведения
- ОбработкаУдаленияПроведения
- ПриУстановкеНовогоНомера
Аналогичные обработчики событий могут располагаться в модуле справочника и модулях других прикладных объектов.
3. Есть также модуль набора записей для всех видов регистров, который подобен модулям прикладных объектов. Модуль набора записей может содержать следующие процедуры-обработчики событий (имена процедур должны совпадать с именами событий):
Ниже приведены несколько важных моментов, которые полезно помнить при работе с событиями:
Примечание 1. Событие ПередЗаписью прикладного объекта отличается от события ПередЗаписью формы, связанной с этим прикладным объектом. Обработчик события в модуле формы вызывается при интерактивной записи, а обработчик в модуле объекта при любом способе записи элемента в базу данных.
Примечание 2. Если в процедурах-обработчиках модуля объекта нужно обратиться к самому объекту (текущий элемент справочника, текущий документ и т.д.), то для этого можно использовать свойство ЭтотОбъект. Оно содержит объект типа "СправочникОбъект", "ДокументОбъект" и т.д.
Примечание 3. Считается грубой ошибкой в процедурах-обработчиках событий объектов вызывать такие интерактивные команды, как Вопрос и Предупреждение. Эти команды показывают на экране диалоговое окно и ждут реакции пользователя. Так как событие обрабатывается в рамках транзакции, то это вызовет значительную задержку в обработке события и часть данных (или вся таблица) будет заблокирована на время ожидания.
Программа 1С постоянно усовершенствуется, добавляются новые функции, позволяющие сделать работу в системе более удобной.
Событие в программе 1С возникает в тот момент, когда пользователь использует какую-либо кнопку, в результате нажатия на которую открывается форма или записывается документ.
Функции программы позволяют выполнять определённые действия в результате возникновения определённого события. Для этого необходимо прописать подробные условия во встроенной программе. Для этого программисту необходимо назначить обработчик на каждое событие.
Кроме того, программист может настроить систему таким образом, что обработчик будет назначен сразу на несколько документов при нажатии на одну кнопку.
Чтобы найти элемент дерева конфигурации «Подписки на события», достаточно открыть вкладку «Общие» в дереве конфигурации. В выпадающем списке дерева можно выбрать необходимый пункт.
В самой подписке на события выбирается источник, который будет основой для осуществления определённых событий.
Функция-обработчик выбирается в общем модуле в дереве конфигурации.
Как проверить заполнение поля?
Например, для работы в системе программист добавил общий реквизит. Необходимо проконтролировать заполнение данного поля в каждом вновь созданном документе. Для выполнения этого действия следует учитывать несколько этапов.
Пользователю необходимо добавить в систему новую подписку, следует придумать для неё новое название и написать его. В свойствах подписки на событие устанавливаются ссылки на документы, на которые впоследствии будет установлен обработчик.
Следующий шаг – выбор в свойствах одного из вариантов событий, которые будут происходить после нажатия кнопок с документами или справочниками.
Работа с формами 1С
Как показывает практика, можно значительно упростить работу со многими объектами в 1С. Чаще всего это документы и справочники. Однако на данный момент невозможно подписаться на события 1С формы, например, при её открытии.
Следует понимать, что возможность использования событий напрямую зависит от используемого объекта. Однако, если выбрать сразу несколько объектов, в итоге в списке будут только те события, которые возможно применить к каждому из объектов.
Функция-обработчик
Следующий этап – работа с функцией обработчиком события. Для её использования необходимо установить серверный общий модуль. Эти настройки можно изменить во вкладке «Свойства». Функция-обработчик создаётся после нажатия кнопки «Лупа».
Для чего нужна функция подписки на события?
За несколько этапов пользователь сам может установить функцию подписки на событие в 1С. Этот приём позволяет выполнять определённую функцию при записи любого документа или создания нового.
Создание подписки значительно упрощает работу в программе 1С, а также экономит время пользователю.
Документы в 1С: состав и проведение
У каждого документа есть экранная форма и, как правило, бумажная форма в виде таблицы. Бумажная форма позволяет печатать Документы. Правила проведения определяются параметрами встроенного языка 1С. Язык программирования диктует, как Документы в 1С будут записываться, вести себя на экране, формировать печатную форму. Всю структуру описывают метаданные.
Роль метаданных в формировании структуры документов
Метаданные в 1С описывают всю структуру базы данных. Получить метаданные в 1С можно через функционал объекта «Метаданные». Описание структуры метаданных полностью раскрыто в главном меню Конфигуратора. Через Метаданные в 1С можно получить информацию обо всех реквизитах Документа.
Реквизиты и журналы
Каждому виду документа соответствует неограниченное количество его реквизитов. Обязательные черты любого документа в 1С:
- Многострочная часть и шапка имеют неограниченное число реквизитов;
- У каждого документа есть экранный диалог – форма на экране;
- Обязательна настройка общих характеристик: номер, длина, уникальность, дата и т.п.;
- У документа есть шапка и табличная часть;
- Табличная часть состоит из однотипных строк с информацией;
- Каждому документу присуща своя дополнительная информация.
Отличия Документов от Констант, Справочников и Перечислений
Документы и Константы хранят значения, но Документ – это информация о хозяйственном событии, Константа – неизменный параметр метаданных. У константы нет печатной формы.
Документы и Справочники имеют список реквизитов и печатные формы, но Справочник содержит нормативно-справочную информацию, а Документы – актуальные данные о свершившихся фактах.
Документы и Перечисления хранят список значений, но Перечисления содержат значения, заданные разработчиком в Конфигураторе. Их, в отличие от Документов, нельзя редактировать. У Перечислений нет печатной формы.
Экранные формы Документов
Чтобы найти Документы в 1С, нужно выйти в соответствующий Журнал. На экране появятся все записи журнала, содержащие заранее установленные реквизиты. К примеру, в Кадровых документах системы, можно увидеть все записи о Приеме на работу, Увольнении, Отпусках и Внутреннем перемещении. Отбор возможен по дате, виду документа, автору документа, номеру в системе. Если установить интервал экранного выведения записей, то пользователь увидит только позиции за указанный временной период. Колонки журнала настраиваются в Конфигураторе. Отбор можно установить как программно, так и вручную. Можно использовать функционал закладок.
Создание, проведение и удаление Документа
Методы создания Документа в 1С:
- Создать Документ в 1С можно через меню, выбрав в подменю соответствующую позицию;
- Можно создавать записи в открытой форме журнала путём копирования;
- Сделать новый Документ можно на основании другого введённого в систему.
Таким образом, существует 3 способа введения нового документа: создание, копирование, ввод на основании.
Проведение Документа происходит автоматически, если правильно заполнены все обязательные поля формы.
Для удаления нужно пометить Документ в программе, а затем удалить позиции встроенной обработкой в монопольном доступе.
Печать Документа в системе
Распечатать можно только те Документы, которые имеют печатную форму. Заказать печатную форму можно для любого документа. Печатные формы формируются с помощью встроенного языка 1С. Печатная форма – отчёт, созданный на основании сведений о хозяйственных операциях. Печатную форму Документа в 1С можно также настраивать.
Читайте также: