Обслуживание системы

Обслуживание системы включает в себя:

Управление базой данных

Раздел «Управление базой данных» в версиях до 3.11 и в версиях 3.11 и выше отличается.

Управление базой данных для версий до 3.11

В версиях Synergy до 3.11 раздел «Управление базой данных» отображает текущую и доступную версии базы данных, а также позволяет обновить текущую версию БД до доступной версии (илл. «Управление базой данных»).

Рисунок 4.48. Управление базой данных

Управление базой данных

В случае несовпадения версий БД администратор системы нажимает на кнопку «Обновить БД». Система предоставит диалоговое окно подтверждения действия: «ОК» для подтверждения, «Отмена» для отмены действия. В случае подтверждения начнется генерация БД, в окне отобразятся логи выполняемых действий (илл. «Логи обновления БД»).

Рисунок 4.49. Логи обновления БД

Логи обновления БД

Управление базой данных для версии 3.11 и выше

В версиях Synergy от 3.11 и выше раздел «Управление базой данных» отображает сведения об актуальности текущей БД и о классах (апдейтах), которые требуется применить для актуализации БД.

Для этого в модуле synergy-ejb, внутри каталога kz.arta.synergy.db.updates, располагается единый конфигурационный xml-файл, где будут перечислены все апдейты по порядку.

В случае наличия непримененных обновлений выводится сообщение:

Ваша версия БД неактуальна.
Следующие обновления еще не применены:
%id% - %comment%

%id% - %comment%

Поле %id% содержит название апдейта, поле %comment% - его описание.

Если в списке содержится более 5 обновлений, которые надо применить, то перечисляются первые 5 (в порядке перечисления классов в конфигурационном файле). В этом случае дополнительно будет отображена подпись:

и еще обновлений: %count%,

где %count% равен общему количеству непримененных обновлений без учета отображенных в списке (илл. «Вид окна при наличии непримененных обновлений»).

Рисунок 4.50. Вид окна при наличии непримененных обновлений

Вид окна при наличии непримененных обновлений

В случае невозможности применения обновлений БД выводятся сведения возникших ошибках (илл. «Вид окна в случае ошибок во время обновления»):

%ГГГГ-ММ-ДД ЧЧ:ММ%: Обновление прервано со следующей ошибкой: %текст_ошибки%

Рисунок 4.51. Вид окна в случае ошибок во время обновления

Вид окна в случае ошибок во время обновления

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

Если все обновления, указанные в конфигурационном файле, применены в БД, то будет выведено сообщение (илл. «Вид окна при отсутствии непримененных обновлений»):

Ваша версия БД актуальна

Рисунок 4.52. Вид окна при отсутствии непримененных обновлений

Вид окна при отсутствии непримененных обновлений

В данном разделе также можно проверить индексы, нажав на соответствующую кнопку в правом верхнем углу. Система предоставит окно (илл. «Проверка индексов»).

Рисунок 4.53. Проверка индексов

Проверка индексов

По нажатию на кнопку «Проверить индексы» в данном окне отобразятся логи выполняемых действий (илл. «Логи проверки индексов»).

Рисунок 4.54. Логи проверки индексов

Логи проверки индексов

Для закрытия окна администратор системы нажимает на кнопку «Отмена» либо кнопку закрытия окна.

Управление индексом документов

Для поиска документов используется отдельный индекс, который нужно генерировать. Для того, чтобы это сделать, необходимо нажать кнопку «Проиндексировать все документы» и дождаться окончания процесса индексирования. По ходу выполнения изменения будут отображаться в основной области.

Индексирование осуществляется блоками по 200 документов.

Для генерации индекса имеются дополнительные возможности:

  1. Возможность продолжить индексирование с момента последней остановки.

    До нажатия кнопки «Проиндексировать все документы» необходимо включить соответствующий флажок. Остановка индексирования может быть вызвана:

    • остановкой сервера приложений с ARTA Synergy;

    • ручной остановкой индексации (с помощью кнопки «Остановить индексирование»).

  2. Если процесс индексирования слишком сильно замедляет работу системы, можно установить паузу после индексирования очередного блока документов. Для этого необходимо ввести значение задержки в миллисекундах в поле «Пауза между индексированием частей документов».

Рисунок 4.55. Управление индексом документов

Управление индексом документов

Управление индексом форм

Для работы фильтров по реестрам используется отдельный индекс, который нужно генерировать. Для того, чтобы это сделать, используется раздел «Управление индексом форм» (илл. «Управление индексом данных форм»):

Рисунок 4.56. Управление индексом данных форм

Управление индексом данных форм

Окно «Управление индексом данных форм» содержит текущую статистику состояния данных, параметры и кнопки запуска и остановки индексирования, а также панель информации.

Статистика состояния данных

  1. Размер индекса в байтах: при использовании Lucene (устанавливается по умолчанию) отображается прочерк «-»; при использовании Elasticsearch - текущий размер индекса.

  2. Общее количество записей: общее количество документов по формам.

  3. Количество удаленных записей: количество индексов, удаленных при изменении индексируемых данных.

Запуск и остановка индексирования

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

    • Если ранее индексирование не осуществлялось, или нет ранее запущенного и остановленного процесса, флаг недоступен.

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

    • Если последний процесс индексирования был остановлен, а флаг отключен, то процесс индексирования начнется заново.

  2. Пауза между индексированием часлей записей (мс): числовое поле ввода, в котором указывается время необходимой паузы в процессе индексирования. Одной «частью» считается индексирование 500 документов.

Процесс запускается по нажатию на кнопку «Проиндексировать все данные форм». При этом в панели информации отображается сведения о процессе индексирования каждой части в формате:

«Отправлен запрос на индексирование данных форм»

«Индексирование записей начато %ГГГГ-ММ-ДД ЧЧ:ММ%. Займет примерно 2 минуты на каждые 2000 документов. В вашей базе %общее_количество_записей% записей.»

«Общее количество записей %общее_количество_записей%, проиндексировано %количество_проиндексированных_записей% за %ss% секунд»

«Общее количество записей %общее_количество_записей%, проиндексировано %количество_проиндексированных_записей% за %ss% секунд»

В случае, если в процессе индексирования очередной части возникли ошибки, то их текст будет отображен в отдельном сообщении об ошибке. При этом индексирование будет продолжено.

Процесс останавливается в двух случаях:

  1. Ручная остановка - по нажатию на кнопку «Остановить индексирование». При этом в панели информации выводится сообщение:

«Процесс индексирования остановлен»

Номер позиции, на которой процесс был остановлен, запоминается, и в дальнейшем индексирование можно продолжить с этой позиции либо начать заново.

  1. Все данные проиндексированы - процесс завершается самостоятельно. При этом в панели информации выводится сообщение:

«Индексирование завершено. Индексирование %общее_количество_записей% записей заняло %M% минут»

Помимо панели информации, сообщения о прогрессе индексирования выводятся как уведомления.

Рисунок 4.57. Процесс индексирования остановлен

Процесс индексирования остановлен

Рисунок 4.58. Процесс индексирования завершен

Процесс индексирования завершен

Управление индексом файлов

Генерация индексов элементов хранилища - файлов и документов - осуществляется в разделе «Управление индексом файлов»:

Рисунок 4.59. Вид раздела «Управление индексом файлов»

Вид раздела «Управление индексом файлов»

Окно «Управление индексом данных форм» содержит текущую статистику состояния данных, параметры и кнопки запуска и остановки индексирования, а также панель информации.

Статистика состояния данных

  1. Размер индекса в байтах: при использовании Lucene (устанавливается по умолчанию) отображается прочерк «-»; при использовании Elasticsearch - текущий размер индекса.

  2. Общее количество записей: общее количество файлов.

  3. Количество удаленных записей: количество индексов, удаленных при изменении индексируемых данных.

Запуск и остановка индексирования

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

    • Если ранее индексирование не осуществлялось, или нет ранее запущенного и остановленного процесса, флаг недоступен.

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

    • Если последний процесс индексирования был остановлен, а флаг отключен, то процесс индексирования начнется заново.

  2. Пауза между индексированием часлей записей (мс): числовое поле ввода, в котором указывается время необходимой паузы в процессе индексирования. Одной «частью» считается индексирование 200 документов.

Процесс запускается по нажатию на кнопку «Проиндексировать все файлы». Система запрашивает подтверждение действия:

«Вы действительно хотите проиндексировать все записи?»

Если пользователь подтверждает действие, процесс индексирования начинается. При этом в панели информации отображается сведения о процессе индексирования каждой части в формате:

«Отправлен запрос на индексирование файлов»

«Индексирование записей начато %ГГГГ-ММ-ДД ЧЧ:ММ%. Займет примерно 2 минуты на каждые 2000 документов. В вашей базе %общее_количество_записей% записей.»

«Общее количество записей %общее_количество_записей%, проиндексировано %количество_проиндексированных_записей% за %ss% секунд»

«Общее количество записей %общее_количество_записей%, проиндексировано %количество_проиндексированных_записей% за %ss% секунд»

В случае, если в процессе индексирования очередной части возникли ошибки, то их текст будет отображен в отдельном сообщении об ошибке. При этом индексирование будет продолжено.

Процесс останавливается в двух случаях:

  1. Ручная остановка - по нажатию на кнопку «Остановить индексирование». При этом в панели информации выводится сообщение:

«Процесс индексирования остановлен»

Номер позиции, на которой процесс был остановлен, запоминается, и в дальнейшем индексирование можно продолжить с этой позиции либо начать заново.

  1. Все данные проиндексированы - процесс завершается самостоятельно. При этом в панели информации выводится сообщение:

«Индексирование завершено. Индексирование %общее_количество_записей% записей заняло %M% минут»

Помимо панели информации, сообщения о прогрессе индексирования выводятся как уведомления.

Рисунок 4.60. Процесс индексирования остановлен

Процесс индексирования остановлен

Рисунок 4.61. Процесс индексирования завершен

Процесс индексирования завершен

Переключение индексаторов осуществляется посредством конфигурационных файлов:

  • Индекс документов: arta/esb/docIndex.xml

  • Индекс хранилища: arta/esb/fileIndex.xml

Примечание:

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

Настройки индексирования файлов и документов указываются в файле arta/elasticConfiguration.xml.

Описание полей индекса

Документы:

Каждый документ в индексе содержит как минимум следующие поля:

Имя поля в индексе Тип поля Хранимые данные в терминах Synergy

documentId

keyword

идентификатор документа

docID

keyword

идентификатор РКК

createDate

keyword

дата создания документа (в мс)

modified

keyword

дата изменения документа (в мс)

createDate_num

long

дата создания документа (в мс)

number

text

номер документа

registered

long

дата регистрации документа (в мс)

subject

text

краткое содержание

correspondent

text

корреспондент

correspondent_org

text

корреспондент (орг.)

base_number

text

номер исходящего документа

base_date

long

дата дата исходящего документа (в мс)

reg_date

long

дата регистрации документа (в мc)

doc_type

keyword

идентификатор типа документа

doctypename

text

название типа документа

duration

long

длительность (рабочих дней)

author

keyword

ID автора документа

authorname

text

имя автора документа

reg_user

keyword

ID пользователя, зарегистрировавшего документ

regusername

text

имя пользователя, зарегистрировавшего документ

counter_number

long

склеенная числовая часть номера документа

control

boolean

признак контрольного документа

defective

boolean

признак бракованного документа

writtenoff

boolean

признак списанного в дело документа

active

boolean

признак наличия работ по документу

late

boolean

признак просроченного документа

register

keyword

ID журнала, в котором расположен документ

docfile

keyword

ID дела, к которому относится документ

registry

keyword

ID реестра, к которому относится документ

counter<N>

long

числовая часть счетчика документа

ui<N>

keyword

символьный суффикс номер документа

uinumber<N>

long

числовая часть номера документа

status_sort

long

код статуса документа

sent_date_*

long

дата отправки документа пользователем (в мс)

read_date_*

long

дата прочтения документа пользователем (в мс)

sending_date_*

long

дата получения документа пользователем (в мс)

lastdate_*

long

максимум между датой прочтения и отправки документа пользователем (в мс)

read_*

boolean

признак того, что документ прочитан

hidden_*

boolean

признак того, что документ скрыт от пользователя

all

keyword

список ID пользователей, у которых документ должен быть в фильтре «Все документы»

sent

keyword

список ID пользователей, у которых документ должен быть в фильтре «Отправленные»

received

keyword

список ID пользователей, у которых документ должен быть в фильтре «Полученные»

mine

keyword

список ID пользователей, у которых документ должен быть в фильтре «Мои»

  • counter<N> - поле, содержащее числовую часть счетчика документа. <N> - порядковый номер части, от 1 до 5;

  • ui<N> - поле, содержащее суффикс номера документа (не числовой), расположенный между числовыми частями номера. <N> - порядковый номер суффикса, от 1 до 5;

  • uinumber<N> - поле, содержащее числовую часть номера документа, расположенную между символьными суффиксами. <N> - порядковый номер части, от 1 до 5;

  • в полях с постфиксом _* вместо * используется ID пользователя.

  • поле docID должно загружаться в индекс в том случае, если у документа есть сохраненная РКК.

Для следующих полей используется русскоязычный анализатор текста:

  • correspondent

  • correspondent_org

  • doctypename

  • authorname

  • regusername

  • username

  • number

  • base_number

  • formvalues

  • subject

  • base_number

  • formvalues

Кроме того, для полей number, subject, base_number и formvalues дополнительно используется параметр веса.

Файлы и ярлыки:

Каждый документ в индексе содержит как минимум следующие поля:

Имя поля в индексе Тип поля Хранимые данные в терминах Synergy

NODE_ID

keyword

ID файла

DOC_CREATED

long

дата создания файла (в мс)

DOC_AUTHOR_ID

keyword

ID пользователя, создавшего файл

PARENT_NODE_ID

keyword

ID родительской папки файла

PATH

keyword

расположение файла

DOC_FILENAME

text

название файла

NODE_NAME

text

название файла

DOC_COMPANION_ID

keyword

тип сущности, к которой принадлежит файл (документ, заметка, план, личное дело)

DOC_CATEGORIES

long

список категорий, к которым принадлежит файл

DOC_EXPIRE_DATE

long

срок действия версии файла (в мс)

DOC_PUBLISH_DATE

long

дата публикации файла (в мс)

DOC_SIZE

long

размер файла (в байтах)

DOC_COMPANION_MEMBERS

keyword

массив ID пользователей, имеющих доступ к файлу согласно их правам на COMPANION_ID

DOC_MIME_TYPE

keyword

название типа файла

ANCESTORS

keyword

список идентификаторов родительских папок

DOC_TITLE

text

название файла

DOC_CONTENT

text

текст документа (если возможно выделить непосредственно текст или служебную информацию для данного типа файла)

DOC_COMMENTS

text

комментарий к текущей версии файла

DOC_METADATA

text

склеенные данные свойств файла

READS_COUNT

long

количество открытий файла

Помимо описанного набора полей, для каждого свойства файла с кодом optionID создается поле с именем aiDocumentCompanionField<optionID>.

Для следующих полей используется русскоязычный анализатор текста:

  • DOC_CONTENT

  • DOC_METADATA

  • DOC_FILENAME

  • NODE_NAME

  • DOC_TITLE

  • DOC_COMMENTS

Кроме того, для полей DOC_FILENAME, NODE_NAME, DOC_TITLE, DOC_COMMENTS дополнительно используется параметр веса.

Примечания:

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

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

Процессы

Раздел «Процессы» отображает актуальность процессов системы в виде таблицы с полями:

  • название процесса;

  • ID процесса;

  • описание процесса;

  • актуальность состояния (да / нет);

  • кнопка «Обновить».

Рисунок 4.62. Процессы

Процессы

Раздел должен содержать следующие процессы:

  • Элемент ознакомления

  • Стандартное поручение

  • Элемент согласования

  • Элемент утверждения

  • Поручение (как элемент маршрута)

  • Элемент поручения

  • Блокирующий процесс

  • Назначение нестандартного рабочего графика

  • Выбор ответственного за работу

  • Общий процесс при запуске по формам

  • Условный переход

  • Копирование в карточку

  • Процесс копирования в папку пользователя

  • Процесс логирования

  • Утверждение проекта

  • Служебный элемент утверждения проекта

  • Работа проекта

  • Ввод значения показателя

  • Назначение пользователя на должность

  • Увольнение пользователя с должности

  • Перевод пользователя с должности на должность

  • Утверждение протокола

  • Результат запроса

  • Переназначение работ

  • Копирование полей реестров

  • Событие реестра

  • Этап регистрации документа

  • Регистрация документа

  • Элемент резолюция-работа

  • Резолюция

  • Маршрут

  • Шаблон маршрута

  • Этап маршрута

  • Отправка документа пользователю

  • Отправка документа пользователям из формы

  • Работа для анкетирования

  • Таймер

В случае, если процесс в неактуальном состоянии, администратор системы нажимает напротив него на кнопку «Обновить». Система предоставляет диалоговое окно подтверждения обновления: «ОК» для подтверждения, «Отмена» для отмены действия.

Кнопка «Обновить».

По нажатию на кнопку происходит обновление списка процессов.

Альтернативные потоки событий.

Альтернативный поток 1. Обновляется актуальный процесс.

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

Состояние приложения

Раздел «Состояние приложения» отображает текущее состояние системы (доступно / недоступно), а также позволяет централизованно выключить приложение (илл. «Состояние приложения»).

Рисунок 4.63. Состояние приложения

Состояние приложения

По нажатию на кнопку «Выключить приложение» клиентское приложение Synergy станет недоступным (илл. «Synergy централизованно выключено»). Кнопка переименуется на «Включить приложение».

Рисунок 4.64. Synergy централизованно выключено

Synergy централизованно выключено

По нажатию на кнопку «Включить приложение» клиентское приложение Synergy станет сразу доступным.

Управление резервным копированием

Раздел «Управление резервным копированием» отображает список резервных копий системы (илл. «Управление резервным копированием») в виде таблицы с полями:

  • Пользователь

  • Дата

  • Продолжительность

  • Размер

  • кнопка «Восстановить»

  • кнопка «Удалить»

Рисунок 4.65. Управление резервным копированием

Управление резервным копированием

Для создания новой резервной копии системы администратор нажимает на кнопку «Рез. копирование».

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

Для удаления резервной копии из списка администратор системы нажимает напротив нее на кнопку «Удалить».

Во всех трех случаях система предоставляет диалоговое окно подтверждения действия: «ОК» для подтверждения действия, «Отмена» для отмены выбранного действия.

Кнопка «Обновить».

По нажатию на кнопку происходит обновление списка резервных копий.

Информация о лицензии

Раздел «Информация о лицензии» отображает всю информацию о текущей лицензии системы в виде таблице со следующими строками:

  • Название продукта

  • Клиент

  • Дата выдачи

  • Номер лицензии

  • Условие лицензии

Поле «Условие лицензии» может принимать одно из следующих значений:

  • «Лицензия не ограничена» (илл. «Информация о лицензии (лицензия не ограничена)»)

  • «Лицензия ограничена» (илл. «Информация о лицензии (лицензия ограничена)»)

В случае, если лицензия ограничена, в таблицу добавляются следующие строки:

  • Максимальное количество пользовательских лицензий

  • Количество доступных пользовательских лицензий

  • Максимальная дата использования

Рисунок 4.66. Информация о лицензии (лицензия не ограничена)

Информация о лицензии (лицензия не ограничена)

Рисунок 4.67. Информация о лицензии (лицензия ограничена)

Информация о лицензии (лицензия ограничена)