Протоколирование сложных алгоритмов для пользователя

27.03.12

Разработка - Математика и алгоритмы

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

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

Поэтому пользователи звонят программисту, он берет в руки отладчик, и начинает разбираться.

Предлагаю избавить себя от груза подобной ответственности. Выход прост - трассировать логику работы схемы, выдавать протокол.

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

Когда я работал с ЗУП, то видел там замечательный механизм - выполнить расчет по сотруднику с комментарием. В комментарии выдавались подробности расчета. Но, видимо, 1с не хотело напрягать пользователей, и комментарии были очень поверхностными, иногда все-таки приходилось брать отладчик или смотреть промежуточные отчеты для того, чтобы понять, почему считает так или иначе.

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

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

Чтобы протоколирование не влияло на производительность, нужно включать его только тогда, когда требуется анализ, ну примерно как это сделано в 1С:ЗУП, где можно рассчитать зарплату по сотруднику без комментария или с комментарием. Однако на практике удобнее включать комментирование по выделенным строкам. Т.е. выделилил строки, нажали кнопку обработки - с комментарием или без. Потом можно смотреть протоколы.

Такой протокол в программировании называется трассировка. И он очень полезен. Я предлагал 1С в ЗУП внедрить протоколирование начислений налогов и прочих участков, которые для пользователей пока выглядят как черные ящики, но пока что не был услышан.

Пару рекомендаций:

·        В протоколе указывайте, что именно протоколируется - документ или номер строки.

·        Можно использовать не только окно сообщений, но и табличные документы

·        Ошибки отделяйте от информационных сообщений, выделяя их жирным или красным цветом

·        Протокол неплохо сохранять в отдельном поле документа, но не как текст, а как список важных тегов, т.е. что именно происходило с данной строкой.

Ну, и напоследок, приведу пример протокола.

Я конвертирую одни счета в другие. В документе в строке содержится исходный счет дебета и кредита и аналитика.

Протокол сообщает о том, какие счета получены в результате и какие правила конвертации применены.

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

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

 

Такой же метод я внедрял и в своих нетиповых конфигурациях на поддержке. Обычно в отчетах у меня стояла галочка "Выводить отладочные таблицы", которая выводила в ТЗ все запросы, из которых собирался отчет. При желании эти таблицы можно было сохранить в Excel, и проанализировать, чтобы проверить правильность работы отчета.

Тоже очень удобный метод. Рекомендую.

Пример протокола на картинке к статье.

См. также

Автоподбор ролей для профилей и групп доступа в любых типовых базах 1С УТ 11, КА 2, ERP2, Розница 2/3, УНФ 16/3, БП 3, ЗУП 3 и подобных (УФ, Платформа 8.3.14+)

Инструменты администратора БД Роли и права 8.3.14 1С:Розница 2 1С:Управление нашей фирмой 1.6 1С:Документооборот 1С:Зарплата и кадры государственного учреждения 3 1С:Бухгалтерия 3.0 1С:Управление торговлей 11 1С:Комплексная автоматизация 2.х 1С:Зарплата и Управление Персоналом 3.x 1С:Управление нашей фирмой 3.0 1С:Розница 3.0 Платные (руб)

Роли… Вы тратите много времени и сил на подбор ролей среди около 2400 в ERP или 1500 в Рознице 2, пытаясь понять какими правами они обладают? Вы все время смотрите права в конфигураторе или отчетах чтоб создать нормальные профили доступа? Вы хотите наглядно видеть какие права дает профиль и редактировать все в простом виде? А может хотите просто указать подсистему и дать права на просмотр и добавление на объекты и не лезть в дебри прав и чтоб обработка сама подобрала нужные роли? Все это теперь стало возможно! Обновление от 15.12.2023, версия 1.1.

12000 руб.

06.12.2023    2756    11    1    

30

Infostart УДиФ: Управление данными и формами

Инструменты администратора БД Инструментарий разработчика Роли и права Платформа 1С v8.3 Конфигурации 1cv8 Россия Платные (руб)

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

10000 руб.

10.11.2023    3243    10    1    

31

PowerTools

Инструментарий разработчика Инструменты администратора БД Платформа 1С v8.3 Управляемые формы Конфигурации 1cv8 Россия Платные (руб)

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

3600 руб.

14.01.2013    177340    1070    0    

846

Ускоренное проведение документов (x4), устранение ошибок 60/62 счетов и зачет авансов (Бухгалтерия 3.0)

Закрытие периода Инструменты администратора БД Корректировка данных Бухгалтерский учет 1С:Бухгалтерия 3.0 Россия Бухгалтерский учет Платные (руб)

Расширение «Оперативное проведение» в 4 раза уменьшает время проведения документов и закрытия месяца. Является комплексным решением проблем 62 и 60 счетов. Оптимизирует проведение при включенной функциональной опции «Раздельный учет НДС». Используется в более 10 организациях уже 2 года. Совместимо с конфигурацией Бухгалтерия 3.0 (+КОРП).

14400 руб.

29.04.2020    27144    78    146    

59

"Менеджер потоков 2.1": УПП: "Восстановление партий"

Инструменты администратора БД Платформа 1С v8.3 1С:Управление производственным предприятием Россия Бухгалтерский учет Управленческий учет Платные (руб)

Как оптимизировать то, что, считалось, не поддается оптимизации? Как повысить доступность базы данных? Как проводить самую «времяемкую» операцию не по паре раз в неделю, а по несколько раз в день*? Ответ есть!

20000 руб.

12.09.2019    11706    5    9    

7

Брандмауэр для сервера 1С Предприятие 8 - внешнее управление сеансами

Инструменты администратора БД Платформа 1С v8.3 Конфигурации 1cv8 Платные (руб)

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

3600 руб.

06.02.2017    31040    31    18    

47

Система хранения присоединенных файлов в томах на диске

Инструменты администратора БД Платформа 1С v8.3 1С:Комплексная автоматизация 1.х 1С:Управление производственным предприятием Платные (руб)

Конфигурация Комплексная автоматизация 1.1 (и УПП 1.3 тоже) хранит файлы и изображения в справочнике Хранилище дополнительной информации в реквизите Хранилище типа ХранилищеЗначений. Та же история с ВложениямиЭлектроннойПочты. Но при этом присоединенные файлы в Электронном документообороте хранит в томах на диске. Эта доработка позволяет использовать стандартный механизм хранения файлов, изображений и вложений электронных писем в томах на диске. При этом можно разделить тома хранения по объектам конфигурации.

4200 руб.

10.11.2015    61228    87    59    

72

Хранилище файлов на SQL

Инструменты администратора БД Платформа 1С v8.3 Управляемые формы Конфигурации 1cv8 Управленческий учет Платные (руб)

Привязка файлов / сканов к объектам 1С с сохранением их на SQL-сервере

12000 руб.

09.10.2019    10893    5    8    

9
Комментарии
В избранное Подписаться на ответы Сортировка: Древо развёрнутое
Свернуть все
1. BorisMor 310 28.03.12 20:46 Сейчас в теме
2. fixin 4252 28.03.12 21:09 Сейчас в теме
(1) а смысл? Описывается подход. Сообщить("Переменная Х=" +Х+ " на шаге " + i ) не является проблемой. Трассировка. Только данных для пользователей.
Или накапливать данные в таблицах, а потом их выводить, если стоит галочка вывода этих таблиц.
3. fomix 33 29.03.12 10:35 Сейчас в теме
(1) BorisMor, Рассмешил... Смотри типовые конфы! Например, Комплексная вер.7.7, там есть вывод комментариев
4. Dnki 4 30.03.12 18:42 Сейчас в теме
А не надо смеяться! Несмотря на банальность предложения, не видел, что бы этот прием программисты применяли, кроме меня разумеется :).
Вот действительно вопрос: как реализовали в программе, в диалоге? Некрасивость в том, что не хочется перегружать текст вещами вроде:
Если ВключенаТрассровка Тогда
Сообщить();

Я для краткости завел одну процедуру Трассировка("Что вывести"). Ее втыкаю где надо. А процедура проверяет включен ли флаг вывода. Разумеется использовать не для критичных по скорости циклов.
10. shatt 38 05.04.12 03:16 Сейчас в теме
Тоже так стараюсь делать
(4) идея хороша!
а в типовых конфах еще есть Процедура СообщитьИнформациюПользователю(СтрокаСообщенияПользователю)
и СообщитьОбОшибке(ТекстСообщения, Отказ = Ложь, Заголовок = "", Статус = Неопределено)
в общем модуле ОбщегоНазначения
11. fixin 4252 05.04.12 08:17 Сейчас в теме
(10) иногда надо использовать два режима - отладки и расчета. Т.е. если неясно, откуда расчет берет цифры, запускаешь его в режиме отладки и он или выводит комментарии или в конце выводит таблицу с детализацией расчета.
5. klel 02.04.12 21:41 Сейчас в теме
Интересная вещь стоит призадуматься
6. AnKonAlm 28 03.04.12 10:20 Сейчас в теме
Я тоже использую протоколирование. НО - при обработке больших объемов информации, лучше сообщать пользователю только глючную информацию. Ибо, если сообщать всё, то тяжело искать нужное.
7. fixin 4252 03.04.12 10:40 Сейчас в теме
(6) не надо этих народных песен. Выгружайте все в таблицу.
Если надо, пользователь скопирует в эксель и там проанализирует с помощью автофильтрами...
8. INSh 22 03.04.12 11:28 Сейчас в теме
Пробовал использовать подобный подход, но по-факту - ошибки (глюки) вылезают в самых непредсказуемых (а потому, непротоколируемых) местах и все-равно приходится лезть в код или отладчик и смотреть там... :-)
Зато, при нормальной работе модулей, генерится море бесполезной (никем неиспользуемой) информации :-)
Однако, согласен с тем, что в некоторых случаях протоколирование очень полезная вещь. Автору - "+"
9. fixin 4252 03.04.12 11:55 Сейчас в теме
(8) у меня есть расчет премий продавцам. При этом генерируются таблицы значений. Если поставить галочку "Показывать отладочную инфу", эти таблицы значений тупо выводятся в MXL. Далее их можно смотреть.
Помимо этого, если щелнуть на товаре в отчете, продавец получает опять эти же ТЗ, но отфильтрованные по товару.
То бишь ему становится понятно, откуда берутся цифры и проверять легко.
О чем идея? О том, что нужно иметь возможность восстановить любой сделанный расчет
12. alexmobile 69 30.10.12 09:08 Сейчас в теме
Безусловно полезная вешь. Но как ее реализовать?
Оставьте свое сообщение