Description of Processing Server commands

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 diagnostics

Processing Server commands should be entered as follows: 'FlexiBrSvc Please [command]'. Instead of typing 'FlexiBrSvc Please ' in each command, you can enable command mode by using FlexiBrSvc Please obey. To disable command mode, use FlexiBrSvc Please quit.

For help on any of the above commands, use help [command].

The commands that can be used on the Processing Server are described below.

Specifying authentication credentials

  • set basicauthstring=<username>:<password> – sets Basic authentication credentials for the Processing Server and Processing Stations. The user whose credentials are specified in this command must have the Processing Server role. To remove the currently used authentication credentials, use a blank string: 'set basicauthstring='. To display the currently used credentials, use 'view' (if no credentials have been specified, a blank string will be returned).
    Note: Basic authentication credentials can only be specified when the Processing Server and the Processing Stations are not running. If invalid credentials are specified, the Processing Server and the Processing Stations will not start.

Managing the server

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

To set a time period during which the server should complete the initialized tasks, uSe the [timeout] parameter . If this parameter is not 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. To remove all the stations, use '*'.

Note: This command requires a station's name and location or UUID to be specified.

  • set station <station> <param>=<value> – assigns a value to a parameter. To display all the available parameters, use 'view' . To display all the allowed values, use 'set station <station> <param>=?' .

To assign a value to all the stations, use '*' instead of a station name.

  • start station <<station>|*> [/Async] – attempts to initialize a station. Use '*' to attempt to initialize all the stations.

Note: This command requires a station's name and location or UUID to be specified.

To prevent other commands from being blocked if the specified station has not been initialized, use the [/Async] parameter

  • stop station <<station>|*> [timeout] – stops a station. To stop all the stations, use '*' .

Note: This command requires a station's name and location or UUID to be specified. To set a time period during which the server should complete the initialized tasks, use the [timeout] parameter.

  • view <station>|* – displays detailed information about a station.  To display information about all the stations, use '*'. 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. To specify the full path to the project, use <project> (for example: https://app-server/f24d.../Banking_eng). If no Document Definition or data set name is specified, all the Document Definitions and data sets will be updated.

Managing hot folders

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

Process diagnostics

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

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 include 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.

15.11.2022 10:12:44

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.