Windward DocumentationFor Beginners Getting Started with Report DesignerReport Designer Office Edition Getting Started Guide

Report Designer Office Edition Getting Started Guide

Welcome to Windward Studios Report Designer

Windward Studios takes a unique approach to reporting. Our Report Designer sits directly inside Microsoft Office which means you get to use a familiar and powerful tool without having to learn a new designer. If you’ve ever used one of our competitors’ products, you may be familiar with their modular designers that require you to build reports using bits and pieces, where every bit of text or every piece of data is a distinct object in your template. Windward changes all of that. With Windward in Microsoft Office, you design report templates just like you design any other document, utilizing Tags to insert your data wherever you need it seamlessly in-line with your other text and content.

How Does Windward Work?

Before we jump into template design, let’s talk about the philosophy of Windward. Let’s consider the example of a local energy company. Every month they need to send out bills to all their customers. Their data might look something like this:

Using Windward, you design a single template in Word or Excel that allows you to generate a unique bill for every one of your customers.

This template uses Tags as placeholders for data. Every piece of text contained in brackets ([ ]) is a Tag and will be replaced with data when the bill is generated. Windward does the heavy lifting – we pull in all the relevant information from your Data Source and format it as specified in the original template:

Now let’s look at one of our sample templates, the “Variable Invoice Sample – Template.docx”.

This template was created from scratch in Microsoft Word. Everything you see in the template, from the header to the text to the color formatting, functions just like it normally would in Word - with one major exception. All the colored text you see contained in brackets ([ ]) are Tags. Windward uses Tags as placeholders for your data. Every Tag corresponds to an item in your Data Source. In this example, the Tags are used to fill in the data for any given Order Number and its subsequent information. This is the output of the template:

All the Tags are now replaced with the corresponding data from the Data Source. Once you have Report Designer installed, you can open this template and play around with it to help get an idea of how Windward lets you design templates in a familiar environment. All of Words powerful design tools are available to you as you build unique templates.

Please note - A critical element of successful template design with Windward is knowing your data. If you are unfamiliar with your data or how it’s structured, you may want to spend a few minutes reviewing the data or ask your database administrator for an overview before beginning this training.

Training Overview

This Training Guide walks you through the fundamental steps you need in order to begin designing report templates with Windward Studios Report Designer in Microsoft Word using an SQL Data Source.

The Five Steps to Windward:

Install

Connect To Data

Design Your Template & Your Data

Refine Your Template

Output

Step 1 – Install

The first step to getting started is to install the Report Designer. Please visit the Windward Studios Downloads Page and download the Report Designer.

Please note: Windward Studios requires Microsoft Office running on Microsoft Windows to install.

Run the program WindwardWebInstall.exe.

Enter your AutoTag License Key when prompted. If you do not have a License Key, contact our Sales team.

Start Microsoft Word or Excel.

When Word or Excel first starts, it may indicate that you do not have a valid license. Click Yes. At the prompt, copy and paste your license key into the license key field.

Verify that the Windward menu is available by opening Microsoft Word or Excel. If AutoTag is not present, please reboot your system.

For troubleshooting, see the Instructions page.

Step 2 - Connect To Data

In this training guide we are connecting to a sample SQL Data Source provided by Windward. If you’d like to see a training guide using an XML or JSON Data Source please click the following links:

[Link to XML Training Guide]

[Link to JSON Training Guide]

Open Microsoft Word. Now that you’ve installed Windward Studios Report Designer, you will see two new tabs in the Microsoft Office Ribbon – the Windward tab and the Windward Tools tab.

Click on the Windward Tab and click on the Data Sources button located on the left-hand side of the ribbon.

In the Connection Editor window, in the New tab, click on SqlServer Database under SQL. The Details pane will change to prompt you for your data source details.

Enter a Nickname for your data source connection. It is best practice to always assign a nickname to your Data Source in the Nickname field. This will make your life much easier down the road when working with templates or tracking down issues.

Fill in the following fields:

Server: mssql.windward.net

Database: Northwind

Use Username/Password

Username: demo

Password: demo

Click Test, and then click Add to add your connection. If all parameters and credentials are correct and a connection is made, you will receive a successful notification. Click Update to save your information and Close to close the window.

Step 3 – Design Your Template & Insert Your Data

In this Training Guide we’re going to build a very basic order receipt that is generated anytime an order is completed.

Dear COMPANYNAME,

Thank you for your purchase. you placed your order on ORDERDATE. Your Order Number is ORDERID.

Here is a summary of your order:

Product ID Price Quantity Discount
PRODUCTID PRICE QUANTITY DISCOUNT


Thank you!

Let’s start by adding a basic outline for a written sales receipt. You can either type or copy-paste this text into your document:

Now we’re going to insert a Tag that gives your template the ability to incrementally pull in as much connected data as you need – the ForEach Tag. The ForEach Tag is used to step through your Data Source and insert individual pieces of data for each entry in the Data Source. First place your cursor at the very beginning of the document, before the ‘Dear’ text. Navigate to the Windward tab, click the Tags drop-down menu, and click on the ForEach Tag to insert a ForEach Tag at the start of your document.

Now we’re going to set up the ForEach Tag so it knows what data we want to insert into this template. Click on the Tag to select it and then click on the Wizard button in the Windward tab to open the SQL Wizard.

The Wizard is used to create a Query for the data. A query tells AutoTag exactly what data to pull from your data source for your report. This can seem technical your first time through, but the Query uses common language and you should be able to understand what we’re pulling from the Data Source as we build the statement. Since the CompanyName is in a different table than the Order information we’re going to make sure we’re pulling the correct CompanyName based off the OrderID.

 

  1. In the SQL Wizard expand the Tables header and then drag the Customers, Order Details, and Orders tables into the Columns selection. Then click OK.

 

 

 

This is a little overkill and produces a large Query, but for the purpose of this training material that is ok. In the future as you build your own Queries, you can build more concise Queries by selecting only the specific nodes you need for your template rather than the full tables they reside in.

 

  1. In the template this creates a very large ForEach Tag label that lists all the nodes we selected, so let’s shrink this by entering a nickname for the Tag in the Nickname section of the ForEach Tag Properties in the Windward tab.

Now that we’ve specified that we want to use the Order table set of data in our template, it’s time to insert our data Tags.

Let’s start by inserting a Tag for the Company Name in place of our COMPANYNAME placeholder text. Begin by selecting and deleting the COMPANYNAME text.

Now use the Tags dropdown to insert an Out Tag.

Double-click on that Out Tag to open the Tag Editor window.

In the Tag Editor expand the node under your ForEach Tag and double-click the CompanyName node. This builds the Query for this individual Tag. Then click Save Tag to close the window.

Congratulations! We just created the CompanyName Tag for our template. Now let’s create the remaining Tags for our template.

 

  1. Just as we did for the CompanyName Tag, replace your placeholder text with an Out Tag.
  2. Double-click the Out Tag to open the Tag Editor.
  3. Then select the matching node from the ForEach dropdown for our replacement text.
Replacement Text Tag Node
ORDERDATE OrderDate
ORDERID OrderDetails_OrderID
PRODUCTID ProductID
PRICE UnitPrice
QUANTITY Quantity
DISCOUNT Discount

 

  1. Click Save Tag.

The final step is to add an EndForEach Tag so the document knows where to stop filling in data. Place the cursor after the Thank you! text and insert an End ForEach Tag from the Tags dropdown.

Our final template now looks like this:

Step 4 – Refine Your Output

On the AutoTag Tab you can use the Output dropdown to generate this template into a report in any supported format. Let’s start by generating it in DOCX format.

As you can see, we need to make a few revisions to our template to get it looking right.

The first easy fix is to move the End ForEach Tag to a new page so that we’re only generating one receipt per page. Place the cursor in front of the End ForEach Tag, and use the Insert tab to insert a Page Break before this Tag. This moves the End ForEach Tag to a new page.

Now let’s change the Data Type of the OrderDate, Price, and Discount Tags so they look better.

Double-click on the OrderDate Tag to open the Tag Editor.

Switch the main pane to the Properties pane, click in the entry field to the right of Format, and open the formatting window by clicking the button on the right of the entry box. The formatting window allows us to select a format for the Tag. This is very similar to Excel, where you are presented with options to standardize how this data is displayed in the output report. Since we’re formatting OrderDate, click on the Date option and then select the most appealing format for you. Once you have your format click Apply and then click Close. Finally click Save Tag to close the Tag Editor window. Your Tag doesn’t look any different, but when generated it will appear in the format you selected.

Repeat this process for the UnitPrice and Discount Tags, making sure that you select Currency instead of Date in the Formatting window.

  1. Now let’s do some basic Word formatting on the rest of the document. Let’s bold the OrderDate and OrderID Tags as well as the first row of our table. Feel free to format the rest of the template in any way you wish - any formatting you define here will carry over to your generated document.

When you’re done, generate another DOCX output of the template to see the changes.

This output looks MUCH better. Receipts are now on individual pages and we’re bolding parts of the template to draw attention to it. The Price and Discount columns are also now in commonly accepted currency format.

Most customers find it very useful to make formatting changes and output their document frequently to see how those changes appear. As you build more complex templates and use elements such as images and charts you’ll find that it moves the rest of your content around as data is inserted.

Step 5 – Output Your Template

Once you have completed formatting your output, you’re ready to complete the final output of your template. To test your template you may generate output using the Designer, but in production you’ll probably use one of our Windward Studios Report Engines. You can either copy the DOCX or XLSX template to your Engine server for output or use the Generate Code button in Office in you use to the template dynamically in your application. The Generate Code button is found in the Windward Tools tab.

0 Comments

Add your comment

E-Mail me when someone replies to this comment