Administering Subscribers: Bulk Add

How Bulk Add Works

Prerequisites

Adding Subscribers in Bulk

Setting Up the bulktool.ini File

Adding the Users

Correcting rejected entries

Administering Subscribers: Bulk Add

If you have ten or more subscribers that you must add to the LDAP database, you may want to use the bulktool.tcl utility instead of the Unified Messaging System Administration. The bulktool.tcl utility allows you to conveniently add large groups of users without having to continually enter the same common attributes for each subscriber entry.

How Bulk Add Works

When you execute the bulktool.tcl utility, it invokes the Unified Messaging System Administration CGI program and passes an entry from the input file to that program, along with values it reads from the bulktool.ini , schemaData.ini, and schemaConfig.ini files (such as, mail host, subscriber time zone, search base, etc.). The Unified Messaging System Administration CGI program converts the entry data to LDIF format and then places the entry in the LDAP database. The bulktool.tcl continues to pass entries and the Unified Messaging System Administration CGI program continues to convert and load these entries until all the entries in the input file have been processed. In addition to placing the entries in the LDAP database, the necessary folders on the Messaging Server under the Greeting Administrator account are created.

The bulktool.tcl utility outputs messages and/or entries to the following files, which are placed in the same directory as the input file.

input filename.added —This log file contains entries that were successfully added to the LDAP database.
input_filename.err —This file contains rejected entries with a brief error message for each entry. Entries may be rejected because they are missing information, their format may be invalid, they may already exist in the database, the database schema may be wrong, or the database may be down.
input_filename.notadded —This file contains rejected entries in the input file format. These entries are based on the input_filename.err file.

Prerequisites

Before you start provisioning subscribers in bulk, ensure that the following tasks have been completed:

UMSA is installed and configured.
All Classes of Service to which you will assign subscribers must have entries in the LDAP database. (See "Setting Up Classes of Service".)
Greeting Administrative accounts must have entries in the LDAP database. (See "Setting Up Greeting Administrators".)
If Fax services will be available, Fax Administrative accounts must have entries in the LDAP database. (See "Administering Outbound Fax".)

Adding Subscribers in Bulk

To add subscribers in bulk, you perform the following tasks:

Set up the bulktool.ini configuration file
Add the users
If necessary, correct rejected entries and reapply them to the database.

After you complete a bulk add, user accounts are active and ready for login.

Setting Up the bulktool.ini File

The bulktool.ini file contains a common set of subscriber attributes, such the greeting message host, subscriber time zone, etc. It is used along with an input text file to create uOne subscriber entries in the LDAP database during the bulk add.

To set up the bulktool.ini file for a bulk add run, follow these steps:

Step 1 On a GateServer where the UMSA software resides, type:

cd /home2/spmaster/ADMIN/cgi-bin/MSGadmin/MSGdata

Step 2 Edit the bulktool.ini file, changing the following attributes to match your system configuration (Table 15-1). You may use the defaults for the remaining attributes.

[entryDN]
default=

[cos ]
default=

[cosdn ]
default=

[serverhostname ]
default=

[admininfo ]
default=

[faxadmininfo ]
default=
Table 15-1: bulktool.ini Attributes

Attribute Description Valid Values

[entryDN]
default=

The entry DN for this group of subscribers.

For example, cn=Directory Manager, o=Cisco

[cos]
default=

The class of service to which these subscribers will be assigned.

A valid COS ID. For example, COS=0

[cosdn]
default=

The COS DN to which these subscribers will be assigned.

A valid COS dn. For example, COS=0, o=Cisco

[serverhostname]
default=

The Directory Server name for the server where these subscriber entries will reside.

A valid domain name. For example, dome2.cisco.com

[admininfo]
default=

The Greeting Administrator account to which these subscriber will be assigned.

A valid mailbox ID of the Greeting Administrator account.

[faxadmininfo]
default=

If your subscribers will have fax services, the Fax Administrator account to which these subscriber will be assigned.

A valid mailbox ID of the Fax Administrator account.

Attribute	Description	Valid Values
[entryDN] default=	The entry DN for this group of subscribers.	For example, cn=Directory Manager, o=Cisco
[cos] default=	The class of service to which these subscribers will be assigned.	A valid COS ID. For example, COS=0
[cosdn] default=	The COS DN to which these subscribers will be assigned.	A valid COS dn. For example, COS=0, o=Cisco
[serverhostname] default=	The Directory Server name for the server where these subscriber entries will reside.	A valid domain name. For example, dome2.cisco.com
[admininfo] default=	The Greeting Administrator account to which these subscriber will be assigned.	A valid mailbox ID of the Greeting Administrator account.
[faxadmininfo] default=	If your subscribers will have fax services, the Fax Administrator account to which these subscriber will be assigned.	A valid mailbox ID of the Fax Administrator account.

Adding the Users

To add users in bulk, use these steps:

Step 1 On a GateServer where the UMSA software resides, type:

cd /home2/spmaster/ADMIN/cgi-bin/MSGadmin

Step 2 Create an input text file with the subscriber attributes. This file must contain the following 4 fields for each subscriber entry. The format for each subscriber entry is:

phone number,last name,first name,1st part of e-mail address

Separate fields in an entry with commas. The entry line ends with a carriage return. See the sample input file in Figure 15-1. Table 15-2, "bulktool Input File Contents," contains valid values and descriptions for each attribute.

Figure 15-1: Example of an Input File

Table 15-2: bulktool Input File Contents

Attribute Description Valid Values

phone number

The subscriber's ten-digit telephone number.

The phone number for each subscriber must be unique.

Whitespace, dashes, slashes, and parentheses are not allowed in this field.

last name

The subscriber's last name.

Upper case and lower case characters, whitespace, and punctuation characters (except the comma) are allowed in this field. Slashes are not allowed in this field.

first name

The subscriber's first name.

Upper case and lower case characters, whitespace, and punctuation characters (except the comma) are allowed in this field. Slashes are not allowed in this field.

e-mail address

The first part of the subscriber's e-mail address, that is the part before the @ symbol, that will be used by uOne.
Note The full e-mail address for each subscriber must be unique. However, if the telephone number is used for the user ID, the first part of the e-mail address need not be unique.
The first part of a valid e-mail address.

Attribute	Description	Valid Values
phone number	The subscriber's ten-digit telephone number.	The phone number for each subscriber must be unique. Whitespace, dashes, slashes, and parentheses are not allowed in this field.
last name	The subscriber's last name.	Upper case and lower case characters, whitespace, and punctuation characters (except the comma) are allowed in this field. Slashes are not allowed in this field.
first name	The subscriber's first name.	Upper case and lower case characters, whitespace, and punctuation characters (except the comma) are allowed in this field. Slashes are not allowed in this field.
e-mail address	The first part of the subscriber's e-mail address, that is the part before the @ symbol, that will be used by uOne. Note The full e-mail address for each subscriber must be unique. However, if the telephone number is used for the user ID, the first part of the e-mail address need not be unique.	The first part of a valid e-mail address.

Step 3 To place the subscriber entries in the LDAP database, type:

./bulktool.tcl [-y] [-u email|telephone] input filename
Table 15-3: bulktool.tcl Command Line Options

Option Description

-y

Indicates non-interactive mode. This is useful with nohup.

-u <email|telephone>

Takes either the first part of an e-mail address or the telephone number from the input file as the user ID (uid) attribute, depending on whether "email" or "telephone" is specified in this argument.

The default is "email".
Note It is wise to use "telephone" for the user ID when multiple e-mail domains will co-exist on a Messaging Server.

input filename

A text file that contains the subscriber entries in the proper format.

Option	Description
-y	Indicates non-interactive mode. This is useful with nohup.
-u <email\|telephone>	Takes either the first part of an e-mail address or the telephone number from the input file as the user ID (uid) attribute, depending on whether "email" or "telephone" is specified in this argument. The default is "email". Note It is wise to use "telephone" for the user ID when multiple e-mail domains will co-exist on a Messaging Server.
input filename	A text file that contains the subscriber entries in the proper format.

Note

Step 4 Type y (or press Enter) to accept the set of attributes displayed and continue with the bulktool.tcl process.

The utility continues executing and takes the fourth field (first part of e-mail address) as the uid attribute. Figure 15-2 shows sample output from the bulktool.tcl utility.

Figure 15-2: Example of bulktool.tcl Status Information

Correcting rejected entries

Use the following procedure to correct rejected entries and reapply them to the database.

Step 1 On a GateServer where UMSA software resides, type:

cd /home2/spmaster/ADMIN/cgi-bin/MSGadmin

Step 2 Use the <input_filename>.err file to determine why the entries were rejected (Table 15-4).

Step 3 Make the appropriate corrections to the entries in the <input_filename>.notadded file.

Step 4 Run the bulktool.tcl utility with the corrected <input_filename>.notadded file as input.
Table 15-4: input_filename.err Error Messages

Error Message Description

Failed to add

The entry could not be added to the LDAP database.

Duplicate

The entry could not be added to the LDAP database because there is another entry on the database that exactly matches this entry.

Mail host not configured

The entry could not be added to the LDAP database because a mail host could not be found.

Missing field

The entry could not be added to the LDAP database because a required LDAP field was missing.

Error Message	Description
Failed to add	The entry could not be added to the LDAP database.
Duplicate	The entry could not be added to the LDAP database because there is another entry on the database that exactly matches this entry.
Mail host not configured	The entry could not be added to the LDAP database because a mail host could not be found.
Missing field	The entry could not be added to the LDAP database because a required LDAP field was missing.

Table of Contents