 | MachineMapper Documentation |
| | | |
Introduction to MachineMapper
Getting Started - (Installation Procedures)
Running the Setup Wizard
Configuring IIS Using MachineMapper
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.
MachineMapper fixes bad URL typo or spelling mistakes that could cost corporations their customers. With MachineMapper, you can help get customers back on track and where they need to be. MachineMapper 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 MachineMapper, 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. MachineMapper 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.
MachineMapper 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 MachineMapper, and provide you a list of files that are installed.
To run the setup wizard for MachineMapper:
- Double click on the setup file to display the setup program. A screen titled "Welcome to MachineMapper Setup Wizard" will appear and ask you to verify that you want to install MachineMapper.
- Click "Next" to continue the setup.
- You will be asked to select a destination or installation directory. Click "Next" to continue setup. (Note: MachineMapper's default installation destination is "C:\Program Files\MachineMapper\". However, you can install it in any directory you specify.)
- Click "Install" to confirm that MachineMapper is to be installed on the computer and finalize the customization of the MachineMapper installation.
- When the installation is complete, a screen titled "Completing the MachineMapper Setup Wizard" will appear. The screen includes two checkboxes: "Auto-configure IIS to work with MachineMapper" and "Launch MachineMapper." Selecting the Auto-configure box will allow the setup program to prepare IIS to immediately begin working with MachineMapper. (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 MachineMapper to work with IIS.
- Click "Finish" to close the setup program.
To set up IIS to work with MachineMapper:
- Open the MachineMapper 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 MachineMapper. To remove the MachineMapper configuration in IIS click on the "Remove from Webserver" button. This will stop IIS from running MachineMapper.
IIS can be configured manually to work with MachineMapper 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 MachineMapper 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 MachineMapper to the list of filters IIS uses.
- In the Filter Properties dialog enter the following information:
- Under Filter Name, enter "MachineMapper."
- Enter the location of the MachineMapper DLL file. (Note: The DLL file is is always located in the directory where MachineMapper was installed "C:\Program Files\MachineMapper\." 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 MachineMapper.
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 MachineMapper to run properly:
| File Name | Description | | mmap.exe | MachineMapper Application | | mmap.cfg | MachineMapper Configuration File | | mmap.dll | MachineMapper DLL | | mmap.htm | MachineMapper Help Documentation | | elmsg.dll | MachineMapper Event Log DLL |
All the settings for MachineMapper can be configured using the MachineMapper configuration tool. The configuration tool has several tabs: QuickStart, Advanced, and License. These tabs provide access to all of MachineMapper's settings, which make it possible for you to configure MachineMapper to meet the needs of any web server application.
The "Load" button (located at the bottom of the MachineMapper 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 MachineMapper default values. No changes will take effect until they are saved. MachineMapper periodically checks to see if a new configuration file is available. If the configuration file currently available is newer than the one MachineMapper has loaded, it will load the new one into memory. one into memory.
When MachineMapper is started, by default the configuration file that is located in the directory where MachineMapper was installed (usually "C:\Program Files\MachineMapper\") is started up as well.
QuickStart is a fast and easy way to configure MachineMapper. With QuickStart, you can integrate MachineMapper into IIS with the click of a button.
Unlike other ISAPI filters for IIS, you can start or stop MachineMapper from being loaded by IIS using MachineMapper's configuration tool. MachineMapper allows for maximum control within IIS without having to adjust the Internet Services Manager settings or manually configure MachineMapper to work on IIS. Instead, MachineMapper can configure itself into or out of IIS with minimal effort on your part. To allow the MachineMapper filter to be loaded by IIS, click on the "Add to Webserver" button. IIS will start using MachineMapper the next time IIS is restarted or the next time the computer is restarted. To stop the MachineMapper filter from being loaded by IIS, click on the "Remove from Webserver" button. MachineMapper will then be removed from use by IIS the next time IIS is restarted or the computer is restarted.
MachineMapper can decode country information via requests coming from proxy servers. By default, this option is turned off because it is possible to forge the IP address using proxy server requests.
Page extensions are a valuable resource in MachineMapper that specify which extensions MachineMapper should retrieve country information for. Retrieving country information for jpeg or gif formats would not be very valuable since the jpeg or gif can not do anything with the country information it is passed. To specify an extension that MachineMapper should pass the user's country location to, simply add the the extension to the list, without a period, and separated by commas. An example would be htm,html,php,asp,cgi,pl,exe.
MachineMapper allows for a customizable statistics page named country-stats.htm. This country-stats.htm web page should be located in the same directory as the MachineMapper DLL. To map country-stats.htm to another name on the web server enter that name in the statistics section under the "Advanced" tab in the configuration tool. The physical file should still be called country-stats.htm and be located in the MachineMapper DLL directory, although to view the page users will have to enter in the mapped address. To specify the file name of the web page that MachineMapper should use to generate statistics enter it in the space provided. To turn this feature off leave this field blank.
This feature allows the generation of log files in the supplied log file directory. The log files contain information on all the operations that MachineMapper 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 MachineMapper starts up or shuts down. The format for such an event looks like:
12/12/2003 19:08:30 MachineMapper v0.8 (Beta) started
12/12/2003 19:08:31 MachineMapper 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 MachineMapper, including the version number, the number of MachineMapper 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 MachineMapper manually by editing the configuration (.cfg) file for MachineMapper, which is located in the directory where MachineMapper 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 mmap.cfg file is saved, MachineMapper 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-mmap\
Event Log Notification
NotifyStartStop:[TRUE/FALSE] default: FALSE
TO BE DONE
WAITING FOR UPDATE
To Uninstall MachineMapper, click on the Uninstall icon that is located in the Program Folder for MachineMapper in the Start menu. This will run through the uninstall program and uninstall MachineMapper. If the MachineMapper filter is currently in use by IIS, the MachineMapper 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.
MachineMapper 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 MachineMapper
For important information on purchasing a copy of MachineMapper, 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.
|
|
|
|
