# Содержание

## Назначение документа

Целью создания данного документа является предоставление информации о конфигурации продукта, в частности, предоставление детализированного описания:

> - созданных объектов
> - произведенных настроек
> - предполагаемого процесса работы в системе согласно назначению продукта.

Данный документ также может содержать дополнительные инструкции по возможным сценариям кастомизации существующей функциональности, советы и рекомендации.

## Методология внедрения

### Получение ресурсов (боевого и тестового стенда)

Характеристики серверов:

- Хранилище Jackrabbit
- Поисковые индексы Lucene
- 16 Гб ОЗУ
- Debian GNU/Linux (jessie, wheezy)
- CPU 8-core
- HDD/SSD с 10Гб свободного дискового пространства.

Предупреждение

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

### Установка и настройка системы

Воспользуйтесь инструкциями данного документа для установки (Инструкция по установке) системы на боевом и тестовом стендах.

### Кастомизация процессов по факту выявленных пожеланий

1. Для выявления пожеланий по изменению стандартной конфигурации продукта, устанавливаемой по-умолчанию, рекомендуется провести демонстрацию всем заинтересованным лицам проекта, в том числе, конечным пользователем: сотрудникам первой и второй линии.
2. Все пожелания/замечания к продукту должны быть задокументированы и проанализированы на сложность и сроки адаптации продукта под данные требования.
3. В качестве вспомогательного инструмента к определению необходимых настроек в системе для реализации тех или иных пожеланий, рекомендуется ознакомиться со Структурой продукта, а также Руководством разработчика

Предупреждение

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

### Обучение сотрудников работе в системе

1. Все сотрудники организации, которым в рамках проекта предполагается обучение, могут быть объединены в группы согласно осуществляемым ими ролям (канцелярия, отдел кадров, исполнители, руководители и т.д.)
2. Рекомендуем адаптировать руководство пользователя, представленное по-умолчанию, согласно произведенным изменениям конфигурации, оргстукртуе компании и прочей специфики проекта.
3. В первую очередь, должны быть обучены сотрудники, исполняющие основные роли в процессах, попадающих под опытную эксплуатацию (см. Шаг 6)

### Опытная эксплуатация

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

Примечание

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

### Запуск в промышленную эксплуатацию

## Инструкция по установке Arta Synergy Workflow

### Предварительные требования

Важно! Для работы системы требуется:

- установить Arta Synergy 4.1 minsky (инструкция по установке)
- в подсистеме администрирования обновить БД и процессы.

### Подключение репозиториев

Установочный пакет находится в репозитории product-stable. В файле `/etc/apt/sources.list` необходимо добавить либо раскомментировать следующую строку:

`deb http://deb.arta.kz/tengri product-stable main contrib non-free`

### Установка приложения

Для установки приложения необходимо выполнить команду:

    # apt-get update
    # apt-get install arta-synergy-apps-workflow

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

Примечание

1. Вариант `Clean` полностью удаляет все ранее установленные данные Synergy, устанавливает приложение Synergy Project, автоматически загружает его конфигурацию и загружает дампы базы данных.
2. Вариант `Install/Upgrade Configuration` устанавливает приложение Synergy Project, автоматически загружает его конфигурацию и настраивает необходимые конфигурационные файлы.
3. Вариант `Manual` устанавливает приложение Synergy Project без автоматической загрузки конфигурации (т.е. только заменяет `war`-файлы).

Дальнейший ход установки зависит от выбранного типа установки:

- для варианта `Clean`:

  > - указать URL сервера Synergy, на котором производится работа (например: `http://192.168.0.187:8080/Synergy`)
  > - ввести пароль пользователя, имеющего root-права mysql, от имени которого будут применены дампы базы данных
  > - после завершения установки обязательно нужно выполнить полную переиндексацию форм, файлов и документов в Административном приложении Synergy.

- для вариантов `Install/Upgrade Configuration` и `Manual`:

  > - указать URL сервера Synergy, на котором производится работа (например: `http://192.168.0.187:8080/Synergy`):
  > - ввести последовательно логин и пароль Системного пользователя:

После установки приложения обязательно выполнить пункты (Инструкция по первичной настройке)

## Инструкция по первичной настройке

1. Внести организационную структуру.

Обязательно должны присутствовать сотрудники с ролями:

- Сортудник канцелярии
- Сотрудник отдела кадров (для внедрения процесса Кадрового Делопроизводства)

2. Раздать права на реестры и журналы согласно указанным ролям
3. Настроить формы согласно внутренним потребностям компании

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

4. Настроить маршруты реестров согласно внутренним потребностям компании.

Настройка форм и маршрутов осуществляется в конфигураторе платформы. Для подробной инструкции обратить к обучающим курсам по платформе.

Примечание

Рекомендуем пройти обучающией курсы SD03 и SD04

## Структура продукта

### Как все устроено

Система Synergy Workflow реализована на базе платформы ARTA SYNERGY, путем создания конфигурации, допускающей гибкую настройку объектов: форм, маршрутов, статусов и пр…

В системе Synergy Workflow реализованы следующие глобальные процессы и их подпроцессы:

- Контроль поручений
    - Управление поручениями (работами)
    - Управление протоколами совещаний
- Документооборот
    - Входящая корреспонденция (1 журнал регистрации)
    - Исходящая корреспонеденция (1 журнал регистрации)
    - Резолюции и контроль исполнения документов
    - Архив (5 номенклатурных дел)
    - Внутрення переписка (1 журнал регистрации, 1 форма и реестр служебных записок)
- Кадровое делопроизводство
    - Прием (2 формы и 2 реестра служебных записок, 1 форма и реестр приказов на прием, 1 форма и реестр трудовых договоров)
    - Перевод (1 форма и реестр служебных записок на перевод ,1 форма и реестр приказов на перевод)
    - Увольнения (1 форма и реестр заявлений на увольнение ,1 форма и реестр приказов на увольнение)
    - Отпуска (5 форм и реестров заявлений на отпуск, 5 форм и реестров приказов на отпуск)
    - Командирования (1 форма и реестр служебных записок на командирование ,1 форма и реестр приказов на командирование)
    - Штатное расписания, расстановка, кадровый резерв
    - Ведение личных дел/личных карточек по сотрудникам.»

В конфигураторе приложение `workflow` состоит из следующих папок:

- `contracts` - Договора и контрагенты
    - `сontract_dicts` - справочники, используемые в формах договоров и контрагентов
    - Формы, реестры договоров
    - Формы, реестры контрагентов
- `docflow` - объекты Документооборота
    - `сounters` - счетчики
    - `document_registers` - журналы
    - `document_types` - типы документов
    - `number_templates` - шаблоны номеров
- `groups` - Группы пользователей
- `hr_processes`
    - `buisness_trip` - справочники, формы, реестры процесса «Командирование»
    - `firing` - справочники, формы, реестры процесса «Увольнение»
    - `hiring` - справочники, формы, реестры процесса «Прием»
    - `internal_notes` - справочники, формы, реестры процесса «Внутренняя служебная записка»
    - `leaves` - «Отпуска»
        - `leave` - справочники, формы, реестры процесса «Очередной трудовой отпуск»
        - `social_leave` - справочники, формы, реестры процесса «Учебный отпуск», «ОБР», «ОУР»
        - `unpaid_leave` - справочники, формы, реестры процесса «Неоплачиваемый отпуск»
    - `transfer` - справочники, формы, реестры процесса «Перевод»

## Инструкция по установке SdecAdapter (для интеграции с ЕСЭДО)

### Подключение репозиториев

Установочный пакет находится в репозитории extensions.

В файле `/etc/apt/sources.list` необходимо добавить либо раскомментировать следующую строку: `deb [allow-insecure=yes] http://deb.arta.kz/tengri extensions main contrib non-free`

### Установка приложения

Для установки приложения необходимо выполнить команду:

    # apt-get update
    # apt-get install arta-synergy-extensions-sdecadapter

Пакет SdecAdpater включает в себя:

1. Конфигурацию с необходимыми формами, реестрами, журналами
2. Модуль SdecAdapter для отправки документов и уведомлений в ЦОД SYNERGY - ЕСЭДО (размещается в /opt/synergy/jboss/standalone/deployments)
3. Конфигурационный файл настроек адаптера sdecAdapter.properties (размещается в /opt/synergy/jboss/standalone/configuration/arta)

### Первичная настройка

После установки приложения обязательно выполнить пункты:

1. Прописать корректные настройки в конфигурационном файле sdecAdapter.properties (URL, логин, пароль).

Примечание

Логин и пароль обязательно должны совпадать с авторизационными данными, указанными при регистрации контрагента в ЦОДе. Также в конфигурации адаптера необходимо указывать все коды форм входящих и исходящих документов.

2. Проверить наличие очередей в конфигурационных файлах (добавляются автоматически в ходе установки):

`/opt/synergy/jboss/standalone/configuration/standalone-onesynergy.xml`

    <jms-queue name="outgoingEmailQueue" entries="queue/outgoingEmailQueue java:jboss/queues/workflow/outgoingEmailQueue" durable="true"/>
    <jms-queue name="ingoingEmailQueue" entries="queue/ingoingEmailQueue java:jboss/queues/workflow/ingoingEmailQueue" durable="true"/>
    <jms-queue name="ingoingEmailQueueReject" entries="queue/ingoingEmailQueueReject java:jboss/queues/workflow/ingoingEmailQueueReject" durable="true"/>
    <jms-queue name="ingoingEmailQueueRegistration" entries="queue/ingoingEmailQueueRegistration java:jboss/queues/workflow/ingoingEmailQueueRegistration" durable="true"/>

`/opt/synergy/jboss/standalone/configuration/arta/api-observation-configuration.xml`

    <listener>
        <queue>java:jboss/queues/workflow/outgoingEmailQueue</queue>
        <event>event.sdecadapter.blocking.outgoing_registration</event>
    </listener>
    <listener>
        <queue>java:jboss/queues/workflow/ingoingEmailQueueRegistration</queue>
        <event>event.sdecadapter.blocking.ingoing_registration</event>
    </listener>
    <listener>
        <queue>java:jboss/queues/workflow/ingoingEmailQueueReject</queue>
        <event>event.sdecadapter.ingoing_reject</event>
    </listener>
    <listener>
        <queue>java:jboss/queues/workflow/ingoingEmailQueue</queue>
        <event>event.docflow.document.*</event>
    </listener>

3. Прописать на форме входящих и исходящих документов значения полей по-умолчанию:

Для исходящих:

- `from` (memberID вашего контрагента, полученного от администратора ЦОД, после добавления вашего контрагента в справочники ЕНСИ*)
- `senderOrg` (senderOrg вашего контрагента, полученного от администратора ЦОД, после добавления вашего контрагента в справочники ЕНСИ*)

Для входящих:

- `notif_from` (memberID вашего контрагента, полученного от администратора ЦОД, после добавления вашего контрагента в справочники ЕНСИ*)
- `notif_senderOrg` (senderOrg вашего контрагента, полученного от администратора ЦОД, после добавления вашего контрагента в справочники ЕНСИ*)

Примечание

Для добавления вашего контрагента в справочники ЕНСИ необходимо обратиться в ДРП

Read the Docs v: master

Versions
  latest
  workflow-2.19
  workflow-2.18
  workflow-2.17
  workflow-2.16
  workflow-2.15
  workflow-2.14
  workflow-2.13
  workflow-2.12
  master

Downloads
  pdf
  docx
  htmlzip
  epub

On Read the Docs
  Project Home
  Builds

Free document hosting provided by Read the Docs.