Windows, Linux operating systems
Image Server Administration Guide
Document Release Date: February 2015 Software Release Date: February 2015
Legal Notices
Warranty
The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.
The information contained herein is subject to change without notice.
Restricted Rights Legend
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.
Copyright Notice
© Copyright 2015 Hewlett-Packard Development Company, L.P.
Trademark Notices
Adobe™ is a trademark of Adobe Systems Incorporated.
Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.
UNIX® is a registered trademark of The Open Group.
This product includes an interface of the 'zlib' general purpose compression library, which is Copyright © 1995-2002 Jean-loup Gailly and Mark Adler.
Documentation Updates
The title page of this document contains the following identifying information:
l Software Version number, which indicates the software version.
l Document Release Date, which changes each time the document is updated.
l Software Release Date, which indicates the release date of this version of the software.
You can retrieve the most current product documentation from the Autonomy Knowledge Base on the Customer Support Site.
A document in the Knowledge Base displays a version number in its name, such as IDOL Server 7.5 Administration Guide. The version number applies to the product that the document describes. The document may also have a revision number in its name, such as IDOL Server 7.5 Administration Guide Revision 6. The revision number applies to the document and indicates that there were revisions to the document since its original release.
HP recommends that you periodically check the Knowledge Base for revisions to documents for the products your enterprise is using.
To access Autonomy documentation
1. Go to the Autonomy Customer Support site:
https://customers.autonomy.com 2. Click Login.
3. Type the login credentials that you were given, and then click Login.
The Customer Support Site opens.
4. Click Knowledge Base.
The Knowledge Base Search page opens.
5. Search or browse the Knowledge Base.
To search the knowledge base:
n In the Search box, type a search term or phrase and click Search.
Documents that match the query display in a results list.
To browse the knowledge base:
n Select one or more of the categories in the Browse list. You can browse by:
o Repository. Filters the list by Documentation produced by technical publications, or Solutions to Technical Support cases.
o Product Family. Filters the list by product suite or division. For example, you could retrieve documents related to the iManage, IDOL, Virage or KeyView product suites.
o Type. Filters the list by document type. For example, you could retrieve Guides, Help, Packages (ZIP files), or Release Notes.
o Format. Filters the list by document format. For example, you could retrieve documents in PDF or HTML format. Guides are typically provided in both PDF and HTML format.
6. To open a document, click its title in the results list.
To download a PDF version of a guide, open the PDF version, click the Download icon in the PDF reader, and save the PDF to another location.
To download a documentation ZIP package, click Get Documentation Package under the document title in the results list. Alternatively, browse to the desired ZIP package by selecting either the Packages document Type or the ZIP document Format from the Browse list.
Support
Autonomy Customer Support provides prompt and accurate support to help you quickly and effectively resolve any issue you may encounter while using Autonomy products.
Support services include access to the Customer Support Site (CSS) for online answers, expertise-based service by Autonomy support engineers, and software maintenance to ensure you have the most up-to-date technology.
To access the Customer Support Site l go to https://customers.autonomy.com
The Customer Support Site includes:
l Knowledge Base. The CSS contains an extensive library of end user documentation, FAQs, and technical articles that is easy to navigate and search.
l Case Center. The Case Center is a central location to create, monitor, and manage all your cases that are open with technical support.
l Download Center. Products and product updates can be downloaded and requested from the Download Center.
l Resource Center. Other helpful resources appropriate for your product.
To contact Autonomy Customer Support by e-mail or phone l go to http://www.autonomy.com/work/services/customer-support
About this PDF Version of Online Help
This document is a PDF version of the online help. This PDF file is provided so you can easily print multiple topics from the help information or read the online help in PDF format. Because this content was originally created to be viewed as online help in a web browser, some topics may not be formatted properly. Some interactive topics may not be present in this PDF version. Those topics can be successfully printed from within the online help.
Contents
Part 1: Getting Started 9
Chapter 1: Introduction 11
Image Server 11
OEM Certification 12
Image Analysis 12
Optical Character Recognition 12
Face Detection, Recognition, and Analysis 13
Object Detection 13
Object Class Recognition 14
Barcode Detection 14
Color Analysis 14
Skin Detection 14
Image Hash Generation 14
Intelligent Document Recognition 14
Analysis of Redacted Documents 15
Image Editing 15
Image Cropping 15
HP's IDOL Platform 15
System Architecture 15
Related Documentation 15
Chapter 2: Install Image Server 17
System Requirements 17
Install Image Server 17
Upgrade Image Server 18
Patch Image Server 18
Licenses 19
Display License Information 19
Revoke a Client License 20
Forcibly Revoke Licenses from Inaccessible Clients 21
Troubleshoot License Errors 21
Set Up Image Server Databases 23
Set Up the Internal Datastore File 23
Set Up a PostgreSQL Database on Windows 24
Set Up a MySQL Database on Linux 40
Distribute Image Server Operations 45
Install DAH 45
Configure DAH 45
Configure DAH with Child Image Servers 45
Configure Asynchronous Actions 46
Run DAH and Image Server 47
Chapter 3: Configure Image Server 48
The Image Server Configuration File 48
Default Configuration File Sections 48
Additional Configuration Sections 51
Modify Configuration Parameter Values 51
Enter Boolean Values 52
Enter String Values 52
Specify Multiple Values 52
Example Configuration File 53
Override Parameters at Runtime 54
Replace Configuration Sections 55
Replace Individual Parameters 55
Validate the Configuration File 55
Specify Modules to Enable 56
Customize Logging 57
Chapter 4: Start and Stop Image Server 59
Start Image Server 59
Stop Image Server 59
Verify Image Server is Running 60
GetStatus 60
GetLicenseInfo 60
Display Online Help 61
Chapter 5: Send Actions to Image Server 62
Send Actions to Image Server 62
Use the cURL Command-line Tool to Send Requests 62
Send Actions with a GET Method 62
Send Data with a POST Method 64
Application/x-www-form-urlencoded 64
Multipart/form-data 65
Use Asynchronous Actions 66
Event Handlers 67
Use XSL Templates to Transform Action Responses 69
Part 2: Image Server Operations 71
Chapter 6: Image Analysis Overview 73
Image File Format Restrictions 73
Extract File Metadata 73
Start Analysis 74
Retrieve Analysis Results 75
Analyze Action Response 75
Chapter 7: Perform Optical Character Recognition (OCR) 77
OCR Results 78
Example OCR Task Configurations 81
Improve OCR 81
Chapter 8: Detect, Recognize, and Analyze Faces 82
Set up a Face Analysis Task 82
Face Results 85
Example Face Task Configurations 88
Chapter 9: Detect Objects 90
Object Detection Results 92
Example Object Task Configurations 93
Improve Object Detection 94
Chapter 10: Recognize Object Classes 95
Set up an Object Classification Task 95
Restrict Classification to a Region 97
Object Class Detection and Localization 97
Object Class Recognition Results 99
Example ObjectClass Task Configurations 101
Improve Object Class Recognition 102
Chapter 11: Detect Barcodes 103
Barcode Detection Results 104
Example Barcode Task Configuration 105
Chapter 12: Analyze Image Colors 106
Color Analysis Results 107
Example Color Analysis Task Configurations 109
Chapter 13: Detect Skin 110
Skin Detection Results 111
Image Hashing Results 113
Example ImageHash Task Configuration 113
Chapter 15: Extract Information Using Intelligent Document Recognition (IDR) 114
IDR Results 116
Example IDR Task Configuration 118
Improve IDR 119
Chapter 16: Analyze Redacted Text 120
Redaction Analysis Results 121
Example Redaction Configuration 121
Chapter 17: Edit Images 123
Edit an Image 123
Specify the Page (Multi-Page Images Only) 124
Specify Editing Operations 124
Blur 124
Crop 125
Outline 125
SmartCrop 126
Specify the Regions to Edit 126
Ellipse 126
Rectangle 127
Polygon 127
Example XML 128
Run the EditImage Action 129
Example - Blur a Detected Face 130
Chapter 18: Manage Recognition Databases 133
Overview 133
Data Requirements 134
Image Quality Guidelines–Faces 134
Image Quality Guidelines–Objects 135
Create a Database 135
Train New Models 136
Train Existing Face Models 139
Delete a Database Model 141
Rename a Database Model 141
Delete a Database 142
Rename a Database 142
List the Models in a Database 143
Appendix A: IDR Templates 147
IDR Templates 147
Basic XML Structure 148
Operators 148
Common Field Tags for All Operators 148
Phrase 150
RegularExpression 152
Date 153
Amount 156
Address 157
Table 158
KeyValue 161
Or 162
Example IDR Template 163
Appendix B: Supported Languages 165
Appendix C: Supported Specialized Fonts 167
Glossary 168
Send Documentation Feedback 171
l "Introduction"
l "Install Image Server"
l "Configure Image Server"
l "Start and Stop Image Server"
l "Send Actions to Image Server"
Image Server 11
Image Analysis 12
HP's IDOL Platform 15
System Architecture 15
Related Documentation 15
Image Server
Image Server generates and analyzes image files. It allows you to construct your own image processing tasks, based on the following operations:
l Optical Character Recognition (OCR)
l face detection, recognition, and analysis
l clothing analysis
l 2-D and 3-D object detection
l object class recognition
l barcode detection
l color analysis
l skin detection
l image hash generation
l Intelligent Document Recognition (IDR)
l analysis of redacted documents
l image editing–blurring or outlining specific parts of an image, such as faces
l image cropping
Image Server can perform all operations on all standard image formats:
.TIFF .GIF1
.JPEG .BMP2 and .ICO
.PNG .PBM, .PGM, and .PPM
Additionally, Image Server uses HP KeyView to support other document formats, including:
.DOC and .DOCX .XLS and .XLSX .PPT and .PPTX .ODT
.RTF
Note: Some operations are only partially supported for document formats other than PDF. For more information, see "Image File Format Restrictions" on page 73.
Note: You can also use KeyView directly to process documents and then send the resulting data to Image Server. This is equivalent to processing documents using Image Server only.
OEM Certification
The Image Server works in OEM licensed environments.
Image Analysis
Image analysis encompasses a range of operations. This section briefly outlines the different operations that Image Server can perform.
Optical Character Recognition
Image Server performs OCR to convert text in an image into a text file. OCR allows you to convert scanned documents, pictures or photos into a computer-readable format to make it easier to store and search the documents.
Image Server OCR:
l accepts photos of documents, as well as scanned documents, and automatically adjusts for documents that are rotated or offset by small amounts.
l produces output in several different formats.
l provides options to increase the accuracy of the OCR process for different types of text, such as different fonts.
l provides a variety of other options to improve OCR for your document set.
l searches images for text-like regions, and only performs OCR on those regions.
l supports many languages, font types, and character sets.
l automatically merges PDF text elements into the output.
Face Detection, Recognition, and Analysis
Image Server can detect faces in images, identify those that match models in databases, and analyze all faces for information such as gender, age, ethnicity, facial expression, and so on. Image Server can also locate the region containing a person's clothing and identify its dominant colors.
Object Detection
Image Server uses a set of user-trained templates to detect predefined objects in an image file. These objects can be two-dimensional or three-dimensional. Image Server can detect a two-dimensional object even when it is subject to 2-D similarity transformations or perspective transformations.
2-D object with 2-D similarity transform
For example, a company logo on a scanned document.
Image Server can still detect the logo when it is subject to 2- D similarity transformations such as rotation and scaling.
2-D object with perspective transform
For example, a photo of a sign displaying a company logo.
Perspective transformations result from viewing the object from any angle other than directly perpendicular to its plane.
This can result in skewing of the image. Perspective transformations often occur in photos of objects when the camera axis is not directly aligned with the object.
3-D object
For example, a photo of product packaging.
If you supply sufficient training images, Image Server can detect a 3-D object from any angle.
Object Class Recognition
You can train Image Server to detect objects that belong to a particular object class. For example, if trained to identify cars as a class, Image Server recognizes a broad range of cars (as opposed to a particular instance of a car, which can be performed by the object detection operation).
Barcode Detection
Image Server can detect one-dimensional and two-dimensional barcodes in documents and photos of documents. (Two-dimensional barcodes include QR codes.) For each barcode, it returns the barcode type, location in the document, and the information that it encodes.
Color Analysis
Image Server can analyze a color image to identify the dominant colors, returning either a qualitative or quantitative description (for example, "green" or "0 255 127").
Skin Detection
Image Server can identify the proportion of an image that contains skin tone.
Image Hash Generation
Image Server can generate an image hash that describes the approximate color distribution of the image. The hash is suitable for indexing into HP IDOL Server.
Intelligent Document Recognition
Image Server can perform OCR on an image, and match features of the image to an Intelligent
Document Recognition (IDR) template. For example, this feature can analyze scanned copies of forms
Analysis of Redacted Documents
Image Server performs analysis on documents where some text has been redacted or partially obscured. It can compare a text file with the OCR of a redacted image to produce a text file that includes the redaction.
Image Editing
Image Server can blur or outline specified regions of an image.
Image Cropping
Image Server automatically crops images that have a border around a central image, such as the residual background obtained when scanning an image on a flat-bed scanner.
HP's IDOL Platform
At the core of Image Server is HP’s Intelligent Data Operating Layer (IDOL).
IDOL gathers and processes unstructured, semi-structured, and structured information in any format from multiple repositories using IDOL connectors and a global relational index. It can automatically form a contextual understanding of the information in real time, linking disparate data sources together based on the concepts contained within them. For example, IDOL can automatically link concepts contained in an e-mail message to a recorded phone conversation, that can be associated with a stock trade. This information is then imported into a format that is easily searchable, adding advanced retrieval, collaboration, and personalization to an application that integrates the technology.
For more information on IDOL, refer to the IDOL Getting Started Guide.
System Architecture
Image Server uses the Autonomy Content Infrastructure (ACI) Client API to communicate with custom applications that retrieve data using HTTP commands. It communicates over HTTP using XML, and can adhere to SOAP.
Related Documentation
The following documents provide more details on Image Server.
l Image Server Reference
The Image Server Reference describes the ACI actions and configuration parameters that you can use with Image Server.
l License Server Administration Guide
This guide describes how you can use a License Server to license multiple Autonomy services.
System Requirements 17
Install Image Server 17
Upgrade Image Server 18
Patch Image Server 18
Licenses 19
Set Up Image Server Databases 23
Distribute Image Server Operations 45
System Requirements
HP recommends the following hardware specifications.
l a minimum of two dedicated CPUs - XEON 3 GHz or above
l 4 GB RAM
l a dedicated SCSI disk
l 100 GB disk space
Install Image Server
Image Server is installed by the IDOL Server installer. Perform an Advanced Install and select the Image Server component. For more information about using this installer, refer to the IDOL Server Getting Started Guide.
You can also install Image Server using the Image Server Chef package.
After installing Image Server, HP recommends checking the Autonomy Customer Support Site and installing the latest patch, if one has been released. For information about how to install a patch, see
"Patch Image Server" on the next page.
Upgrade Image Server
If you have previously installed Image Server and need to upgrade to the latest version, follow these steps.
To upgrade to the latest version of Image Server
1. Make a backup of the following files from your current installation:
n The Image Server configuration file, imageserver.cfg.
n The Image Server datastore, which contains your training data. By default, the datastore is named imageserver.db.
2. Perform a clean installation of the latest version of Image Server, as described in the IDOL Server Getting Started Guide.
3. Check the Autonomy Customer Support Site and install the latest patch, if one has been released:
a. Download the latest patch from the Autonomy Customer Support Site. Patches are cumulative, so you only need to download the latest patch.
b. Unzip the files into the Image Server installation directory, overwriting any files that already exist.
4. Copy your configuration file and datastore into the new installation, overwriting the files that were installed.
Patch Image Server
Occasionally Autonomy may releases patches to fix issues in Image Server. To install a patch, follow these steps.
Note: Only use this procedure if you are running the latest version of Image Server. To upgrade to the latest version of Image Server, see "Upgrade Image Server" above.
To install a patch
1. Stop Image Server, if it is running.
2. Make a backup of the following files from your current installation:
n The Image Server configuration file, imageserver.cfg.
n The Image Server datastore, which contains your training data. By default, the datastore is named imageserver.db.
3. Download the latest patch from the Autonomy Customer Support Site. Patches are cumulative, so you only need to download the latest version.
4. Unzip the files into the Image Server installation directory, overwriting any files that already exist.
5. Copy your configuration file and datastore back into the Image Server installation directory.
6. You can now start Image Server.
Licenses
An HP License Server controls the license that enables you to run HP solutions. You must have a running HP License Server that resides on a machine with a static, known IP address, MAC address, or host name.
You can revoke licenses at any time if, for example, you want to reallocate them to different clients or if you want to change a client IP address.
Caution: Taking any of the following actions causes the licensed module to become inoperable.
You must not:
l change the IP address of the machine on which a licensed module runs (if you use an IP address to lock your license)
l change the service port of a module without first revoking the license
l replace the network card of a client without first revoking the license
l remove the contents of the license and uid directories
All modules produce a license.log and a service.log file. If a product fails to start, examine the contents of these files before submitting a support ticket.
Display License Information
You can verify which modules you have licensed by sending the following action from a Web browser to the running License Server.
http://LicenseServerhost:port/action=LicenseInfo where,
LicenseServerhost is the IP address of the machine where License Server resides.
port is the ACI port of License Server (specified by the Port parameter in the License Server configuration file's [Server] section).
In response, License Server returns the requested license information. This example describes a license to run four instances of IDOL server.
<?xml version="1.0" encoding="UTF-8" ?>
<autnresponse xmlns:autn="http://schemas.autonomy.com/aci/">
<action>LICENSEINFO</action>
<response>SUCCESS</response>
<responsedata>
<LicenseDiSH>
<LICENSEINFO>
<autn:Product>
<autn:ProductType>IDOLSERVER</autn:ProductType>
<autn:TotalSeats>4</autn:TotalSeats>
<autn:SeatsInUse>0</autn:SeatsInUse>
</autn:Product>
</LICENSEINFO>
</LicenseDiSH>
</responsedata>
</autnresponse>
Revoke a Client License
After you set up licensing, you can revoke licenses at any time if, for example, you want to reallocate them to different clients or if you want to change a client IP address.
To revoke a license
1. Stop the Autonomy solution that uses the license.
2. Execute the following action from a command prompt.
InstallDir/ExecutableName[.exe] –revokelicense –configfile cfgFilename
This action returns the license to the License Server.
You can send the LicenseInfo action from a Web browser to the running License Server to check for free licenses. In this sample output from the action, one IDOL server license is available for allocation to a client.
<autn:Product>
<autn:ProductType>IDOLSERVER</autn:ProductType>
<autn:Client>
<autn:IP>192.123.51.23</autn:IP>
<autn:ServicePort>1823</autn:ServicePort>
</autn:Client>
<autn:TotalSeats>2</autn:TotalSeats>
<autn:SeatsInUse>1</autn:SeatsInUse>
</autn:Product>
Forcibly Revoke Licenses from Inaccessible Clients
If a client machine becomes inaccessible, you can revoke a license on it by sending the next ACI action to the License Server. The AdminRevokeLicense action frees the license from the inaccessible machine.
Note: Call the AdminRevokeLicense function only for inaccessible client machines. Otherwise, the module shuts down and becomes inaccessible.
http://LicenseServerhost:port/action=AdminRevokeLicense&ClientProductType=productTy pe&ClientIP=clientHost&ClientServicePort=clientPort
where,
productType is the product type of the HP solution whose license you want to revoke from the inaccessible client.
clientHost is the IP address of the inaccessible client machine.
clientPort is the port by which service actions are sent to the HP module on the inaccessible client (specified by the ServicePort parameter in the module configuration file's [Service] section).
Troubleshoot License Errors
The table contains explanations for typical licensing-related error messages.
Error message Explanation
Error: Failed to update license from the license server. Your license cache details do not match the current service configuration.
Shutting the service down.
The configuration of the service has been altered. Verify that the service port and IP address have not changed since the service started.
Error: License for ProductName is invalid.
Exiting.
The license returned from the License Server is invalid. Ensure that the license has not expired.
Error: Failed to connect to license server using cached licensed details.
Cannot communicate with the License Server.
The product still runs for a limited period, however you should verify whether your License Server is still available.
License-related error messages
Error message Explanation Error: Failed to connect to license server.
Error code is SERVICE: ErrorCode
Failed to retrieve a license from the License Server or from the backup cache. Ensure that your License Server can be contacted.
Error: Failed to decrypt license keys. Please contact HP support. Error code is
SERVICE:ErrorCode
Provide HP Support with the exact error message and your license file.
Error: Failed to update the license from the license server. Shutting down
Failed to retrieve a license from the License Server or from the backup cache. Ensure that your License Server can be contacted.
Error: Your license keys are invalid. Please contact HP support. Error code is
SERVICE:ErrorCode
Your license keys appear to be out of sync.
Provide HP Support with the exact error message and your license file.
Failed to revoke license: No license to revoke from server.
The License Server cannot find a license to revoke.
Failed to revoke license from server
LicenseServer Host:LicenseServerPort. Error code is ErrorCode
Failed to revoke a license from the License Server. Provide HP Support with the exact error message.
Failed to revoke license from server. An instance of this application is already running.
Please stop the other instance first.
You cannot revoke a license from a running service. Stop the service and try again.
Failed to revoke license. Error code is SERVICE:ErrorCode
Failed to revoke a license from the License Server. Provide HP Support with the exact error message.
Your license keys are invalid. Please contact HP Support. Error code is
ACISERVER:ErrorCode
Failed to retrieve a license from the License Server. Provide HP Support with the exact error message and your license file.
Your product ID does not match the generated ID.
Your installation appears to be out of sync.
Forcibly revoke the license from the License Server and rename the license and uid directories.
Your product ID does not match this configuration.
The service port for the module or the IP address for the machine appears to have changed. Check your configuration file.
License-related error messages, continued
Set Up Image Server Databases
Image Server uses databases to store models that it requires for recognition operations, including face recognition, object class recognition, and object detection. Image Server supports multiple databases, which are all stored in a single internal datastore file or an external PostgreSQL or MySQL database server.
Multiple Image Servers can share an external database server. (Sharing an internal datastore file is not supported.)
Set Up the Internal Datastore File
Using the default configuration file, Image Server generates a datastore file (imageserver.db) in the installation directory when you first run an action that requires a database. You can change the name and location of the datastore file or use a datastore file from an earlier version of Image Server.
Note: To use a datastore file, the DatabaseType parameter in the [Database] configuration section must be set to internal. This is the default setting.
l To use a datastore file from Image Server 10.2 or earlier, you must use the upgrade procedure described in the Image Server 10.3 Database Upgrade Technical Note.
l To use a datastore file from Image Server 10.3 or later, point Image Server 10.9 to the existing file (see following procedure). When Image Server 10.9 opens a datastore file from an earlier version, it automatically updates it to the latest version. This means that earlier versions of Image Server are no longer able to read the file.
Caution: If you need to use a datastore file with an earlier version of Image Server, do not open it using a later version.
To customize the datastore file
1. Open the Image Server configuration file in a text editor.
2. In the [Paths] section, set the DatabasePath parameter to the file name and path of either an existing datastore file or the new file that you want Image Server to generate.
3. (Optional) To restrict database administrative actions (see "Manage Recognition Databases" on page 133) to administrative clients only, set the AdminClients parameter in the [Server] section to the IP addresses or host names of these clients.
4. Save and close the configuration file.
5. Restart Image Server for your changes to take effect.
For instructions on adding and managing individual databases in the datastore file, see "Manage Recognition Databases" on page 133.
Set Up a PostgreSQL Database on Windows
To use Image Server with a PostgreSQL database, you must download and install a PostgreSQL server and ODBC driver, and configure Image Server to connect to the database through the driver.
Supported Windows platforms:
l Windows 64-bit
Note: Other platforms might work but have not been tested.
Minimum requirements:
l PostgreSQL version 9.x
The procedure describes setting up the database server using the psql command-line tool. If you prefer, you can use the pgAdmin graphical user interface. For more information, refer to the pgAdmin
documentation on www.pgadmin.org.
To set up a PostgreSQL Image Server database on Windows
1. Download and install a PostgreSQL 9.x server. For instructions, refer to the PostgreSQL documentation on www.postgresql.org.
n Ensure that the installation includes the PostgreSQL Unicode ODBC driver.
n During installation, set up a user account with superuser privileges.
Note: Once installed, the PostgreSQL server appears in the Services tab in Windows Task Manager.
2. Add the PostgreSQL bin directory path to the PATH environmental variable:
a. In the Windows Start menu, right-click on Computer.
A menu opens.
b. Click Properties.
The System window opens.
c. Click Advanced system settings in the list on the left.
The System Properties dialog box opens.
d. Click Environment Variables.
The Environment Variables dialog box opens.
e. Select Path from the System variables list and click Edit.
The Edit System Variable dialog box opens.
f. In the Variable value box, add a semi-colon (;) to the end of the list and then add the absolute directory path to the PostgreSQL bin directory.
g. In the Edit System Variable dialog box, click OK to close the box.
h. In the System Properties dialog box, click OK to close the box.
Note: This step enables you to use the command psql to start the PostgreSQL command- line tool (psql) from the Windows Command Prompt. If the directory path is not added to the PATH variable, you must specify the psql.exe file path in the Command Prompt to start psql.
3. Open the psql command-line tool:
a. In the Windows Command Prompt, run the command:
psql -U userName
b. Enter your password when prompted.
4. Run a CREATE DATABASE command to create a new database. Specify the following database settings.
Database name Any name.
Encoding Must be Unicode–either UTF8 or UCS2.
Collation Any that is compatible with the encoding.
Locale Any that is compatible with the encoding.
For example:
CREATE DATABASE myDatabase WITH ENCODING 'UTF8' LC_COLLATE='English_United King dom' LC_CTYPE='English_United Kingdom';
Note: Ensure that you include the semi-colon (;) at the end of the command.
5. Connect to the new database using the command:
\c databaseName
6. Run the postgres.sql script provided in the Image Server installation directory. This script sets up the database schema that Image Server requires. The schema is inserted inside the public schema.
a. HP recommends running the following command to ensure that the script stops running if it encounters an error:
\set ON_ERROR_STOP on
b. Run the script using the command:
\i 'path/postgres.sql' where path is the script file path.
Note: Replace backslashes in the file path with forward slashes. The psql command-line tool does not recognize backslashes in file paths.
7. Grant privileges to the user that Image Server will connect as. Required privileges are:
Select All tables
Insert All tables
Update All tables
Delete All tables
Execute All functions and stored procedures If security is not a consideration, grant all privileges.
For example:
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO userName;
GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public TO userName;
where,
userName is the user name that Image Server will connect as.
8. Open the Data Sources (ODBC) program:
a. In the Windows Control Panel, click System and Security.
The System and Security window opens.
b. Click Administrative Tools.
The Administrative Tools window opens.
c. Double-click Data Sources (ODBC).
The ODBC Data Source Administrator dialog box opens.
9. In the User DSN tab, click Add... .
The Create New Data Source dialog box opens.
10. Select the PostgreSQL Unicode driver from the list and click Finish.
The PostgreSQL Unicode ODBC Driver (psqlODBC) Setup dialog box opens.
11. Complete the data source information fields:
Data Source
The data source name (DSN). Image Server uses this string to connect to the database server.
Database The name of the database that you created in Step 2.
Server The IP address or hostname of the server that the database server is installed on.
User Name The user name to connect to the database server with.
Description An optional description for the data source.
SSL Mode Whether to use SSL to connect to the database server.
Note: To enable SSL mode, you must also configure the database server to support SSL. For instructions, refer to the PostgreSQL documentation.
Port The port to use to communicate with the database server.
Password The password for the user account that connects to the database server.
12. Click Datasource.
The Advanced Options (driverName) 1/2 dialog box opens.
13. Click Page 2.
The Advanced Options (driverName) 2/2 dialog box opens.
14. Select the bytea as LO check box.
15. Click Apply and then OK.
The Advanced Options (driverName) 2/2 dialog box closes.
16. In the PostgreSQL Unicode ODBC Driver (psqlODBC) Setup dialog box, click Test to test the connection.
The Connection Test box opens containing a message describing whether the connection was successful. If the connection failed, use the information in the message to resolve any issues.
17. Click OK to close the Connection Test box.
18. In the PostgreSQL Unicode ODBC Driver (psqlODBC) Setup dialog box, click Save to close the dialog box.
19. In the ODBC Data Source Administrator dialog box, click OK to close the dialog box.
20. Ensure that Image Server is not running.
21. Open the Image Server configuration file (imageserver.cfg) with a text editor.
22. Add a [Database] section to the configuration file if it does not already exist, then set the following parameters.
a. Set DatabaseType to postgres.
b. Set ODBCConnectionString to the connection string to connect to the datasource you created in Step 9.
A standard connection string for the PostgreSQL Unicode ODBC driver uses the format:
Driver = {PostgreSQL UNICODE}; Server = IPAddress; Port = port; Database = m yDatabase; Uid = myUsername; Pwd = myPassword;
Alternatively, if you included the password in the data source, you can set this parameter to the name of the data source. Use the format DSN=dataSourceName;
For example:
ODBCConnectionString=DSN=PostgresSQL35W;
23. Save and close the configuration file.
24. Start Image Server.
For instructions on adding and managing individual databases in the database server, see "Manage Recognition Databases" on page 133.
Set Up a PostgreSQL Database on Linux
To use Image Server with a PostgreSQL database, you must install a PostgreSQL server and ODBC driver, and configure Image Server to connect to the database through the driver.
Supported Linux and UNIX platforms:
l CentOS 6
Note: Other platforms might work but have not been tested.
Minimum requirements:
l PostgreSQL version 9.x
l unixODBC version 2.2.14 or later
The procedure describes how to set up a PostgreSQL database on a CentOS 6 distribution.
To set up a PostgreSQL Image Server database on Linux 1. Edit the .repo file to exclude PostgreSQL:
a. Open the CentOS-Base.repo file with a text editor. The file is usually located in /etc/yum.repos.d.
b. Add the following line to the [base] and [updates] sections:
exclude=postgresql*
2. Download the PostgreSQL 9.x RPM file for your Linux distribution from the PostgreSQL Yum repository on www.postgresql.org. For example:
curl -O http://yum.postgresql.org/9.3/redhat/rhel-5-x86_64/pgdg-centos93-9.3-1.
noarch.rpm
3. Install the PostgreSQL RPM file by running the command:
sudo rpm -i RPM
where RPM is the name of the downloaded RPM file.
4. Install the required packages from the RPM file. Ensure that these include the ODBC driver. For example:
sudo yum install postgresql93 postgresql93-odbc
5. Add the PostgreSQL bin directory path to the PATH environmental variable by running the
command:
export PATH=$PATH:binDirectoryPath
Note: This step enables you to use the command psql to start the PostgreSQL command- line tool (psql) from the terminal. If the directory path is not added to the PATH variable, you must specify the psql.exe file path in the terminal to start psql.
6. Initialize and start PostgreSQL.
a. Initialize the server by running the command:
sudo service postgresql-9.3 initdb b. Start the server by running the command:
sudo service postgresql-9.3 start
7. Log on to the psql command-line tool by running the command:
sudo -u postgres psql
8. Run a CREATE DATABASE command to create a new database. Specify the following database settings.
Database name Any name.
Encoding Must be Unicode–either UTF8 or UCS2.
Collation Any that is compatible with the encoding.
Locale Any that is compatible with the encoding.
For example:
CREATE DATABASE myDatabase WITH ENCODING 'UTF8' LC_COLLATE='en_US.UTF-8' LC_CTY PE='en_US.UTF-8';
Note: Ensure that you include the semi-colon (;) at the end of the command.
9. Connect to the new database using the command:
\c databaseName
10. Run the postgres.sql script provided in the Image Server installation directory. This script sets up the database schema that Image Server requires. The schema is inserted inside the public schema.
a. HP recommends running the following command to ensure that the script stops running if it encounters an error:
\set ON_ERROR_STOP on
b. Run the script using the command:
\i 'path/postgres.sql' where path is the script file path.
11. Grant privileges to the user that Image Server will connect as. Required privileges are:
Select All tables
Insert All tables
Update All tables
Delete All tables
Execute All functions and stored procedures If security is not a consideration, grant all privileges.
For example:
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO userName;
GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public TO userName;
where,
userName is the user name that Image Server will connect as.
12. Install unixODBC driver manager version 2.2.14 or later. If using the Yum package manager, run the command:
sudo yum install unixODBC 13. Configure the data source.
a. Open the odbc.ini file with a text editor. This file is usually stored in the /etc directory.
b. Add the data source name in square brackets. The name can be any string. For example:
[PostgreSQL_1]
c. Under the data source name, set the following parameters.
Parameter Description
Driver The driver to use.
ServerName The IP address or hostname of the server that the database server is installed on.
Port The port to use to communicate with the database server.
UserName The user name to connect to the database server with.
Password The password for the user account that connects to the database server.
Database The name of the database that you created in Step 2.
ByteAsLongVarBinary You must set this parameter to 1.
Caution: If this value is not set to 1, Image Server fails to start.
For example:
[PostgreSQL_1]
Driver=PostgreSQL ServerName=localhost Port=5432
UserName=postgres Password=password Database=myDatabase ByteAsLongVarBinary=1
Note: You can set other parameters in this file, but these have not been tested with Image Server.
d. Save and close the file.
14. Configure the ODBC driver.
a. Open the odbcinst.ini file with a text editor. This file is usually stored in the /etc directory.
b. If not already present, add the database server name in square brackets. For example:
[PostgreSQL]
c. Under the database server name, set the following parameters.
Parameter Description
Description A description of the driver instance.
Driver64 The location of the PostgreSQL driver library file.
Setup64 The location of the driver installer file.
FileUsage Set this parameter to 1.
For example:
[PostgreSQL]
Description=ODBC for PostgreSQL
Driver64=/usr/pgsql-9.3/lib/psqlodbc.so Setup64=/usr/lib64/libodbcpsqlS.so FileUsage=1
Note: You can set other parameters in this file, but these have not been tested with Image Server.
d. Save and close the file.
15. Ensure that Image Server is not running.
16. Open the Image Server configuration file with a text editor.
17. Add a [Database] section to the configuration file if it does not already exist, then set the following parameters.
a. Set DatabaseType to postgres.
b. Set ODBCConnectionString to the connection string to connect to the datasource you created in Step 9.
A standard connection string for the PostgreSQL Unicode ODBC driver uses the format:
Driver = {PostgreSQL UNICODE}; Server = IPAddress; Port = port; Database = m yDatabase; Uid = myUsername; Pwd = myPassword;
Alternatively, if you included the password in the data source, you can set this parameter to the name of the data source. Use the format DSN=dataSourceName;
For example:
ODBCConnectionString=DSN=PostgresSQL_1;
c. Set ODBCDriverManager to the unixODBC Driver Manager shared object file. For example:
ODBCDriverManager=libodbc.so 18. Save and close the configuration file.
19. Start Image Server.
For instructions on adding and managing individual databases in the database server, see "Manage Recognition Databases" on page 133.
Set Up a MySQL Database on Windows
To use Image Server with a MySQL database, you must download and install a MySQL server and ODBC driver, and configure Image Server to connect to the database through the driver.
Supported Windows platforms:
l Windows 64-bit
Note: Other platforms might work but have not been tested.
Minimum requirements:
l MySQL versions 5.x (other MySQL versions might work but are not tested) To set up a MySQL Image Server database on Windows
1. Download and install a MySQL 5.x server and MySQL Connector/ODBC 5.x (which contains the Unicode driver). For instructions, refer to the MySQL documentation on www.mysql.com.
n During installation, set up a user account with superuser privileges.
Note: Once installed, the MySQL server appears in the Services tab in Windows Task Manager.
2. Add the MySQL bin directory path to the PATH environmental variable:
a. In the Windows Start menu, right-click on Computer.
A menu opens.
b. Click Properties.
The System window opens.
c. Click Advanced system settings in the list on the left.
The System Properties dialog box opens.
d. Click Environment Variables.
The Environment Variables dialog box opens.
e. Select Path from the System variables list and click Edit.
The Edit System Variable dialog box opens.
f. In the Variable value box, add a semi-colon (;) to the end of the list and then add the absolute directory path to the MySQL bin directory.
g. In the Edit System Variable dialog box, click OK to close the box.
h. In the System Properties dialog box, click OK to close the box.
Note: This step enables you to use the command mysql to start the mysql command-line tool from the Windows Command Prompt. If the directory path is not added to the PATH variable, you must specify the mysql.exe file path in the Command Prompt to start psql.
3. Open the mysql command line tool:
a. In the Windows Command Prompt, run the command:
mysql -u userName -p
b. Enter your password when prompted.
4. Run a CREATE DATABASE command to create a new database. Specify the following database settings.
Database name Any name.
Character set Must be Unicode–either UTF8 or UCS2.
Collation Any that is compatible with the encoding.
For example:
CREATE DATABASE myDatabase CHARACTER SET utf8 COLLATE utf8_unicode_ci;
Note: Ensure that you include the semi-colon (;) at the end of the command.
5. Run the my.sql script provided in the Image Server installation directory. This script sets up the
database schema that Image Server requires.
a. Close the mysql command-line tool:
quit
b. In the Windows Command Prompt, run the following command:
mysql -u userName -p -v -D databaseName -e "source path/my.sql"
where,
userName is the MySQL user name.
databaseName is the name of the database you created in Step 2.
path is the path to the my.sql file.
Note: Running the script non-interactively from the terminal ensures that the script terminates if an error occurs.
c. Enter your password when prompted.
6. Grant privileges to the user that Image Server will connect as. Required privileges are:
Select All tables
Insert All tables
Update All tables
Delete All tables
Execute All functions and stored procedures If security is not a consideration, grant all privileges.
a. Start the mysql command-line tool:
mysql
b. Run the GRANT commands:
GRANT SELECT, INSERT, UPDATE, DELETE ON databaseName.* TO userName;
GRANT EXECUTE ON databaseName.* TO userName;
where,
databaseName is the name of the database you created in Step 2.
userName is the user name that Image Server will connect as.
c. Close the mysql command-line tool:
quit
7. Open the Data Sources (ODBC) program:
a. In the Windows Control Panel, click System and Security.
The System and Security window opens.
b. Click Administrative Tools.
The Administrative Tools window opens.
c. Double-click Data Sources (ODBC).
The ODBC Data Source Administrator dialog box opens.
8. In the User DSN tab, click Add... .
The Create New Data Source dialog box opens.
9. Select the MySQL ODBC Unicode driver from the list and click Finish.
The MySQL Connector/ODBC Data Source Configuration dialog box opens.
10. Complete the Connection Parameters fields:
Data Source Name
The data source name (DSN). Choose any string. Image Server can use this string to connect to the database server.
Description An optional description for the data source.
TCP/IP Server
The IP address or hostname of the server that the database server is installed on.
Port The port to use to communicate with the database server.
User The user name to connect to the database server with.
Password The password for the user account that connects to the database server.
Database The name of the database that you created in Step 2.
11. Click Test to test the connection.
The Connection Test box opens containing a message describing whether the connection was successful. If the connection failed, use the information in the message to resolve any issues.
12. Click OK to close the Connection Test box.
13. In the MySQL Connector/ODBC Data Source Configuration dialog box, click OK to close the dialog box.
14. In the ODBC Data Source Administrator dialog box, click OK to close the dialog box.
15. Ensure that Image Server is not running.
16. Open the Image Server configuration file with a text editor. In the [Database] section, set the following parameters.
a. Set DatabaseType to mysql.
b. Set ODBCConnectionString to the connection string to connect to the datasource you created in Step 9.
A standard connection string for the MySQL Unicode ODBC driver uses the format:
Driver = {MySQL ODBC 5.x UNICODE Driver}; Server = IPAddress; Database = myD atabase; User = myUsername; Password = myPassword; Option = 3;
Alternatively, if you included the password in the data source, you can set this parameter to the name of the data source. Use the format DSN=dataSourceName;
For example:
ODBCConnectionString=DSN=MySQL_1;
17. Save and close the configuration file.
18. Start Image Server.
For instructions on adding and managing individual databases in the database server, see "Manage Recognition Databases" on page 133.
Set Up a MySQL Database on Linux
To use Image Server with a MySQL database, you must install a MySQL server and ODBC driver, and configure Image Server to connect to the database through the driver.
Supported Linux and UNIX platforms:
l CentOS 6
Note: Other platforms might work but have not been tested.
Minimum requirements:
l MySQL versions 5.x (other MySQL versions might work but are not tested)
l unixODBC version 2.2.14 or later
To set up a MySQL Image Server database on Linux
1. Install a MySQL server. (Ensure that the package includes the mysql command-line tool.) For instructions, refer to the MySQL documentation on www.mysql.com.
3. Add the MySQL bin directory path to the PATH environmental variable by running the command:
export PATH=$PATH:binDirectoryPath
Note: This step enables you to use the command mysql to start the mysql command-line tool from the terminal. If the directory path is not added to the PATH variable, you must specify the mysql.exe file path in the terminal to start mysql.
2. Start the mysql command-line tool. In the terminal, run the command:
mysql
3. Run a CREATE DATABASE command to create a new database. Specify the following database settings.
Database name Any name.
Character set Must be Unicode–either UTF8 or UCS2.
Collation Any that is compatible with the encoding.
For example:
CREATE DATABASE myDatabase CHARACTER SET utf8 COLLATE utf8_unicode_ci;
Note: Ensure that you include the semi-colon (;) at the end of the command.
4. Run the my.sql script provided in the Image Server installation directory. This script sets up the database schema that Image Server requires.
a. Close the mysql command-line tool:
quit
b. In the terminal, run the command:
mysql -u userName -p -v -D databaseName -e "source path/my.sql"
where,
userName is the MySQL user name.
databaseName is the name of the database you created in Step 3.
path is the script file path.
Note: Running the script non-interactively from the terminal ensures that the script terminates if an error occurs.
5. Grant privileges to the user that Image Server will connect to the MySQL server as. Required privileges are:
Select All tables
Insert All tables
Update All tables
Delete All tables
Execute All functions and stored procedures If security is not a consideration, grant all privileges.
a. Start the mysql command-line tool:
mysql
b. Run the GRANT commands:
GRANT SELECT, INSERT, UPDATE, DELETE ON databaseName.* TO username;
GRANT EXECUTE ON databaseName.* TO username;
where,
databaseName is the name of the database you created in Step 2.
userName is the user name that Image Server will connect as.
c. Close the mysql command-line tool:
quit
6. Install unixODBC driver manager version 2.2.14 or later. If you have the relevant Yum repository, you can run the command in the terminal:
sudo yum install unixODBC
7. Install the MySQL driver. If you have the relevant Yum repository, you can run the command in the
terminal:
sudo yum install mysql-connector-odbc 8. Configure the data source.
a. Open the odbc.ini file with a text editor. This file is usually stored in the /etc directory.
b. Add the data source name in square brackets. The name can be any string. For example:
[MySQL_1]
c. Under the data source name, set the following parameters.
Parameter Description Driver The driver to use.
Server The IP address or hostname of the server that the database server is installed on.
Port The port to use to communicate with the database server.
User The user name to connect to the database server with.
Password The password for the user account that connects to the database server.
Database The name of the database that you created in Step 3.
For example:
[MySQL_1]
Driver=MySQL Server=localhost Port=5432
User=mysql
Password=password Database=myDatabase
Note: You can set other parameters in this file, but these have not been tested with Image Server.
d. Save and close the file.
9. Configure the ODBC driver.
a. Open the odbcinst.ini file with a text editor. This file is usually stored in the /etc directory.
b. If not already present, add the database server name in square brackets. For example:
[MySQL]
a. Set the following parameters.
Parameter Description
Description A description of the driver instance.
Driver64 The location of the MySQL driver library file.
Setup64 The location of the driver installer file.
FileUsage Set this parameter to 1.
For example:
[MySQL]
Description=ODBC for MySQL
Driver64=/usr/lib64/libmyodbc5.so Setup64=/usr/lib64/libodbcmyS.so FileUsage=1
Note: You can set other parameters in this file, but these have not been tested with Image Server.
b. Save and close the file.
10. Ensure that Image Server is not running.
11. Open the Image Server configuration file with a text editor. In the [Database] section, set the following parameters.
a. Set DatabaseType to mysql.
b. Set ODBCConnectionString to the connection string to connect to the datasource you created in Step 9.
A standard connection string for the MySQL Unicode ODBC driver uses the format:
Driver = {MySQL ODBC 5.x UNICODE Driver}; Server = IPAddress; Database = myD atabase; User = myUsername; Password = myPassword; Option = 3;
Alternatively, if you included the password in the data source, you can set this parameter to the name of the data source. Use the format DSN=dataSourceName;
For example:
ODBCConnectionString=DSN=MySQL_1;
c. Set ODBCDriverManager to the unixODBC Driver Manager shared object file. For example:
ODBCDriverManager=libodbc.so 12. Save and close the configuration file.
13. Start Image Server.
For instructions on adding and managing individual databases in the database server, see "Manage Recognition Databases" on page 133.
Distribute Image Server Operations
In large systems where you want to process a very large number of documents, you can use multiple Image Server instances. In this case, you can use a Distributed Action Handler (DAH) to distribute actions to each Image Server, to ensure that each Image Server receives a similar number of requests.
Install DAH
You can use the IDOL Server installer to install the DAH. For more information about installing the DAH, refer to the Distributed Action Handler Administration Guide.
Configure DAH
This section describes the configuration settings that are required in the DAH configuration file when you want to distribute to multiple Image Servers.
Configure DAH with Child Image Servers
When using Image Server, you must run DAH in mirror mode, which distributes actions between identical Image Servers. You must then configure the host and port for each of the Image Servers that you want DAH to connect to.
For more information about configuring child servers for the DAH, refer to the Distributed Action Handler Administration Guide and the Distributed Action Handler Reference.
To configure DAH with child Image Servers 1. Open the DAH configuration file in a text editor.
2. In the [Server] section, set the MirrorMode parameter to true.
3. If all of your Image Servers are sharing a single database, set the FastMirrorMode parameter to true. Do not use fast mirror mode if your Image Servers use their own datastores.
Note: When using FastMirrorMode, ensure that there are only Image Servers behind the DAH.
4. In the [Server] section, set the DistributedEngines parameter to the number of Image Servers that you want to distribute to.
5. Create a [DistributedEngineN] section for each child Image Server, where N is an integer value, starting from 0. The number of configured DistributedEngineN sections must match the number of DistributedEngines that you configured.
In each [DistributedEngineN] section:
n Set Host to the host name or IP address of the machine where the child Image Server is installed.
n Set Port to the ACI port number of that Image Server.
6. Save and close the configuration file. Restart DAH for your changes to take effect.
Configure Asynchronous Actions
By default, DAH is configured for handling only synchronous actions. You must edit the DAH configuration file (DAH.cfg) to add your Image Server asynchronous actions.
To configure DAH to run asynchronous actions 1. Open the DAH configuration file in a text editor.
2. Find the [Server] section.
n Set the AsynchronousCommands parameter to a comma-separated list of the asynchronous Image Server actions that you want to run. For example:
[Server]
AsynchronousCommands=Analyze,Redaction,Train,AddTraining 3. Find the [QueryTemplate] section, or create it if it does not exist.
n Set the QueueInfo parameter to the path to the name of the template that you want to use for the QueueInfo action. This template is required for asynchronous actions. For example:
[QueryTemplate]
QueueInfo=templates/queueinfo.xsl.
Run DAH and Image Server
After you have installed and configured DAH, you can start using it to distribute Image Server actions.
To run DAH and Image Server 1. Start all configured Image Servers.
2. Start the DAH.
3. Send all Image Server actions to the DAH ACI port. DAH distributes the actions between all configured Image Servers.
Related Topics
l "Start Image Server" on page 59
l "Stop Image Server" on page 59
The Image Server Configuration File 48
Specify Modules to Enable 56
Customize Logging 57
The Image Server Configuration File
The Image Server configuration file contains information that Image Server needs to run.
You can customize the operation of Image Server by editing the configuration file. The configuration file is named imageserver.cfg and is stored in the installation directory.
For information about all of the configuration parameters that you can use to configure Image Server, refer to the Image Server Reference.
Default Configuration File Sections
The Image Server configuration file is divided into sections that represent different Image Server features.
[License] Section
The [License] section contains information needed to connect to your License Server.
[License]
LicenseServerHost=10.0.0.0 LicenseServerACIPort=20000 LicenseServerTimeout=600000 LicenseServerRetries=1
[Service] Section
The [Service] section contains settings that determine which machines can use and control the Image Server service. For example:
[Service]
ServicePort=18001
ServiceStatusClients=*.*.*.*
[Server] section
The [Server] section contains general settings for Image Server. Parameters in this section specify the Image Server ACI port, the IP addresses of clients that can query the server, and default settings for synchronous ACI actions.
[Server]
Port=18000
AdminClients=127.0.0.1 QueryClients=*.*.*.*
Threads=4
[Actions] Section
The [Actions] section contains parameters for configuring asynchronous ACI actions and action queues.
[Actions]
MaximumThreads=8
[Paths] Section
The [Paths] section specifies the location of files required by Image Server.
[Paths]
StaticDataDirectory=.
DatabasePath=imageserver.db KeyviewDirectory=filters
[Database] Section
The [Database] section contains parameters that determine the database in which Image Server stores models of faces and objects for detection and recognition operations.
[Database]
DatabaseType=internal
[Analyze] Section
The [Analyze] section contains a list of analysis tasks. Each task has its own separate configuration section. The [Analyze] section can also contain parameters that determine how Image Server performs the Analyze action.
[Analyze]
Task0=DocOCRTask
Task2=ObjectTask Task3=BarcodeTask Task4=ObjectClassTask Task5=ColorClusterTask Task6=DominantColorTask
[TaskName] Section
Each [TaskName] section contains the settings for one of the analysis tasks listed in the [Analyze]
section. For example:
[DocOCRTask]
Type=ocr
OCRMode=document Languages=en Whitelist=•
[FaceTask]
Type=face Recognize=true Demographics=true FaceState=true ClothingColor=true [ObjectTask]
Type=object
[Logging] Section
The [Logging] section contains configuration parameters that determine how messages are logged.
You can use log streams to send different types of message to separate log files. The configuration file also contains a section to configure each of the log streams.
[Logging]
LogLevel=NORMAL LogHistorySize=0 LogTime=true LogEcho=true MaxLogSizeKbs=4096
OldLogFileAction=compress 0=APP_LOG_STREAM
1=ACT_LOG_STREAM [APP_LOG_STREAM]
LogFile=application.log LogTypeCSVs=application