Welcome!

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

"Frameworks" Focus Issue: TheHUB

A comparison

Neil Ross (pictured) writes: recently spoke to a group of attendees at the Fusebox and Frameworks Conference 2005 about the framework that I call TheHUB. Then when I was asked to write this article, I thought it would be a great way to compare and contrast it with several of the frameworks discussed at that conference. So I jumped at the chance to share my approach to developing ColdFusion applications.

I use a framework and methodology called TheHUB, which is an approach that I developed over the past couple of years, and I discussed the origins and motivations for this approach at the conference. The bottom line is that TheHUB is easy to learn, easy to use, and easy to maintain. It has a much smaller footprint than other application frameworks and is flexible enough to allow you to develop applications the way you want without adding lots of restrictions to the way you code.

The Basics
The first thing to understand about TheHUB is that all you're being asked to do is to conform to a pattern of application development. This pattern is similar to the development of a Fusebox application where you indicate a "fuseaction" for each request.

When following the pattern of development prescribed by TheHUB, you format your hyperlinks and form actions in such a way that you identify the template to be loaded by passing along the URL, a key/value pair that specifies a template to be loaded from a specific directory within the folder structure of your site or application. The analysis and processing of the request is implicit and there is a piece of core code that TheHUB uses to analyze the query string on your request and load the appropriate templates.

This approach leaves you, the developer, free to decide how to organize the code, for example, along the lines of what is display code and what is not or along the subject area line. This gives you flexibility as the application evolves and expands.

Preparing the ColdFusion Server
The "readme" file that comes with the downloadable Pet Market code includes the server setup information. You'll need to create your data source connection within the ColdFusion administrator. You'll also need to create a virtual directory in IIS or a virtual mapping in the built-in Web server. Do this by following the directions in the "readme" file included with the download. You'll edit the "jrun-web.xml" file to include the mapping to your Pet Market directory.

Preparing TheHUB
TheHUB has very few core files that are needed for the actual operation of an application. I actually removed several of the sample files that come with the download because I didn't need them for the application to function (see www.cfpetmarket.com). Now, when I do a file count and comparison I find that there were 100 files in the original application and only 102 in the converted application.

There are a few lines of code in the core files that you'll need to update. TheHUB relies on a variable called "request.frameworkhub" in order for an application to function properly. This variable is set within the "globals.cfm" within the "cmn" directory of the core files download for TheHUB and points to the page that you want to run all of the page requests through. The code within the "index.cfm' is pretty simple and just handles the include of the requested templates:

<cfinclude template="cmn/varhandler.cfm">
<cftry>
    <cfinclude template="#request.dir##request.tmp#.cfm">
<cfcatch type="missinginclude">
    <script>
    alert("The page that you requested has experienced an error.
    You'll now be redirected back to the page you last viewed.");
    history.back();
    </script>
</cfcatch>
</cftry>

This is normally the "index.cfm" template, but it can be another template as long as you copy the code over to that new template and update the reference to it in the "globals.cfm".

For this application, update the "cmn\globals.cfm" so that all you need in there is:

<cfscript>
     request.frameworkhub="/petmarket/index.cfm?";
request.cfcPath="petmarket.extensions.components.petmarket";
</cfscript>

Normally there are other variables set within this block, but they're not needed because they are a part of the Pet Market application that we are converting.

Organizing the Code
I'm not going to pretend to know the best way for you to organize code for any application that you're working on today or tomorrow. I know that every developer thinks about development and how he or she wants the applications structured, so TheHUB is nice enough to let you organize your code so that it makes sense to you. I got started converting the Pet Market code by doing a quick review of the application. After looking through the application for a few minutes, I decided to organize the code into three main groupings or subject areas:

  1. DSP: Generic display code
  2. Cart: Display code specific to cart functionality
  3. Extensions: Intact structure from the downloaded zip
I created a directory for my application and called it "PetMarket" so that I could run the applications side-by-side. I wanted to make sure that the functionality was the same from screen to screen and that my interaction with the application didn't differ with any action that I took within the application.

Updating the Code
I mentioned earlier that the most important thing to know about TheHUB is the format of the hyperlinks and form actions. The next step to converting the Pet Market application to a "TheHUB" application is to reformat all of the hyperlinks and form actions. All requests will flow through the "frameworkhub". This is just the template used to conduct traffic for the application. You'll need to update all hyperlinks and form actions to flow through that template.

Let's look at an example. If the hyperlink you're updating goes to the "preferences.cfm" template in the directory where you located that template, in my case I put it in the "dsp" directory.

Before:

<a href="preferences.cfm">preferences</a>

After:

<a href="#request.frameworkhub#dsp=preferences">preferences</a>

The key to making these changes is consistency. I ran a "Find All" for both "<a href=" and for "action=" so that I could modify each form action and all hyperlinks within the application. Everything functions the same but I'm running all requests through TheHUB now.

Beyond the Basics
In addition to the changes to the code for the hyperlinks and form actions, there were a couple of other small changes that I made:

  1. Update CFLOCATION tags to use the "request.frameworkhub" variable
  2. Update CFC object instantiation calls to use the "request.cfcpath" variable
That's about it. The longest part of the process was reviewing the code from the original Pet Market download files. Of course, not every application will be as easy to convert as this one.

Conclusion
This exercise was undertaken so that you would have a side-by-side comparison of the different application frameworks in action. It should give you a good idea of the complexity of the frameworks highlighted in these versions of the Pet Market application. This article shows that the work involved in moving your development approach to TheHUB is actually pretty painless. It gives you all of the flexibility that you need to make good decisions about code organization, maintenance tasks, and the extension of the application. Also note that if you compare them, TheHUB has a much smaller footprint than other frameworks and does not clutter up your application folders with files that you'll never use or even understand.

If you start from scratch using TheHUB as your application framework, you'll find that you can easily extend and maintain the applications that you're building without the overhead of maintaining configuration files.

More Stories By Neil Ross

Neil Ross is a
consultant and ColdFusion course instructor at Allaire. He's been developing Web sites for five
years and developing applications with ColdFusion for three.

Comments (2) View Comments

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.


Most Recent Comments
Neil Ross 02/08/06 07:08:06 PM EST

TheHUB can be downloaded at my site: www.codesweeper.com

I've recently packaged an updated version specifically for CFMX7, utilizing the Application.cfc for event management. Shoot me an email and I'll send you a copy now.

I would love to hear feedback.

Neil

news desk 01/29/06 11:22:58 PM EST

I recently spoke to a group of attendees at the Fusebox and Frameworks Conference 2005 about the framework that I call TheHUB. Then when I was asked to write this article, I thought it would be a great way to compare and contrast it with several of the frameworks discussed at that conference. So I jumped at the chance to share my approach to developing ColdFusion applications.

@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 ...