Getting Started with .NET Report Engine

This article gives you the basic information you need to install and test .NET Report Engine.

Requirements

Installing .NET Report Engine

For detailed instructions, see How Do I Install the .NET Report Engine?

Installation

Go to Windward Studios Downloads and click on the link .NET Engine Installer – (EXE)

Once the download is complete, double-click on the installer. Follow the steps of the Installation Wizard. You may enter your license key during the installation or afterward.

Entering Your License Key

All configuration information goes in the App.exe.config file for the application calling the .NET Report Engine.  By default, an example WindwardReports.dll.config file is located in C:\Program Files (x86)\Windward Studios\Windward .NET Engine. If you chose not to enter your license key during the installation, after the installation you must copy and paste your license key into to your App.exe.config. 

As with all configuration entries, use the standard .NET '<add key="xxx" value="xxx"/>' format when entering your license key. An example is provided in the WindwardReports.dll.config file, and is also shown below for your reference (but is not a valid key). 

<add key="license" value="cHtzLjSa8TwnWysGZbDtvf1YB8eKHSxNWb54T0m MoG+d/qztTfI9xdwyRx98vGk2dpjpPHYSRQQoZmE0J8o7NWYSRQWpZ220dhDT
wnWysGZbDtvj2A7T53uzsdJzqxHO1Zm61kZukHZqt/NSs5aaaThis/is/not/a/valid/key==="/> 

The license key string can be entered as a single line, or it can be entered on multiple lines as long as each line is just the license key (no spaces before or after).

Testing the Installation

The .NET Report Engine test directory (by default C:\Program Files (x86)\Windward Studios\Windward .NET Engine\test) contains a test template and data source to verify your installation is working correctly. Navigate to that directory and execute run.bat. If the output file "testreport.pdf" is created, then .NET Report Engine is installed and running.

What's Next

You have now verified your .NET Engine installation. You have a few choices for how to proceed from here:

  • Open the installed Catapult sample software application and look through the sample projects. A wide variety are installed with the .NET Report Engine to get you started.
  • Just need to the see the code?  See the .NET Report Engine API Reference.