Setting up the Windows service to host Datacap Web Services

To host Datacap Web Services as a Windows service, install the Datacap Windows Service by using the installation wizard. You must start the Datacap Windows Service before you can validate the installation by opening the Datacap Web Services help page.

Before you begin

Install Datacap Web Services by using the installation wizard.

About this task

Follow this procedure to install and start the Datacap Windows Service to host the Datacap Web Services.

Procedure

  1. Install the Datacap Windows Service from the installation wizard.
    1. Make the installation package available on your network or insert the Datacap CD in the web server's CD/DVD drive. If the installation process does not start automatically or if the package is on the network, open Windows Explorer, navigate to and double-click the Setup.exe.
    2. Select the appropriate language, then click OK. The language that you select determines the language that is displayed by the installation program during the installation process.
    3. When additional, redistributed software is required, the installation program displays a list of the items to be installed. Click Install.
    4. Click Next.
    5. Accept the license agreement and click Next.
    6. Select the Custom option and click Next.
    7. Select the Datacap Windows Service option from the list of components.
    8. Click Next.
    9. Click Install.
    10. Click Finish
  2. Start the Datacap Windows Service.
    1. Go to Administrative Tools > Services.
    2. Right-click Datacap Windows Service and select Start.
  3. Validate the installation of Datacap Web Services by opening the help page.
    1. Go to c:\Datacap\Taskmaster and open wTMservice.exe.config with Notepad.
    2. Copy the baseAddress URL to your browser and add /help.
      The following is an example of a baseAddress URL in the wTMservice.exe.config file.
              <host>
                <baseAddresses>
                  <add baseAddress="http://localhost:82/service" />
                </baseAddresses>
              </host>
      In this example, the URL of the help page is http://localhost:82/service/help,
    3. When the Datacap Web Services help page opens, you can click one of the links in the Method column to show detailed information about the REST API endpoint.
    4. The configuration setting has a name. The following is an example of setting name in the wTMservice.exe.config file.
      <setting name="serviceLogLevel" serializeAs="String">
      <value>4</value>
       </setting>
  4. Enable logging for Datacap Web Services to use serviceLogLevel settings. Edit the web.config file found in \Datacap\wTM folder (\Datacap\wtm\web.config) and enter a value from 0 through 5 to suppress, generate, or moderate a detailed level of information returned in task rrs logs and wrrs logs.
    1. Edit the web.config file and enter a value from 0 through 5 as shown in the below example.
      <setting name="serviceLogLevel" serializeAs="String">
      <value>4</value>
       </setting>
      Table 1. The following table lists the different logging levels that can be updated as a value to set the serviceLogLevel in web.config file
      Setting task_rrs.log wrrs-xxx.log
      0 no logs not created
      1 created and returns basic date and time information with no details of individual actions execution. not created
      2, 3 created and returns lower level details of individual actions execution. not created
      4 created and returns moderate level details of individual actions execution. created with minimal logging
      5 created and returns high level details of individual actions execution including document hierarchy navigation path implemented during execution of rules. created with detailed logging