Setting up logging

Use the below procedure to enable and adjust application-related logging in XBOUND.

Procedure

1. Using the XBOUND Management Center, open a console containing the Common Configuration Manager.

   Note: In order to save changes in the Common Configuration Manager, you must run the Management Center as an Administrator.

2. In the navigation pane, select whether to set up logging for all applications (if so, select Local Common Properties) or for a specific application (if so, expand Local Common Properties and then select the application, for example Process Monitor).

3. Select where the log messages are to be saved:

   File system	On the File System Logging tab, select Log to file if you want the log information saved to a separate file. Then specify the file name, folder, and format (XML or text). Disadvantage: Many log files are created. These must be purged regularly. Note: Logging to a central file folder requires the appropriate rights.
   Service logging	On the Service Logging tab, select Log to Logging database if you want the log information saved to the logging database. Advantages: The logging database can be used by different servers. The log messages can be accessed individually. The logging database is native to XBOUND. XBOUND accesses this database to provide information to users (for example using the Log Explorer and Process Monitor). There is an agent for maintaining this database – see Agent for Service Logging Removal. Specify the binding and the application server name. Note: You must close all open XBOUND applications (Document Manager, Document Verifier, etc.) and the Management Center. Then restart the XBOUND Platform Service. Finally, restart the applications you need. You must also create a log view before log messages can be displayed in Log Explorer.
   Windows Event Log	On the Event Log tab, select Log to Windows Event Log if you want the information to be added to the operating system's event log. Advantages: Other applications (third-party components) can also log to the event log. These log messages can be viewed manually in the Windows Event Log or using an external program. Disadvantage: Old messages could be automatically deleted or overwritten by newer messages (if it is configured like this).

4. Select the log level:

   Debug

   In addition to all the messages logged by the other three levels, if you select this setting XBOUND also logs the following:

   • Detailed information about the status of a task or a module.

   • Information about the performance of RCF business rules, if used.

   • Information about the performance of RCC Classification and Interpretation, if used.

   This information is used primarily for troubleshooting. The messages do not need to be checked daily, and they are hidden by default, as is the Debug button. See Displaying debug log messages.

   Information

   In addition to error and warning messages, if you select this setting XBOUND also logs messages that contain important information about the status of a task or a module.

   Warning

   In addition to error messages, if you select this setting XBOUND also logs messages about things that do not prevent the execution of tasks but should be checked.

   Error

   If you select this setting, XBOUND logs only messages about events that cause significant tasks to fail. These must be checked so that the causes for such serious errors can be eliminated as soon as possible.

5. Select File > Save:

   

6. For logging to file when running XBOUND as native 64-bit components, perform these additional steps:

   1. Open the Windows Component Services dialog and note the exact display name of the XBOUND service(s) that you want to log to file. Example:

      

   2. Using Notepad or other text editor, open the xboundConfiguration.foxconfig file. Default location: C:\ProgramData\ReadSoft\xbound

   3. Find the section of the file that corresponds to the services that you want to log to file, and change the beginning and end tags to match the display name – except replace spaces with underscores. Example:

      Before:

        <xboundActivities>
          <LogManager>
            <Textfile>
              <LoggingInFile>1</LoggingInFile>
              <LogFileName>Act.log</LogFileName>
              <LogFilePath>C:\Logs</LogFilePath>
              <LogFileMinSeverity>information</LogFileMinSeverity>
            </Textfile>
          </LogManager>
        </xboundActivities>

      After:

        <XBOUND_Activities_x64>
          <LogManager>
            <Textfile>
              <LoggingInFile>1</LoggingInFile>
              <LogFileName>Act.log</LogFileName>
              <LogFilePath>C:\Logs</LogFilePath>
              <LogFileMinSeverity>information</LogFileMinSeverity>
            </Textfile>
          </LogManager>
        </XBOUND_Activities_x64>

   4. Save and close the configuration file.

   5. Restart the corresponding XBOUND services.

7. Optional: By default, warnings about long database operations are not logged. You can activate that function separately.

Related topics

Setting up XBOUND: Overview