Local Service

Edit online

Local Service is a service that runs in the browser side, and is installed as a Windows Service in browser machine.

Introduction

Local Service supports the following tasks:
  • Executing Datacap profiles
  • Rendering images
  • Building thumbnail
Note: You must have full control permissions to enable Local Service to run the necessary task while communicating with various Datacap components, ICN components and batch folders.

Local Service provides REST interface. Local Profile and Local Rendering features depend on this feature to execute rule or render image. It supports most of the Datacap actions and custom actions, but does not include OCR, ICR, and DocumentAnalytics actions.

Rendering and thumbnail functions support image files only (for example, TIFF, JPEG, BMP, PNG, and GIF), and does not include, Microsoft Office or other file formats.
Note:
  • HTTPS configuration is not supported by default.
  • Do not install it on the same machine with other Datacap components, for example, TaskMaster server, and RuleRunner, Datacap Desktop, as the Local Service might modify the datacap.xml during applications sync up.

Installation

The installation package of Local Service is deployed by Datacap installation, and you can find it in your Datacap folder. For example, C:\Datacap\tmweb.java\LocalTM.

Local Service has some prerequisites, which are included in the ISSetupPrerequisites folder of the installation package, and the installer tries to install them if they are not available in the target machine.

It is not mandatory to deploy the ISSetupPrerequisites folder, as long as you are sure that those prerequisites have already been installed on the target machine.

URL

http://127.0.0.1:51224/service

If needed, the port can be changed using the baseAddress parameter of the LocalTMService.exe.config setting file in your Datacap folder of Local Service machine. For example C:\datacap\LocalTM\ LocalTMService.exe.config

Log files

There are the following several log files in Local Service:
  • aTM.log

    logOverwrite in the config file is used to specify if there is log overriding.

  • localtm.x.log

    It creates another log file after 500K lines in current log file, and start to override existing file after total 10 log files. For example, localtm.0.log->localtm.1.log,->...,->localtm.9.log->localtm.0.log

  • rrs log in temp scan batch folder

Log settings

You can configure log settings using the parameters of LocalTMService.exe.config setting file in your Datacap folder of Local Service machine. For example, C:\datacap\LocalTM\ LocalTMService.exe.config.

You can use the following log settings:
  • logSeverity: Severity of the log
  • logOverwrite: Overwrite the log file
  • logFlushBuffer: If Yes, then flush buffer for each line in the log. It might impact the performance
  • logEnable: Enable or Disable log
  • logPath: Log file path
  • logTime: Write the time to the log
  • logAtmEnable: Enable aTM log