> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Processing Server

> Run the ABBYY FlexiCapture Processing Server: start it, add and group Processing Stations, set up logging, and manage the server from the command line.

The Processing Server distributes the workload among the Processing Stations. Together with the Processing Server, a Processing Server Monitor is installed for monitoring the server. Document processing itself is done on the Processing Station.

Once the Processing Server is installed, configure it: start the server, and then add, set up, and start the Processing Stations.

<Note>
  Before starting the Processing Server, make sure that the Processing Server access permissions have been granted to the account under which the server is running.
</Note>

<Frame>
  <img src="https://mintcdn.com/abbyy/mpS3pcxC_lkohQUS/images/flexi-capture/ProcessingServerMonitor.png?fit=max&auto=format&n=mpS3pcxC_lkohQUS&q=85&s=4cc80c07017b12a06f66e525d5530056" alt="Screenshot of the Processing Server Monitor window showing the ABBYY FlexiCapture 12 Servers tree with a started server and its Stations, Station groups, and Tasks nodes." width="1197" height="370" data-path="images/flexi-capture/ProcessingServerMonitor.png" />
</Frame>

## Start the Processing Server

<Steps>
  <Step title="Launch the Processing Server Monitor">
    Launch the Processing Server Monitor by selecting **Start → All Programs → ABBYY FlexiCapture 12 Servers → Processing Server**.
  </Step>

  <Step title="Add the server">
    On the server tree, select **ABBYY FlexiCapture Servers**, right-click, and select **Add Server...**.
  </Step>

  <Step title="Specify the server location">
    In the **Add Processing Server** dialog box, specify the server location (**Network host** or **Local host**).
  </Step>

  <Step title="Provide the Application Server path">
    Select **Actions → Properties** and provide the path to the Application Server (`https://<ApplicationServer>`, where `<ApplicationServer>` is the name of the computer on which the Application Server is installed). If the Processing Server and the Application Server are installed on the same computer, specify its name directly. Using the IP address `127.0.0.1` or `localhost` renders the Processing Stations inoperable.

    <Note>
      On the Application Server, start the Administration and Monitoring Console and assign the corresponding role to the computer on which the Processing Server is installed.
    </Note>
  </Step>

  <Step title="Start the server">
    Click <img src="https://mintcdn.com/abbyy/XVEmG3cTpHwMKf5X/images/flexi-capture/StartServer.gif?fit=max&auto=format&n=XVEmG3cTpHwMKf5X&q=85&s=93616f535a5b427e2795ae92558cf116" alt="" style={{display:"inline-block",verticalAlign:"middle",margin:0}} width="22" height="22" data-path="images/flexi-capture/StartServer.gif" /> to start the Processing Server.

    <Note>
      The Processing Server can be stopped with a hard or soft stop. For a soft stop (for example, to upgrade or move a database), select **Actions → Stop**. All current tasks are completed, the Processing Server then stops, and no new tasks are taken into processing. For a hard stop, select **Actions → Stop Immediately**. All current tasks fail.
    </Note>
  </Step>
</Steps>

## Set up the Processing Stations

<Steps>
  <Step title="Add stations">
    In the server tree, select **Stations** and click <img src="https://mintcdn.com/abbyy/39LtOHLEp1q7pm1x/images/flexi-capture/AddStation.gif?fit=max&auto=format&n=39LtOHLEp1q7pm1x&q=85&s=c926888a1e12b4d4037fe6a804717d3f" alt="" style={{display:"inline-block",verticalAlign:"middle",margin:0}} width="22" height="22" data-path="images/flexi-capture/AddStation.gif" />. The **Add Stations** dialog box appears. Select the stations from the overall list. You can also identify a computer by name or IP address. The name works even when dynamic IP addresses are used. Use IP addresses if you have problems accessing the DNS network.
  </Step>

  <Step title="Configure the station parameters">
    Select **Actions → Properties** and, in the **Station Properties** dialog box, specify the parameters of the station:

    * **Name** – The displayed name of the station.
    * **Group** – The group to which the station belongs.
    * **Start automatically** – The station is started automatically by the Processing Server. Selected by default. Frequent attempts to start too many stations may considerably slow down the Processing Server.
    * **Required disk space** – The minimum disk space required for the Processing Stations to operate. If there is not enough free disk space, the station is stopped. The space specified in the field should be three times the maximum size of an image that can be in processing. The optimal value is twice the maximum size of a batch that can be in processing.
    * **Maximum number of processes** – The maximum number of CPU cores that can be used for task processing.
    * **Allowed number of processes** – The allowed number of CPU cores for task processing. This value is computed automatically based on your hardware and license parameters and cannot be changed.
    * **Process priority** – The priority of the process.
    * **Acceptable task types** – The task types that the station can handle:
      * **Import images** – Import tasks.
      * **Recognize pages** – Recognition and export preprocessing tasks.
      * **Verification support** – Merging the results of double verification, and pre- and post-processing tasks for the Web Verification Station.
      * **Custom processing** – Processing batch and document [processing scripts](/flexi-capture/appendix/scripts/scripts-handling).
      * **Export documents** – Document export tasks.
  </Step>

  <Step title="Start the station">
    Click <img src="https://mintcdn.com/abbyy/mpS3pcxC_lkohQUS/images/flexi-capture/ProcServer_StartStation.gif?fit=max&auto=format&n=mpS3pcxC_lkohQUS&q=85&s=fbd07ff728e6fa33ec882a0f0b76c4ae" alt="" style={{display:"inline-block",verticalAlign:"middle",margin:0}} width="26" height="24" data-path="images/flexi-capture/ProcServer_StartStation.gif" /> to start the station manually, or wait for it to start automatically (if the **Start automatically** option is selected, the station starts within a minute).

    <Note>
      The Processing Station can be stopped with a hard or soft stop. For a soft stop (for example, to upgrade), select **Actions → Stop**. All current tasks are completed, the Processing Station then stops, and no new tasks are taken into processing. For a hard stop, select **Actions → Stop Immediately**. All current tasks fail.
    </Note>
  </Step>
</Steps>

The stations receive the permissions to process documents from the Processing Server when they connect to the server.

## Create station groups

You can isolate different tenants from one another at the task level. To do so, create the required Processing Station groups and then assign a group to each new tenant you create.

<Steps>
  <Step title="Add a station group">
    In the server tree, select **Station groups** and click <img src="https://mintcdn.com/abbyy/39LtOHLEp1q7pm1x/images/flexi-capture/AddStation.gif?fit=max&auto=format&n=39LtOHLEp1q7pm1x&q=85&s=c926888a1e12b4d4037fe6a804717d3f" alt="" style={{display:"inline-block",verticalAlign:"middle",margin:0}} width="22" height="22" data-path="images/flexi-capture/AddStation.gif" />. The **New Station Group** dialog box opens.
  </Step>

  <Step title="Specify the group">
    Specify a group name and select the stations from the overall list.
  </Step>

  <Step title="Save the group">
    Click **OK**.
  </Step>
</Steps>

The group appears in the list, and you can then specify it for tenants in the Administration and Monitoring Console. For more information, see [Manage tenants](/flexi-capture/web-stations/monitoring-console/multitenancy).

To change the name of a group or its list of stations, select the group in the list and click **Edit Station Group...** in the context menu. You can also add a station to a group by selecting the group in the **Station Properties** dialog box.

## Set up the Processing Server log

<Steps>
  <Step title="Open the log settings">
    Open the Processing Server Monitor settings by selecting **File → Settings...**.
  </Step>

  <Step title="Choose which messages to log">
    Specify which messages should be logged (Errors, Warnings, Information messages).
  </Step>

  <Step title="Choose whether to remove completed tasks">
    Specify whether information about completed tasks should be deleted (**Remove completed tasks from the list**).
  </Step>

  <Step title="Choose which messages trigger logging">
    Specify which messages trigger logging of information about the task.

    <Note>
      Do not disable the **Remove completed tasks from the list** option during normal operation of the system, as this may cause a pile-up of data and slow down the Processing Server Monitor. Disable this option only when setting up and tuning the system.
    </Note>
  </Step>

  <Step title="View the task log">
    Click <img src="https://mintcdn.com/abbyy/dDAYrQCagGQmZN3a/images/flexi-capture/view_log.gif?fit=max&auto=format&n=dDAYrQCagGQmZN3a&q=85&s=8d5cad1943833c1bcdae4f79b13e7fa6" alt="" style={{display:"inline-block",verticalAlign:"middle",margin:0}} width="21" height="20" data-path="images/flexi-capture/view_log.gif" /> to view the task log. To save a task log as a `.txt` file, click the **Export Log...** button in the dialog box that opens.
  </Step>
</Steps>

## View task information

To view task details, select **Tasks** in the Processing Server tree. For each task, the following parameters are displayed: task name, start-up time, progress, status, priority, and the station name. Failed tasks are marked with <img src="https://mintcdn.com/abbyy/fmgRWFNHKYN2MLSg/images/flexi-capture/failed.gif?s=17d48022628a3682da7b5077a390606f" alt="" style={{display:"inline-block",verticalAlign:"middle",margin:0}} width="16" height="15" data-path="images/flexi-capture/failed.gif" />. If, besides an error message, the task log also contains informational messages, the task is marked with <img src="https://mintcdn.com/abbyy/8aWHPAJyzWmTqglX/images/flexi-capture/info_mes.gif?s=2acd5ad582fadb19d3f1ac1dc45cd111" alt="" style={{display:"inline-block",verticalAlign:"middle",margin:0}} width="17" height="17" data-path="images/flexi-capture/info_mes.gif" />.

## Service log

Besides the regular task processing log, the Processing Server and the Processing Station can keep a service log. [ABBYY technical support](/flexi-capture/appendix/support) staff may need information from this log when handling your support requests. Service logging does not slow down your Processing Server or Processing Station, but the information it contains is only useful to ABBYY's technical support engineers, so we do not recommend keeping service logging permanently enabled. If a technical support engineer asks you for a service log, follow these steps:

<Steps>
  <Step title="Open the properties dialog box">
    Depending on which log is required, open the **Processing Server Properties** dialog box (select **Properties** on the shortcut menu of the Processing Server) or the **Station Properties** dialog box (select **Properties** on the shortcut menu of the Processing Station).
  </Step>

  <Step title="Enable logging">
    Select the **Write processing log** option and click **OK**.
  </Step>

  <Step title="Collect the log files">
    Once the log files are created, find them in `%programdata%\ABBYY\FlexiCapture\12.0\FlexiBrSvc\Logs`. Send copies of these files to ABBYY technical support.
  </Step>

  <Step title="Disable logging">
    Disable service logging by clearing the **Write processing log** option and clicking **OK**.
  </Step>
</Steps>

## Manage the Processing Server from the command line

<Steps>
  <Step title="Open a command-line prompt">
    In the Windows **Start → Run** menu, type `cmd` and click **OK**. A command-line prompt window appears.
  </Step>

  <Step title="Go to the FlexiBRSvc.exe location">
    Type the path to the `FlexiBRSvc.exe` file (by default, `C:\Program Files\ABBYY FlexiCapture 12 Servers`).
  </Step>

  <Step title="Enter commands">
    Enter commands in the form `FlexiBrSvc Please [command]`:

    * To enable command mode so that you do not type `FlexiBrSvc Please` before each command, use `FlexiBrSvc Please obey`.
    * To disable command mode, use `FlexiBrSvc Please quit`.

    The commands let you start or stop a station, display the station list, start or stop the Processing Server, add or remove stations, view information about a station, and set server and station parameters.
  </Step>

  <Step title="View the list of commands">
    To show the list of allowed commands and other help information, type `FlexiBRSvc.exe /?`.
  </Step>
</Steps>

For a detailed description of all commands, see [Description of Processing Server commands](/flexi-capture/appendix/proc-server-cmd).
