Import Data File Format

An entry in an import data file can contain the following optional attributes: · An optional (text format) attribute UniqueOrgUnit, whose value is used as an

additional value for OrganizationUnit to distinguish between entries with identical names; that is, identical values for the FirstName, MiddleInitial, LastName attributes.

· An optional (integer) attribute Validity, whose value specifies the lifetime, in days, for which the user certificate is valid (the default is 730 (2 years)).

The import data file format supports the LDIF per-entry "changetype" attribute that indicates the type of modification to be made to the entry in the Notes address book. The value for "changetype" is one of "add", "modify", "delete", "RenameUser", "RecertifyUser", "DeleteUser" or "MoveUserInHier". The changetype attribute name and its values are case-insensitive.

The attributes for a multi-valued attribute specified in a "modify" changetype operation appear on separate lines. For example:

add: OfficeFaxPhoneNumber OfficeFaxPhoneNumber: 123458 OfficeFaxPhoneNumber: 345892 -

Entries with a "modify" changetype contain attributes that indicate one or more "add", "delete", or "replace" attribute value modifications. The "replace" modification has a higher precedence than the "add and "delete" modifications; if it is present for an attribute, it is the only modification evaluated. For the "modify" changetype, NotesAgent adds a new entry in the Notes address book if it does not find a matching entry.

The "RenameUser" changetype renames a registered user. The user may need to confirm renaming when he logs on to Notes the next time. The entry must contain the

OldUserName (in canonical format) and LastName attributes. The FirstName, MiddleInitial, UniqueOrgUnit. and Validity attributes are optional. For example:

OldUserName: CN=Armen Varteressian/OU=USA/O=Siemens LastName: Varteressian

Validity: 365

To perform this operation, the PathFileCertId field in the RegUser section of the import configuration file must be specified.

completed when the user logs on the next time using the new certificate. The entry must contain the UserName (in canonical format) attribute and the PathFileCertId field in the RegUser section of the import configuration file must be specified.

The "DeleteUser" changetype deletes the user in "Person Documents", "Access Control List" and in "Reader/Author" fields and deletes his mail file subject to confirmation in the request database (approve file deletion) by the Lotus Administrator. The following attributes must be present in the import entry:

· UserName (in abbreviated format) · MailServer (in abbreviated format)

· MailFile (mail file name including path relative to the Notes data directory) · DeleteMailFile (0=don't delete mail file;1=delete just mail file specified in person

record;2=delete mail file specified in person record and all replicas) For example:

UserName: Armen Varteressian/USA/Siemens MailServer: Neptune/Siemens

MailFile: mail\Varteres DeleteMailFile: 2

In order to perform this operation, the AdminReqDB and AdminReqAuthor fields in the Import section of the import configuration file must be specified, and the DeleteEntries field must be set to 0. If DeleteEntries is set to 1 or a "delete" changetype entry is

processed, the user is deleted in the Notes address book only and his mail file is retained. The "MoveUserInHier" changetype moves a user to a different organizational unit and renames the full user name. In order to perform this operation:

· The Lotus Notes Client V5.0 must be installed

· The source and target organizational units must have different certificate ID (cert.id) files

· The PathFileTargetCertID field in the Import section of the import configuration file must specify the pathname to the certificate ID file of the target organizational unit, for example:

PathFileTargetCertID=a:\German.id

· The PathFileCertID in the RegUser section of the import configuration file must specify the pathname to the certificate ID file of the source organizational unit, for example:

PathFileCertID=a:\cert.id

· The password configuration file must contain the passwords for both source and target organizational unit certificate IDs in the Password section, for example:

CertifierPW=password_for_source_organization

TargetCertifierPW=password_for_target_organization

· The FullName and TargetCertifier attributes must be present in the import entry in canonical format. For example:

FullName: CN=Armen Varteressian/O=Siemens TargetCertifier: OU=Germany/O=Siemens

The values in the relevant fields in the import configuration file have a higher precedence than the changetype operations specified in the import data file. For example, if

DeleteEntries is set to 1, NotesAgent deletes entries that match entries in the import data file from the Notes address book regardless of the change types specified for the entries in the import data file.

The import data file can contain comments, which are identified by a # character at the beginning of a line.

For Person entries, the LastName attribute must be the first attribute for the entry, the FirstName attribute must be the second attribute, and the MiddleInitial attribute must be the third attribute. For Group entries, the ListName attribute must be the first attribute for the entry. The ordering for all other attributes for Person and Group entries is arbitrary.

2.4 Import Error File Format

During the import process, NotesAgent writes the original attributes and values of entries that it is unable to import into the error file specified on the command line along with an error message that describes the error. Each line in the import error file generated by NotesAgent on an import operation has the following format:

source_entry

#error_code

#error_message

where source_entry is the original entry that NotesAgent was unable to import, error_code

is the code for the error that occurred, and error_message is a description of the error. For example:

FirstName: Armen

LastName: Varteressian CompanyName: Digital Type: Person

FullName: Armen Varteressian ShortName: avart

City: Nashua

Department: PUBS,VMSpubs State: New Hampshire #ProcessAddress error:

#Find more as one document with the following ItemIdentityName(s): FirstName, LastName

Any entry that cannot be imported into the Notes address book is written into the import error file. Consequently, you can use the file as an input file and re-run the import operation, after first fixing the errors reported in the file.

2.5 NotesAgent Import Procedure

If NotesAgent encounters a single-valued attribute in an import data file that has more than one value defined, it takes the first value.

The order of operation on attributes is arbitrary. An import entry should not contain inconsistent attribute operations for the entry.

NotesAgent creates groups with GroupType 0-2 in the Groups folder of the Lotus Notes address book. It creates groups with GroupType 3 in the Server/Deny Access Groups folder.

The import configuration fields RegisterUser, ClientType, PathFileCertId and

PathFileTargetCertId can be present as attributes of an entry to be imported. The syntax is:

field_name: field_value

The colon character (:) is the name and value separator. For example: RegisterUser: 1

ClientType: 1

PathFileCertId: d:\notes\data\certs\cert.id

PathFileTargetCertId: d:\notes\data\certs\sales.id

When present in the entry, the values in these attributes override the values specified in the fields of the import configuration file. When absent from the entry, NotesAgent uses the fields' default values from the configuration file.

Chapter

3