Previous      Contents      Next
Sun Java System Identity Manager 6.0 Resources Reference 2005Q4M3

---

Domino

The Domino resource adapter is defined in the com.waveset.adapter.DominoResourceAdapter class.

This adapter supports the following versions of Lotus Domino Server:

5.0
6.5

---

Note  The Domino Active Sync adapter (com.waveset.adapter.
DominoActiveSyncAdapter has been deprecated as of Identity Manager 5.0 SP1. All features in this adapter are now in the Domino Gateway adapter. Although existing instances of the Domino Active Sync adapter will still function, new instances of these can no longer be created.

---

Resource Configuration Notes

This section provides instructions for configuring Domino resources for use with Identity Manager, including:

General instructions for setting up the Domino resource for use with Identity Manager
Instructions for installing the Gateway to support Domino

General Configuration Instructions

Use these procedures to set up a Domino resource adapter:

Create the Identity Manager administrator in Domino. Use a certifier ID that has access to all organizations needed to manage users.
Add the user to the access control list (ACL) of the address book for the server, names.nsf.
Give the user Editor access.
Assign the user the following roles:
GroupModifier
UserCreator
UserModifier
Add the user to the ACL of the registration log, certlog.nsf, with Depositor access.
Add the user to the ACL of the Administration Requests, admin4.nsf, with Depositor access.
Add the newly-created user to server security:
Open the Security panel to edit the server configuration.
If access to the Domino server is restricted, make sure the Identity Manager proxy account has access to the server. This is done by specifying the account name or a group to which the proxy account belongs in the Access Server field.
If there is a before or after action that calls a Domino agent, the user might need to be added to the Run unrestricted LotusScript/Java agents or Run restricted LotusScript/Java agent field, depending on how the agent being called is configured.

Installing the Gateway to Support Domino

For the gateway to talk with Domino there must be a Notes client already installed on the gateway machine

Add the following string values to HKEY_LOCAL_MACHINE\SOFTWARE\
Waveset\Lighthouse\Gateway in the Windows registry to ensure Domino works properly:

notesInstallDir - This is the location where the client is installed and where the notes.dll file is location. Typically, the location is something like C:\Lotus\Notes\.

notesIniFile - The full path to the Lotus Notes initialization file, including the file name. We recommend that you copy the file from its default location (such as C:\Lotus\Notes\notes.ini) to the directory containing the Identity Manager gateway. Therefore, you should set the value of this registry key to a value similar to C:\GatewayDir\notes.ini.

---

Note  Make sure the Notes client is running with a network-enabled profile. If you change the network connection after you copy the ini file, you must re-copy it or run the client through the command line, as in:

---

C:\Lotus\Notes\notes.exe =PathToIniFile

Identity Manager Installation Notes

No additional installation procedures are required on this resource.

Usage Notes

This section provides information related to using the Domino resource adapter, which is organized into the following sections:

Recertification Process
Changing Passwords
Disabling and Enabling
ID File
Rename/Move
Resource Names
Active Sync Configuration

Recertification Process

The recertification process is done using the Boolean user attribute named “recertify.” During an update operation the attribute is checked; if enabled, the user ID is recertified.

The recertification process is done via the adminp process, meaning we generate an adminp request and the recertification of the id gets done at some point afterwards. The timing of the recertification will depend on configuration of the Domino server. In 5.0, if the address book entry gets recertified, then the next time the user logs into the system it will fix up the ID file with the new digest keys.

Changing Passwords

Administrative password changes and resets are not supported. Users must change their own passwords because the current password is required when changing.

The current password must be defined in the schema map as an account attribute named WS_USER_PASSWORD and needs to be of the encrypted type.

Disabling and Enabling

In the Domino database, there isn’t a native disable flag for each user, so each user disabled is placed in a DENY GROUP. When enabled, they are removed as members of any of the defined groups. DENY GROUP has a maximum number of members threshold so the group has to be specified as an account attribute to the resource. This requires an additional DenyGroups account attribute to be passed to the resource. DenyGroups can be set during a Disable, Enable, or Deprovision, but will not be fetched without additional coding.

When deprovisioning or disabling, you must send a list of DenyGroups that the user will be added to. When enabling, you must send a list of DenyGroups that the user will be removed from.

The available DenyGroups can be fetched from the resource with the following code:

<invoke name='listResourceObjects' class='com.waveset.ui.FormUtil'>

   <ref>:display.session</ref>

   <s>DenyLists</s>

   <s>YourResourceName</s>

   <null/>

   <s>false</s>

</invoke>

The currently assigned DenyGroups can be fetched on a disable, enable, or deprovision form with this code:

<invoke name='getList'>

   <invoke name='getView'>

      <ref>display.session</ref>

      <concat>

         <s>UserViewer:</s>

         <ref>resourceAccounts.id</ref>

      </concat>

      <map>

         <s>TargetResources</s>

         <list>

            <s>YourResourceName</s>

         </list>

      </map>

   </invoke>

   <s>accounts[YourResourceName].DenyGroups</s>

</invoke>

In the enable, disable, and deprovision forms, you must address the DenyGroups attribute as:

resourceAccounts.currentResourceAccounts [YourResourceName].attributes.DenyGroups

The following example defines a field in the disable form that lists the available DenyGroups in the left hand side of a multi-select box:

<Field name='resourceAccounts.currentResourceAccounts [YourResourceName].attributes.DenyGroups'>

   <Display class='MultiSelect'>

      <Property name='title' value='Deny Groups'/>

      <Property name='required'>

         <Boolean>false</Boolean>

      </Property>

      <Property name='allowedValues'>

         <invoke name='listResourceObjects' class='com.waveset.ui.FormUtil'>

            <ref>:display.session</ref>

            <s>DenyLists</s>

            <s>YourResourceName</s>

            <null/>

            <s>false</s>

         </invoke>

      </Property>

      <Property name='availableTitle' value='Available Deny Groups'/>

      <Property name='selectedTitle' value='Assigned Deny Groups'/>

   </Display>

</Field>

The following example defines a field in the enable form that lists the assigned DenyGroups in a derivation rule of a hidden field:

<Field name='resourceAccounts.currentResourceAccounts [YourResourceName].attributes.DenyGroups'>

   <Derivation>

      <invoke name='getList'>

         <invoke name='getView'>

            <ref>display.session</ref>

            <concat>

               <s>UserViewer:</s>

               <ref>resourceAccounts.id</ref>

            </concat>

            <map>

               <s>TargetResources</s>

               <list>

                  <s>YourResourceName</s>

               </list>

            </map>

         </invoke>

         <s>accounts[YourResourceName].DenyGroups</s>

      </invoke>

   </Derivation>

</Field>

ID File

The gateway machine generates new IDs for users that are newly registered. They may be placed on a UNC path that is accessible to the gateway process/service. So, specifying \\machine\ids\myidfile.id would put it on the network share.

There might be a need for the gateway to run as a user when configured as a service to get access to the share specified when a user is created. You can assign SYSTEM to have access to shares, but it depends on how the gateway network environment looks.

You can specify that the ID file be stored in the address book also by setting the Store ID In Addr Book resource attribute to TRUE/FALSE.

Rename/Move

The move/rename actions are also preformed by the adminp process. A move can be initiated from the rename form by changing the certifierOrgHierarchy attribute and providing the original certifierId file and password for that id file. The move request will create a “Name Move Request” in the requests database and must be completed by the new certifier that represents the user's new organization. A move can be initiated by changing the user's first/last name.

---

Note  You cannot perform a rename and a move at the same time; the adminp process will not allow this since the request references the canonical name which will be changed in both cases.

---

Resource Names

The gateway requires that all Domino resources be named uniquely. If you have multiple Identity Manager deployments and they “point” to the same gateway, all of the Domino resources that exist on the deployments must have unique resource names.

Active Sync Configuration

Before Identity Manager 5.5, if the Active Sync Process deletes as updates check box was selected, Identity Manager would disable a deleted Identity Manager user as well as all resource accounts and mark the user for later deletion. By default, this check box was selected. In Identity Manager 5.5 and beyond, this functionality is configured by setting the Delete Rule set to None.

If the checkbox was previously deselected, then the Delete Rule will be set to ActiveSync has isDeleted set.

Additional Information

This section provides some additional, useful information related to this adapter, including:

ListAllObjects
Form Updates
searchFilter
Other Form Issues
Attributes Configured to be Passed Into Views
Actions

ListAllObjects

You can list any object specified in Domino. Pass in the view name as the “type” to the listAllObjects call.

Form Updates

Since some of these operations require additional attributes, default forms must be updated to include these attributes.

The resource definition already defines the attributes that should be passed to the various views.

Enable, Disable — DenyGroups
Deprovision — DenyGroups (optional)
Expired Login, Change Password, Change My Password Form — HTTPPassword (must be secret), id file
Rename — certifierIDFile, credentials (must be secret)

searchFilter

The following sample UserForm illustrates how the searchFilter option for the getResourceObjects method can be implemented for Domino. This form finds all users with the last name Smith on the resource MyResource.

<Form name='Domino searchFilter Form' objectType=UserForm'>

   <Display class='EditForm'/>

   <Field name='rcwfield'>

      <Display class='MultiSelect'>

         <Property name='title' value='My Lister'/>

         <Property name='availableTitle' value='Listing available items'/>

         <Property name='selectedTitle' value='Selected Item(s)'/>

         <Property name='allowedValues'>

            <block trace='true'>

               <invoke name='getResourceObjects' class='com.waveset.ui.FormUtil'>

                  <ref>:display.session</ref>

                  <s>People</s>

                  <s>MyResource</s>

                  <Map>

                     <MapEntry key='searchAttrsToGet'>

                        <List>

                           <String>LastName</String>

                           <String>ShortName</String>

                           <String>MailFile</String>

                        </List>

                     </MapEntry>

                     <MapEntry key='searchFilter' value='@IsAvailable(LastName) &amp; @Contains(@LowerCase(LastName);"smith")'/>

                  </Map>

               </invoke>

            </block>

         </Property>

      </Display>

      <Disable>

         <i>0</i>

      </Disable>

   </Field>

</Form>

Other Form Issues

Only the HTTPPassword can be changed or reset via the administrator. If you do not want to change only the HTTPPassword, the default tables must filter the Domino adapter.
The Change My Password, Change Password, and Expired Login forms generate a column named “Forgot Old Password?” This column must be removed for Domino resources since Identity Manager does not support administrator password updates.

Attributes Configured to be Passed Into Views

idFile — Password, LoginChange
DenyGroups — Enable, Disable, Delete
certifierIdFile, credentials — Rename
HTTPPassword — Password, LoginChange

Actions

The following variables are available for use in before and after actions:

WSUSER_accountId
WSUSER_UNID

The WSUSER_UNID variable refers to the Lotus Notes universal ID. This variable cannot be referenced until after the account has been created.

Security Notes

This section provides information about supported connections and privilege requirements.

Supported Connections

Identity Manager uses the Sun Identity Manager Gateway to communicate with Domino.

Required Administrative Privileges

None

Provisioning Notes

The following table summarizes the provisioning capabilities of this adapter.

Feature	Supported?
Enable/disable account	Yes
Rename account	Yes
Pass-through authentication	No
Before/after actions	Yes
Data loading methods	Import from resource   Reconciliation   Active Sync

Account Attributes

The following table provides information about Domino account attributes.
The default data type is string, unless otherwise indicated.

Resource User Attribute	Description
alternateOrgUnit	The organizational unit for the user in the alternate language.
AltFullName	The user’s full name, in the user’s native language
AltFullNameLanguage	The language associated with the alternate full name.
Assistant	The name of an assistant.
CalendarDomain	The domain name for the calendar.
CellPhoneNumber	The user’s cell phone number.
certifierIDFile	Path to the certifier ID file relative to the gateway machine (overrides value on resource)
CertifierOrgHierarchy	Path of certifier’s organization hierarchy, such as /US1 (overrides value on resource)
CheckPassword	Integer. 1 = check 0 = no check
Children	The name or names of the employee’s children.
City	The city of the user’s home address.
Comment	A comment about the user.
CompanyName	The company the user works for.
Country	The country of the user’s home address.
credentials	Password for the certifier ID file (overrides value on resource)
dbQuotaSizeLimit	Specifies the maximum size of the user’s mail database. If you specify a value less than 1000, then the maximum size is in megabytes (MB). If the value is 1000 or greater, then the maximum size is expressed in bytes. Values between 1001 and 1023 are rounded up to 1024 bytes. The proxy administrator must be listed as an Administrator in the Server document to set this attribute.
dbQuotaWarningThreshold	Specifies the size of a user’s mail database at which point a warning about the size of the database is generated. If you specify a value less than 1000, then the threshold is in megabytes (MB). If the value is 1000 or greater, then the threshold is expressed in bytes. Values between 1001 and 1023 are rounded up to 1024 bytes. The proxy administrator must be listed as an Administrator in the Server document to set this attribute.
defaultPasswordExp	Number of days for new certificates to be issued (create, recertify operations)
deleteMailFileOption	Overrides the resource attribute:   0: Do not delete mail file   1: Delete just mail file specified in person record   2: Delete mail file specified in person record and all replicas Note: If configured to delete the mailfile and adminp request will be queued and must be approved natively before it is deleted.
DenyGroups
Department	The department name or number of the user.
DisplayName	The user’s displayed name.
EmployeeID	The unique employee ID for the user.
firstname	The user’s first name.
HomeFAXPhoneNumber	The user’s home fax/phone number
HTTPPassword	Password to be used when accessing a Notes server from a web browser or other HTTP client.
idFile	Full qualified path to the ID file relative to the gateway machine.
gateway machine
InternetAddress
JobTitle	The user’s job title.
lastModified	A string representation of the last date and time the user was modified.
lastname	The user’s last name
Location	Office location or mail stop
MailAddress	The user’s e-mail address.
MailDomain	Domain name of user’s mail server
MailFile	The name of the mail file, such as MAIL\JSMITH
mailOwnerAccess	Indicates the access control level for the mailbox owner. Possible values are 0 (manager), 1(desginer), and 2 (editor). This attribute is not in the schema map by default. The attribute is applicable only when creating users.
MailServer	The user’s mail server name.
MailTemplate	Name of mail template. Only valid during create.
Manager	The user’s manager.
MiddleInitial	Middle initial with a trailing period.
NetUserName	The user’s network account name.
NotesGroups
objectGUID	The user’s NotesID.
OfficeCity	The city of the user’s work address.
OfficeCountry	The country of the user’s work address.
OfficeFAXPhoneNumber	The fax number of the user’s work address.
OfficeNumber	The office number of the user’s work address.
OfficePhoneNumber	The phone number of the user’s work address.
OfficeState	The state or province of the user’s work address.
OfficeStreetAddress	The street address of the user’s work address.
OfficeZIP	The postal code of the user’s work address.
orgUnit
password	The user’s password
PasswordChangeInterval	Integer. The number of days after which the user must supply a new password.
PasswordGracePeriod	The number of days after the password has expired before the user is locked out.
PhoneNumber	The user’s home telephone number.
PhoneNumber_6
Profiles
Recertify	Boolean. Flag to indicate you would like to recertify a user.
SametimeServer	Hierarchical name of the user’s sametime server.
ShortName	Short user name commonly used by a foreign mail system.
Spouse	The name of the user’s spouse.
State	The state or province in the user’s home address.
StreetAddress	The address of the user’s home address.
Suffix	The user’s generational qualifier
Title	The user’s title
WebSite	The user’s web site.
WS_USER_PASSWORD	Attribute used to send user’s current password during user change password requests.
x400Address
Zip	The postal code of the user’s home address.

Identity Template

Domino stores the identity of each user in the userid file. However, that same user name is stored in the user record in the FullName attribute. That attribute is multi-valued, and the first one in the list is unique. The first name in the list is stored in canonical format and is similar to the following:

CN=Joe T Smith/O=MyCompany

Using this name we can get to the record of the Name and address book. Identity Manager stores this string on the resourceInfo in its “nice” form, which looks like:

Joe T Smith/MyCompany

Domino has built-in functions to convert names back and forth at the API level. Identity Manager also stores the NOTEID as the GUID attributes, and whenever possible uses this global identifier to look up users in Domino.

The default identity template is:

$firstname$ $MiddleInitial$ $lastname$$CertifierOrgHierarchy$

Depending on the environment, the middle initial may not be not included.

Sample Forms

DominoActiveSyncForm.xml

Troubleshooting

Use the Identity Manager debug pages to set trace options on the following class:

com.waveset.adapter.DominoResourceAdapter

---

Exchange 5.5

Support for the Microsoft Exchange resource adapter has been deprecated.

---

Note  Use the Active Directory resource for Exchange 2000/20003, which is integrated with Exchange.

---

Previous      Contents      Next

---

Copyright 2006 Sun Microsystems, Inc. All rights reserved.