User data lists
User data list operations all begin with an input file
that consists of one line per record. Remember, there
has to be at least a new line between records (a carriage return
in front of it is also acceptable--this combination
is often known as "DOS text" and it's what's produced by Windows
Notepad, or Wordpad, when files are saved as DOS text.)
Each record in a user data list may consist of:
"login","email","password","firstname","lastname","city","state","nation"
(This is shown in commas-and-quotes format. You
may also use a field separator instead if you like, provided the
seperator doesn't occur in the fields themselves.)
Of these fields, only the first is are required in any given
record.
All of these fields can be 0-40
characters long, except for login
(1-20), password (20 max), first name (20 max),
and the e-mail address
(must be at least 7 characters long). The
e-mail address
must contain an "at-sign,",
and there must be a period somewhere after the
"at-sign."
You'll be shown an alert which references the bad line if any
errors are found.
If you wish to omit a series of consecutive fields at the end,
you needn't code them at all. For example, this is
perfectly acceptable:
"login"
However, if you want to omit a field in the middle, it has to
be specified as an empty field. For example, if you want
to omit the password, but specify the first and last names, you'd
do this:
"login","email","","firstname","lastname"
That example assumes that you're using commas-and-quotes.
If you were using ** (2 asterisks) as your field separator,
then it would look like this:
login**email****firstname**lastname"
(note that four asterisks signify the missing field.)
User data lists can be used to find users by: login name (on boards that
use login names); by last name (on boards that use last names);
and by e-mail address (all boards).
User data lists may also be used to
add users to the user database, or to send e-mail to
users.
In the case of finding users, the output is broken down into two
parts: found users and unfound users.
Found users are returned in a modified user data list
format, except that the numeric user ID# comes first, i.e.:
"User ID#","login","email","password","firstname","lastname","city","state","nation"
Note that the password will be the same as whatever you supplied
as the input. On boards that use login names, the same
goes for the first and last names. On boards that use
real names, the login name will be the same as whatever you
supplied in the input.
This is because a
WebBoard user search reveals none of these fields. If you
didn't specify any of these fields, they'll be filled with the value:
*Unknown*
You also get a list of numeric user ID#s out for the found
users. Each user ID is printed between
double-quotes on a separate line.
For each user that wasn't found in the search, you'll get back the
input line that you supplied to initiate the search.
To repeat: user data lists may also be used to add users to
the WebBoard user database, and to send e-mail to them.
When adding users, you may omit the password--if so, one will be
generated automatically. If you fail to supply a first or
last name, these will be set to "None," and the geographical fields
will each be set to one space (the WebBoard default).
You may also omit the e-mail address. If you
do, it defaults to need.email@ddress.com, or the value of
C_DefAddEmail. (See
section 21 for
how to change this default. It can't be altered
at run time.)
The output of an add operation is also divided into
successfully added users and those who weren't successfully added,
and the format for each is the same as user data list format
(except that if you omit the password, the generated password
will be included in the list of successfully added users).
You may also use user data lists for sending e-mail
to users. What gets sent is the e-mail me my password
message (emailpass.txt). At the end of the
run, you'll see a list of found users (the login name was
recognized) and unfound users (the login name wasn't recognized, perhaps
because the user changed it).
Finally, user data lists can be used to "replicate membership,"
i.e. to make WebBoard "think" that the list of users are also
users for the same board from which the batch processor is running.
This can be particularly useful if you wish to install the
"fast" version of usersearch.html (see section
19), and/or to switch between the login names
and real names options on this board (without affecting other
boards).