-

docs/integration.rst

@@ -18,24 +18,24 @@
 -----------------
 
 ARTA Synergy предоставляет API для доступа к своим функциям
-с помощью rest сервисов. Описание методов API можно
-посмотреть в javadoc.
+с помощью rest сервисов. Описание методов REST API можно
+найти в `данном разделе`_.
 Авторизация для всех методов API — ``Basic HTTP``.
 
 Событийная интеграция
 ---------------------
 
 Под «событием» мы будем подразумевать сообщение о каком-либо изменении
-в Arta Synergy, содержащее тип события
+в ARTA Synergy, содержащее тип события
 и минимально необходимые для получения связанной с событием информации
 либо воздействия на Synergy данные. Обработчик события (или событий) —
 программный модуль, читающий сообщения о событиях из ``JMS Queue`` или ``JMS Topic``
 и осуществляющий, при необходимости, доступ к экземпляру Synergy,
 сгенерировавшему сообщение, с помощью API Synergy.
 
-Обработчик событий является отдельным от Arta Synergy приложением,
+Обработчик событий является отдельным от ARTA Synergy приложением,
 которое может работать как на том же сервере приложений,
-что и Arta Synergy, так и на удалённом.
+что и ARTA Synergy, так и на удалённом.
 
 Кроме этого, обработчик события может иметь собственные конфигурационные файлы,
 необходимые для реализации целевого назначения.
@@ -85,7 +85,7 @@ ARTA Synergy генерирует событие в случае,
    ``event.users.formdata.change``,
    ``event.users.account.add`` и т.д.
 2. ``java:jboss/queues/Synergy/RegisterCreateDocQueue``
-    для события добавления записи реестра ``event.registers.formdata.add``.
+   для события добавления записи реестра ``event.registers.formdata.add``.
 
 Рассмотрим, например, код обработчика очереди ``UsersQueue``:
 
@@ -100,7 +100,7 @@ ARTA Synergy генерирует событие в случае,
             //Получаем тип события
             String eventType = message.getStringProperty("api_event");
 
-            //Выполнение действие по получению дополнительных данных через API
+            //Выполнение действия по получению дополнительных данных через API
             //и прочих операций, зависящих от условий решаемой задачи
         }
     }
@@ -122,3 +122,9 @@ ARTA Synergy генерирует событие в случае,
         //Получаем идентификатор формы
         String formUUID = message.getStringProperty("formUUID");
     }
+
+.. toctree::
+  :maxdepth: 2
+  :numbered:
+
+  integration/events

docs/integration/events.rst

+События пользователей
+---------------------
+
+Данные события генерируются для каждого из
+нижеописанных случаев изменения *данных пользователей*:
+
+*   ``event.users.account.change`` Изменение данных полей *первичной
+    карточки* пользователя, т.е. параметров его учётной записи:
+
+        * Фамилия
+        * Имя
+        * Отчество
+        * Логин
+        * Код для показателей
+        * e-mail
+        * JID
+        * Личная папка пользователя
+
+*   ``event.users.formdata.change`` Изменение данных *карточек
+    пользователей* на основе *форм*, ассоциированных с ним
+    посредством функциональности «Отдел кадров». Для данного
+    события передаются следующие данные:
+
+        * `userID` - `ID` пользователя
+
+        * `formUUID` - `ID` формы карточки пользователя
+
+        * `dataUUID` - `ID` данных по форме
+
+*   ``event.users.account.add`` Добавление новой записи учётной
+    записи пользователя (и связанными с ней файлами по формам
+    «отдела кадров»)
+
+*   ``event.users.account.delete`` Удаление (пометка «удалённые»)
+    учётной записи пользователя (и связанных с ней файлов по формам
+    «отдела кадров»)
+
+*   ``event.users.contactdata.change`` Изменение «контактных данных»
+    пользователя — изменение/добавление записей раздела «Контакты»
+    профиля пользователя (модуль «Сотрудники») следующих типов:
+
+        * Skype
+        * Рабочий телефон
+        * XMPP
+        * Адрес
+        * Мобильный телефон
+        * Почта
+        * Телефон
+
+Для всех событий типа ``event.users.*`` передаваемые данные —
+``ID`` пользователя Synergy.
+
+События должностей
+------------------
+
+Данные события генерируются для каждого из нижеописанных случаев c
+*должностями*:
+
+*   ``event.orgstructure.position.add`` Добавление новой должности
+
+*   ``event.orgstructure.position.change`` Изменение данных должности -
+    добавление/изменение/удаление следующей информации:
+
+    *   Общее:
+
+        *   Название должности (на трех языках)
+        *   Код для показателей
+        *   Подразделение
+        *   Шифр
+        *   Необходимое количество штатных единиц
+        *   Тип назначения целей
+        *   Номер
+
+    *   Управление модулями
+    *   Показатели - статус активности
+
+*   ``event.orgstructure.position.formdata.change`` Изменение данных
+    *карточки должности* на основе *формы*, ассоциированной с ней
+    посредством функциональности «Отдел кадров». Для данного события
+    передаются следующие данные:
+
+        * ``positionID`` - ``ID`` должности
+        * ``assistantID`` - ``ID`` заместителя, передается только при изменении
+            данных карточки заместителя
+        * ``formUUID`` - ``ID`` формы карточки должности
+        * ``dataUUID`` - ``ID`` данных по форме
+
+*   ``event.orgstructure.position.delete`` Удаление должности
+
+Для всех событий типа ``event.orgstructure.position.*`` передаваемые
+данные - ``ID`` должности ``Synergy``.