|
|
If you have ten or more subscribers that you must add to the directory and messaging servers, you may want to use the bulktool.tcl utility instead of uOne 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. It also facilitates migration from legacy systems.
When you execute the bulktool.tcl utility, it invokes the uOne 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 uOne Administration CGI program converts the entry data to LDIF format and then places the entry in the LDAP database. The utility continues to pass entries, and the uOne 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.
Before you start provisioning subscribers in bulk, ensure that the following tasks have been completed:
To add subscribers in bulk, you perform the following tasks:
After you complete a bulk add, subscriber accounts are active and ready for login.
The bulktool configuration file contains a common set of subscriber attributes, such as the greeting administrator account, 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.
There are two variants of the bulktool configuration file, the one that you use depends on the type of backend server in your system configuration:
To set up the bulktool configuration file for a bulk add run, follow these steps:
cd /home2/spmaster/ADMIN/cgi-bin/MSGadmin/MSGdata
Step 2 Edit the appropriate bulktool ini file, changing the following parameters to match your system configuration (Table 17-1). You may use the defaults for the remaining parameters.
[entryDN]
default=
[cosdn]
default=
[serverhostname]
default=
[admininfo]
default=
[faxadmininfo]
default=
[preferredlanguage]
default=
| Parameter | Description | Valid Values |
|---|---|---|
[entryDN] | Indicates where in the LDAP database the subscribers' entries will reside. | Examples: For Software.com: o=consumer, dc=software, dc=com |
[cosdn] | Identifies the class of service and the distinguished name (dn) for a class of service to which the subscribers belong. This entry must be at or below the search base used as the subscribers' entry DN. | A valid COS dn. Examples: For Software.com: cos1, o=consumer, dc=software, dc=com |
[serverhostname] | The messaging server name for the server where these subscriber entries will reside. | A valid domain name. For example, dome2.cisco.com |
[admininfo] | The Greeting Administrator account to which these subscribers will be assigned. | A valid mailbox ID of the Greeting Administrator account. |
[maildomain] | Used to create a valid e-mail address. The input file is used for the e-mail prefix. | A valid e-mail domain name. Do not include the @ character. |
[faxadmininfo] | If your subscribers will have fax services, the Fax Administrator account to which these subscribers will be assigned. | A valid mailbox ID of the Fax Administrator account. |
[preferredlanguage] | Selects the language in which the subscribers will listen to prompts and e-mail TTS over the telephone interface. | A valid value for a preinstalled language listed in the languageData.ini file. That file is in /home2/spmaster/ADMIN/cgi-bin/MSGadmin/MSGdata. |
To add subscribers in bulk, use these steps:
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 17-1. Table 17-2 contains valid values and descriptions for each field.
| 8047625614,Smith,Thomas,tsmith
|
| Field | Description | Valid Values | ||
|---|---|---|---|---|
phone number | The subscriber's telephone number. | 4 - 15 digits. The phone number for each subscriber must be unique. Whitespace, dots, 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. | ||
1st part of e-mail address | The first part of the subscriber's e-mail address, that is the part before the @ symbol.
| 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>
| Option | Description | ||
|---|---|---|---|
-y | Indicates non-interactive mode. This is useful when running the command via the UNIX nohup command. | ||
-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 uid is used, in particular, when IMAP logins are performed. The default is "email."
| ||
<input filename> | A text file that contains the subscriber entries in the format of Table 17-2. |
 |
Note When running interactively, the utility displays the default values and asks if you want to continue. The msghost, uniqueidentifier, noforlastname, and noforfirstname attributes should have a value of "to be determined." These attributes are computed automatically by uOne Administration when the entries are added. |
Step 4 When running interactively, 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 17-2 shows sample output from the bulktool.tcl utility.
| Processing \Qdata2.txt\Q for
|
|
Note In the above example, the dots (.) represent entries that were successfully added and the stars (*) represent the rejected entries. |
Use the following procedure to correct rejected entries and reapply them to the database.
cd /home2/spmaster/ADMIN/cgi-bin/MSGadmin
Step 2 Use the <input_filename>.err file to determine why the entries were rejected (Table 17-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.
| 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 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 attribute value was missing. |
Posted: Mon Sep 25 20:00:12 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.