Scalix import tool for contacts
===============================

Requirements
============

Apache 2.x server with mod_python 3.0.x

Installation Files
==================

import_contacts.py
import_contacts.conf
contact.rfc822

Description
===========

The import tool provides an HTML front-end to allow end-users to import
their contact data into the Scalix server without needing to involve
a system administrator.

The script requires a username, password, an optional hostname and a file to import.

The import file can be either in LDIF or CSV format. See the "Configuration Options" section 
for details on how to change the data mapping from these formats.

The testing has been done on Netscape 4.79 LDIF and Thunderbird LDIF/CSV formats.

Installation
============

** Please read the "Configuration Options" section before installation **

1) Untar the supplied tar file

	tar -xzvf import_contacts.tgz

2) Access the install directory and run the install script

	cd import_contacts ; ./install.sh

The default is to install into a directory called import/ which is underneath
the DocumentRoot as defined in the Apache configuration. If you want to use a
different name (which will still be below DocumentRoot), use the -i option.

If the directory already exists, the installation can be forced by specifying
the -f option.

On installation, the default IMAP server will be defined as the current
machine as returned by the command "uname -n". If you wish to change this at
installation time, specify the -s option with a server name.

Removal
=======

Run the command uninstall.sh which exists in the directory in which you untarred the
install tar file.

The -i option is used to specify a name other than import/
The -r option must be specified if you wish to remove the directory in which
the scripts are installed.

Configuration Options
=====================

There are a number of configuration options in import_contacts.py which will change the
behaviour of the import script.

Changing the default IMAP server
--------------------------------

The default IMAP server is defined by the gIMAPHost option in import_contacts.py.
There is support for IMAP referrals so there is no need to set up a script for each server in
the Scalix network.

You can also use the -s option at install time to specify a different host
name.

Displaying the hostname input box
---------------------------------
By default, the script will not display a hostname input box. This can be enabled by changing the
gShowHostName option from 0 to 1.

Allowing blank passwords
------------------------

By default, blank passwords are not allowed by the script. To allow this, change gAllowBlankPwd from
0 to 1.

Changing the mapping between LDIF/CSV data to Contact data
----------------------------------------------------------

The file contact.rfc822 is a template used to create the contact record.
There are a number of placeholders in the template which are represented by a ##NAME## format.

The option gCSVHeaders defines the position in a CSV file that these placeholders will appear.
The option gLDIFAttrs defines the mapping between LDIF attributes and the position that they will appear in a CSV file when the script converts from LDIF to CSV.

Changing the label for "User Name"
----------------------------------

Some organisations have a different nomenclature for a user name.
Use the gUserNameLabel to define what this label should be.

Changing the banner
-------------------

If it is necessary to change the title of the page, the option gBanner defines
this text.