Description of Processing Server commands

A command line interface may be used for managing the Processing Server. The command line interface can be used to perform the following operations on the Processing Server:

  • initializing and stopping the server;
  • adding, setting up, and removing stations;
  • updating data sets;
  • managing hot folders;
  • managing the diagnostics mode.

Processing server commands should be entered as follows: 'FlexiBrSvc Please [command]'. In order to not have to enter the phrase 'FlexiBrSvc Please ' every time, you can enable command mode by using FlexiBrSvc Please obey. To disable command mode, use FlexiBrSvc Please quit.

For help regarding one or several of the above commands, use help [command].

Below is a description of all commands authorized to be used in the Processing Server.

Managing the server

  • set <param>=<value> – assigns the <value> value to the <param> parameter. Use the 'view' command to display a list of available parameters. Use the 'set <param>=?' command to display a list of all allowed values for a parameter.
  • start server – initializes the Processing Server.
  • stop server [timeout] – stops the Processing Server.

Use the [timeout] parameter to set a time period during which the server should finish carrying out initialized tasks. If this parameter has not been set, the server will stop instantly.

Managing stations

  • add station <location> – adds a new station to <location>.
  • list stations – displays information about existing stations.
  • remove station <station>|* – removes a <station>. Use '*' to remove all stations.

Note: Carrying out this command requires that the station's name as well as its location or UUID are specified.

  • set station <station> <param>=<value> – assigns the <value> value to the <param> station parameter. Use the 'view' command to display a list of all available parameters. Use the 'set station <station> <param>=?' command to display a list of all possible parameter values. Use '*' instead of the station name to assign the specified parameter value to all stations.
  • start station <<station>|*> [/Async] – attempts to initialize the <station> station. Use '*' to attempt to initialize all stations.

Note: Carrying out this command requires that the station's name as well as its location or UUID are specified.

Use the [/Async] parameter so that other commands are not blocked if station <station> has not been initialized.

  • stop station <<station>|*> [timeout] – stops the <station> station. Use '*' to stop all stations.

Note: Carrying out this command requires that the station's name as well as its location or UUID are specified.

Use the [timeout] parameter to set a time period during which the server should finish carrying out initialized tasks.

  • view <station>|* – displays detailed information about station <station>. Use '*' to display information about all stations. If no station has been specified, this command will display information about the server.

Managing projects

  • update dataset <project> [document definition] [data set] – updates a data set. Use <project> to specify the full path to the project, for example: http://app-server/f24d.../Banking_eng. If either the document definition name or the data set name are not specified, all document definitions and data sets will be updated.

Managing hot folders

  • list hotfolders <project> – displays detailed information about all enabled hot folders.
  • set hotfolder <project> Enabled/Disabled – enables or disables hot folder processing for project <project>. Use the 'view' command to display a list of available projects.

Process diagnostics

The profiling system is designed for low-level monitoring of Server and Processing Station internal conditions. If profiling is enabled, the Processing Server will begin to collect statistics about its own and the stations' internal processes. By default, this function is disabled.

The Processing Server will save the collected data to the following folder in the file system: %ProgramData%\ABBYY\FlexiCapture\12.0\FlexiBr[Svc]\Profiling. The frequency with which the collected data is saved to disk is set by the following registry key: ProfilingManagerSaveWindowProfilingReportPeriod in HKEY_LOCAL_MACHINE\SOFTWARE\[Wow6432Node\]ABBYY\FlexiCapture\12.0\FlexiBr​ (in milliseconds; the default value is 3600000).

  • reset total profiling report – resets the full profiling report. After this command has been used to clear the profiling report, the report will only cover the time period after the command has been called.
  • save total profiling report <path> – saves the full profiling report to the specified folder.
  • save window profiling report <path> – saves the full profiling report for the specified period to the specified folder.
  • set profiling disabled – disables profiling.
  • set profiling enabled – enables profiling.

10.11.2020 12:08:03


Please leave your feedback about this article