Systems Planning Homepage MWeb Homepage MWeb Administrator's Guide - How MWeb Works - Getting Started 1. Configuring the Project - Integrated Searching - Project Setup - Subsets - Search Categories - Stopwords - Linking to MWeb - Moving or Deleting a Project 2. Configuring Databases - Types of Databases - Adding Databases - Configuring Features - Configuring Tables - Configuring Subsets - Configuring Fields - Indexing a Database - Maintaining the Index - Testing the Database - If a Database Changes - Deleting a Database - Databases with Images, Part 1 - Databases with Images, Part 2 - Advanced Relational Topics - More about MARC Databases 3. Configuring the Interface - Introduction - Customizing the Splash Screen - Changing Messages - Changing Layouts - Changing CSS Stylesheets - Using XML and XSLT 4. Using MWeb Features - Sorting Search Results - Direct Access 5. Administering MWeb - Basic Tasks - Keeping Records - Administrator Control Center - User Administration - Reporting Problems - Performance Appendix 1: Express Setup Appendix 2: Standard Setup Appendix 3: Reference - Interface Options - Security - Browsers and Standards - Error Messages - Character Encodings - Installation Details - Uninstalling & Reinstalling Appendix 4: Troubleshooting MWeb Glossary Contact Us

MWeb™ Universal Administrator's Guide


We recommend you print this page to refer to during installation and setup. You may also wish to check off each step as it is completed.

For some steps you will see a box with this symbol. It indicates information you will need to know later with exact spelling. Since this information may be hard to find, we recommend you record it in the box as you go.

Express Setup

Express Setup installs the same software as Standard Setup but the setup process is much easier. You can add additional Database Connectors or move your Database to another server later if you need to.

Express Setup can be used only for a Project that meets the following requirements. If yours does not, please use Standard Setup.

  1. The Project has only one Database
  2. The Database is one of these types:
    • A MARC Database. See More About MARC Databases for the definition of a MARC Database.
    • An MWeb Enterprise Database (in MWeb Universal Release 2.0 or later)
    • A PastPerfect-Online Database running on the PastPerfect server
    • A PastPerfect Export Database -- files exported from PastPerfect and loaded onto your own server
  3. The Database will be on the same server as MWeb Universal runs on.
  4. The server does not require programs and data to be in areas with special names. The MWeb installer creates a set of directories using its default names. If you want or need to use different names, you will need to install manually using these instructions.
  5. It is doubtful that any shared-hosting service would allow the installation program to run. You will have to install and configure these manually using these instructions.

Please Note!

Because MWeb is installed onto a server, there can be more problems than with normal desktop software. We recommend that a server technician perform the installation, because of these kinds of problems:

  • Your server may require administrative permission to run some of the installation steps, since they configure IIS, add directories, and run Visual Basic scripts.
  • IIS may be using names for virtual directories that MWeb wants to use.
  • The IIS website you wish to use may not be the default website (the only one MWeb can install to automatically).
  • A technician may be required to load your Database onto the server or deal with security issues.

We regret that this process cannot be more automated. However, once installed, using MWeb requires absolutely no technical ability!

Database Security

For highest security you should keep your Databases behind a firewall. This will require one of two ways to allow requests to pass:

  1. Install the Database on a server inside the firewall and permit the HTTP GET requests from MWeb to be received by the Database Connector on that server.
  2. Install the Database Connector on a server outside the firewall and allow it to pass ODBC requests through to another server inside the firewall running your database.

In addition, the Database Connector maintains its own Control Tables that it must be allowed to write to. These Control Tables are in a file called MWebXML1.dat.

No part of MWeb ever tries to write to or modify your Database in any way.

We regret we cannot assist with security setup.

Ordering MWeb

To order, see MWeb Universal Pricing and Ordering, then return here and write down the Order Number.

If you ever upgrade to a later release of MWeb, you will use the Order Number of the upgrade purchase from then on.

Step 1: Install MWeb

The file you downloaded when you purchased MWeb is an installation file that takes care of many of the details. To begin, double-click the file to run it.

The installer will install MWeb into the default website in IIS; it assumes that your server can use the default directories and permissions, that you have the required security permissions to run, and that the server will allow Visual Basic scripts to run. If any of these conditions cannot be met, you will have to perform part or all of the installation by hand using these instructions.

Click images for larger view

Installer screen Instructions
1. Click Next to proceed.
2. Read the license. You may also read or print it by going to the MWeb License page.

When you have read the license, click I Agree.
3. The exact wording of this screen depends on what components you purchased, either Express Installation, Install Main Module, or Install Database Connector. Express Installation installs all MWeb components onto this server. The other two must be installed separately.

If you are installing Database Connectors on more than one server, you will run that installation program on EACH server.

Click Next to proceed.
4. This is the location where MWeb will be installed. You may choose another location by clicking the Browse button. Write down the location before clicking Next to proceed.

5. Here is where you enter the Project and Database codes. These should be short, as they are used to make folder names and URLs. These codes are not displayed to users.

For Express Installation we recommend the defaults shown. However, for multiple Databases, give each one a unique Code. Write down the codes before clicking Install to proceed.

6. When you see this display, the installation program is creating directories, copying files, and adding the virtual directories to IIS.

During the process, or at the end, messages may be shown about problems the installation program encountered.

It is always safe to re-run the installation program. Therefore if you see a message like "Could not configure IIS ...", try that first. You may save yourself having to do manual configuration.

If you see a message like "... already exists in IIS ...", then IIS already has a virtual directory with the name that MWeb was planning to use. MWeb creates names based on the Project and Database Codes you entered in the previous step. Unfortunately the installer cannot go back at this point, so do one of these two things: delete the IIS virtual directories if they are no longer needed and rerun the installer; or rerun the installer choosing a different Project or Database Code.

Step 2: Allow Programs to Run

For Windows Server 2003, the default security does not allow executable programs to run. This needs to be modified:

  1. Open the IIS manager by clicking Start/ Programs/ Administrative Tools/ Internet Information Server.
  2. Expand the tree under the computer name, then expand Web Service Extension under that.
  3. In the right pane, click Add a new Web Service Extension. Enter the extension exe. Then click the Add button.
  4. Or, if the exe extension is already listed, click the Allow button to allow it to run.
  5. Browse to the directories containing the MWeb programs and add them. Then right-click the extension and click Allow. These are the programs you should add (assuming the default installation folders):
    • c:\mweb\unicgi\MWebUni.exe
    • c:\mweb\unicgi\IMS.exe
    • c:\mweb\udccgi\MWebXML.exe
    • c:\mweb\udccgi\MWebIndex.exe
  6. You may close the IIS manager or leave it open.

You must allow the Database Server(s) to accept long URLs. For some MWeb requests, the URL may be 500 characters long or more. If you do not do this, your users will get a 408 message (server timeout) if the URL is longer than allowed.

Step 3: Change Permissions in TEMP Directories

MARC Databases -- skip this section
MWeb Enterprise Databases -- read this section
PastPerfect Export Databases -- read this section
PastPerfect-Online Databases -- skip this section
Relational Databases -- read this section if your Database is Foxpro

MWeb Enterprise Databases, Relational Databases, and PastPerfect Export Databases: If your Database uses FoxPro tables, the Microsoft Visual FoxPro ODBC driver requires permissions to write and then delete temporary files. Add these permissions as follows:

  1. Using the Windows command prompt, type the word "set" and press Enter. Note the directories assigned to the TEMP and TMP settings. If you do not have both TEMP and TMP settings, add them. They usually are assigned to the same directory, which is fine, either c:\temp or c:\winnt\temp. Windows Server 2003 seems to want each user to have separate temp directories, so you will need to change these in Control Panel/System/Environment Variables.
  2. Still using the command prompt, navigate to the TEMP directory and enter "attrib -s". Do the same in the TMP directory if it is different from TEMP.
  3. Back in the Windows Explorer, find the TEMP and TMP directories and give the IUSER Full Control permission. This is required for the ODBC driver to be able to create and delete temporary files.

Step 4: Load Your Database onto the Server

The Database(s) to be used by MWeb must be on the server. Please put them there now if they are not already there. Since every Database is different, the installer cannot do this. For some types of database (SQL Server, Oracle, etc.) this may be a complex installation that a technician should do.

A MARC Database is one or more files in the same format and in the same encoding. Simply copy the files to the server. Configuration will be easier if they are all in the same folder, but this is not required. Skip to Installing MARC Databases.

The PastPerfect-Online User's Guide

The PastPerfect-Online User's Guide was written assuming that your database would be hosted on the PastPerfect server. Therefore you may skip some parts of the Guide. Here is what you need to know:

  • The Guide uses the term "PastPerfect-Online" to refer to two things, the overall product including hosting, and also the web-publishing upgrade that is installed into the PastPerfect collection management system. If you are using MWeb Universal, you will install and use the upgrade, but you may ignore the parts of the Guide that refer to hosting by PastPerfect. With MWeb Universal you will be hosting the database on your own server.
  • The upgrade installed into PastPerfect allows you to select records for export to the web. It also includes a wizard to export the fields you desire, to name fields, and to determine how data is indexed. (This is called mapping.) This wizard is used by MWeb Universal for the same purposes. Therefore refer to pages 2-13 of the Guide that tell you how to do install and use the module.
  • Ignore bullet point 3 on page 3.
  • You may watermark your images as they are exported from PastPerfect. The watermarks will appear in MWeb.
  • The entire last part of the Guide starting on page 14 should be ignored. This refers to the PastPerfect-Online product with hosting, not to MWeb Universal.
  • Instead, once you have run the web-export wizard, you will copy the exported data and image files to your web server. For data, you have two options:
    1. Using FTP or a similar tool, copy the file c:\pp4\webexport\data\data.zip to the server and uncompress it into the folder where you decided to put your Database.
    2. Copy to the server the individual files in c:\pp4\webexport\data except for data.zip. Important: Make sure you upload the files Catnames.dbf, Fieldmap.dbf, and Fieldnames.dbf, and make sure all files end up in the same folder on your server. (Older versions of the PastPerfect web-export wizard put these three files in c:\pp4\webexport instead of c:\pp4\webexport\data.)
  • Images linked to the exported records will be in c:\pp4\webexport\images. There will be subfolders under that for your groupings like \001, etc. Under these subfolders will be \thumbs subfolders for the thumbnails corresponding to the images. Don't forget to upload these images to the server as well as the data.
  • The c:\pp4\webexport folder and all subfolders are emptied each time you run the export wizard.
Note: Mapping is performed only the first time you load data from PastPerfect. To make changes to the mapping after the initial load of your data, use MWeb Universal.

For a PastPerfect Export Database the Database consists of a set of FoxPro tables created by running the web-export wizard from PastPerfect. For help with this process, see the PastPerfect Online User's Guide you received when you purchased the PastPerfect-Online module (more information in the box to the right).


We regret we cannot help with installing databases and database software on your servers except on a consulting basis. It requires specialized knowledge for each database vendor.

Step 5: Create an ODBC Data Source on the Server

The Database Connectors use Open Database Connectivity (ODBC) to access the Database(s) in your Project. This is a nearly universal approach to accessing data. ODBC requires an "ODBC driver", which is just a program developed for data access. In nearly all cases, the vendor of your database software (Microsoft, Oracle, MySQL, IBM, etc.) provides an ODBC driver with the database software.

If the Database already has an ODBC Data Source on the server, you may skip this step, but write down the Data-Source Name.

Each ODBC driver is slightly different. We regret we cannot help with the details of installing and configuring ODBC drivers, except on a consulting basis. However, here are the general steps:

Using the ODBC Administrator on the server, create a "System DSN" as follows:

  1. Click the System DSN tab.
  2. Click the Add button.
  3. Select the appropriate driver and click Finish.
  4. Fill in the necessary fields, which are different for each kind of database. Write down the Data Source Name in the box above.

    For PastPerfect Export Databases, click the Free tables radio button.

    For Microsoft Visual FoxPro databases, click Options and un-check Fetch data in background.

    For Oracle databases, end the Data Source Name with an underscore and the schema name, such as "MWEB_ORACLE_HR", where "HR" is the schema name. Enter both the user ID and password in the User ID box, separated by a slash, such as "joe/Gdk45". If you prefer, you may add the password to the Windows Registry instead. You may set the Data Source to "read-only" for safety, since MWeb does not alter the Oracle database.

    For SQL Server databases, after you set up the Data Source, use the SQL Server administration interface to add the IUSR to the valid users of the database. Only the db_datareader and db_datawrite roles are required for this user.

  5. Click the OK button.

You may now close the ODBC Administrator.

Step 6: Install Images

MARC Databases -- read this section
MWeb Enterprise Databases -- handled by wizard
PastPerfect Export Databases -- read this section
PastPerfect-Online Databases -- handled by wizard
Relational Databases -- read this section

MARC Databases

For MARC Databases, it is required that the images be referenced by a complete URL in the 856$u. Therefore, install the images to the locations specified in the 856$u subfields.

Relational Databases

Install images by copying them to the udcimages folder on the server, which was created by the MWeb installation program.

PastPerfect Export Databases

Install images by copying them to the udcimages folder on the server, which was created by the MWeb installation program. For PastPerfect Export Databases, image access is configured by the wizard if your images are stored in sub-folders under udcimages like this:

Images/udcimages/001/imagefile.jpg
Thumbnails/udcimages/001/thumbs/imagefile.jpg

You may also have multiple levels of sub-folders in the path, like this:

Images/udcimages/objects/gifts/imagefile.jpg
Thumbnails/udcimages/objects/gifts/thumbs/imagefile.jpg

If you wish to do things differently, you will need to see Databases with Images after you have completed the rest of Project Setup.

Step 7: Configuring the Project

Congratulations! The worst is over. There are just a few more steps before you can use your MWeb site.

Before proceeding, you must allow MWeb to set cookies. Cookies are used to store the permissions, last query, and other information. Cookies are not saved between logons.

During installation you assigned your Project a Project Code and its Database a Database Code. In our example we use the defaults: Project Code "Uni" and Database code "UDC".

To begin, in your browser, go to the following address, substituting your domain for www.example.org, and changing "uni" if you changed the default Project Code during installation:

     http://www.example.org/uni/

(Note that Windows servers are not case-sensitive.) If the installation was successful you will see a display titled "MWeb Universal New Project".

You will be asked provide the following Project-related information:

Project Name This will be the name of the Project used as the header of each display, and also as the title in each browser window. (You can change these two independently later.)
An Administrator user ID and password This will be the ID of the Project Owner. This user will have the highest level of privilege, including the ability to change search parameters, add other users, and generally control the system. Memorize this ID and the password, or write them down and keep them in a safe place. (If you lose your password, see Troubleshooting.)

The Order Number you received when you purchased MWeb Enter this Order Number exactly as given to you. (The Order Number is associated with your Project in the Systems Planning Registration Database.)

Note: If you ever upgrade to a later release of MWeb, you will use the Order Number of the upgrade purchase from then on.
If you are reusing MWeb for a new Project, enter the previous domain exactly as it was first registered (such as "www.yoursite.org") WARNING: Your registration will replace the existing one, which will stop working.

Click the Save button to save the information you entered. You will then be asked to logon using the new Administrator ID and password.

Whenever you logon using the Administrator ID, you will see the Administrator Control Center. This is a display that lets you configure all aspects of the Project. You will see several buttons here, but do not be dismayed! Most of them can be ignored for now.

Step 8: Adding the Database

To add the Database, from the Administrator Control Center, click the Databases button, select the Database Type* to add, then click the Add New Database button. You will see the Add Database form. Fill in the requested information:

Code A brief name the users will understand when they see it in the Search Results. It need not be the same as the Database Code you used during installation.
Name A longer name for the Database. This is both for your reference and also displays to the user.
Domain The domain of the Database Server, such as "www.example.org" (do not add "http://"). Do not use "localhost" or "127.0.0.1" as the domain; if you do, your Database will not be visible from the Internet.
CGI Path The virtual directory to the CGI Directory containing the Database Connector (referred to as "udccgi" in the installation instructions). Do not use slashes here.
Data-Source Name The ODBC Data-Source Name for the Database on the Database Server. (This is the name you chose in Step 5.)

When all fields are filled in, click the Add button to add the Database.

* Database Type

Selecting the Database Type activates the appropriate wizard. Wizards save you the trouble of telling MWeb the structure of your Database. We add a wizard whenever we learn the structure of a widely used Database. Here are the wizards currently available:

  • MARC Database -- A Database consisting of standard MARC files.
  • PastPerfect-Online Database -- A PastPerfect-Online Database hosted on the PastPerfect server.
  • PastPerfect Export Database -- The files exported from the PastPerfect-Online upgrade in the PastPerfect collections management system. These files let you run PastPerfect-Online on your own server.

Release 2.0 will include a wizard for

  • MWeb Enterprise Database -- An existing MWeb Enterprise Database.

We will update this list as we develop more wizards.


Step 9: Indexing the Database

Indexing the Database

Return to the Administrator Control Center, then click Databases and then the Index button for the Database. Your Project will be ready for use when indexing is complete.

Indexing allows MWeb to find data in your Database without making any changes to it. By default, every word in every field is indexed. As you can imagine, this can take up to several hours for a large Database. The status of the indexing will be updated in your browser every five seconds. Do not cancel the process or MWeb will not work.

If indexing takes too long and you wish to skip the indexing of some fields in future updates, see Configuring Fields.

MWeb Enterprise Databases and PastPerfect-Online Databases do not require indexing.

Optional use of MySQL

Starting with Release 1.2, you may use the MySQL 5.0 database system to store MWeb's internal index (instead of the default SQLite database system). This may provide faster indexing and retrieval for large Databases. If you want to use MySQL, follow these steps now:

  1. If the server does not have MySQL 5.0, download and install it now. (We cannot distribute it without charging you for a license.) Beta sites: We have not yet tested MWeb with MySQL 5.1. If you have -- or wish to try -- MySQL 5.1, we would be happy to hear of the results.
  2. Create a default user. To do this, use the Mysql program from a command prompt and issue these three instructions:
         create user ODBC;
         grant all privileges on *.* to 'ODBC'@'%';
         flush privileges;
    
  3. Create a database. To do this, use the Mysql program from a command prompt and issue the instruction
         create database MWEB;
    
    (or choose your own name).
  4. In MWeb Universal, return to the Administrator Control Center, click the Databases button, then the Configure button, then the Edit button.
  5. Enter "MySQL" into the Index DBMS field.
  6. Enter the name of the MySQL database you just created into the Index Name field.
  7. The smaller the Index Key Length, the faster MWeb will run. Make the default of 40 smaller if your data will allow it, larger if necessary. The key length is the length of the unique identifiers in your Database, plus 4.
  8. Click Save.

When you index your Database, the index will be created in MySQL. If you wish to revert to MWeb's default of using SQLite, restore the MySQL Database setting to its default (blank); you will have to reindex your MWeb Database after that.

We have found no significant difference in speed of indexing or retrieval between MySQL and SQLite. Our largest test so far has been 1.6 million records (80 million keywords, 6 GB filesize). These indexes took about 8 hours to build.



All contents of website, including HTML and JavaScript, copyright © 1996-2009 Systems Planning. MWeb, MARCView, MARConvert, and InFORMer are trademarks of Systems Planning.

Systems Planning
4915 Redford Road
Bethesda, MD 20816 USA
(301) 652-1231
info@systemsplanning.com (Including the name of one of our products in your message will bypass all spam filters)