The Processing Server distributes the workload among the Processing Stations. Together with the Processing Server, a Processing Server Monitor is installed, which is used for monitoring the server. Document processing proper is done on the Processing Station.
Once the Processing Server is installed, you should configure it: start the server, 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 ($).
A description of the setup process is provided below.
Starting the Processing Server
To start the Processing Server:
- Launch the Processing Server Monitor by selecting Start → All Programs → ABBYY FlexiCapture 12 Servers → Processing Server.
- On the server tree, select ABBYY FlexiCapture Servers, right-click, and select Add Server...
- In the Add Processing Server dialog box, specify the server location (Network host or Local host).
- 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, as the use of the IP address 127.0.0.1 or the localhost expression will render 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.
- Click to start the Application Server.
Note: The Processing Server can be stopped by using hard or "soft" stop. If you need to stop the Processing Server, for example, for upgrade purposes or for moving a database, you can use the "soft" stop. For this, select Actions → Stop. In this case, all current tasks are completed and afterward the Processing Server is stopped. New tasks are not taken into processing.
To do a hard stop of the Processing Server, select Actions → Stop Immediately. In this case all current tasks will fail.
Starting the Processing Stations
To set up the Processing Stations:
- In the server tree, select Stations and click . The Add Stations dialog box appears. Select the desired stations from the overall list. You can also specify the name of the computer or its IP address. You can specify the name of the computer even if dynamic IP addresses are used. Use IP addresses if you experience problems accessing the DNS network.
- 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 - this flag means that the station is started automatically by the Processing Server; by default this option is selected;
Note: Frequent attempts to start too many stations may considerably slow down the Processing Server
- Required disk space - the minimum disk space required for the operation of the Processing Stations; if there is not enough free disk space, the station will be stopped. The space specified in the field should be three times as large as the maximum size of an image that can be in processing. The optimal value of the minimum disk space is the doubled 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 parameter 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 results of double verification as well as pre- and postprocessing tasks for the Web Verification Station;
- Custom processing - processing batch and document processing scripts;
- Export documents - document export tasks.
Note: The Processing Station can be stopped by using hard or "soft" stop. If you need to stop the Processing Station, for example, for upgrade purposes, you can use the "soft" stop. For this, select Actions → Stop. In this case, all current tasks are completed and afterward the Processing Station is stopped. New tasks are not taken into processing.
To do a hard stop of the Processing Station, select Actions → Stop Immediately. In this case all current tasks will fail.
The stations receive the permissions to process documents from the Processing Server when they connect to the server.
Creating station groups
You can isolate different tenants from one another at task level. To do so, create required Processing Station groups and then assign a desired group to each new tenant you create.
To create a station group:
- In the server tree, select Station groups and click . This will open the New Station Group dialog box.
- Specify a group name and select the desired stations from the overall list.
- Click OK.
The group will appear in the list and you will be able to specify it for tenants in tenants in Administration and Monitoring Console.
To change the name of a group or a list of stations, select the group in the list and click Edit Station Group... in the context menu. You also can add a station to the group by selecting the desired group in the Station Properties dialog box.
Setting up the Processing Server log
To set up the Processing Server log:
- Open the Processing Server Monitor Settings dialog box by selecting File → Settings....
- Specify which messages should be logged (Errors, Warnings, Information messages).
- Specify whether information about completed tasks should be deleted (Remove completed tasks from the list).
- Specify which messages will trigger logging information about the task.
Note: We do not recommend disabling 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.
- Click to view the task log. To save a task log as *.txt file, in the dialog box that opens click the Export Log... button.
Viewing task info
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 . If besides error message, the task log also contains informational messages, the task is marked with .
Besides the regular task processing log, the Processing Server and the Processing Station can keep a service log. ABBYY technical support staff may need information from this log when handing your support requests. Service logging will not slow down your Processing Server or Processing Station, but information contained in this log is only useful to ABBYY's technical support engineers, so we do not recommend that you have service logging permanently enabled. If a technical support engineer asks you for a service log, please follow these steps:
- 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).
- Select the Write processing log option and click OK.
- Once the log files are created, you can find them in %programdata%\ABBYY\FlexiCapture\12.0\FlexiBrSvc\Logs. Send copies of these files to the ABBYY technical support service.
- Disable service logging by clearing the Write processing log option and clicking OK.
Managing the Processing Server using command line
Processing Server can be operated via the command line. For command line operation, do the following:
- In the Start → Run Windows menu, type 'cmd' and click OK. A command line prompt window will appear;
- Type the path to the FlexiBRSvc.exe file (by default, "C:\Program Files\ABBYY FlexiCapture 12 Servers");
- Type "FlexiBRSvc Please obey" to enter the command mode. The commands are entered in the form of 'FlexiBRSvc Please '. The commands allow you to start or stop a station, display the stations list, start or stop the Processing Server, add or remove stations, view information about a station as well as to set server and station parameters;
- To show the list of allowed commands and other help information, type 'FlexiBRSvc.exe /?'.
For a more detailed description of all commands, see Description of Processing Server commands.