Skip to main content

Using Scout


This page discusses how the programmer sets up Windward to use Scout.

The License Key

For the Windward Engines, instead of specifying a license key, you specify an API key. Use the API key you received when you signed up for Scout. You can also be find your Scout API key at the following link:


For example:

Java Engine - in


​.NET Engine - in the app.config (or web.config):

<add key="api-key" value="637A3AD0-0132-4CE2-B7C7-967A9F8FE2BF"/>

AutoTag - enter the API key where you normally enter the license key.

Additions to the API

Java: The ProcessReport class has two new methods: setDescription(String) and getDescription().

.NET : The Report class has a new property Description.

This string is passed to the license server for each report generated and saved with the information for the report. The spreadsheet you can download listing all reports run includes this description for each report. When AutoTag runs a report, this description will be the full filename of the template.

What we Send to the License Server

The request during setup:

<setup-request api-key="637A3AD0-0132-4CE2-B7C7-967A9F8FE2BF" msg-guid="ca2c523b-2332-4fbe-a729-c96234e97cd5" request-schema="1.0" ip-address="123.456.789.123" host-name="bogus.windward.local" description="Weekly sales report" application="1" version=""/>

What this is pulling from your computer:

  1. Your API key.
  2. The internal IP address of the computer running the report.
  3. The name of the computer running the report.
  4. The description you specified for the report.
  5. The application (Java engine, .NET engine, or AutoTag).
  6. The version of Windward you are running.

The ip-address & host-name are recorded for your use, not ours. If you see a giant surge in reports run, and therefore overage charges, this lets you track down what computer is causing you the additional charges. We do nothing with this data except report it to you.

The request during complete:

<complete-request msg-guid="ca2c523b-2332-4fbe-a729-c96234e97cd5" nonce="12345" template="docx" report="pdf" num-datasources="1" num-template-imports="0" num-charts="3" num-tags="28" num-pages="14" datasource-types="sql"/>

This is returning statistics about the report run. Not the contents of the report, just what functionality is being used in the engine.

  • Was this article helpful?