Описание команд Сервера Обработки

Для автоматизации управления Сервером Обработки может использоваться интерфейс командной строки. Режим управления с помощью командной строки позволяет выполнять c Сервером Обработки следующие операции:

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

Команды Сервера Обработки вводятся в виде 'FlexiBrSvc Please [command]'. Чтобы каждый раз не вводить 'FlexiBrSvc Please ', можно войти в командный режим, набрав FlexiBrSvc Please obey. Чтобы выйти из этого режима, наберите FlexiBrSvc Please quit.

Чтобы отобразить справку для одной или нескольких перечисленных команд, наберите help [command].

Далее описаны все разрешенные команды Сервера Обработки.

Настройка аутентификации

• set basicauthstring=<username>:<passoword> – задает параметры базовой аутентификации для Сервера Обработки и Станций Обработки. У пользователя, чьи данные указываются в этой команде, должна быть роль Сервер обработки.Чтобы сбросить параметры аутентификации используйте пустую строку: 'set basicauthstring='. Используйте команду 'view', чтобы вывести текущее значение параметров. Если параметры не заданы, будет выведена пустая строка.
  Замечание. Параметры базовой аутентификации можно задавать, только если Сервер Обработки и станции еще не запущены. Если параметры были заданы неверно, например, был указан неправильный пароль, то сервер и станции не смогут запуститься.

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

• set <param>=<value> – присваивает параметру <param> значение <value>. Используйте команду 'view', чтобы вывести список доступных параметров. Используйте команду 'set <param>=?', чтобы вывести список доступных значений параметра.
• start server – запускает Сервер Обработки.
• stop server [timeout] – останавливает Сервер Обработки.
  Используйте параметр [timeout], чтобы задать время, в течение которого сервер сможет закончить запущенные задания. Если этот параметр не задан, сервер остановится немедленно.

Управление станциями

• add station <location> – добавляет новую станцию в <location>.
• list stations – выводит информацию об имеющихся станциях.
• remove station <station>|* – удаляет станцию <station>. Введите '*', чтобы удалить все станции.
  Замечание. Для выполнения этой команды должны быть заданы имя станции и ее расположение или UUID.
• set station <station> <param>=<value> – присваивает параметру станции <param> значение <value>. Используйте команду 'view', чтобы вывести список доступных параметров. Используйте команду 'set station <station> <param>=?', чтобы вывести список доступных значений параметра. Введите '*' вместо имени станции, чтобы присвоить введенное значение параметра всем станциям.
• start station <<station>|*> [/Async] – производит попытку запуска станции <station>. Введите '*', чтобы запустить все станции.
  Замечание. Для выполнения этой команды должны быть заданы имя станции и ее расположение или UUID.
  Используйте параметр [/Async], чтобы выполнение других команд не блокировалось, если станция <station> не запущена.
• stop station <<station>|*> [timeout] – останавливает станцию <station>. Введите '*', чтобы остановить все станции.
  Замечание. Для выполнения этой команды должны быть заданы имя станции и ее расположение или UUID.
  Используйте параметр [timeout], чтобы задать время, в течение которого станции смогут завершить текущие задания.
• view <station>|* – выводит подробную информацию о станции <station>. Введите '*', чтобы вывести информацию о всех станциях. Если не указана конкретная станция, будет выведена информация о сервере.

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

• update dataset <project> [document definition] [data set] – обновляет набор данных. В <project> указывается полный путь к проекту, например, http://app-server/f24d.../Banking_eng. Если имя определения документа или набор данных не указаны, будут обновлены все определения документов и наборы данных.

Управление горячими папками

• list hotfolders <project> – выводит подробную информацию о включенных горячих папках.
• set hotfolder <project> Enabled/Disabled – включает или отключает обработку горячих папок для проекта <project>. Используйте команду 'view', чтобы вывести список доступных проектов.

Диагностика процессов

Система профилирования предназначена для низкоуровневого мониторинга внутреннего состояния Сервера и Станций Обработки. Если профилирование включено, Сервер Обработки начинает накапливать статистику о своей внутренней работе и внутренней работе станций. По умолчанию сбор статистики выключен.

Сервер Обработки сохраняет эту статистику в файловую систему по адресу %ProgramData%\ABBYY\FlexiCapture\12.0\FlexiBr[Svc]\Profiling. Частота сохранения статистики задается ключом реестра ProfilingManagerSaveWindowProfilingReportPeriod в HKEY_LOCAL_MACHINE\SOFTWARE\[Wow6432Node\]ABBYY\FlexiCapture\12.0\FlexiBr​ (задается в миллисекундах, значение по умолчанию – 3600000).

• reset total profiling report – сбрасывает полный отчет профилирования. После выполнения этой команды профиль полного отчёта профилирования сбросится и будет охватывать только промежуток времени с момента вызова команды.
• save total profiling report <path> – сохраняет полный отчет профилирования в указанную папку.
• save window profiling report <path> – сохраняет отчет профилирования за определенный период в указанную папку.
• set profiling disabled – отключает профилирование.
• set profiling enabled – включает профилирование.