1. No category

Contents
I
Table of Contents
Part I Introduction
3
1 Server Requirements
................................................................................................................................... 4
2 ionCube
................................................................................................................................... 5
3 Source Guardian
................................................................................................................................... 6
4 MySQL Database
................................................................................................................................... 7
Part II Installing
9
1 Which version...................................................................................................................................
to install?
9
2 Uploading Files
................................................................................................................................... 10
Uploading with
..........................................................................................................................................................
the Auto Uploader Tool
11
Walk-Through
......................................................................................................................................................... 12
Uploading with
..........................................................................................................................................................
FTP
22
3 Installation Script
................................................................................................................................... 25
4 Google Maps...................................................................................................................................
API
35
5 10 Troubleshooting
...................................................................................................................................
Tips
37
6 Upgrading ................................................................................................................................... 39
Part III Front-End
40
1 Templates ................................................................................................................................... 44
How To Customize
.......................................................................................................................................................... 45
About Smarty..........................................................................................................................................................
Templates
49
Smarty Template
..........................................................................................................................................................
Tips
50
2 Languages ................................................................................................................................... 52
Part IV Admin Panel
53
1 Logging In ................................................................................................................................... 53
2 Admin Home................................................................................................................................... 56
3 Records
................................................................................................................................... 57
4 Zip / Postal Codes
................................................................................................................................... 64
5 Configuration
................................................................................................................................... 67
6 Miscellaneous
...................................................................................................................................
Tasks
74
7 Help
................................................................................................................................... 80
Part V Importing
1 Locations
83
................................................................................................................................... 83
2 Category Assignments
................................................................................................................................... 87
2007 Web Logic Media, Inc.
I
II
Ultimate Locator v3
Index
0
2007 Web Logic Media, Inc.
Introduction
1
Introduction
What is the Ultimate Locator v3?
Ultimate Locator v3 is a web server application
that will allow a website owner the ability to
offer their website visitors a means to searching
a database via a zip code, a state/province
name, a city name, a location name or even a
country name. Ultimate Locator is a
sophisticated system that will determine a result
based on many factors, one being the
geographical location that is closest to the user.
Our new v3+ now supports Products and
Categories which will allow you to offer filters
searching on your locations.
What can Ultimate Locator v3 be used for?
Ultimate Locator v3 can be used to find just
about anything that has a physical address.
Including, but not limited to, Retail Outlets,
Dealers, Vendors, Warehouses, Distributors,
Banks and ATM, Hotels, Car Lots, Members,
Friends and Family. The list goes on...
How do I control the data that is used by
Ultimate Locator v3?
Ultimate Locator v3 comes standard with an
online Administrator's Control Panel. The
Admin Panel is an online tool that you use to
control the records and the settings of the
program. Login anytime to the Control Panel to
make changes, import more records or make a
backup of your entire system. The heart of the
locator is the Admin Control Panel and is
available to you by logging in via your Internet
web browser.
Who uses Ultimate Locator v3?
2007 Web Logic Media, Inc.
3
4
Ultimate Locator v3
Ultimate Locator v3 can be used by any individual who owns a website and needs to offer a
solid solution for allowing their visitors to find the nearest location to them. We have
installed Ultimate Locator on websites for many different industries. Some of our customers
include: Medical Supply Manufacturers, Clothing Manufacturers, Pharmaceutical
Distributors, Auto Parts Distributors, Boot/Shoes Manufacturers, Organizational Member
Directories, Free Directories, Paid Directories, Insurance Companies, Motorcycle Dealers,
Banks, Auditors and a dozen other.
How long has Web Logic Media been around?
The people behind Web Logic Media, Inc. (the copyright holders of Ultimate Locator v3)
have been designing websites and web programs since 1996. It was in 2002 when the
founding member was hired by a small company to build a searchable member directory that
was available online to all their members. It was at that point that we decided to take it to
the next level and begin designing a web application that would rival the expensive "Popular"
locator systems on the market. It took our team over 10 months and well over 30,000 lines
of custom php code. Ultimate Locator v3 v1.0 was officially released on May 01, 2004.
How does Ultimate Locator v3 compare to other Locator Applications?
Ultimate Locator v3 has many, if not most of the features that the expensive locator systems
use. It even has custom features that no other locator application has. Overall, you can
achieve greater results with Ultimate Locator v3 than what you can with most any other
"High Priced" locator application on the market today.
Some of our unique features include:
1.1
•
Ability to allow your website visitors to add records to your database
•
4-Tier Ranking System to better control the desired output
•
Limit the number of times a user can perform a search
•
Full Category system and Products implementation for each record
Server Requirements
Minimum Server Requirements:
Your web server must meet the following minimum requirements:
2007 Web Logic Media, Inc.
Introduction
5
Operating System: Linux, Unix,
FreeBSD or Windows
Web Server: Apache or IIS
Scripting Language: PHP 4.3+
Database: MySQL 3.23+ (v4.1.2+
for advanced features*)
Encoding: Ability to run ionCube
5 or SourceGuardian 6 encoded
files
PHP's Safe_Mode turned off
GD 2.0 is required to utilize captcha
If your web server, where you plan to install Ultimate Locator v3, does not meet these
requirements or you don't know for sure if it does, then please contact your hosting support
team and ask them to look into your account. They will know if your account will meet these
requirements.
* Advanced features include Category and Product searching, which will not function
normally without MySQL server version 4.1.2 or higher.
1.2
ionCube
What is ionCube and why do I need it?
ionCube is a method of protection for php scripts. It helps us protect our software from
piracy while being able to deliver the software at an affordable price. Some files within your
software are encoded (encrypted) with ionCube Encoder.
When php files are not encoded, they code can be read, changed, edited or copied and
programmed to be run on any php enabled server. In order to stay competitive and to
remain a leader in the proximity locator software industry, we must 'encode' or 'encrypt' our
source code with ionCube Encoder in order to protect our rights as the original owner.
2007 Web Logic Media, Inc.
6
Ultimate Locator v3
Since we choose to deliver our software with ionCube Encoding, it means that ionCube
Loaders are required to be installed on your server to run Ultimate Locator v3. In most
cases, it's not hard to get your server to have ionCube support. In fact, there are 3 methods
available for integrating ionCube into your server, if it's not already there...
1. Our Auto Uploader 12 tool will try to install the ionCube Runtime Loaders during install of
the software if ionCube is not already installed on your server. When you download your
software, there will be an included executable (Locator_Setup.exe) file along with all the
program files. You can choose to launch this executable file to help aid in uploading the files
to your server. Plus, this tool will attempt to change file permissions and also ensure
ionCube support is available, and install it if it's not.
2. Integrate ionCube into your php.ini file. This is the recommended method, as having
ionCube built into php is the most reliable. You'll need root access to your server in order to
edit your php.ini file. Instructions for Manual Installation in the php.ini file can be found here.
3. Install the Runtime Loaders yourself, by downloading the files from ionCube.com and
FTPing the files to your server in a new /locator/ioncube folder. Instructions for using
Runtime Loading can be found here.
You can learn more about the ionCube Encoder requirements by visiting www.ioncube.com
Note: ionCube Runtime Loaders will not work if your php settings have Safe_Mode turned
on.
1.3
Source Guardian
What is Source Guardian and why do I need it?
Source Guardian is a method of protection for php scripts. It helps us protect our software
from piracy while being able to deliver the software at an affordable price. Some files within
your software are encoded (encrypted) with Source Guardian encoding.
When php files are not encoded, they code can be read, changed, edited or copied and
programmed to be run on any php enabled server. In order to stay competitive and to
remain a leader in the proximity locator software industry, we must 'encode' or 'encrypt' our
source code with Source Guardian in order to protect our rights as the original owner.
2007 Web Logic Media, Inc.
Introduction
7
Since we choose to deliver our software with Source Guardian Encoding, it means that
Source Guardian Loaders are required to be installed on your server to run Ultimate Locator
v3. In most cases, it's not hard to get your server to have Source Guardian support.
Our Source Guardian encoded files require a few special files to be on your server. These
files are called 'loaders' and simply need to be placed on your server in their own folder.
Simply make sure you have a folder named /locator/ixed and it has the appropriate file for
your server type. We include all the 'ixed loaders' you might need along with your software
so you don't have to worry about finding and loading them.
Source Guardian files work with all versions of PHP.
Most operating systems and installations of PHP will load our encoded scripts without any
modification. PHP will be able to find and load the appropriate loader if the following
conditions are met:
1) Operating system and PHP mode:
Linux or FreeBSD - PHP installed as CGI or CLI
Linux or FreeBSD - PHP installed as Apache module (with thread safety off)
Windows - PHP installed as CGI or CLI
2) Thread Safety is disabled. You may check phpinfo() output for this.
3) dl() is enabled. You should have enable_dl=On in your php.ini.
4) The PHP extensions directory needs to exist. Please check that the extension_dir= option
in php.ini points to the real directory. Some hosting companies have incorrect installations of
PHP and this can cause problems.
5) The latest ixed loaders are installed in an /ixed/ subdirectory within your scripts directory
or any parent directory. Examples are below:
6) (For windows users only) extension_dir= option in php.ini should point to the directory
located *on the same drive* with your document root and scripts directory.
You can learn more about the Source Guardian requirements by visiting www.
sourceguardian.com
1.4
MySQL Database
Setting up a new MySQL Database
Ultimate Locator utilizes a MySQL database backend. You must manually create your own
2007 Web Logic Media, Inc.
8
Ultimate Locator v3
database before you can install the software. Once you have your database created, our
install script will setup everything else, including all the tables needed and the installation
data. All you must do during the install is input your MySQL Database's Hostname,
Database Name, Username and Password. The install script must have these inputs to
locate your database and continue installation.
Typically if you have a rented server, such as from a hosting company, they will make is
easy to create new mysql databases. Many hosting companies give you an online control
panel, which may have a database manager built in. If so, you can use this tool to create
your new database. If you do not have a control panel, there are other simple ways to
create your database.
The easiest way to create mysql databases are with 3rd party database manager software.
Such as phpMyAdmin or MySQL Administrator
Of course, you can always connect to your MySQL Host remotely, and follow the instructions
below. You can visit W3Schools.com for easy instructions on creating your database with
SQL.
How to Create a new MySQL database manually by hand...
a) Login to MySQL: Firstly, you need to login to the mysql interface, once you login you
should have something like the following output:
> mysql -u root -p
Enter Password: [Enter your root password here]
b) Create Database: Assuming the database name is locator, user is admin, the host is
localhost and the password is admin123, issue the following commands:
mysql > create database locator;
Query OK, 1 row affected (0.02 sec)
mysql > GRANT ALL PRIVILEGES ON locator.* TO admin@"%" IDENTIFIED BY
'admin123' WITH GRANT OPTION;
Query OK, 0 rows affected (0.01 sec)
mysql > exit
Bye >
These commands will create a new database named locator and assign the user admin to
2007 Web Logic Media, Inc.
Introduction
9
this database.
Additionally you can also use control panels like CPanel, Ensim or Plesk to create a
database and assign users under it.
Check with your hosting company first to see if their hosting control panel offers you a way
to create your own MySQL databases and users.
We Install... If you don't' feel comfortable installing the software, our team can do it for a
nominal fee. Just contact support.
2
Installing
2.1
Which version to install?
Wondering which version to download and install? Maybe this will help....
When you login to your member's account to download the software, you'll notice there are
several versions available for download.
They include...
1. Ultimate Locator ionCube
2. Ultimate Locator ionCube Auto-Uploader
3. Ultimate Locator SourceGuardian PHP4
4. Ultimate Locator SourceGuardian PHP5
First, determine if you want to download the ionCube version or SourceGuardian version. If
you choose ionCube, then your server must support ionCube encoded files. If you choose
SourceGuardian, then your server must support SourceGuardian encoded files. And you
will have to choose between PHP4 or PHP5 for SourceGuardian, depending on which
version of PHP is installed on your server.
In most cases, our SourceGuardian version will install and run without any problems and
without any modifications to your server. If you seem to be having trouble getting the
SourceGuardian version running as intended, then try installing the ionCube version. Of
course, if you know your server already has ionCube support built into your php.ini file, it will
be best to use our ionCube version.
ionCube and SourceGuardian work much in the same way, regarding their requirements.
2007 Web Logic Media, Inc.
10
Ultimate Locator v3
Both can run on any server without extra server modifications, as long as the required
'loaders' are present and PHP's Safe_Mode is off. So, in either case, always make sure you
have a folder inside your /locator folder named /ioncube or /ixed. The /ioncube folder will
need to contain any ionCube loader files and the /ixed folder will need to contain any
SourceGuardian loader files.
Recommendations...
If you are installing on:
Linux or FreeBSD platform servers: Then try installing the ionCube Auto-Uploader
version first, then SourceGuardian
Windows platform servers: Try installing the SourceGuardian version first, then ionCube
The ionCube Auto-Uploader version will not be successful on a windows server. Don't wast
your time downloading and using the Auto-Uploader tool if you are wanting to install on a
Windows platform server.
2.2
Uploading Files
Uploading the files to your server
We have two step-by-step walk-through available depending on how you are trying to
upload...
- Auto Uploader Tool 11
Click this link if you plan on uploading your files, setting permissions and checking for
ionCube support with the Auto Uploader Tool (Locator_Setup.exe file in your download).
Recommended for Unix, Linux and FreeBSD servers
or
- FTP
22
Click this link if you plan on uploading your files, setting permissions and installing ionCube
manually yourself. Recommended for Windows servers.
2007 Web Logic Media, Inc.
Installing
11
click a link above to view that set of instructions
* We recommend using an FTP program to upload the files if you are uploading to a Windows platform server.
The Auto Uploader Tool does not typically work well on a windows server and will not be able to set file
permission nor install ionCube if needed.
2.2.1
Uploading with the Auto Uploader Tool
Steps for uploading with the Auto Uploader Tool:
1. Download the Software:
Simply login to your Ultimate Locator v3 Member's Account and click the link provided to
download the software to your computer. It will be a compressed (zip) file. Save the Zip file
to your local hard drive when prompted.
2. Extract the Zip file:
After you have downloaded the Zip file to your computer, you will have to extract (Unzip) the
files onto your computer's hard drive. You will have to use software programs such as
WinZIP or PKZip to do this. Windows XP users may have Unzipping built in to their
operating system. If you do not, you will need to install the unzipping software.
3. Launch the Auto Uploader:
After unzipping the download, you will have a new file named Locator_Setup.exe on your
hard drive. Simply launch this file by double-clicking it. You will be presented with a few
screens that will ask you for your server's FTP information so that the setup can connect to
your server and upload the files automatically. You can get more help (with screenshots) on
the Auto Uploader tool Walk-Through here 12 .
Setup will also attempt to change permissions on a few select files and folders. If it fails with
this step, it will notify you that it could not change permissions and will ask you to do this
manually. In most cases, Setup will not be able to change permissions on a windows
server.
Setup will also verify if ionCube is installed on your server. Auto Uploader will detect your
server type and automatically upload the correct ionCube loaders to your server, if they are
not already detected and installed.
Complete all steps of the Auto Uploader to have Ultimate Locator v3 installed onto your web
server. After setup is complete, you will be automatically taken to the install.php script on
your server where you will continue setting up your software through your web browser.
2007 Web Logic Media, Inc.
12
Ultimate Locator v3
If you experience trouble using the Auto-Uploader tool, you do have the option to install via
FTP manually. See FTP Installation 22 for help with this method..
2.2.1.1
Walk-Through
Here is a brief tutorial on how to successfully use the Auto Uploader tool to get the Ultimate
Locator v3 files uploaded to your web server.
The Auto Uploader tool is a part of your download. It is an executable (.exe) file and should run on Windows 95,
98, 2000 and XP.
The Auto Uploader has 3 main purposes:
1. Upload all files to your server and test for compatibility
2. Change the permission on files/folders automatically *
3. Test for ionCube on your web server and install the loaders if they are not present. *
* Auto Uploader will attempt this task. But we can not guarantee successful completion. It all depends on your
server's settings.
After you have downloaded the software from your Member's Account, you will need to extract the files from the .
zip archive. You will then find a new executable file named Locator_Setup.exe. Double click this file to launch
the Auto-Uploader tool.
Screenshot Walk-Through:
2007 Web Logic Media, Inc.
Installing
13
The opening screen will welcome you to the Installation Wizard If previous installs have
been detected, it will list them and allow you to continue with those installs. For brand new
installs, always choose the "Fresh Install" selection.
2007 Web Logic Media, Inc.
14
Ultimate Locator v3
If you wish to install the software, you must select the "I accept the agreement" choice.
2007 Web Logic Media, Inc.
Installing
15
You can choose the "Install to a remove machine" or "Install to this Machine" for your
installation type. In most cases, you will want to choose "Install to a remote machine".
Choosing Install to a remote machine, means you must provide FTP info to the Auto
Uploader and it will transfer all files over to your server for you.
Choosing Install to this machine, means all files will be copied over to the computer you
are currently working.
2007 Web Logic Media, Inc.
16
Ultimate Locator v3
If you are installing to a Remote Machine, this screen will ask for your FTP Login info. Type
in your FTP server address, FTP username and FTP password. Click the browse button to
connect to your server and to designate the folder you wish to install into.
After clicking the "Browse" button, you will be connected to your server, and you can
navigate to the folder where you wish to install Ultimate Locator v3. Or you can create a
new folder as well by clicking the button "Make New Folder". We recommend you create a
new folder in your web accessible folder and name it locator.
2007 Web Logic Media, Inc.
Installing
17
If you create a new folder, do make sure you are creating this under a web accessible
folder. Typically your web accessible folder will contain your website's index page and your
other website pages.
2007 Web Logic Media, Inc.
18
Ultimate Locator v3
After clicking the Next button, the Auto Uploader will now run through several steps that will
test your server.
2007 Web Logic Media, Inc.
Installing
19
This screen is asking for your URL that points to the location you have chosen on the
previous step. If you are installing your locator system inside a new folder named 'locator',
then you would want to enter http://www.mysite.com/locator/.
Just make sure you type in the full URL to your locator. Including the http:// part.
2007 Web Logic Media, Inc.
20
Ultimate Locator v3
Notice how above, our 'Directory" and our "Directory URL" above, both end with the /locator
folder. That is important and must be the same every time or you will get errors.
The above screen is a 'Summary' of things to happen during install. It will tell you if
permission can be set, if ionCube was found in php.ini and if not, then it runtime ionCube
loaders will work on your server.
After reviewing your selections, you can click the 'Install' button to begin the uploading of
your system.
2007 Web Logic Media, Inc.
Installing
The screen shows you the upload progress.
2007 Web Logic Media, Inc.
21
22
Ultimate Locator v3
The final screen is the Completion Screen. Click the Finish button to close the Auto
Uploader program and to launch your web browser which will take you to the install.php file
on your server where you need to finish the installation steps to configure your locator and to
build your MYSQL database 7 .
2.2.2
Uploading with FTP
Steps for uploading with FTP:
1. Download the Software:
Simply login to your Ultimate Locator v3 Member's Account and click the link provided to
download the software to your computer. It will be a compressed (zip) file. Save the Zip file
to your local hard drive when prompted.
2. Extract the Zip file:
After you have downloaded the Zip file to your computer, you will have to extract (Unzip) the
files onto your computer's hard drive. You will have to use software programs such as
WinZIP or PKZip to do this. Windows XP users may have Unzipping built in to their
operating system. If you do not, you will need to install the unzipping software.
2007 Web Logic Media, Inc.
Installing
23
At this point, you should have the downloaded zip file unzipped and the contents of your
download onto your computer. Just make sure you remember the locations where you
saved your file. You'll need to access it later.
3. Create a new Folder on Your Server:
If you haven't done so already, create a new folder on your web server named locator. Just
be sure to create this new folder in your public or web accessible directory on your web
server. It should be created in the same folder where your homepage is located. i.e.: http://
www.domain.com/locator
4. Upload the files:
Using your FTP client, locate your download and browse it until you find the /locator folder.
The contents of this folder is what we are looking for and will be uploading to your server.
Upload all the files inside the /locator folder on your local computer and store them inside
the web server's /locator folder. You can use 'Auto' transfer mode and your FTP client
should upload all text/php files in ASCII and all image files in BINARY for you automatically.
If not, please use the same transfer modes as just stated.
Once the entire contents of the /locator folder on your local computer are transferred to your
web server, you are done uploading
5. Set Permissions:
Ultimate Locator v3 needs special write permission on some files and folders on your server.
In order to perform an import or backup, the program must be able to write to files on your
server. By default, your files and folders to do not have any special permission. So you
must change them yourself.
You will have to change the permission of the following files and folders manually to have
full read and write permissions.
FOLDERS: (Set to CHMOD 777 on Linux servers)
/locator/locationimages
/locator/templates_c
/locator/admin/templates_c
/locator/dbackup
2007 Web Logic Media, Inc.
24
Ultimate Locator v3
/locator/dbackup/restore
/locator/dbackup/zipdata
/locator/dbackup/category
/locator/admin/install/templates_c
FILES: (Set to CHMOD 666 on Linux servers)
/locator/admin/mysql.php
/locator/css/admin.css
/locator/css/front_end_layout.css
/locator/css/visitor_add_form.css
/locator/css/tab-view.css
/locator/templates/generic_message.tpl
/locator/templates/result_details.tpl
/locator/templates/results_list_online.tpl
/locator/templates/search_form_int.tpl
/locator/templates/search_limit.tpl
/locator/templates/index.tpl
/locator/templates/results_list_format_online.tpl
/locator/templates/results_list.tpl
/locator/templates/search_form_online.tpl
/locator/templates/visitor_add.tpl
/locator/templates/print.tpl
/locator/templates/results_list_format.tpl
/locator/templates/search_form_ca.tpl
/locator/templates/search_form_us.tpl
The way a file permission is changed for a file or a folder is different among server types.
With a Unix/Linux based system, you can simply change file permission with most FTP
software. On a Windows server, you will have to launch your hosting control panel and give
a specific web user (everyone) full read/write/modify access to these files/folders. Always
ask your hosting support team or web administrator what the best way to change file
permissions are. Their help documents will probably inform you as well.
2007 Web Logic Media, Inc.
Installing
2.3
25
Installation Script
Steps for Installing the program:
Now that all the files are on your server inside the new /locator directory and you have the
proper read/write permissions on the files and folders that need them, you are ready to
begin the real installation/configuration of the locator system.
You need to launch the installation script by pointing your browser to your install.php file on
your server. Open your browser and type in your URL to your install.php file.
i.e.: http://www.mysite.com/locator/admin/install/index.php
Of course, you need to replace the mysite.com above with your real domain.
You will be asked a series of questions in order to setup the locator properly. Please follow
the instructions on each screen. In order to complete this installation script, you will need to
supply your mysql database info on Step 3. Be sure you have already setup a new
database and have the hostname, database name, username and password. This info is
needed.
Screen 1: Welcome Screen
2007 Web Logic Media, Inc.
26
Ultimate Locator v3
Screens 2 and 3: Check System Files
2007 Web Logic Media, Inc.
Installing
Screen 4: Check File Permissions
Screen 5: Enter MySQL Info
2007 Web Logic Media, Inc.
27
28
Ultimate Locator v3
Screen 6: Test MySQL Results
2007 Web Logic Media, Inc.
Installing
Screen 7: Create MySQL Tables
2007 Web Logic Media, Inc.
29
30
Ultimate Locator v3
Screen 8: MySQL Tables Results
2007 Web Logic Media, Inc.
Installing
Screen 9: Create Super Admin Account
2007 Web Logic Media, Inc.
31
32
Ultimate Locator v3
Screen 10: Create Account Results
2007 Web Logic Media, Inc.
Installing
Screen 11: Installation Complete
The next screen you will see is the login screen to your Admin
Panel:
2007 Web Logic Media, Inc.
33
34
Ultimate Locator v3
2007 Web Logic Media, Inc.
Installing
2.4
35
Google Maps API
Embed Google Maps into your Results Details page....
Starting with v3.1, you now have the option to turn on Google Maps API. The Google Maps
API has the ability to embed an interactive map right into the details page of a record. No
need for your website visitors to click a link and be taken to the google site directly.
Getting your key...
In order to utilize the google maps api service, you must visit google's website and signup
for a new key. It's very easy and only takes 1 minute of your time, but Google requires you
to have a special custom key that is tied in with your domain name.
You must visit the following web page to get your own api key...
http://www.google.com/apis/maps/signup.html
2007 Web Logic Media, Inc.
36
Ultimate Locator v3
Once you get to the above page you will need to agree to the terms and conditions, and
then type in your domain name into the box.
After clicking the button, google will return a very long api key.
You will need to copy this key and paste it into your locator's /include/googlemapsapi.php
file.
Copying the key into your googlemapsapi.php file...
You will need to open the /locator/include/googlemapsapi.php file in a text editor. On line #
7, you will see a place that looks like...
You will need to paste your login api key that google has assigned you into line #7, between
the two apostrophe characters. (yes, leave the two apostrophe characters in place and
paste between them)
2007 Web Logic Media, Inc.
Installing
37
When you are done pasting your long api key code, line #7 should look similar to the
following example...
All done, save the file and then upload to your server via FTP. Be sure to save it in the
folder named: /locator/include
Activating Google Maps API Service
You must login to your Admin Panel and navigate to the General Settings / Mapping tab.
Once there, you will see a drop down where you can turn on Google Maps API. Set this to
Yes to activate.
2.5
10 Troubleshooting Tips
Having trouble installing?
2007 Web Logic Media, Inc.
38
Ultimate Locator v3
Here are a few troubleshooting tips that may help...
1. Always use ASCII mode when uploading files to the server via FTP Typically, you can
use 'auto' mode and your FTP client will handle the mode automatically. Always use
BINARY mode for images, executables, etc.. and ASCII for text or scripting files such as
PHP files.
2. Check File Permissions. More often than not, issues that are hard to track down seem to
stem from files and folder on your server that have not yet had their permissions settings
changes. Always follow the Installation Instructions 22 in full, which include setting file
permissions on specific files and folders within your Ultimate Locator system
3. Always contact your support team for any PHP or MySQL issues. We typically can not
help you very much if your server is having PHP or MySQL problems. Your hosting support
team is responsible for maintaining and running PHP and MySQL on your server and only
they have access to all the system and configuration files.
4. Check our eSupport Section for help. You can visit http://support.ultimatelocator.com 24
hours a day to get help. We provide all users with Trouble Tickets, FAQ Knowledgebase,
Downloads, News and Community Forums.
5. Run some of the test scripts on your server. They are located in your new /locator/
admin/tests folder. You can run the MySQL test, Sessions test and fSock test to see if your
server supports those components.
6. To determine your php settings, you can always create an info.php file and use your
browser to view it. It will show you all of your servers PHP settings and a lot of information
can be obtained from it. To create an info.php file, simply follow these instructions...
1. Create a new text file on your computer and name if info.php
2. Open this text file with a text editor (such as Windows Notepad)
3. Put the following line of code into the file: <?php phpinfo() ?>
4. Save the file
5. Upload the file to your server
6. View the file in your web browser.
7. You should check to see if the directive:" magic_quotes_gpc " is turned off inside your
php.ini file. Usually needs to be off on a Windows Server.
2007 Web Logic Media, Inc.
Installing
39
8. View your mysql.php file in a text editor. Make sure all the values inside it are correct for
your mysql login.
9. If you need access to edit the data in your mysql database, You can access the
WizMySQLAdmin program from within your /locator/admin/mysqladmin folder. It's a single
php file, that will give you direct access to your mysql database. You will be able to view all
your database tables and fields and make direct edits to the values in your tables. Just be
sure to open the /locator/admin/mysqladmin/index.php file in a text editor before you upload
it and add your MySQL login info (username and password) where needed at the top of the
file. Then upload the file to your server and access with your internet browser.
10. If you are running on a Linux/Unix/FreeBSD, and your server supports execution of .
htaccess files, then you can try renaming the X.htaccess file to .htaccess (remove the letter
X). The file is located in your /locator folder.
2.6
Upgrading
Everything you need to know about upgrading your v3 Ultimate Locator
(This does not cover upgrading from a v2.5 or earlier system)
Upgrade from v3.0 to v3.1:
1. Download the v3.1 package from your Member's Account
2. Upload all files to your server. It most cases it would be the /locator folder However, be
sure NOT to upload the mysql.php file that is inside the /locator/admin folder. Doing so
will wipe out your mysql login info and kill your locator system.
3. Run the upgrade script by pointing your browser to yoursite.com/locator/admin/
upgrade3.1.php The upgrade script will add new fields to your database tables that are
needed for the v3.1 requirements. Which adds two fields to the configuration table and
one field to the language table.
4. If you plan on utilizing the new Embed Google Maps feature, then you will need to get
your own Google Maps API Key from Google. Follow the instructions for this procedure
here... 35
Notices:
 Upgrading to v3.1 may reset any customizations you have made to your templates.
 If you have made changes to your index.tpl template, and wish to retain those changes, do
not upload the /locator/templates/index.tpl file to your server. Keeping your old index.tpl
file will retain your customizations and will not affect any v3.1 updates.
 However, all other templates should be uploaded to your server so that you can get the
2007 Web Logic Media, Inc.
40
Ultimate Locator v3
most out of the v3.1 updates. So be prepared to customize your other templates again.
There is no way around this, You should consider making a full backup of your templates
before upgrading, and then using them as a guide for modifying your new v3.1 set of
templates.
These templates include: generic_message.tpl, print.tpl, result_details.tpl, results_list.tpl,
results_list_format.tpl, results_list_format_online.tpl, results_list_online.tpl,
search_form_ca.tpl, search_form_int.tpl, search_form_online.tpl, search_form_us.tpl,
search_limit.tpl and visitor_add.tpl)
3
Front-End
The "Front-End" of your locator system is what your website visitors see when using your
locator search tool. Your visitors can perform The following types of searches against your
database, depending on which navigation Tab they are viewing:
2007 Web Logic Media, Inc.
Front-End
USA:
1. Zip
Code
Search
(within
a
proximit
y)
2.
State
Name
Search
3. City
Name
Search
4.
Locatio
n Name
Search
5.
Catego
ry
Search
6.
Product
Type
Search
2007 Web Logic Media, Inc.
41
42
Ultimate Locator v3
Canad
a:
1.
Postal
Code
Search
(within
a
proximi
ty)
2.
Provinc
e
Name
Search
3. City
Name
Search
4.
Locatio
n
Name
Search
5.
Catego
ry
Search
6.
Produc
t Type
Search
2007 Web Logic Media, Inc.
Front-End
43
Intern
ational
:
1.
Postal
Code
Search
(within
a
proximi
ty)
2.
Provin
ce
Name
Search
3. City
Name
Search
4.
Locatio
n
Name
Search
5.
Catego
ry
Search
6.
Produc
t Type
Search
Online Stores:
There is also an optional 'Online Stores' tab that you can activate, if you have locations that
have your products for sale online. Your users will be able to get a quick list of stores that
sell online with links to the website of that online store.
About this Search Page:
This search page is dynamic and can be controlled within your Admin Panel via the 'Search
Page Settings' tool. You can choose to activate or deactivate any search element. Offer as
little or as much searching capabilities to your visitors as you see fit.
2007 Web Logic Media, Inc.
44
Ultimate Locator v3
Your visitors can enter as much or as little information as they want. The more info they
type in, the more of a specific search the query becomes. Entering a zip code will return
more matches than if entering a zip code and choosing a category. The more specific a
visitor is about what type of search they are wanting to perform, allows them to narrow their
search results.
3.1
Templates
Your locator program is based on a Smarty Templates Engine. Smarty Templates allow you
to use standard HTML coding, plus other advanced coding options inside the template file
itself.
All template files can be edited via the Template Editor Tool inside your Admin Panel. You
can edit any of the templates and add your own html code, javascript, conditional IF
statements. And save the template. There is no need to FTP into the server and download
the template for editing.
Login to your admin panel and click the 'Template Editor' link. You will then see a list of all
editable templates...
2007 Web Logic Media, Inc.
Front-End
3.1.1
45
How To Customize
You can edit any template directly via the Template Editor tool inside your Admin Panel.
You will see a list of all editable templates. Some Knowledge of HTML, Javascript and
Smarty Code may be needed to edit your templates.
Find the template you wish to edit, then click on the edit icon under the 'Action' column...
2007 Web Logic Media, Inc.
46
Ultimate Locator v3
Clicking the edit icon will pull the template up inside the editor box..
2007 Web Logic Media, Inc.
Front-End
47
Make any changes you wish to the template, then click on the 'Save' button to save your
changes.
Here is a quick list of the template filenames and what each template controls...
Template Name
generic_message.tpl
2007 Web Logic Media, Inc.
What it Controls...
Generic Success and Failure messages
48
Ultimate Locator v3
index.tpl
This is the main templates that
encompasses all other templates. It
controls the Header, Content and Footer of
the templates. This single template can be
used to change the entire appearance and
design of your system. Just customize the
Header and Footer sections of this template
with your own code and all output to the
screen will use that same appearance and
design.
print.tpl
This is the template that prints a records
details to the screen when the "Print' link is
clicked. By default it is generic, so you'll
probably want to add your own name or logo
at the top at minimal.
results_list.tpl
This is the template that controls the layout
of the results list after a user performs a
search.
results_list_format.tpl
This is the template that controls the layout
of each record as it gets printed to the
results list. It controls what fields are
printed to the screen for each matching
location.
results_list_format_online.tpl
This is the template that controls the layout
of each online store as it gets printed to the
list.
results_list_online.tpl
result_details.tpl
This is the templates that controls the layout
of the Online Stores list.
This is the template that controls the layout
of the record details page.
search_form_ca.tpl
This is the template that controls the
Canadian Search Tab page.
search_form_int.tpl
This is the template that controls the
International Search Tab page.
search_form_online.tpl
This is the template that controls the Online
Stores Tab page.
2007 Web Logic Media, Inc.
Front-End
search_form_us.tpl
3.1.2
49
This is the template that controls the USA
Search Tab page.
search_limit.tpl
This is the template that controls the search
limit message. The actual text message is
inside the language file, but you can
customize this template even more if
desired.
visitor_add.tpl
This is the template that controls the Visitor
Add a Location page.
About Smarty Templates
Smarty Template Engine
Smarty Templates is new for v3 and above. Smarty is a mainstream engine that has grown
very popular over the last few years and is used in thousands of web programs.
Although Smarty is known as a "Template Engine", it would be more accurately described as
a "Presentation Framework." That is, it provides programmers with a wealth of tools to
automate tasks commonly dealt with at the presentation layer of an application. Its focus is
on quick and painless development and deployment of an application, while maintaining
high-performance, scalability, security and future growth.
For most of our customers, there will be no need to utilize the full capabilities of the Smarty
Template Engine. However, if you need to customize the templates, so there is more
dynamic information presented to your users, you can.
For a Crash Course on the Smarty Templates, you can visit: http://smarty.php.net/
crashcourse.php. There is also a Smarty User Manual here: http://smarty.php.net/manual/
en/
2007 Web Logic Media, Inc.
50
3.1.3
Ultimate Locator v3
Smarty Template Tips
Here are a few tips to help get you to customizing your templates like a pro.
Print a Field:
In many of your front end templates, if you would like for the value of a field to be present on
the page, all you need to do is add the proper variable code to the template.
Example...
Adding the variable code {$location.name} will cause the records 'name' field to be printed.
The variable will be replaced with the location's actual name, such as 'Texas Motorsports,
Inc.'.
Adding the variable code {$location.user1} will cause the records' 'user1' field to be printed.
The variable will be replaced with the location's actual value in the user1 field, such as
'We're open 24hrs a day'. (Obviously, you need to implement user fields and have data in
the user1 field for anything to print.)
If Statements:
If Statements are a great way to test the condition of a variable before you do anything with
it.
Example:
Adding the variable code {if $location.address2 neq ''} <br>{$location.address2} {/if}
will only use the break line code and print the value of the 'address2' field if data is present
in the address2 field. If it's blank, nothing will print.
Adding the code
{if $location.website neq ''}
<a href="http://{$location.website}">Online Store Now Available!</a>
{else}
<a href="{$location.email}">Contact via Email</a><br>
{/if}
2007 Web Logic Media, Inc.
Front-End
51
The above code will check to see if the location has data in the website field. If it does, it will
then create a link to the website. If it does not, it will create a link for email.
Print Fields in HTML Format:
All fields are stored in the database in plain text and using standard ASCII format. And all
references of HTML are stored in their ASCII code. If you have a field you are using html in,
you may wish to decode it to html before it gets printed to the screen.
Example:
If you have entered HTML into your user1 field...
Adding the variable code
{$location.user1} will print like this:
M-F: 8:00am until 5:00pm&lt;br&gt;
&lt;font color=&quot;blue&quot;&gt;Blue
Sale on Saturdays&lt;/font&gt;
If you want the user1 field to print in HTML, then you can use the following variable code
alteration:
{$location.user1|html_entity_decode} and the value will print like this:
M-F: 8:00am until 5pm
Blue Sale on Saturdays
Tip: html_entity_decode is a php string function, and you can use any available php
function as a variable modifier. Just add the php function after the variable in the format of |
functionname For a list of PHP string functions, visit http://at.php.net/manual/en/ref.strings.
php
2007 Web Logic Media, Inc.
52
3.2
Ultimate Locator v3
Languages
There is a language editor inside the Admin Panel, that will allow the admin to control many
of the words and paragraphs that get printed to the screen.
If you would like to edit some of the text, you can use the 'Language Editor' inside the Admin
Panel, to do just this...
2007 Web Logic Media, Inc.
Front-End
53
You can edit any of the text inside of the text boxes to any word or phrase. You can also
use any language you wish. The default is English.
4
Admin Panel
The Admin Panel is the heart and soul of the locator system. It is where you, the
administrator, can login via your web browser and manage the functionality of the entire
system. Once logged in, you can control many aspects of the locator in real-time.
Here is a screenshot of the 'Dashboard' of your Admin Panel...
4.1
Logging In
You need to launch the Admin Panel by pointing your browser to your login file on your
server. Open your browser and type in your URL to your login.php file.
i.e.: http://www.mysite.com/locator/admin/login.php
Of course, you need to replace the mysite.com above with your real domain.
How To Login:
2007 Web Logic Media, Inc.
54
Ultimate Locator v3
Once you type in your URL, you should see the login page, where you are asked to login
with your username and password.
If you can't remember your login info, then you can click on the 'Forgot Your Password'
link to have an opportunity to have the system email you the login details. PHPMail must be
installed for emails to work.
You will have a choice of entering your Username or Email to get your password. After
entering your Username or Email Address into the box, just click the button to have the
system search for your account. If one is found, an email will be dispatched to the email
address of file, containing the username and password for logging in.
2007 Web Logic Media, Inc.
Admin Panel
55
In the event that your license key code inside your database does not pass authentication,
then you may see a login page that looks similar to the graphic below. If so, you will need to
re-enter your license key code into the box, along with your username and password. You
can get your license key code from within your Member's Account. Just view your license
and copy/paste the key code.
2007 Web Logic Media, Inc.
56
Ultimate Locator v3
You can also click on the 'License help can be found here' link to get a little bit more help
about this error you are receiving.
4.2
Admin Home
Once logged in successfully, the first screen you will see in the Admin Home screen We
sometimes also call this screen the 'Dashboard', because it has a lot of information about
your locator system.
You can click on any link to go to that specific item.
Total Locations:
This number is a total of every record in your database
Active Locations:
This number is a total of all records who are considered active. Meaning not flagged as
needing Admin Approval (pending).
Hidden Locations:
This number is a total of all records who are flagged as Disabled.
Preferred Locations:
This number is a total of all records who are ranked as a 1, 2 or 3 rank.
Locations needing Approval:
2007 Web Logic Media, Inc.
Admin Panel
57
This number is a total of all records who are flagged as needing Admin Approval (pending).
Typically any Visitor Added record will show up here so you will know there is a new pending
record that needs your attention.
4.3
Records
A record is a location of a specific place or thing. Your database will be filled with many
records when you start adding locations to your system. To control these records you have
many choices on the menu...
Browse All:
2007 Web Logic Media, Inc.
58
Ultimate Locator v3
This link will take you to a page that will list all your records in one place. It's a great way to
see all your records and to manage them.
Add Record:
This link will take you to a new form where you can type in all the information about a new
record and save it to the database.
2007 Web Logic Media, Inc.
Admin Panel
59
Edit Record:
This link will take you to a search form where you can enter information to search on, to find
a specific record that you wish to edit the information. Enter as much info to narrow down
your search results.
2007 Web Logic Media, Inc.
60
Ultimate Locator v3
Delete Record:
This link will take you to a search form where you can enter information to search on, to find
a specific record that you wish to delete from the system. Remember: once a record is
deleted, it is gone forever.
2007 Web Logic Media, Inc.
Admin Panel
61
Import Records:
This link will take you to a page that will allow you to import your records from a list. This is
the 'bulk upload' routine that is used when you have many records that you wish to import at
one time.
More information and details about Importing Records can be found here
2007 Web Logic Media, Inc.
83
...
62
Ultimate Locator v3
Export Record:
This link will take you to a page that will allow you to export all of your location data. You can
then download the file to your computer and open in Excel for printing, etc...
2007 Web Logic Media, Inc.
Admin Panel
63
Approve Records:
If you allow visitors to add locations to your locator, then you will surely want to approve
them before they go live. This link will take you to a page that will show you any/all records
that are flagged as pending. You will have a chance to review them, then either approve
them for inclusion or delete them from the system. You can also click on the name of the
location to edit it, before approving it.
2007 Web Logic Media, Inc.
64
Ultimate Locator v3
Import Categories:
This link will take you to a page that will allow you to import a list of location & categories into
the system. If you only have a few locations you wish to assign categories or products to,
you can use the 'Edit Location' tool to select which categories or products a location shall
belong too, but if you have dozens and dozens or hundreds and thousands of locations &
categories or products, then you can import them from a list.
More information about importing Categories/Products can be found here
4.4
87
...
Zip / Postal Codes
Your locator's database come with over 42,000 USA zip codes, and if you buy Canadian
Postal Codes, that will add another 800,000 codes to your database.
2007 Web Logic Media, Inc.
Admin Panel
65
In order to control such a large amount of zip code data, we have two tools that will help you.
Zip Code Manager:
The Zip Code Manager Tool is here for searching your database for a specific zip code. It
allows you to enter any code, then it will search the entire database to see if that code exist.
If it does, it will pull up an editor page where you will see the zip code, latitude and longitude
coordinates for that zip code. You can also edit the info if needed.
2007 Web Logic Media, Inc.
66
Ultimate Locator v3
If the zip code is not found, it will tell you so in an error message. If you know for sure the
zip code should exist, you can also 'Add New'.
Import Zip Codes:
Let's say you want to offer proximity searches for a country other than the United States.
You will need to obtain the postal codes dataset for that particular country. For example,
Canada. If you wish to allow your website visitors to search Canadian locations via a postal
code search and you want your locator to search a radius and list the results by distance,
then you will need to import all Canadian Postal Codes. (You can buy that dataset from us)
Once you get your hands on the dataset, you can use this Import Zip Codes Tool to import
the postal codes into your database.
2007 Web Logic Media, Inc.
Admin Panel
67
Option 1 will show you any files that are found inside the /dbackup/zipdata folder. You can
select any of the files to import. You can also chose to perform option 2, which will allow you
to select a new file on your computer and import it.
4.5
Configuration
The Configuration menu will give you the tools you need to manage and configure your
locator system. Use any of the various tool to do anything from configuring the General
Setting to editing template files.
2007 Web Logic Media, Inc.
68
Ultimate Locator v3
General Settings:
The General Settings page allows you to make system wide changes and enter your own
settings for the program.
Categories & Products:
You can view, add, edit or delete any categories or products that you have setup within your
program. If you allow 'category searches' then your users will be able to select from a drop2007 Web Logic Media, Inc.
Admin Panel
69
down list when they perform a search, which will filter their results. You can then assign
your locations to the categories and products that you have setup.
Note: You must have MySQL v4.1.2 or higher in order to use Categories and Products
simultaneously. This is an advanced feature to use both at the same time. If you just wish
to use categories, then earlier versions of MySQL should suffice.
Field Settings:
You can setup which fields are Required, which fields are Hidden and also give labels to the
10 User Fields that are available.
Required Fields - Means that when a user or admin adds a new record to the database, that
field must not be blank. It's a good way to insure data quality. Example: Every use must
supply a phone number while adding a new record if the Telephone field is checked here.
Hidden Fields - This allows you to deactivate any field. It will keep it from showing on the
front-end.
User Fields - This allows you to assign field labels to any of your extra 10 user fields.
Note: If you wish to use any of the 10 user fields to hold extra data, then you must give a
user field a label here. Giving a user field a label activates that field throughout your locator.
2007 Web Logic Media, Inc.
70
Ultimate Locator v3
Search Page Settings:
The search page is the first screen your website visitors see. You have many options on
which search elements you wish to offer your visitors. Select YES next to the ones you
want active, and select NO for the ones you want to disable.
2007 Web Logic Media, Inc.
Admin Panel
71
State/Province List:
This page allows you to view/edit all the states and provinces that are loaded in your system.
You can also add new if needed. All states/provinces in this list are what's available to your
users in the drop down list while searching.
It is safe to remove any state/province that you do not wish to be on the list.
2007 Web Logic Media, Inc.
72
Ultimate Locator v3
Country List:
This page allows you to view/edit all the countries that are loaded in your system. You can
also add new if needed. All country codes/names in this list are what's available to your
users in the drop down list while searching.
It is safe to remove any country that you do not wish to be on the list.
CSS Editor:
The CSS Editor allow you to open the CSS (Cascading Style Sheets) and edit them. The
CSS file is the single file that will allow you to make design changes, that are system wide,
such at Font Color, Font Size, Table Properties, Background Colors, etc...
Select which css file you wish to edit from the list.
2007 Web Logic Media, Inc.
Admin Panel
73
Tip: Ranked Location's Background Color is stored in the front_end_layout file.
Look for the line: table.results tr.rank_bg {background-color:#feffcb;} and edit it to
change the background color for your ranked locations.
Template Editor:
There are many templates that you can edit, and add your own code. Such as HTML and
Javascript. The Template Editor will allow you to manage your templates and edit them.
The single most important template in this list is the index.tpl template. This is the template
that encompasses all output of the locator. This templates allows you to add your own html
and graphics to the header (top) and footer (bottom) of the templates. Once you add your
own html to the header section and the footer section, your custom code will wrap the output
of each and every page of the locator.
2007 Web Logic Media, Inc.
74
Ultimate Locator v3
Language Editor:
There are many words that are used in the system and you can edit these words with the
Language Editor. English is the default language but you can change the words to anything
you need.
4.6
Miscellaneous Tasks
The Admin Panel also offers a few miscellaneous tasks.
2007 Web Logic Media, Inc.
Admin Panel
75
Send Email:
You can send an email to the email address on file for each location. You can choose which
group to send emails to and you can send in HTML or Plain Text formats. Very useful for
announcements.
2007 Web Logic Media, Inc.
76
Ultimate Locator v3
Backup Database:
One you have your locator up and running and your locations, zip codes, settings are saved,
you'll want to create a new backup file. The file will be saved on the server inside the /
locator/dbackup/restore folder. You can also download the file, which we do recommend.
Note: You can choose any/all of the tables from the list, that you wish to backup. If you
experience problems, you may want to deselect the zipcode table, as it typically holds tens
of thousands of records. And you can always re-import them fresh at a later time.
2007 Web Logic Media, Inc.
Admin Panel
77
Restore Database:
You can restore your entire mysql database, if needed, from one of your backup files you
have created. It will take the backup file, read in all the data, delete all tables inside your
mysql database, then create new tables and populate them with the values inside your
backup file.
2007 Web Logic Media, Inc.
78
Ultimate Locator v3
File Manager:
All the files that you import, upload and create within that admin panel can be managed with
the File Manager. This tool will list any file that if finds inside the system folders and give
you a list, where you can download or delete the file.
2007 Web Logic Media, Inc.
Admin Panel
79
IP Tracking Table:
If you are utilizing the 'Limit Search by IP' feature, then the data used to perform that routine
is stored in a special table inside the database. This tool allows you to see how many
records are stored in this special table and give you the opportunity to 'prune' x number of
days worth of data. Busy sites have the possibility to save large amounts of data, with the
'Limit Search' feature and should consider pruning this data often to keep the file size of
your database to a minimal
.
Admin Management:
You created a Super Admin account when you installed the system. This tool will allow you
to add/edit other login accounts for additional administrators. If you have other people that
will need in the system, you can provide them with their own username and password.
2007 Web Logic Media, Inc.
80
Ultimate Locator v3
Note: Any administrator account will have equal permissions as the super admin account.
Meaning, your additional administrator account will be able to add/edit/delete records and
change settings, just as you the super admin can. There are no restrictions.
4.7
Help
Need some help? This Help menu will give you some options.....
User Manual:
The user manual is online and stored at the UltimateLocator.com website. This is a quick
link to those files.
eSupport Center:
You can visit the eSupport Center 24 Hours a day. We offer many avenues to obtain
support. If you have an issue you need a tech to look at, then please open a trouble ticket.
If you have general questions, you can view the FAQ Knowledgebase or the Forums or open
a new Trouble Ticket.
My PHP Settings:
This is a link to an info.php page. This page will display all your php settings. Very useful
for troubleshooting issues with your server.
2007 Web Logic Media, Inc.
Admin Panel
81
License Key:
This page allows you to view/edit your software's License Key. Although it is unlikely that
you will need to change your key.
2007 Web Logic Media, Inc.
82
Ultimate Locator v3
Get HTML Code:
If you want to add a 'Enter Your Zip Code' form to an existing page on your site, you can.
This page allows you to get the code needed to do just that. It offers the code you need for
zip code searches in the USA and Canada. Just copy/paste the code into any existing page
on your site.
Note: Inside your General Settings Tool, there is a spot to type in your Locator URL. That
entry must be correct for this code to work properly. An Invalid value saved for the Locator
URL setting will cause this code to not point correctly to your locator files.
2007 Web Logic Media, Inc.
Admin Panel
83
About Ultimate Locator:
This page will tell you what version of the locator you are running.
5
Importing
5.1
Locations
Importing a list of locations into the locator is a simple process. Preparing your list for the
correct format can be challenging in some cases. We'll help you get your list in order with
the following tutorial...
In order to import your list into the locator, you'll need to create a comma separated values
(CSV) file. A CSV file is a simple text files with one record per line, and each field is
separated by a comma. Much like this...
Bob Smith,123 Main Street,Dallas,Texas
Jane Doe,775 Euclid Drive,Phoenix,Arizona
See how each record above is on it's own line and each field is separated by a comma.
Question: Can I import my list from a MS Excel file?
Answer: No. Not your Excel (xls) file. But, you can save your Excel file as a .csv file that
will import just fine. Use 'File' - 'Save As' to export into a CSV file.
If you have a list of locations in MS Excel, you are half way home. You can easily modify
your excel list into the correct format by adding the extra column fields needed. Each record
must consist of all 33 fields.
Record Fields:
2007 Web Logic Media, Inc.
84
Ultimate Locator v3
Each record in your import file must contain all 33 fields. Here are the names of each field...
Name
Description
Example Data
id
Record ID
122
name
Location Name Cycle world
- Required
address1
Address 1
Optional - But recommended
address2
Address 2
677 Eastchase
Pkwy
Suite 202
city
City
Dallas
Optional - But recommended
state
State Code
TX
2-Letter Code Optional - But recommended
country
Country Code US
2-Letter Code Optional - But recommended
zip
Zip code
75202
- Required
telephone
Telephone
214-555-1212
optional
fax
Fax
214-555-3434
optional
email
Email
[email protected] optional
website
Website URL
www.cycles.com
no http:// needed - Optional
user1
User 1 Field
Sale every
Wednesday
Anything you want - Optional
user2
User 2 Field
Anything you want - Optional
user3
User 3 Field
Anything you want - Optional
user4
User 4 Field
Anything you want - Optional
user5
User 5 Field
Anything you want - Optional
pref
Rank
hide
Disable Record 0
0=no, 1=yes - Required
hits
No. of Hits
0
Number of hits received, set to 0 first time Required
0=no, 1=yes - Required
Admin
Name of person who submitted the record - Optional
aprove
Needs
Approval
visitorname Name
2
167
visitoremail Email
Can be blank for auto number
Optional - But recommended
1 through 4 - Required
Email of person who submitted the record - Optional
visitordate
Date
2007-22-05
Date record was submitted - Optional
user6
User 6 Field
Anything you want - Optional
user7
User 7 Field
Anything you want - Optional
user8
User 8 Field
Anything you want - Optional
user9
User 9 Field
Anything you want - Optional
user10
User 10 Field
Anything you want - Optional
is_online
Online Store
0
0=no, 1=yes - Optional
image
Image
image.gif
image filename - Optional
icon
Icon
icon.gif
icon filename - Optional
url_text
Text for Link
Click to View
Text that gets printed on website link - Optional
2007 Web Logic Media, Inc.
Importing
85
You can download a sample MS Excel and CSV file. You can use these sample files to start
your own list correctly!
Steps to Importing
On the Admin Panel navigation menu, click on the link under 'Records' that says "Import
Records'. Once you get to the Import Records screen, you'll see a few options. They are...
1. Select File
You have the option to selecting a file that is already on the server inside the /
dbackup directory
or
2. Upload a New File
Click the 'browse' button to select a file that is on your computer
If you have a large import file (over 2MB) then you should FTP your file to your server, in the
/locator/dbackup folder, give it a name that starts with Locations, then select it from this list.
2007 Web Logic Media, Inc.
86
Ultimate Locator v3
Once you have chosen your csv file that you wish to import, you can choose which action
you want to perform while importing. Your choices are.
Append - which will add all locations on the import list to the current list in the database.
Nothing gets erased.
Overwrite - which will erase all current locations in the database first (deleting all records),
then import the locations from your list into the database as a new/fresh database of
locations.
After the Import Routine has completed, you'll get a confirmation screen that will inform you
on how many records successfully imported and how many records were invalid and didn't
import.
2007 Web Logic Media, Inc.
Importing
87
Special Note:
It is very important that your import file has all fields necessary to populate the locations
table. A quick scan is performed during an import and the number of fields is verified. If
your import has more than or less than the correct number of fields (which is 33), import will
skip those records and they will not get imported. See the top of this page for the layout of
fields necessary to import.
Attn: MAC Users:
If you are using a MAC computer, and are planning on importing your locations from a file,
there is one step you must do before your import will work correctly. If you have a list of
locations in MS excel and then save the file as a CSV file, you must also choose the
"Windows Text" option. Your text file must be saved with Windows ANSI file formatting.
Choosing the Windows Text option should do this for you.
5.2
Category Assignments
Importing a list of category assignments or product assignments into the locator is a simple
process.
Understanding Category & Product Assignments:
If you are wondering exactly what this tool is used for, here is an explanation... Let's
assume you have 100 locations in your database. And you have already setup 10 different
categories with the 'Categories & Products' tool. It's now time to assign a location to a
category or product.
1. You can edit each record in your database individually with the Edit tool, and you will see
a list of the available categories & products, of which you can place a check-mark on for any
assignment, then save your changes. Not bad, if you only have a few locations to assign.
2. Do you really want to do this for 50, 100 or 1000 locations? Probably not. Well, you can
import a master list, that contains a record ID and the category ID. The import will allow you
to perform the assignments in bulk. Therefore, if you have 5,000 locations and each one
should belong to a specific category or product, or should belong to multiple categories or
products, then importing a master list is the way to go.
In order to import your list into the locator, you'll need to create a comma separated values
(CSV) file. A CSV file is a simple text files with one record per line, and each field is
separated by a comma. Much like this...
1,1
2007 Web Logic Media, Inc.
88
Ultimate Locator v3
2,2:3
3,1:2:3
See how each record above is on it's own line and each field is separated by a comma.
Question: Can I import my list from a MS Excel file?
Answer: No. Not your Excel (xls) file. But, you can save your Excel file as a .csv file that
will import just fine. Use 'File' - 'Save As' to export into a CSV file.
Fields:
Each record in your import file must contain 2 fields. Here are the names of each field...
Name
Description
Example Data
id
Record ID
10
must match location record id to assign correctly
category id
Category ID
1 or 1:2:3:4
must match category or product id to assign
correctly
A record can be assigned to multiple categories or products. In this event, you need to
separate each category or product with a colon character. Like this: 1:2:3:4
You can download a sample MS Excel and CSV file. You can use these sample files to start
your own list correctly!
Steps to Importing
On the Admin Panel navigation menu, click on the link under 'Records' that says "Import
Categories'. Once you get to the Import Categories screen, you'll see a few options. They
are...
1. Select File
You have the option to selecting a file that is already on the server inside the /
dbackup/category directory
or
2. Upload a New File
Click the 'browse' button to select a file that is on your computer
If you have a large import file (over 2MB) then you should FTP your file to your server, in the
2007 Web Logic Media, Inc.
Importing
89
/locator/dbackup/category folder, give it any name, then select it from this list.
Once you have chosen your csv file that you wish to import, you can choose which action
you want to perform while importing. Your choices are.
Append - which will add all locations on the import list to the current list in the database.
Nothing gets erased.
Overwrite - which will erase all current locations in the database first (deleting all records),
then import the locations from your list into the database as a new/fresh database of
locations.
2007 Web Logic Media, Inc.
90
Ultimate Locator v3
After the Import Routine has completed, you'll get a confirmation screen that will inform you
on how many records successfully imported and how many records were invalid and didn't
import.
TIP: A Quick Way to build your Category Assignment Import File:
Ok, so your thinking that you have way to many locations to assign categories and products
by hand manually, and you can't even think about creating this file from scratch. It's hard
enough to type in the category ID, plus the location id. So, what is the fastest way to build
this file?
1. Import or type in all your locations into your locator.
2. Export your locations into a csv file with the 'Export Locations' tool.
3. Download and Open the exported csv file in MS Excel.
2007 Web Logic Media, Inc.
Importing
91
4. Notice that every record has a record ID field in the very first column (column A) (think
about it, you now have a full list of record IDs)
5. Insert a new column between the existing column A and column B (id field and name
field)
6. Use this new column to hold your category/product IDs.
7. Print off your list of categories and product from your admin panel. (this list will show you
the IDs)
8. Start typing in the category/product IDs for each location that you want to assign
9. Each location can belong to one category/product or multiple categories/products. If
multiple, the separate each one with colon character.
TIP: Right click on the letter 'B' (column B), click on 'Format', and choose 'TEXT'.
Otherwise Excel may try to change your category IDs into time.
10. Once you've completed typing all category/product IDs, then you can safely remove all
the other fields. Column C and beyond.
11. Now, your file has two columns, Column A and Column B. Column A holds location
record id and Column B holds category IDs. And there are now no other fields (columns) on
your spreadsheet.
12. Done! Click on 'File- Save AS' from the file menu, and save the file as a .csv format file.
2007 Web Logic Media, Inc.
92
Ultimate Locator v3
13. Your file is now ready to import.
Attn: MAC Users:
If you are using a MAC computer, and are planning on importing your category assignments
from a file, there is one step you must do before your import will work correctly. If you have
a list of locations/categories in MS excel and then save the file as a CSV file, you must also
choose the "Windows Text" option. Your text file must be saved with Windows ANSI file
formatting. Choosing the Windows Text option should do this for you.
2007 Web Logic Media, Inc.