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, Machine Learning

ColdFusion: Article

AJAX Custom Error Handling: Enhancing the Interactive User Experience

AJAX and Rich Internet Applications

AJAX has become an increasingly popular tool to develop RIAs. With AJAX, as with many new technologies, developers often overlook core application issues such as error handling. While many current AJAX frameworks come with ways to handle errors, the built-in error-handling methods might not be quite what you need, and it's possible that you might not even want to adopt a specific AJAX framework at all. So how do you handle errors in AJAX?

This article will guide you through one possible way to implement custom error handling in AJAX using many of the same techniques that you'll likely read about in other parts of this magazine. Because AJAX represents a big paradigm shift in the way users interact with Web applications, it's easy to leave your users confused when things don't quite work as they'd expected. To enhance the user experience, it's equally important to alert them when something goes exactly as planned and enhances the interactive experience.

Consider for a moment a hypothetical AJAX application that updates employee information. Users will fill out fields and click on a "Save" button to process the update. In a traditional Web application the user expects to wait a moment while the server updates the record then anticipates another page that displays a confirmation message. This is the typical request/return scenario that our Internet conditioning forces us to accept.

Now let's look at the same example using AJAX techniques. The end user still fills out form fields and clicks on the "Save" button but instead of seeing the confirmation message, nothing seems to happen. This can leave the user confused and unsure that his information was saved, yet with AJAX, the database update occurred exactly as expected. Here's how you can implement a messaging and error system in a simple employee information maintenance application that will alert a user as records are updated.

Process at a Glance
The process isn't much different from any typical AJAX request/response. A request is created, sent to the server, checked for error conditions, XML is sent back to your request page, and checked in the browser for a status message, which is displayed, if it exists.

Create an Area to Display Status Messages
We'll begin to create our code by creating our CSS format classes for our status messages. Let's create three styles for our application's potential conditions: error, success, and hidden, which correspond to the two cardinal states (error and success) of our query (hidden being used when no update is currently active):

.error{
     font-family: Arial, Helvetica, sans-serif;
     font-size: 10px;
     font-weight: bold;
     color: #FFFFFF;
     background-color: #FF0000;
     display:block;
}
.success {
     font-family: Arial, Helvetica, sans-serif;
     font-size: 10px;
     font-weight: bold;
     color: #FFFFFF;
     background-color: #009900;
     display:block;
}
.hidden {
     display:none;
}

Once we have our styles set, we have to put them to use. We'll do this by creating an area in our application to display the status messages returned by the server. This display area can be any type of HTML container such as table, div, or span; we'll use a div. Once the container is created, we'll set the initial style to hidden, as follows:

<div id="message" name="message" class="hidden"></div>

Creating the ColdFusion Page To Process the Request.
At this point, you'll find that the code you've created doesn't do much - you have three CSS styles, one of which is called by your container div, but its class is set to not display on the rendered page. To create conditions where an error or success message might actually exist, we'll look at a ColdFusion template that updates an employee's database record. Since the focus of this article is on error handling we'll skip the details of updating the record and get right to the process of building the XML that returns our status message.

First let's look at an example of processing an update of one of our employee records. Since this is a situation where no data is being returned (because we're not using a SELECT statement), we really only need to deliver either a success or error message to our user.

To do this, we'll have to create a variable to hold the XML string then add the XML declaration to it:

<cfset xml = "<?xml version=""1.0"" encoding=""UTF-8"" standalone=""yes"" ?>">

Now that we've created our variable, "xml," we're going to want to do some simple data validation - in this case, to make sure that a valid department ID was passed into the template. If the department ID passed in is not valid, we're going to want to set the first node of the XML document to (<error>), add the error message, and close the error node (</error>). For our purposes, we'll assume that a "departmentID" value of 0 or of a non-numeric value constitutes an invalid condition. We're also going to include "try/catch" conditions to cover database errors and general failures:

<cfif departmentId eq 0 OR NOT IsNumeric(departmentId)>
<cfset xml = xml & "<error>Invalid department specified.</error>">
<cfelse>
     <cftry>
<cfcatch type="database">
     <cfset xml = "<?xml version=""1.0"" encoding=""UTF-8"" standalone=""yes"" ?>
<error>There was a error communicating with the server, please call the help desk at
x555.</error>">
</cfcatch>
<cfcatch type="Any">
<cfset xml = "<?xml version=""1.0"" encoding=""UTF-8"" standalone=""yes"" ?>
<error>There was a error processing your request. Please try again later or call the help
desk at x555.</error>">
</cfcatch>
</cftry>
</cfif>

One thing to note here is that the entire XML string is overwritten in the catch statement. This eliminates a situation caused by an error being thrown in the middle of building the XML string. Specifically this condition sends an incomplete and unpredictable XML document back to the requesting page.Let's walk through an example of a successful and unsuccessful update of an employee record. The main screen of the employee update application is shown in Figure 1. For this example let's say that a phone extension can only be used once per employee in a company. When a user clicks on the "Update Employee" link the main screen will prepare the AJAX request and send it to a ColdFusion template. The template will then process the update and send a XML message back to the main screen.

More Stories By Ryan Anklam

Ryan Anklam is the Chief Information Officer at Innova Creative Media, Inc. His current focus is on using ColdFusion to develop large scale hosted applications. Ryan has been developing ColdFusion applications since 1996. In addition, he is also a Microsoft Certified Professional with demonstrated skills in C# and SQL Server.

Comments (6)

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.


IoT & Smart Cities Stories
In his general session at 19th Cloud Expo, Manish Dixit, VP of Product and Engineering at Dice, discussed how Dice leverages data insights and tools to help both tech professionals and recruiters better understand how skills relate to each other and which skills are in high demand using interactive visualizations and salary indicator tools to maximize earning potential. Manish Dixit is VP of Product and Engineering at Dice. As the leader of the Product, Engineering and Data Sciences team at D...
Bill Schmarzo, Tech Chair of "Big Data | Analytics" of upcoming CloudEXPO | DXWorldEXPO New York (November 12-13, 2018, New York City) today announced the outline and schedule of the track. "The track has been designed in experience/degree order," said Schmarzo. "So, that folks who attend the entire track can leave the conference with some of the skills necessary to get their work done when they get back to their offices. It actually ties back to some work that I'm doing at the University of San...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...
Bill Schmarzo, author of "Big Data: Understanding How Data Powers Big Business" and "Big Data MBA: Driving Business Strategies with Data Science," is responsible for setting the strategy and defining the Big Data service offerings and capabilities for EMC Global Services Big Data Practice. As the CTO for the Big Data Practice, he is responsible for working with organizations to help them identify where and how to start their big data journeys. He's written several white papers, is an avid blogge...
Dynatrace is an application performance management software company with products for the information technology departments and digital business owners of medium and large businesses. Building the Future of Monitoring with Artificial Intelligence. Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more busine...
Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities - ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups.
Chris Matthieu is the President & CEO of Computes, inc. He brings 30 years of experience in development and launches of disruptive technologies to create new market opportunities as well as enhance enterprise product portfolios with emerging technologies. His most recent venture was Octoblu, a cross-protocol Internet of Things (IoT) mesh network platform, acquired by Citrix. Prior to co-founding Octoblu, Chris was founder of Nodester, an open-source Node.JS PaaS which was acquired by AppFog and ...
The deluge of IoT sensor data collected from connected devices and the powerful AI required to make that data actionable are giving rise to a hybrid ecosystem in which cloud, on-prem and edge processes become interweaved. Attendees will learn how emerging composable infrastructure solutions deliver the adaptive architecture needed to manage this new data reality. Machine learning algorithms can better anticipate data storms and automate resources to support surges, including fully scalable GPU-c...
Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
The standardization of container runtimes and images has sparked the creation of an almost overwhelming number of new open source projects that build on and otherwise work with these specifications. Of course, there's Kubernetes, which orchestrates and manages collections of containers. It was one of the first and best-known examples of projects that make containers truly useful for production use. However, more recently, the container ecosystem has truly exploded. A service mesh like Istio addr...