Документация по разработке с использованием платформы ARTA SYNERGY

Версия 4.2 Development

Сергей Коробицин

Данир Тлепов

Ревизия VCS: 1aec87d4b

Последним изменил: Kristina Markova

Для внутреннего использования

Дата сборки документа: 2018.12.06 17:05:59


Содержание

1. Руководство по интеграции
1.1. Введение
1.2. Способы интеграции с ARTA Synergy
1.2.1. Синхронизация/интеграция server-side
1.2.1.1. Прямая
1.2.1.2. Событийная
1.2.1.2.1. События ARTA Synergy
1.2.2. Модуль, влияющий на ход исполнения маршрута
1.2.2.1. Блокирующий процесс
1.2.2.2. SQL-запрос
1.2.3. Приложение, работающее от имени пользователя по API
1.2.4. Ссылки на модули системы и их внутренние элементы
1.2.4.1. Ссылка на модуль системы
1.2.4.1.1. Ссылка на документ и файл в нём
1.2.4.1.2. Ссылка на проект и мероприятие в нем
1.2.4.1.3. Ссылка на профиль пользователя
1.2.4.1.4. Отключение всего пользовательского клиентского скриптинга
1.2.5. WEB-модуль, встроенный в ARTA Synergy
1.2.6. Дополнительный обработчик для стандартного процесса ARTA Synergy
1.2.6.1. Исходный код SendControl:
1.2.7. Внешние модули-компоненты (ВМК)
1.2.7.1. Добавление ВМК
1.2.7.2. События для ВМК
1.2.7.2.1. WORK_USERS_CHANGED
1.2.7.2.2. WORK_DIALOG_UPDATE
1.2.7.2.3. SETTINGS_LOADED
1.2.7.2.4. DEPARTMENT_ENTITY_CHANGED
1.2.7.2.5. FORM_LOADED
1.2.7.2.6. REGISTRY_SELECTED
1.2.7.2.7. USER_CHOOSER_CREATED
1.2.8. Скриптинг в формах: модели, свойства и методы
1.2.8.1. Создание экземпляра проигрывателя и его методы
1.2.8.2. Базовые модели и отображения
1.2.8.3. Модели и отображения, которые не имеют специфичных свойств или переопределения методов
1.2.8.4. Модели и отображения, которые имеют специфичные свойства или методы
1.2.8.4.1. Модели и отображения компонентов «Страница» и «Таблица»
1.2.8.4.2. Модели и отображения компонента «Числовое поле»
1.2.8.4.3. Модели и отображения компонентов выбора
1.2.8.4.4. Модели и отображения компонента «Дата/время»
1.2.8.4.5. Модели и отображения компонента «Файл»
1.2.8.4.6. Модели и отображения компонента «Ссылка»
1.2.8.4.7. Модели и отображения компонента «Пользователь»
1.2.8.4.8. Модели и отображения компонента «Должность»
1.2.8.4.9. Модели и отображения компонента «Подразделение»
1.2.8.4.10. Модели и отображения компонента «Период повторения»
1.2.8.4.11. Модели и отображения компонента «Ссылка на проект»
1.2.8.4.12. Модели и отображения компонента «Ссылка на реестр»
1.2.8.4.13. Модели и отображения компонента «Ссылка на адресную книгу»
1.2.8.4.14. Модели и отображения компонента «Ссылка на файл в хранилище»
1.2.8.5. Методы поля ввода с тегами
1.2.8.6. Методы AS.SERVICES
1.2.8.7. Утилита при вызове методов API Synergy
1.2.8.8. Утилиты для работы с asfData и asfDefinition
1.2.8.9. Утилиты для работы с датами
1.2.8.10. Утилиты для работы с компонентами
1.2.8.11. Создание нового компонента
1.3. Установка и применение JavaScript интерпретатора
1.3.1. Введение
1.3.2. Автоматический способ установки
1.3.3. Ручной способ установки
1.3.3.1. После установки
1.3.4. Защита
1.3.4.1. Вводная часть
1.3.4.2. Настройка
1.3.5. Интерфейс модуля
1.3.6. Запуск скрипта
1.3.7. Объекты ARTA Synergy
1.3.7.1. Платформа
1.3.7.2. Менеджер данных по формам
1.3.7.3. Менеджер личных карточек
1.3.7.4. Файл по форме
1.3.8. Использование API методов
1.3.9. Авторизация
1.3.10. Завершение процесса
1.3.11. Примеры скриптов
1.4. Руководство по работе с аналитическими дашбордами
1.4.1. Введение
1.4.2. Подключение Elasticsearch и Kibana
1.4.2.1. Системные требования
1.4.2.2. Подключение пакетов Elasticsearch и Kibana
1.4.2.2.1. Установка Java
1.4.2.2.2. Установка и настройка Elasticsearch
1.4.2.2.3. Установка и настройка Kibana
1.4.2.2.4. Защита Kibana
1.4.2.3. Индексация данных форм
1.4.2.3.1. Названия индексов и alias-ы
1.4.2.3.2. Структура документа в индексе
1.4.2.3.3. Индексы изменения данных (историчные индексы)
1.4.3. Визуализация данных в Kibana
1.4.3.1. Шаблоны индексов
1.4.3.2. Создание диаграмм
1.4.3.2.1. Общая часть
1.4.3.2.2. Pie chart
1.4.3.2.3. Data table
1.4.3.2.4. Vertical bar chart
1.4.3.2.5. Markdown widget
1.4.3.2.6. Metric
1.4.3.2.7. Tag cloud
1.4.3.3. Создание дашбордов
1.4.3.3.1. Добавление и настройка диаграмм
1.4.3.3.2. Публикация дашборда
1.4.3.4. Возможные проблемы и способы их решения
1.4.4. Использование диаграмм
1.5. Способы авторизации в ARTA Synergy
1.5.1. Авторизация по логину и паролю
1.5.2. Сессионная авторизация
1.5.3. Авторизация по ключам
1.6. Как задеплоить интеграционное приложение
1.7. Стандартные решения интеграционных задач
1.7.1. Внедрение портлета liferay в Synergy
2. Сопутствующая документация

Список иллюстраций

1.1. Процесс «Событие реестра»
1.2.
1.3. Веб-модуль
1.4. Внешние модули
1.5. Добавление нового внешнего модуля
1.6. Пользовательские компоненты
1.7. Внешние модули-компоненты
1.8. Схема 1, общая схема работы проигрывателя
1.9. Схема 2, процесс изменения модели
1.10. Схема 3, процесс изменения значения компонента
1.11. Схема 4, взаимодействие со средой
1.12. Интерфейс модуля
1.13. Интерфейс модуля
1.14. Конфигурация выполнения скрипта
1.15. Успешное завершение выполнения скрипта
1.16. Ошибка при выполнении скрипта
1.17. Ошибка «Status: RED»
1.18. Создание нового шаблона индексов
1.19. Создание нового шаблона индексов без временных данных
1.20. Созданный шаблон индексов
1.21. Kibana, раздел Visualize
1.22. Выбор источника данных
1.23. Настройка отображаемых данных
1.24. JSON Input
1.25. Форма «Заявка»
1.26. Создание диаграммы Pie chart
1.27. Заявки по офисам и клиентам
1.28. Заявки по офисам и клиентам
1.29. Вкладка «Опции» диаграммы Pie chart
1.30. Создание диаграммы Data table
1.31. Настроены отображаемые данные в таблице
1.32. Вкладка «Опции» диаграммы Data table
1.33. Создание диаграммы Vertical bar chart
1.34. Диаграмма Vertical bar chart, пример 1
1.35. Диаграмма Vertical bar chart, пример 2
1.36. Создание Markdown widget
1.37. Создание Metrics
1.38. Вкладка «Опции» диаграммы Metrics
1.39. Создание Tag cloud
1.40. Пример диаграммы Tag cloud
1.41. Вкладка «опции» диаграммы Tag cloud
1.42. Kibana, раздел Dashboard
1.43. Добавление диаграммы на дашборд
1.44. Настройки периода отображения
1.45. Настройки периода обновления диаграмм
1.46. Добавлена панель диаграммы на дашборд
1.47. Изменение размера панели диаграммы
1.48. Изменен размер панели диаграммы
1.49.
1.50. Пример готового дашборда в режиме редактирования
1.51. Пункт меню «Share»
1.52. Пример дашборда, опубликованного как внешний модуль
1.53. Запрос пароля при просмотре дашборда
1.54.
1.55.
1.56.
1.57.
1.58.
1.59.
1.60. Условие на статус применено
1.61. Условие на тип применено
1.62. Отображение портлета в диалоговом окне
1.63. Отображение портлета на форме Synergy