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

Building a Zip Code Proximity Search with ColdFusion

The new challenges and possibilities are numerous

Recently I was tasked with improving our Web site's Reseller Locator application. This tool helps potential customers in the U.S. find a product reseller in their state. By choosing a state from a drop-down box, a listing of all resellers located in that state is displayed.

Over the years, as more and more resellers have signed on to sell our products, some problems with this application have surfaced:

  • Some states, such as California, display a very long list of resellers, and customers may never contact those listed near the bottom.
  • The states with smaller populations such as North Dakota may not have any resellers to list.
  • Competitors could use the tool to easily find all our resellers, and may steal these valuable partner relationships.
The Solution Is Defined
We needed a solution to solve these problems, and searching by zip codes appeared to be the answer. The new tool would ask the customer to enter their five digit zip code in a text box and select a search radius of 25, 50, or 100 miles. We wanted to limit the search to 100 miles, to keep the results to an appropriate number and prevent our competitors from entering 2,000 miles and getting a huge list all at once. For example, I might search for all resellers within 50 miles of 55113. This time a list of resellers in close proximity to St. Paul, MN, is displayed, ignoring those 200 miles north in the city of Duluth. Implementing this approach addressed each problem, respectively:
  • A shorter list would result from the search, containing only the resellers located near the customer's zip code.
  • The list can cross state boundaries, now that it will find all resellers located within the specified radius to the customer, and hopefully would show results for zip codes in states like North Dakota.
  • Competitors can still use the tool to find our resellers, but they'll have to work much harder to get the information with the 100 mile limit.
The "Webmonkey" Demo
I've used many store locator Web applications, such as finding the nearest Quiznos or Best Buy, and always wondered how they worked. Now I had the opportunity to learn something brand new, and I began my quest for how to accomplish the Reseller Locator zip code search by starting where everybody does: Google! I quickly found a great tutorial article with sample ColdFusion code on webmonkey.com. The article was written by Robert Capili and titled Proximity Searches for Fun and Profit. The stars were aligned that day, since Robert published his article three weeks before I started my project. It was perfect timing, because as I started reading, it became apparent that this was exactly what I needed to get my feet wet. In the article Robert discusses four primary ways to calculate zip code proximities:
  1. Pythagorean Theorem (remember this trig equation? a2 + b2 = c2)
  2. Spherical Law of Cosines (Pythagorean theorem for triangles drawn on a sphere)
  3. Haversine Formula (most accurate way to calculate distance on a sphere)
  4. Square Search (Robert's speedy solution)
For each method, he explains some background information, how it calculates results, how it performs (speed versus accuracy), and his usage suggestions. I encourage you to read it when you finish this article (or now if you feel the need) to dive deeper into this topic: www.webmonkey.com/webmonkey/05/32/index4a.html?tw=programming. In a nutshell, Robert recommends method #4. He improved upon the speed produced by the Pythagorean method and developed the Square Search. It performs the fastest, but does not take into account the spherical shape of the earth, which the Haversine formula is best at. However, as long as you are not in need of absolute pinpoint accuracy, the Square Search is the way to go for most applications.

Testing the Sample Code
Included in the sample code is a ColdFusion Component, zipfinder.cfc, that implements each of the four search methods. It also contains a testing template, zip.cfm, that has a basic search form, containing a zip code text box and radius text box. Finally, it contains a database file, zipDB. My first step to getting set up was a quick visit to our company's DB Admin, who helped me perform a restore of the SQL database file, zipDB. The database restore creates a single table that contains 29,470 zip code records. Next, I opened Application.cfm and modified the variable application.dsn to use the correct value for our datasource name. Now on to some real testing. I pointed my browser to the zip.cfm template and saw the search form. After entering a zip code and radius in the text boxes, what you get are four cfdumps of the recordsets returned from the CFC, as well as the execution times. Each query gets the city, state, zip code, and distance from the specified zip code. Table 1 and Table 2 show the partial output from a search of 55113.

I soon realized why he recommended the Square Search. The execution time was faster than each of the other methods, and the distance results were very close to the Haversine Formula. After a few more tests, it was soon time to put the final pieces together.

Integrating the Solution
Now I needed to take the recordset returned by the Square Search method and put it to use in my application. We have a database table (actually a view) of resellers that includes the field: zipcode. Nothing special here; most of us are familiar with SQL tables that contain address information broken out in separate fields. All I needed to do was create a new query against the reseller table, and make sure a reseller's zip code was found among the zip codes in the recordset returned by the CFC. The code and query looked like this:

<cfinvoke component="zipfinder" method="squareSearch" radius="#URL.miles#"
zip="#URL.zip#" returnvariable="results"></cfinvoke>

<cfif NOT results.recordcount>
   Sorry, no zip codes found within #URL.miles# miles of #URL.zip#.
   <cfabort>
</cfif>

<cfquery name="get_resellers" datasource="#dsn#">
select *
from PartnerView
where zipcode IN (#ListQualify(ValueList(results.zip),"'")#)
and Country = 'USA'
order by CompanyName
</cfquery>

The first block of code invokes the CFC, calling the SquareSearch method. Next, I verify at least one record is returned. If not, I stop right there and let the user know with a friendly error message. Last, I perform a search against our resellers, using the clause:

where zipcode IN (#ListQualify(ValueList(results.zip),"'")#)

Based on the sample records I listed earlier, the actual query might look like:

select *
from PartnerView
where zipcode IN ('55113','55108','55117','55103','55114','55104','55414','55101','55418')
and Country = 'USA'
order by CompanyName

The ListQualify() and ValueList() ColdFusion functions come in handy here. ValueList() converts a query column into a comma-delimited list, then ListQualify() slaps a single quote around each item in the list. This is exactly what is needed to use as the expression on the right-hand side of the IN clause. All that's left is to display the results from the get_resellers query in a nice HTML format, and the customer has the information he or she needs to make a couple of phone calls that will hopefully lead to a future sale!

More Stories By Troy Pullis

Troy Pullis works as a senior Web developer for Secure Computing Corporation (www.securecomputing.com) and also manages the Twin Cities ColdFusion Users Group (www.colderfusion.com). He is a Certified Advanced CFMX Developer. Back in 1999, Troy shifted his client/server Java programming career to focus on the Internet boom. He immediately started using ColdFusion, began attending CFUG meetings, and has never looked back.

Comments (3) 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
CFDJ News Desk 12/15/05 06:33:24 PM EST

Building a Zip Code Proximity Search with ColdFusion. Recently I was tasked with improving our Web site's Reseller Locator application. This tool helps potential customers in the U.S. find a product reseller in their state. By choosing a state from a drop-down box, a listing of all resellers located in that state is displayed.

CFDJ News Desk 12/15/05 06:03:25 PM EST

Building a Zip Code Proximity Search with ColdFusion. Recently I was tasked with improving our Web site's Reseller Locator application. This tool helps potential customers in the U.S. find a product reseller in their state. By choosing a state from a drop-down box, a listing of all resellers located in that state is displayed.

@ThingsExpo Stories
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 ...
"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...
In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
"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...
Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
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.
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, 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.
Large industrial manufacturing organizations are adopting the agile principles of cloud software companies. The industrial manufacturing development process has not scaled over time. Now that design CAD teams are geographically distributed, centralizing their work is key. With large multi-gigabyte projects, outdated tools have stifled industrial team agility, time-to-market milestones, and impacted P&L stakeholders.
"Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
"Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, 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.
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 ...
"There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, 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.
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
SYS-CON Events announced today that Telecom Reseller has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.
It is of utmost importance for the future success of WebRTC to ensure that interoperability is operational between web browsers and any WebRTC-compliant client. To be guaranteed as operational and effective, interoperability must be tested extensively by establishing WebRTC data and media connections between different web browsers running on different devices and operating systems. In his session at WebRTC Summit at @ThingsExpo, Dr. Alex Gouaillard, CEO and Founder of CoSMo Software, presented ...
WebRTC is great technology to build your own communication tools. It will be even more exciting experience it with advanced devices, such as a 360 Camera, 360 microphone, and a depth sensor camera. In his session at @ThingsExpo, Masashi Ganeko, a manager at INFOCOM Corporation, introduced two experimental projects from his team and what they learned from them. "Shotoku Tamago" uses the robot audition software HARK to track speakers in 360 video of a remote party. "Virtual Teleport" uses a multip...
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...
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.
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...
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 ...