Welcome!

Adobe Flex Authors: Matthew Lobas, PR.com Newswire, Shelly Palmer, Kevin Benedict

Related Topics: Adobe Flex

Adobe Flex: Article

Building Reports with ColdFusion MX 7

How to generate your first ColdFusion MX 7 report (previous ColdFusion knowledge is helpful but not necessary)

Reporting is one of the most common tasks developers have faced since the beginning of the IT revolution. In the past, Macromedia ColdFusion developers didn't have many choices for easily creating reports and integrating them with their applications. They either had to leave the comfort of using ColdFusion and use a third-party solution or write CFML to generate HTML layouts - a solution that involved writing a lot of CFML code to read data from database, slice and dice the data, and generate HTML output.

Doing that kind of work can be tedious, repetitive, and just plain boring. Even after all that hard work, the final result can be less than optimal. Because HTML has no notion of page breaks, page headers, and footers, the results seldom look very good when the browser sends a report to the printer.

In ColdFusion 7, the ColdFusion engineering team has created a reporting feature to help liberate you from such tedious tasks. Now you can spend more time developing dynamic applications and less time worrying about whether or not it will print well.

Requirements
To complete this tutorial you will need to install the software and files listed at the end of the article. Previous ColdFusion knowledge is helpful but not necessary.

Getting Familiar with the New CFREPORT Tag Syntax
The cfreport tag has undergone some slight revisions. Aside from still supporting its usual syntax that supports Crystal Reports integration, the new syntax is as follows:


<cfreport
     template = "report definition filename"
     format = "PDF or FlashPaper" or "excel"
     name = "cf variable"
     filename = "output filename"
     query = "query variable"
     overwrite = "yes" or "no"
     encryption = "128-bit" or "40-bit" or "none"
     ownerpassword = "password"
     userpassword = "password"
     permissions = "permission list"
>
     cfreportparam tags [optional]
</cfreport>

The ColdFusion MX 7 Reporting Solution
The ColdFusion reporting solution contains two parts: a report engine and a report designer.

The report engine contains the following functionality: graphing capability, columnar layouts, support of report runtime input parameters, and the ability to output in three formats (Adobe PDF, Macromedia FlashPaper, and Microsoft Excel). You can output these files directly to a browser, save them to disk, or send them through e-mail.

The report feature gives ColdFusion developers many advantages over third-party solutions:

  • It understands CFML expressions
  • It can use data sources defined in the ColdFusion Administrator
  • It has access to shared scopes
The report builder contains the following wizards to help you create reports:
  • Report Creation Wizard
  • Chart Wizard
  • Subreport Wizard
  • Server Setup Wizard
Let's discuss the report builder some more.

Introducing the ColdFusion Report Builder
The ColdFusion Report Builder is a tool you can use to create ColdFusion report files (CFR files) that the report engine will consume. The Report Builder is only available to Windows users, even though the reports themselves can run on most platforms to which ColdFusion deploys (Windows, Linux, Solaris, Mac OS X, HPUX, and AIX specifically - HPUX and AIX are only supported through pure Java deployments).

When you run the Report Builder for the first time, the Server Setup Wizard helps you configure Report Builder to work with ColdFusion Server. You can modify all of the settings in the Server Setup Wizard from the preferences screen, or you can run the wizard again.

ColdFusion reporting uses a banded-report writing paradigm. In other words, each section of the report is separated into different bands; a section, or band, is a printable region of the report. Each band has its own rules that specify when and how to print. The Report Builder lists each of these bands in the work area from the top to the bottom in the following order:

  • Report Header
  • Page Header
  • Column Header
  • Detail, Column Footer
  • Page Footer
  • Report Footer
There is also a special band called "Watermark" that prints in the background of every page. You can get more information about the different bands by using the integrated help system from the Help menu.

The Report Builder layout has four main areas (see Figure 1):

  • Workspace
  • Properties panel
  • Fields
  • Parameters panel
  • Text Styles panel
Use the Workspace in the middle of the screen to place your images, labels, or text - anything - that you want to print. When you select an object or text in the workspace, the Properties panel in the upper right displays the properties available for that object. The Fields and Parameters panel below the Properties panel displays the fields (either from your database or ones that the report calculates) and parameters that are available for your report. Last, use the Text Styles panel to set text attributes in your report quickly and easily.

Building a Sample Report
In this tutorial, you will build a sample report with the ColdFusion Report Builder to help you understand the following features of ColdFusion MX 7 reports:

  • Layout of a banded report
  • Database access
  • Text formatting (styles)
  • Text formatting (ColdFusion)
  • Subreporting
  • Group management
  • Images and shapes
  • Report and ColdFusion expressions
  • Labels and fields
  • Layout controls
  • Fields and parameters
  • Query Builder
  • Output formats
  • cfreport tag modifications
In the following section, you will create a new report that contains several elements: report header, page header, detail pages, and queries:
  1. Open the Report Builder.
  2. Create a new report document, selecting the As a Blank Report option.
  3. Save your report to the webroot of your ColdFusion server, naming it FirstReport.cfr.
By default the Report Builder shows a select number of report bands: Report Header, Column Header, Detail, Column Footer, and Report Footer. The Report Builder doesn't show the following by default: Page Header, Page Footer, Watermark, and those bands created when using the "Group Management" option (explained later).

The bands displayed represent everything that your report can contain. Some bands, like the Report Header, appear only once - in this case at the top of the very first page of the report. Other bands, most importantly the Detail band, will be iterated over a number of times, depending on your query data, grouping, and number of pages.

Building a Query for Your Report in the Query Builder
To open the Query Builder, select Report > Report Query from the menu bar, or click the Report Query button on the menu bar. The Query Builder appears. Now select a data source:

  1. Make sure that you have selected the appropriate RDS server, choosing an RDS server from the pop-up list box above the tree control. The Report Builder displays a list of data sources defined for the associated ColdFusion server.
  2. Select a data source by clicking it or by clicking the plus (+) sign next to the data source to expand the list.
  3. Expand the data source tree.
  4. To view the database schema, click the plus sign (+) next to Tables.
  5. To view the column definitions, click the plus sign next to a table name.
Build an SQL statement using the Table pane and the Properties panel:
  1. Select an RDS server.
  2. Expand a data source.
  3. Drag one or more tables from the Table pane to the Data Source pane. Alternatively, right-click a table and select Add to Work Area. You can also select a table by double-clicking it or by right-clicking on the Table pane.
  4. To remove a table from the Table pane, right-click it and select Remove Table.
  5. (Optional) If you select more than one table, you must specify the column or columns used to join them by dragging a column from one table to the related column in the second table.
  6. Double-click the columns for the SELECT statement.
As you select columns, the Query Builder creates the SELECT statement in the area in the bottom half of the pane:
  1. (Optional) Specify the sort order and selection criteria.
  2. Review the SELECT statement that displays in the SQL pane, and use the Table and Properties panes to make adjustments, if necessary.
  3. (Optional) Click Test Query.
  4. Click Save.
The Query Builder saves the SQL statement as part of the report and defines query fields for columns returned by the result set. See the ColdFusion LiveDocs on Report Builder for more information. For the example in this tutorial, the Query Builder should look like Figure 2.

The report samples use "text styles" to format elements that display fonts. A text style is similar to a font style in Microsoft Word. Instead of explicitly associating a text element with font specifications, you associate the element with a text style.

Formatting Your Report
To begin formatting your report, take a look at Report Builder toolbox. The toolbox contains everything you need to draw, type, place, and embed everything you need in the report.

Formatting the Report Header
Use the following steps to create a Report Header from the Report Builder toolbox:

  1. Click the lightning bolt button. This is the field control, which allows for the display of textual expressions to be rendered in your report. Expressions, as you'll see, can contain any and all of the following: static text, dynamic text, calculated text, and concatenated text.
  2. Use your cursor to resize the Report Header. A dialog box appears and asks you to select one of the following choices: pre-existing values in the report (such as data from the query you built in the Query Builder), or a manually entered expression. Select manually entered expression; and for the expression enter the following:

    
    "Report Format is " & param.outputFormatLabel
    

    This expression concatenates static text with a predefined report parameter -named outputFormatLabel, specified in the cfreportparam tag, embedded in the cfreport tag - which ultimately invokes our report (covered later). So as we explained earlier, anything in the Report Header appears once on the first page of your report. In this instance, it will print out something like "Report Format is FlashPaper."

  3. Because you want the text to appear in the upper left of the Report Header while the text field is selected (denoted by the handles that appear on the rectangle), click the Align to Band button in the Align palette, click the Align Left Edges button, and then the Align Top Edges button. These steps move the text to the top-left band while respecting the outermost boundaries of the band.
  4. To resize or move the band while you have selected it, click and drag the entire element, use your keyboard arrows, click and drag the element's handles, or alter the values for this element in the properties panel under "Layout" - values such as Height, Width, Left, Top, and so forth. For every new type of element you use in your report, note the related properties of that element in the Properties panel; this will help you be aware of every configurable property available to you.
  5. Supply a static text report title. In the Toolbox, click the abc button (when you place your cursor over it, "Label" appears). Draw a rectangle the width of the entire Report Header band. Notice that when you release the cursor, the Report Builder doesn't ask you to enter an expression, but to enter label text. Enter the following:

    
    Works of Art on Consignment (grouped by Artist)
    

    Notice that with any text, you can align the text box surrounding it and also align the text within the text box by selecting Properties Panel > Format > Alignment, or using the Text and Styles toolbar. Additionally, the dynamic and static fields appear differently in the report. Fields have a solid line on the text box perimeter. Labels only have bracket in its corners.

  6. You're almost done with the report header, but it has no color. Click the "Rectangle" button in the Toolbox and drag it much like a text control. Adjust the control points so that the rectangle occupies the entire width and height of the header band. While selecting the rectangle, set the background color to any color of your choice by selecting Properties Panel > Colors & Style > Background Color, or by using the Background Color paint bucket in the Text Styles panel.
  7. Notice that the rectangle in the report covers the two elements you put in the report header - this is referred to as the z-order. You've essentially stacked your rectangle on top of the other elements. Right-click your rectangle and choose Send to Back. As with most every command in the Report Builder, there are at least one or two other ways to do the same (keyboard shortcuts, panels, toolboxes, right-click menus).
You're done with the header!

Formatting the Page Header
Enter today's date in the Page Header. Conveniently, this ColdFusion report processes much like a ColdFusion page itself, and has access to all variables accessible to the page that contains the cfreport tag invoking the report (that is, unless a user browses to the report definition directly), and also has access to all ColdFusion functions.

To explore functionality available to your report, drag a text field (dynamic - remember lightning bolt) onto the Page Header and enter the following expression:

DateFormat(Now (), "d mmmm yyyy")

You've just used a widely known ColdFusion function, Now(), and formatted it with another function, DateFormat(). Notice that as you entered the expression, the Expression Builder was insightful and prompted you with code completion options. Take advantage of this feature or simply continue typing.

Formatting the Detail Band
Now onto formatting the core of the report, the Detail Band. This band prints in your report for every row of data returned from your report query (the query that you specified in your report through the cfreport tag or that you embedded in the report itself, through the Query Builder).

See if you can mimic the layout described below in your detail band, knowing what you know about fields, labels, layout, and expressions. If you're not terribly knowledgeable with CFML, don't work on this until you're more familiar with the functions below. Note that items in parentheses are instructional; do not include them in the report. Give it a try:


------ Detail Band Start ------
(Label) Artist Contact Info
(Label) Name: (Field) query.FIRSTNAME & " " & query.LASTNAME
(Label) Address: (Field) report.FormatAddress
("", query.ADDRESS, "", query.CITY, query.STATE, query.POSTALCODE)
(Label) Email: (Field) query.EMAIL
(Label) Phone: (Field) report.FormatPhone(query.PHONE, "", "")
(Label) Fax: (Field) report.FormatPhone(query.FAX, "", "")

(Label) "See all artwork by " & query.FIRSTNAME
------ Detail Band End ------

Note: To display the images in the reports you must specify the path for the image files dynamically. In this case, I have used Application.cfm to define an application-level variable called application.sImageLocation. In the report you named works-of-art-by-artist.cfr, the field element under the image label has the following expression: application.sImageLocation & "/" & query.LARGEIMAGE. Because the table stores the image filename, concatenating the path to the image helps your report dynamically find the image files.

Adding a Subreport
You have one more element to add to the Detail Band - another report! This other report serves as a subreport to the main report. Subreporting, conceptually, is much like how a ColdFusion developer would group query data, with nested cfoutput tags.

Use subreports to nest a report within another report. The data you display in a subreport is typically related to the data in the main report. You invoke a subreport by passing one or more subreport parameters from the main report to the subreport. However, the data displayed in a subreport can also be unrelated to the data in the main report. Other common ways to refer to this relationship between these reports are master/detail or parent/child:

  1. On the toolbar, select the Subreport tool and draw an area on the Detail Band.
  2. When the Subreport Wizard prompts you, choose the From an Existing Report option.
  3. Browse to the file called consignment-report.cfr.
  4. The Subreport Wizard asks you to specify the bind parameters for the main report to the subreport. For this example choose #query.ARTISTID#.
  5. Click Finished.
See documentation on subreports in the ColdFusion MX LiveDocs for more information.

Adding a Page Footer
In the Page Footer, place a Field control, entering within it the self-explanatory variable: calc.PAGE_NUMBER

The calc.PAGE_NUMBER variable is one of a few variables available to any report Other variables are:

  • calc.PAGE_NUMBER
  • calc.COLUMN_NUMBER
  • calc.REPORT_COUNT
  • calc.COLUMN_COUNT
Check out the Report Builder documentation in "Built-in Calculated Fields and Input Parameters" in ColdFusion MX 7.

LiveDocs
Browsing Your Report
The ColdFusion code needed to render this report is minimal because you've already embedded your query in the report definition. Save this ColdFusion code in your webroot (where your CFR file is located). Save it as FirstReport.cfm:


<cfreport template="FirstReport.cfr" format="flashpaper">
     <cfreportparam name="outputFormatLabel" value="flashpaper">
     <cfreportparam name="reportTemplateName" value="FirstReport">
</cfreport>

Browse to FirstReport.cfm and the FlashPaper version of your report appears. Go ahead and change the cfreport tag attribute value for format from flashpaper to pdf to excel.

Congratulations! You've generated your first ColdFusion MX 7 report. If you think that was fun, try the Report Wizard next!

Source Code and Files Necessary for This Article
ColdFusion MX 7

  • Try
  • Buy
Tutorials and sample files:
  • reporting.zip (ZIP, 36K)
Note: This ZIP file contains the sample files to build your first report. If you installed ColdFusion MX 7 without the sample applications, run the installer again and select the Sample Applications option during the installation process.

This article can also be read at the Macromedia Developer Center site (www.macromedia.com/devnet/)

More Stories By Dean Harmon

Dean Harmon has been with Macromedia since 2001. Originally he was on the Visual Tools team developing HomeSite before transitioning to ColdFusion. He enjoys creating and playing video games and spending time with his wife and three children.

More Stories By Collin Tobin

Collin Tobin joined Macromedia in 2001. He is currently a principal quality assurance engineer for ColdFusion. Previously he worked at Gtriad as a web developer.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
SYS-CON Events announced today that N3N will exhibit at SYS-CON's @ThingsExpo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. N3N’s solutions increase the effectiveness of operations and control centers, increase the value of IoT investments, and facilitate real-time operational decision making. N3N enables operations teams with a four dimensional digital “big board” that consolidates real-time live video feeds alongside IoT sensor data a...
Mobile device usage has increased exponentially during the past several years, as consumers rely on handhelds for everything from news and weather to banking and purchases. What can we expect in the next few years? The way in which we interact with our devices will fundamentally change, as businesses leverage Artificial Intelligence. We already see this taking shape as businesses leverage AI for cost savings and customer responsiveness. This trend will continue, as AI is used for more sophistica...
Real IoT production deployments running at scale are collecting sensor data from hundreds / thousands / millions of devices. The goal is to take business-critical actions on the real-time data and find insights from stored datasets. In his session at @ThingsExpo, John Walicki, Watson IoT Developer Advocate at IBM Cloud, will provide a fast-paced developer journey that follows the IoT sensor data from generation, to edge gateway, to edge analytics, to encryption, to the IBM Bluemix cloud, to Wa...
What is the best strategy for selecting the right offshore company for your business? In his session at 21st Cloud Expo, Alan Winters, U.S. Head of Business Development at MobiDev, will discuss the things to look for - positive and negative - in evaluating your options. He will also discuss how to maximize productivity with your offshore developers. Before you start your search, clearly understand your business needs and how that impacts software choices.
SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
SYS-CON Events announced today that Fusic will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Fusic Co. provides mocks as virtual IoT devices. You can customize mocks, and get any amount of data at any time in your test. For more information, visit https://fusic.co.jp/english/.
SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
SYS-CON Events announced today that Enroute Lab will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Enroute Lab is an industrial design, research and development company of unmanned robotic vehicle system. For more information, please visit http://elab.co.jp/.
SYS-CON Events announced today that Mobile Create USA will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Mobile Create USA Inc. is an MVNO-based business model that uses portable communication devices and cellular-based infrastructure in the development, sales, operation and mobile communications systems incorporating GPS capabi...
SYS-CON Events announced today that Interface Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Interface Corporation is a company developing, manufacturing and marketing high quality and wide variety of industrial computers and interface modules such as PCIs and PCI express. For more information, visit http://www.i...
SYS-CON Events announced today that Keisoku Research Consultant Co. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Keisoku Research Consultant, Co. offers research and consulting in a wide range of civil engineering-related fields from information construction to preservation of cultural properties. For more information, vi...
There is huge complexity in implementing a successful digital business that requires efficient on-premise and cloud back-end infrastructure, IT and Internet of Things (IoT) data, analytics, Machine Learning, Artificial Intelligence (AI) and Digital Applications. In the data center alone, there are physical and virtual infrastructures, multiple operating systems, multiple applications and new and emerging business and technological paradigms such as cloud computing and XaaS. And then there are pe...
SYS-CON Events announced today that SIGMA Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. uLaser flow inspection device from the Japanese top share to Global Standard! Then, make the best use of data to flip to next page. For more information, visit http://www.sigma-k.co.jp/en/.
SYS-CON Events announced today that B2Cloud will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. B2Cloud specializes in IoT devices for preventive and predictive maintenance in any kind of equipment retrieving data like Energy consumption, working time, temperature, humidity, pressure, etc.
Agile has finally jumped the technology shark, expanding outside the software world. Enterprises are now increasingly adopting Agile practices across their organizations in order to successfully navigate the disruptive waters that threaten to drown them. In our quest for establishing change as a core competency in our organizations, this business-centric notion of Agile is an essential component of Agile Digital Transformation. In the years since the publication of the Agile Manifesto, the conn...
While some developers care passionately about how data centers and clouds are architected, for most, it is only the end result that matters. To the majority of companies, technology exists to solve a business problem, and only delivers value when it is solving that problem. 2017 brings the mainstream adoption of containers for production workloads. In his session at 21st Cloud Expo, Ben McCormack, VP of Operations at Evernote, will discuss how data centers of the future will be managed, how th...
SYS-CON Events announced today that NetApp has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. NetApp is the data authority for hybrid cloud. NetApp provides a full range of hybrid cloud data services that simplify management of applications and data across cloud and on-premises environments to accelerate digital transformation. Together with their partners, NetApp em...
SYS-CON Events announced today that Nihon Micron will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Nihon Micron Co., Ltd. strives for technological innovation to establish high-density, high-precision processing technology for providing printed circuit board and metal mount RFID tags used for communication devices. For more inf...
SYS-CON Events announced today that Suzuki Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Suzuki Inc. is a semiconductor-related business, including sales of consuming parts, parts repair, and maintenance for semiconductor manufacturing machines, etc. It is also a health care business providing experimental research for...
SYS-CON Events announced today that Ryobi Systems will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Ryobi Systems Co., Ltd., as an information service company, specialized in business support for local governments and medical industry. We are challenging to achive the precision farming with AI. For more information, visit http:...