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
BnkToTheFuture.com is the largest online investment platform for investing in FinTech, Bitcoin and Blockchain companies. We believe the future of finance looks very different from the past and we aim to invest and provide trading opportunities for qualifying investors that want to build a portfolio in the sector in compliance with international financial regulations.
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...
Imagine if you will, a retail floor so densely packed with sensors that they can pick up the movements of insects scurrying across a store aisle. Or a component of a piece of factory equipment so well-instrumented that its digital twin provides resolution down to the micrometer.
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settle...
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.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
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...
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...
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
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...
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
When shopping for a new data processing platform for IoT solutions, many development teams want to be able to test-drive options before making a choice. Yet when evaluating an IoT solution, it’s simply not feasible to do so at scale with physical devices. Building a sensor simulator is the next best choice; however, generating a realistic simulation at very high TPS with ease of configurability is a formidable challenge. When dealing with multiple application or transport protocols, you would be...
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 ...
We are given a desktop platform with Java 8 or Java 9 installed and seek to find a way to deploy high-performance Java applications that use Java 3D and/or Jogl without having to run an installer. We are subject to the constraint that the applications be signed and deployed so that they can be run in a trusted environment (i.e., outside of the sandbox). Further, we seek to do this in a way that does not depend on bundling a JRE with our applications, as this makes downloads and installations rat...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lead...
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 ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...