The Hyland.DataCapture.LoggingConfiguration Element - Data Capture Server - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Data Capture Server Deployment Guide

Platform
OnBase
Product
Data Capture Server
Release
Foundation 23.1
License
Standard
Essential
Premier

This section contains logging information about the Data Capture Server Windows Service.

<Settings> Attributes

Description

loggingServiceType

This option sets where the information about the Data Capture Server Windows Service is logged.

Valid values are:

  • DiagnosticsConsole. Information is logged to the Diagnostics Console.

  • WindowsEventLog. Information is logged to the Windows Event Viewer (under Applications and Services Logs | OnBase Log).

  • TextFileLog. Information is logged to a text file in either plain text or XML format.

Note:

When this option is set to TextFileLog, a separate text log file is created for each OCR process, and each unique process ID number is automatically included in the corresponding log file's name.

level

This option sets the level of information that is logged about the Data Capture Server Windows Service.

Valid values are:

  • Diagnostics. The most verbose logging level. Messages of all types (e.g., error, warning, database, and trace viewer information) are displayed. All extracted capture data is also included. This level is most useful for troubleshooting.

    Note:

    When set to the Diagnostics level, general processing information (e.g., the document and batch being processed) is output in real time, while processing actions are consolidated and output in a document summary.

  • Warning. Database information and warning messages are displayed.

  • Error. The default logging level. Only error messages are displayed.

  • None. No information related to the Data Capture Server Windows Service is displayed.

processname

This option sets the name of the originating process that has been configured for logging (e.g., Hyland.DataCapture.Server).

sourcename

This option sets the name that will be displayed as the source of the logged event (e.g., Hyland Data Capture Server).

Note:

When logging information to the Windows Event Viewer, the value of this option should match the value of the sourcename option configured for the WindowsEventLogging attribute within the Hyland.Diagnostics element.

testLogFormat

Note:

This option is only respected when loggingServiceType is set to TextFileLog.

This option sets the format of the information logged to a text file.

Valid values are:

  • PlainText. Information is logged to a text file in plain text.

  • XML. Information is logged to a text file in XML.

filePath

Note:

This option is only respected when loggingServiceType is set to TextFileLog.

This option specifies the file path of the text file containing the logging information. The default location is the directory of the Data Capture Server executable (i.e., C:\Program Files\ Hyland\Services\Data Capture).