You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion

ColdFusion: Article

ColdFusion Developer's Journal Special "Frameworks" Focus Issue: Fusebox

Petmarket a la Fusebox

Simon says, "Build the Pet Market app in Fusebox." Simon says, "Write an article about it."

 So I'm sitting on a plane at 35,000 feet, somewhere over the heartlands, writing an article. Having been the driving force behind the creation of the Wegot Widgets reference application project for Fusebox, I think the idea of an "All Pet Market" issue of CFDJ is a great idea.

I'm sure each of the application authors are taking a slightly different approach, even with the various frameworks taken out of the picture. Here are the ground rules by which I played when building Pet MarketFB:

  1. No changes to the database
  2. Use the existing application's HTML
  3. Follow the whole Fusebox Lifecycle Process (FLiP)
Consequently, there are a lot of things you won't see in the Pet MarketFB code. You won't see any attempt to modernize the HTML, use CSS, build accessibility, etc. While these are all laudable goals, they are beyond the scope of this project and article. In my opinion, the point of the project is to show you how the same application's code would look if arranged in Fusebox.

Prototype/Front End
Fortunately, FLiP is well-suited for an effort like this. We can pick up the project at the end of the Prototype/Frontend phase--the point called "Prototype Freeze". We just use the HTML generated by the existing application as the frozen frontend. Based on that assumption, I started by printing out the screen shots of the application and marking up the printouts as I would for any Fusebox application. The printouts are marked in various colors representing dynamic data, exit points, exit data points, and fuse file names (for the display fuses implied by each printed page). An example of a marked up page is shown in Figure 1.

Mind Mapping
Once the markup was completed, I fired up Mind Mapper Pro and started building out the architecture of the application. For each page in the markup, I chose a circuit to contain the logic represented by the markup. Each circuit is assigned fuseactions implied by the pages and the actions they require, and each fuseaction is in turn assigned one or more fuses. I also defined Exit Fuseactions and Component Content Variables. At this stage of the game, we're not concerned about code at all. It's all about the application architecture. A shot of one circuit in the finished mind map is shown in Figure 2. The complete mind map is available in the companion zip file for this article, which can be downloaded from www.cfpetmarket.com.

With the mind map's nodes all built out, I turned my attention to the Fusedocs. Fusedocs define the responsibilities, properties, and IO for each fuse in a standardized XML vocabulary. Still, we're not working in code. The project might be completed in ColdFusion, but it could also be coded in PHP, Lasso, or any other language for which the Fusebox 4 core files have been created. An example of one of the Fusedocs is shown in Figure 3.

The purpose in a Fusedoc is to provide everything the coder needs to write the fuse, and nothing more. The responsibilities section describes the fuse's job, and the properties and io sections provide specific data about the fuse, its inputs, and its outputs.

Fusedocs to Fuse Stubs
In addition to the XML-based Fusedocs, I also added some extra stuff for some of the fuses. In particular, I copied relevant chunks of HTML from the front end into each display fuse, and I created a QuerySim for each query fuse. QuerySims are an easy way to provide recordsets with test data before the database is available. During the architecture phase, I'm not concerned about the database, even if one already exists - I'm concerned about satisfying the data requirements represented by the front end. The front end is the customer's expectation and it must be met. I'll worry about the database's demands when the time comes - in the coding stage.

These "Fusedocs with stuff added to them" are known as fuse stubs. I typically write the Fusedoc in HomeSite+, using the available VTMs for Fusedoc. Then I copy and paste the Fusedoc into the Notes pane for its node in the mind map. I do this so that I have the entire architecture for the application contained in one place - the mind map. A sample fuse stub is shown in Listing 1.

Generate the Framework
With the mind map completed, it was time to start working some time-saving magic. I saved the mind map in text format, which results in an outline with all the data in the mind map. A few years back, I wrote a custom tag called Fuseminder that uses just such a file to generate the entire Fusebox framework. With feedback and new code provided by several other Fuseboxers over the years, the latest being Jamie Thomas, Fuseminder was kept up-to-date as new versions of Fusebox came out. So I ran the latest, FuseminderFB4, passing the outline file to it. The calling form for FuseminderFB4 is shown in Figure 4.

FuseminderFB4 cruises the outline file, creating directories, writing data to fuse stub files, creating circuit configuration files (circuit.xml) and an application configuration file (fusebox.xml), and placing the Fusebox 4 core files in the application's root directory. Figure 5 shows a portion of the output from FuseminderFB4 running in Verbose mode.

Test Harnesses
With the application framework generated, it was time to build some test harnesses for unit testing. Test harnesses are just little templates that set up the environment required by a fuse and allow the coder to run the fuse all by itself. This allows them to make sure the fuse works according to its Fusedoc even though the coder knows nothing about the rest of the application.

As you can imagine, writing all these test harnesses is quite a bit of drudge work. It's another perfect opportunity for the use of a utility, so I wrote one called Harness (back in old days of Fusedoc 1.0). Harness2 is the latest incarnation, updated for Fusedoc 2 by several of us, notably Kevin Roche. I ran Harness2 as a custom tag called in the root of the application, and it cranked out all the test harnesses in a few seconds. Listing 2 shows a test harness for the fuse stub we saw in Listing 1.

Test harnesses were generated for all the fuses, and the time came to write the actual code for the application. As the architect, I farmed out the coding assignments to my skilled team of coders and waited for the finished fuses to come back. To keep track of the coding assignments, I used another utility I wrote - FB4Checklister. This utility just reads through the application's circuit.xml files and renders a checklist for all the fuseactions and fuses in the each circuit. A page of output from FB4Checklister is shown in Figure 6.

With the fuse stubs, test harnesses, and checklist prepared, I called in a few favors. With Hal unable to attend the MAX conference, I enlisted his help in writing the final application code. With a few circuits in hand, Hal went to work on his fuses while I worked on the rest of them. As of this moment, the fuses need to be written. I'll finish this story after the application is done, sometime during MAX.

Sometime During Max - Integration Testing
The coders went to work on their fuses, and let me know if they had questions about any of the Fusedocs. After a few clarifications on some fuses, the work was completed and I had the code back in hand. It was time to drop everything into the application framework and watch the finished application run flawlessly.

Okay, so the "run flawlessly" part didn't quite happen. Why? Because I, as the architect, rushed through my job and didn't do a good job designing the application. Consequently, there were a few issues that I had to resolve during the final integration testing. Fortunately, these were all minor problems, such as specifying the variable "productID" instead of "breedID", and easy to resolve thanks to the granular nature of the code.

What's It Look Like?
Obviously, the application itself doesn't differ from the original in terms of the user experience. The important part of the exercise for us developers is how the code looks. One of the nicest things for Fusebox users is the "roadmap" nature of each circuit's configuration file (circuit.xml) and the application configuration file (fusebox.xml). Listing 3 shows the fusebox.xml file for PetmarketFB, and Listing 4 shows the circuit.xml file for the Catalog circuit.

The code in the fuses isn't as critical in terms of differences from other frameworks, but I will make an example of the overall application layout display fuse, shown in Listing 5. It's immediately apparent that this code, and the layout is creates, is very simple to interpret. The actual content blocks have been removed and replaced by Component Content Variables. This is one small example of how Fusebox can greatly simplify the maintenance of an application.

Similarly, the layout fuse for the checkout process is much more flexible, as shown in Listing 6. The layout doesn't depend on an arbitrary "step" variable to control segments of the display. Consequently, this layout can be easily adapted to any stepped process simply by changing the step names contained in the list at the beginning of the fuse. Displayed links in the title bands and the display of content within successive bands is controlled by the presence or absence of content instead of a control variable's value.

At the end of the FLiP process, we have a finished application that is highly documented, easy to maintain, and has powerful management features built right in. There are a few caveats about this particular project that I should mention. For example, without the original database designer available, assumptions had to be made about the intent of the database design. For example, there appears to be no place in the database to store orders - only user shopping carts. My assumption based on this observation was that the orders were being stored elsewhere in the company. There are also inconsistencies in the database, such as calling a field "firstname" in one table and "givenname" in another. By using the FLiP process, these inconsistencies don't become inconsistencies in the application, because the application's variables, field names, and so on are designed without the database at hand, and the differences in naming are resolved during the coding phase.

In addition, issues like the layout of the site, which is fairly confusing to examine and navigate in its original code, becomes much more easy to follow when organized in terms of Fusebox layout files and Component Content Variables. Fusebox provides the organization that improves the lives of maintenance programmers.

This is a simple introduction to Fusebox and FLiP in the context of the Pet Market application. All the files for the application, captured at various stages of the process, are available in a zip file on my site, www.GrokFusebox.com.

More Stories By Jeff Peters

Jeff Peters works for Open Source Data Integration Software company XAware.

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 Evatronix 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. Evatronix SA offers comprehensive solutions in the design and implementation of electronic systems, in CAD / CAM deployment, and also is a designer and manufacturer of advanced 3D scanners for professional applications.
SYS-CON Events announced today that Synametrics Technologies will exhibit at SYS-CON's 22nd International Cloud Expo®, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Synametrics Technologies is a privately held company based in Plainsboro, New Jersey that has been providing solutions for the developer community since 1997. Based on the success of its initial product offerings such as WinSQL, Xeams, SynaMan and Syncrify, Synametrics continues to create and hone inn...
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
"Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
Recently, WebRTC has a lot of eyes from market. The use cases of WebRTC are expanding - video chat, online education, online health care etc. Not only for human-to-human communication, but also IoT use cases such as machine to human use cases can be seen recently. One of the typical use-case is remote camera monitoring. With WebRTC, people can have interoperability and flexibility for deploying monitoring service. However, the benefit of WebRTC for IoT is not only its convenience and interopera...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, discussed how they built...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
The 22nd International Cloud Expo | 1st DXWorld Expo has announced that its Call for Papers is open. Cloud Expo | DXWorld Expo, to be held June 5-7, 2018, at the Javits Center in New York, NY, brings together Cloud Computing, Digital Transformation, Big Data, Internet of Things, DevOps, Machine Learning and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding busin...
"Digital transformation - what we knew about it in the past has been redefined. Automation is going to play such a huge role in that because the culture, the technology, and the business operations are being shifted now," stated Brian Boeggeman, VP of Alliances & Partnerships at Ayehu, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
With tough new regulations coming to Europe on data privacy in May 2018, Calligo will explain why in reality the effect is global and transforms how you consider critical data. EU GDPR fundamentally rewrites the rules for cloud, Big Data and IoT. In his session at 21st Cloud Expo, Adam Ryan, Vice President and General Manager EMEA at Calligo, examined the regulations and provided insight on how it affects technology, challenges the established rules and will usher in new levels of diligence arou...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...