| Oracle® Identity Manager Connector Guide for SAP Enterprise Portal Release 9.0.3 Part Number B32370-01 |
|
|
View PDF |
| Oracle® Identity Manager Connector Guide for SAP Enterprise Portal Release 9.0.3 Part Number B32370-01 |
|
|
View PDF |
Deploying the connector involves the following steps:
If you want to configure the connector for multiple installations of SAP Enterprise Portal, then perform the following procedure:
The following table lists the deployment requirements for the connector.
| Item | Requirement |
|---|---|
| Oracle Identity Manager | Oracle Identity Manager release 8.5.3 or later |
| Target systems | The target system can be any one of the following:
|
| Infrastructure requirements | SAP Enterprise Portal 6.0 with WAS 6.2 on SAP 4.7, UME 4.0 on SAP Enterprise Portal 6.0, and Axis 1.3 |
| External code | Apache Axis JAR files
These are listed in the "Files and Directories That Comprise the Connector" section. |
| Target system user account | Create a user account, and assign the following roles to it:
The second role gives the rights to deploy the agent on the target system. For this connector, the agent is the Refer to "Configuring the sapum.properties File" section for information about how this user account is used. |
The connector files and external code files to be copied and the directories to which you must copy them are given in the following table.
Note:
The connector files listed in the first column of this table are in the following directory on the installation media:Enterprise Applications\SAP Enterprise Portal
Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.
| Connector File/External Code File | Destination Directory |
|---|---|
Files in the lib directory |
OIM_home\Xellerate\SAP_EP\lib
|
lib\SAP_EP_jar\servicelistener.jar |
OIM_home\Xellerate\JavaTasks
In addition, copy this file into the lib directory inside the SAP Enterprise Portal connector deployment directory as shown in the following sample directory path:
D:\usr\sap\EP6J\j2ee\j2ee_00\cluster\server\services\servlet_jsp\work\jspTemp\irj\root\WEB-INF\portal\lib |
par\ConnectorService.par |
Refer to the "Step 4: Deploying Web Services on the Target System" section. |
Files in the resources directory |
OIM_home\xellerate\connectorResources
|
Files in the Troubleshoot directory |
OIM_home\Xellerate\SAP_EP\Troubleshoot
|
Files in the xml directory |
OIM_home\Xellerate\SAP_EP\xml
|
The following files from the OIM_home\xellerate directory:
prtapi.jar prtconnection.jar prtcoreservice.jar prtdeploymentapi.jar prtjsp_api.jar prttest.jar |
Copy these file into the lib directory inside the SAP Enterprise Portal connector deployment directory as shown in the following sample directory path:
D:\usr\sap\EP6J\j2ee\j2ee_00\cluster\server\services\servlet_jsp\work\jspTemp\irj\root\WEB-INF\portal\lib |
The following files from the SAP EP installation directory:
BaseComps.jar com.sap.portal.pcd.basicrolefactoryapi.jar com.sap.portal.pcd.glserviceapi.jar com.sap.portal.pcd.umwrapperserviceapi.jar com.sap.portal.pcmbuilderserviceapi.jar com.sap.portal.usermanagementcore.jar com.sap.security.api.jar com.sap.security.api.perm.jar com.sap.security.core.jar connector.jar exception.jar j2ee.jar jARM.jar Jta.jar Logging.jar P9base.jar P9oracle.jar P9util.jar pcdglstandalone.jar prtapi.jar prtjndisupport.jar prtregistry.jar sapj2eeclient.jar umeuseradminbase.jar util.jar |
OIM_home\Xellerate\JavaTasks
|
The following files from the Apache Web site at
axis.jar jaxrpc.jar commons-logging.jar commons-discovery.jar See Also: The "Downloading the Apache Axis JAR Files" section for more information. |
OIM_home\Xellerate\JavaTasks
|
Note:
While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy the
connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.Download the Apache Axis JAR files that are required for SOAP communication with the Web service running on the SAP Enterprise Portal 6.0 server. The version of Axis used is axis-1_3. You can download the JAR files from
You must copy these JAR files into the JavaTasks directory of Oracle Identity Manager. In a clustered environment, you must copy these JAR files into the JavaTasks directory of each node of the cluster.
Configuring the Oracle Identity Manager server involves the following procedures:
Note:
In a clustered environment, you must perform this step on each node of the cluster.Changing to the required input locale (language and country setting) involves installing the required fonts and setting the required input locale.
To set the required input locale:
Note:
Depending on the operating system used, you may need to perform this procedure differently.Open Control Panel.
Double-click Regional Options.
On the Input Locales tab of the Regional Options dialog box, add the input locale that you want to use and then switch to the input locale.
Whenever you add a new resource bundle file in the OIM_home\xellerate\connectorResources directory or make a change in an existing resource bundle file, you must clear content related to connector resource bundles from the server cache.
To clear content related to connector resource bundles from the server cache:
In a command window, change to the OIM_home\xellerate\bin directory.
Enter one of the following commands:
Note:
You must perform Step 1 before you perform this step. If you run the command as follows, then an exception is thrown:OIM_home\xellerate\bin\batch_file_name
On Microsoft Windows:
PurgeCache.bat ConnectorResourceBundle
On UNIX:
PurgeCache.sh ConnectorResourceBundle
In this command, ConnectorResourceBundle is one of the content categories that you can remove from the server cache. Refer to the following file for information about the other content categories:
OIM_home\xellerate\config\xlConfig.xml
Note:
You can ignore the exception that is thrown when you perform Step 2.The sapum.properties file is in the OIM_home\Xellerate\SAP_EP\lib directory. To configure this file, first open it in a text editor and then specify values for the parameters in the Database Settings section of the file.
If the data source used by SAP EP is SAP R3 or LDAP, then you must specify values for the parameters listed in the corresponding section of the sapum.properties file.
When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:
ALL
This level enables logging for all events.
DEBUG
This level enables logging of information about fine-grained events that are useful for debugging.
INFO
This level enables logging of informational messages that highlight the progress of the application at coarse-grained level.
WARN
This level enables logging of information about potentially harmful situations.
ERROR
This level enables logging of information about error events that may still allow the application to continue running.
FATAL
This level enables logging of information about very severe error events that could cause the application to stop functioning.
OFF
This level disables logging for all events.
The file in which you set the log level and the log file path depend on the application server that you use:
For JBoss Application Server
To enable logging:
In the JBoss_home\server\default\conf\log4j.xml file, locate the following lines:
<category name="XELLERATE">
<priority value="log_level"/>
</category>
In the second XML code line, replace log_level with the log level that you want to set. For example:
<category name="XELLERATE"> <priority value="INFO"/> </category>
After you enable logging, log information is written to the following file:
JBoss_home\server\default\log\server.log
For IBM WebSphere:
To enable logging:
Add the following line in the OIM_home\xellerate\config\log.properties file:
log4j.logger.XELLERATE=log_level
In this line, replace log_level with the log level that you want to set.
For example:
log4j.logger.XELLERATE=INFO
After you enable logging, log information is written to the following file:
WebSphere_home\AppServer\logs\server_name\startServer.log
For BEA WebLogic
To enable logging:
Add the following line in the OIM_home\xellerate\config\log.properties file:
log4j.logger.XELLERATE=log_level
In this line, replace log_level with the log level that you want to set.
For example:
log4j.logger.XELLERATE=INFO
After you enable logging, log information is written to the following file:
WebLogic_home\user_projects\domains\domain_name\server_name\server_name.log
For OC4J
To enable logging:
Add the following line in the OIM_home\xellerate\config\log.properties file:
log4j.logger.XELLERATE=log_level
In this line, replace log_level with the log level that you want to set.
For example:
log4j.logger.XELLERATE=INFO
After you enable logging, log information is written to the following file:
OC4J_home\opmn\logs\default_group~home~default_group~1.log
To be able to use Web services with the SAP Enterprise Portal connector, you must deploy the ConnectorService.par file as follows:
Log in to SAP Enterprise Portal as the administrator.
Click the Java Development tab, the Development secondary tab, and then Component Manager.
In the Archive Uploader region, browse to the ConnectorService.par file, and then click Upload. After the file is uploaded, an INFO message is displayed.
From the list in the Archive Deployment Checker region, select WSPortlet, and then click Refresh.
To import the connector XML file into Oracle Identity Manager:
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 SAPEPResourceObject.xml file, which is in the OIM_home\Xellerate\xml directory. Details of this XML file are shown on the File Preview page.
Note:
The connector version is also displayed on this page.Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Next. The Provide IT Resource Instance Data page for the SAP EP IT Resource IT resource is displayed.
Specify values for the parameters of the SAP EP IT Resource IT resource. Refer to the "Defining IT Resources" section for information about the values to be specified.
If you want to configure the connector for another instance of the target system, then:
Click Next. The Provide IT Resource Instance Data page for a new instance of the SAP EP IT Resource IT resource type is displayed.
To define an IT resource for the next instance of the target system, first assign a name to the new IT resource on this page. Then, refer to the "Defining IT Resources" section for information about the values to be specified for the parameters of the new IT resource.
Repeat Steps a and b for the remaining instances of the target system.
See Also:
Oracle Identity Manager Tools Reference GuideClick Skip after you define IT resources for all the instances of the target system. The Confirmation page is displayed.
Click View Selections.
The contents of the XML file are displayed on the Import page. You may see a cross-shaped icon along with some nodes. Remove these nodes by right-clicking each node and then selecting Remove.
Click Import. The connector XML file is imported into Oracle Identity Manager.
After you import the connector XML file, proceed to the "Step 6: Configuring Reconciliation" section.
You must specify values for the SAP EP IT resource parameters listed in the following table.
| Parameter | Description |
|---|---|
SAPUMLocation |
This parameter holds the location of the sapum.properties file. This file contains information to connect to the target SAP EP system.
Sample value: |
TimeStamp |
For the first reconciliation run, the time stamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.
The following are sample timestamp values:
|
WSDLLocation |
This parameter holds the location of the WSDL URL, where the Web service is running in SAP Enterprise Portal 6.0.
For example: To determine the WSDL URL:
|
After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.
Configuring reconciliation involves the following steps:
Note:
Perform this step of the procedure only if you want to configure trusted source reconciliation. Only one connector can be configured for trusted source reconciliation. If you import theSAPEPXLResourceObject.xml file while you have another trusted source configured, then both connector reconciliations would stop working.
Refer to Oracle Identity Manager Connector Framework Guide for conceptual information about reconciliation configurations.
To configure trusted source reconciliation, you must first import the XML file for trusted source reconciliation as follows:
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 SAPEPXLResourceObject.xml file, which is in the OIM_home\Xellerate\SAP_EP\xml 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.
Then, set the value of the IsTrustedSource reconciliation scheduled task attribute to True while performing the procedure described in the following section.
To create the scheduled tasks for lookup fields and user reconciliations:
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 "Step 7: Compiling Adapters" 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 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.| Attribute | Description | Sample Value |
|---|---|---|
ITResource |
Name of the IT resource for setting up a connection to SAP Enterprise Portal | SAP EP IT Resource |
After you specify values for the task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
You must specify values for the following attributes of the user 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.| Attribute | Description | Sample Value |
|---|---|---|
Organization |
Default organization assigned to a new user | OIM Users |
Xellerate type |
Default type assigned to a new user | End-User Administrator |
Role |
Default role assigned to a new user | Consultant |
ITResource |
Name of the IT resource for setting up a connection with SAP | SAP EP IT Resource |
ResourceObject |
Name of the resource object that is used for user reconciliation | SAP EP Resource Object |
IsTrustedSource |
Configuration for trusted/nontrusted target
If it is set to |
False |
FirstTimeReconRecords |
Number of records to be fetched during first-time reconciliation, if the reconciliation scheduled task times out
Initially, Oracle Identity Manager tries to fetch all the records. If the process times out, then Oracle Identity Manager tries to fetch the number of records specified by this parameter. If the task times out even before this number of records are fetched, then Oracle Identity Manager tries to fetch records by recursively dividing this number by two, until all records are fetched from the target system. |
5000 |
Password |
Default dummy password | Dummy |
XLDeleteUsersAllowed |
Flag that specifies whether or not users are to be deleted in Oracle Identity Manager during user reconciliation | False |
After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
The following adapters are imported into Oracle Identity Manager when you import the connector XML file:
SAP EP Remove Role
SAP EP Remove Group
SAP EP Password Change
SAP EP Modify User Date
SAP EP Modify User
SAP EP Delete User
SAP EP Create User
SAP EP Add Role
SAP EP Add Group
SAP EP Lock UnLock User
PrePopulate SAP EP Form
You must compile these adapters before you can use them to provision accounts on the target system.
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.
To view detailed information about an adapter:
You can configure the Change Password function to modify password behavior in scenarios such as when a user profile on the target system gets locked or expires. For such scenarios, you can configure the system so that the administrator is not able to reset the password for a locked or expired user profile. This helps prevent discrepancies between data in Oracle Identity Manager and the target system.
To configure the Change Password function:
See Also:
Oracle Identity Manager Design Console GuideOpen the Oracle Identity Manager Design Console.
Expand the Process Management folder.
Open the Process Definition form.
Select the SAP EP Process process definition.
Double-click the Password Updated task.
On the Integration tab, specify values for the following parameters:
ValidityChange: You can specify either true or false.
True: If the user's validity period has expired, then it is extended to the date specified in the ValidTo parameter.
False: If the user's validity period has expired, then it does not extend the validity and the user's password cannot be changed.
lockChange: You can specify either true or false.
True: If the user is locked but not by the administrator, then the user is unlocked before the change of password. If the user is locked by the administrator, then the password cannot be changed.
False: If the user is locked, then the password cannot be changed.
ValidTo: Date to which the user's validity must be extended. The date format must be as follows:
Apr 1 10 11:18:29 AM
If this field is left empty, then the value is set to 1970-01-01, which is the default date.
Note:
The values specified are case-sensitive and must match the case in the SAP system.Note:
Perform this procedure only if you want to configure the connector for multiple installations of SAP Enterprise Portal. Refer to Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedure.To configure the connector for multiple installations of the target system:
Create and configure one resource object for each target system installation.
The Resource Objects form is in the Resource Management folder. The SAP EP Resource Object resource object is created when you import the connector XML file. You can use this resource object as the template for creating the remaining resource objects.
Create and configure one IT resource for each resource object.
The IT Resources form is in the Resource Management folder. The SAP EP IT Resource 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 resource type.
Design one process form for each process definition.
The Form Designer form is in the Development Tools folder. The following process forms are created when you import the connector XML file:
UD_SAPEP (parent form)
UD_SAPEPROL (child form for multivalue attributes)
UD_SAPEPGP (child form for multivalue attributes)
You can use these process forms as templates for creating the remaining process forms.
Create and configure one process definition for each resource object.
The Process Definition form is in the Process Management folder. The SAP EP Process process definition is created when you import the connector XML file. You can use this process definition as the template for creating the remaining process definitions.
While creating process definitions for each target system installation, the following steps that you must perform are specific to the creation of each process definition:
From the Object Name lookup field, select the resource object that you create in Step 1.
From the Table Name lookup field, select the process form that you create in Step 3.
While mapping the adapter variables for the IT Resource data type, ensure that you select the IT resource that you create in Step 2 from the Qualifier list.
Configure reconciliation for each target system installation. Refer to the "Step 6: Configuring Reconciliation" section for instructions. Note that only the values of the following attributes are to be changed for each reconciliation scheduled task:
ITResource
ResourceObject
IsTrustedSource
Set the IsTrustedSource attribute to True for the SAP Enterprise Portal installation that you want to designate as a trusted source. You can designate either a single or multiple installations of SAP Enterprise Portal as the trusted source. For the remaining SAP Enterprise Portal installations, set this attribute to False.
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 SAP Enterprise Portal installation to which you want to provision the user.
