 | URLRepair Documentation |
| | | |
Introduction to URLRepair
Getting Started - (Installation Procedures)
Running the Setup Wizard
Configuring IIS Using URLRepair
Configuring IIS Manually
Files to be Installed
Feature List
Configuration
User Interface
QuickStart
License
Advanced
Manual Configuration Via Config File
Frequently Asked Questions
Uninstalling
System Requirements
Release Notes
Licensing/Purchasing
Technical Support
Contact Information
When a user navigates to a web page they often enter in the incorrect URL. This cost corporations money if the customers who are trying to access a page on their web server cannot find the product they are looking for because of a bad url or misspelled URL.
URLRepair fixes bad URL typo or spelling mistakes that could cost corporations their customers. With URLRepair, you can help get customers back on track and where they need to be. URLRepair is an easy-to-use Internet Server Application Programming Interface (ISAPI) plugin for any web server running IIS.
Whenever a user types in a web address to a web server installed with URLRepair, it matches the name of the page the user is trying to access with the name of the pages that are actually on the web server. URLRepair will easily correct the user's URL mistake and redirect them to the correct page as if they had typed in the URL correctly the first time. The web server administrator can also set the maximum amount of spelling error to redirect.
URLRepair uses a setup wizard to make the installation process as easy as possible. The next four sections will help you run the setup wizard, configure IIS to use URLRepair, and provide you a list of files that are installed.
To run the setup wizard for URLRepair:
- Double click on the setup file to display the setup program. A screen titled "Welcome to URLRepair Setup Wizard" will appear and ask you to verify that you want to install URLRepair.
- Click "Next" to continue the setup.
- You will be asked to select a destination or installation directory. Click "Next" to continue setup. (Note: URLRepair's default installation destination is "C:\Program Files\URLRepair\". However, you can install it in any directory you specify.)
- Click "Install" to confirm that URLRepair is to be installed on the computer and finalize the customization of the URLRepair installation.
- When the installation is complete, a screen titled "Completing the URLRepair Setup Wizard" will appear. The screen includes two checkboxes: "Auto-configure IIS to work with URLRepair" and "Launch URLRepair." Selecting the Auto-configure box will allow the setup program to prepare IIS to immediately begin working with URLRepair. (Note: It is best to restart after the setup is complete.) However, if you choose to leave the Auto-configure box unchecked, you may use the configuration tool later to manually configure or auto-configure URLRepair to work with IIS.
- Click "Finish" to close the setup program.
To set up IIS to work with URLRepair:
- Open the URLRepair configuration tool.
- Click on the QuickStart tab near the top of the window.
- Click the "Add to Webserver" button. (Note: If this button is disabled, it means that IIS is already configured to work with URLRepair. To remove the URLRepair configuration in IIS click on the "Remove from Webserver" button. This will stop IIS from running URLRepair.
IIS can be configured manually to work with URLRepair using the following steps:
- Open the Internet Information Services configuration utility. (You can access this utility by opening Control Panel, double-clicking on Administrative Tool, and clicking on Internet Services Manager icon).
- Right-click on the server that URLRepair will be installed on and select Properties.
- Under the Internet Information Services tab is a group of options called Master Properties. Click on the "Edit" button and select the ISAPI Filters tab.
- Click on the "Add" button to add URLRepair to the list of filters IIS uses.
- In the Filter Properties dialog enter the following information:
- Under Filter Name, enter "URLRepair."
- Enter the location of the URLRepair DLL file. (Note: The DLL file is is always located in the directory where URLRepair was installed "C:\Program Files\URLRepair\." To locate the file in Windows Explorer, click "Browse".)
- Click "OK" until you return to the Internet Information Services configuration utility.
- Right-click on the server and select Restart IIS. When the restart is complete, IIS is ready to work with URLRepair.
For further step-by-step instructions, visit our Quick Help support area, which shows screenshots of how to install and uninstall an ISAPI plugin with IIS.
The following files are installed during setup and are required to allow URLRepair to run properly:
| File Name | Description | | urlfix.exe | URLRepair Application | | urlfix.cfg | URLRepair Configuration File | | urlfix.dll | URLRepair DLL | | urlfix.htm | URLRepair Help Documentation | | elmsg.dll | URLRepair Event Log DLL |
All the settings for URLRepair can be configured using the URLRepair configuration tool. The configuration tool has several tabs: QuickStart, Advanced, and License. These tabs provide access to all of URLRepair's settings, which make it possible for you to configure URLRepair to meet the needs of any web server application.
The "Load" button (located at the bottom of the URLRepair application) allows you to load new configuration settings from a configuration file. You can save the configured settings to a configuration file using the "Save" and "Save As" buttons. Use the "Reset" button to reset the current configuration to the URLRepair default values. No changes will take effect until they are saved. URLRepair periodically checks to see if a new configuration file is available. If the configuration file currently available is newer than the one URLRepair has loaded, it will load the new one into memory. one into memory.
When URLRepair is started, by default the configuration file that is located in the directory where URLRepair was installed (usually "C:\Program Files\URLRepair\") is started up as well.
QuickStart is a fast and easy way to configure URLRepair. With QuickStart, you can integrate URLRepair into IIS with the click of a button.
Unlike other ISAPI filters for IIS, you can start or stop URLRepair from being loaded by IIS using URLRepair's configuration tool. URLRepair allows for maximum control within IIS without having to adjust the Internet Services Manager settings or manually configure URLRepair to work on IIS. Instead, URLRepair can configure itself into or out of IIS with minimal effort on your part. To allow the URLRepair filter to be loaded by IIS, click on the "Add to Webserver" button. IIS will start using URLRepair the next time IIS is restarted or the next time the computer is restarted. To stop the URLRepair filter from being loaded by IIS, click on the "Remove from Webserver" button. URLRepair will then be removed from use by IIS the next time IIS is restarted or the computer is restarted.
This feature allows the generation of log files in the supplied log file directory. The log files contain information on all the operations that URLRepair performs. By default, this feature is turned off.
Each time a log file is generated, it is generated in a particular format. This format always begins with the date and time the event occurred, followed by the description of the event. For example:
12/14/2003 17:34:52 New configuration applied
This states that a new configuration was applied on 12/14/2003 at 17:34:52. The most important event that is displayed in the log is:
01/02/2004 19:35:39 IP 127.0.0.1 [static.html] 2:3 -> [stats.htm]
The description for this event shows the ip address of the user, the page the user typed into their browser, the amount of error in the url the user typed in, the maximum amount of error allowed in a url, and where the user was redirected.
A log file record is also kept each time URLRepair starts up or shuts down. The format for such an event looks like:
12/12/2003 19:08:30 URLRepair v0.8 (Beta) started
12/12/2003 19:08:31 URLRepair v0.8 (Beta) shutdown
The description of this event displays the date and time of the event, the name of the ISAPI plugin, the version number, and whether or not a start up or shutdown event occurred.
The License tab provides information about the current copy of URLRepair, including the version number, the number of URLRepair copies that have been used, and the number of copies that can still be used with the current serial number.
It is possible to configure URLRepair manually by editing the configuration (.cfg) file for URLRepair, which is located in the directory where URLRepair was installed. This is recommended for advanced users only. The configuration file can be edited by loading it into notepad. The format is similar to the format for Windows INI files. After changes have been made to the file and the urlfix.cfg file is saved, URLRepair will automatically reload the configuration file and use its new settings. Entries that take integers look like this: MinFileSize:1000. Entries that take strings look like this: LogDirectory:"logs" or SupportProxyIP:"TRUE".
Logging
LogEnabled:[TRUE/FALSE] default: FALSE
LogDirectory:[string] default: log-urlfix\
Event Log Notification
NotifyStartStop:[TRUE/FALSE] default: FALSE
Redirection
RedirectMaxError:2
RedirectTotalError:4
CustomMaxError:2
CustomTotalError:8
To Uninstall URLRepair, click on the Uninstall icon that is located in the Program Folder for URLRepair in the Start menu. This will run through the uninstall program and uninstall URLRepair. If the URLRepair filter is currently in use by IIS, the URLRepair DLL file that IIS uses will be deleted the next time the system is restarted.
For further step-by-step instructions, visit our Quick Help support area, which shows screenshots of how to install and uninstall an ISAPI plugin with IIS.
URLRepair requires Windows NT/2000/XP Professional/2003 .NET with Microsoft Internet Information Services (IIS) 5.x or 6 and at least 128 MB of RAM.
Version 1.00 - First release of URLRepair
For important information on purchasing a copy of URLRepair, please contact ISAPILabs at http://www.isapilabs.com/.
All technical support is available via our support page located on the World Wide Web at http://www.isapilabs.com/.
To contact us, please visit our contact page.
|
|
|
|
