Skip to main content
Use the command line interface 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
Enter Processing Server commands in the form FlexiBrSvc Please [command]. Instead of typing FlexiBrSvc Please in each command, you can enable command mode with FlexiBrSvc Please obey. To disable command mode, use FlexiBrSvc Please quit. For help on any command, use help [command].

​
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 current authentication credentials, use a blank string: set basicauthstring=. To display the current credentials, use view (if no credentials have been specified, a blank string is returned).
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 available parameters, use view. To display all 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 stops 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 *.
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 available parameters, use view. To display all 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.
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 *.
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 is specified, this command displays information about the server.

​
Managing station groups

  • set station <<station> StationGroup=<group name> – Adds a station to the group.
  • set station <<station> StationGroup= – Deletes a station from the group.
To find out which group a station belongs to, use the view <station>|* command.

​
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 Document Definitions and data sets are 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 a project. To display all 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 begins to collect statistics about its own and the Processing Stations’ internal processes. This function is disabled by default. The Processing Server saves the collected data to the folder %ProgramData%\ABBYY\FlexiCapture\12.0\FlexiBr[Svc]\Profiling. The frequency with which the collected data is saved to disk is set by the 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 clears the profiling report, the report includes only the time period after the command was 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.