RxCmd – это утилита Directum RX для решения вспомогательных интеграционных задач. Утилита представляет собой клиентское приложение, работа которого основана на плагинах. В стандартную поставку входят плагины для решения следующих задач:

•запуск и настройка интеллектуальной обработки документов, полученных с электронной почты или из папки с помощью службы ввода Directum Capture Service (DCS);

•настройка классификации документов в сервисах Directum Ario: создание и обучение классификаторов, просмотр, импорт, экспорт и публикация моделей классификации;

•импорт, экспорт и удаление шаблонов документов;

•запуск загрузки исторических данных из сервисов обмена, мониторинг ее состояния и возможность прекращения;

• первоначальное индексирование справочников для выполнения нечеткого поиска, выгрузка статистики распознавания документов, а также обновление и загрузка словаря синонимов ОПФ в Directum RX.

Также утилита RxCmd используется в отдельных решениях Directum RX. Например, с помощью нее настраивается обмен данными при интеграции Directum RX со службой каталогов Active Directory или Samba. Само решение «Интеграция с Directory Service» предоставляется по запросу в службу поддержки. Описание необходимых настроек утилиты входит в комплекты документации к решениям.

Плагины позволяют обращаться к внешним приложениям на компьютере или к локальным файлам в операционной системе, обрабатывать полученные данные и запускать серверную логику. Для запуска серверной логики они подключаются к сервису интеграции и через него обращаются к репозиториям типов сущностей, а также к серверным и разделяемым функциям Directum RX. Таким же образом плагины могут получать данные с сервиса интеграции, преобразовывать их и записывать локально.

Обмен данными выполняется в невизуальном режиме с компьютера сотрудника, где установлена утилита RxCmd.

Также можно создавать свои плагины. По запросу в службе поддержки Directum RX предоставляется архив RxCmdPluginSDK.zip с готовым шаблоном и исходные файлы стандартных плагинов. Например, можно создать копию плагина по интеллектуальной обработке и изменить логику обработки документов, полученных из конкретной папки. Подробнее см. руководство разработчика, раздел «Создание плагина RxCmd».

Установка, размещение и настройка утилиты

Утилита RxCmd устанавливается вместе с Directum RX при выгрузке архива DirectumRX.zip – для Microsoft Windows, DirectumRX.tar.gz – для Linux. По умолчанию утилита размещается в папке:

 DirectumLauncher\etc\_builds\DirectumRX\RxCmd

 DirectumLauncher/etc/_builds/DirectumRX/RxCmd

Если вы работаете с системой Directum RX в облаке, то запросите архив с утилитой в службе поддержки, распакуйте его и расположите в любой локальной папке.

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

•если планируется запускать утилиту через скрипты развертывания, то перед началом работ заполните параметры утилиты в конфигурационном файле config.yml в секции RxCmd;

•если планируется запускать утилиту напрямую через исполняемый файл, то заполните параметры утилиты в конфигураторе Directum Launcher в секции RxCmd, а также в файле _ConfigSettings.xml.

При облачной поставке файл _ConfigSettings.xml выдается службой поддержки Directum RX. При локальной установке файл необходимо создать вручную на основе входящего в поставку примера _ConfigSettings.xml.example.

ПРИМЕЧАНИЕ. Файл _ConfigSettings.xml можно не заполнять, только если при запуске утилиты всегда будет указываться URL-адрес сервиса интеграции (опция -s).

Также в комплекте с утилитой содержатся папки DefaultTemplates и Plugins со стандартными шаблонами документов и плагинами.

Для анализа ошибок работы с утилитой используйте лог-файлы. Путь до лог-файла задается в конфигурационном файле config.yml в параметре LOGS_PATH. Подробнее см. в руководстве администратора описание лог-файлов утилиты для систем Microsoft Windows и Linux.

Установка утилиты после обновления системы

Если в организации используется стандартная прикладная разработка, то утилита RxCmd обновляется вместе с Directum RX.

Если используется заказная разработка, то после обновления Directum RX:

1.Скопируйте в папку DirectumLauncher пакет стандартной прикладной разработки: DirectumRX.zip – для ОС Windows, DirectumRX.tar.gz – для ОС Linux.

2.Перейдите в папку DirectumLauncher и выполните команду:

do components add directumrx

./do.sh components add directumrx

3.Настройте утилиту.

Запуск утилиты через исполняемый файл

Исполняемый файл утилиты вызывается из командной строки.

Опции утилиты:

--version – просмотр информации о версии утилиты RxCmd.

-?, -h или --help – просмотр справки с информацией о командах утилиты RxCmd. Справка является многоуровневой: ее можно вызвать для команд первого и второго уровня.

-n <login> – пользователь, от имени которого утилита подключается к Directum RX.

-p <password> – пароль пользователя, от имени которого утилита подключается к Directum RX.

-с <name> – название набора учетных данных пользователя, от имени которого утилита подключается к Directum RX. Утилита получает учетные данные из своего конфигурационного файла. При этом пароль пользователя можно зашифровать. Если одновременно указать опции -c, -n и -p, то опции -n, -p игнорируются.

ПРИМЕЧАНИЕ. Опции -n и -p заполняются при аутентификации по паролю. При настроенной внешней аутентификации на сервисе интеграции опции заполнять не нужно.

-s – URL-адрес сервиса интеграции, например, http://192.188.9.95/DrxIntegration/odata. По умолчанию утилита получает адрес из своего конфигурационного файла. Если необходимо указать другой адрес, воспользуйтесь опцией.

ВАЖНО. При использовании утилиты учитывайте требования к экранированию спецсимволов командной строки. Например, если утилита запускается через командную строку Windows и в параметре используются пробелы или специальные символы, такие как &, параметр необходимо заключить в двойные кавычки.

Команды первого уровня:

ario – настройка классификации документов в сервисах Directum Ario: создание и обучение классификатора, просмотр, импорт, экспорт и публикация моделей классификации. Команда доступна для выполнения всем сотрудникам, у кого есть права на изменение справочника «Настройки интеллектуальной обработки документов».

templates – запуск экспорта, импорта и удаления шаблонов документов.

smart – запуск и настройка интеллектуальной обработки документов, полученных со сканера или из папки с помощью службы ввода DCS, подключение алгоритмов нечеткого поиска, а также также выгрузка статистики распознавания документов за выбранный период.

exchange – команды для загрузки исторических данных из сервисов обмена в Directum RX, например Диадок или СБИС: запуск, мониторинг состояния, прекращение загрузки.

Список команд второго уровня у каждого свой. Чтобы его посмотреть, укажите опцию -? после ввода команды первого уровня. Например:

Таким же образом можно получить информацию об опциях и аргументах команд второго уровня. Например:

Пример импорта шаблонов документов

"D:\DirectumLauncher\etc\_builds\DirectumRX\RxCmd\rxcmd.exe" templates import "D:\DirectumLauncher\etc\_builds\DirectumRX\RxCmd\DefaultTemplates" -n Administrator -p 11111

'/srv/DirectumLauncher/etc/_builds/DirectumRX/RxCmd' templates import '/srv/DirectumLauncher/etc/_builds/DirectumRX/RxCmd/DefaultTemplates' -n Administrator -p 11111

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

"D:\DirectumLauncher\etc\_builds\DirectumRX\RxCmd\rxcmd.exe" smart export-stats 2023-04-01 2023-04-30 "D:\Export" -n Administrator -p 11111

'/srv/DirectumLauncher/etc/_builds/DirectumRX/RxCmd' smart export-stats 2023-04-01 2023-04-30 ‘/home/user/Documents/export’ -n Administrator -p 11111

Подробнее см. раздел «Результаты обработки документов».

Запуск утилиты через скрипты развертывания

Если система установлена локально, то утилиту можно запускать с помощью скриптов развертывания.

Список команд:

generate-config-settings – создание конфигурационного файла _ConfigSettings.xml с настройками утилиты.

import_templates – импорт стандартных шаблонов документов из базовой поставки Directum RX.

import_templates --templates_dir_path="<Путь к шаблонам>" – импорт шаблонов документов из указанной папки.

run --command="<Команда>" – выполнение произвольных команд. Здесь указываются такие же команды и опции, как при запуске утилиты через исполняемый файл: --version, -s, ario, smart и др.

Пример импорта шаблонов документов из папки

do rxcmd import_templates --templates_dir_path="D:\Templates"

./do.sh rxcmd import_templates --templates_dir_path="/home/templates/"

Подробнее см. раздел «Экспорт и импорт шаблонов».

Пример подключения к сервисам Directum Ario

do rxcmd run --command= "smart init" ""http://smartstable:61100"" ""40"" ""80"" ""First page classifier"" ""Types classifier"" -n Administrator -p 11111"

./do.sh rxcmd run --command='smart init 'http://smart:61100' '40' '80' 'First page classifier' 'Types classifier' -n Administrator -p 11111'

Подробнее см. раздел «Подключение интеллектуальной обработки через командную строку».

Пример вызова справки по утилите

do rxcmd run --command='--help'

./do.sh rxcmd run --command='--help'

© Компания Directum, 2024