CFMX

Delivering well-formatted reports through a web browser has always been a problem. Style sheets and cross browser compatibility are just a few of the many issues we, as developers, have to deal with when creating HTML based reports. Fortunately, with the release of CFMX 7 Macromedia has provided us with a great tool for providing end users with well formatted, browser independent reports: ColdFusion Report Builder.

Now that we have the Report Builder, life is perfect (at least when it comes to delivering reports via the web) - right? We have one tool to create a query and a perfectly formatted report in a matter of minutes. Well, let's not get too excited too fast -there are some limitations to using the report builder to build your queries and deliver your web-based reports. What if your database table or column names change after you've created a report? What if the query for your report changes, or worse yet, is wrong? What if each user wants to see specific subsets of data in a customized report? You don't want to go into the report builder and re-create your .cfr file (ColdFusion Report) every time your end users throw you a curveball.

One way to fix this problem would be to store your query for the report in a .cfm file, use the report builder to create a blank report and manually add the fields to the report, then use the report wizard to format your report. This solution would let you easily change the query that runs your report.

Now we can easily change the queries behind our reports, but what if an end user wants to change the report? What if a user would also want, for instance, last week's sales report, or a sales report for a specific customer? Writing a separate query for each report a user requests would quickly become a nightmare to maintain. Wouldn't it be convenient to let users configure their own reports?

Here's how you can do just that. By using a database to store the report's properties, a component to represent a Report object, ColdFusion Report Builder to build your report templates, and .cfm files to handle your display logic and manipulate the report object you can create reports that users can easily modify to their needs.

Building a Report
The first thing to do is to create the base reports. The base reports are the reports the user will select as the template for their user modified report. When a user customizes a report, they are actually cloning one of the base reports.

The first step in creating a base report is to use a SQL query builder tool to write a SQL statement to get the data for the report. For the first base report I'll create a Year-To-Date Sales by Salesperson report. The query is pretty straight forward, however, one thing to note is that I use table and column name aliases because I had columns from different tables that have identical names - after all, we want to take a look at a "real-life" situation. Here's my query:

SELECT
  C.name AS Customer
 ,P.name AS Product
 ,E.firstName + ' ' + E.lastName AS SalesPerson
 ,J.quantity
 ,S.saleDate
 ,P.price
 ,P.price * J.quantity AS TotalCost
 ,S.id
FROM
	Customer C
INNER JOIN
	Sale S ON S.customerId = C.id
INNER JOIN
	JoinSaleProduct J ON J.saleId = S.id
INNER JOIN
	Product P ON P.id = J.productId
INNER JOIN
	SalesPerson E ON E.id = S.salespersonId
WHERE
	DatePart(yyyy,s.saleDate) = DatePart(yyyy,GetDate())
ORDER BY  S.id

Let's take a step back and look at the SQL for the base Year-To-Date Sales report. This works very nicely because there is no static date in the WHERE clause; however, it won't lend itself very easily to modification by the common user. Using a DatePart() statement isn't something many end users will be familiar. A user-modifiable version of the above query might look like this:

SELECT
  C.name AS Customer
 ,P.name AS Product
 ,E.firstName + ' ' + E.lastName AS SalesPerson
 ,J.quantity
 ,S.saleDate
 ,P.price
 ,P.price * J.quantity AS TotalCost
 ,S.id
FROM
	Customer C
INNER JOIN
	Sale S ON S.customerId = C.id
INNER JOIN
	JoinSaleProduct J ON J.saleId = S.id
INNER JOIN
	Product P ON P.id = J.productId
INNER JOIN
	SalesPerson E ON E.id = S.salespersonId
WHERE
	s.saleDate >= '01/01/2005'
AND
	s.saleDate <= '12/31/2005'
ORDER BY  S.id

Add Your Feedback

In order to post a comment you need to be registered and logged in.

Register | Log in

Please wait while we process your request...