Skip to main content

RunReport Command Line



The RunReport program is a precompiled program that Windward ships with both the Java and .NET Engines.  It allows a user to quickly test the engine after installation to ensure that a test template can generate a report.  When running the command without any input parameters a help menu of options will be printed. Below is the full and most current listing of the RunReport command.

Example output of the RunReport.exe command 


C:\Program Files (x86)\Windward Studios\Windward .NET Engine\test>RunReport.exe

Windward Reports version

usage: RunReport template_file output_file [-record recorder_file] [-xml xml_file | -sql connection_string | -oracle con

nection_string | -ole oledb_connection_string | -playback[:name] recorder_file] [key=value | ...]

       The template file can be a rtf, xml (WordML), docx, pptx, or xlsx file.

       The output file extension determines the report type created:

           output.csv - SpreadSheet CSV file

           output.docm - Word DOCM file

           output.docx - Word DOCX file

           output.htm - HTML file with no CSS

           output.html - HTML file with CSS

           output.pdf - Acrobat PDF file

           output.pptm - PowerPoint PPTM file

           output.pptx - PowerPoint PPTX file

           output.rtf - Rich Text Format file

           output.sml - SpreadsheetML file (rename to .xml to use)

           output.txt - Ascii text file

           output.xhtml - XHTML file with CSS

           output.xls - Excel XLS file

           output.xlsm - Excel XLSM file

           output.xlsx - Excel XLSX file

           output.xml - WordML file

       -performance:123 - will run the report 123 times.

            output file is used for directory and extension for reports

       -threads:4 - will create 4 threads when running -performance.

       -launch - will launch the report when complete.

       version=9 - sets the template to the passed version (9 in this example)

       -record filename - records the next datasource to this file

       The datasource is identified with a pair of parameters

           -xml filename - passes an xml file as the datasource

            -xml xmlFilename;schemaFilename - passes an xml file and a schema file as the datasource

           -db2 connection_string ex: server=localhost;database=SAMPLE;Uid=test;Pwd=pass;

           -excel connection_string ex: Provider=Microsoft.ACE.OLEDB.12.0;Data Source=c:\test1.xlsx;Extended Properties="Excel 12.0 Xml;HDR=YES"

           -mysql connection_string ex: server=localhost;database=sakila;user id=test;password=pass;

           -odbc connection_string ex: Driver={Sql Server};Server=localhost;Database=Northwind;User ID=test;Password=pass;

           -oledb connection_string ex: Provider=sqloledb;Data Source=localhost;Initial Catalog=Northwind;User ID=test;Password=pass;

           -oracle connection_string ex: Data Source=localhost:1521/HR;Persist Security Info=True;Password=HR;User ID=HR

           -sql connection_string ex: Data Source=localhost;Initial Catalog=Northwind;Integrated Security=SSPI;

           -postgresql connection_string ex: HOST=localhost;DATABASE=pagila;USER ID=test;PASSWORD=test;

               if a datasource is named you use the syntax -type:name (ex: -xml:name filename.xml)

               set username=user password=pass BEFORE datasource for database connections

               for a POD file (datasets), set pod=pod_filename must come BEFORE each -xml, -sql, ... part

           -rest filename - passes an xml file as the datasource reading it with the REST protocol

           -sharepoint filename - passes an xml file as the datasource reading it with the SharePoint FBA protocol

           -playback filename - passes an recorded file as the datasource

       You can have 0-N key=value pairs that are passed to the datasource Map property

            If the value starts with I', F', or D' it parses it as an integer, float, or date(yyyy-MM-ddThh:mm:ss)

            If the value is * it will set a filter of all

            If the value is "text,text,..." it will set a filter of all

C:\Program Files (x86)\Windward Studios\Windward .NET Engine\test>

  • Was this article helpful?