RxCmd – новая утилита для импорта шаблонов и интеграции

В версии Directum RX 4.1 на смену утилите DrxUtil пришла утилита RxCmd. В этой статье расскажем, зачем нужна новая утилита, и чем она отличается от своего предшественника.

Различия утилит DrxUtil и RxCmd

Что известно о DrxUtil?

До версии 4.1 утилита использовалась для экспорта и импорта шаблонов документов, интеграции с Directum Ario, 1С, Active Directory и других задач. Она представляет собой десктоп-приложение, которое взаимодействует с WCF-сервером Directum RX. Утилита работает только в системе Microsoft Windows.

Чем новая утилита RxCmd лучше DrxUtil?

Начнем с предыстории. Тема импортозамещения давно у всех на слуху. Многие организации переходят на свободно распространяемое ПО, так как того требует законодательство либо из-за санкций на импортные продукты. В Directum RX большое развитие эта тема получила в версии 4.0, когда все сервисы системы научились работать в системах Linux.

Архитектура утилиты DrxUtil не позволяла сделать ее кроссплатформенной, поэтому было принято решение разработать новую. Так появилась утилита RxCmd, которая может запускаться как в Microsoft Windows, так и в системах Linux. Кроме того, новая утилита справляется со своими задачами быстрее своего предшественника.

Какие задачи решает RxCmd?

RxCmd – это клиентское приложение, работа которого основана на плагинах. В стандартную поставку утилиты входят плагины, которые решают схожие с DrxUtil задачи:

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

Кроме того, вы можете создавать свои плагины. Благодаря плагинам через утилиту можно выполнять интеграции с другими системами.

Каковы архитектурные особенности RxCmd?

С системой Directum RX утилита работает через сервис интеграции. Сервис выступает в роли API к Directum RX.

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

Где взять утилиту RxCmd?

Утилита входит в состав дистрибутива Directum RX, после установки она размещается в папках:

• %PROGRAMFILES%\Directum Company\DirectumRX\Utilities\RxCmd\win7-x64\ либо
• $%PROGRAMFILES%\Directum Company\Sungero Development Studio\Utilities\RxCmd\win7-x64\

 /etc/_builds/DirectumRX/<Номер версии>/RxCmd/linux-x64/.

Остается ли старая утилита DrxUtil в поставке?

Да, утилита DrxUtil остается в поставке, но только для интеграции с 1С и Active Directory (AD). В ближайших версиях эти задачи также будут решаться через RxCmd.

Также если вы вызывали через утилиту DrxUtil статические клиентские функции для обращения к локальным ресурсам внешних систем, то этот код продолжит работать. Но уже сейчас настоятельно рекомендуется переводить код на плагины RxCmd, так как в скором времени поддержка утилиты DrxUtil прекратится.

В таблице сведена информация, когда используется та или иная утилита в Directum RX 4.1:

Решаемые задачи	Используемая утилита
Запуск и настройка интеллектуальной обработки документов, загруженных через DCS	RxCmd
Настройка классификации документов в сервисах Directum Ario	RxCmd
Импорт, экспорт и удаление шаблонов документов	RxCmd
Интеграция с 1С	DrxUtil
Интеграция с Active Directory	DrxUtil
Обращение к локальным ресурсам внешних систем	RxCmd (рекомендуется)/DrxUtil

 

Запуск утилиты RxCmd

Утилита запускается из командной строки в Microsoft Windows, а также через консоль или скрипты развертывания в системах Linux.

Чтобы выполнить определенную операцию, например, импорт шаблонов документов, достаточно запустить командную строку. В Microsoft Windows такая командная строка имеет вид вид:

"С:\Program Files\Directum Company\DirectumRX\Utilities\rxcmd\rxcmd" templates import "c:\Program Files\Directum Company\DirectumRX\Utilities\rxcmd\DefaultTemplates\" -n Administrator -p 11111

Строка может содержать команды первого и второго уровней, а также опции и аргументы. Аргументы являются обязательными параметрами, а опции необязательными. В примере templates – это команда первого уровня, import – команда второго уровня, -n и -p –опции, а путь до папки с шаблонами – это аргумент.

Для быстрого знакомства с утилитой удобно воспользоваться встроенной справкой, которая вызывается с помощью опций -?, -h или –help/. При этом справка является многоуровневой: ее можно вызвать для команд первого и второго уровня.

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

Разработка новых плагинов

Плагины – это модули, за счет которых расширяется функциональность утилиты. Помимо стандартных плагинов утилиты RxCmd, вы можете создать свои. Например, чтобы:

• написать новую логику для интеллектуальной обработки документов;
• выполнить интеграцию с другими системами, когда есть доступ на локальном компьютере к внешней системе, например, к системе SAP;
• перевести на плагины любой код, который ранее работал через DrxUtil.

Плагины разрабатываются в Microsoft Visual Studio. Они могут напрямую работать с сущностями через сервис интеграции либо вызывать прикладные функции. При необходимости вы можете создать такие функции в среде разработки Directum RX.

В поставку утилиты входит архив RxCmdPluginSDK.zip с готовым шаблоном разработки. Можно создавать плагины на его основе или использовать стандартные. Так выглядит развернутый архив:

• CustomPlugin.sln – проект с шаблоном плагина;
• src – папка с исходным кодом шаблона для разработки плагина;
• samples – папка с исходным кодом плагинов из базовой поставки Directum RX;
• lib – папка с библиотеками, которые используются в проекте.

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

Порядок разработки плагина довольно прост:

1. 1. Распаковываем архив с проектом. Меняем имя сборки.
2. 2. Создаем команды первого и второго уровней по шаблону.
3. 3. Задаем для каждой команды обработчик и алгоритм выполнения.

Затем остается только присоединить плагин к RxCmd. Для этого достаточно собрать проект и положить его файлы в подпапку утилиты Plugins. Если плагин добавлен, то при вызове справки об утилите отображаются все его команды и параметры:

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

Также на сайте GitHub есть много готовых примеров разработки с использованием библиотек, которые можно применять в плагинах RxCmd. Подробнее см. примеры использования библиотек Simple.OData.Client для обращения к сервису интеграции и System.CommandLine для обработки командной строки.

В заключение

Новая утилита RxCmd позволяет работать в системах Microsoft Windows и Linux: запускать интеллектуальную обработку, настраивать классификаторы, удалять, экспортировать и импортировать шаблоны документов. А также она предоставляет удобные инструменты для написания своих плагинов.

Оцените возможности утилиты уже сейчас, будем рады вашим комментариям, вопросам и пожеланиям!