Тестирование и отладка настроек Lotsia PDM PLUS

Виктор Афанасьев

Данная публикация некоторым образом продолжает тему настройки Lotsia PDM PLUS[1], достаточно подробно освещенную в предыдущем номере журнала. Тестирование и отладка созданных настроек является неотъемлемой частью процесса развития системы. До успешного завершения тестирования настройка не может считаться выполненной и готовой к применению.

Требования к администратору

Lotsia PDM PLUS предоставляет инструментарий, с помощью которого администратор, не привлекая разработчиков программы, формирует рабочую среду конечного пользователя. При этом настраиваются пользовательские формы, действия (макрокоманды), отчеты, загрузка внешних данных, процессы Workflow и многое другое. Настройки выполняются под процессы конкретного предприятия и его пользователей.

Поскольку имеет место человеческий фактор, при выполнении настроек могут возникать ошибки, которые необходимо диагностировать и исправлять. Даже если ошибок нет, в процессе выполнения и тестирования настроек обычно требуется что­то изменить и улучшить. Эти рутинные операции могут требовать значительных трудозатрат, возрастающих при повышении сложности выполняемых настроек. Реализация сложных настроек более трудоемка именно вследствие большого количества факторов, которые необходимо учитывать. На уровне предприятия совсем простых настроек не бывает, ведь Lotsia PDM PLUS используется для автоматизации процессов информационного обмена всего предприятия, которые нетривиальны по определению [2].

Для успешной настройки Lotsia PDM PLUS администратору важно знать предметную область. Наличие согласованного технического задания очень поможет, но знания администратора, привлекаемого к постановке и согласованию задачи, значительно облегчают как этот процесс, так и процесс внедрения разработок.

Администратор должен быть продвинутым IT­специалистом, знакомым с операционными системами семейства Microsoft Windows и системами управления базами данных. Необходимым организационным моментом является наличие у администратора требуемых прав доступа.

Как правило, администратор Lotsia PDM PLUS не является профессиональным программистом. Инструменты Lotsia PDM PLUS созданы с учетом данного обстоятельства.

Перейдем к конкретным примерам и рекомендациям.

Атрибутивные формы

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

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

Простейший и типичный случай нарушения вышеуказанного порядка настройки: при создании атрибутивной формы не было установлено соответствие атрибута типу объекта. Разумеется, потом это забылось, но при тестировании формы Lotsia PDM PLUS выдаст сообщение об ошибке (рис. 1).

Рис. 1. Сообщение об ошибке

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

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

Рис. 2. Выбор атрибута

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

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

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

Зачастую оказывается откровением, что для отображения изменений, сделанных в форме, администратору нет необходимости каждый раз перезапускать Lotsia PDM PLUS. Достаточно выделить в дереве связей объект с другой формой, а затем вернуться на объект с измененной формой.

Настройка действий (макрокоманд)

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

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

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

Рис. 3. Ошибка выполнения действия

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

Однако не всегда причиной подобной ошибки являются настройки структуры базы данных. Могут быть и ошибки в логике, но в любом случае, получив такое сообщение, необходимо проверить, должен ли данный атрибут присваиваться этому объекту? Если ответ не однозначно положительный, должны возникнуть примерно следующие вопросы:

• Тот ли атрибут устанавливается?
• Тому ли объекту устанавливается атрибут?
• Должен ли был выполнен данный шаг действия?
• В той ли последовательности выполнен данный шаг относительно других?

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

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

Если причину ошибки удалось выявить визуальным анализом содержания действия — отлично! К сожалению, это случается не всегда, поэтому для локализации места возникновения ошибки отключают выполнение отдельных шагов или строк. Зачастую этого оказывается достаточно. В более сложных случаях добавляют временные отладочные формы до и после выполнения различных функций, ориентируясь на текст ошибки. Это простейшие формы, отображающие текущие значения переменных. По завершении отладки действия эти формы удаляют. Таким способом удается отследить результат выполнения любого фрагмента действия до отдельной строки. Иногда и строку функций потребуется разбить на несколько более простых, с добавлением дополнительных переменных. В результате выявляется проблемное место и исправляется ошибка.

Трудности при написании действия могут возникать и на логическом уровне. Например, не всегда может быть очевиден оптимальный способ получения или обработки тех или иных данных. В подобных случаях рекомендуется в первую очередь обратиться к разделу «Практические рекомендации и примеры» электронной справки Lotsia PDM PLUS. Подходящий пример можно скопировать в действие и при необходимости адаптировать. Если остались затруднения, можно запросить рекомендации у службы технической поддержки, ни одно обращение к которой не остается без ответа!

Настройка отчетов

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

Обычно настройка любого отчета сопровождается проверкой его работы — это позволяет выявить и исправить ошибку сразу при ее появлении. Lotsia PDM PLUS позволяет проверить работоспособность отчета прямо в процессе настройки. Сохраненные изменения в настройке отчета тут же проверяются при обновлении выполненного отчета. Если результат устраивает — настройка при необходимости продолжается, а если появилась проблема — то ее источник, как правило, очевиден.

Так же, как при отладке атрибутивных форм и действий, для отладки, например, сложных фильтров или других выражений, рекомендуется идти по пути максимального упрощения такого выражения. Можно использовать дополнительные вычисляемые поля с понятными именами. Значения этих полей можно на время отладки показать в выполненном отчете, а выражение фильтра упростить, используя имена вычисляемых полей. В результате выражение фильтра любой сложности может быть сведено к объединению выражений типа «вычисляемое поле ХХХ=Значение».

Кроме фильтра, который накладывается на извлеченные данные, можно использовать SQL­условия предварительного отбора, которые уменьшают объем извлекаемых данных. В ряде случаев это бывает лучшим решением с точки зрения быстродействия и функциональности. Для настройки условий предварительного отбора можно применять форму аргументов отчета. С помощью выражений в вычисляемых полях можно сформировать результирующий SQL­запрос, который будет использован для отбора данных в секции WHERE. Во время тестирования отчета вычисляемые поля обычно визуализируются для контроля правильности формируемых условий, а затем их видимость отключается. В электронной справке Lotsia PDM PLUS содержится подробное описание данного инструмента и примеры условий.

Импорт внешних данных

Чтобы исключить случайную перезапись актуальных данных, настраивать и тестировать настройку импорта предпочтительно на копии рабочей базы данных Lotsia PDM PLUS. Убедившись в правильной работе сделанной настройки, ее можно перенести в рабочую базу данных. Перенос настройки импорта является элементарной операцией (рис. 4), выполняемой штатными средствами Lotsia PDM PLUS [3] с применением обменного файла.

Рис. 4. Перенос настройки импорта данных

Как показывает практика, основная сложность при выполнении загрузки внешних данных заключается в качестве самих данных. Если при создании таких данных использовался неконтролируемый ручной ввод, то данные наверняка содержат ошибки. Lotsia PDM PLUS позволяет автоматизировать обработку таких ошибок, но сложность задачи зависит от качества исходных данных.

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

Процессы Workflow

Тестирование и отладка процессов Workflow в сравнении с рассмотренными выше случаями более трудоемки. Это и понятно, ведь в процессах, кроме своих специфических настроек и форм, может использоваться большое количество действий.

В некоторых случаях, когда проблема выявляется не в начале процесса, требуется «прогон» процесса до проблемного места. При тестировании на это тратится дополнительное время. Но Lotsia PDM PLUS позволяет сократить время за счет отладки экземпляра процесса — карты с курсором исполнения, расположенным в нужной точке. Администратору важно не забыть скопировать изменения из отлаженной карты в шаблон.

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

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

Рис. 5. Проверка карты процесса

Рис. 6. Список действий задачи (некоторые действия отключены)

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

• отключение части действий в отлаживаемом фрагменте процесса путем установки заведомо невыполнимого условия. Чтобы отключенное действие визуально не терялось в списке (рис. 6), в начало его описания можно поместить специальную метку, например символы «//», используемые для комментирования строки внутри действий;
• переменные, изменение значений которых требуется контролировать, временно добавляются в форму этапа;
• при отладке списка действий, выполняемых последовательно по одному событию, практикуется разделение его на несколько более коротких. В этом случае одно событие, инициирующее выполнение всей последовательности действий, заменяется несколькими. Как правило, в форму временно добавляются кнопки, к каждой из которых привязывается часть тестируемых действий. В ходе отладки отдельно контролируется результат нажатия каждой кнопки. По окончании отладки все временно добавленные элементы формы удаляются.

Заключение

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

Пока же можно дать несколько общих рекомендаций.

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

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

В ряде случаев отладка настроек в экземпляре системы, находящемся в промышленной эксплуатации, может вызвать дополнительные сложности, связанные с необходимостью исключения вмешательства в работу пользователей. Изменение и тестирование настроек методически верно выполнять в тестовой копии рабочей базы данных. Для переноса настроек можно воспользоваться опциональным модулем репликации настроек Lotsia PDM PLUS.

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

Список литературы:

1. Садовников Д.Л. О настройке Lotsia PDM PLUS / Садовников, Д.Л. // САПР и графика. 2021. № 3. С. 60­67. ISSN 1560­4640.
2. ООО «НИПИ НГ «ПЕТОН». Опыт внедрения Lotsia PDM PLUS. Материалы конкурса «Опыт применения Lotsia PLM 2020», г.Москва // [Электронный ресурс]: база данных. — Режим доступа: https://plm­conference.com.
3. Афанасьев В.В. Возможности Lotsia PDM PLUS по обмену данными / Афанасьев, В.В. // САПР и графика. 2020. № 10. С. 24­29. ISSN 1560-4640.