Corporate lookup settings
Many settings can be modified for the corporate look up feature.
- The minimum number of characters typed before a lookup is executed.
- The maximum number of results returned to the device.
- Which server the lookup is executed against.
- Which directories are searched.
- Enforcing access control lists.
- The search depth performed by the look up function.
- What fields are retrieved from the directory and how they are sent to the device.
- What fields are used for duplicate resolution.
- What mail address fields are encoded for Apple Devices.
All settings below can be updated by changing and/or adding a property
in the notes.ini
for the server.
Configuring how many characters are typed before the query is performed
Apple and Android devices will search
as you type. To improve performance, a default of three characters
must be typed before the actual look up initiates. You can configure
this value by setting NTS_NAME_LOOKUP_MIN_LENGTH
.
On Windows Mobile and Nokia devices, a search is not executed until
you press the Search or Lookup button.
Configuring the maximum number of results to return to the client
NTS_NAME_LOOKUP_MAX_RECORDS
property. Configuring which server to perform the lookup against
By default the lookup is performed against the user's mail server. This is done to reduce
configuration needed on the IBM Traveler server and provide more consistent results with a Notes® Client. The behavior can be changed to perform the lookup
operation against the IBM Traveler server instead. To have lookups performed against the IBM
Traveler server, set NTS_TRAVELER_AS_LOOKUP_SERVER=true
.
Which directories are searched
The look up itself is a Domino® server operation. The Domino® server will search the local address book and any directories specified by Directory Assistance. For example if using a corporate LDAP you will need to setup Directory Assistance such that the Domino® server can look up entries in the LDAP server. In general, the user's mail server should already have appropriate configuration for handling search requests from a Notes® Client. See the Domino® documentation on Directory Assistance for more information.
Enforcing access control for lookup
- Ensure all IBM Traveler servers have set
NTS_LOOKUP_ENFORCE_ACL=1
in thenotes.ini
. A setting of0
is the default. - Ensure the IBM Traveler server has read access in the ACL of the primary directory of the mail
server, as well as any secondary address books that may need to be searched.
Do not use the
Unspecified
type in the ACL. Instead, identify it as aServer
(orServer Group
when using a group). When using a server group, the group type in the name and address book must beServer group
. Do not use mixed groups. - Ensure that the names and address books that need to have restricted access use the Extended
ACL. Additionally:
- It is important that the extended access portion of the ACL be configured to contain the groups that should have access to search the directory.
- To prevent unauthorized users from viewing data in the directory, confirm that the default and
anonymous entries are set to
No Access
and do not have the Read public documents checkbox selected.
For more information on the extended ACL, see the Domino documentation on using ACL and Extended ACL to control access to directories.
Search depth
The default search depth is an exhaustive search of all directories found. This search depth is the most common, however it can be configured with one of the values shown below.
NTS_NAME_LOOKUP_FLAGS
attribute.0
means that the lookup will not match partial names and will stop searching once a match is found.8
means that the lookup will match partial names, but again will only return the first value found.32
will not match partial names, but will perform an exhaustive search of all directories including ones specified in directory assistance. It will return all results.40
(default) will match partial names and perform an exhaustive search of all directories.
Configuring which items should be retrieved from the directory
NTS_NAME_LOOKUP_ITEMS_EXT
property.
Due to line length limitations in the notes.ini
file,
the NTS_NAME_LOOKUP_ITEMS_EXT
property must be split
into segments of less than 256 characters each. For example: NTS_NAME_LOOKUP_ITEMS_EXT=NTS_ITEMS_1, NTS_ITEMS_2 NTS_ITEMS_1=LastName,FirstName,MiddleInitial,ListName,FullName,Type,$$NoteID,Title,Suffix,OfficeStreetAddress,OfficeCity,OfficeState,OfficeZIP,OfficeCountry NTS_ITEMS_2=StreetAddress,City,State,Zip,country,JobTitle,CompanyName,Department,InternetAddress,CellPhoneNumber,PhoneNumber,OfficePhoneNumber,WebSite
LastName,FirstName,MiddleInitial,ListName,FullName,Type,$$NoteID,Title,Suffix,OfficeStreetAddress,OfficeCity,OfficeState,OfficeZIP,OfficeCountry,StreetAddress,City,State,Zip,country,JobTitle,CompanyName,Department,InternetAddress,CellPhoneNumber,PhoneNumber,OfficePhoneNumber,WebSite
Once the fields are retrieved from the directory, you can then change how they get mapped to the device. This differs based on device type. For Apple devices, see Customizing the Exchange ActiveSync XSLT file. For all other devices, see Customizing the VCARD XSLT file.
Duplicate resolution
Often, you will have
a particular entry in more than one directory, or even in the same
directory with different names. To prevent duplicate results from
being sent to the device, you can specify a field or fields that are
required to be unique. If the field contains a duplicate entry, then
it is ignored and not sent to the device. By default, the fields InternetAddress
and $$NoteID
are
used for duplicate resolution. You can configure which fields to use
in the NTS_NAME_LOOKUP_UNIQUEITEMS
property. Note
that in order for the field to be used for duplicate resolution, it
must be returned by the lookup. Therefore any field specified in NTS_NAME_LOOKUP_UNIQUEITEMS
must
also be specified in NTS_NAME_LOOKUP_ITEMS_EXT
, or
in the default list if not specified. Otherwise, the item will be
ignored for duplicate resolution.
E-mail address fields
Apple devices do not
handle Domino® style mail
addresses well. To improve usability and overcome some functional
concerns, all non-standard mail addresses sent to an Apple device
are encoded to a format that Apple devices understand (for example,
name@yourco.com). By default, corporate lookup is done for the InternetAddress
field.
To apply this encoding to another mail address field, modify NTS_NAME_LOOKUP_EMAILADDRESSITEMS
property.
See Address encoding for Microsoft Exchange ActiveSync devices for more
information on this function.