Справка по системе Платформа ELMA BPM
×
Меню

Документация по процессу

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

Формирование самостоятельной документации по процессу

Документация по процессу в виде самостоятельного HTML-файла может быть сформирована в Дизайнере по одному, предварительно выбранному, процессу или нескольким процессам. Если не выбран ни один процесс, в мастере не доступен тип операции "Формирование документации для текущего процесса" и настройка содержимого документации.
Для запуска мастера формирования документации необходимо нажать кнопку Документация в панели инструментов списка процессов или карточки процесса.
Шаг 1. Тип формирования документации
На первом шаге задается тип операции формирования документации: для текущего процесса или группы процессов. Если не выбран ни один процесс, тип "Формирование документации для текущего процесса" недоступен. От типа формирования зависит набор настроек, доступных на втором шаге мастера.
Кроме того, на первом шаге можно изменить директорию, в которую будут помещены файлы документации (рис. 1). По умолчанию файлы документации помещаются в директорию "\Designer\Documentation" в каталоге установки платформы ELMA BPM.
Для перехода ко второму шагу мастера формирования документации нажмите кнопку Далее.
Рис. 1. Первый шаг формирования документации по процессу.
 
Шаг 2. Документация по текущему процессу
Если выбран тип «Формирование документации для текущего бизнес-процесса», то на втором можно настроить содержимое HTML документации, исключив из неё по выбору информацию о матрице ответственности, контексте, подпроцессах, переходах и оповещениях, задачах (этот пункт включает в себя информацию о зонах ответственности, событиях, собственно задачах и шлюзах), метриках и показателях процесса.
В области Выбор подпроцессов можно выбрать внутренние подпроцессы текущего процесса, по которым необходимо получить документацию (рис. 2). При этом на документацию по внутренним подпроцессам распространяются настройки содержимого, заданные для родительского процесса.
Рис. 2. Второй шаг формирования документации по текущему процессу.
Нажатие кнопки Завершить запустит процесс формирования документации по выбранному процессу. По окончании операции формирования документации в указанной на первом шаге директории будут размещены файлы документации. Система автоматически откроет эту директорию в проводнике Windows (рис. 3). Для ознакомления с документацией необходимо открыть файл index.html в любом браузере. Для перемещения документации необходимо скопировать файл index.html и все каталоги, расположенные в той же директории, что и файл index.html.
Рис. 3. Директория с документацией по процессу в проводнике Windows.
Шаг 2. Документация по нескольким процессам
Если выбран тип "Формирование документации по группе бизнес-процессов", на втором шаге предлагается выбрать процессы, по которым необходимо сформировать документацию (рис. 4). При этом нельзя отдельно выбрать внутренние подпроцессы. Они включаются в документацию соответствующих родительских процессов по умолчанию.
Рис. 4. Второй шаг формирования документации по нескольким процессам.
Нажатие кнопки Завершить запускает формирование документации по выбранным процессам. По окончании операции формирования документации в указанной на первом шаге директории будут размещены файлы документации. Система автоматически откроет эту директорию в проводнике Windows (рис. 5). Для ознакомления с документацией необходимо открыть файл index.html в любом браузере. Данный файл содержит ссылки на страницы с документацией для выбранных процессов. Для перемещения документации необходимо скопировать файл index.html и каталоги с документацией по процессам, расположенные в той же директории, что и файл index.html. Наименование каталогов соответствует наименованию процессов в системе.
Рис. 5. Директория с документацией по нескольким процессам в проводнике Windows.

Публикация документации по процессу в веб-приложении

Для публикации документации по процессу в веб-приложении, необходимо при публикации процесса активировать настройку Генерировать документацию (рис. 6).
Рис. 6. Окно публикации процесса.
После публикации документация по этому процессу доступна в веб-приложении в разделе Процессы - Документирование. Документация доступна администратору системы, а также владельцам и кураторам соответствующих процессов.
См. также:

Copyright © 2006–2019 ELMA