Документ Process Design Document (PDD)

Process Design Document (PDD) представляет собой шаблон для документирования автоматизированных процессов в Sherpa Designer.

PDD генерируется при нажатии на кнопку "Документировать..." в меню "Проект".

Шаблон PDD автоматически подгружается Sherpa Designer в поле "Шаблон PDD" и не изменяется в процессе генерации документа.

PDD предназначен для описания текущих (AS IS) и целевых (TO BE) процессов, параметров и конфигураций.

AS IS в шаблоне содержит схему и описание текущего ручного или частично автоматизированного процесса. Фиксируются реальные шаги, приложения, роли сотрудников и узкие места для анализа перед роботизацией.
TO BE включает схему с автоматизированным процессом (блоки Sherpa Designer, последовательность действий, число шагов) и отражает итоговый процесс с интеграциями Sherpa Orchestrator и статистикой блоков.
Параметры включают таблицы, содержащие данные, которые предназначены для передачи между блоками и JSON-схемами.
Конфигурации включают: учетные данные, флаги, статистику по работе блоков и взаимодействию с ними, данные из Sherpa Orchestrator и логирование.

Структура шаблона

Шаблон включает разделы с таблицами и изображениями схем:

Назначение документа — раздел определяет цель PDD (стандартизированное документирование RPA-процессов Sherpa RPA для передачи знаний между разработчиками, аналитиками и стейкхолдерами).
Контроль над документом — раздел позволяет отслеживать каждое изменение в документе.

Содержит информацию об:

2.1. История изменений — таблица с колонками “Дата”, “Версия”, “Краткое описание изменений”, “Автор”, “Роль”. Фиксирует эволюцию документа для аудита и контроля.

2.2. Контактные лица — таблица, которая содержит перечень ответственных: “ФИО”, “Роль”, “Электронная почта”, что упрощает коммуникацию по проекту.

Глоссарий — таблица для фиксации терминов, их сокращений и определений, которая позволяет стандартизировать терминологию внутри проекта.

Общая информация по процессу — таблица с ключевыми метриками и характеристиками для оценки эффективности роботизации.

Описание процесса AS IS — раздел, в котором приведена информация по текущему процессу до автоматизации.

5.1. Общие сведения — описание текущего процесса с блоками и интеграциями.

5.2. Верхнеуровневая схема процесса AS IS — изображение (650px), отображающее схему текущего процесса.

5.3. Описание шагов процесса AS IS — таблица с детализацией шагов текущего процесса, действий пользователей и используемого ПО.

Описание процесса TO BE — раздел, в котором приведена информация по автоматизированному процессу.

6.1. Общее описание роботизированного процесса — описание оптимизированного процесса с блоками и интеграциями.

6.2. Верхнеуровневая схема процесса TO BE — изображение (650px), отображающее схему автоматизированного процесса.

Среда и взаимодействующие ИТ-системы — таблица, описывающая системы, задействованные в процессе: названия систем , логины и пароли для доступа робота, а также внешние сервисы и соответствующие блоки Sherpa Designer: названия сервисов, имена блоков автоматизации, палитры.

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

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

Структура папок проекта — таблица, описывающая структуру папок проекта.

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

Статистика по блокам — таблица, содержащая данные о количестве выполнения блоков Sherpa Designer, задействованных в данном процессе.

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

Работа с Оркестратором — раздел, содержащий информацию о настройки очередей, ассетов, расписаний Sherpa Orchestrator.

14.1. Список очередей, используемых в проекте — таблица, описывающая конфигурацию очередей Sherpa Orchestrator для каждого блока робота.

14.2. Ассеты. Переменные Orchestrator (Assets) — подраздел, в котором фиксируется привязка блоков Sherpa Designer к ассетам Sherpa Orchestrator.

14.3. Учетные данные — таблица, описывающая учетные данные, которые используются роботом для взаимодействия с Sherpa Orchestrator.

14.4. Остальные переменные — таблица, описывающая переменные, которые используются роботом в процессе (при работе с Sherpa Orchestrator).

Логирование —раздел, в котором документируются все точки логирования робота Sherpa RPA для мониторинга, отладки и аудита.

15.1. Логирование NLog — конфигурация nlog.config.xml, содержащая пути логов. Определяет ротацию и уровни (Info, Error, Debug) файлового логирования.

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

15.3. Точки логирования в Оркестратор — таблица, описывающая блоки, при логировании в Sherpa Orchestrator, которые собирают данные о диаграммах и возникающих в них ошибках. Также в ней приводятся скриншоты и уровни исходящих сообщений.

Логины и пароли к системам — таблица, в которой приводятся все логины и пароли, которые нужны для доступа к системам и сервисам, используемым в процессе работы робота.

Режим работы робота — таблица, описывающая расписания и настройки запуска робота в Sherpa Orchestrator.

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

18.1. Обрабатываемые роботами (заложенные в логике процесса) — таблица, описывающая поведение пользователя при сбоях, заложенных в логике процесса.