| Oracle® Identity Manager Connector Guide for IBM Lotus Notes and Domino Release 9.0.4 Part Number E10157-01 |
|
|
View PDF |
| Oracle® Identity Manager Connector Guide for IBM Lotus Notes and Domino Release 9.0.4 Part Number E10157-01 |
|
|
View PDF |
After you deploy the connector, you must configure it to meet your requirements. This chapter discusses the following connector configuration procedures:
Note:
These sections provide both conceptual and procedural information about configuring the connector. It is recommended that you read the conceptual information before you perform the procedures.As mentioned earlier in this guide, reconciliation involves duplicating in Oracle Identity Manager additions of and modifications to user accounts on the target system. This section discusses the following topics related to configuring reconciliation:
By default, all target system records that are added or modified after the last reconciliation run are reconciled during the current reconciliation run. You can customize this process by specifying the subset of added or modified target system records that must be reconciled. You do this by creating filters for the reconciliation module.
Creating a filter involves specifying a value for a target system attribute, which will be used in the query SELECT criteria to retrieve the records to be reconciled. You can specify values for any one or a combination of the following filter attributes, which are also target system attributes:
LastName
OU
If you want to use multiple target system attributes to filter records, then you must also specify the logical operator (AND or OR) that you want to apply to the combination of target system attributes that you select.
For example, suppose you specify the following values for these attributes:
LastName: Doe
OU: DEL
Because you are using the OR operator, during reconciliation, only user records for which any one of these criteria is met are reconciled. If you were to use the AND operator, then only user records for which all of these criteria are met are reconciled.
While deploying the connector, follow the instructions in the "Specifying Values for the Scheduled Task Attributes" section to specify values for these attributes and the logical operator that you want to apply.
During a reconciliation run, all changes in the target system records are reconciled into Oracle Identity Manager. Depending on the number of records to be reconciled, this process may require a large amount of time. In addition, if the connection breaks during reconciliation, then the process would take longer to complete.
You can configure batched reconciliation to avoid these problems.
To configure batched reconciliation, you must specify values for the following user reconciliation scheduled task attributes:
BatchSize: Use this attribute to specify the number of records that must be included in each batch. The default value is 1000.
NumberOfBatches: Use this attribute to specify the total number of batches that must be reconciled. The default value is All.
If you specify a value other than All, then some of the newly added or modified user records may not get reconciled during the current reconciliation run. The following example illustrates this:
Suppose you specify the following values while configuring the scheduled tasks:
BatchSize: 20
NumberOfBatches: 10
Suppose that 314 user records were created or modified after the last reconciliation run. Of these 314 records, only 200 records would be reconciled during the current reconciliation run. The remaining 114 records would be reconciled during the next reconciliation run.
You specify values for the BatchSize and NumberOfBatches attributes by following the instructions described in the "Specifying Values for the Scheduled Task Attributes" section.
While configuring the connector, the target system can be designated as a trusted source or a target resource. If you designate the target system as a trusted source, then both newly created and modified user accounts are reconciled in Oracle Identity Manager. If you designate the target system as a target resource, then only modified user accounts are reconciled in Oracle Identity Manager.
Configuring trusted source reconciliation involves the following steps:
Note:
You can skip this section if you do not want to designate the target system as a trusted source for reconciliation.Import the XML file for trusted source reconciliation, xlLotusNotes_XellerateUser.xml, by using the Deployment Manager. This section describes the procedure to import the XML file.
Note:
Only one target system can be designated as a trusted source. If you import the
xlLotusNotes_XellerateUser.xml file while you have another trusted source configured, then both connector reconciliations would stop working.Specify values for the attributes of the Lotus Notes trusted User Reconciliation scheduled task. This procedure is described later in this guide.
To configure trusted source reconciliation:
Open the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for locating files is displayed.
Locate and open the xlLotusNotes_XellerateUser.xml file, which is in the OIM_home/xlclient directory. Details of this XML file are shown on the File Preview page.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Import.
In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.
When you perform the procedure described in the "Step 3: Copying the Connector Files and External Code Files" section, the scheduled tasks for lookup fields, trusted source user, and nontrusted user reconciliations are automatically created in Oracle Identity Manager. To configure these scheduled tasks:
Expand the Xellerate Administration folder.
Select Task Scheduler.
Click Find. The details of the predefined scheduled tasks are displayed on two different tabs.
For the first scheduled task, enter a number in the Max Retries field. This number represents the number of times Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task.
Ensure that the Disabled and Stop Execution check boxes are not selected.
In the Start region, double-click the Start Time field. From the date-time editor that is displayed, select the date and time at which you want the task to run.
In the Interval region, set the following schedule parameters:
To set the task to run on a recurring basis, select the Daily, Weekly, Recurring Intervals, Monthly, or Yearly option.
If you select the Recurring Intervals option, then you must also specify the time interval at which you want the task to run on a recurring basis.
To set the task to run only once, select the Once option.
Provide values for the attributes of the scheduled task. Refer to the "Specifying Values for the Scheduled Task Attributes" section for information about the values to be specified.
See Also:
Oracle Identity Manager Design Console Guide for information about adding and removing task attributesClick Save. The scheduled task is created. The INACTIVE status is displayed in the Status field, because the task is not currently running. The task is run at the date and time that you set in Step 7.
Repeat Steps 5 through 10 to create the second scheduled task.
After you create both scheduled tasks, proceed to the "Adding Custom Attributes for Reconciliation" section.
This section provides information about the values to be specified for the following scheduled tasks:
You must specify values for the following attributes of the Lotus Notes Lookup Reconciliation lookup fields reconciliation scheduled task.
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value were left empty, then reconciliation would not be performed.
After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
Depending on whether you want to implement trusted or nontrusted soured reconciliation, you must specify values for the attributes of one of the following user reconciliation scheduled tasks:
Lotus Notes trusted User Reconciliation (Scheduled task for trusted source reconciliation)
Lotus Notes Non trusted User Reconciliation (Scheduled task for nontrusted source reconciliation)
The following table describes the attributes of both scheduled tasks.
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value were left empty, then reconciliation would not be performed.
| Attribute | Description | Default/Sample Value |
|---|---|---|
TargetRO |
Name of the resource object | LOTUSRO for nontrusted source reconciliation
|
ServerName |
Name of the IT resource instance that the connector uses to reconcile data | LotusNotes |
IsTrusted |
Specifies whether or not reconciliation is to be carried out in trusted mode | For trusted source reconciliation, set the value of this attribute to Yes.
For nontrusted source reconciliation, set the value of this attribute to |
LoginNameField |
Parameter whose value is used as the login name for the Xellerate User
Ensure that the value of the parameter that you select is unique for each IBM Lotus Notes and Domino user. |
Notes.LastName or Notes.ShortName |
XellerateOrganisation |
Default value for the Oracle Identity Manager Organization name
This value is used to create the Xellerate User in trusted mode. Note: This attribute is specific to trusted source reconciliation. |
Xellerate Users |
BatchSize |
Number of records in each batch that is reconciled
You must specify an integer value greater than zero. See Also: The "Batched Reconciliation" section |
The default value is 1000. |
NoOfBatches |
Number of batches to be reconciled
The number of records in each batch is specified by the See Also: The "Batched Reconciliation" section |
Specify All if you want to reconcile all the batches. This is the default value.
Specify an integer value greater than zero if you want to reconcile only a fixed number of batches. |
LastName |
This is a filter attribute. Use this attribute to specify the first name of the user whose records you want to reconcile.
If you do not want to use this filter attribute, then specify See Also: The "Partial Reconciliation" section |
The value can be either the first name or Nodata.
The default value is |
| OU | This is a filter attribute. Use this attribute to specify the OU of the users whose records you want to reconcile.
If you do not want to use this filter attribute, then specify See Also: The "Partial Reconciliation" section |
The value can be either the first name or Nodata.
The default value is |
Operator |
This is a filter attribute. Use this attribute to specify the operator that you want to apply on the filter attributes.
See Also: The "Partial Reconciliation" section |
The value can be AND or OR.
The default value is |
After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
Note:
In this section, the term "attribute" refers to the identity data fields that store user data.By default, the attributes listed in the "Reconciliation Module" section are mapped for reconciliation between Oracle Identity Manager and the target system. If required, you can map additional attributes for reconciliation as follows:
Note:
You need not perform this procedure if you do not want to add custom attributes for reconciliation.See Also:
Oracle Identity Manager Design Console for detailed instructions on performing the following stepsModify the attributemapping_recon.properties file, which is in the OIM_home/xellerate/XLIntegrations/LotusNotes/config directory.
At the end of this file, some of the attribute definitions are preceded by comment characters. You can uncomment the definition of an attribute to make it a part of the list of reconciliation attributes. If required, you can also add new attributes in this file. The format that you must use is as follows:
OimAttributeName=TargetAttributeName,API_Name
For example:
Users.City=City
In this example, City is the reconciliation field and also the equivalent target system attribute. As a standard, the prefix "Users." is added at the start of all reconciliation field names.
In the resource object definition, add a reconciliation field corresponding to the new attribute as follows:
Open the Resource Objects form. This form is in the Resource Management folder.
Click Query for Records.
On the Resource Objects Table tab, double-click the LOTUSRO resource object to open it for editing.
On the Object Reconciliation tab, click Add Field to open the Add Reconciliation Field dialog box.
Specify a value for the field name.
You must specify the name that is to the left of the equal sign in the line that you uncomment or add while performing Step 2.
For example, if you uncomment the Users.City=City line in Step 2, then you must specify Users.City as the attribute name.
From the Field Type list, select a data type for the field.
For example: String
Save the values that you enter, and then close the dialog box.
If required, repeat Steps d through g to map more fields.
Modify the process definition to include the mapping between the newly added attribute and the corresponding reconciliation field as follows:
Open the Process Definition form. This form is in the Process Management folder.
On the Reconciliation Field Mappings tab, click Add Field Map to open the Add Reconciliation Field Mapping dialog box.
Enter the required values, save the values that you enter, and then close the dialog box.
If required, repeat Steps b and c to map more fields.
As mentioned earlier in this guide, provisioning involves creating or modifying a user's account information on the target system through Oracle Identity Manager. Refer to the "Supported Functionality" section for a listing of the provisioning functions that are available with this connector.
This section discusses the following topics related to configuring provisioning:
Note:
You must perform this procedure if you want to use the provisioning features of the connector.Adapters are used to implement provisioning functions. The following adapters are imported into Oracle Identity Manager when you import the connector XML file:
See Also:
The "Supported Functionality" section for a listing of the provisioning functions that are available with this connectoradpLNCreateuser
adpLNUpdateUserName
adpUpdateUserInfo
adpLNDeleteUser
adpLNEnableDisable
adpLNUpdateGrp
adpLNUpdatePassword
You must compile these adapters before they can be used in provisioning operations.
To compile adapters by using the Adapter Manager form:
Open the Adapter Manager form.
To compile all the adapters that you import into the current database, select Compile All.
To compile multiple (but not all) adapters, select the adapters you want to compile. Then, select Compile Selected.
Note:
Click Compile Previously Failed to recompile only those adapters that were not compiled successfully. Such adapters do not have anOK compilation status.Click Start. Oracle Identity Manager compiles the selected adapters.
If Oracle Identity Manager is installed in a clustered environment, then copy the compiled adapters from the OIM_home/xellerate/Adapter directory to the same directory on each of the other nodes of the cluster. If required, overwrite the adapter files on the other nodes.
If you want to compile one adapter at a time, then use the Adapter Factory form.
See Also:
Oracle Identity Manager Tools Reference Guide for information about using the Adapter Factory and Adapter Manager formsTo view detailed information about an adapter:
Highlight the adapter in the Adapter Manager form.
Double-click the row header of the adapter, or right-click the adapter.
Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.
Note:
In this section, the term "attribute" refers to the identity data fields that store user data.By default, the attributes listed in the "Provisioning Module" section are mapped for provisioning between Oracle Identity Manager and the target system. If required, you can map additional attributes for provisioning as follows:
See Also:
Oracle Identity Manager Design Console GuideModify the attributemapping_prov.properties file, which is in the OIM_home/xellerate/XLIntegrations/LotusNotes/config directory.
At the end of this file, some of the attribute definitions are preceded by comment characters. You can uncomment the definition of an attribute to make it a part of the list of reconciliation attributes. If required, you can also add new attributes in this file. The format that you must use is as follows:
OimAttributeName=TargetAttributeName,API_Name
For example:
HomeCity=City
In this example, HomeCity is the provisioning field and City is the equivalent target system attribute.
Add a new column in the process form.
Open the process form. This form is in the Development Tools folder of the Oracle Identity Manager Design Console.
Click Create New Version.
In the Create a New Version dialog box, specify the version name in the Label field, save the changes, and then close the dialog box.
From the Current Version list, select the newly created version.
On the Additional Columns tab, click Add.
Specify the new field name and other values.
Add a new variable in the variable list.
Open the Adapter Factory form. This form is in the Development Tools folder of the Oracle Identity Manager Design Console.
Click the Query for Records icon.
On the Adapter Factory Table tab, double-click the adpLNCreateuser adapter from the list.
On the Variable List tab, click Add.
In the Add a Variable dialog box, specify the required values and then save and close the dialog box.
Define an additional adapter task for the newly added variable in the adpLNCreateuser adapter.
On the Adapter Tasks tab of the Adapter Factory form, click Add.
In the Adapter Task Selection dialog box, select Functional Task, select Java from the list of functional task types, and then click Continue.
In the Object Instance Selection dialog box, select Persistent Instance and then click Continue.
In the Add an Adapter Factory Task dialog box, specify the task name, select the setProperty method from the Method list, and then click Save.
Map the application method parameters, and then save and close the dialog box. To map the application method parameters:
For the "Output: String Return variable (Adapter Variable)" parameter:
i. From the Map to list, select Literal.
ii. From the Name list, select Return variable.
For the "Input: String input (Adapter Variable)" parameter:
i. From the Map to list, select Adapter Variables.
ii. From the Name list, select Input.
For the "Input: String Status (Literal)" parameter:
i. From the Map to list, select Literal.
ii. From the Name list, select String.
iii. In the Value field, enter Status.
For the "Input: String Status (Adapter Variable)" parameter:
i. From the Map to list, select Adapter Variables.
ii. From the Name list, select Status.
Repeat Steps b through g to create more adapter tasks.
Create an additional adapter task to set the input variable.
Open the Adapter Factory form. This form is in the Development Tools folder in the Oracle Identity Manager Design Console.
On the Adapter Tasks tab, click Add.
In the Adapter Task Selection dialog box, select Logic Task, select SET VARIABLE from the list, and then click Continue.
In the Edit Set Variable Task Parameters dialog box, select input from the Variable Name list, select Adapter Task from the Operand Type list, and the Operand Qualifier as the Adapter Task that you have created in the previous step. Then, click Save.
Map the process form columns and adapter variables for the Create User process task as follows:
Open the Process Definition form. This form is in the Process Management folder of the Design Console.
Click the Query for Records icon.
On the Process Definition Table tab, double-click the Lotus process.
On the Tasks tab, double-click the Create User task.
In the Closing Form dialog box, click Yes.
On the Integration tab of the Editing Task Columns Create User dialog box, map the unmapped variables, and then save and close the dialog box. To map an unmapped variable:
i. Double-click the row in which N is displayed in the Status column. The value N signifies that the variable is not mapped.
ii. From the Map to list in the Edit Data Mapping for Variables dialog box, select Process Data.
iii. From the Qualifier list, select the name of the variable.
Repeat Steps i through iii for all unmapped variables.
Repeat Steps 1 through 6 if you want to add more attributes.
Note:
Perform this procedure only if you want to configure the connector for multiple installations of IBM Lotus Notes and Domino.You may want to configure the connector for multiple installations of IBM Lotus Notes and Domino. The following example illustrates this requirement:
The Tokyo, London, and New York offices of Acme Multinational Inc. have their own installations of IBM Lotus Notes and Domino. The company has recently installed Oracle Identity Manager, and they want to configure Oracle Identity Manager to link all the installations of IBM Lotus Notes and Domino.
To meet the requirement posed by such a scenario, you must configure the connector for multiple installations of IBM Lotus Notes and Domino.
To configure the connector for multiple installations of the target system:
See Also:
Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedureCreate and configure one IT resource for each target system installation.
The IT Resources form is in the Resource Management folder. An IT resource is created when you import the connector XML file. You can use this IT resource as the template for creating the remaining IT resources, of the same IT resource type.
Configure reconciliation for each target system installation. Refer to the "Configuring Reconciliation" section for instructions. Note that you only need to modify the attributes that are used to specify the IT resource and to specify whether or not the target system installation is to be set up as a trusted source.
If required, modify the fields to be reconciled for the Xellerate User resource object.
When you use the Administrative and User Console to perform provisioning, you can specify the IT resource corresponding to the IBM Lotus Notes and Domino installation to which you want to provision the user.
